Shell - Moisture Bricklet

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

Examples

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

Simple

Download (example-simple.sh)

1
2
3
4
5
6
7
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Moisture Bricklet

# Get current moisture value
tinkerforge call moisture-bricklet $uid get-moisture-value

Callback

Download (example-callback.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Moisture Bricklet

# Handle incoming moisture value callbacks
tinkerforge dispatch moisture-bricklet $uid moisture &

# 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!
tinkerforge call moisture-bricklet $uid set-moisture-callback-period 1000

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

Threshold

Download (example-threshold.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Moisture Bricklet

# Get threshold callbacks with a debounce time of 1 second (1000ms)
tinkerforge call moisture-bricklet $uid set-debounce-period 1000

# Handle incoming moisture value reached callbacks
tinkerforge dispatch moisture-bricklet $uid moisture-reached &

# Configure threshold for moisture value "greater than 200"
tinkerforge call moisture-bricklet $uid set-moisture-callback-threshold threshold-option-greater 200 0

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

API

Possible exit codes for all tinkerforge commands are:

  • 1: interrupted (ctrl+c)
  • 2: syntax error
  • 21: Python 2.5 or newer is required
  • 22: Python argparse module is missing
  • 23: socket error
  • 24: other exception
  • 25: invalid placeholder in format string
  • 26: authentication error
  • 201: timeout occurred
  • 209: invalid argument value
  • 210: function is not supported
  • 211: unknown error

Command Structure

The common options of the call and dispatch commands are documented here. The specific command structure is shown below.

tinkerforge call moisture-bricklet [<option>..] <uid> <function> [<argument>..]
Parameters:
  • <uid> -- string
  • <function> -- string

The call command is used to call a function of the Moisture Bricklet. It can take several options:

  • --help shows help for the specific call command and exits
  • --list-functions shows a list of known functions of the Moisture Bricklet and exits
tinkerforge dispatch moisture-bricklet [<option>..] <uid> <callback>
Parameters:
  • <uid> -- string
  • <callback> -- string

The dispatch command is used to dispatch a callback of the Moisture Bricklet. It can take several options:

  • --help shows help for the specific dispatch command and exits
  • --list-callbacks shows a list of known callbacks of the Moisture Bricklet and exits
tinkerforge call moisture-bricklet <uid> <function> [<option>..] [<argument>..]
Parameters:
  • <uid> -- string
  • <function> -- string

The <function> to be called can take different options depending of its kind. All functions can take the following options:

  • --help shows help for the specific function and exits

Getter functions can take the following options:

  • --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Setter functions can take the following options:

  • --expect-response requests response and waits for it

The --expect-response option for setter functions allows to detect timeouts and other error conditions calls of setters as well. The device will then send a response for this purpose. If this option is not given for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch moisture-bricklet <uid> <callback> [<option>..]
Parameters:
  • <uid> -- string
  • <callback> -- string

The <callback> to be dispatched can take several options:

  • --help shows help for the specific callback and exits
  • --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Basic Functions

tinkerforge call moisture-bricklet <uid> get-moisture-value
Output:
  • moisture -- int

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

Advanced Functions

tinkerforge call moisture-bricklet <uid> set-moving-average <average>
Parameters:
  • <average> -- int
Output:

no output

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.

tinkerforge call moisture-bricklet <uid> get-moving-average
Output:
  • average -- int

Returns the length moving average as set by set-moving-average.

tinkerforge call moisture-bricklet <uid> get-identity
Output:
  • uid -- string
  • connected-uid -- string
  • position -- char
  • hardware-version -- int,int,int
  • firmware-version -- int,int,int
  • device-identifier -- int (has symbols)

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

tinkerforge call moisture-bricklet <uid> set-moisture-callback-period <period>
Parameters:
  • <period> -- int
Output:

no output

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

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

The default value is 0.

tinkerforge call moisture-bricklet <uid> get-moisture-callback-period
Output:
  • period -- int

Returns the period as set by set-moisture-callback-period.

tinkerforge call moisture-bricklet <uid> set-moisture-callback-threshold <option> <min> <max>
Parameters:
  • <option> -- char (has symbols)
  • <min> -- int
  • <max> -- int
Output:

no output

Sets the thresholds for the 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 symbols are available for this function:

  • threshold-option-off = x, for <option>
  • threshold-option-outside = o, for <option>
  • threshold-option-inside = i, for <option>
  • threshold-option-smaller = <, for <option>
  • threshold-option-greater = >, for <option>
tinkerforge call moisture-bricklet <uid> get-moisture-callback-threshold
Output:
  • option -- char (has symbols)
  • min -- int
  • max -- int

Returns the threshold as set by set-moisture-callback-threshold.

The following symbols are available for this function:

  • threshold-option-off = x, for option
  • threshold-option-outside = o, for option
  • threshold-option-inside = i, for option
  • threshold-option-smaller = <, for option
  • threshold-option-greater = >, for option
tinkerforge call moisture-bricklet <uid> set-debounce-period <debounce>
Parameters:
  • <debounce> -- int
Output:

no output

Sets the period in ms with which the threshold callback

is triggered, if the threshold

keeps being reached.

The default value is 100.

tinkerforge call moisture-bricklet <uid> get-debounce-period
Output:
  • debounce -- int

Returns the debounce period as set by set-debounce-period.

Callbacks

Callbacks can be used to receive time critical or recurring data from the device:

tinkerforge dispatch moisture-bricklet <uid> example

The available callbacks 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.

tinkerforge dispatch moisture-bricklet <uid> moisture
Output:
  • moisture -- int

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

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

tinkerforge dispatch moisture-bricklet <uid> moisture-reached
Output:
  • moisture -- int

This callback is triggered when the threshold as set by set-moisture-callback-threshold 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 set-debounce-period.