LabVIEW - Moisture Bricklet

This is the description of the LabVIEW 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 LabVIEW API bindings is part of their general description.

API

Generally, every method of the LabVIEW bindings that outputs a value can report a Tinkerforge.TimeoutException. This error gets reported 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.

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

Basic Functions

BrickletMoisture(uid, ipcon) → moisture
Input:
  • uid -- String
  • ipcon -- .NET Refnum (IPConnection)
Output:
  • moisture -- .NET Refnum (BrickletMoisture)

Creates an object with the unique device ID uid. This object can then be used after the IP Connection is connected (see examples above).

BrickletMoisture.GetMoistureValue() → moisture
Output:
  • moisture -- Int32

Returns the current moisture value. The value has a range of 0 to 4095. 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)
Input:
  • average -- Byte

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.

The range for the averaging is 0-100.

The default value is 100.

BrickletMoisture.GetMovingAverage() → average
Output:
  • average -- Byte

Returns the length moving average as set by SetMovingAverage().

BrickletMoisture.GetAPIVersion() → apiVersion
Output:
  • apiVersion -- Byte[3]

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.

BrickletMoisture.GetResponseExpected(functionId) → responseExpected
Input:
  • functionId -- Byte
Output:
  • responseExpected -- Boolean

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.

See SetResponseExpected() for the list of function ID constants available for this function.

BrickletMoisture.SetResponseExpected(functionId, responseExpected)
Input:
  • functionId -- Byte
  • responseExpected -- Boolean

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 function ID constants are available for this function:

  • BrickletMoisture.FUNCTION_SET_MOISTURE_CALLBACK_PERIOD = 2
  • BrickletMoisture.FUNCTION_SET_MOISTURE_CALLBACK_THRESHOLD = 4
  • BrickletMoisture.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletMoisture.FUNCTION_SET_MOVING_AVERAGE = 10
BrickletMoisture.SetResponseExpectedAll(responseExpected)
Input:
  • responseExpected -- Boolean

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

BrickletMoisture.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier
Output:
  • uid -- String
  • connectedUid -- String
  • position -- Char
  • hardwareVersion -- Byte[3]
  • firmwareVersion -- Byte[3]
  • deviceIdentifier -- Int32

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

BrickletMoisture.SetMoistureCallbackPeriod(period)
Input:
  • period -- Int64

Sets the period in ms 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.

The default value is 0.

BrickletMoisture.GetMoistureCallbackPeriod() → period
Output:
  • period -- Int64

Returns the period as set by SetMoistureCallbackPeriod().

BrickletMoisture.SetMoistureCallbackThreshold(option, min, max)
Input:
  • option -- Char
  • min -- Int32
  • max -- Int32

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 default value is ('x', 0, 0).

The following constants are available for this function:

  • BrickletMoisture.THRESHOLD_OPTION_OFF = 'x'
  • BrickletMoisture.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletMoisture.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletMoisture.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletMoisture.THRESHOLD_OPTION_GREATER = '>'
BrickletMoisture.GetMoistureCallbackThreshold() → option, min, max
Output:
  • option -- Char
  • min -- Int32
  • max -- Int32

Returns the threshold as set by SetMoistureCallbackThreshold().

The following constants are available for this function:

  • BrickletMoisture.THRESHOLD_OPTION_OFF = 'x'
  • BrickletMoisture.THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletMoisture.THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletMoisture.THRESHOLD_OPTION_SMALLER = '<'
  • BrickletMoisture.THRESHOLD_OPTION_GREATER = '>'
BrickletMoisture.SetDebouncePeriod(debounce)
Input:
  • debounce -- Int64

Sets the period in ms with which the threshold callback

is triggered, if the threshold

keeps being reached.

The default value is 100.

BrickletMoisture.GetDebouncePeriod() → debounce
Output:
  • debounce -- Int64

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. 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)
Input:
  • sender -- .NET Refnum (BrickletMoisture)
  • moisture -- Int32

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)
Input:
  • sender -- .NET Refnum (BrickletMoisture)
  • moisture -- Int32

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().

Constants

BrickletMoisture.DEVICE_IDENTIFIER

This constant is used to identify a Moisture Bricklet.

The GetIdentity() function and the EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

BrickletMoisture.DEVICE_DISPLAY_NAME

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