tinkerforge_async::temperature_ir_bricklet

Struct TemperatureIrBricklet

pub struct TemperatureIrBricklet { /* private fields */ }

Expand description

Measures contactless object temperature between -70°C and +380°C

Implementations§

Source §

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

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

Source

pub fn get_response_expected( &mut self, fun: TemperatureIrBrickletFunction, ) -> 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.

Source

pub fn set_response_expected( &mut self, fun: TemperatureIrBrickletFunction, 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.

Source

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.

Source

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.

Source

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

This receiver 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 get_ambient_temperature_callback_receiver receiver is only triggered if the ambient temperature has changed since the last triggering.

Source

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

This receiver 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 [get_object_temperature_callback_receiver] receiver is only triggered if the object temperature has changed since the last triggering.

Source

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

This receiver 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 receiver is triggered periodically with the period as set by [set_debounce_period].

Source

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

This receiver 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 receiver is triggered periodically with the period as set by [set_debounce_period].

Source

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

Returns the ambient temperature of the sensor.

If you want to get the ambient temperature periodically, it is recommended to use the [get_ambient_temperature_callback_receiver] receiver and set the period with [set_ambient_temperature_callback_period].

Source

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

Returns the object temperature of the sensor, i.e. the temperature of the surface of the object the sensor is aimed at.

The temperature of different materials is dependent on their emissivity <https://en.wikipedia.org/wiki/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 [get_object_temperature_callback_receiver] receiver and set the period with [set_object_temperature_callback_period].

Source

pub async fn set_emissivity( &mut self, emissivity: u16, ) -> Result<(), TinkerforgeError>

Sets the emissivity__ that is used to calculate the surface temperature as returned by :func:[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](https://www.infrared-thermography.com/material.htm)__.

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 emissivity is stored in non-volatile memory and will still be used after a restart or power cycle of the Bricklet.

Source

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

Returns the emissivity as set by [set_emissivity].

Source

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

Sets the period with which the [get_ambient_temperature_callback_receiver] receiver is triggered periodically. A value of 0 turns the receiver off.

The [get_ambient_temperature_callback_receiver] receiver is only triggered if the temperature has changed since the last triggering.

Source

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

Returns the period as set by [set_ambient_temperature_callback_period].

Source

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

Sets the period with which the [get_object_temperature_callback_receiver] receiver is triggered periodically. A value of 0 turns the receiver off.

The [get_object_temperature_callback_receiver] receiver is only triggered if the temperature has changed since the last triggering.

Source

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

Returns the period as set by [set_object_temperature_callback_period].

Source

pub async fn set_ambient_temperature_callback_threshold( &mut self, option: char, min: i16, max: i16, ) -> Result<(), TinkerforgeError>

Sets the thresholds for the [get_ambient_temperature_reached_callback_receiver] receiver.

The following options are possible:

Option	Description
‘x’	Receiver is turned off
‘o’	Receiver is triggered when the ambient temperature is outside the min and max values
‘i’	Receiver is triggered when the ambient temperature is inside the min and max values
‘<’	Receiver is triggered when the ambient temperature is smaller than the min value (max is ignored)
‘>’	Receiver is triggered when the ambient temperature is greater than the min value (max is ignored)

Associated constants:

TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_OFF
TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_OUTSIDE
TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_INSIDE
TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_SMALLER
TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_GREATER

Source

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

Returns the threshold as set by [set_ambient_temperature_callback_threshold].

Associated constants:

TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_OFF
TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_OUTSIDE
TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_INSIDE
TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_SMALLER
TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_GREATER

Source

pub async fn set_object_temperature_callback_threshold( &mut self, option: char, min: i16, max: i16, ) -> Result<(), TinkerforgeError>

Sets the thresholds for the [get_object_temperature_reached_callback_receiver] receiver.

The following options are possible:

Option	Description
‘x’	Receiver is turned off
‘o’	Receiver is triggered when the object temperature is outside the min and max values
‘i’	Receiver is triggered when the object temperature is inside the min and max values
‘<’	Receiver is triggered when the object temperature is smaller than the min value (max is ignored)
‘>’	Receiver is triggered when the object temperature is greater than the min value (max is ignored)