Mathematica - Humidity Bricklet 2.0

This is the description of the Mathematica API bindings for the Humidity Bricklet 2.0. General information and technical specifications for the Humidity Bricklet 2.0 are summarized in its hardware description.

An installation guide for the Mathematica API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.nb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Humidity Bricklet 2.0*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
h=NETNew["Tinkerforge.BrickletHumidityV2",uid,ipcon]
ipcon@Connect[host,port]

(*Get current humidity*)
Print["Humidity: "<>ToString[N[Quantity[h@GetHumidity[],"%RH/100"]]]]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[h]
ReleaseNETObject[ipcon]

Callback

Download (ExampleCallback.nb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Humidity Bricklet 2.0*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
h=NETNew["Tinkerforge.BrickletHumidityV2",uid,ipcon]
ipcon@Connect[host,port]

(*Callback function for humidity callback*)
HumidityCB[sender_,humidity_]:=
 Print["Humidity: "<>ToString[N[Quantity[humidity,"%RH/100"]]]]
AddEventHandler[h@HumidityCallback,HumidityCB]

(*Set period for humidity callback to 1s (1000ms) without a threshold*)
option=Tinkerforge`BrickletHumidityV2`THRESHOLDUOPTIONUOFF
h@SetHumidityCallbackConfiguration[1000,False,option,0,0]

Input["Click OK to exit"]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[h]
ReleaseNETObject[ipcon]

Threshold

Download (ExampleThreshold.nb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

host="localhost"
port=4223
uid="XYZ"(*Change XYZ to the UID of your Humidity Bricklet 2.0*)

(*Create IPConnection and device object*)
ipcon=NETNew["Tinkerforge.IPConnection"]
h=NETNew["Tinkerforge.BrickletHumidityV2",uid,ipcon]
ipcon@Connect[host,port]

(*Callback function for humidity callback*)
HumidityCB[sender_,humidity_]:=
 Module[{},
  Print["Humidity: "<>ToString[N[Quantity[humidity,"%RH/100"]]]];
  Print["Recommended humidity for human comfort is 30 to 60 %RH."]
 ]

AddEventHandler[h@HumidityCallback,HumidityCB]

(*Configure threshold for humidity "outside of 30 to 60 %RH"*)
(*with a debounce period of 10s (10000ms)*)
option=Tinkerforge`BrickletHumidityV2`THRESHOLDUOPTIONUOUTSIDE
h@SetHumidityCallbackConfiguration[10000,False,option,30*100,60*100]

Input["Click OK to exit"]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[h]
ReleaseNETObject[ipcon]

API

Generally, every function of the Mathematica bindings that returns a value can throw a Tinkerforge.TimeoutException. This exception gets thrown if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody plugs the device out). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

Since .NET/Link does not support multiple return values directly, we use the out keyword to return multiple values from a function. For further information about the out keyword in .NET/Link see the corresponding Mathematica .NET/Link documentation.

The namespace for all Brick/Bricklet bindings and the IPConnection is Tinkerforge.*.

Basic Functions

BrickletHumidityV2[uid, ipcon] → humidityV2
Parameters:
  • uid – Type: String
  • ipcon – Type: NETObject[IPConnection]
Returns:
  • humidityV2 – Type: NETObject[BrickletHumidityV2]

Creates an object with the unique device ID uid:

humidityV2=NETNew["Tinkerforge.BrickletHumidityV2","YOUR_DEVICE_UID",ipcon]

This object can then be used after the IP Connection is connected (see examples above).

The .NET runtime has built-in garbage collection that frees objects that are no longer in use by a program. But because Mathematica can not automatically tell when a Mathematica "program" doesn't use a .NET object anymore, this has to be done by the program. For this the ReleaseNETObject[] function is used in the examples.

For further information about object management in .NET/Link see the corresponding Mathematica .NET/Link documentation.

BrickletHumidityV2@GetHumidity[] → humidity
Returns:
  • humidity – Type: Integer, Unit: 1/100 %, Range: [0 to 10000]

Returns the humidity measured by the sensor.

If you want to get the value periodically, it is recommended to use the HumidityCallback callback. You can set the callback configuration with SetHumidityCallbackConfiguration[].

BrickletHumidityV2@GetTemperature[] → temperature
Returns:
  • temperature – Type: Integer, Unit: 1/100 °C, Range: [-4000 to 16500]

Returns the temperature measured by the sensor.

If you want to get the value periodically, it is recommended to use the TemperatureCallback callback. You can set the callback configuration with SetTemperatureCallbackConfiguration[].

BrickletHumidityV2@SetHeaterConfiguration[heaterConfig] → Null
Parameters:
  • heaterConfig – Type: Integer, Range: See constants, Default: False

Enables/disables the heater. The heater can be used to dry the sensor in extremely wet conditions.

The following constants are available for this function:

For heaterConfig:

  • BrickletHumidityV2`HEATERUCONFIGUDISABLED = 0
  • BrickletHumidityV2`HEATERUCONFIGUENABLED = 1
BrickletHumidityV2@GetHeaterConfiguration[] → heaterConfig
Returns:
  • heaterConfig – Type: Integer, Range: See constants, Default: False

Returns the heater configuration as set by SetHeaterConfiguration[].

The following constants are available for this function:

For heaterConfig:

  • BrickletHumidityV2`HEATERUCONFIGUDISABLED = 0
  • BrickletHumidityV2`HEATERUCONFIGUENABLED = 1
BrickletHumidityV2@SetMovingAverageConfiguration[movingAverageLengthHumidity, movingAverageLengthTemperature] → Null
Parameters:
  • movingAverageLengthHumidity – Type: Integer, Range: [1 to 1000], Default: 5
  • movingAverageLengthTemperature – Type: Integer, Range: [1 to 1000], Default: 5

Sets the length of a moving averaging for the humidity and temperature.

Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.

New data is gathered every 50ms*. With a moving average of length 1000 the resulting averaging window has a length of 50s. If you want to do long term measurements the longest moving average will give the cleanest results.

* In firmware version 2.0.3 we added the SetSamplesPerSecond[] function. It configures the measurement frequency. Since high frequencies can result in self-heating of th IC, changed the default value from 20 samples per second to 1. With 1 sample per second a moving average length of 1000 would result in an averaging window of 1000 seconds!

BrickletHumidityV2@GetMovingAverageConfiguration[out movingAverageLengthHumidity, out movingAverageLengthTemperature] → Null
Output Parameters:
  • movingAverageLengthHumidity – Type: Integer, Range: [1 to 1000], Default: 5
  • movingAverageLengthTemperature – Type: Integer, Range: [1 to 1000], Default: 5

Returns the moving average configuration as set by SetMovingAverageConfiguration[].

BrickletHumidityV2@SetSamplesPerSecond[sps] → Null
Parameters:
  • sps – Type: Integer, Range: See constants, Default: 3

Sets the samples per second that are gathered by the humidity/temperature sensor HDC1080.

We added this function since we found out that a high measurement frequency can lead to self-heating of the sensor. Which can distort the temperature measurement.

If you don't need a lot of measurements, you can use the lowest available measurement frequency of 0.1 samples per second for the least amount of self-heating.

Before version 2.0.3 the default was 20 samples per second. The new default is 1 sample per second.

The following constants are available for this function:

For sps:

  • BrickletHumidityV2`SPSU20 = 0
  • BrickletHumidityV2`SPSU10 = 1
  • BrickletHumidityV2`SPSU5 = 2
  • BrickletHumidityV2`SPSU1 = 3
  • BrickletHumidityV2`SPSU02 = 4
  • BrickletHumidityV2`SPSU01 = 5

New in version 2.0.3 (Plugin).

BrickletHumidityV2@GetSamplesPerSecond[] → sps
Returns:
  • sps – Type: Integer, Range: See constants, Default: 3

Returnes the samples per second, as set by SetSamplesPerSecond[].

The following constants are available for this function:

For sps:

  • BrickletHumidityV2`SPSU20 = 0
  • BrickletHumidityV2`SPSU10 = 1
  • BrickletHumidityV2`SPSU5 = 2
  • BrickletHumidityV2`SPSU1 = 3
  • BrickletHumidityV2`SPSU02 = 4
  • BrickletHumidityV2`SPSU01 = 5

New in version 2.0.3 (Plugin).

Advanced Functions

BrickletHumidityV2@GetSPITFPErrorCount[out errorCountAckChecksum, out errorCountMessageChecksum, out errorCountFrame, out errorCountOverflow] → Null
Output Parameters:
  • errorCountAckChecksum – Type: Integer, Range: [0 to 232 - 1]
  • errorCountMessageChecksum – Type: Integer, Range: [0 to 232 - 1]
  • errorCountFrame – Type: Integer, Range: [0 to 232 - 1]
  • errorCountOverflow – Type: Integer, Range: [0 to 232 - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

BrickletHumidityV2@SetBootloaderMode[mode] → status
Parameters:
  • mode – Type: Integer, Range: See constants
Returns:
  • status – Type: Integer, Range: See constants

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

For mode:

  • BrickletHumidityV2`BOOTLOADERUMODEUBOOTLOADER = 0
  • BrickletHumidityV2`BOOTLOADERUMODEUFIRMWARE = 1
  • BrickletHumidityV2`BOOTLOADERUMODEUBOOTLOADERUWAITUFORUREBOOT = 2
  • BrickletHumidityV2`BOOTLOADERUMODEUFIRMWAREUWAITUFORUREBOOT = 3
  • BrickletHumidityV2`BOOTLOADERUMODEUFIRMWAREUWAITUFORUERASEUANDUREBOOT = 4

For status:

  • BrickletHumidityV2`BOOTLOADERUSTATUSUOK = 0
  • BrickletHumidityV2`BOOTLOADERUSTATUSUINVALIDUMODE = 1
  • BrickletHumidityV2`BOOTLOADERUSTATUSUNOUCHANGE = 2
  • BrickletHumidityV2`BOOTLOADERUSTATUSUENTRYUFUNCTIONUNOTUPRESENT = 3
  • BrickletHumidityV2`BOOTLOADERUSTATUSUDEVICEUIDENTIFIERUINCORRECT = 4
  • BrickletHumidityV2`BOOTLOADERUSTATUSUCRCUMISMATCH = 5
BrickletHumidityV2@GetBootloaderMode[] → mode
Returns:
  • mode – Type: Integer, Range: See constants

Returns the current bootloader mode, see SetBootloaderMode[].

The following constants are available for this function:

For mode:

  • BrickletHumidityV2`BOOTLOADERUMODEUBOOTLOADER = 0
  • BrickletHumidityV2`BOOTLOADERUMODEUFIRMWARE = 1
  • BrickletHumidityV2`BOOTLOADERUMODEUBOOTLOADERUWAITUFORUREBOOT = 2
  • BrickletHumidityV2`BOOTLOADERUMODEUFIRMWAREUWAITUFORUREBOOT = 3
  • BrickletHumidityV2`BOOTLOADERUMODEUFIRMWAREUWAITUFORUERASEUANDUREBOOT = 4
BrickletHumidityV2@SetWriteFirmwarePointer[pointer] → Null
Parameters:
  • pointer – Type: Integer, Unit: 1 B, Range: [0 to 232 - 1]

Sets the firmware pointer for WriteFirmware[]. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletHumidityV2@WriteFirmware[{data1, data2, ..., data64}] → status
Parameters:
  • datai – Type: Integer, Range: [0 to 255]
Returns:
  • status – Type: Integer, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer[] before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickletHumidityV2@SetStatusLEDConfig[config] → Null
Parameters:
  • config – Type: Integer, Range: See constants, Default: 3

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

For config:

  • BrickletHumidityV2`STATUSULEDUCONFIGUOFF = 0
  • BrickletHumidityV2`STATUSULEDUCONFIGUON = 1
  • BrickletHumidityV2`STATUSULEDUCONFIGUSHOWUHEARTBEAT = 2
  • BrickletHumidityV2`STATUSULEDUCONFIGUSHOWUSTATUS = 3
BrickletHumidityV2@GetStatusLEDConfig[] → config
Returns:
  • config – Type: Integer, Range: See constants, Default: 3

Returns the configuration as set by SetStatusLEDConfig[]

The following constants are available for this function:

For config:

  • BrickletHumidityV2`STATUSULEDUCONFIGUOFF = 0
  • BrickletHumidityV2`STATUSULEDUCONFIGUON = 1
  • BrickletHumidityV2`STATUSULEDUCONFIGUSHOWUHEARTBEAT = 2
  • BrickletHumidityV2`STATUSULEDUCONFIGUSHOWUSTATUS = 3
BrickletHumidityV2@GetChipTemperature[] → temperature
Returns:
  • temperature – Type: Integer, Unit: 1 °C, Range: [-215 to 215 - 1]

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

BrickletHumidityV2@Reset[] → Null

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

BrickletHumidityV2@WriteUID[uid] → Null
Parameters:
  • uid – Type: Integer, Range: [0 to 232 - 1]

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

BrickletHumidityV2@ReadUID[] → uid
Returns:
  • uid – Type: Integer, Range: [0 to 232 - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

BrickletHumidityV2@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null
Output Parameters:
  • uid – Type: String, Length: up to 8
  • connectedUid – Type: String, Length: up to 8
  • position – Type: Integer, Range: [ToCharacterCode["a"][[0]] to ToCharacterCode["h"][[0]], ToCharacterCode["i"][[0]], ToCharacterCode["z"][[0]]]
  • hardwareVersioni – Type: Integer
    • 1: major – Type: Integer, Range: [0 to 255]
    • 2: minor – Type: Integer, Range: [0 to 255]
    • 3: revision – Type: Integer, Range: [0 to 255]
  • firmwareVersioni – Type: Integer
    • 1: major – Type: Integer, Range: [0 to 255]
    • 2: minor – Type: Integer, Range: [0 to 255]
    • 3: revision – Type: Integer, Range: [0 to 255]
  • deviceIdentifier – Type: Integer, Range: [0 to 216 - 1]

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

BrickletHumidityV2@SetHumidityCallbackConfiguration[period, valueHasToChange, option, min, max] → Null
Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False
  • option – Type: Integer, Range: See constants, Default: ToCharacterCode["x"][[0]]
  • min – Type: Integer, Unit: 1/100 %, Range: [0 to 216 - 1], Default: 0
  • max – Type: Integer, Unit: 1/100 %, Range: [0 to 216 - 1], Default: 0

The period is the period with which the HumidityCallback callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the HumidityCallback callback.

The following options are possible:

Option Description
'x' Threshold is turned off
'o' Threshold is triggered when the value is outside the min and max values
'i' Threshold is triggered when the value is inside or equal to the min and max values
'<' Threshold is triggered when the value is smaller than the min value (max is ignored)
'>' Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The following constants are available for this function:

For option:

  • BrickletHumidityV2`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletHumidityV2`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletHumidityV2`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletHumidityV2`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletHumidityV2`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletHumidityV2@GetHumidityCallbackConfiguration[out period, out valueHasToChange, out option, out min, out max] → Null
Output Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False
  • option – Type: Integer, Range: See constants, Default: ToCharacterCode["x"][[0]]
  • min – Type: Integer, Unit: 1/100 %, Range: [0 to 216 - 1], Default: 0
  • max – Type: Integer, Unit: 1/100 %, Range: [0 to 216 - 1], Default: 0

Returns the callback configuration as set by SetHumidityCallbackConfiguration[].

The following constants are available for this function:

For option:

  • BrickletHumidityV2`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletHumidityV2`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletHumidityV2`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletHumidityV2`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletHumidityV2`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletHumidityV2@SetTemperatureCallbackConfiguration[period, valueHasToChange, option, min, max] → Null
Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False
  • option – Type: Integer, Range: See constants, Default: ToCharacterCode["x"][[0]]
  • min – Type: Integer, Unit: 1/100 °C, Range: [-215 to 215 - 1], Default: 0
  • max – Type: Integer, Unit: 1/100 °C, Range: [-215 to 215 - 1], Default: 0

The period is the period with which the TemperatureCallback callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the TemperatureCallback callback.

The following options are possible:

Option Description
'x' Threshold is turned off
'o' Threshold is triggered when the value is outside the min and max values
'i' Threshold is triggered when the value is inside or equal to the min and max values
'<' Threshold is triggered when the value is smaller than the min value (max is ignored)
'>' Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The following constants are available for this function:

For option:

  • BrickletHumidityV2`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletHumidityV2`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletHumidityV2`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletHumidityV2`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletHumidityV2`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletHumidityV2@GetTemperatureCallbackConfiguration[out period, out valueHasToChange, out option, out min, out max] → Null
Output Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
  • valueHasToChange – Type: True/False, Default: False
  • option – Type: Integer, Range: See constants, Default: ToCharacterCode["x"][[0]]
  • min – Type: Integer, Unit: 1/100 °C, Range: [-215 to 215 - 1], Default: 0
  • max – Type: Integer, Unit: 1/100 °C, Range: [-215 to 215 - 1], Default: 0

Returns the callback configuration as set by SetTemperatureCallbackConfiguration[].

The following constants are available for this function:

For option:

  • BrickletHumidityV2`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletHumidityV2`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletHumidityV2`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletHumidityV2`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletHumidityV2`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a function to a callback property of the device object:

MyCallback[sender_,value_]:=Print["Value: "<>ToString[value]]

AddEventHandler[humidityV2@ExampleCallback,MyCallback]

For further information about event handling using .NET/Link see the corresponding Mathematica .NET/Link documentation.

The available callback property and their type of parameters are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

event BrickletHumidityV2@HumidityCallback[sender, humidity]
Callback Parameters:
  • sender – Type: NETObject[BrickletHumidityV2]
  • humidity – Type: Integer, Unit: 1/100 %, Range: [0 to 10000]

This callback is triggered periodically according to the configuration set by SetHumidityCallbackConfiguration[].

The parameter is the same as GetHumidity[].

event BrickletHumidityV2@TemperatureCallback[sender, temperature]
Callback Parameters:
  • sender – Type: NETObject[BrickletHumidityV2]
  • temperature – Type: Integer, Unit: 1/100 °C, Range: [-4000 to 16500]

This callback is triggered periodically according to the configuration set by SetTemperatureCallbackConfiguration[].

The parameter is the same as GetTemperature[].

Virtual Functions

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

BrickletHumidityV2@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}
Output Parameters:
  • apiVersioni – Type: Integer
    • 1: major – Type: Integer, Range: [0 to 255]
    • 2: minor – Type: Integer, Range: [0 to 255]
    • 3: revision – Type: Integer, Range: [0 to 255]

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

BrickletHumidityV2@GetResponseExpected[functionId] → responseExpected
Parameters:
  • functionId – Type: Integer, Range: See constants
Returns:
  • responseExpected – Type: True/False

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected[]. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

  • BrickletHumidityV2`FUNCTIONUSETUHUMIDITYUCALLBACKUCONFIGURATION = 2
  • BrickletHumidityV2`FUNCTIONUSETUTEMPERATUREUCALLBACKUCONFIGURATION = 6
  • BrickletHumidityV2`FUNCTIONUSETUHEATERUCONFIGURATION = 9
  • BrickletHumidityV2`FUNCTIONUSETUMOVINGUAVERAGEUCONFIGURATION = 11
  • BrickletHumidityV2`FUNCTIONUSETUSAMPLESUPERUSECOND = 13
  • BrickletHumidityV2`FUNCTIONUSETUWRITEUFIRMWAREUPOINTER = 237
  • BrickletHumidityV2`FUNCTIONUSETUSTATUSULEDUCONFIG = 239
  • BrickletHumidityV2`FUNCTIONURESET = 243
  • BrickletHumidityV2`FUNCTIONUWRITEUUID = 248
BrickletHumidityV2@SetResponseExpected[functionId, responseExpected] → Null
Parameters:
  • functionId – Type: Integer, Range: See constants
  • responseExpected – Type: True/False

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

  • BrickletHumidityV2`FUNCTIONUSETUHUMIDITYUCALLBACKUCONFIGURATION = 2
  • BrickletHumidityV2`FUNCTIONUSETUTEMPERATUREUCALLBACKUCONFIGURATION = 6
  • BrickletHumidityV2`FUNCTIONUSETUHEATERUCONFIGURATION = 9
  • BrickletHumidityV2`FUNCTIONUSETUMOVINGUAVERAGEUCONFIGURATION = 11
  • BrickletHumidityV2`FUNCTIONUSETUSAMPLESUPERUSECOND = 13
  • BrickletHumidityV2`FUNCTIONUSETUWRITEUFIRMWAREUPOINTER = 237
  • BrickletHumidityV2`FUNCTIONUSETUSTATUSULEDUCONFIG = 239
  • BrickletHumidityV2`FUNCTIONURESET = 243
  • BrickletHumidityV2`FUNCTIONUWRITEUUID = 248
BrickletHumidityV2@SetResponseExpectedAll[responseExpected] → Null
Parameters:
  • responseExpected – Type: True/False

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Constants

BrickletHumidityV2`DEVICEUIDENTIFIER

This constant is used to identify a Humidity Bricklet 2.0.

The GetIdentity[] function and the IPConnection@EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

BrickletHumidityV2`DEVICEDISPLAYNAME

This constant represents the human readable name of a Humidity Bricklet 2.0.