Rust - Industrial Quad Relay Bricklet

This is the description of the Rust API bindings for the Industrial Quad Relay Bricklet. General information and technical specifications for the Industrial Quad Relay 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
26
27
28
29
30
31
32
use std::{error::Error, io, thread, time::Duration};
use tinkerforge::{industrial_quad_relay_bricklet::*, ip_connection::IpConnection};

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

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

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

    // Turn relays alternating on/off 10 times with 100 ms delay
    for _i in 0..10 {
        thread::sleep(Duration::from_millis(100));
        iqr.set_value(1 << 0);
        thread::sleep(Duration::from_millis(100));
        iqr.set_value(1 << 1);
        thread::sleep(Duration::from_millis(100));
        iqr.set_value(1 << 2);
        thread::sleep(Duration::from_millis(100));
        iqr.set_value(1 << 3);
    }

    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 IndustrialQuadRelayBricklet::new(uid: &str, ip_connection: &IpConnection) → IndustrialQuadRelayBricklet

Creates a new IndustrialQuadRelayBricklet 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 IndustrialQuadRelayBricklet::set_value(&self, value_mask: u16) → ConvertingReceiver<()>

Sets the output value with a bitmask (16bit). A 1 in the bitmask means relay closed and a 0 means relay open.

For example: The value 3 or 0b0011 will close the relay of pins 0-1 and open the other pins.

If no groups are used (see IndustrialQuadRelayBricklet::set_group), the pins correspond to the markings on the Industrial Quad Relay Bricklet.

If groups are used, the pins correspond to the element in the group. Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3 pins 8-11 and element 4 pins 12-15.

All running monoflop timers will be aborted if this function is called.

pub fn IndustrialQuadRelayBricklet::get_value(&self) → ConvertingReceiver<u16>

Returns the bitmask as set by IndustrialQuadRelayBricklet::set_value.

Advanced Functions

pub fn IndustrialQuadRelayBricklet::set_monoflop(&self, selection_mask: u16, value_mask: u16, time: u32) → ConvertingReceiver<()>

Configures a monoflop of the pins specified by the first parameter bitmask.

The second parameter is a bitmask with the desired value of the specified pins. A 1 in the bitmask means relay closed and a 0 means relay open.

The third parameter indicates the time (in ms) that the pins should hold the value.

If this function is called with the parameters (9, 1, 1500) or (0b1001, 0b0001, 1500): Pin 0 will close and pin 3 will open. In 1.5s pin 0 will open and pin 3 will close again.

A monoflop can be used as a fail-safe mechanism. For example: Lets assume you have a RS485 bus and a Quad Relay Bricklet connected to one of the slave stacks. You can now call this function every second, with a time parameter of two seconds and pin 0 closed. Pin 0 will be closed all the time. If now the RS485 connection is lost, then pin 0 will be opened in at most two seconds.

pub fn IndustrialQuadRelayBricklet::get_monoflop(&self, pin: u8) → ConvertingReceiver<Monoflop>

Returns (for the given pin) the current value and the time as set by IndustrialQuadRelayBricklet::set_monoflop as well as the remaining time until the value flips.

If the timer is not running currently, the remaining time will be returned as 0.

pub fn IndustrialQuadRelayBricklet::set_group(&self, group: [char; 4]) → ConvertingReceiver<()>

Sets a group of Quad Relay Bricklets that should work together. You can find Bricklets that can be grouped together with IndustrialQuadRelayBricklet::get_available_for_group.

The group consists of 4 elements. Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3 pins 8-11 and element 4 pins 12-15.

Each element can either be one of the ports ('a' to 'd') or 'n' if it should not be used.

For example: If you have two Quad Relay Bricklets connected to port A and port B respectively, you could call with ['a', 'b', 'n', 'n'].

Now the pins on the Quad Relay on port A are assigned to 0-3 and the pins on the Quad Relay on port B are assigned to 4-7. It is now possible to call IndustrialQuadRelayBricklet::set_value and control two Bricklets at the same time.

pub fn IndustrialQuadRelayBricklet::get_group(&self) → ConvertingReceiver<[char; 4]>

Returns the group as set by IndustrialQuadRelayBricklet::set_group

pub fn IndustrialQuadRelayBricklet::get_available_for_group(&self) → ConvertingReceiver<u8>

Returns a bitmask of ports that are available for grouping. For example the value 5 or 0b0101 means: Port A and port C are connected to Bricklets that can be grouped together.

pub fn IndustrialQuadRelayBricklet::set_selected_values(&self, selection_mask: u16, value_mask: u16) → ConvertingReceiver<()>

Sets the output value with a bitmask, according to the selection mask. The bitmask is 16 bit long, true refers to a closed relay and false refers to an open relay.

For example: The values (3, 1) or (0b0011, 0b0001) will close the relay of pin 0, open the relay of pin 1 and leave the others untouched.

If no groups are used (see IndustrialQuadRelayBricklet::set_group), the pins correspond to the markings on the Industrial Quad Relay Bricklet.

If groups are used, the pins correspond to the element in the group. Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3 pins 8-11 and element 4 pins 12-15.

Running monoflop timers for the selected relays will be aborted if this function is called.

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

pub fn IndustrialQuadRelayBricklet::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_QUAD_RELAY_BRICKLET_FUNCTION_SET_VALUE = 1
  • INDUSTRIAL_QUAD_RELAY_BRICKLET_FUNCTION_SET_MONOFLOP = 3
  • INDUSTRIAL_QUAD_RELAY_BRICKLET_FUNCTION_SET_GROUP = 5
  • INDUSTRIAL_QUAD_RELAY_BRICKLET_FUNCTION_SET_SELECTED_VALUES = 9
pub fn IndustrialQuadRelayBricklet::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 IndustrialQuadRelayBricklet::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.

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 IndustrialQuadRelayBricklet::get_monoflop_done_callback_receiver(&self) → ConvertingCallbackReceiver<MonoflopDoneEvent>

Receivers created with this function receive Monoflop Done events.

This callback is triggered whenever a monoflop timer reaches 0. The members of the received struct contain the involved pins and the current value of the pins (the value after the monoflop).

Constants

IndustrialQuadRelayBricklet::DEVICE_IDENTIFIER

This constant is used to identify a Industrial Quad Relay Bricklet.

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

IndustrialQuadRelayBricklet::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Industrial Quad Relay Bricklet.