Rust - PTC Bricklet

This is the description of the Rust API bindings for the PTC Bricklet. General information and technical specifications for the PTC 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, ptc_bricklet::*};

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let ptc = PtcBricklet::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 = ptc.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, ptc_bricklet::*};

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let ptc = PtcBricklet::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 = ptc.get_temperature_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `ptc` 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!
    ptc.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, ptc_bricklet::*};

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let ptc = PtcBricklet::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).
    ptc.set_debounce_period(10000);

    let temperature_reached_receiver = ptc.get_temperature_reached_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `ptc` 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".
    ptc.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 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 PtcBricklet::new(uid: &str, ip_connection: &IpConnection) → PtcBricklet
Parameters:
  • uid – Type: &str
  • ip_connection – Type: &IPConnection
Returns:
  • ptc – Type: PtcBricklet

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

let ptc = PtcBricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn PtcBricklet::get_temperature(&self) → ConvertingReceiver<i32>
Returns:
  • temperature – Type: i32, Unit: 1/100 °C, Range: [-24600 to 84900]

Returns the temperature of connected sensor.

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

pub fn PtcBricklet::is_sensor_connected(&self) → ConvertingReceiver<bool>
Returns:
  • connected – Type: bool

Returns true if the sensor is connected correctly.

If this function returns false, there is either no Pt100 or Pt1000 sensor connected, the sensor is connected incorrectly or the sensor itself is faulty.

pub fn PtcBricklet::set_wire_mode(&self, mode: u8) → ConvertingReceiver<()>
Parameters:
  • mode – Type: u8, Range: See constants, Default: 2

Sets the wire mode of the sensor. Possible values are 2, 3 and 4 which correspond to 2-, 3- and 4-wire sensors. The value has to match the jumper configuration on the Bricklet.

The following constants are available for this function:

For mode:

  • PTC_BRICKLET_WIRE_MODE_2 = 2
  • PTC_BRICKLET_WIRE_MODE_3 = 3
  • PTC_BRICKLET_WIRE_MODE_4 = 4
pub fn PtcBricklet::get_wire_mode(&self) → ConvertingReceiver<u8>
Returns:
  • mode – Type: u8, Range: See constants, Default: 2

Returns the wire mode as set by PtcBricklet::set_wire_mode

The following constants are available for this function:

For mode:

  • PTC_BRICKLET_WIRE_MODE_2 = 2
  • PTC_BRICKLET_WIRE_MODE_3 = 3
  • PTC_BRICKLET_WIRE_MODE_4 = 4

Advanced Functions

pub fn PtcBricklet::get_resistance(&self) → ConvertingReceiver<i32>
Returns:
  • resistance – Type: i32, Unit: ? Ω, Range: [-231 to 231 - 1]

Returns the value as measured by the MAX31865 precision delta-sigma ADC.

The value can be converted with the following formulas:

  • Pt100: resistance = (value * 390) / 32768
  • Pt1000: resistance = (value * 3900) / 32768

If you want to get the resistance periodically, it is recommended to use the PtcBricklet::get_resistance_callback_receiver callback and set the period with PtcBricklet::set_resistance_callback_period.

pub fn PtcBricklet::set_noise_rejection_filter(&self, filter: u8) → ConvertingReceiver<()>
Parameters:
  • filter – Type: u8, Range: See constants, Default: 0

Sets the noise rejection filter to either 50Hz (0) or 60Hz (1). Noise from 50Hz or 60Hz power sources (including harmonics of the AC power's fundamental frequency) is attenuated by 82dB.

The following constants are available for this function:

For filter:

  • PTC_BRICKLET_FILTER_OPTION_50HZ = 0
  • PTC_BRICKLET_FILTER_OPTION_60HZ = 1
pub fn PtcBricklet::get_noise_rejection_filter(&self) → ConvertingReceiver<u8>
Returns:
  • filter – Type: u8, Range: See constants, Default: 0

Returns the noise rejection filter option as set by PtcBricklet::set_noise_rejection_filter

The following constants are available for this function:

For filter:

  • PTC_BRICKLET_FILTER_OPTION_50HZ = 0
  • PTC_BRICKLET_FILTER_OPTION_60HZ = 1
pub fn PtcBricklet::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 PtcBricklet::set_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 PtcBricklet::get_temperature_callback_receiver callback is triggered periodically. A value of 0 turns the callback off.

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

pub fn PtcBricklet::get_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 PtcBricklet::set_temperature_callback_period.

pub fn PtcBricklet::set_resistance_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 PtcBricklet::get_resistance_callback_receiver callback is triggered periodically. A value of 0 turns the callback off.

The PtcBricklet::get_resistance_callback_receiver callback is only triggered if the resistance has changed since the last triggering.

pub fn PtcBricklet::get_resistance_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 PtcBricklet::set_resistance_callback_period.

pub fn PtcBricklet::set_temperature_callback_threshold(&self, option: char, min: i32, max: i32) → ConvertingReceiver<()>
Parameters:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: i32, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0
  • max – Type: i32, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0

Sets the thresholds for the PtcBricklet::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 following constants are available for this function:

For option:

  • PTC_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • PTC_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • PTC_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • PTC_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • PTC_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn PtcBricklet::get_temperature_callback_threshold(&self) → ConvertingReceiver<TemperatureCallbackThreshold>
Return Object:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: i32, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0
  • max – Type: i32, Unit: 1/100 °C, Range: [-231 to 231 - 1], Default: 0

Returns the threshold as set by PtcBricklet::set_temperature_callback_threshold.

The following constants are available for this function:

For option:

  • PTC_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • PTC_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • PTC_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • PTC_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • PTC_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn PtcBricklet::set_resistance_callback_threshold(&self, option: char, min: i32, max: i32) → ConvertingReceiver<()>
Parameters:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: i32, Unit: ? Ω, Range: [-231 to 231 - 1], Default: 0
  • max – Type: i32, Unit: ? Ω, Range: [-231 to 231 - 1], Default: 0

Sets the thresholds for the PtcBricklet::get_resistance_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 following constants are available for this function:

For option:

  • PTC_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • PTC_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • PTC_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • PTC_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • PTC_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn PtcBricklet::get_resistance_callback_threshold(&self) → ConvertingReceiver<ResistanceCallbackThreshold>
Return Object:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: i32, Unit: ? Ω, Range: [-231 to 231 - 1], Default: 0
  • max – Type: i32, Unit: ? Ω, Range: [-231 to 231 - 1], Default: 0

Returns the threshold as set by PtcBricklet::set_resistance_callback_threshold.

The following constants are available for this function:

For option:

  • PTC_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • PTC_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • PTC_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • PTC_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • PTC_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn PtcBricklet::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 callback

is triggered, if the threshold

keeps being reached.

pub fn PtcBricklet::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 PtcBricklet::set_debounce_period.

pub fn PtcBricklet::set_sensor_connected_callback_configuration(&self, enabled: bool) → ConvertingReceiver<()>
Parameters:
  • enabled – Type: bool, Default: false

If you enable this callback, the PtcBricklet::get_sensor_connected_callback_receiver callback is triggered every time a Pt sensor is connected/disconnected.

New in version 2.0.2 (Plugin).

pub fn PtcBricklet::get_sensor_connected_callback_configuration(&self) → ConvertingReceiver<bool>
Returns:
  • enabled – Type: bool, Default: false

Returns the configuration as set by PtcBricklet::set_sensor_connected_callback_configuration.

New in version 2.0.2 (Plugin).

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 PtcBricklet::get_temperature_callback_receiver(&self) → ConvertingCallbackReceiver<i32>
Event:
  • temperature – Type: i32, Unit: 1/100 °C, Range: [-24600 to 84900]

Receivers created with this function receive Temperature events.

This callback is triggered periodically with the period that is set by PtcBricklet::set_temperature_callback_period. The received variable is the temperature of the connected sensor.

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

pub fn PtcBricklet::get_temperature_reached_callback_receiver(&self) → ConvertingCallbackReceiver<i32>
Event:
  • temperature – Type: i32, Unit: 1/100 °C, Range: [-24600 to 84900]

Receivers created with this function receive Temperature Reached events.

This callback is triggered when the threshold as set by PtcBricklet::set_temperature_callback_threshold is reached. The received variable is the temperature of the connected sensor.

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

pub fn PtcBricklet::get_resistance_callback_receiver(&self) → ConvertingCallbackReceiver<i32>
Event:
  • resistance – Type: i32, Unit: ? Ω, Range: [-231 to 231 - 1]

Receivers created with this function receive Resistance events.

This callback is triggered periodically with the period that is set by PtcBricklet::set_resistance_callback_period. The received variable is the resistance of the connected sensor.

The PtcBricklet::get_resistance_callback_receiver callback is only triggered if the resistance has changed since the last triggering.

pub fn PtcBricklet::get_resistance_reached_callback_receiver(&self) → ConvertingCallbackReceiver<i32>
Event:
  • resistance – Type: i32, Unit: ? Ω, Range: [-231 to 231 - 1]

Receivers created with this function receive Resistance Reached events.

This callback is triggered when the threshold as set by PtcBricklet::set_resistance_callback_threshold is reached. The received variable is the resistance of the connected sensor.

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

pub fn PtcBricklet::get_sensor_connected_callback_receiver(&self) → ConvertingCallbackReceiver<bool>
Event:
  • connected – Type: bool

Receivers created with this function receive Sensor Connected events.

This callback is triggered periodically according to the configuration set by PtcBricklet::set_sensor_connected_callback_configuration.

The received variable is the same as PtcBricklet::is_sensor_connected.

New in version 2.0.2 (Plugin).

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 PtcBricklet::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 PtcBricklet::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 PtcBricklet::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:

  • PTC_BRICKLET_FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 3
  • PTC_BRICKLET_FUNCTION_SET_RESISTANCE_CALLBACK_PERIOD = 5
  • PTC_BRICKLET_FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 7
  • PTC_BRICKLET_FUNCTION_SET_RESISTANCE_CALLBACK_THRESHOLD = 9
  • PTC_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • PTC_BRICKLET_FUNCTION_SET_NOISE_REJECTION_FILTER = 17
  • PTC_BRICKLET_FUNCTION_SET_WIRE_MODE = 20
  • PTC_BRICKLET_FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 22
pub fn PtcBricklet::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:

  • PTC_BRICKLET_FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 3
  • PTC_BRICKLET_FUNCTION_SET_RESISTANCE_CALLBACK_PERIOD = 5
  • PTC_BRICKLET_FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 7
  • PTC_BRICKLET_FUNCTION_SET_RESISTANCE_CALLBACK_THRESHOLD = 9
  • PTC_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • PTC_BRICKLET_FUNCTION_SET_NOISE_REJECTION_FILTER = 17
  • PTC_BRICKLET_FUNCTION_SET_WIRE_MODE = 20
  • PTC_BRICKLET_FUNCTION_SET_SENSOR_CONNECTED_CALLBACK_CONFIGURATION = 22
pub fn PtcBricklet::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 PtcBricklet::DEVICE_IDENTIFIER

This constant is used to identify a PTC Bricklet.

The PtcBricklet::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 PtcBricklet::DEVICE_DISPLAY_NAME

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