Rust - Remote Switch Bricklet

This is the description of the Rust API bindings for the Remote Switch Bricklet. General information and technical specifications for the Remote Switch Bricklet are summarized in its hardware description.

An installation guide for the Rust API bindings is part of their general description. Additional documentation can be found on docs.rs.

Examples

The example code below is Public Domain (CC0 1.0).

Switch Socket

Download (example_switch_socket.rs)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
use std::{error::Error, io};

use tinkerforge::{ip_connection::IpConnection, remote_switch_bricklet::*};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Remote Switch Bricklet.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let rs = RemoteSwitchBricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    // Switch on a type A socket with house code 17 and receiver code 1.
    // House code 17 is 10001 in binary (least-significant bit first)
    // and means that the DIP switches 1 and 5 are on and 2-4 are off.
    // Receiver code 1 is 10000 in binary (least-significant bit first)
    // and means that the DIP switch A is on and B-E are off.
    rs.switch_socket_a(17, 1, REMOTE_SWITCH_BRICKLET_SWITCH_TO_ON).recv()?;

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

API

To allow non-blocking usage, nearly every function of the Rust bindings returns a wrapper around a mpsc::Receiver. To block until the function has finished and get your result, call one of the receiver's recv variants. Those return either the result sent by the device, or any error occurred.

Functions returning a result directly will block until the device has finished processing the request.

All functions listed below are thread-safe, those which return a receiver are lock-free.

Basic Functions

pub fn RemoteSwitchBricklet::new(uid: &str, ip_connection: &IpConnection) → RemoteSwitchBricklet
Parameters:
  • uid – Type: &str
  • ip_connection – Type: &IPConnection
Returns:
  • remote_switch – Type: RemoteSwitchBricklet

Creates a new RemoteSwitchBricklet object with the unique device ID uid and adds it to the IPConnection ip_connection:

let remote_switch = RemoteSwitchBricklet::new("YOUR_DEVICE_UID", &ip_connection);

This device object can be used after the IP connection has been connected.

pub fn RemoteSwitchBricklet::switch_socket(&self, house_code: u8, receiver_code: u8, switch_to: u8) → ConvertingReceiver<()>
Parameters:
  • house_code – Type: u8, Range: [0 to 31]
  • receiver_code – Type: u8, Range: [0 to 31]
  • switch_to – Type: u8, Range: See constants

This function is deprecated, use RemoteSwitchBricklet::switch_socket_a instead.

The following constants are available for this function:

For switch_to:

  • REMOTE_SWITCH_BRICKLET_SWITCH_TO_OFF = 0
  • REMOTE_SWITCH_BRICKLET_SWITCH_TO_ON = 1
pub fn RemoteSwitchBricklet::get_switching_state(&self) → ConvertingReceiver<u8>
Returns:
  • state – Type: u8, Range: See constants

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 RemoteSwitchBricklet::set_repeats.

The following constants are available for this function:

For state:

  • REMOTE_SWITCH_BRICKLET_SWITCHING_STATE_READY = 0
  • REMOTE_SWITCH_BRICKLET_SWITCHING_STATE_BUSY = 1
pub fn RemoteSwitchBricklet::switch_socket_a(&self, house_code: u8, receiver_code: u8, switch_to: u8) → ConvertingReceiver<()>
Parameters:
  • house_code – Type: u8, Range: [0 to 31]
  • receiver_code – Type: u8, Range: [0 to 31]
  • switch_to – Type: u8, Range: See constants

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.

The following constants are available for this function:

For switch_to:

  • REMOTE_SWITCH_BRICKLET_SWITCH_TO_OFF = 0
  • REMOTE_SWITCH_BRICKLET_SWITCH_TO_ON = 1

New in version 2.0.1 (Plugin).

pub fn RemoteSwitchBricklet::switch_socket_b(&self, address: u32, unit: u8, switch_to: u8) → ConvertingReceiver<()>
Parameters:
  • address – Type: u32, Range: [0 to 226 - 1]
  • unit – Type: u8, Range: [0 to 15, 255]
  • switch_to – Type: u8, Range: See constants

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.

The following constants are available for this function:

For switch_to:

  • REMOTE_SWITCH_BRICKLET_SWITCH_TO_OFF = 0
  • REMOTE_SWITCH_BRICKLET_SWITCH_TO_ON = 1

New in version 2.0.1 (Plugin).

pub fn RemoteSwitchBricklet::dim_socket_b(&self, address: u32, unit: u8, dim_value: u8) → ConvertingReceiver<()>
Parameters:
  • address – Type: u32, Range: [0 to 226 - 1]
  • unit – Type: u8, Range: [0 to 15, 255]
  • dim_value – Type: u8, Range: [0 to 255]

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.

New in version 2.0.1 (Plugin).

pub fn RemoteSwitchBricklet::switch_socket_c(&self, system_code: char, device_code: u8, switch_to: u8) → ConvertingReceiver<()>
Parameters:
  • system_code – Type: char, Range: ['A' to 'P']
  • device_code – Type: u8, Range: [1 to 16]
  • switch_to – Type: u8, Range: See constants

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.

The following constants are available for this function:

For switch_to:

  • REMOTE_SWITCH_BRICKLET_SWITCH_TO_OFF = 0
  • REMOTE_SWITCH_BRICKLET_SWITCH_TO_ON = 1

New in version 2.0.1 (Plugin).

Advanced Functions

pub fn RemoteSwitchBricklet::set_repeats(&self, repeats: u8) → ConvertingReceiver<()>
Parameters:
  • repeats – Type: u8, Range: [0 to 255], Default: 5

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 fn RemoteSwitchBricklet::get_repeats(&self) → ConvertingReceiver<u8>
Returns:
  • repeats – Type: u8, Range: [0 to 255], Default: 5

Returns the number of repeats as set by RemoteSwitchBricklet::set_repeats.

pub fn RemoteSwitchBricklet::get_identity(&self) → ConvertingReceiver<Identity>
Return Object:
  • uid – Type: String, Length: up to 8
  • connected_uid – Type: String, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'i', 'z']
  • hardware_version – Type: [u8; 3]
    • 0: major – Type: u8, Range: [0 to 255]
    • 1: minor – Type: u8, Range: [0 to 255]
    • 2: revision – Type: u8, Range: [0 to 255]
  • firmware_version – Type: [u8; 3]
    • 0: major – Type: u8, Range: [0 to 255]
    • 1: minor – Type: u8, Range: [0 to 255]
    • 2: revision – Type: u8, Range: [0 to 255]
  • device_identifier – Type: u16, Range: [0 to 216 - 1]

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). The Raspberry Pi HAT (Zero) Brick is always at position 'i' and the Bricklet connected to an Isolator Bricklet is always as position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding get_*_callback_receiver function, which returns a receiver for callback events.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

pub fn RemoteSwitchBricklet::get_switching_done_callback_receiver(&self) → ConvertingCallbackReceiver<()>

Receivers created with this function receive Switching Done events.

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

Virtual Functions

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

pub fn RemoteSwitchBricklet::get_api_version(&self) → [u8; 3]
Return Object:
  • api_version – Type: [u8; 3]
    • 0: major – Type: u8, Range: [0 to 255]
    • 1: minor – Type: u8, Range: [0 to 255]
    • 2: revision – Type: u8, Range: [0 to 255]

Returns the version of the API definition 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 fn RemoteSwitchBricklet::get_response_expected(&mut self, function_id: u8) → bool
Parameters:
  • function_id – Type: u8, Range: See constants
Returns:
  • response_expected – Type: bool

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 RemoteSwitchBricklet::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.

The following constants are available for this function:

For function_id:

  • REMOTE_SWITCH_BRICKLET_FUNCTION_SWITCH_SOCKET = 1
  • REMOTE_SWITCH_BRICKLET_FUNCTION_SET_REPEATS = 4
  • REMOTE_SWITCH_BRICKLET_FUNCTION_SWITCH_SOCKET_A = 6
  • REMOTE_SWITCH_BRICKLET_FUNCTION_SWITCH_SOCKET_B = 7
  • REMOTE_SWITCH_BRICKLET_FUNCTION_DIM_SOCKET_B = 8
  • REMOTE_SWITCH_BRICKLET_FUNCTION_SWITCH_SOCKET_C = 9
pub fn RemoteSwitchBricklet::set_response_expected(&mut self, function_id: u8, response_expected: bool) → ()
Parameters:
  • function_id – Type: u8, Range: See constants
  • response_expected – Type: bool

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.

The following constants are available for this function:

For function_id:

  • REMOTE_SWITCH_BRICKLET_FUNCTION_SWITCH_SOCKET = 1
  • REMOTE_SWITCH_BRICKLET_FUNCTION_SET_REPEATS = 4
  • REMOTE_SWITCH_BRICKLET_FUNCTION_SWITCH_SOCKET_A = 6
  • REMOTE_SWITCH_BRICKLET_FUNCTION_SWITCH_SOCKET_B = 7
  • REMOTE_SWITCH_BRICKLET_FUNCTION_DIM_SOCKET_B = 8
  • REMOTE_SWITCH_BRICKLET_FUNCTION_SWITCH_SOCKET_C = 9
pub fn RemoteSwitchBricklet::set_response_expected_all(&mut self, response_expected: bool) → ()
Parameters:
  • response_expected – Type: bool

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Constants

pub const RemoteSwitchBricklet::DEVICE_IDENTIFIER

This constant is used to identify a Remote Switch Bricklet.

The RemoteSwitchBricklet::get_identity function and the IpConnection::get_enumerate_callback_receiver callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

pub const RemoteSwitchBricklet::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Remote Switch Bricklet.