Struct tinkerforge::temperature_ir_bricklet::TemperatureIrBricklet

pub struct TemperatureIrBricklet { /* fields omitted */ }

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

Methods

impl TemperatureIrBricklet

pub const DEVICE_IDENTIFIER: u16

pub const DEVICE_DISPLAY_NAME: &'static str

pub fn new<T: GetRequestSender>(
    uid: &str,
    req_sender: T
) -> TemperatureIrBricklet

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: 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 send 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: 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 send 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 fn get_ambient_temperature_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<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.

pub fn get_object_temperature_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<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.

pub fn get_ambient_temperature_reached_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<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.

pub fn get_object_temperature_reached_callback_receiver(
    &self
) -> ConvertingCallbackReceiver<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.

pub fn get_ambient_temperature(&self) -> ConvertingReceiver<i16>

Returns the ambient temperature of the sensor. The value has a range of -400 to 1250 and is given in °C/10, e.g. a value of 423 means that an ambient temperature of 42.3 °C is measured.

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.

pub fn get_object_temperature(&self) -> ConvertingReceiver<i16>

Returns the object temperature of the sensor, i.e. the temperature of the surface of the object the sensor is aimed at. The value has a range of -700 to 3800 and is given in °C/10, e.g. a value of 3001 means that a temperature of 300.1 °C is measured on the surface of the object.

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.

pub fn set_emissivity(&self, emissivity: u16) -> ConvertingReceiver<()>

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 default emissivity is 1.0 (value of 65535) and the minimum emissivity the sensor can handle is 0.1 (value of 6553).

The emissivity is stored in non-volatile memory and will still be used after a restart or power cycle of the Bricklet.

pub fn get_emissivity(&self) -> ConvertingReceiver<u16>

Returns the emissivity as set by set_emissivity.

pub fn set_ambient_temperature_callback_period(
    &self,
    period: u32
) -> ConvertingReceiver<()>

Sets the period in ms 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.

The default value is 0.

pub fn get_ambient_temperature_callback_period(&self) -> ConvertingReceiver<u32>

Returns the period as set by set_ambient_temperature_callback_period.

pub fn set_object_temperature_callback_period(
    &self,
    period: u32
) -> ConvertingReceiver<()>

Sets the period in ms 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.

The default value is 0.

pub fn get_object_temperature_callback_period(&self) -> ConvertingReceiver<u32>

Returns the period as set by set_object_temperature_callback_period.

pub fn set_ambient_temperature_callback_threshold(
    &self,
    option: char,
    min: i16,
    max: i16
) -> ConvertingReceiver<()>

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)

The default value is ('x', 0, 0).

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

pub fn get_ambient_temperature_callback_threshold(
    &self
) -> ConvertingReceiver<AmbientTemperatureCallbackThreshold>

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

pub fn set_object_temperature_callback_threshold(
    &self,
    option: char,
    min: i16,
    max: i16
) -> ConvertingReceiver<()>

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)

The default value is ('x', 0, 0).

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

pub fn get_object_temperature_callback_threshold(
    &self
) -> ConvertingReceiver<ObjectTemperatureCallbackThreshold>

Returns the threshold as set by set_object_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

pub fn set_debounce_period(&self, debounce: u32) -> ConvertingReceiver<()>

Sets the period in ms with which the threshold receivers

• get_ambient_temperature_reached_callback_receiver,
• get_object_temperature_reached_callback_receiver

are triggered, if the thresholds

• set_ambient_temperature_callback_threshold,
• set_object_temperature_callback_threshold

keep being reached.

The default value is 100.

pub fn get_debounce_period(&self) -> ConvertingReceiver<u32>

Returns the debounce period as set by set_debounce_period.

pub fn get_identity(&self) -> ConvertingReceiver<Identity>

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

Trait Implementations

impl Clone for TemperatureIrBricklet

fn clone(&self) -> TemperatureIrBricklet

Returns a copy of the value.

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

Performs copy-assignment from source.