This is the description of the Shell API bindings for the Thermal Imaging Bricklet. General information and technical specifications for the Thermal Imaging 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).
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 Thermal Imaging Bricklet
# Handle incoming high contrast image callbacks
tinkerforge dispatch thermal-imaging-bricklet $uid high-contrast-image &
# Enable high contrast image transfer for callback
tinkerforge call thermal-imaging-bricklet $uid set-image-transfer-config image-transfer-callback-high-contrast-image
echo "Press key to exit"; read dummy
kill -- -$$ # Stop callback dispatch in background
|
Possible exit codes for all tinkerforge
commands are:
argparse
module is missingThe common options of the call
and dispatch
commands are documented
here. The specific command structure is shown below.
call
thermal-imaging-bricklet
[<option>..] <uid> <function> [<argument>..]¶Parameters: |
|
---|
The call
command is used to call a function of the Thermal Imaging 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 Thermal Imaging Bricklet and exitsdispatch
thermal-imaging-bricklet
[<option>..] <uid> <callback>¶Parameters: |
|
---|
The dispatch
command is used to dispatch a callback of the Thermal Imaging 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 Thermal Imaging Bricklet and exitsthermal-imaging-bricklet
<uid> <function>
[<option>..] [<argument>..]¶Parameters: |
|
---|
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 exitsGetter 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 itThe --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.
thermal-imaging-bricklet
<uid> <callback>
[<option>..]¶Parameters: |
|
---|
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)thermal-imaging-bricklet
<uid> get-high-contrast-image
¶Output: |
|
---|
Returns the current high contrast image. See here for the difference between High Contrast and Temperature Image. If you don't know what to use the High Contrast Image is probably right for you.
The data is organized as a 8-bit value 80x60 pixel matrix linearized in a one-dimensional array. The data is arranged line by line from top left to bottom right.
Each 8-bit value represents one gray-scale image pixel that can directly be shown to a user on a display.
Before you can use this function you have to enable it with
set-image-transfer-config
.
thermal-imaging-bricklet
<uid> get-temperature-image
¶Output: |
|
---|
Returns the current temperature image. See here for the difference between High Contrast and Temperature Image. If you don't know what to use the High Contrast Image is probably right for you.
The data is organized as a 16-bit value 80x60 pixel matrix linearized in a one-dimensional array. The data is arranged line by line from top left to bottom right.
Each 16-bit value represents one temperature measurement in either
Kelvin/10 or Kelvin/100 (depending on the resolution set with set-resolution
).
Before you can use this function you have to enable it with
set-image-transfer-config
.
thermal-imaging-bricklet
<uid> get-statistics
¶Output: |
|
---|
Returns the spotmeter statistics, various temperatures, current resolution and status bits.
The spotmeter statistics are:
The temperatures are:
The resolution is either 0 to 6553 Kelvin or 0 to 655 Kelvin. If the resolution is the former, the temperatures are in Kelvin/10, if it is the latter the temperatures are in Kelvin/100.
FFC (Flat Field Correction) Status:
Temperature warning bits:
The following symbols are available for this function:
For resolution:
For ffc-status:
thermal-imaging-bricklet
<uid> set-resolution
<resolution>¶Parameters: |
|
---|---|
Output: |
|
Sets the resolution. The Thermal Imaging Bricklet can either measure
The accuracy is specified for -10°C to 450°C in the first range and -10°C and 140°C in the second range.
The following symbols are available for this function:
For <resolution>:
thermal-imaging-bricklet
<uid> get-resolution
¶Output: |
|
---|
Returns the resolution as set by set-resolution
.
The following symbols are available for this function:
For resolution:
thermal-imaging-bricklet
<uid> set-spotmeter-config
<region-of-interest>¶Parameters: |
|
---|---|
Output: |
|
Sets the spotmeter region of interest. The 4 values are
The spotmeter statistics can be read out with get-statistics
.
thermal-imaging-bricklet
<uid> get-spotmeter-config
¶Output: |
|
---|
Returns the spotmeter config as set by set-spotmeter-config
.
thermal-imaging-bricklet
<uid> set-high-contrast-config
<region-of-interest> <dampening-factor> <clip-limit> <empty-counts>¶Parameters: |
|
---|---|
Output: |
|
Sets the high contrast region of interest, dampening factor, clip limit and empty counts.
This config is only used in high contrast mode (see set-image-transfer-config
).
The high contrast region of interest consists of four values:
The algorithm to generate the high contrast image is applied to this region.
Dampening Factor: This parameter is the amount of temporal dampening applied to the HEQ (history equalization) transformation function. An IIR filter of the form:
(N / 256) * previous + ((256 - N) / 256) * current
is applied, and the HEQ dampening factor represents the value N in the equation, i.e., a value that applies to the amount of influence the previous HEQ transformation function has on the current function. The lower the value of N the higher the influence of the current video frame whereas the higher the value of N the more influence the previous damped transfer function has.
Clip Limit Index 0 (AGC HEQ Clip Limit High): This parameter defines the maximum number of pixels allowed to accumulate in any given histogram bin. Any additional pixels in a given bin are clipped. The effect of this parameter is to limit the influence of highly-populated bins on the resulting HEQ transformation function.
Clip Limit Index 1 (AGC HEQ Clip Limit Low): This parameter defines an artificial population that is added to every non-empty histogram bin. In other words, if the Clip Limit Low is set to L, a bin with an actual population of X will have an effective population of L + X. Any empty bin that is nearby a populated bin will be given an artificial population of L. The effect of higher values is to provide a more linear transfer function; lower values provide a more non-linear (equalized) transfer function.
Empty Counts: This parameter specifies the maximum number of pixels in a bin that will be interpreted as an empty bin. Histogram bins with this number of pixels or less will be processed as an empty bin.
thermal-imaging-bricklet
<uid> get-high-contrast-config
¶Output: |
|
---|
Returns the high contrast config as set by set-high-contrast-config
.
thermal-imaging-bricklet
<uid> set-flux-linear-parameters
<scene-emissivity> <temperature-background> <tau-window> <temperatur-window> <tau-atmosphere> <temperature-atmosphere> <reflection-window> <temperature-reflection>¶Parameters: |
|
---|---|
Output: |
|
Sets the flux linear parameters that can be used for radiometry calibration.
See FLIR document 102-PS245-100-01 for more details.
New in version 2.0.5 (Plugin).
thermal-imaging-bricklet
<uid> get-flux-linear-parameters
¶Output: |
|
---|
Returns the flux linear parameters, as set by set-flux-linear-parameters
.
New in version 2.0.5 (Plugin).
thermal-imaging-bricklet
<uid> set-ffc-shutter-mode
<shutter-mode> <temp-lockout-state> <video-freeze-during-ffc> <ffc-desired> <elapsed-time-since-last-ffc> <desired-ffc-period> <explicit-cmd-to-open> <desired-ffc-temp-delta> <imminent-delay>¶Parameters: |
|
---|---|
Output: |
|
Sets the FFC shutter mode parameters.
See FLIR document 110-0144-03 4.5.15 for more details.
The following symbols are available for this function:
For <shutter-mode>:
For <temp-lockout-state>:
New in version 2.0.6 (Plugin).
thermal-imaging-bricklet
<uid> get-ffc-shutter-mode
¶Output: |
|
---|
Sets the FFC shutter mode parameters.
See FLIR document 110-0144-03 4.5.15 for more details.
The following symbols are available for this function:
For shutter-mode:
For temp-lockout-state:
New in version 2.0.6 (Plugin).
thermal-imaging-bricklet
<uid> run-ffc-normalization
¶Output: |
|
---|
Starts the Flat-Field Correction (FFC) normalization.
See FLIR document 110-0144-03 4.5.16 for more details.
New in version 2.0.6 (Plugin).
thermal-imaging-bricklet
<uid> get-spitfp-error-count
¶Output: |
|
---|
Returns the error count for the communication between Brick and Bricklet.
The errors are divided into
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.
thermal-imaging-bricklet
<uid> set-status-led-config
<config>¶Parameters: |
|
---|---|
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>:
thermal-imaging-bricklet
<uid> get-status-led-config
¶Output: |
|
---|
Returns the configuration as set by set-status-led-config
The following symbols are available for this function:
For config:
thermal-imaging-bricklet
<uid> get-chip-temperature
¶Output: |
|
---|
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.
thermal-imaging-bricklet
<uid> reset
¶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!
thermal-imaging-bricklet
<uid> get-identity
¶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', '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.
thermal-imaging-bricklet
<uid> set-image-transfer-config
<config>¶Parameters: |
|
---|---|
Output: |
|
The necessary bandwidth of this Bricklet is too high to use getter/callback or high contrast/temperature image at the same time. You have to configure the one you want to use, the Bricklet will optimize the internal configuration accordingly.
Corresponding functions:
get-high-contrast-image
.get-temperature-image
.high-contrast-image
callback.temperature-image
callback.The following symbols are available for this function:
For <config>:
thermal-imaging-bricklet
<uid> get-image-transfer-config
¶Output: |
|
---|
Returns the image transfer config, as set by set-image-transfer-config
.
The following symbols are available for this function:
For config:
Callbacks can be used to receive time critical or recurring data from the device:
tinkerforge dispatch thermal-imaging-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.
thermal-imaging-bricklet
<uid> high-contrast-image
¶Output: |
|
---|
This callback is triggered with every new high contrast image if the transfer image
config is configured for high contrast callback (see set-image-transfer-config
).
The data is organized as a 8-bit value 80x60 pixel matrix linearized in a one-dimensional array. The data is arranged line by line from top left to bottom right.
Each 8-bit value represents one gray-scale image pixel that can directly be shown to a user on a display.
Note
If reconstructing the value fails, the callback is triggered with None for image.
thermal-imaging-bricklet
<uid> temperature-image
¶Output: |
|
---|
This callback is triggered with every new temperature image if the transfer image
config is configured for temperature callback (see set-image-transfer-config
).
The data is organized as a 16-bit value 80x60 pixel matrix linearized in a one-dimensional array. The data is arranged line by line from top left to bottom right.
Each 16-bit value represents one temperature measurement in either
Kelvin/10 or Kelvin/100 (depending on the resolution set with set-resolution
).
Note
If reconstructing the value fails, the callback is triggered with None for image.
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.
thermal-imaging-bricklet
<uid> set-bootloader-mode
<mode>¶Parameters: |
|
---|---|
Output: |
|
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>:
For status:
thermal-imaging-bricklet
<uid> get-bootloader-mode
¶Output: |
|
---|
Returns the current bootloader mode, see set-bootloader-mode
.
The following symbols are available for this function:
For mode:
thermal-imaging-bricklet
<uid> set-write-firmware-pointer
<pointer>¶Parameters: |
|
---|---|
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.
thermal-imaging-bricklet
<uid> write-firmware
<data>¶Parameters: |
|
---|---|
Output: |
|
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.
thermal-imaging-bricklet
<uid> write-uid
<uid>¶Parameters: |
|
---|---|
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.
thermal-imaging-bricklet
<uid> read-uid
¶Output: |
|
---|
Returns the current UID as an integer. Encode as Base58 to get the usual string version.