Rust - Voltage/Current Bricklet

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

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let vc = VoltageCurrentBricklet::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 = vc.get_voltage().recv()?;
    println!("Voltage: {} V", voltage as f32 / 1000.0);

    // Get current current.
    let current = vc.get_current().recv()?;
    println!("Current: {} A", current 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_current_bricklet::*};

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

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

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

    let current_receiver = vc.get_current_callback_receiver();

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

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

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

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

    let power_reached_receiver = vc.get_power_reached_callback_receiver();

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

    // Configure threshold for power "greater than 10 W".
    vc.set_power_callback_threshold('>', 10 * 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 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 VoltageCurrentBricklet::new(uid: &str, ip_connection: &IpConnection) → VoltageCurrentBricklet

Creates a new VoltageCurrentBricklet 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 VoltageCurrentBricklet::get_current(&self) → ConvertingReceiver<i32>

Returns the current. The value is in mA and between -20000mA and 20000mA.

If you want to get the current periodically, it is recommended to use the VoltageCurrentBricklet::get_current_callback_receiver callback and set the period with VoltageCurrentBricklet::set_current_callback_period.

pub fn VoltageCurrentBricklet::get_voltage(&self) → ConvertingReceiver<i32>

Returns the voltage. The value is in mV and between 0mV and 36000mV.

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

pub fn VoltageCurrentBricklet::get_power(&self) → ConvertingReceiver<i32>

Returns the power. The value is in mW and between 0mV and 720000mW.

If you want to get the power periodically, it is recommended to use the VoltageCurrentBricklet::get_power_callback_receiver callback and set the period with VoltageCurrentBricklet::set_power_callback_period.

pub fn VoltageCurrentBricklet::set_configuration(&self, averaging: u8, voltage_conversion_time: u8, current_conversion_time: u8) → ConvertingReceiver<()>

Sets the configuration of the Voltage/Current Bricklet. It is possible to configure number of averages as well as voltage and current conversion time.

Averaging:

Value Number of Averages
0 1
1 4
2 16
3 64
4 128
5 256
6 512
>=7 1024

Voltage/Current conversion:

Value Conversion time
0 140µs
1 204µs
2 332µs
3 588µs
4 1.1ms
5 2.116ms
6 4.156ms
>=7 8.244ms

The default values are 3, 4 and 4 (64, 1.1ms, 1.1ms) for averaging, voltage conversion and current conversion.

The following constants are available for this function:

  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_1 = 0
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_4 = 1
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_16 = 2
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_64 = 3
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_128 = 4
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_256 = 5
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_512 = 6
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_1024 = 7
pub fn VoltageCurrentBricklet::get_configuration(&self) → ConvertingReceiver<Configuration>

Returns the configuration as set by VoltageCurrentBricklet::set_configuration.

The following constants are available for this function:

  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_1 = 0
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_4 = 1
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_16 = 2
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_64 = 3
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_128 = 4
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_256 = 5
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_512 = 6
  • VOLTAGE_CURRENT_BRICKLET_AVERAGING_1024 = 7

Advanced Functions

pub fn VoltageCurrentBricklet::set_calibration(&self, gain_multiplier: u16, gain_divisor: u16) → ConvertingReceiver<()>

Since the shunt resistor that is used to measure the current is not perfectly precise, it needs to be calibrated by a multiplier and divisor if a very precise reading is needed.

For example, if you are expecting a measurement of 1000mA and you are measuring 1023mA, you can calibrate the Voltage/Current Bricklet by setting the multiplier to 1000 and the divisor to 1023.

pub fn VoltageCurrentBricklet::get_calibration(&self) → ConvertingReceiver<Calibration>

Returns the calibration as set by VoltageCurrentBricklet::set_calibration.

pub fn VoltageCurrentBricklet::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 VoltageCurrentBricklet::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 VoltageCurrentBricklet::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 VoltageCurrentBricklet::set_response_expected for the list of function ID constants available for this function.

pub fn VoltageCurrentBricklet::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:

  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_CONFIGURATION = 4
  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_CALIBRATION = 6
  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 8
  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 10
  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_POWER_CALLBACK_PERIOD = 12
  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 14
  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 16
  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_POWER_CALLBACK_THRESHOLD = 18
  • VOLTAGE_CURRENT_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 20
pub fn VoltageCurrentBricklet::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 VoltageCurrentBricklet::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 VoltageCurrentBricklet::set_current_callback_period(&self, period: u32) → ConvertingReceiver<()>

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

The VoltageCurrentBricklet::get_current_callback_receiver callback is only triggered if the current has changed since the last triggering.

The default value is 0.

pub fn VoltageCurrentBricklet::get_current_callback_period(&self) → ConvertingReceiver<u32>

Returns the period as set by VoltageCurrentBricklet::set_current_callback_period.

pub fn VoltageCurrentBricklet::set_voltage_callback_period(&self, period: u32) → ConvertingReceiver<()>

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

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

The default value is 0.

pub fn VoltageCurrentBricklet::get_voltage_callback_period(&self) → ConvertingReceiver<u32>

Returns the period as set by VoltageCurrentBricklet::set_voltage_callback_period.

pub fn VoltageCurrentBricklet::set_power_callback_period(&self, period: u32) → ConvertingReceiver<()>

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

The VoltageCurrentBricklet::get_power_callback_receiver callback is only triggered if the power has changed since the last triggering.

The default value is 0.

pub fn VoltageCurrentBricklet::get_power_callback_period(&self) → ConvertingReceiver<u32>

Returns the period as set by VoltageCurrentBricklet::get_power_callback_period.

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

Sets the thresholds for the VoltageCurrentBricklet::get_current_reached_callback_receiver callback.

The following options are possible:

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

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

The following constants are available for this function:

  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn VoltageCurrentBricklet::get_current_callback_threshold(&self) → ConvertingReceiver<CurrentCallbackThreshold>

Returns the threshold as set by VoltageCurrentBricklet::set_current_callback_threshold.

The following constants are available for this function:

  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn VoltageCurrentBricklet::set_voltage_callback_threshold(&self, option: char, min: i32, max: i32) → ConvertingReceiver<()>

Sets the thresholds for the VoltageCurrentBricklet::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 default value is ('x', 0, 0).

The following constants are available for this function:

  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn VoltageCurrentBricklet::get_voltage_callback_threshold(&self) → ConvertingReceiver<VoltageCallbackThreshold>

Returns the threshold as set by VoltageCurrentBricklet::set_voltage_callback_threshold.

The following constants are available for this function:

  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn VoltageCurrentBricklet::set_power_callback_threshold(&self, option: char, min: i32, max: i32) → ConvertingReceiver<()>

Sets the thresholds for the VoltageCurrentBricklet::get_power_reached_callback_receiver callback.

The following options are possible:

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

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

The following constants are available for this function:

  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn VoltageCurrentBricklet::get_power_callback_threshold(&self) → ConvertingReceiver<PowerCallbackThreshold>

Returns the threshold as set by VoltageCurrentBricklet::set_power_callback_threshold.

The following constants are available for this function:

  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • VOLTAGE_CURRENT_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn VoltageCurrentBricklet::set_debounce_period(&self, debounce: u32) → ConvertingReceiver<()>

Sets the period in ms with which the threshold callbacks

are triggered, if the thresholds

keep being reached.

The default value is 100.

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

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

Receivers created with this function receive Current events.

This callback is triggered periodically with the period that is set by VoltageCurrentBricklet::set_current_callback_period. The received variable is the current of the sensor.

The VoltageCurrentBricklet::get_current_callback_receiver callback is only triggered if the current has changed since the last triggering.

pub fn VoltageCurrentBricklet::get_voltage_callback_receiver(&self) → ConvertingCallbackReceiver<i32>

Receivers created with this function receive Voltage events.

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

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

pub fn VoltageCurrentBricklet::get_power_callback_receiver(&self) → ConvertingCallbackReceiver<i32>

Receivers created with this function receive Power events.

This callback is triggered periodically with the period that is set by VoltageCurrentBricklet::set_power_callback_period. The received variable is the power of the sensor.

The VoltageCurrentBricklet::get_power_callback_receiver callback is only triggered if the power has changed since the last triggering.

pub fn VoltageCurrentBricklet::get_current_reached_callback_receiver(&self) → ConvertingCallbackReceiver<i32>

Receivers created with this function receive Current Reached events.

This callback is triggered when the threshold as set by VoltageCurrentBricklet::set_current_callback_threshold is reached. The received variable is the current of the sensor.

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

pub fn VoltageCurrentBricklet::get_voltage_reached_callback_receiver(&self) → ConvertingCallbackReceiver<i32>

Receivers created with this function receive Voltage Reached events.

This callback is triggered when the threshold as set by VoltageCurrentBricklet::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 VoltageCurrentBricklet::set_debounce_period.

pub fn VoltageCurrentBricklet::get_power_reached_callback_receiver(&self) → ConvertingCallbackReceiver<i32>

Receivers created with this function receive Power Reached events.

This callback is triggered when the threshold as set by VoltageCurrentBricklet::set_power_callback_threshold is reached. The received variable is the power of the sensor.

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

Constants

VoltageCurrentBricklet::DEVICE_IDENTIFIER

This constant is used to identify a Voltage/Current Bricklet.

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

VoltageCurrentBricklet::DEVICE_DISPLAY_NAME

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