Rust - Analog In Bricklet

This is the description of the Rust API bindings for the Analog In Bricklet. General information and technical specifications for the Analog In 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::{analog_in_bricklet::*, ip_connection::IpConnection};

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

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

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

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

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

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

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

    let voltage_reached_receiver = ai.get_voltage_reached_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `ai` 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 "smaller than 5 V".
    ai.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 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 AnalogInBricklet::new(uid: &str, ip_connection: &IpConnection) → AnalogInBricklet

Creates a new AnalogInBricklet 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 AnalogInBricklet::get_voltage(&self) → ConvertingReceiver<u16>

Returns the voltage of the sensor. The value is in mV and between 0V and 45V. The resolution between 0 and 6V is about 2mV. Between 6 and 45V the resolution is about 10mV.

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

pub fn AnalogInBricklet::set_range(&self, range: u8) → ConvertingReceiver<()>

Sets the measurement range. Possible ranges:

  • 0: Automatically switched
  • 1: 0V - 6.05V, ~1.48mV resolution
  • 2: 0V - 10.32V, ~2.52mV resolution
  • 3: 0V - 36.30V, ~8.86mV resolution
  • 4: 0V - 45.00V, ~11.25mV resolution
  • 5: 0V - 3.3V, ~0.81mV resolution, new in version 2.0.3 (Plugin)

The default measurement range is 0.

The following constants are available for this function:

  • ANALOG_IN_BRICKLET_RANGE_AUTOMATIC = 0
  • ANALOG_IN_BRICKLET_RANGE_UP_TO_6V = 1
  • ANALOG_IN_BRICKLET_RANGE_UP_TO_10V = 2
  • ANALOG_IN_BRICKLET_RANGE_UP_TO_36V = 3
  • ANALOG_IN_BRICKLET_RANGE_UP_TO_45V = 4
  • ANALOG_IN_BRICKLET_RANGE_UP_TO_3V = 5

New in version 2.0.1 (Plugin).

pub fn AnalogInBricklet::get_range(&self) → ConvertingReceiver<u8>

Returns the measurement range as set by AnalogInBricklet::set_range.

The following constants are available for this function:

  • ANALOG_IN_BRICKLET_RANGE_AUTOMATIC = 0
  • ANALOG_IN_BRICKLET_RANGE_UP_TO_6V = 1
  • ANALOG_IN_BRICKLET_RANGE_UP_TO_10V = 2
  • ANALOG_IN_BRICKLET_RANGE_UP_TO_36V = 3
  • ANALOG_IN_BRICKLET_RANGE_UP_TO_45V = 4
  • ANALOG_IN_BRICKLET_RANGE_UP_TO_3V = 5

New in version 2.0.1 (Plugin).

Advanced Functions

pub fn AnalogInBricklet::get_analog_value(&self) → ConvertingReceiver<u16>

Returns the value as read by a 12-bit analog-to-digital converter. The value is between 0 and 4095.

Note

The value returned by AnalogInBricklet::get_voltage is averaged over several samples to yield less noise, while AnalogInBricklet::get_analog_value gives back raw unfiltered analog values. The only reason to use AnalogInBricklet::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 AnalogInBricklet::get_analog_value_callback_receiver callback and set the period with AnalogInBricklet::set_analog_value_callback_period.

pub fn AnalogInBricklet::set_averaging(&self, average: u8) → ConvertingReceiver<()>

Set the length of a averaging for the voltage value.

Setting the length to 0 will turn the averaging completely off. If the averaging is off, there is more noise on the data, but the data is without delay.

The default value is 50.

New in version 2.0.3 (Plugin).

pub fn AnalogInBricklet::get_averaging(&self) → ConvertingReceiver<u8>

Returns the averaging configuration as set by AnalogInBricklet::set_averaging.

New in version 2.0.3 (Plugin).

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

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

  • ANALOG_IN_BRICKLET_FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 3
  • ANALOG_IN_BRICKLET_FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
  • ANALOG_IN_BRICKLET_FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 7
  • ANALOG_IN_BRICKLET_FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
  • ANALOG_IN_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 11
  • ANALOG_IN_BRICKLET_FUNCTION_SET_RANGE = 17
  • ANALOG_IN_BRICKLET_FUNCTION_SET_AVERAGING = 19
pub fn AnalogInBricklet::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 AnalogInBricklet::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 AnalogInBricklet::set_voltage_callback_period(&self, period: u32) → ConvertingReceiver<()>

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

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

The default value is 0.

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

Returns the period as set by AnalogInBricklet::set_voltage_callback_period.

pub fn AnalogInBricklet::set_analog_value_callback_period(&self, period: u32) → ConvertingReceiver<()>

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

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

The default value is 0.

pub fn AnalogInBricklet::get_analog_value_callback_period(&self) → ConvertingReceiver<u32>

Returns the period as set by AnalogInBricklet::set_analog_value_callback_period.

pub fn AnalogInBricklet::set_voltage_callback_threshold(&self, option: char, min: u16, max: u16) → ConvertingReceiver<()>

Sets the thresholds for the AnalogInBricklet::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:

  • ANALOG_IN_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • ANALOG_IN_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • ANALOG_IN_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • ANALOG_IN_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • ANALOG_IN_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn AnalogInBricklet::get_voltage_callback_threshold(&self) → ConvertingReceiver<VoltageCallbackThreshold>

Returns the threshold as set by AnalogInBricklet::set_voltage_callback_threshold.

The following constants are available for this function:

  • ANALOG_IN_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • ANALOG_IN_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • ANALOG_IN_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • ANALOG_IN_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • ANALOG_IN_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn AnalogInBricklet::set_analog_value_callback_threshold(&self, option: char, min: u16, max: u16) → ConvertingReceiver<()>

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

The following constants are available for this function:

  • ANALOG_IN_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • ANALOG_IN_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • ANALOG_IN_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • ANALOG_IN_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • ANALOG_IN_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn AnalogInBricklet::get_analog_value_callback_threshold(&self) → ConvertingReceiver<AnalogValueCallbackThreshold>

Returns the threshold as set by AnalogInBricklet::set_analog_value_callback_threshold.

The following constants are available for this function:

  • ANALOG_IN_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • ANALOG_IN_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • ANALOG_IN_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • ANALOG_IN_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • ANALOG_IN_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn AnalogInBricklet::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 AnalogInBricklet::get_debounce_period(&self) → ConvertingReceiver<u32>

Returns the debounce period as set by AnalogInBricklet::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 AnalogInBricklet::get_voltage_callback_receiver(&self) → ConvertingCallbackReceiver<u16>

Receivers created with this function receive Voltage events.

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

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

pub fn AnalogInBricklet::get_analog_value_callback_receiver(&self) → ConvertingCallbackReceiver<u16>

Receivers created with this function receive Analog Value events.

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

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

pub fn AnalogInBricklet::get_voltage_reached_callback_receiver(&self) → ConvertingCallbackReceiver<u16>

Receivers created with this function receive Voltage Reached events.

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

pub fn AnalogInBricklet::get_analog_value_reached_callback_receiver(&self) → ConvertingCallbackReceiver<u16>

Receivers created with this function receive Analog Value Reached events.

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

Constants

AnalogInBricklet::DEVICE_IDENTIFIER

This constant is used to identify a Analog In Bricklet.

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

AnalogInBricklet::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Analog In Bricklet.