Struct ThermalImagingBricklet

pub struct ThermalImagingBricklet { /* private fields */ }

80x60 pixel thermal imaging camera

Implementations

impl ThermalImagingBricklet

pub const DEVICE_IDENTIFIER: u16 = 278u16

pub const DEVICE_DISPLAY_NAME: &'static str = "Thermal Imaging Bricklet"

pub fn new(uid: Uid, connection: AsyncIpConnection) -> ThermalImagingBricklet

Creates an object with the unique device ID uid. This object can then be used after the IP Connection ip_connection is connected.

pub fn get_response_expected( &mut self, fun: ThermalImagingBrickletFunction, ) -> Result<bool, GetResponseExpectedError>

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by set_response_expected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

See set_response_expected for the list of function ID constants available for this function.

pub fn set_response_expected( &mut self, fun: ThermalImagingBrickletFunction, response_expected: bool, ) -> Result<(), SetResponseExpectedError>

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

pub fn set_response_expected_all(&mut self, response_expected: bool)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

pub fn get_api_version(&self) -> [u8; 3]

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

pub async fn get_high_contrast_image_low_level_callback_receiver( &mut self, ) -> impl Stream<Item = HighContrastImageLowLevelEvent>

See get_high_contrast_image_callback_receiver

pub async fn get_temperature_image_low_level_callback_receiver( &mut self, ) -> impl Stream<Item = TemperatureImageLowLevelEvent>

See get_temperature_image_callback_receiver

pub async fn get_high_contrast_image_low_level( &mut self, ) -> Result<HighContrastImageLowLevel, TinkerforgeError>

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.

pub async fn get_temperature_image_low_level( &mut self, ) -> Result<TemperatureImageLowLevel, TinkerforgeError>

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

pub async fn get_statistics(&mut self) -> Result<Statistics, TinkerforgeError>

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)

Associated constants:

• THERMAL_IMAGING_BRICKLET_RESOLUTION_0_TO_6553_KELVIN
• THERMAL_IMAGING_BRICKLET_RESOLUTION_0_TO_655_KELVIN
• THERMAL_IMAGING_BRICKLET_FFC_STATUS_NEVER_COMMANDED
• THERMAL_IMAGING_BRICKLET_FFC_STATUS_IMMINENT
• THERMAL_IMAGING_BRICKLET_FFC_STATUS_IN_PROGRESS
• THERMAL_IMAGING_BRICKLET_FFC_STATUS_COMPLETE

pub async fn set_resolution( &mut self, resolution: u8, ) -> Result<(), TinkerforgeError>

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.

Associated constants:

• THERMAL_IMAGING_BRICKLET_RESOLUTION_0_TO_6553_KELVIN
• THERMAL_IMAGING_BRICKLET_RESOLUTION_0_TO_655_KELVIN

pub async fn get_resolution(&mut self) -> Result<u8, TinkerforgeError>

Returns the resolution as set by [set_resolution].

Associated constants:

• THERMAL_IMAGING_BRICKLET_RESOLUTION_0_TO_6553_KELVIN
• THERMAL_IMAGING_BRICKLET_RESOLUTION_0_TO_655_KELVIN

pub async fn set_spotmeter_config( &mut self, region_of_interest: &[u8; 4], ) -> Result<(), TinkerforgeError>

Sets the spotmeter region of interest. The 4 values are

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

The spotmeter statistics can be read out with [get_statistics].

pub async fn get_spotmeter_config( &mut self, ) -> Result<Box<[u8; 4]>, TinkerforgeError>

Returns the spotmeter config as set by [set_spotmeter_config].

pub async fn set_high_contrast_config( &mut self, region_of_interest: &[u8; 4], dampening_factor: u16, clip_limit: &[u16; 2], empty_counts: u16, ) -> Result<(), TinkerforgeError>

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 or equal then Column end).
• Index 1: Row start (has to be smaller then Row end).
• Index 2: Column end (has to be smaller then 80).
• Index 3: Row end (has to be smaller then 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.

pub async fn get_high_contrast_config( &mut self, ) -> Result<HighContrastConfig, TinkerforgeError>

Returns the high contrast config as set by [set_high_contrast_config].

pub async fn set_image_transfer_config( &mut self, config: u8, ) -> Result<(), TinkerforgeError>

The necessary bandwidth of this Bricklet is too high to use getter/receiver 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].
• Manual Temperature Image: [get_temperature_image].
• Receiver High Contrast Image: [get_high_contrast_image_callback_receiver] receiver.
• Receiver Temperature Image: [get_temperature_image_callback_receiver] receiver.

Associated constants:

• THERMAL_IMAGING_BRICKLET_IMAGE_TRANSFER_MANUAL_HIGH_CONTRAST_IMAGE
• THERMAL_IMAGING_BRICKLET_IMAGE_TRANSFER_MANUAL_TEMPERATURE_IMAGE
• THERMAL_IMAGING_BRICKLET_IMAGE_TRANSFER_CALLBACK_HIGH_CONTRAST_IMAGE
• THERMAL_IMAGING_BRICKLET_IMAGE_TRANSFER_CALLBACK_TEMPERATURE_IMAGE

pub async fn get_image_transfer_config( &mut self, ) -> Result<u8, TinkerforgeError>

Returns the image transfer config, as set by [set_image_transfer_config].

Associated constants:

• THERMAL_IMAGING_BRICKLET_IMAGE_TRANSFER_MANUAL_HIGH_CONTRAST_IMAGE
• THERMAL_IMAGING_BRICKLET_IMAGE_TRANSFER_MANUAL_TEMPERATURE_IMAGE
• THERMAL_IMAGING_BRICKLET_IMAGE_TRANSFER_CALLBACK_HIGH_CONTRAST_IMAGE
• THERMAL_IMAGING_BRICKLET_IMAGE_TRANSFER_CALLBACK_TEMPERATURE_IMAGE

pub async fn set_flux_linear_parameters( &mut self, scene_emissivity: u16, temperature_background: u16, tau_window: u16, temperatur_window: u16, tau_atmosphere: u16, temperature_atmosphere: u16, reflection_window: u16, temperature_reflection: u16, ) -> Result<(), TinkerforgeError>

Sets the flux linear parameters that can be used for radiometry calibration.

See FLIR document 102-PS245-100-01 for more details.

.. versionadded:: 2.0.5$nbsp;(Plugin)

pub async fn get_flux_linear_parameters( &mut self, ) -> Result<FluxLinearParameters, TinkerforgeError>

Returns the flux linear parameters, as set by [set_flux_linear_parameters].

.. versionadded:: 2.0.5$nbsp;(Plugin)

pub async fn set_ffc_shutter_mode( &mut self, shutter_mode: u8, temp_lockout_state: u8, video_freeze_during_ffc: bool, ffc_desired: bool, elapsed_time_since_last_ffc: u32, desired_ffc_period: u32, explicit_cmd_to_open: bool, desired_ffc_temp_delta: u16, imminent_delay: u16, ) -> Result<(), TinkerforgeError>

Sets the FFC shutter mode parameters.

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

.. versionadded:: 2.0.6$nbsp;(Plugin)

Associated constants:

• THERMAL_IMAGING_BRICKLET_SHUTTER_MODE_MANUAL
• THERMAL_IMAGING_BRICKLET_SHUTTER_MODE_AUTO
• THERMAL_IMAGING_BRICKLET_SHUTTER_MODE_EXTERNAL
• THERMAL_IMAGING_BRICKLET_SHUTTER_LOCKOUT_INACTIVE
• THERMAL_IMAGING_BRICKLET_SHUTTER_LOCKOUT_HIGH
• THERMAL_IMAGING_BRICKLET_SHUTTER_LOCKOUT_LOW

pub async fn get_ffc_shutter_mode( &mut self, ) -> Result<FfcShutterMode, TinkerforgeError>

Sets the FFC shutter mode parameters.

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

.. versionadded:: 2.0.6$nbsp;(Plugin)

Associated constants:

• THERMAL_IMAGING_BRICKLET_SHUTTER_MODE_MANUAL
• THERMAL_IMAGING_BRICKLET_SHUTTER_MODE_AUTO
• THERMAL_IMAGING_BRICKLET_SHUTTER_MODE_EXTERNAL
• THERMAL_IMAGING_BRICKLET_SHUTTER_LOCKOUT_INACTIVE
• THERMAL_IMAGING_BRICKLET_SHUTTER_LOCKOUT_HIGH
• THERMAL_IMAGING_BRICKLET_SHUTTER_LOCKOUT_LOW

pub async fn run_ffc_normalization(&mut self) -> Result<(), TinkerforgeError>

Starts the Flat-Field Correction (FFC) normalization.

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

.. versionadded:: 2.0.6$nbsp;(Plugin)

pub async fn get_spitfp_error_count( &mut self, ) -> Result<SpitfpErrorCount, TinkerforgeError>

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.

pub async fn set_bootloader_mode( &mut self, mode: u8, ) -> Result<u8, TinkerforgeError>

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.

Associated constants:

• THERMAL_IMAGING_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• THERMAL_IMAGING_BRICKLET_BOOTLOADER_MODE_FIRMWARE
• THERMAL_IMAGING_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• THERMAL_IMAGING_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• THERMAL_IMAGING_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
• THERMAL_IMAGING_BRICKLET_BOOTLOADER_STATUS_OK
• THERMAL_IMAGING_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
• THERMAL_IMAGING_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
• THERMAL_IMAGING_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
• THERMAL_IMAGING_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
• THERMAL_IMAGING_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH

pub async fn get_bootloader_mode(&mut self) -> Result<u8, TinkerforgeError>

Returns the current bootloader mode, see [set_bootloader_mode].

Associated constants:

• THERMAL_IMAGING_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• THERMAL_IMAGING_BRICKLET_BOOTLOADER_MODE_FIRMWARE
• THERMAL_IMAGING_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• THERMAL_IMAGING_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• THERMAL_IMAGING_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT

pub async fn set_write_firmware_pointer( &mut self, pointer: u32, ) -> Result<(), TinkerforgeError>

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.

pub async fn write_firmware( &mut self, data: &[u8; 64], ) -> Result<u8, TinkerforgeError>

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.

pub async fn set_status_led_config( &mut self, config: u8, ) -> Result<(), TinkerforgeError>

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.

Associated constants:

• THERMAL_IMAGING_BRICKLET_STATUS_LED_CONFIG_OFF
• THERMAL_IMAGING_BRICKLET_STATUS_LED_CONFIG_ON
• THERMAL_IMAGING_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• THERMAL_IMAGING_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

pub async fn get_status_led_config(&mut self) -> Result<u8, TinkerforgeError>

Returns the configuration as set by [set_status_led_config]

Associated constants:

• THERMAL_IMAGING_BRICKLET_STATUS_LED_CONFIG_OFF
• THERMAL_IMAGING_BRICKLET_STATUS_LED_CONFIG_ON
• THERMAL_IMAGING_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• THERMAL_IMAGING_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

pub async fn get_chip_temperature(&mut self) -> Result<i16, TinkerforgeError>

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.

pub async fn reset(&mut self) -> Result<(), TinkerforgeError>

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!

pub async fn write_uid(&mut self, uid: u32) -> Result<(), TinkerforgeError>

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.

pub async fn read_uid(&mut self) -> Result<u32, TinkerforgeError>

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

pub async fn get_identity(&mut self) -> Result<Identity, TinkerforgeError>

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

Trait Implementations

impl Clone for ThermalImagingBricklet

fn clone(&self) -> ThermalImagingBricklet

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.