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.
The example code below is Public Domain (CC0 1.0).
1 2 3 4 5 6 7 8 | #!/bin/sh
# connects to localhost:4223 by default, use --host and --port to change it
# change to your UID
uid=XYZ
# get current moisture value
tinkerforge call moisture-bricklet $uid get-moisture-value
|
Download (example-callback.sh)
1 2 3 4 5 6 7 8 9 10 11 12 13 | #!/bin/sh
# connects to localhost:4223 by default, use --host and --port to change it
# change to your UID
uid=XYZ
# set period for moisture callback to 1s (1000ms)
# note: the moisture 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
# handle incoming moisture callbacks
tinkerforge dispatch moisture-bricklet $uid moisture
|
Download (example-threshold.sh)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | #!/bin/sh
# connects to localhost:4223 by default, use --host and --port to change it
# change to your UID
uid=XYZ
# get threshold callbacks with a debounce time of 1 seconds (1000ms)
tinkerforge call moisture-bricklet $uid set-debounce-period 1000
# configure threshold for "greater than 200"
tinkerforge call moisture-bricklet $uid set-moisture-callback-threshold greater 200 0
# handle incoming moisture-reached callbacks
tinkerforge dispatch moisture-bricklet $uid moisture-reached
|
Possible exit codes for all tinkerforge commands are:
The common options of the call and dispatch commands are documented here. The specific command structure is shown below.
Parameters: |
|
---|
The call command is used to call a function of the Moisture Bricklet. It can take several options:
Parameters: |
|
---|
The dispatch command is used to dispatch a callback of the Moisture Bricklet. It can take several options:
Parameters: |
|
---|
The <function> to be called can take different options depending of its kind. All functions can take the following options:
Getter functions can take the following options:
Setter functions can take the following options:
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.
Parameters: |
|
---|
The <callback> to be dispatched can take several options:
Output: |
|
---|
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 and set the period with set-moisture-callback-period.
Parameters: |
|
---|---|
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.
Output: |
|
---|
Returns the length moving average as set by set-moving-average.
Output: |
|
---|
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.
Parameters: |
|
---|---|
Output: | no output |
Sets the period in ms with which the moisture callback is triggered periodically. A value of 0 turns the callback off.
moisture is only triggered if the moisture value has changed since the last triggering.
The default value is 0.
Output: |
|
---|
Returns the period as set by set-moisture-callback-period.
Parameters: |
|
---|---|
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:
Output: |
|
---|
Returns the threshold as set by set-moisture-callback-threshold.
The following symbols are available for this function:
Parameters: |
|
---|---|
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.
Output: |
|
---|
Returns the debounce period as set by set-debounce-period.
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.
Output: |
|
---|
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.
moisture is only triggered if the moisture value has changed since the last triggering.
Output: |
|
---|
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.