pub struct IndustrialDualRelayBricklet { /* private fields */ }
Expand description
Two relays to switch AC/DC devices
Implementations§
source§impl IndustrialDualRelayBricklet
impl IndustrialDualRelayBricklet
pub const DEVICE_IDENTIFIER: u16 = 284u16
pub const DEVICE_DISPLAY_NAME: &'static str = "Industrial Dual Relay Bricklet"
sourcepub fn new<T: GetRequestSender>(
uid: &str,
req_sender: T
) -> IndustrialDualRelayBricklet
pub fn new<T: GetRequestSender>( uid: &str, req_sender: T ) -> IndustrialDualRelayBricklet
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: IndustrialDualRelayBrickletFunction
) -> Result<bool, GetResponseExpectedError>
pub fn get_response_expected( &mut self, fun: IndustrialDualRelayBrickletFunction ) -> 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.
sourcepub fn set_response_expected(
&mut self,
fun: IndustrialDualRelayBrickletFunction,
response_expected: bool
) -> Result<(), SetResponseExpectedError>
pub fn set_response_expected( &mut self, fun: IndustrialDualRelayBrickletFunction, 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.
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_api_version(&self) -> [u8; 3]
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.
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 relay and the current state of the relay (the state after the monoflop).
sourcepub fn set_value(
&self,
channel0: bool,
channel1: bool
) -> ConvertingReceiver<()>
pub fn set_value( &self, channel0: bool, channel1: bool ) -> ConvertingReceiver<()>
Sets the state of the relays, true means on and false means off. For example: (true, false) turns relay 0 on and relay 1 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_value
] or you
can use [set_selected_value
].
All running monoflop timers will be aborted if this function is called.
sourcepub fn get_value(&self) -> ConvertingReceiver<Value>
pub fn get_value(&self) -> ConvertingReceiver<Value>
Returns the state of the relays, true means on and false means off.
sourcepub fn set_monoflop(
&self,
channel: u8,
value: bool,
time: u32
) -> ConvertingReceiver<()>
pub fn set_monoflop( &self, channel: u8, value: bool, time: u32 ) -> ConvertingReceiver<()>
The first parameter can be 0 or 1 (relay 0 or relay 1). The second parameter is the desired state of the relay (true means on and false means off). The third parameter indicates the time 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 Industrial 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, channel: u8) -> ConvertingReceiver<Monoflop>
pub fn get_monoflop(&self, channel: 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_value(
&self,
channel: u8,
value: bool
) -> ConvertingReceiver<()>
pub fn set_selected_value( &self, channel: u8, value: bool ) -> ConvertingReceiver<()>
Sets the state of the selected relay, true means on and false means off.
A running monoflop timer for the selected relay will be aborted if this function is called.
The other relay remains untouched.
sourcepub fn get_spitfp_error_count(&self) -> ConvertingReceiver<SpitfpErrorCount>
pub fn get_spitfp_error_count(&self) -> ConvertingReceiver<SpitfpErrorCount>
Returns the error count for the communication between Brick and Bricklet.
The errors are divided into
- ACK checksum errors,
- message checksum errors,
- framing errors and
- overflow errors.
The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.
sourcepub fn set_bootloader_mode(&self, mode: u8) -> ConvertingReceiver<u8>
pub fn set_bootloader_mode(&self, mode: u8) -> ConvertingReceiver<u8>
Sets the bootloader mode and returns the status after the requested mode change was instigated.
You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.
This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
Associated constants:
- INDUSTRIAL_DUAL_RELAY_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
- INDUSTRIAL_DUAL_RELAY_BRICKLET_BOOTLOADER_MODE_FIRMWARE
- INDUSTRIAL_DUAL_RELAY_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- INDUSTRIAL_DUAL_RELAY_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- INDUSTRIAL_DUAL_RELAY_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
- INDUSTRIAL_DUAL_RELAY_BRICKLET_BOOTLOADER_STATUS_OK
- INDUSTRIAL_DUAL_RELAY_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
- INDUSTRIAL_DUAL_RELAY_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
- INDUSTRIAL_DUAL_RELAY_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
- INDUSTRIAL_DUAL_RELAY_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
- INDUSTRIAL_DUAL_RELAY_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH
sourcepub fn get_bootloader_mode(&self) -> ConvertingReceiver<u8>
pub fn get_bootloader_mode(&self) -> ConvertingReceiver<u8>
Returns the current bootloader mode, see [set_bootloader_mode
].
Associated constants:
- INDUSTRIAL_DUAL_RELAY_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
- INDUSTRIAL_DUAL_RELAY_BRICKLET_BOOTLOADER_MODE_FIRMWARE
- INDUSTRIAL_DUAL_RELAY_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
- INDUSTRIAL_DUAL_RELAY_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
- INDUSTRIAL_DUAL_RELAY_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
sourcepub fn set_write_firmware_pointer(&self, pointer: u32) -> ConvertingReceiver<()>
pub fn set_write_firmware_pointer(&self, pointer: u32) -> ConvertingReceiver<()>
Sets the firmware pointer for [write_firmware
]. The pointer has
to be increased by chunks of size 64. The data is written to flash
every 4 chunks (which equals to one page of size 256).
This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
sourcepub fn write_firmware(&self, data: [u8; 64]) -> ConvertingReceiver<u8>
pub fn write_firmware(&self, data: [u8; 64]) -> ConvertingReceiver<u8>
Writes 64 Bytes of firmware at the position as written by
[set_write_firmware_pointer
] before. The firmware is written
to flash every 4 chunks.
You can only write firmware in bootloader mode.
This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.
sourcepub fn set_status_led_config(&self, config: u8) -> ConvertingReceiver<()>
pub fn set_status_led_config(&self, config: u8) -> ConvertingReceiver<()>
Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.
You can also turn the LED permanently on/off or show a heartbeat.
If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.
Associated constants:
- INDUSTRIAL_DUAL_RELAY_BRICKLET_STATUS_LED_CONFIG_OFF
- INDUSTRIAL_DUAL_RELAY_BRICKLET_STATUS_LED_CONFIG_ON
- INDUSTRIAL_DUAL_RELAY_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
- INDUSTRIAL_DUAL_RELAY_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS
sourcepub fn get_status_led_config(&self) -> ConvertingReceiver<u8>
pub fn get_status_led_config(&self) -> ConvertingReceiver<u8>
Returns the configuration as set by [set_status_led_config
]
Associated constants:
- INDUSTRIAL_DUAL_RELAY_BRICKLET_STATUS_LED_CONFIG_OFF
- INDUSTRIAL_DUAL_RELAY_BRICKLET_STATUS_LED_CONFIG_ON
- INDUSTRIAL_DUAL_RELAY_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
- INDUSTRIAL_DUAL_RELAY_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS
sourcepub fn get_chip_temperature(&self) -> ConvertingReceiver<i16>
pub fn get_chip_temperature(&self) -> ConvertingReceiver<i16>
Returns the temperature as measured inside the microcontroller. The value returned is not the ambient temperature!
The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.
sourcepub fn reset(&self) -> ConvertingReceiver<()>
pub fn reset(&self) -> ConvertingReceiver<()>
Calling this function will reset the Bricklet. All configurations will be lost.
After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!
sourcepub fn write_uid(&self, uid: u32) -> ConvertingReceiver<()>
pub fn write_uid(&self, uid: u32) -> ConvertingReceiver<()>
Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.
We recommend that you use Brick Viewer to change the UID.
sourcepub fn read_uid(&self) -> ConvertingReceiver<u32>
pub fn read_uid(&self) -> ConvertingReceiver<u32>
Returns the current UID as an integer. Encode as Base58 to get the usual string version.
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’, ‘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§
source§impl Clone for IndustrialDualRelayBricklet
impl Clone for IndustrialDualRelayBricklet
source§fn clone(&self) -> IndustrialDualRelayBricklet
fn clone(&self) -> IndustrialDualRelayBricklet
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more