Shell - Humidity Bricklet

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.

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 Humidity Bricklet

# Get current humidity
tinkerforge call humidity-bricklet $uid get-humidity

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 Humidity Bricklet

# Handle incoming humidity callbacks
tinkerforge dispatch humidity-bricklet $uid humidity &

# 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

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
18
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

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

# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
tinkerforge call humidity-bricklet $uid set-debounce-period 10000

# Handle incoming humidity reached callbacks
tinkerforge dispatch humidity-bricklet $uid humidity-reached\
 --execute "echo Humidity: {humidity}/10 %RH. Recommended humidity for human comfort is 30 to 60 %RH." &

# Configure threshold for humidity "outside of 30 to 60 %RH"
tinkerforge call humidity-bricklet $uid set-humidity-callback-threshold threshold-option-outside 300 600

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 humidity-bricklet [<option>..] <uid> <function> [<argument>..]
Parameters:
  • <uid> -- string
  • <function> -- string

The call command is used to call a function of the Humidity 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 Humidity Bricklet and exits
tinkerforge dispatch humidity-bricklet [<option>..] <uid> <callback>
Parameters:
  • <uid> -- string
  • <callback> -- string

The dispatch command is used to dispatch a callback of the Humidity 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 Humidity Bricklet and exits
tinkerforge call humidity-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 humidity-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 humidity-bricklet <uid> get-humidity
Output:
  • humidity -- int

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

Advanced Functions

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

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

tinkerforge call humidity-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 humidity-bricklet <uid> set-humidity-callback-period <period>
Parameters:
  • <period> -- int
Output:

no output

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

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

The default value is 0.

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

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

tinkerforge call humidity-bricklet <uid> set-analog-value-callback-period <period>
Parameters:
  • <period> -- int
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.

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

The default value is 0.

tinkerforge call humidity-bricklet <uid> get-analog-value-callback-period
Output:
  • period -- int

Returns the period as set by set-analog-value-callback-period.

tinkerforge call humidity-bricklet <uid> set-humidity-callback-threshold <option> <min> <max>
Parameters:
  • <option> -- char (has symbols)
  • <min> -- int
  • <max> -- int
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:

  • 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 humidity-bricklet <uid> get-humidity-callback-threshold
Output:
  • option -- char (has symbols)
  • min -- int
  • max -- int

Returns the threshold as set by set-humidity-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 humidity-bricklet <uid> set-analog-value-callback-threshold <option> <min> <max>
Parameters:
  • <option> -- char (has symbols)
  • <min> -- int
  • <max> -- int
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:

  • 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 humidity-bricklet <uid> get-analog-value-callback-threshold
Output:
  • option -- char (has symbols)
  • min -- int
  • max -- int

Returns the threshold as set by set-analog-value-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 humidity-bricklet <uid> set-debounce-period <debounce>
Parameters:
  • <debounce> -- int
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.

tinkerforge call humidity-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 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.

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

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

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

tinkerforge dispatch humidity-bricklet <uid> analog-value
Output:
  • value -- int

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.

The analog-value callback is only triggered if the humidity has changed since the last triggering.

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

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.

tinkerforge dispatch humidity-bricklet <uid> analog-value-reached
Output:
  • value -- int

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.