Rust - Analog Out Bricklet

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

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

use tinkerforge::{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 Analog Out Bricklet.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let ao = AnalogOutBricklet::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
    ao.set_voltage(3300).recv()?;

    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 occurred.

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 AnalogOutBricklet::new(uid: &str, ip_connection: &IpConnection) → AnalogOutBricklet
Parameters:
  • uid – Type: &str
  • ip_connection – Type: &IPConnection
Returns:
  • analog_out – Type: AnalogOutBricklet

Creates a new AnalogOutBricklet object with the unique device ID uid and adds it to the IPConnection ip_connection:

let analog_out = AnalogOutBricklet::new("YOUR_DEVICE_UID", &ip_connection);

This device object can be used after the IP connection has been connected.

pub fn AnalogOutBricklet::set_voltage(&self, voltage: u16) → ConvertingReceiver<()>
Parameters:
  • voltage – Type: u16, Unit: 1 mV, Range: [0 to 5000], Default: 0

Sets the voltage. Calling this function will set the mode to 0 (see AnalogOutBricklet::set_mode).

pub fn AnalogOutBricklet::get_voltage(&self) → ConvertingReceiver<u16>
Returns:
  • voltage – Type: u16, Unit: 1 mV, Range: [0 to 5000], Default: 0

Returns the voltage as set by AnalogOutBricklet::set_voltage.

pub fn AnalogOutBricklet::set_mode(&self, mode: u8) → ConvertingReceiver<()>
Parameters:
  • mode – Type: u8, Range: See constants, Default: 1

Sets the mode of the analog value. Possible modes:

  • 0: Normal Mode (Analog value as set by AnalogOutBricklet::set_voltage is applied)
  • 1: 1k Ohm resistor to ground
  • 2: 100k Ohm resistor to ground
  • 3: 500k Ohm resistor to ground

Setting the mode to 0 will result in an output voltage of 0 V. You can jump to a higher output voltage directly by calling AnalogOutBricklet::set_voltage.

The following constants are available for this function:

For mode:

  • ANALOG_OUT_BRICKLET_MODE_ANALOG_VALUE = 0
  • ANALOG_OUT_BRICKLET_MODE_1K_TO_GROUND = 1
  • ANALOG_OUT_BRICKLET_MODE_100K_TO_GROUND = 2
  • ANALOG_OUT_BRICKLET_MODE_500K_TO_GROUND = 3
pub fn AnalogOutBricklet::get_mode(&self) → ConvertingReceiver<u8>
Returns:
  • mode – Type: u8, Range: See constants, Default: 1

Returns the mode as set by AnalogOutBricklet::set_mode.

The following constants are available for this function:

For mode:

  • ANALOG_OUT_BRICKLET_MODE_ANALOG_VALUE = 0
  • ANALOG_OUT_BRICKLET_MODE_1K_TO_GROUND = 1
  • ANALOG_OUT_BRICKLET_MODE_100K_TO_GROUND = 2
  • ANALOG_OUT_BRICKLET_MODE_500K_TO_GROUND = 3

Advanced Functions

pub fn AnalogOutBricklet::get_identity(&self) → ConvertingReceiver<Identity>
Return Object:
  • uid – Type: String, Length: up to 8
  • connected_uid – Type: String, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'z']
  • hardware_version – Type: [u8; 3]
    • 0: major – Type: u8, Range: [0 to 255]
    • 1: minor – Type: u8, Range: [0 to 255]
    • 2: revision – Type: u8, Range: [0 to 255]
  • firmware_version – Type: [u8; 3]
    • 0: major – Type: u8, Range: [0 to 255]
    • 1: minor – Type: u8, Range: [0 to 255]
    • 2: revision – Type: u8, Range: [0 to 255]
  • device_identifier – Type: u16, Range: [0 to 216 - 1]

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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Virtual Functions

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

pub fn AnalogOutBricklet::get_api_version(&self) → [u8; 3]
Return Object:
  • api_version – Type: [u8; 3]
    • 0: major – Type: u8, Range: [0 to 255]
    • 1: minor – Type: u8, Range: [0 to 255]
    • 2: revision – Type: u8, Range: [0 to 255]

Returns the version of the API definition 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 AnalogOutBricklet::get_response_expected(&mut self, function_id: u8) → bool
Parameters:
  • function_id – Type: u8, Range: See constants
Returns:
  • response_expected – Type: 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 AnalogOutBricklet::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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

  • ANALOG_OUT_BRICKLET_FUNCTION_SET_VOLTAGE = 1
  • ANALOG_OUT_BRICKLET_FUNCTION_SET_MODE = 3
pub fn AnalogOutBricklet::set_response_expected(&mut self, function_id: u8, response_expected: bool) → ()
Parameters:
  • function_id – Type: u8, Range: See constants
  • response_expected – Type: 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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

  • ANALOG_OUT_BRICKLET_FUNCTION_SET_VOLTAGE = 1
  • ANALOG_OUT_BRICKLET_FUNCTION_SET_MODE = 3
pub fn AnalogOutBricklet::set_response_expected_all(&mut self, response_expected: bool) → ()
Parameters:
  • response_expected – Type: bool

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Constants

pub const AnalogOutBricklet::DEVICE_IDENTIFIER

This constant is used to identify a Analog Out Bricklet.

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

pub const AnalogOutBricklet::DEVICE_DISPLAY_NAME

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