Rust - Temperature IR Bricklet

This is the description of the Rust API bindings for the Temperature IR Bricklet. General information and technical specifications for the Temperature IR Bricklet are summarized in its hardware description.

An installation guide for the Rust API bindings is part of their general description. Additional documentation can be found on docs.rs.

Examples

The example code below is Public Domain (CC0 1.0).

Simple

Download (example_simple.rs)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
use std::{error::Error, io};

use tinkerforge::{ip_connection::IpConnection, temperature_ir_bricklet::*};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Temperature IR Bricklet.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let tir = TemperatureIrBricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    // Get current ambient temperature.
    let ambient_temperature = tir.get_ambient_temperature().recv()?;
    println!("Ambient Temperature: {} °C", ambient_temperature as f32 / 10.0);

    // Get current object temperature.
    let object_temperature = tir.get_object_temperature().recv()?;
    println!("Object Temperature: {} °C", object_temperature as f32 / 10.0);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

Callback

Download (example_callback.rs)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, temperature_ir_bricklet::*};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Temperature IR Bricklet.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let tir = TemperatureIrBricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    let object_temperature_receiver = tir.get_object_temperature_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `tir` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for object_temperature in object_temperature_receiver {
            println!("Object Temperature: {} °C", object_temperature as f32 / 10.0);
        }
    });

    // Set period for object temperature receiver to 1s (1000ms).
    // Note: The object temperature callback is only called every second
    //       if the object temperature has changed since the last call!
    tir.set_object_temperature_callback_period(1000);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

Water Boiling

Download (example_water_boiling.rs)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, temperature_ir_bricklet::*};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Temperature IR Bricklet.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let tir = TemperatureIrBricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    // Set emissivity to 0.98 (emissivity of water, 65535 * 0.98 = 64224.299)
    tir.set_emissivity(64224).recv()?;

    // Get threshold receivers with a debounce time of 10 seconds (10000ms).
    tir.set_debounce_period(10000);

    let object_temperature_reached_receiver = tir.get_object_temperature_reached_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `tir` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for object_temperature_reached in object_temperature_reached_receiver {
            println!("Object Temperature: {} °C", object_temperature_reached as f32 / 10.0);
            println!("The water is boiling!");
        }
    });

    // Configure threshold for object temperature "greater than 100 °C".
    tir.set_object_temperature_callback_threshold('>', 100 * 10, 0);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

API

To allow non-blocking usage, nearly every function of the Rust bindings returns a wrapper around a mpsc::Receiver. To block until the function has finished and get your result, call one of the receiver's recv variants. Those return either the result sent by the device, or any error occurred.

Functions returning a result directly will block until the device has finished processing the request.

All functions listed below are thread-safe, those which return a receiver are lock-free.

Basic Functions

pub fn TemperatureIrBricklet::new(uid: &str, ip_connection: &IpConnection) → TemperatureIrBricklet
Parameters:
  • uid – Type: &str
  • ip_connection – Type: &IPConnection
Returns:
  • temperature_ir – Type: TemperatureIrBricklet

Creates a new TemperatureIrBricklet object with the unique device ID uid and adds it to the IPConnection ip_connection:

let temperature_ir = TemperatureIrBricklet::new("YOUR_DEVICE_UID", &ip_connection);

This device object can be used after the IP connection has been connected.

pub fn TemperatureIrBricklet::get_ambient_temperature(&self) → ConvertingReceiver<i16>
Returns:
  • temperature – Type: i16, Unit: 1/10 °C, Range: [-400 to 1250]

Returns the ambient temperature of the sensor.

If you want to get the ambient temperature periodically, it is recommended to use the TemperatureIrBricklet::get_ambient_temperature_callback_receiver callback and set the period with TemperatureIrBricklet::set_ambient_temperature_callback_period.

pub fn TemperatureIrBricklet::get_object_temperature(&self) → ConvertingReceiver<i16>
Returns:
  • temperature – Type: i16, Unit: 1/10 °C, Range: [-700 to 3800]

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. The emissivity of the material can be set with TemperatureIrBricklet::set_emissivity.

If you want to get the object temperature periodically, it is recommended to use the TemperatureIrBricklet::get_object_temperature_callback_receiver callback and set the period with TemperatureIrBricklet::set_object_temperature_callback_period.

Advanced Functions

pub fn TemperatureIrBricklet::set_emissivity(&self, emissivity: u16) → ConvertingReceiver<()>
Parameters:
  • emissivity – Type: u16, Unit: 1/65535, Range: [6553 to 216 - 1], Default: 216 - 1

Sets the emissivity that is used to calculate the surface temperature as returned by TemperatureIrBricklet::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.

The parameter of TemperatureIrBricklet::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.

pub fn TemperatureIrBricklet::get_emissivity(&self) → ConvertingReceiver<u16>
Returns:
  • emissivity – Type: u16, Unit: 1/65535, Range: [6553 to 216 - 1], Default: 216 - 1

Returns the emissivity as set by TemperatureIrBricklet::set_emissivity.

pub fn TemperatureIrBricklet::get_identity(&self) → ConvertingReceiver<Identity>
Return Object:
  • uid – Type: String, Length: up to 8
  • connected_uid – Type: String, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'i', 'z']
  • hardware_version – Type: [u8; 3]
    • 0: major – Type: u8, Range: [0 to 255]
    • 1: minor – Type: u8, Range: [0 to 255]
    • 2: revision – Type: u8, Range: [0 to 255]
  • firmware_version – Type: [u8; 3]
    • 0: major – Type: u8, Range: [0 to 255]
    • 1: minor – Type: u8, Range: [0 to 255]
    • 2: revision – Type: u8, Range: [0 to 255]
  • device_identifier – Type: u16, 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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

pub fn TemperatureIrBricklet::set_ambient_temperature_callback_period(&self, period: u32) → ConvertingReceiver<()>
Parameters:
  • period – Type: u32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Sets the period with which the TemperatureIrBricklet::get_ambient_temperature_callback_receiver callback is triggered periodically. A value of 0 turns the callback off.

The TemperatureIrBricklet::get_ambient_temperature_callback_receiver callback is only triggered if the temperature has changed since the last triggering.

pub fn TemperatureIrBricklet::get_ambient_temperature_callback_period(&self) → ConvertingReceiver<u32>
Returns:
  • period – Type: u32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by TemperatureIrBricklet::set_ambient_temperature_callback_period.

pub fn TemperatureIrBricklet::set_object_temperature_callback_period(&self, period: u32) → ConvertingReceiver<()>
Parameters:
  • period – Type: u32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Sets the period with which the TemperatureIrBricklet::get_object_temperature_callback_receiver callback is triggered periodically. A value of 0 turns the callback off.

The TemperatureIrBricklet::get_object_temperature_callback_receiver callback is only triggered if the temperature has changed since the last triggering.

pub fn TemperatureIrBricklet::get_object_temperature_callback_period(&self) → ConvertingReceiver<u32>
Returns:
  • period – Type: u32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by TemperatureIrBricklet::set_object_temperature_callback_period.

pub fn TemperatureIrBricklet::set_ambient_temperature_callback_threshold(&self, option: char, min: i16, max: i16) → ConvertingReceiver<()>
Parameters:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: i16, Unit: 1/10 °C, Range: [-215 to 215 - 1], Default: 0
  • max – Type: i16, Unit: 1/10 °C, Range: [-215 to 215 - 1], Default: 0

Sets the thresholds for the TemperatureIrBricklet::get_ambient_temperature_reached_callback_receiver callback.

The following options are possible:

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

The following constants are available for this function:

For option:

  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn TemperatureIrBricklet::get_ambient_temperature_callback_threshold(&self) → ConvertingReceiver<AmbientTemperatureCallbackThreshold>
Return Object:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: i16, Unit: 1/10 °C, Range: [-215 to 215 - 1], Default: 0
  • max – Type: i16, Unit: 1/10 °C, Range: [-215 to 215 - 1], Default: 0

Returns the threshold as set by TemperatureIrBricklet::set_ambient_temperature_callback_threshold.

The following constants are available for this function:

For option:

  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn TemperatureIrBricklet::set_object_temperature_callback_threshold(&self, option: char, min: i16, max: i16) → ConvertingReceiver<()>
Parameters:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: i16, Unit: 1/10 °C, Range: [-215 to 215 - 1], Default: 0
  • max – Type: i16, Unit: 1/10 °C, Range: [-215 to 215 - 1], Default: 0

Sets the thresholds for the TemperatureIrBricklet::get_object_temperature_reached_callback_receiver callback.

The following options are possible:

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

The following constants are available for this function:

For option:

  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn TemperatureIrBricklet::get_object_temperature_callback_threshold(&self) → ConvertingReceiver<ObjectTemperatureCallbackThreshold>
Return Object:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: i16, Unit: 1/10 °C, Range: [-215 to 215 - 1], Default: 0
  • max – Type: i16, Unit: 1/10 °C, Range: [-215 to 215 - 1], Default: 0

Returns the threshold as set by TemperatureIrBricklet::set_object_temperature_callback_threshold.

The following constants are available for this function:

For option:

  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • TEMPERATURE_IR_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn TemperatureIrBricklet::set_debounce_period(&self, debounce: u32) → ConvertingReceiver<()>
Parameters:
  • debounce – Type: u32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Sets the period with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

pub fn TemperatureIrBricklet::get_debounce_period(&self) → ConvertingReceiver<u32>
Returns:
  • debounce – Type: u32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by TemperatureIrBricklet::set_debounce_period.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding get_*_callback_receiver function, which returns a receiver for callback events.

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.

pub fn TemperatureIrBricklet::get_ambient_temperature_callback_receiver(&self) → ConvertingCallbackReceiver<i16>
Event:
  • temperature – Type: i16, Unit: 1/10 °C, Range: [-400 to 1250]

Receivers created with this function receive Ambient Temperature events.

This callback is triggered periodically with the period that is set by TemperatureIrBricklet::set_ambient_temperature_callback_period. The received variable is the ambient temperature of the sensor.

The TemperatureIrBricklet::get_ambient_temperature_callback_receiver callback is only triggered if the ambient temperature has changed since the last triggering.

pub fn TemperatureIrBricklet::get_object_temperature_callback_receiver(&self) → ConvertingCallbackReceiver<i16>
Event:
  • temperature – Type: i16, Unit: 1/10 °C, Range: [-700 to 3800]

Receivers created with this function receive Object Temperature events.

This callback is triggered periodically with the period that is set by TemperatureIrBricklet::set_object_temperature_callback_period. The received variable is the object temperature of the sensor.

The TemperatureIrBricklet::get_object_temperature_callback_receiver callback is only triggered if the object temperature has changed since the last triggering.

pub fn TemperatureIrBricklet::get_ambient_temperature_reached_callback_receiver(&self) → ConvertingCallbackReceiver<i16>
Event:
  • temperature – Type: i16, Unit: 1/10 °C, Range: [-400 to 1250]

Receivers created with this function receive Ambient Temperature Reached events.

This callback is triggered when the threshold as set by TemperatureIrBricklet::set_ambient_temperature_callback_threshold is reached. The received variable is the ambient temperature of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by TemperatureIrBricklet::set_debounce_period.

pub fn TemperatureIrBricklet::get_object_temperature_reached_callback_receiver(&self) → ConvertingCallbackReceiver<i16>
Event:
  • temperature – Type: i16, Unit: 1/10 °C, Range: [-700 to 3800]

Receivers created with this function receive Object Temperature Reached events.

This callback is triggered when the threshold as set by TemperatureIrBricklet::set_object_temperature_callback_threshold is reached. The received variable is the object temperature of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by TemperatureIrBricklet::set_debounce_period.

Virtual Functions

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

pub fn TemperatureIrBricklet::get_api_version(&self) → [u8; 3]
Return Object:
  • api_version – Type: [u8; 3]
    • 0: major – Type: u8, Range: [0 to 255]
    • 1: minor – Type: u8, Range: [0 to 255]
    • 2: revision – Type: u8, Range: [0 to 255]

Returns the version of the API definition 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 TemperatureIrBricklet::get_response_expected(&mut self, function_id: u8) → bool
Parameters:
  • function_id – Type: u8, Range: See constants
Returns:
  • response_expected – Type: bool

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 TemperatureIrBricklet::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.

The following constants are available for this function:

For function_id:

  • TEMPERATURE_IR_BRICKLET_FUNCTION_SET_EMISSIVITY = 3
  • TEMPERATURE_IR_BRICKLET_FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD = 5
  • TEMPERATURE_IR_BRICKLET_FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_PERIOD = 7
  • TEMPERATURE_IR_BRICKLET_FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_THRESHOLD = 9
  • TEMPERATURE_IR_BRICKLET_FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_THRESHOLD = 11
  • TEMPERATURE_IR_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 13
pub fn TemperatureIrBricklet::set_response_expected(&mut self, function_id: u8, response_expected: bool) → ()
Parameters:
  • function_id – Type: u8, Range: See constants
  • response_expected – Type: bool

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.

The following constants are available for this function:

For function_id:

  • TEMPERATURE_IR_BRICKLET_FUNCTION_SET_EMISSIVITY = 3
  • TEMPERATURE_IR_BRICKLET_FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_PERIOD = 5
  • TEMPERATURE_IR_BRICKLET_FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_PERIOD = 7
  • TEMPERATURE_IR_BRICKLET_FUNCTION_SET_AMBIENT_TEMPERATURE_CALLBACK_THRESHOLD = 9
  • TEMPERATURE_IR_BRICKLET_FUNCTION_SET_OBJECT_TEMPERATURE_CALLBACK_THRESHOLD = 11
  • TEMPERATURE_IR_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 13
pub fn TemperatureIrBricklet::set_response_expected_all(&mut self, response_expected: bool) → ()
Parameters:
  • response_expected – Type: bool

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

Constants

pub const TemperatureIrBricklet::DEVICE_IDENTIFIER

This constant is used to identify a Temperature IR Bricklet.

The TemperatureIrBricklet::get_identity function and the IpConnection::get_enumerate_callback_receiver callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

pub const TemperatureIrBricklet::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Temperature IR Bricklet.