Shell - Temperature Bricklet¶

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

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

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

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

# Set period for temperature callback to 1s (1000ms)
# Note: The temperature callback is only called every second
#       if the temperature has changed since the last call!
tinkerforge call temperature-bricklet $uid set-temperature-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 Temperature Bricklet

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

# Handle incoming temperature reached callbacks
tinkerforge dispatch temperature-bricklet $uid temperature-reached\
 --execute "echo Temperature: {temperature}/100 °C. It is too hot, we need air conditioning!" &

# Configure threshold for temperature "greater than 30 °C"
tinkerforge call temperature-bricklet $uid set-temperature-callback-threshold threshold-option-greater 3000 0

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 temperature-bricklet [<option>..] <uid> <function> [<argument>..]¶

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

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

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

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

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

tinkerforge call temperature-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 temperature-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 temperature-bricklet <uid> get-temperature¶

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

Returns the temperature of the sensor.

If you want to get the temperature periodically, it is recommended to use the temperature callback and set the period with set-temperature-callback-period.

Advanced Functions¶

tinkerforge call temperature-bricklet <uid> set-i2c-mode <mode>¶

Parameters:	<mode> – Type: Int, Range: See symbols, Default: 0
Output:	no output

Sets the I2C mode. Possible modes are:

• 0: Fast (400kHz)
• 1: Slow (100kHz)

If you have problems with obvious outliers in the Temperature Bricklet measurements, they may be caused by EMI issues. In this case it may be helpful to lower the I2C speed.

It is however not recommended to lower the I2C speed in applications where a high throughput needs to be achieved.

The following symbols are available for this function:

For <mode>:

• i2c-mode-fast = 0
• i2c-mode-slow = 1

New in version 2.0.1 (Plugin).

tinkerforge call temperature-bricklet <uid> get-i2c-mode¶

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

Returns the I2C mode as set by set-i2c-mode.

The following symbols are available for this function:

For mode:

• i2c-mode-fast = 0
• i2c-mode-slow = 1

New in version 2.0.1 (Plugin).

tinkerforge call temperature-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 temperature-bricklet <uid> set-temperature-callback-period <period>¶

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

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

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

tinkerforge call temperature-bricklet <uid> get-temperature-callback-period¶

Output:	period – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

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

tinkerforge call temperature-bricklet <uid> set-temperature-callback-threshold <option> <min> <max>¶

Parameters:	<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

Sets the thresholds for the temperature-reached callback.

The following options are possible:

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

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 temperature-bricklet <uid> get-temperature-callback-threshold¶

Output:	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 threshold as set by set-temperature-callback-threshold.

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 temperature-bricklet <uid> set-debounce-period <debounce>¶

Parameters:	<debounce> – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100
Output:	no output

Sets the period with which the threshold callback

• temperature-reached

is triggered, if the threshold

• set-temperature-callback-threshold

keeps being reached.

tinkerforge call temperature-bricklet <uid> get-debounce-period¶

Output:	debounce – Type: Int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

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 temperature-bricklet <uid> example

The available callbacks are described below.

tinkerforge dispatch temperature-bricklet <uid> temperature¶

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

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

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

tinkerforge dispatch temperature-bricklet <uid> temperature-reached¶

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

This callback is triggered when the threshold as set by set-temperature-callback-threshold is reached. The parameter is the temperature of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by set-debounce-period.