Rust - Distance US Bricklet

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

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

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

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

    // Get current distance value.
    let distance = dus.get_distance_value().recv()?;
    println!("Distance Value: {}", distance);

    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::{distance_us_bricklet::*, ip_connection::IpConnection};

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

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

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

    let distance_receiver = dus.get_distance_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `dus` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for distance in distance_receiver {
            println!("Distance Value: {}", distance);
        }
    });

    // Set period for distance value receiver to 0.2s (200ms).
    // Note: The distance value callback is only called every 0.2 seconds
    //       if the distance value has changed since the last call!
    dus.set_distance_callback_period(200);

    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::{distance_us_bricklet::*, ip_connection::IpConnection};

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

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

    let distance_reached_receiver = dus.get_distance_reached_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `dus` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for distance_reached in distance_reached_receiver {
            println!("Distance Value: {}", distance_reached);
        }
    });

    // Configure threshold for distance value "smaller than 200".
    dus.set_distance_callback_threshold('<', 200, 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 DistanceUsBricklet::new(uid: &str, ip_connection: &IpConnection) → DistanceUsBricklet

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

Returns the current distance value measured by the sensor. The value has a range of 0 to 4095. A small value corresponds to a small distance, a big value corresponds to a big distance. The relation between the measured distance value and the actual distance is affected by the 5V supply voltage (deviations in the supply voltage result in deviations in the distance values) and is non-linear (resolution is bigger at close range).

If you want to get the distance value periodically, it is recommended to use the DistanceUsBricklet::get_distance_callback_receiver callback and set the period with DistanceUsBricklet::set_distance_callback_period.

Advanced Functions

pub fn DistanceUsBricklet::set_moving_average(&self, average: u8) → ConvertingReceiver<()>

Sets the length of a moving averaging for the distance value.

Setting the length to 0 will turn the averaging completely off. With less averaging, there is more noise on the data.

The range for the averaging is 0-100.

The default value is 20.

pub fn DistanceUsBricklet::get_moving_average(&self) → ConvertingReceiver<u8>

Returns the length moving average as set by DistanceUsBricklet::set_moving_average.

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

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

  • DISTANCE_US_BRICKLET_FUNCTION_SET_DISTANCE_CALLBACK_PERIOD = 2
  • DISTANCE_US_BRICKLET_FUNCTION_SET_DISTANCE_CALLBACK_THRESHOLD = 4
  • DISTANCE_US_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • DISTANCE_US_BRICKLET_FUNCTION_SET_MOVING_AVERAGE = 10
pub fn DistanceUsBricklet::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 DistanceUsBricklet::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 DistanceUsBricklet::set_distance_callback_period(&self, period: u32) → ConvertingReceiver<()>

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

Der DistanceUsBricklet::get_distance_callback_receiver callback is only triggered if the distance value has changed since the last triggering.

The default value is 0.

pub fn DistanceUsBricklet::get_distance_callback_period(&self) → ConvertingReceiver<u32>

Returns the period as set by DistanceUsBricklet::set_distance_callback_period.

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

Sets the thresholds for the DistanceUsBricklet::get_distance_reached_callback_receiver callback.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the distance value is outside the min and max values
'i' Callback is triggered when the distance value is inside the min and max values
'<' Callback is triggered when the distance value is smaller than the min value (max is ignored)
'>' Callback is triggered when the distance 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:

  • DISTANCE_US_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • DISTANCE_US_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • DISTANCE_US_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • DISTANCE_US_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • DISTANCE_US_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn DistanceUsBricklet::get_distance_callback_threshold(&self) → ConvertingReceiver<DistanceCallbackThreshold>

Returns the threshold as set by DistanceUsBricklet::set_distance_callback_threshold.

The following constants are available for this function:

  • DISTANCE_US_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • DISTANCE_US_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • DISTANCE_US_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • DISTANCE_US_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • DISTANCE_US_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn DistanceUsBricklet::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 DistanceUsBricklet::get_debounce_period(&self) → ConvertingReceiver<u32>

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

Receivers created with this function receive Distance events.

This callback is triggered periodically with the period that is set by DistanceUsBricklet::set_distance_callback_period. The received variable is the distance value of the sensor.

The DistanceUsBricklet::get_distance_callback_receiver callback is only triggered if the distance value has changed since the last triggering.

pub fn DistanceUsBricklet::get_distance_reached_callback_receiver(&self) → ConvertingCallbackReceiver<u16>

Receivers created with this function receive Distance Reached events.

This callback is triggered when the threshold as set by DistanceUsBricklet::set_distance_callback_threshold is reached. The received variable is the distance value of the sensor.

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

Constants

DistanceUsBricklet::DEVICE_IDENTIFIER

This constant is used to identify a Distance US Bricklet.

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

DistanceUsBricklet::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Distance US Bricklet.