Shell - Humidity Bricklet 2.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 2.0

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

Callback¶

Download (example-callback.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 this

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

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

# Set period for humidity callback to 1s (1000ms) without a threshold
tinkerforge call humidity-v2-bricklet $uid set-humidity-callback-configuration 1000 false threshold-option-off 0 0

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

#!/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 2.0

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

# Configure threshold for humidity "outside of 30 to 60 %RH"
# with a debounce period of 10s (10000ms)
tinkerforge call humidity-v2-bricklet $uid set-humidity-callback-configuration 10000 false threshold-option-outside 3000 6000

echo "Press key to exit"; read dummy

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

Command Structure¶

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

tinkerforge call humidity-v2-bricklet [<option>..] <uid> <function> [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: String

The call command is used to call a function of the Humidity Bricklet 2.0. 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 2.0 and exits

tinkerforge dispatch humidity-v2-bricklet [<option>..] <uid> <callback>¶

Parameters:	<uid> – Type: String <callback> – Type: String

The dispatch command is used to dispatch a callback of the Humidity Bricklet 2.0. 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 2.0 and exits

tinkerforge call humidity-v2-bricklet <uid> <function> [<option>..] [<argument>..]¶

Parameters:	<uid> – Type: String <function> – Type: 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 sent and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch humidity-v2-bricklet <uid> <callback> [<option>..]¶

Parameters:	<uid> – Type: String <callback> – Type: 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-v2-bricklet <uid> get-humidity¶

Output:	humidity – Type: Int, Unit: 1/100 %, Range: [0 to 10000]

Returns the humidity measured by the sensor.

If you want to get the value periodically, it is recommended to use the humidity callback. You can set the callback configuration with set-humidity-callback-configuration.

tinkerforge call humidity-v2-bricklet <uid> get-temperature¶

Output:	temperature – Type: Int, Unit: 1/100 °C, Range: [-4000 to 16500]

Returns the temperature measured by the sensor.

If you want to get the value periodically, it is recommended to use the temperature callback. You can set the callback configuration with set-temperature-callback-configuration.

tinkerforge call humidity-v2-bricklet <uid> set-heater-configuration <heater-config>¶

Parameters:	<heater-config> – Type: Int, Range: See symbols, Default: False
Output:	no output

Enables/disables the heater. The heater can be used to dry the sensor in extremely wet conditions.

The following symbols are available for this function:

For <heater-config>:

• heater-config-disabled = 0
• heater-config-enabled = 1

tinkerforge call humidity-v2-bricklet <uid> get-heater-configuration¶

Output:	heater-config – Type: Int, Range: See symbols, Default: False

Returns the heater configuration as set by set-heater-configuration.

The following symbols are available for this function:

For heater-config:

• heater-config-disabled = 0
• heater-config-enabled = 1

tinkerforge call humidity-v2-bricklet <uid> set-moving-average-configuration <moving-average-length-humidity> <moving-average-length-temperature>¶

Parameters:	<moving-average-length-humidity> – Type: Int, Range: [1 to 1000], Default: 5 <moving-average-length-temperature> – Type: Int, Range: [1 to 1000], Default: 5
Output:	no output

Sets the length of a moving averaging for the humidity and temperature.

Setting the length to 1 will turn the averaging off. With less averaging, there is more noise on the data.

New data is gathered every 50ms*. With a moving average of length 1000 the resulting averaging window has a length of 50s. If you want to do long term measurements the longest moving average will give the cleanest results.

* In firmware version 2.0.3 we added the set-samples-per-second function. It configures the measurement frequency. Since high frequencies can result in self-heating of th IC, changed the default value from 20 samples per second to 1. With 1 sample per second a moving average length of 1000 would result in an averaging window of 1000 seconds!

tinkerforge call humidity-v2-bricklet <uid> get-moving-average-configuration¶

Output:	moving-average-length-humidity – Type: Int, Range: [1 to 1000], Default: 5 moving-average-length-temperature – Type: Int, Range: [1 to 1000], Default: 5

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

tinkerforge call humidity-v2-bricklet <uid> set-samples-per-second <sps>¶

Parameters:	<sps> – Type: Int, Range: See symbols, Default: 3
Output:	no output

Sets the samples per second that are gathered by the humidity/temperature sensor HDC1080.

We added this function since we found out that a high measurement frequency can lead to self-heating of the sensor. Which can distort the temperature measurement.

If you don't need a lot of measurements, you can use the lowest available measurement frequency of 0.1 samples per second for the least amount of self-heating.

Before version 2.0.3 the default was 20 samples per second. The new default is 1 sample per second.

The following symbols are available for this function:

For <sps>:

• sps-20 = 0
• sps-10 = 1
• sps-5 = 2
• sps-1 = 3
• sps-02 = 4
• sps-01 = 5

New in version 2.0.3 (Plugin).

tinkerforge call humidity-v2-bricklet <uid> get-samples-per-second¶

Output:	sps – Type: Int, Range: See symbols, Default: 3

Returnes the samples per second, as set by set-samples-per-second.

The following symbols are available for this function:

For sps:

• sps-20 = 0
• sps-10 = 1
• sps-5 = 2
• sps-1 = 3
• sps-02 = 4
• sps-01 = 5

New in version 2.0.3 (Plugin).

Advanced Functions¶

tinkerforge call humidity-v2-bricklet <uid> get-spitfp-error-count¶

Output:	error-count-ack-checksum – Type: Int, Range: [0 to 232 - 1] error-count-message-checksum – Type: Int, Range: [0 to 232 - 1] error-count-frame – Type: Int, Range: [0 to 232 - 1] error-count-overflow – Type: Int, Range: [0 to 232 - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

• ACK checksum errors,
• message checksum errors,
• framing errors and
• overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

tinkerforge call humidity-v2-bricklet <uid> set-status-led-config <config>¶

Parameters:	<config> – Type: Int, Range: See symbols, Default: 3
Output:	no output

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following symbols are available for this function:

For <config>:

• status-led-config-off = 0
• status-led-config-on = 1
• status-led-config-show-heartbeat = 2
• status-led-config-show-status = 3

tinkerforge call humidity-v2-bricklet <uid> get-status-led-config¶

Output:	config – Type: Int, Range: See symbols, Default: 3

Returns the configuration as set by set-status-led-config

The following symbols are available for this function:

For config:

• status-led-config-off = 0
• status-led-config-on = 1
• status-led-config-show-heartbeat = 2
• status-led-config-show-status = 3

tinkerforge call humidity-v2-bricklet <uid> get-chip-temperature¶

Output:	temperature – Type: Int, Unit: 1 °C, Range: [-215 to 215 - 1]

Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

tinkerforge call humidity-v2-bricklet <uid> reset¶

Output:	no output

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

tinkerforge call humidity-v2-bricklet <uid> get-identity¶

Output:

uid – Type: String, Length: up to 8 connected-uid – Type: String, Length: up to 8 position – Type: Char, Range: [a to h, z] hardware-version – Type: Int Array, Length: 3 0: major – Type: Int, Range: [0 to 255] 1: minor – Type: Int, Range: [0 to 255] 2: revision – Type: Int, Range: [0 to 255] firmware-version – Type: Int Array, Length: 3 0: major – Type: Int, Range: [0 to 255] 1: minor – Type: Int, Range: [0 to 255] 2: revision – Type: Int, Range: [0 to 255] device-identifier – Type: Int, Range: [0 to 216 - 1]

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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. 

Callback Configuration Functions¶

tinkerforge call humidity-v2-bricklet <uid> set-humidity-callback-configuration <period> <value-has-to-change> <option> <min> <max>¶

Parameters:	<period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 <value-has-to-change> – Type: Bool, Default: false <option> – Type: Char, Range: See symbols, Default: x <min> – Type: Int, Unit: 1/100 %, Range: [0 to 216 - 1], Default: 0 <max> – Type: Int, Unit: 1/100 %, Range: [0 to 216 - 1], Default: 0
Output:	no output

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

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the humidity callback.

The following options are possible:

Option	Description
'x'	Threshold is turned off
'o'	Threshold is triggered when the value is outside the min and max values
'i'	Threshold is triggered when the value is inside or equal to the min and max values
'<'	Threshold is triggered when the value is smaller than the min value (max is ignored)
'>'	Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The following symbols are available for this function:

For <option>:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call humidity-v2-bricklet <uid> get-humidity-callback-configuration¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 value-has-to-change – Type: Bool, Default: false option – Type: Char, Range: See symbols, Default: x min – Type: Int, Unit: 1/100 %, Range: [0 to 216 - 1], Default: 0 max – Type: Int, Unit: 1/100 %, Range: [0 to 216 - 1], Default: 0

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

The following symbols are available for this function:

For option:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call humidity-v2-bricklet <uid> set-temperature-callback-configuration <period> <value-has-to-change> <option> <min> <max>¶

Parameters:	<period> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 <value-has-to-change> – Type: Bool, Default: false <option> – Type: Char, Range: See symbols, Default: x <min> – Type: Int, Unit: 1/100 °C, Range: [-215 to 215 - 1], Default: 0 <max> – Type: Int, Unit: 1/100 °C, Range: [-215 to 215 - 1], Default: 0
Output:	no output

The period is the period with which the temperature callback is triggered periodically. A value of 0 turns the callback off.

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

It is furthermore possible to constrain the callback with thresholds.

The option-parameter together with min/max sets a threshold for the temperature callback.

The following options are possible:

Option	Description
'x'	Threshold is turned off
'o'	Threshold is triggered when the value is outside the min and max values
'i'	Threshold is triggered when the value is inside or equal to the min and max values
'<'	Threshold is triggered when the value is smaller than the min value (max is ignored)
'>'	Threshold is triggered when the value is greater than the min value (max is ignored)

If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.

The following symbols are available for this function:

For <option>:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

tinkerforge call humidity-v2-bricklet <uid> get-temperature-callback-configuration¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 value-has-to-change – Type: Bool, Default: false option – Type: Char, Range: See symbols, Default: x min – Type: Int, Unit: 1/100 °C, Range: [-215 to 215 - 1], Default: 0 max – Type: Int, Unit: 1/100 °C, Range: [-215 to 215 - 1], Default: 0

Returns the callback configuration as set by set-temperature-callback-configuration.

The following symbols are available for this function:

For option:

• threshold-option-off = x
• threshold-option-outside = o
• threshold-option-inside = i
• threshold-option-smaller = <
• threshold-option-greater = >

Callbacks¶

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

tinkerforge dispatch humidity-v2-bricklet <uid> example

The available callbacks are described below.

tinkerforge dispatch humidity-v2-bricklet <uid> humidity¶

Output:	humidity – Type: Int, Unit: 1/100 %, Range: [0 to 10000]

This callback is triggered periodically according to the configuration set by set-humidity-callback-configuration.

The parameter is the same as get-humidity.

tinkerforge dispatch humidity-v2-bricklet <uid> temperature¶

Output:	temperature – Type: Int, Unit: 1/100 °C, Range: [-4000 to 16500]

This callback is triggered periodically according to the configuration set by set-temperature-callback-configuration.

The parameter is the same as get-temperature.

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

tinkerforge call humidity-v2-bricklet <uid> set-bootloader-mode <mode>¶

Parameters:	<mode> – Type: Int, Range: See symbols
Output:	status – Type: Int, Range: See symbols

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following symbols are available for this function:

For <mode>:

• bootloader-mode-bootloader = 0
• bootloader-mode-firmware = 1
• bootloader-mode-bootloader-wait-for-reboot = 2
• bootloader-mode-firmware-wait-for-reboot = 3
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

For status:

• bootloader-status-ok = 0
• bootloader-status-invalid-mode = 1
• bootloader-status-no-change = 2
• bootloader-status-entry-function-not-present = 3
• bootloader-status-device-identifier-incorrect = 4
• bootloader-status-crc-mismatch = 5

tinkerforge call humidity-v2-bricklet <uid> get-bootloader-mode¶

Output:	mode – Type: Int, Range: See symbols

Returns the current bootloader mode, see set-bootloader-mode.

The following symbols are available for this function:

For mode:

• bootloader-mode-bootloader = 0
• bootloader-mode-firmware = 1
• bootloader-mode-bootloader-wait-for-reboot = 2
• bootloader-mode-firmware-wait-for-reboot = 3
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

tinkerforge call humidity-v2-bricklet <uid> set-write-firmware-pointer <pointer>¶

Parameters:	<pointer> – Type: Int, Unit: 1 B, Range: [0 to 232 - 1]
Output:	no output

Sets the firmware pointer for write-firmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

tinkerforge call humidity-v2-bricklet <uid> write-firmware <data>¶

Parameters:	<data> – Type: Int Array, Length: 64, Range: [0 to 255]
Output:	status – Type: Int, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by set-write-firmware-pointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

tinkerforge call humidity-v2-bricklet <uid> write-uid <uid>¶

Parameters:	<uid> – Type: Int, Range: [0 to 232 - 1]
Output:	no output

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

tinkerforge call humidity-v2-bricklet <uid> read-uid¶

Output:	uid – Type: Int, Range: [0 to 232 - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.