This is the description of the Shell API bindings for the Humidity Bricklet. General information and technical specifications for the Humidity 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=7bA
# get current humidity (unit is %RH/10)
tinkerforge call humidity-bricklet $uid get-humidity
|
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=7bA
# set period for humidity callback to 1s (1000ms)
# note: the humidity callback is only called every second if the
# humidity has changed since the last call!
tinkerforge call humidity-bricklet $uid set-humidity-callback-period 1000
# handle incoming humidity callbacks (unit is %RH/10)
tinkerforge dispatch humidity-bricklet $uid humidity
|
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 it
# change to your UID
uid=7bA
# get threshold callbacks with a debounce time of 10 seconds (10000ms)
tinkerforge call humidity-bricklet $uid set-debounce-period 10000
# configure threshold for "outside of 30 to 60 %RH" (unit is %RH/10)
tinkerforge call humidity-bricklet $uid set-humidity-callback-threshold outside 300 600
# handle incoming humidity-reached callbacks (unit is %RH/10)
tinkerforge dispatch humidity-bricklet $uid humidity-reached\
--execute "if [ {humidity} -lt 300 ]; then echo 'Humidity too low: {humidity} %RH/10';
elif [ {humidity} -gt 600 ]; then echo 'Humidity too high: {humidity} %RH/10'; fi;
echo Recommended humiditiy for human comfort is 300 to 600 %RH/10"
|
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 Humidity Bricklet. It can take several options:
Parameters: |
|
---|
The dispatch command is used to dispatch a callback of the Humidity 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 humidity of the sensor. The value has a range of 0 to 1000 and is given in %RH/10 (Relative Humidity), i.e. a value of 421 means that a humidity of 42.1 %RH is measured.
If you want to get the humidity periodically, it is recommended to use the callback humidity and set the period with set-humidity-callback-period.
Output: |
|
---|
Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.
Note
The value returned by get-humidity is averaged over several samples to yield less noise, while get-analog-value gives back raw unfiltered analog values. The returned humidity value is calibrated for room temperatures, if you use the sensor in extreme cold or extreme warm environments, you might want to calculate the humidity from the analog value yourself. See the HIH 5030 datasheet.
If you want the analog value periodically, it is recommended to use the callback analog-value and set the period with set-analog-value-callback-period.
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 humidity callback is triggered periodically. A value of 0 turns the callback off.
humidity is only triggered if the humidity has changed since the last triggering.
The default value is 0.
Output: |
|
---|
Returns the period as set by set-humidity-callback-period.
Parameters: |
|
---|---|
Output: | no output |
Sets the period in ms with which the analog-value callback is triggered periodically. A value of 0 turns the callback off.
analog-value is only triggered if the analog value has changed since the last triggering.
The default value is 0.
Output: |
|
---|
Returns the period as set by set-analog-value-callback-period.
Parameters: |
|
---|---|
Output: | no output |
Sets the thresholds for the humidity-reached callback.
The following options are possible:
Option | Description |
---|---|
'x' | Callback is turned off |
'o' | Callback is triggered when the humidity is outside the min and max values |
'i' | Callback is triggered when the humidity is inside the min and max values |
'<' | Callback is triggered when the humidity is smaller than the min value (max is ignored) |
'>' | Callback is triggered when the humidity 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-humidity-callback-threshold.
The following symbols are available for this function:
Parameters: |
|
---|---|
Output: | no output |
Sets the thresholds for the analog-value-reached callback.
The following options are possible:
Option | Description |
---|---|
'x' | Callback is turned off |
'o' | Callback is triggered when the analog value is outside the min and max values |
'i' | Callback is triggered when the analog value is inside the min and max values |
'<' | Callback is triggered when the analog value is smaller than the min value (max is ignored) |
'>' | Callback is triggered when the analog 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-analog-value-callback-threshold.
The following symbols are available for this function:
Parameters: |
|
---|---|
Output: | no output |
Sets the period in ms with which the threshold callbacks
are triggered, if the thresholds
keep 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 humidity-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-humidity-callback-period. The parameter is the humidity of the sensor.
humidity is only triggered if the humidity has changed since the last triggering.
Output: |
|
---|
This callback is triggered periodically with the period that is set by set-analog-value-callback-period. The parameter is the analog value of the sensor.
analog-value is only triggered if the humidity has changed since the last triggering.
Output: |
|
---|
This callback is triggered when the threshold as set by set-humidity-callback-threshold is reached. The parameter is the humidity of the sensor.
If the threshold keeps being reached, the callback is triggered periodically with the period as set by set-debounce-period.
Output: |
|
---|
This callback is triggered when the threshold as set by set-analog-value-callback-threshold is reached. The parameter is the analog value of the sensor.
If the threshold keeps being reached, the callback is triggered periodically with the period as set by set-debounce-period.