Shell - Temperature IR Bricklet

This is the description of the Shell API bindings for the Temperature IR Bricklet. General information and technical specifications for the Temperature IR 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
 8
 9
10
#!/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 IR Bricklet

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

# Get current object temperature
tinkerforge call temperature-ir-bricklet $uid get-object-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 IR Bricklet

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

# Set period for object temperature callback to 1s (1000ms)
# Note: The object temperature callback is only called every second
#       if the object temperature has changed since the last call!
tinkerforge call temperature-ir-bricklet $uid set-object-temperature-callback-period 1000

echo "Press key to exit"; read dummy

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

Water Boiling

Download (example-water-boiling.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
#!/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 IR Bricklet

# Set emissivity to 0.98 (emissivity of water, 65535 * 0.98 = 64224.299)
tinkerforge call temperature-ir-bricklet $uid set-emissivity 64224

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

# Handle incoming object temperature reached callbacks
tinkerforge dispatch temperature-ir-bricklet $uid object-temperature-reached\
 --execute "echo Object Temperature: {temperature}/10 °C. The water is boiling!" &

# Configure threshold for object temperature "greater than 100 °C"
tinkerforge call temperature-ir-bricklet $uid set-object-temperature-callback-threshold threshold-option-greater 1000 0

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 temperature-ir-bricklet [<option>..] <uid> <function> [<argument>..]
Parameters:
  • <uid> -- string
  • <function> -- 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> -- string
  • <callback> -- 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> -- 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 temperature-ir-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 temperature-ir-bricklet <uid> get-ambient-temperature
Output:
  • temperature -- int

Returns the ambient temperature of the sensor. The value has a range of -400 to 1250 and is given in °C/10, e.g. a value of 423 means that an ambient temperature of 42.3 °C is measured.

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 -- int

Returns the object temperature of the sensor, i.e. the temperature of the surface of the object the sensor is aimed at. The value has a range of -700 to 3800 and is given in °C/10, e.g. a value of 3001 means that a temperature of 300.1 °C is measured on the surface of the object.

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> -- int
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 default emissivity is 1.0 (value of 65535) and the minimum emissivity the sensor can handle is 0.1 (value of 6553).

tinkerforge call temperature-ir-bricklet <uid> get-emissivity
Output:
  • emissivity -- int

Returns the emissivity as set by set-emissivity.

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

no output

Sets the period in ms 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.

The default value is 0.

tinkerforge call temperature-ir-bricklet <uid> get-ambient-temperature-callback-period
Output:
  • period -- int

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> -- int
Output:

no output

Sets the period in ms 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.

The default value is 0.

tinkerforge call temperature-ir-bricklet <uid> get-object-temperature-callback-period
Output:
  • period -- int

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

Returns the threshold as set by set-ambient-temperature-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 temperature-ir-bricklet <uid> set-object-temperature-callback-threshold <option> <min> <max>
Parameters:
  • <option> -- char (has symbols)
  • <min> -- int
  • <max> -- int
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 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 temperature-ir-bricklet <uid> get-object-temperature-callback-threshold
Output:
  • option -- char (has symbols)
  • min -- int
  • max -- int

Returns the threshold as set by set-object-temperature-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 temperature-ir-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 temperature-ir-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 temperature-ir-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 temperature-ir-bricklet <uid> ambient-temperature
Output:
  • temperature -- int

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 -- int

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 -- int

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 -- int

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.