Struct IndustrialQuadRelayBricklet

pub struct IndustrialQuadRelayBricklet { /* private fields */ }

4 galvanically isolated solid state relays

Implementations

impl IndustrialQuadRelayBricklet

pub const DEVICE_IDENTIFIER: u16 = 225u16

pub const DEVICE_DISPLAY_NAME: &'static str = "Industrial Quad Relay Bricklet"

pub fn new( uid: Uid, connection: AsyncIpConnection, ) -> IndustrialQuadRelayBricklet

Creates an object with the unique device ID uid. This object can then be used after the IP Connection ip_connection is connected.

pub fn get_response_expected( &mut self, fun: IndustrialQuadRelayBrickletFunction, ) -> Result<bool, GetResponseExpectedError>

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

See set_response_expected for the list of function ID constants available for this function.

pub fn set_response_expected( &mut self, fun: IndustrialQuadRelayBrickletFunction, response_expected: bool, ) -> Result<(), SetResponseExpectedError>

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.

pub fn 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 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 async fn get_monoflop_done_callback_receiver( &mut self, ) -> impl Stream<Item = MonoflopDoneEvent>

This receiver is triggered whenever a monoflop timer reaches 0. The parameters contain the involved pins and the current value of the pins (the value after the monoflop).

pub async fn set_value( &mut self, value_mask: u16, ) -> Result<(), TinkerforgeError>

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 [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 async fn get_value(&mut self) -> Result<u16, TinkerforgeError>

Returns the bitmask as set by [set_value].

pub async fn set_monoflop( &mut self, selection_mask: u16, value_mask: u16, time: u32, ) -> Result<(), TinkerforgeError>

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 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 async fn get_monoflop( &mut self, pin: u8, ) -> Result<Monoflop, TinkerforgeError>

Returns (for the given pin) the current value and the time as set by [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 async fn set_group( &mut self, group: &[char; 4], ) -> Result<(), TinkerforgeError>

Sets a group of Quad Relay Bricklets that should work together. You can find Bricklets that can be grouped together with [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 [set_value] and control two Bricklets at the same time.

pub async fn get_group(&mut self) -> Result<Box<[char; 4]>, TinkerforgeError>

Returns the group as set by [set_group]

pub async fn get_available_for_group(&mut self) -> Result<u8, TinkerforgeError>

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 async fn set_selected_values( &mut self, selection_mask: u16, value_mask: u16, ) -> Result<(), TinkerforgeError>

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 [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 async fn get_identity(&mut self) -> Result<Identity, TinkerforgeError>

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

Trait Implementations

impl Clone for IndustrialQuadRelayBricklet

fn clone(&self) -> IndustrialQuadRelayBricklet

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.