Rust - Industrial Dual 0-20mA Bricklet

This is the description of the Rust API bindings for the Industrial Dual 0-20mA Bricklet. General information and technical specifications for the Industrial Dual 0-20mA 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::{industrial_dual_0_20ma_bricklet::*, ip_connection::IpConnection};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet.

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

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

    // Get current current from sensor 1.
    let current = id020.get_current(1).recv()?;
    println!("Current (Sensor 1): {} mA", current as f32 / 1000000.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
37
38
use std::{error::Error, io, thread};
use tinkerforge::{industrial_dual_0_20ma_bricklet::*, ip_connection::IpConnection};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet.

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

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

    // Set period for current (sensor 1) receiver to 1s (1000ms).
    // Note: The current (sensor 1) callback is only called every second
    //       if the current (sensor 1) has changed since the last call!
    id020.set_current_callback_period(1, 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
38
39
use std::{error::Error, io, thread};
use tinkerforge::{industrial_dual_0_20ma_bricklet::*, ip_connection::IpConnection};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Industrial Dual 0-20mA Bricklet.

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

    let current_reached_receiver = id020.get_current_reached_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `id020` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for current_reached in current_reached_receiver {
            println!("Sensor: {}", current_reached.sensor);
            println!("Current: {} mA", current_reached.current as f32 / 1000000.0);
            println!();
        }
    });

    // Configure threshold for current (sensor 1) "greater than 10 mA".
    id020.set_current_callback_threshold(1, '>', 10 * 1000000, 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.

Two sensors can be connected to the Bricklet. Functions that are related directly to a sensor have a sensor parameter to specify one of the two sensors. Valid values for the sensor parameter are 0 and 1.

Basic Functions

pub fn IndustrialDual020maBricklet::new(uid: &str, ip_connection: &IpConnection) → IndustrialDual020maBricklet

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

Returns the current of the specified sensor (0 or 1). The value is in nA and between 0nA and 22505322nA (22.5mA).

It is possible to detect if an IEC 60381-1 compatible sensor is connected and if it works probably.

If the returned current is below 4mA, there is likely no sensor connected or the sensor may be defect. If the returned current is over 20mA, there might be a short circuit or the sensor may be defect.

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

Advanced Functions

pub fn IndustrialDual020maBricklet::set_sample_rate(&self, rate: u8) → ConvertingReceiver<()>

Sets the sample rate to either 240, 60, 15 or 4 samples per second. The resolution for the rates is 12, 14, 16 and 18 bit respectively.

Value Description
0 240 samples per second, 12 bit resolution
1 60 samples per second, 14 bit resolution
2 15 samples per second, 16 bit resolution
3 4 samples per second, 18 bit resolution

The default value is 3 (4 samples per second with 18 bit resolution).

The following constants are available for this function:

  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_SAMPLE_RATE_240_SPS = 0
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_SAMPLE_RATE_60_SPS = 1
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_SAMPLE_RATE_15_SPS = 2
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_SAMPLE_RATE_4_SPS = 3
pub fn IndustrialDual020maBricklet::get_sample_rate(&self) → ConvertingReceiver<u8>

Returns the sample rate as set by IndustrialDual020maBricklet::set_sample_rate.

The following constants are available for this function:

  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_SAMPLE_RATE_240_SPS = 0
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_SAMPLE_RATE_60_SPS = 1
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_SAMPLE_RATE_15_SPS = 2
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_SAMPLE_RATE_4_SPS = 3
pub fn IndustrialDual020maBricklet::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 IndustrialDual020maBricklet::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 IndustrialDual020maBricklet::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 IndustrialDual020maBricklet::set_response_expected for the list of function ID constants available for this function.

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

  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_FUNCTION_SET_CURRENT_CALLBACK_PERIOD = 2
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_FUNCTION_SET_CURRENT_CALLBACK_THRESHOLD = 4
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_FUNCTION_SET_SAMPLE_RATE = 8
pub fn IndustrialDual020maBricklet::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 IndustrialDual020maBricklet::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 IndustrialDual020maBricklet::set_current_callback_period(&self, sensor: u8, period: u32) → ConvertingReceiver<()>

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

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

The default value is 0.

pub fn IndustrialDual020maBricklet::get_current_callback_period(&self, sensor: u8) → ConvertingReceiver<u32>

Returns the period as set by IndustrialDual020maBricklet::set_current_callback_period.

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

Sets the thresholds for the IndustrialDual020maBricklet::get_current_reached_callback_receiver callback for the given sensor.

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:

  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn IndustrialDual020maBricklet::get_current_callback_threshold(&self, sensor: u8) → ConvertingReceiver<CurrentCallbackThreshold>

Returns the threshold as set by IndustrialDual020maBricklet::set_current_callback_threshold.

The following constants are available for this function:

  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_THRESHOLD_OPTION_OFF = 'x'
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_THRESHOLD_OPTION_OUTSIDE = 'o'
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_THRESHOLD_OPTION_INSIDE = 'i'
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_THRESHOLD_OPTION_SMALLER = '<'
  • INDUSTRIAL_DUAL_0_20MA_BRICKLET_THRESHOLD_OPTION_GREATER = '>'
pub fn IndustrialDual020maBricklet::set_debounce_period(&self, debounce: u32) → ConvertingReceiver<()>

Sets the period in ms with which the threshold callback

is triggered, if the threshold

keeps being reached.

The default value is 100.

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

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

Receivers created with this function receive Current events.

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

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

pub fn IndustrialDual020maBricklet::get_current_reached_callback_receiver(&self) → ConvertingCallbackReceiver<CurrentReachedEvent>

Receivers created with this function receive Current Reached events.

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

Constants

IndustrialDual020maBricklet::DEVICE_IDENTIFIER

This constant is used to identify a Industrial Dual 0-20mA Bricklet.

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

IndustrialDual020maBricklet::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Industrial Dual 0-20mA Bricklet.