pub struct DualRelayBricklet { /* private fields */ }
Expand description
Two relays to switch AC/DC devices
Implementations
sourceimpl DualRelayBricklet
impl DualRelayBricklet
pub const DEVICE_IDENTIFIER: u16 = 26u16
pub const DEVICE_DISPLAY_NAME: &'static str = "Dual Relay Bricklet"
sourcepub fn new(uid: &str, ip_connection: &IpConnection) -> DualRelayBricklet
pub fn new(uid: &str, ip_connection: &IpConnection) -> DualRelayBricklet
Creates an object with the unique device ID uid
. This object can then be used after the IP Connection ip_connection
is connected.
sourcepub fn get_response_expected(
&mut self,
fun: DualRelayBrickletFunction
) -> Result<bool, GetResponseExpectedError>
pub fn get_response_expected(
&mut self,
fun: DualRelayBrickletFunction
) -> 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 send 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.
sourcepub fn set_response_expected(
&mut self,
fun: DualRelayBrickletFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
pub fn set_response_expected(
&mut self,
fun: DualRelayBrickletFunction,
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 send and errors are silently ignored, because they cannot be detected.
sourcepub fn set_response_expected_all(&mut self, response_expected: bool)
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.
sourcepub fn get_monoflop_done_callback_receiver(
&self
) -> ConvertingCallbackReceiver<MonoflopDoneEvent>
pub fn get_monoflop_done_callback_receiver(
&self
) -> ConvertingCallbackReceiver<MonoflopDoneEvent>
This receiver is triggered whenever a monoflop timer reaches 0. The parameter contain the relay (1 or 2) and the current state of the relay (the state after the monoflop).
sourcepub fn set_state(&self, relay1: bool, relay2: bool) -> ConvertingReceiver<()>
pub fn set_state(&self, relay1: bool, relay2: bool) -> ConvertingReceiver<()>
Sets the state of the relays, true means on and false means off. For example: (true, false) turns relay 1 on and relay 2 off.
If you just want to set one of the relays and don’t know the current state
of the other relay, you can get the state with get_state
or you
can use set_selected_state
.
Running monoflop timers will be overwritten if this function is called.
The default value is (false, false).
sourcepub fn get_state(&self) -> ConvertingReceiver<State>
pub fn get_state(&self) -> ConvertingReceiver<State>
Returns the state of the relays, true means on and false means off.
sourcepub fn set_monoflop(
&self,
relay: u8,
state: bool,
time: u32
) -> ConvertingReceiver<()>
pub fn set_monoflop(
&self,
relay: u8,
state: bool,
time: u32
) -> ConvertingReceiver<()>
The first parameter can be 1 or 2 (relay 1 or relay 2). The second parameter is the desired state of the relay (true means on and false means off). The third parameter indicates the time (in ms) that the relay should hold the state.
If this function is called with the parameters (1, true, 1500): Relay 1 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 Dual 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.
sourcepub fn get_monoflop(&self, relay: u8) -> ConvertingReceiver<Monoflop>
pub fn get_monoflop(&self, relay: u8) -> ConvertingReceiver<Monoflop>
Returns (for the given relay) 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.
sourcepub fn set_selected_state(&self, relay: u8, state: bool) -> ConvertingReceiver<()>
pub fn set_selected_state(&self, relay: u8, state: bool) -> ConvertingReceiver<()>
Sets the state of the selected relay (1 or 2), true means on and false means off.
The other relay remains untouched.
sourcepub fn get_identity(&self) -> ConvertingReceiver<Identity>
pub fn 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. |device_identifier_constant|
Trait Implementations
sourceimpl Clone for DualRelayBricklet
impl Clone for DualRelayBricklet
sourcefn clone(&self) -> DualRelayBricklet
fn clone(&self) -> DualRelayBricklet
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more