Software / API Bindings / Mathematica / API Reference and Examples / Bricklets (Discontinued) / Moisture Bricklet

Mathematica - Moisture Bricklet¶

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

Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

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

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

(*Get current moisture value*)
Print["Moisture Value: "<>ToString[m@GetMoistureValue[]]]

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

Callback¶

Download (ExampleCallback.nb)

Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

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

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

(*Callback function for moisture value callback*)
MoistureCB[sender_,moisture_]:=
 Print["Moisture Value: "<>ToString[moisture]]
AddEventHandler[m@MoistureCallback,MoistureCB]

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

Input["Click OK to exit"]

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

Threshold¶

Download (ExampleThreshold.nb)

Needs["NETLink`"]
LoadNETAssembly["Tinkerforge",NotebookDirectory[]<>"../../.."]

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

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

(*Get threshold callbacks with a debounce time of 1 second (1000ms)*)
m@SetDebouncePeriod[1000]

(*Callback function for moisture value reached callback*)
MoistureReachedCB[sender_,moisture_]:=
 Print["Moisture Value: "<>ToString[moisture]]
AddEventHandler[m@MoistureReachedCallback,MoistureReachedCB]

(*Configure threshold for moisture value "greater than 200"*)
option=Tinkerforge`BrickletMoisture`THRESHOLDUOPTIONUGREATER
m@SetMoistureCallbackThreshold[option,200,0]

Input["Click OK to exit"]

(*Clean up*)
ipcon@Disconnect[]
ReleaseNETObject[m]
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¶

BrickletMoisture[uid, ipcon] → moisture¶

Parameters:	uid – Type: String ipcon – Type: NETObject[IPConnection]
Returns:	moisture – Type: NETObject[BrickletMoisture]

Creates an object with the unique device ID uid:

moisture=NETNew["Tinkerforge.BrickletMoisture","YOUR_DEVICE_UID",ipcon]

This object can then be used after the IP Connection is connected.

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.

BrickletMoisture@GetMoistureValue[] → moisture¶

Returns:	moisture – Type: Integer, Range: [0 to 2¹² - 1]

Returns the current moisture value. A small value corresponds to little moisture, a big value corresponds to much moisture.

If you want to get the moisture value periodically, it is recommended to use the MoistureCallback callback and set the period with SetMoistureCallbackPeriod[].

Advanced Functions¶

BrickletMoisture@SetMovingAverage[average] → Null¶

Parameters:	average – Type: Integer, Range: [0 to 100], Default: 100

Sets the length of a moving averaging for the moisture value.

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

BrickletMoisture@GetMovingAverage[] → average¶

Returns:	average – Type: Integer, Range: [0 to 100], Default: 100

Returns the length moving average as set by SetMovingAverage[].

BrickletMoisture@GetIdentity[out uid, out connectedUid, out position, out {hardwareVersion1, hardwareVersion2, hardwareVersion3}, out {firmwareVersion1, firmwareVersion2, firmwareVersion3}, out deviceIdentifier] → Null¶

Output Parameters:

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["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 2¹⁶ - 1]

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["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 2¹⁶ - 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). A Bricklet connected to an Isolator Bricklet is always at 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¶

BrickletMoisture@SetMoistureCallbackPeriod[period] → Null¶

Parameters:	period – Type: Integer, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

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

The MoistureCallback callback is only triggered if the moisture value has changed since the last triggering.

BrickletMoisture@GetMoistureCallbackPeriod[] → period¶

Returns:	period – Type: Integer, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by SetMoistureCallbackPeriod[].

BrickletMoisture@SetMoistureCallbackThreshold[option, min, max] → Null¶

Parameters:	option – Type: Integer, Range: See constants, Default: ToCharacterCode["x"][[0]] min – Type: Integer, Range: [0 to 2¹⁶ - 1], Default: 0 max – Type: Integer, Range: [0 to 2¹⁶ - 1], Default: 0

Sets the thresholds for the MoistureReachedCallback callback.

The following options are possible:

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

The following constants are available for this function:

For option:

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

BrickletMoisture@GetMoistureCallbackThreshold[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 2¹⁶ - 1], Default: 0 max – Type: Integer, Range: [0 to 2¹⁶ - 1], Default: 0

Returns the threshold as set by SetMoistureCallbackThreshold[].

The following constants are available for this function:

For option:

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

BrickletMoisture@SetDebouncePeriod[debounce] → Null¶

Parameters:	debounce – Type: Integer, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 100

Sets the period with which the threshold callback

MoistureReachedCallback

is triggered, if the threshold

SetMoistureCallbackThreshold[]

keeps being reached.

BrickletMoisture@GetDebouncePeriod[] → debounce¶

Returns:	debounce – Type: Integer, Unit: 1 ms, Range: [0 to 2³² - 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[moisture@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 BrickletMoisture@MoistureCallback[sender, moisture]¶

Callback Parameters:	sender – Type: NETObject[BrickletMoisture] moisture – Type: Integer, Range: [0 to 2¹² - 1]

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

The MoistureCallback callback is only triggered if the moisture value has changed since the last triggering.

event BrickletMoisture@MoistureReachedCallback[sender, moisture]¶

Callback Parameters:	sender – Type: NETObject[BrickletMoisture] moisture – Type: Integer, Range: [0 to 2¹² - 1]

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

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

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.

BrickletMoisture@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.

BrickletMoisture@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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

BrickletMoisture`FUNCTIONUSETUMOISTUREUCALLBACKUPERIOD = 2
BrickletMoisture`FUNCTIONUSETUMOISTUREUCALLBACKUTHRESHOLD = 4
BrickletMoisture`FUNCTIONUSETUDEBOUNCEUPERIOD = 6
BrickletMoisture`FUNCTIONUSETUMOVINGUAVERAGE = 10

BrickletMoisture@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.

The following constants are available for this function:

For functionId:

BrickletMoisture`FUNCTIONUSETUMOISTUREUCALLBACKUPERIOD = 2
BrickletMoisture`FUNCTIONUSETUMOISTUREUCALLBACKUTHRESHOLD = 4
BrickletMoisture`FUNCTIONUSETUDEBOUNCEUPERIOD = 6
BrickletMoisture`FUNCTIONUSETUMOVINGUAVERAGE = 10

BrickletMoisture@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¶

BrickletMoisture`DEVICEUIDENTIFIER¶

This constant is used to identify a Moisture 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.

BrickletMoisture`DEVICEDISPLAYNAME¶: This constant represents the human readable name of a Moisture Bricklet.