Struct RemoteSwitchBricklet

pub struct RemoteSwitchBricklet { /* private fields */ }

Controls remote mains switches

Implementations

impl RemoteSwitchBricklet

pub const DEVICE_IDENTIFIER: u16 = 235u16

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

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

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: RemoteSwitchBrickletFunction, ) -> 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: RemoteSwitchBrickletFunction, 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 switch_socket( &mut self, house_code: u8, receiver_code: u8, switch_to: u8, ) -> Result<(), TinkerforgeError>

This function is deprecated, use [switch_socket_a] instead.

Associated constants:

• REMOTE_SWITCH_BRICKLET_SWITCH_TO_OFF
• REMOTE_SWITCH_BRICKLET_SWITCH_TO_ON

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 requests to switch sockets 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_BRICKLET_SWITCHING_STATE_READY
• REMOTE_SWITCH_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.

.. versionadded:: 2.0.1$nbsp;(Plugin)

Associated constants:

• REMOTE_SWITCH_BRICKLET_SWITCH_TO_OFF
• REMOTE_SWITCH_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.

.. versionadded:: 2.0.1$nbsp;(Plugin)

Associated constants:

• REMOTE_SWITCH_BRICKLET_SWITCH_TO_OFF
• REMOTE_SWITCH_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.

.. versionadded:: 2.0.1$nbsp;(Plugin)

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.

.. versionadded:: 2.0.1$nbsp;(Plugin)

Associated constants:

• REMOTE_SWITCH_BRICKLET_SWITCH_TO_OFF
• REMOTE_SWITCH_BRICKLET_SWITCH_TO_ON

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 RemoteSwitchBricklet

fn clone(&self) -> RemoteSwitchBricklet

Returns a copy of the value.

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

Performs copy-assignment from source.