Mathematica - Humidity Bricklet

This is the description of the Mathematica API bindings for the Humidity Bricklet. General information and technical specifications for the Humidity Bricklet 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*)

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

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

(*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
28
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

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

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

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

(*Set period for humidity callback to 1s (1000ms)*)
(*Note: The humidity callback is only called every second*)
(*if the humidity has changed since the last call!*)
h@SetHumidityCallbackPeriod[1000]

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
33
34
Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

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

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

(*Get threshold callbacks with a debounce time of 10 seconds (10000ms)*)
h@SetDebouncePeriod[10000]

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

AddEventHandler[h@HumidityReachedCallback,HumidityReachedCB]

(*Configure threshold for humidity "outside of 30 to 60 %RH"*)
option=Tinkerforge`BrickletHumidity`THRESHOLDUOPTIONUOUTSIDE
h@SetHumidityCallbackThreshold[option,30*10,60*10]

Input["Click OK to exit"]

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

API

Generally, every method 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 method. 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

BrickletHumidity[uid, ipcon] → humidity
Parameters:
  • uid – Type: String
  • ipcon – Type: NETObject[IPConnection]
Returns:
  • humidity – Type: NETObject[BrickletHumidity]

Creates an object with the unique device ID uid:

humidity=NETNew["Tinkerforge.BrickletHumidity","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.

BrickletHumidity@GetHumidity[] → humidity
Returns:
  • humidity – Type: Integer, Range: [0 to 216 - 1]

Returns the humidity of the sensor. The value has a range of 0 to 1000 and is given in %RH/10 (Relative Humidity), i.e. a value of 421 means that a humidity of 42.1 %RH is measured.

If you want to get the humidity periodically, it is recommended to use the HumidityCallback callback and set the period with SetHumidityCallbackPeriod[].

Advanced Functions

BrickletHumidity@GetAnalogValue[] → value
Returns:
  • value – Type: Integer, Range: [0 to 216 - 1]

Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.

Note

The value returned by GetHumidity[] is averaged over several samples to yield less noise, while GetAnalogValue[] gives back raw unfiltered analog values. The returned humidity value is calibrated for room temperatures, if you use the sensor in extreme cold or extreme warm environments, you might want to calculate the humidity from the analog value yourself. See the HIH 5030 datasheet.

If you want the analog value periodically, it is recommended to use the AnalogValueCallback callback and set the period with SetAnalogValueCallbackPeriod[].

BrickletHumidity@GetAPIVersion[] → {apiVersion1, apiVersion2, apiVersion3}
Returns:
  • apiVersioni – Type: Integer, Range: [0 to 255]

Returns the version of the API definition (major, minor, revision) 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.

BrickletHumidity@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:

  • BrickletHumidity`FUNCTIONUSETUHUMIDITYUCALLBACKUPERIOD = 3
  • BrickletHumidity`FUNCTIONUSETUANALOGUVALUEUCALLBACKUPERIOD = 5
  • BrickletHumidity`FUNCTIONUSETUHUMIDITYUCALLBACKUTHRESHOLD = 7
  • BrickletHumidity`FUNCTIONUSETUANALOGUVALUEUCALLBACKUTHRESHOLD = 9
  • BrickletHumidity`FUNCTIONUSETUDEBOUNCEUPERIOD = 11
BrickletHumidity@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:

  • BrickletHumidity`FUNCTIONUSETUHUMIDITYUCALLBACKUPERIOD = 3
  • BrickletHumidity`FUNCTIONUSETUANALOGUVALUEUCALLBACKUPERIOD = 5
  • BrickletHumidity`FUNCTIONUSETUHUMIDITYUCALLBACKUTHRESHOLD = 7
  • BrickletHumidity`FUNCTIONUSETUANALOGUVALUEUCALLBACKUTHRESHOLD = 9
  • BrickletHumidity`FUNCTIONUSETUDEBOUNCEUPERIOD = 11
BrickletHumidity@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.

BrickletHumidity@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
  • hardwareVersioni – Type: Integer, Range: [0 to 255]
  • firmwareVersioni – 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' or 'd'.

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

Callback Configuration Functions

BrickletHumidity@SetHumidityCallbackPeriod[period] → Null
Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

The HumidityCallback callback is only triggered if the humidity has changed since the last triggering.

BrickletHumidity@GetHumidityCallbackPeriod[] → period
Returns:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by SetHumidityCallbackPeriod[].

BrickletHumidity@SetAnalogValueCallbackPeriod[period] → Null
Parameters:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Sets the period with which the AnalogValueCallback callback is triggered periodically. A value of 0 turns the callback off.

The AnalogValueCallback callback is only triggered if the analog value has changed since the last triggering.

BrickletHumidity@GetAnalogValueCallbackPeriod[] → period
Returns:
  • period – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by SetAnalogValueCallbackPeriod[].

BrickletHumidity@SetHumidityCallbackThreshold[option, min, max] → Null
Parameters:
  • option – Type: Integer, Range: See constants, Default: ToCharacterCode["x"][[0]]
  • min – Type: Integer, Range: [0 to 216 - 1]
  • max – Type: Integer, Range: [0 to 216 - 1]

Sets the thresholds for the HumidityReachedCallback callback.

The following options are possible:

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

The default value is ('x', 0, 0).

The following constants are available for this function:

For option:

  • BrickletHumidity`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletHumidity`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletHumidity`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletHumidity`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletHumidity`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletHumidity@GetHumidityCallbackThreshold[out option, out min, out max] → Null
Output Parameters:
  • option – Type: Integer, Range: See constants, Default: ToCharacterCode["x"][[0]]
  • min – Type: Integer, Range: [0 to 216 - 1]
  • max – Type: Integer, Range: [0 to 216 - 1]

Returns the threshold as set by SetHumidityCallbackThreshold[].

The following constants are available for this function:

For option:

  • BrickletHumidity`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletHumidity`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletHumidity`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletHumidity`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletHumidity`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletHumidity@SetAnalogValueCallbackThreshold[option, min, max] → Null
Parameters:
  • option – Type: Integer, Range: See constants, Default: ToCharacterCode["x"][[0]]
  • min – Type: Integer, Range: [0 to 216 - 1]
  • max – Type: Integer, Range: [0 to 216 - 1]

Sets the thresholds for the AnalogValueReachedCallback callback.

The following options are possible:

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

The default value is ('x', 0, 0).

The following constants are available for this function:

For option:

  • BrickletHumidity`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletHumidity`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletHumidity`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletHumidity`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletHumidity`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletHumidity@GetAnalogValueCallbackThreshold[out option, out min, out max] → Null
Output Parameters:
  • option – Type: Integer, Range: See constants, Default: ToCharacterCode["x"][[0]]
  • min – Type: Integer, Range: [0 to 216 - 1]
  • max – Type: Integer, Range: [0 to 216 - 1]

Returns the threshold as set by SetAnalogValueCallbackThreshold[].

The following constants are available for this function:

For option:

  • BrickletHumidity`THRESHOLDUOPTIONUOFF = ToCharacterCode["x"][[0]]
  • BrickletHumidity`THRESHOLDUOPTIONUOUTSIDE = ToCharacterCode["o"][[0]]
  • BrickletHumidity`THRESHOLDUOPTIONUINSIDE = ToCharacterCode["i"][[0]]
  • BrickletHumidity`THRESHOLDUOPTIONUSMALLER = ToCharacterCode["<"][[0]]
  • BrickletHumidity`THRESHOLDUOPTIONUGREATER = ToCharacterCode[">"][[0]]
BrickletHumidity@SetDebouncePeriod[debounce] → Null
Parameters:
  • debounce – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Sets the period with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

BrickletHumidity@GetDebouncePeriod[] → debounce
Returns:
  • debounce – Type: Integer, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by SetDebouncePeriod[].

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[humidity@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 BrickletHumidity@HumidityCallback[sender, humidity]
Callback Parameters:
  • sender – Type: NETObject[BrickletHumidity]
  • humidity – Type: Integer, Range: [0 to 216 - 1]

This callback is triggered periodically with the period that is set by SetHumidityCallbackPeriod[]. The parameter is the humidity of the sensor.

The HumidityCallback callback is only triggered if the humidity has changed since the last triggering.

event BrickletHumidity@AnalogValueCallback[sender, value]
Callback Parameters:
  • sender – Type: NETObject[BrickletHumidity]
  • value – Type: Integer, Range: [0 to 216 - 1]

This callback is triggered periodically with the period that is set by SetAnalogValueCallbackPeriod[]. The parameter is the analog value of the sensor.

The AnalogValueCallback callback is only triggered if the humidity has changed since the last triggering.

event BrickletHumidity@HumidityReachedCallback[sender, humidity]
Callback Parameters:
  • sender – Type: NETObject[BrickletHumidity]
  • humidity – Type: Integer, Range: [0 to 216 - 1]

This callback is triggered when the threshold as set by SetHumidityCallbackThreshold[] is reached. The parameter is the humidity of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod[].

event BrickletHumidity@AnalogValueReachedCallback[sender, value]
Callback Parameters:
  • sender – Type: NETObject[BrickletHumidity]
  • value – Type: Integer, Range: [0 to 216 - 1]

This callback is triggered when the threshold as set by SetAnalogValueCallbackThreshold[] is reached. The parameter is the analog value of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod[].

Constants

BrickletHumidity`DEVICEUIDENTIFIER

This constant is used to identify a Humidity Bricklet.

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.

BrickletHumidity`DEVICEDISPLAYNAME

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