Struct RemoteSwitchV2Bricklet

pub struct RemoteSwitchV2Bricklet { /* private fields */ }

Controls remote mains switches and receives signals from remotes

Implementations

impl RemoteSwitchV2Bricklet

pub const DEVICE_IDENTIFIER: u16 = 289u16

pub const DEVICE_DISPLAY_NAME: &'static str = "Remote Switch Bricklet 2.0"

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

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: RemoteSwitchV2BrickletFunction, ) -> 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: RemoteSwitchV2BrickletFunction, 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_switching_done_callback_receiver( &mut self, ) -> impl Stream<Item = ()>

This receiver is triggered whenever the switching state changes from busy to ready, see get_switching_state.

pub async fn get_remote_status_a_callback_receiver( &mut self, ) -> impl Stream<Item = RemoteStatusAEvent>

Returns the house code, receiver code, switch state (on/off) and number of repeats for remote type A.

The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The receiver is triggered with every repeat.

You have to enable the receiver with [set_remote_configuration]. The number of repeats that you can set in the configuration is the minimum number of repeats that have to be seen before the receiver is triggered for the first time.

pub async fn get_remote_status_b_callback_receiver( &mut self, ) -> impl Stream<Item = RemoteStatusBEvent>

Returns the address (unique per remote), unit (button number), switch state (on/off) and number of repeats for remote type B.

If the remote supports dimming the dim value is used instead of the switch state.

The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The receiver is triggered with every repeat.

You have to enable the receiver with [set_remote_configuration]. The number of repeats that you can set in the configuration is the minimum number of repeats that have to be seen before the receiver is triggered for the first time.

pub async fn get_remote_status_c_callback_receiver( &mut self, ) -> impl Stream<Item = RemoteStatusCEvent>

Returns the system code, device code, switch state (on/off) and number of repeats for remote type C.

The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number. The receiver is triggered with every repeat.

You have to enable the receiver with [set_remote_configuration]. The number of repeats that you can set in the configuration is the minimum number of repeats that have to be seen before the receiver is triggered for the first time.

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

Returns the current switching state. If the current state is busy, the Bricklet is currently sending a code to switch a socket. It will not accept any calls of switch socket functions until the state changes to ready.

How long the switching takes is dependent on the number of repeats, see [set_repeats].

Associated constants:

• REMOTE_SWITCH_V2_BRICKLET_SWITCHING_STATE_READY
• REMOTE_SWITCH_V2_BRICKLET_SWITCHING_STATE_BUSY

pub async fn set_repeats(&mut self, repeats: u8) -> Result<(), TinkerforgeError>

Sets the number of times the code is sent when one of the Switch Socket functions is called. The repeats basically correspond to the amount of time that a button of the remote is pressed.

Some dimmers are controlled by the length of a button pressed, this can be simulated by increasing the repeats.

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

Returns the number of repeats as set by [set_repeats].

pub async fn switch_socket_a( &mut self, house_code: u8, receiver_code: u8, switch_to: u8, ) -> Result<(), TinkerforgeError>

To switch a type A socket you have to give the house code, receiver code and the state (on or off) you want to switch to.

A detailed description on how you can figure out the house and receiver code can be found here.

Associated constants:

• REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_OFF
• REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_ON

pub async fn switch_socket_b( &mut self, address: u32, unit: u8, switch_to: u8, ) -> Result<(), TinkerforgeError>

To switch a type B socket you have to give the address, unit and the state (on or off) you want to switch to.

To switch all devices with the same address use 255 for the unit.

A detailed description on how you can teach a socket the address and unit can be found here.

Associated constants:

• REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_OFF
• REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_ON

pub async fn dim_socket_b( &mut self, address: u32, unit: u8, dim_value: u8, ) -> Result<(), TinkerforgeError>

To control a type B dimmer you have to give the address, unit and the dim value you want to set the dimmer to.

A detailed description on how you can teach a dimmer the address and unit can be found here.

pub async fn switch_socket_c( &mut self, system_code: char, device_code: u8, switch_to: u8, ) -> Result<(), TinkerforgeError>

To switch a type C socket you have to give the system code, device code and the state (on or off) you want to switch to.

A detailed description on how you can figure out the system and device code can be found here.

Associated constants:

• REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_OFF
• REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_ON

pub async fn set_remote_configuration( &mut self, remote_type: u8, minimum_repeats: u16, callback_enabled: bool, ) -> Result<(), TinkerforgeError>

Sets the configuration for receiving data from a remote of type A, B or C.

• Remote Type: A, B or C depending on the type of remote you want to receive.
• Minimum Repeats: The minimum number of repeated data packets until the receiver is triggered (if enabled).
• Receiver Enabled: Enable or disable receiver (see [get_remote_status_a_callback_receiver] receiver, [get_remote_status_b_callback_receiver] receiver and [get_remote_status_c_callback_receiver] receiver).

Associated constants:

• REMOTE_SWITCH_V2_BRICKLET_REMOTE_TYPE_A
• REMOTE_SWITCH_V2_BRICKLET_REMOTE_TYPE_B
• REMOTE_SWITCH_V2_BRICKLET_REMOTE_TYPE_C

pub async fn get_remote_configuration( &mut self, ) -> Result<RemoteConfiguration, TinkerforgeError>

Returns the remote configuration as set by [set_remote_configuration]

Associated constants:

• REMOTE_SWITCH_V2_BRICKLET_REMOTE_TYPE_A
• REMOTE_SWITCH_V2_BRICKLET_REMOTE_TYPE_B
• REMOTE_SWITCH_V2_BRICKLET_REMOTE_TYPE_C

pub async fn get_remote_status_a( &mut self, ) -> Result<RemoteStatusA, TinkerforgeError>

Returns the house code, receiver code, switch state (on/off) and number of repeats for remote type A.

Repeats == 0 means there was no button press. Repeats >= 1 means there was a button press with the specified house/receiver code. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.

Use the receiver to get this data automatically when a button is pressed, see [set_remote_configuration] and [get_remote_status_a_callback_receiver] receiver.

Associated constants:

• REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_OFF
• REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_ON

pub async fn get_remote_status_b( &mut self, ) -> Result<RemoteStatusB, TinkerforgeError>

Returns the address (unique per remote), unit (button number), switch state (on/off) and number of repeats for remote type B.

If the remote supports dimming the dim value is used instead of the switch state.

If repeats=0 there was no button press. If repeats >= 1 there was a button press with the specified address/unit. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.

Use the receiver to get this data automatically when a button is pressed, see [set_remote_configuration] and [get_remote_status_b_callback_receiver] receiver.

Associated constants:

• REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_OFF
• REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_ON

pub async fn get_remote_status_c( &mut self, ) -> Result<RemoteStatusC, TinkerforgeError>

Returns the system code, device code, switch state (on/off) and number of repeats for remote type C.

If repeats=0 there was no button press. If repeats >= 1 there was a button press with the specified system/device code. The repeats are the number of received identical data packets. The longer the button is pressed, the higher the repeat number.

Use the receiver to get this data automatically when a button is pressed, see [set_remote_configuration] and [get_remote_status_c_callback_receiver] receiver.

Associated constants:

• REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_OFF
• REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_ON

pub async fn get_spitfp_error_count( &mut self, ) -> Result<SpitfpErrorCount, TinkerforgeError>

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.

pub async fn set_bootloader_mode( &mut self, mode: u8, ) -> Result<u8, TinkerforgeError>

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:

• REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
• REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT
• REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_STATUS_OK
• REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE
• REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE
• REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT
• REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT
• REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH

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

Returns the current bootloader mode, see [set_bootloader_mode].

Associated constants:

• REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER
• REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE
• REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT
• REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT
• REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT

pub async fn set_write_firmware_pointer( &mut self, pointer: u32, ) -> Result<(), TinkerforgeError>

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.

pub async fn write_firmware( &mut self, data: &[u8; 64], ) -> Result<u8, TinkerforgeError>

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.

pub async fn set_status_led_config( &mut self, config: u8, ) -> Result<(), TinkerforgeError>

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:

• REMOTE_SWITCH_V2_BRICKLET_STATUS_LED_CONFIG_OFF
• REMOTE_SWITCH_V2_BRICKLET_STATUS_LED_CONFIG_ON
• REMOTE_SWITCH_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• REMOTE_SWITCH_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

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

Returns the configuration as set by [set_status_led_config]

Associated constants:

• REMOTE_SWITCH_V2_BRICKLET_STATUS_LED_CONFIG_OFF
• REMOTE_SWITCH_V2_BRICKLET_STATUS_LED_CONFIG_ON
• REMOTE_SWITCH_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT
• REMOTE_SWITCH_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS

pub async fn get_chip_temperature(&mut self) -> Result<i16, TinkerforgeError>

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.

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

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!

pub async fn write_uid(&mut self, uid: u32) -> Result<(), TinkerforgeError>

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.

pub async fn read_uid(&mut self) -> Result<u32, TinkerforgeError>

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

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 RemoteSwitchV2Bricklet

fn clone(&self) -> RemoteSwitchV2Bricklet

Returns a copy of the value.

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

Performs copy-assignment from source.