Rust - Thermocouple Bricklet

This is the description of the Rust API bindings for the Thermocouple Bricklet. General information and technical specifications for the Thermocouple 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
use std::{error::Error, io};

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

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

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

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

    // Get current temperature.
    let temperature = t.get_temperature().recv()?;
    println!("Temperature: {} °C", temperature as f32 / 100.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, thermocouple_bricklet::*};

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

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

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

    let temperature_receiver = t.get_temperature_callback_receiver();

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

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

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

Threshold

Download (example_threshold.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
use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, thermocouple_bricklet::*};

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

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

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

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

    let temperature_reached_receiver = t.get_temperature_reached_callback_receiver();

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

    // Configure threshold for temperature "greater than 30 °C".
    t.set_temperature_callback_threshold('>', 30 * 100, 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 occured.

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 ThermocoupleBricklet::new(uid: &str, ip_connection: &IpConnection) → ThermocoupleBricklet

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

This device object can be used after the IP connection has been connected (see examples above).

pub fn ThermocoupleBricklet::get_temperature(&self) → ConvertingReceiver<i32>

Returns the temperature of the thermocouple. The value is given in °C/100, e.g. a value of 4223 means that a temperature of 42.23 °C is measured.

If you want to get the temperature periodically, it is recommended to use the ThermocoupleBricklet::get_temperature_callback_receiver callback and set the period with ThermocoupleBricklet::set_temperature_callback_period.

Advanced Functions

pub fn ThermocoupleBricklet::set_configuration(&self, averaging: u8, thermocouple_type: u8, filter: u8) → ConvertingReceiver<()>

You can configure averaging size, thermocouple type and frequency filtering.

Available averaging sizes are 1, 2, 4, 8 and 16 samples.

As thermocouple type you can use B, E, J, K, N, R, S and T. If you have a different thermocouple or a custom thermocouple you can also use G8 and G32. With these types the returned value will not be in °C/100, it will be calculated by the following formulas:

  • G8: value = 8 * 1.6 * 2^17 * Vin
  • G32: value = 32 * 1.6 * 2^17 * Vin

where Vin is the thermocouple input voltage.

The frequency filter can be either configured to 50Hz or to 60Hz. You should configure it according to your utility frequency.

The conversion time depends on the averaging and filter configuration, it can be calculated as follows:

  • 60Hz: time = 82 + (samples - 1) * 16.67
  • 50Hz: time = 98 + (samples - 1) * 20

The default configuration is 16 samples, K type and 50Hz.

The following constants are available for this function:

  • THERMOCOUPLE_BRICKLET_AVERAGING_1 = 1
  • THERMOCOUPLE_BRICKLET_AVERAGING_2 = 2
  • THERMOCOUPLE_BRICKLET_AVERAGING_4 = 4
  • THERMOCOUPLE_BRICKLET_AVERAGING_8 = 8
  • THERMOCOUPLE_BRICKLET_AVERAGING_16 = 16
  • THERMOCOUPLE_BRICKLET_TYPE_B = 0
  • THERMOCOUPLE_BRICKLET_TYPE_E = 1
  • THERMOCOUPLE_BRICKLET_TYPE_J = 2
  • THERMOCOUPLE_BRICKLET_TYPE_K = 3
  • THERMOCOUPLE_BRICKLET_TYPE_N = 4
  • THERMOCOUPLE_BRICKLET_TYPE_R = 5
  • THERMOCOUPLE_BRICKLET_TYPE_S = 6
  • THERMOCOUPLE_BRICKLET_TYPE_T = 7
  • THERMOCOUPLE_BRICKLET_TYPE_G8 = 8
  • THERMOCOUPLE_BRICKLET_TYPE_G32 = 9
  • THERMOCOUPLE_BRICKLET_FILTER_OPTION_50HZ = 0
  • THERMOCOUPLE_BRICKLET_FILTER_OPTION_60HZ = 1
pub fn ThermocoupleBricklet::get_configuration(&self) → ConvertingReceiver<Configuration>

Returns the configuration as set by ThermocoupleBricklet::set_configuration.

The following constants are available for this function:

  • THERMOCOUPLE_BRICKLET_AVERAGING_1 = 1
  • THERMOCOUPLE_BRICKLET_AVERAGING_2 = 2
  • THERMOCOUPLE_BRICKLET_AVERAGING_4 = 4
  • THERMOCOUPLE_BRICKLET_AVERAGING_8 = 8
  • THERMOCOUPLE_BRICKLET_AVERAGING_16 = 16
  • THERMOCOUPLE_BRICKLET_TYPE_B = 0
  • THERMOCOUPLE_BRICKLET_TYPE_E = 1
  • THERMOCOUPLE_BRICKLET_TYPE_J = 2
  • THERMOCOUPLE_BRICKLET_TYPE_K = 3
  • THERMOCOUPLE_BRICKLET_TYPE_N = 4
  • THERMOCOUPLE_BRICKLET_TYPE_R = 5
  • THERMOCOUPLE_BRICKLET_TYPE_S = 6
  • THERMOCOUPLE_BRICKLET_TYPE_T = 7
  • THERMOCOUPLE_BRICKLET_TYPE_G8 = 8
  • THERMOCOUPLE_BRICKLET_TYPE_G32 = 9
  • THERMOCOUPLE_BRICKLET_FILTER_OPTION_50HZ = 0
  • THERMOCOUPLE_BRICKLET_FILTER_OPTION_60HZ = 1
pub fn ThermocoupleBricklet::get_error_state(&self) → ConvertingReceiver<ErrorState>

Returns the current error state. There are two possible errors:

  • Over/Under Voltage and
  • Open Circuit.

Over/Under Voltage happens for voltages below 0V or above 3.3V. In this case it is very likely that your thermocouple is defective. An Open Circuit error indicates that there is no thermocouple connected.

You can use the ThermocoupleBricklet::get_error_state_callback_receiver callback to automatically get triggered when the error state changes.

pub fn ThermocoupleBricklet::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 ThermocoupleBricklet::get_response_expected(&mut self, function_id: u8) → 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 ThermocoupleBricklet::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 ThermocoupleBricklet::set_response_expected for the list of function ID constants available for this function.

pub fn ThermocoupleBricklet::set_response_expected(&mut self, function_id: u8, response_expected: 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 send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • THERMOCOUPLE_BRICKLET_FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 2
  • THERMOCOUPLE_BRICKLET_FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 4
  • THERMOCOUPLE_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • THERMOCOUPLE_BRICKLET_FUNCTION_SET_CONFIGURATION = 10
pub fn ThermocoupleBricklet::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 ThermocoupleBricklet::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. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

pub fn ThermocoupleBricklet::set_temperature_callback_period(&self, period: u32) → ConvertingReceiver<()>

Sets the period in ms with which the ThermocoupleBricklet::get_temperature_callback_receiver callback is triggered periodically. A value of 0 turns the callback off.

The ThermocoupleBricklet::get_temperature_callback_receiver callback is only triggered if the temperature has changed since the last triggering.

The default value is 0.

pub fn ThermocoupleBricklet::get_temperature_callback_period(&self) → ConvertingReceiver<u32>

Returns the period as set by ThermocoupleBricklet::set_temperature_callback_period.

pub fn ThermocoupleBricklet::set_temperature_callback_threshold(&self, option: char, min: i32, max: i32) → ConvertingReceiver<()>

Sets the thresholds for the ThermocoupleBricklet::get_temperature_reached_callback_receiver callback.

The following options are possible:

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

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

The following constants are available for this function:

  • THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn ThermocoupleBricklet::get_temperature_callback_threshold(&self) → ConvertingReceiver<TemperatureCallbackThreshold>

Returns the threshold as set by ThermocoupleBricklet::set_temperature_callback_threshold.

The following constants are available for this function:

  • THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • THERMOCOUPLE_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn ThermocoupleBricklet::set_debounce_period(&self, debounce: u32) → ConvertingReceiver<()>

Sets the period in ms with which the threshold callback

is triggered, if the threshold

keeps being reached.

The default value is 100.

pub fn ThermocoupleBricklet::get_debounce_period(&self) → ConvertingReceiver<u32>

Returns the debounce period as set by ThermocoupleBricklet::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 ThermocoupleBricklet::get_temperature_callback_receiver(&self) → ConvertingCallbackReceiver<i32>

Receivers created with this function receive Temperature events.

This callback is triggered periodically with the period that is set by ThermocoupleBricklet::set_temperature_callback_period. The received variable is the temperature of the thermocouple.

The ThermocoupleBricklet::get_temperature_callback_receiver callback is only triggered if the temperature has changed since the last triggering.

pub fn ThermocoupleBricklet::get_temperature_reached_callback_receiver(&self) → ConvertingCallbackReceiver<i32>

Receivers created with this function receive Temperature Reached events.

This callback is triggered when the threshold as set by ThermocoupleBricklet::set_temperature_callback_threshold is reached. The received variable is the temperature of the thermocouple.

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

pub fn ThermocoupleBricklet::get_error_state_callback_receiver(&self) → ConvertingCallbackReceiver<ErrorStateEvent>

Receivers created with this function receive Error State events.

This Callback is triggered every time the error state changes (see ThermocoupleBricklet::get_error_state).

Constants

ThermocoupleBricklet::DEVICE_IDENTIFIER

This constant is used to identify a Thermocouple Bricklet.

The ThermocoupleBricklet::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.

ThermocoupleBricklet::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Thermocouple Bricklet.