This is the description of the Shell API bindings for the Temperature Bricklet. General information and technical specifications for the Temperature Bricklet are summarized in its hardware description.
An installation guide for the Shell API bindings is part of their general description.
The example code below is Public Domain (CC0 1.0).
1 2 3 4 5 6 7 8 | #!/bin/sh
# connects to localhost:4223 by default, use --host and --port to change it
# change to your UID
uid=XYZ
# get current temperature (unit is °C/100)
tinkerforge call temperature-bricklet $uid get-temperature
|
Download (example-callback.sh)
1 2 3 4 5 6 7 8 9 10 11 12 13 | #!/bin/sh
# connects to localhost:4223 by default, use --host and --port to change it
# change to your UID
uid=XYZ
# 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
# handle incoming temperature callbacks (unit is °C/100)
tinkerforge dispatch temperature-bricklet $uid temperature
|
Download (example-threshold.sh)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | #!/bin/sh
# connects to localhost:4223 by default, use --host and --port to change it
# change to your UID
uid=XYZ
# get threshold callbacks with a debounce time of 10 seconds (10000ms)
tinkerforge call temperature-bricklet $uid set-debounce-period 10000
# configure threshold for "greater than 30 °C" (unit is °C/100)
tinkerforge call temperature-bricklet $uid set-temperature-callback-threshold greater 3000 0
# handle incoming temperature-reached callbacks (unit is °C/100)
tinkerforge dispatch temperature-bricklet $uid temperature-reached\
--execute "echo We have {temperature} °C/100. It is too hot, we need air conditioning!"
|
Possible exit codes for all tinkerforge commands are:
The common options of the call and dispatch commands are documented here. The specific command structure is shown below.
Parameters: |
|
---|
The call command is used to call a function of the Temperature Bricklet. It can take several options:
Parameters: |
|
---|
The dispatch command is used to dispatch a callback of the Temperature Bricklet. It can take several options:
Parameters: |
|
---|
The <function> to be called can take different options depending of its kind. All functions can take the following options:
Getter functions can take the following options:
Setter functions can take the following options:
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.
Parameters: |
|
---|
The <callback> to be dispatched can take several options:
Output: |
|
---|
Returns the temperature of the sensor. The value has a range of -2500 to 8500 and is given in °C/100, e.g. a value of 4223 means that a temperature of 42.23 °C is measured.
If you want to get the temperature periodically, it is recommended to use the callback temperature and set the period with set-temperature-callback-period.
Parameters: |
|
---|---|
Output: | no output |
Sets the I2C mode. Possible modes are:
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:
New in version 2.0.1 (Plugin).
Output: |
|
---|
Returns the I2C mode as set by set-i2c-mode.
The following symbols are available for this function:
New in version 2.0.1 (Plugin).
Output: |
|
---|
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.
Parameters: |
|
---|---|
Output: | no output |
Sets the period in ms with which the temperature callback is triggered periodically. A value of 0 turns the callback off.
temperature is only triggered if the temperature has changed since the last triggering.
The default value is 0.
Output: |
|
---|
Returns the period as set by set-temperature-callback-period.
Parameters: |
|
---|---|
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 default value is ('x', 0, 0).
The following symbols are available for this function:
Output: |
|
---|
Returns the threshold as set by set-temperature-callback-threshold.
The following symbols are available for this function:
Parameters: |
|
---|---|
Output: | no output |
Sets the period in ms with which the threshold callback
is triggered, if the threshold
keeps being reached.
The default value is 100.
Output: |
|
---|
Returns the debounce period as set by set-debounce-period.
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.
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.
Output: |
|
---|
This callback is triggered periodically with the period that is set by set-temperature-callback-period. The parameter is the temperature of the sensor.
temperature is only triggered if the temperature has changed since the last triggering.
Output: |
|
---|
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.