Rust - Industrial Analog Out Bricklet

This is the description of the Rust API bindings for the Industrial Analog Out Bricklet. General information and technical specifications for the Industrial Analog Out 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 Current

Download (example_simple_current.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
use std::{error::Error, io};

use tinkerforge::{industrial_analog_out_bricklet::*, ip_connection::IpConnection};

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

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

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

    // Set output current to 4.5mA
    iao.set_current(4500);
    iao.enable();

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    iao.disable();
    ipcon.disconnect();
    Ok(())
}

Simple Voltage

Download (example_simple_voltage.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
use std::{error::Error, io};

use tinkerforge::{industrial_analog_out_bricklet::*, ip_connection::IpConnection};

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

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

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

    // Set output voltage to 3.3V
    iao.set_voltage(3300);
    iao.enable();

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    iao.disable();
    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 IndustrialAnalogOutBricklet::new(uid: &str, ip_connection: &IpConnection) → IndustrialAnalogOutBricklet

Creates a new IndustrialAnalogOutBricklet 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 IndustrialAnalogOutBricklet::enable(&self) → ConvertingReceiver<()>

Enables the output of voltage and current.

The default is disabled.

pub fn IndustrialAnalogOutBricklet::disable(&self) → ConvertingReceiver<()>

Disables the output of voltage and current.

The default is disabled.

pub fn IndustrialAnalogOutBricklet::is_enabled(&self) → ConvertingReceiver<bool>

Returns true if output of voltage and current is enabled, false otherwise.

pub fn IndustrialAnalogOutBricklet::set_voltage(&self, voltage: u16) → ConvertingReceiver<()>

Sets the output voltage in mV.

The output voltage and output current are linked. Changing the output voltage also changes the output current.

pub fn IndustrialAnalogOutBricklet::get_voltage(&self) → ConvertingReceiver<u16>

Returns the voltage as set by IndustrialAnalogOutBricklet::set_voltage.

pub fn IndustrialAnalogOutBricklet::set_current(&self, current: u16) → ConvertingReceiver<()>

Sets the output current in µA.

The output current and output voltage are linked. Changing the output current also changes the output voltage.

pub fn IndustrialAnalogOutBricklet::get_current(&self) → ConvertingReceiver<u16>

Returns the current as set by IndustrialAnalogOutBricklet::set_current.

Advanced Functions

pub fn IndustrialAnalogOutBricklet::set_configuration(&self, voltage_range: u8, current_range: u8) → ConvertingReceiver<()>

Configures the voltage and current range.

Possible voltage ranges are:

  • 0V to 5V
  • 0V to 10V (default)

Possible current ranges are:

  • 4mA to 20mA (default)
  • 0mA to 20mA
  • 0mA to 24mA

The resolution will always be 12 bit. This means, that the precision is higher with a smaller range.

The following constants are available for this function:

  • INDUSTRIAL_ANALOG_OUT_BRICKLET_VOLTAGE_RANGE_0_TO_5V = 0
  • INDUSTRIAL_ANALOG_OUT_BRICKLET_VOLTAGE_RANGE_0_TO_10V = 1
  • INDUSTRIAL_ANALOG_OUT_BRICKLET_CURRENT_RANGE_4_TO_20MA = 0
  • INDUSTRIAL_ANALOG_OUT_BRICKLET_CURRENT_RANGE_0_TO_20MA = 1
  • INDUSTRIAL_ANALOG_OUT_BRICKLET_CURRENT_RANGE_0_TO_24MA = 2
pub fn IndustrialAnalogOutBricklet::get_configuration(&self) → ConvertingReceiver<Configuration>

Returns the configuration as set by IndustrialAnalogOutBricklet::set_configuration.

The following constants are available for this function:

  • INDUSTRIAL_ANALOG_OUT_BRICKLET_VOLTAGE_RANGE_0_TO_5V = 0
  • INDUSTRIAL_ANALOG_OUT_BRICKLET_VOLTAGE_RANGE_0_TO_10V = 1
  • INDUSTRIAL_ANALOG_OUT_BRICKLET_CURRENT_RANGE_4_TO_20MA = 0
  • INDUSTRIAL_ANALOG_OUT_BRICKLET_CURRENT_RANGE_0_TO_20MA = 1
  • INDUSTRIAL_ANALOG_OUT_BRICKLET_CURRENT_RANGE_0_TO_24MA = 2
pub fn IndustrialAnalogOutBricklet::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 IndustrialAnalogOutBricklet::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 IndustrialAnalogOutBricklet::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 IndustrialAnalogOutBricklet::set_response_expected for the list of function ID constants available for this function.

pub fn IndustrialAnalogOutBricklet::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_ANALOG_OUT_BRICKLET_FUNCTION_ENABLE = 1
  • INDUSTRIAL_ANALOG_OUT_BRICKLET_FUNCTION_DISABLE = 2
  • INDUSTRIAL_ANALOG_OUT_BRICKLET_FUNCTION_SET_VOLTAGE = 4
  • INDUSTRIAL_ANALOG_OUT_BRICKLET_FUNCTION_SET_CURRENT = 6
  • INDUSTRIAL_ANALOG_OUT_BRICKLET_FUNCTION_SET_CONFIGURATION = 8
pub fn IndustrialAnalogOutBricklet::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 IndustrialAnalogOutBricklet::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.

Constants

IndustrialAnalogOutBricklet::DEVICE_IDENTIFIER

This constant is used to identify a Industrial Analog Out Bricklet.

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

IndustrialAnalogOutBricklet::DEVICE_DISPLAY_NAME

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