Shell - Temperature IR Bricklet¶

Simple¶

Download (example-simple.sh)

 1#!/bin/sh
 2# Connects to localhost:4223 by default, use --host and --port to change this
 3
 4uid=XYZ # Change XYZ to the UID of your Temperature IR Bricklet
 5
 6# Get current ambient temperature
 7tinkerforge call temperature-ir-bricklet $uid get-ambient-temperature
 8
 9# Get current object temperature
10tinkerforge call temperature-ir-bricklet $uid get-object-temperature

Callback¶

Download (example-callback.sh)

 1#!/bin/sh
 2# Connects to localhost:4223 by default, use --host and --port to change this
 3
 4uid=XYZ # Change XYZ to the UID of your Temperature IR Bricklet
 5
 6# Handle incoming object temperature callbacks
 7tinkerforge dispatch temperature-ir-bricklet $uid object-temperature &
 8
 9# Set period for object temperature callback to 1s (1000ms)
10# Note: The object temperature callback is only called every second
11#       if the object temperature has changed since the last call!
12tinkerforge call temperature-ir-bricklet $uid set-object-temperature-callback-period 1000
13
14echo "Press key to exit"; read dummy
15
16kill -- -$$ # Stop callback dispatch in background

Water Boiling¶

Download (example-water-boiling.sh)

 1#!/bin/sh
 2# Connects to localhost:4223 by default, use --host and --port to change this
 3
 4uid=XYZ # Change XYZ to the UID of your Temperature IR Bricklet
 5
 6# Set emissivity to 0.98 (emissivity of water, 65535 * 0.98 = 64224.299)
 7tinkerforge call temperature-ir-bricklet $uid set-emissivity 64224
 8
 9# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
10tinkerforge call temperature-ir-bricklet $uid set-debounce-period 10000
11
12# Handle incoming object temperature reached callbacks
13tinkerforge dispatch temperature-ir-bricklet $uid object-temperature-reached\
14 --execute "echo Object Temperature: {temperature}/10 °C. The water is boiling!" &
15
16# Configure threshold for object temperature "greater than 100 °C"
17tinkerforge call temperature-ir-bricklet $uid set-object-temperature-callback-threshold threshold-option-greater 1000 0
18
19echo "Press key to exit"; read dummy
20
21kill -- -$$ # 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-ir-bricklet [<option>..] <uid> <function> [<argument>..]¶

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

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

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

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

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

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

Output:	temperature – Type: Int, Unit: 1/10 °C, Range: [-400 to 1250]

Returns the ambient temperature of the sensor.

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

tinkerforge call temperature-ir-bricklet <uid> get-object-temperature¶

Output:	temperature – Type: Int, Unit: 1/10 °C, Range: [-700 to 3800]

Returns the object temperature of the sensor, i.e. the temperature of the surface of the object the sensor is aimed at.

The temperature of different materials is dependent on their emissivity. The emissivity of the material can be set with set-emissivity.

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

Advanced Functions¶

tinkerforge call temperature-ir-bricklet <uid> set-emissivity <emissivity>¶

Parameters:	<emissivity> – Type: Int, Unit: 1/65535, Range: [6553 to 216 - 1], Default: 216 - 1
Output:	no output

Sets the emissivity that is used to calculate the surface temperature as returned by get-object-temperature.

The emissivity is usually given as a value between 0.0 and 1.0. A list of emissivities of different materials can be found here.

The parameter of set-emissivity has to be given with a factor of 65535 (16-bit). For example: An emissivity of 0.1 can be set with the value 6553, an emissivity of 0.5 with the value 32767 and so on.

Note

If you need a precise measurement for the object temperature, it is absolutely crucial that you also provide a precise emissivity.

The emissivity is stored in non-volatile memory and will still be used after a restart or power cycle of the Bricklet.

tinkerforge call temperature-ir-bricklet <uid> get-emissivity¶

Output:	emissivity – Type: Int, Unit: 1/65535, Range: [6553 to 216 - 1], Default: 216 - 1

Returns the emissivity as set by set-emissivity.

tinkerforge call temperature-ir-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-ir-bricklet <uid> set-ambient-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 ambient-temperature callback is triggered periodically. A value of 0 turns the callback off.

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

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

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

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

tinkerforge call temperature-ir-bricklet <uid> set-object-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 object-temperature callback is triggered periodically. A value of 0 turns the callback off.

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

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

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

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

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

Parameters:	<option> – Type: Char, Range: See symbols, Default: x <min> – Type: Int, Unit: 1/10 °C, Range: [-215 to 215 - 1], Default: 0 <max> – Type: Int, Unit: 1/10 °C, Range: [-215 to 215 - 1], Default: 0
Output:	no output

Sets the thresholds for the ambient-temperature-reached callback.

The following options are possible:

Option	Description
'x'	Callback is turned off
'o'	Callback is triggered when the ambient temperature is outside the min and max values
'i'	Callback is triggered when the ambient temperature is inside the min and max values
'<'	Callback is triggered when the ambient temperature is smaller than the min value (max is ignored)
'>'	Callback is triggered when the ambient 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-ir-bricklet <uid> get-ambient-temperature-callback-threshold¶

Output:	option – Type: Char, Range: See symbols, Default: x min – Type: Int, Unit: 1/10 °C, Range: [-215 to 215 - 1], Default: 0 max – Type: Int, Unit: 1/10 °C, Range: [-215 to 215 - 1], Default: 0

Returns the threshold as set by set-ambient-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-ir-bricklet <uid> set-object-temperature-callback-threshold <option> <min> <max>¶

Parameters:	<option> – Type: Char, Range: See symbols, Default: x <min> – Type: Int, Unit: 1/10 °C, Range: [-215 to 215 - 1], Default: 0 <max> – Type: Int, Unit: 1/10 °C, Range: [-215 to 215 - 1], Default: 0
Output:	no output

Sets the thresholds for the object-temperature-reached callback.

The following options are possible:

Option	Description
'x'	Callback is turned off
'o'	Callback is triggered when the object temperature is outside the min and max values
'i'	Callback is triggered when the object temperature is inside the min and max values
'<'	Callback is triggered when the object temperature is smaller than the min value (max is ignored)
'>'	Callback is triggered when the object 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-ir-bricklet <uid> get-object-temperature-callback-threshold¶

Output:	option – Type: Char, Range: See symbols, Default: x min – Type: Int, Unit: 1/10 °C, Range: [-215 to 215 - 1], Default: 0 max – Type: Int, Unit: 1/10 °C, Range: [-215 to 215 - 1], Default: 0

Returns the threshold as set by set-object-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-ir-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 callbacks

• ambient-temperature-reached,

• object-temperature-reached

are triggered, if the thresholds

• set-ambient-temperature-callback-threshold,

• set-object-temperature-callback-threshold

keep being reached.

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

The available callbacks are described below.

tinkerforge dispatch temperature-ir-bricklet <uid> ambient-temperature¶

Output:	temperature – Type: Int, Unit: 1/10 °C, Range: [-400 to 1250]

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

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

tinkerforge dispatch temperature-ir-bricklet <uid> object-temperature¶

Output:	temperature – Type: Int, Unit: 1/10 °C, Range: [-700 to 3800]

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

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

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

Output:	temperature – Type: Int, Unit: 1/10 °C, Range: [-400 to 1250]

This callback is triggered when the threshold as set by set-ambient-temperature-callback-threshold is reached. The parameter is the ambient temperature 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 temperature-ir-bricklet <uid> object-temperature-reached¶

Output:	temperature – Type: Int, Unit: 1/10 °C, Range: [-700 to 3800]

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

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