TCP/IP - Thermal Imaging Bricklet¶

Basic Functions¶

BrickletThermalImaging.get_high_contrast_image_low_level¶

Function ID:	1
Request:	empty payload
Response:	image_chunk_offset – Type: uint16, Range: [0 to 216 - 1] image_chunk_data – Type: uint8[62], Range: [0 to 255]

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.

BrickletThermalImaging.get_temperature_image_low_level¶

Function ID:	2
Request:	empty payload
Response:	image_chunk_offset – Type: uint16, Range: [0 to 216 - 1] image_chunk_data – Type: uint16[31], Unit: ? K, Range: [0 to 216 - 1]

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.

BrickletThermalImaging.get_statistics¶

Function ID:	3
Request:	empty payload
Response:	spotmeter_statistics – Type: uint16[4] 0: mean_temperature – Type: uint16, Unit: ? K, Range: [0 to 216 - 1] 1: max_temperature – Type: uint16, Unit: ? K, Range: [0 to 216 - 1] 2: min_temperature – Type: uint16, Unit: ? K, Range: [0 to 216 - 1] 3: pixel_count – Type: uint16, Range: [0 to 4800] temperatures – Type: uint16[4] 0: focal_plain_array – Type: uint16, Unit: ? K, Range: [0 to 216 - 1] 1: focal_plain_array_last_ffc – Type: uint16, Unit: ? K, Range: [0 to 216 - 1] 2: housing – Type: uint16, Unit: ? K, Range: [0 to 216 - 1] 3: housing_last_ffc – Type: uint16, Unit: ? K, Range: [0 to 216 - 1] resolution – Type: uint8, Range: See meanings ffc_status – Type: uint8, Range: See meanings temperature_warning – Type: bool[2] 0: shutter_lockout – Type: bool 1: overtemperature_shut_down_imminent – Type: bool

Returns the spotmeter statistics, various temperatures, current resolution and status bits.

The spotmeter statistics are:

• Index 0: Mean Temperature.
• Index 1: Maximum Temperature.
• Index 2: Minimum Temperature.
• Index 3: Pixel Count of spotmeter region of interest.

The temperatures are:

• Index 0: Focal Plain Array temperature.
• Index 1: Focal Plain Array temperature at last FFC (Flat Field Correction).
• Index 2: Housing temperature.
• Index 3: Housing temperature at last FFC.

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:

• FFC Never Commanded: Only seen on startup before first FFC.
• FFC Imminent: This state is entered 2 seconds prior to initiating FFC.
• FFC In Progress: Flat field correction is started (shutter moves in front of lens and back). Takes about 1 second.
• FFC Complete: Shutter is in waiting position again, FFC done.

Temperature warning bits:

• Index 0: Shutter lockout (if true shutter is locked out because temperature is outside -10°C to +65°C)
• Index 1: Overtemperature shut down imminent (goes true 10 seconds before shutdown)

The following meanings are defined for the elements of this function:

For resolution:

• 0 = 0 To 6553 Kelvin
• 1 = 0 To 655 Kelvin

For ffc_status:

• 0 = Never Commanded
• 1 = Imminent
• 2 = In Progress
• 3 = Complete

BrickletThermalImaging.set_resolution¶

Function ID:	4
Request:	resolution – Type: uint8, Range: See meanings, Default: 1
Response:	no response

Sets the resolution. The Thermal Imaging Bricklet can either measure

• from 0 to 6553 Kelvin (-273.15°C to +6279.85°C) with 0.1°C resolution or
• from 0 to 655 Kelvin (-273.15°C to +381.85°C) with 0.01°C resolution.

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 meanings are defined for the elements of this function:

For resolution:

• 0 = 0 To 6553 Kelvin
• 1 = 0 To 655 Kelvin

BrickletThermalImaging.get_resolution¶

Function ID:	5
Request:	empty payload
Response:	resolution – Type: uint8, Range: See meanings

Returns the resolution as set by set_resolution.

The following meanings are defined for the elements of this function:

For resolution:

• 0 = 0 To 6553 Kelvin
• 1 = 0 To 655 Kelvin

BrickletThermalImaging.set_spotmeter_config¶

Function ID:	6
Request:	region_of_interest – Type: uint8[4] 0: first_column – Type: uint8, Range: [0 to 78], Default: 39 1: first_row – Type: uint8, Range: [0 to 58], Default: 29 2: last_column – Type: uint8, Range: [1 to 79], Default: 40 3: last_row – Type: uint8, Range: [1 to 59], Default: 30
Response:	no response

Sets the spotmeter region of interest. The 4 values are

• Index 0: Column start (has to be smaller than column end).
• Index 1: Row start (has to be smaller than row end).
• Index 2: Column end (has to be smaller than 80).
• Index 3: Row end (has to be smaller than 60).

The spotmeter statistics can be read out with get_statistics.

BrickletThermalImaging.get_spotmeter_config¶

Function ID:	7
Request:	empty payload
Response:	region_of_interest – Type: uint8[4] 0: first_column – Type: uint8, Range: [0 to 78], Default: 39 1: first_row – Type: uint8, Range: [0 to 58], Default: 29 2: last_column – Type: uint8, Range: [1 to 79], Default: 40 3: last_row – Type: uint8, Range: [1 to 59], Default: 30

Returns the spotmeter config as set by set_spotmeter_config.

BrickletThermalImaging.set_high_contrast_config¶

Function ID:	8
Request:	region_of_interest – Type: uint8[4] 0: first_column – Type: uint8, Range: [0 to 79], Default: 0 1: first_row – Type: uint8, Range: [0 to 58], Default: 0 2: last_column – Type: uint8, Range: [0 to 79], Default: 79 3: last_row – Type: uint8, Range: [1 to 59], Default: 59 dampening_factor – Type: uint16, Range: [0 to 256], Default: 64 clip_limit – Type: uint16[2] 0: agc_heq_clip_limit_high – Type: uint16, Range: [0 to 4800], Default: 4800 1: agc_heq_clip_limit_low – Type: uint16, Range: [0 to 210], Default: 29 empty_counts – Type: uint16, Range: [0 to 214 - 1], Default: 2
Response:	no response

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:

• Index 0: Column start (has to be smaller than or equal to column end).
• Index 1: Row start (has to be smaller than row end).
• Index 2: Column end (has to be smaller than 80).
• Index 3: Row end (has to be smaller than 60).

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.

BrickletThermalImaging.get_high_contrast_config¶

Function ID:	9
Request:	empty payload
Response:	region_of_interest – Type: uint8[4] 0: first_column – Type: uint8, Range: [0 to 78], Default: 0 1: first_row – Type: uint8, Range: [0 to 58], Default: 0 2: last_column – Type: uint8, Range: [1 to 79], Default: 79 3: last_row – Type: uint8, Range: [1 to 59], Default: 59 dampening_factor – Type: uint16, Range: [0 to 256], Default: 64 clip_limit – Type: uint16[2] 0: agc_heq_clip_limit_high – Type: uint16, Range: [0 to 4800], Default: 4800 1: agc_heq_clip_limit_low – Type: uint16, Range: [0 to 210], Default: 29 empty_counts – Type: uint16, Range: [0 to 216 - 1], Default: 2

Returns the high contrast config as set by set_high_contrast_config.

Advanced Functions¶

BrickletThermalImaging.set_flux_linear_parameters¶

Function ID:	14
Request:	scene_emissivity – Type: uint16, Unit: 25/2048 %, Range: [82 to 213], Default: 213 temperature_background – Type: uint16, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 29515 tau_window – Type: uint16, Unit: 25/2048 %, Range: [82 to 213], Default: 213 temperatur_window – Type: uint16, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 29515 tau_atmosphere – Type: uint16, Unit: 25/2048 %, Range: [82 to 213], Default: 213 temperature_atmosphere – Type: uint16, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 29515 reflection_window – Type: uint16, Unit: 25/2048 %, Range: [0 to 213], Default: 0 temperature_reflection – Type: uint16, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 29515
Response:	no response

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).

BrickletThermalImaging.get_flux_linear_parameters¶

Function ID:	15
Request:	empty payload
Response:	scene_emissivity – Type: uint16, Unit: 25/2048 %, Range: [82 to 213], Default: 213 temperature_background – Type: uint16, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 29515 tau_window – Type: uint16, Unit: 25/2048 %, Range: [82 to 213], Default: 213 temperatur_window – Type: uint16, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 29515 tau_atmosphere – Type: uint16, Unit: 25/2048 %, Range: [82 to 213], Default: 213 temperature_atmosphere – Type: uint16, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 29515 reflection_window – Type: uint16, Unit: 25/2048 %, Range: [0 to 213], Default: 0 temperature_reflection – Type: uint16, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 29515

Returns the flux linear parameters, as set by set_flux_linear_parameters.

New in version 2.0.5 (Plugin).

BrickletThermalImaging.set_ffc_shutter_mode¶

Function ID:	16
Request:	shutter_mode – Type: uint8, Range: See meanings, Default: 1 temp_lockout_state – Type: uint8, Range: See meanings, Default: 0 video_freeze_during_ffc – Type: bool, Default: true ffc_desired – Type: bool, Default: false elapsed_time_since_last_ffc – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 desired_ffc_period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 300000 explicit_cmd_to_open – Type: bool, Default: false desired_ffc_temp_delta – Type: uint16, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 300 imminent_delay – Type: uint16, Range: [0 to 216 - 1], Default: 52
Response:	no response

Sets the FFC shutter mode parameters.

See FLIR document 110-0144-03 4.5.15 for more details.

The following meanings are defined for the elements of this function:

For shutter_mode:

• 0 = Manual
• 1 = Auto
• 2 = External

For temp_lockout_state:

• 0 = Inactive
• 1 = High
• 2 = Low

New in version 2.0.6 (Plugin).

BrickletThermalImaging.get_ffc_shutter_mode¶

Function ID:	17
Request:	empty payload
Response:	shutter_mode – Type: uint8, Range: See meanings, Default: 1 temp_lockout_state – Type: uint8, Range: See meanings, Default: 0 video_freeze_during_ffc – Type: bool, Default: true ffc_desired – Type: bool, Default: false elapsed_time_since_last_ffc – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0 desired_ffc_period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 300000 explicit_cmd_to_open – Type: bool, Default: false desired_ffc_temp_delta – Type: uint16, Unit: 1/100 K, Range: [0 to 216 - 1], Default: 300 imminent_delay – Type: uint16, Range: [0 to 216 - 1], Default: 52

Sets the FFC shutter mode parameters.

See FLIR document 110-0144-03 4.5.15 for more details.

The following meanings are defined for the elements of this function:

For shutter_mode:

• 0 = Manual
• 1 = Auto
• 2 = External

For temp_lockout_state:

• 0 = Inactive
• 1 = High
• 2 = Low

New in version 2.0.6 (Plugin).

BrickletThermalImaging.run_ffc_normalization¶

Function ID:	18
Request:	empty payload
Response:	no response

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).

BrickletThermalImaging.get_spitfp_error_count¶

Function ID:	234
Request:	empty payload
Response:	error_count_ack_checksum – Type: uint32, Range: [0 to 232 - 1] error_count_message_checksum – Type: uint32, Range: [0 to 232 - 1] error_count_frame – Type: uint32, Range: [0 to 232 - 1] error_count_overflow – Type: uint32, Range: [0 to 232 - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

• ACK checksum errors,
• message checksum errors,
• framing errors and
• overflow errors.

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.

BrickletThermalImaging.set_status_led_config¶

Function ID:	239
Request:	config – Type: uint8, Range: See meanings, Default: 3
Response:	no response

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 meanings are defined for the elements of this function:

For config:

• 0 = Off
• 1 = On
• 2 = Show Heartbeat
• 3 = Show Status

BrickletThermalImaging.get_status_led_config¶

Function ID:	240
Request:	empty payload
Response:	config – Type: uint8, Range: See meanings, Default: 3

Returns the configuration as set by set_status_led_config

The following meanings are defined for the elements of this function:

For config:

• 0 = Off
• 1 = On
• 2 = Show Heartbeat
• 3 = Show Status

BrickletThermalImaging.get_chip_temperature¶

Function ID:	242
Request:	empty payload
Response:	temperature – Type: int16, Unit: 1 °C, Range: [-215 to 215 - 1]

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.

BrickletThermalImaging.reset¶

Function ID:	243
Request:	empty payload
Response:	no response

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!

BrickletThermalImaging.get_identity¶

Function ID:	255
Request:	empty payload
Response:	uid – Type: char[8] connected_uid – Type: char[8] position – Type: char, Range: ['a' to 'h', 'z'] hardware_version – Type: uint8[3] 0: major – Type: uint8, Range: [0 to 255] 1: minor – Type: uint8, Range: [0 to 255] 2: revision – Type: uint8, Range: [0 to 255] firmware_version – Type: uint8[3] 0: major – Type: uint8, Range: [0 to 255] 1: minor – Type: uint8, Range: [0 to 255] 2: revision – Type: uint8, Range: [0 to 255] device_identifier – Type: uint16, 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¶

BrickletThermalImaging.set_image_transfer_config¶

Function ID:	10
Request:	config – Type: uint8, Range: See meanings, Default: 0
Response:	no response

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:

• Manual High Contrast Image: get_high_contrast_image_low_level.
• Manual Temperature Image: get_temperature_image_low_level.
• Callback High Contrast Image: CALLBACK_HIGH_CONTRAST_IMAGE_LOW_LEVEL callback.
• Callback Temperature Image: CALLBACK_TEMPERATURE_IMAGE_LOW_LEVEL callback.

The following meanings are defined for the elements of this function:

For config:

• 0 = Manual High Contrast Image
• 1 = Manual Temperature Image
• 2 = Callback High Contrast Image
• 3 = Callback Temperature Image

BrickletThermalImaging.get_image_transfer_config¶

Function ID:	11
Request:	empty payload
Response:	config – Type: uint8, Range: See meanings, Default: 0

Returns the image transfer config, as set by set_image_transfer_config.

The following meanings are defined for the elements of this function:

For config:

• 0 = Manual High Contrast Image
• 1 = Manual Temperature Image
• 2 = Callback High Contrast Image
• 3 = Callback Temperature Image

Callbacks¶

BrickletThermalImaging.CALLBACK_HIGH_CONTRAST_IMAGE_LOW_LEVEL¶

Function ID:	12
Response:	image_chunk_offset – Type: uint16, Range: [0 to 216 - 1] image_chunk_data – Type: uint8[62], Range: [0 to 255]

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.

BrickletThermalImaging.CALLBACK_TEMPERATURE_IMAGE_LOW_LEVEL¶

Function ID:	13
Response:	image_chunk_offset – Type: uint16, Range: [0 to 216 - 1] image_chunk_data – Type: uint16[31], Unit: ? K, Range: [0 to 216 - 1]

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).

Internal Functions¶

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.

BrickletThermalImaging.set_bootloader_mode¶

Function ID:	235
Request:	mode – Type: uint8, Range: See meanings
Response:	status – Type: uint8, Range: See meanings

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 meanings are defined for the elements of this function:

For mode:

• 0 = Bootloader
• 1 = Firmware
• 2 = Bootloader Wait For Reboot
• 3 = Firmware Wait For Reboot
• 4 = Firmware Wait For Erase And Reboot

For status:

• 0 = OK
• 1 = Invalid Mode
• 2 = No Change
• 3 = Entry Function Not Present
• 4 = Device Identifier Incorrect
• 5 = CRC Mismatch

BrickletThermalImaging.get_bootloader_mode¶

Function ID:	236
Request:	empty payload
Response:	mode – Type: uint8, Range: See meanings

Returns the current bootloader mode, see set_bootloader_mode.

The following meanings are defined for the elements of this function:

For mode:

• 0 = Bootloader
• 1 = Firmware
• 2 = Bootloader Wait For Reboot
• 3 = Firmware Wait For Reboot
• 4 = Firmware Wait For Erase And Reboot

BrickletThermalImaging.set_write_firmware_pointer¶

Function ID:	237
Request:	pointer – Type: uint32, Unit: 1 B, Range: [0 to 232 - 1]
Response:	no response

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.

BrickletThermalImaging.write_firmware¶

Function ID:	238
Request:	data – Type: uint8[64], Range: [0 to 255]
Response:	status – Type: uint8, Range: [0 to 255]

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.

BrickletThermalImaging.write_uid¶

Function ID:	248
Request:	uid – Type: uint32, Range: [0 to 232 - 1]
Response:	no response

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.

BrickletThermalImaging.read_uid¶

Function ID:	249
Request:	empty payload
Response:	uid – Type: uint32, Range: [0 to 232 - 1]

Returns the current UID as an integer. Encode as Base58 to get the usual string version.