Struct SolidStateRelayBricklet

pub struct SolidStateRelayBricklet { /* private fields */ }

Controls AC and DC Solid State Relays

Implementations

impl SolidStateRelayBricklet

pub const DEVICE_IDENTIFIER: u16 = 244u16

pub const DEVICE_DISPLAY_NAME: &'static str = "Solid State Relay Bricklet"

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

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: SolidStateRelayBrickletFunction, ) -> 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: SolidStateRelayBrickletFunction, 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 = bool>

This receiver is triggered whenever the monoflop timer reaches 0. The parameter is the current state of the relay (the state after the monoflop).

pub async fn set_state(&mut self, state: bool) -> Result<(), TinkerforgeError>

Sets the state of the relays true means on and false means off.

A running monoflop timer will be aborted if this function is called.

pub async fn get_state(&mut self) -> Result<bool, TinkerforgeError>

Returns the state of the relay, true means on and false means off.

pub async fn set_monoflop( &mut self, state: bool, time: u32, ) -> Result<(), TinkerforgeError>

The first parameter is the desired state of the relay (true means on and false means off). The second parameter indicates the time that the relay should hold the state.

If this function is called with the parameters (true, 1500): The relay will turn on and in 1.5s it will turn off again.

A monoflop can be used as a failsafe mechanism. For example: Lets assume you have a RS485 bus and a Solid State Relay Bricklet connected to one of the slave stacks. You can now call this function every second, with a time parameter of two seconds. The relay will be on all the time. If now the RS485 connection is lost, the relay will turn off in at most two seconds.

pub async fn get_monoflop(&mut self) -> Result<Monoflop, TinkerforgeError>

Returns the current state and the time as set by [set_monoflop] as well as the remaining time until the state flips.

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

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 SolidStateRelayBricklet

fn clone(&self) -> SolidStateRelayBricklet

Returns a copy of the value.

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

Performs copy-assignment from source.