Rust - Voltage Bricklet

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

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

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

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

    // Get current voltage.
    let voltage = v.get_voltage().recv()?;
    println!("Voltage: {} V", voltage as f32 / 1000.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, voltage_bricklet::*};

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

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

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

    let voltage_receiver = v.get_voltage_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `v` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for voltage in voltage_receiver {
            println!("Voltage: {} V", voltage as f32 / 1000.0);
        }
    });

    // Set period for voltage receiver to 1s (1000ms).
    // Note: The voltage callback is only called every second
    //       if the voltage has changed since the last call!
    v.set_voltage_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, voltage_bricklet::*};

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

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

    let voltage_reached_receiver = v.get_voltage_reached_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `v` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for voltage_reached in voltage_reached_receiver {
            println!("Voltage: {} V", voltage_reached as f32 / 1000.0);
        }
    });

    // Configure threshold for voltage "greater than 5 V".
    v.set_voltage_callback_threshold('>', 5 * 1000, 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 VoltageBricklet::new(uid: &str, ip_connection: &IpConnection) → VoltageBricklet
Parameters:
  • uid – Type: &str
  • ip_connection – Type: &IPConnection
Returns:
  • voltage – Type: VoltageBricklet

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

let voltage = VoltageBricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn VoltageBricklet::get_voltage(&self) → ConvertingReceiver<u16>
Returns:
  • voltage – Type: u16, Unit: 1 mV, Range: [0 to 50000]

Returns the voltage of the sensor.

If you want to get the voltage periodically, it is recommended to use the VoltageBricklet::get_voltage_callback_receiver callback and set the period with VoltageBricklet::set_voltage_callback_period.

Advanced Functions

pub fn VoltageBricklet::get_analog_value(&self) → ConvertingReceiver<u16>
Returns:
  • value – Type: u16, Range: [0 to 212 - 1]

Returns the value as read by a 12-bit analog-to-digital converter.

Note

The value returned by VoltageBricklet::get_voltage is averaged over several samples to yield less noise, while VoltageBricklet::get_analog_value gives back raw unfiltered analog values. The only reason to use VoltageBricklet::get_analog_value is, if you need the full resolution of the analog-to-digital converter.

If you want the analog value periodically, it is recommended to use the VoltageBricklet::get_analog_value_callback_receiver callback and set the period with VoltageBricklet::set_analog_value_callback_period.

pub fn VoltageBricklet::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 VoltageBricklet::set_voltage_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 VoltageBricklet::get_voltage_callback_receiver callback is triggered periodically. A value of 0 turns the callback off.

The VoltageBricklet::get_voltage_callback_receiver callback is only triggered if the voltage has changed since the last triggering.

pub fn VoltageBricklet::get_voltage_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 VoltageBricklet::set_voltage_callback_period.

pub fn VoltageBricklet::set_analog_value_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 VoltageBricklet::get_analog_value_callback_receiver callback is triggered periodically. A value of 0 turns the callback off.

The VoltageBricklet::get_analog_value_callback_receiver callback is only triggered if the analog value has changed since the last triggering.

pub fn VoltageBricklet::get_analog_value_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 VoltageBricklet::set_analog_value_callback_period.

pub fn VoltageBricklet::set_voltage_callback_threshold(&self, option: char, min: u16, max: u16) → ConvertingReceiver<()>
Parameters:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: u16, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0
  • max – Type: u16, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0

Sets the thresholds for the VoltageBricklet::get_voltage_reached_callback_receiver callback.

The following options are possible:

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

The following constants are available for this function:

For option:

  • VOLTAGE_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn VoltageBricklet::get_voltage_callback_threshold(&self) → ConvertingReceiver<VoltageCallbackThreshold>
Return Object:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: u16, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0
  • max – Type: u16, Unit: 1 mV, Range: [0 to 216 - 1], Default: 0

Returns the threshold as set by VoltageBricklet::set_voltage_callback_threshold.

The following constants are available for this function:

For option:

  • VOLTAGE_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn VoltageBricklet::set_analog_value_callback_threshold(&self, option: char, min: u16, max: u16) → ConvertingReceiver<()>
Parameters:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: u16, Range: [0 to 216 - 1], Default: 0
  • max – Type: u16, Range: [0 to 216 - 1], Default: 0

Sets the thresholds for the VoltageBricklet::get_analog_value_reached_callback_receiver callback.

The following options are possible:

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

The following constants are available for this function:

For option:

  • VOLTAGE_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn VoltageBricklet::get_analog_value_callback_threshold(&self) → ConvertingReceiver<AnalogValueCallbackThreshold>
Return Object:
  • option – Type: char, Range: See constants, Default: 'x'
  • min – Type: u16, Range: [0 to 216 - 1], Default: 0
  • max – Type: u16, Range: [0 to 216 - 1], Default: 0

Returns the threshold as set by VoltageBricklet::set_analog_value_callback_threshold.

The following constants are available for this function:

For option:

  • VOLTAGE_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn VoltageBricklet::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 VoltageBricklet::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 VoltageBricklet::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 VoltageBricklet::get_voltage_callback_receiver(&self) → ConvertingCallbackReceiver<u16>
Event:
  • voltage – Type: u16, Unit: 1 mV, Range: [0 to 50000]

Receivers created with this function receive Voltage events.

This callback is triggered periodically with the period that is set by VoltageBricklet::set_voltage_callback_period. The received variable is the voltage of the sensor.

The VoltageBricklet::get_voltage_callback_receiver callback is only triggered if the voltage has changed since the last triggering.

pub fn VoltageBricklet::get_analog_value_callback_receiver(&self) → ConvertingCallbackReceiver<u16>
Event:
  • value – Type: u16, Range: [0 to 212 - 1]

Receivers created with this function receive Analog Value events.

This callback is triggered periodically with the period that is set by VoltageBricklet::set_analog_value_callback_period. The received variable is the analog value of the sensor.

The VoltageBricklet::get_analog_value_callback_receiver callback is only triggered if the voltage has changed since the last triggering.

pub fn VoltageBricklet::get_voltage_reached_callback_receiver(&self) → ConvertingCallbackReceiver<u16>
Event:
  • voltage – Type: u16, Unit: 1 mV, Range: [0 to 50000]

Receivers created with this function receive Voltage Reached events.

This callback is triggered when the threshold as set by VoltageBricklet::set_voltage_callback_threshold is reached. The received variable is the voltage of the sensor.

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

pub fn VoltageBricklet::get_analog_value_reached_callback_receiver(&self) → ConvertingCallbackReceiver<u16>
Event:
  • value – Type: u16, Range: [0 to 212 - 1]

Receivers created with this function receive Analog Value Reached events.

This callback is triggered when the threshold as set by VoltageBricklet::set_analog_value_callback_threshold is reached. The received variable is the analog value of the sensor.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by VoltageBricklet::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 VoltageBricklet::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 VoltageBricklet::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 VoltageBricklet::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:

  • VOLTAGE_BRICKLET_FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 3
  • VOLTAGE_BRICKLET_FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • VOLTAGE_BRICKLET_FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 7
  • VOLTAGE_BRICKLET_FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • VOLTAGE_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 11
pub fn VoltageBricklet::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:

  • VOLTAGE_BRICKLET_FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 3
  • VOLTAGE_BRICKLET_FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • VOLTAGE_BRICKLET_FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 7
  • VOLTAGE_BRICKLET_FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • VOLTAGE_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 11
pub fn VoltageBricklet::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 VoltageBricklet::DEVICE_IDENTIFIER

This constant is used to identify a Voltage Bricklet.

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

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