TCP/IP - Moisture Bricklet

This is the description of the TCP/IP protocol for the Moisture Bricklet. General information and technical specifications for the Moisture Bricklet are summarized in its hardware description.

API

A general description of the TCP/IP protocol structure can be found here.

Basic Functions

BrickletMoisture.get_moisture_value
Function ID:

1

Request:

empty payload

Response:
  • moisture -- uint16

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 CALLBACK_MOISTURE callback and set the period with set_moisture_callback_period.

Advanced Functions

BrickletMoisture.set_moving_average
Function ID:

10

Request:
  • average -- uint8
Response:

no response

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.get_moving_average
Function ID:

11

Request:

empty payload

Response:
  • average -- uint8

Returns the length moving average as set by set_moving_average.

BrickletMoisture.get_identity
Function ID:

255

Request:

empty payload

Response:
  • uid -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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

Callback Configuration Functions

BrickletMoisture.set_moisture_callback_period
Function ID:

2

Request:
  • period -- uint32
Response:

no response

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

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

The default value is 0.

BrickletMoisture.get_moisture_callback_period
Function ID:

3

Request:

empty payload

Response:
  • period -- uint32

Returns the period as set by set_moisture_callback_period.

BrickletMoisture.set_moisture_callback_threshold
Function ID:

4

Request:
  • option -- char
  • min -- uint16
  • max -- uint16
Response:

no response

Sets the thresholds for the CALLBACK_MOISTURE_REACHED 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 meanings are defined for the parameters of this function:

  • x: off, for option
  • o: outside, for option
  • i: inside, for option
  • <: smaller, for option
  • >: greater, for option
BrickletMoisture.get_moisture_callback_threshold
Function ID:

5

Request:

empty payload

Response:
  • option -- char
  • min -- uint16
  • max -- uint16

Returns the threshold as set by set_moisture_callback_threshold.

The following meanings are defined for the parameters of this function:

  • x: off, for option
  • o: outside, for option
  • i: inside, for option
  • <: smaller, for option
  • >: greater, for option
BrickletMoisture.set_debounce_period
Function ID:

6

Request:
  • debounce -- uint32
Response:

no response

Sets the period in ms with which the threshold callback

is triggered, if the threshold

keeps being reached.

The default value is 100.

BrickletMoisture.get_debounce_period
Function ID:

7

Request:

empty payload

Response:
  • debounce -- uint32

Returns the debounce period as set by set_debounce_period.

Callbacks

BrickletMoisture.CALLBACK_MOISTURE
Function ID:

8

Response:
  • moisture -- uint16

This callback is triggered periodically with the period that is set by set_moisture_callback_period. The response value is the moisture value of the sensor.

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

BrickletMoisture.CALLBACK_MOISTURE_REACHED
Function ID:

9

Response:
  • moisture -- uint16

This callback is triggered when the threshold as set by set_moisture_callback_threshold is reached. The response value is the moisture value of the sensor.

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