pub struct IndustrialQuadRelayBricklet { /* private fields */ }
Expand description
4 galvanically isolated solid state relays
Implementations
sourceimpl IndustrialQuadRelayBricklet
impl IndustrialQuadRelayBricklet
pub const DEVICE_IDENTIFIER: u16 = 225u16
pub const DEVICE_DISPLAY_NAME: &'static str = "Industrial Quad Relay Bricklet"
sourcepub fn new(
uid: &str,
ip_connection: &IpConnection
) -> IndustrialQuadRelayBricklet
pub fn new(
uid: &str,
ip_connection: &IpConnection
) -> IndustrialQuadRelayBricklet
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: IndustrialQuadRelayBrickletFunction
) -> Result<bool, GetResponseExpectedError>
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 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: IndustrialQuadRelayBrickletFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
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 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 parameters contain the involved pins and the current value of the pins (the value after the monoflop).
sourcepub fn set_value(&self, value_mask: u16) -> ConvertingReceiver<()>
pub fn 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 Set Group
), the pins correspond to the
markings on the 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.
sourcepub fn get_value(&self) -> ConvertingReceiver<u16>
pub fn get_value(&self) -> ConvertingReceiver<u16>
Returns the bitmask as set by Set Value
.
sourcepub fn set_monoflop(
&self,
selection_mask: u16,
value_mask: u16,
time: u32
) -> ConvertingReceiver<()>
pub fn 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.
sourcepub fn get_monoflop(&self, pin: u8) -> ConvertingReceiver<Monoflop>
pub fn get_monoflop(&self, pin: u8) -> ConvertingReceiver<Monoflop>
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.
sourcepub fn set_group(&self, group: [char; 4]) -> ConvertingReceiver<()>
pub fn 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 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.
sourcepub fn get_group(&self) -> ConvertingReceiver<[char; 4]>
pub fn get_group(&self) -> ConvertingReceiver<[char; 4]>
Returns the group as set by Set Group
sourcepub fn get_available_for_group(&self) -> ConvertingReceiver<u8>
pub fn 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.
sourcepub fn set_selected_values(
&self,
selection_mask: u16,
value_mask: u16
) -> ConvertingReceiver<()>
pub fn 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 Set Group
), the pins correspond to the
markings on the 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.
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 IndustrialQuadRelayBricklet
impl Clone for IndustrialQuadRelayBricklet
sourcefn clone(&self) -> IndustrialQuadRelayBricklet
fn clone(&self) -> IndustrialQuadRelayBricklet
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more