Deutsch
English
Menu
Software / API Bindings / Rust / API Reference and Examples / Bricklets / Remote Switch Bricklet 2.0

Rust - Remote Switch Bricklet 2.0

This is the description of the Rust API bindings for the Remote Switch Bricklet 2.0. General information and technical specifications for the Remote Switch Bricklet 2.0 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_v2_bricklet::*};

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

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let rs = RemoteSwitchV2Bricklet::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_V2_BRICKLET_SWITCH_TO_ON).recv()?;

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

Remote Callback

Download (example_remote_callback.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
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, remote_switch_v2_bricklet::*};

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

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

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

    // Configure to receive from remote type A with minimum repeats set to 1 and enable callback
    rs.set_remote_configuration(REMOTE_SWITCH_V2_BRICKLET_REMOTE_TYPE_A, 1, true).recv()?;

    let remote_status_a_receiver = rs.get_remote_status_a_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `rs` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for remote_status_a in remote_status_a_receiver {
            println!("House Code: {}", remote_status_a.house_code);
            println!("Receiver Code: {}", remote_status_a.receiver_code);

            if remote_status_a.switch_to == REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_OFF {
                println!("Switch To: Off");
            } else if remote_status_a.switch_to == REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_ON {
                println!("Switch To: On");
            }

            println!("Repeats: {}", remote_status_a.repeats);
            println!();
        }
    });

    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 RemoteSwitchV2Bricklet::new(uid: &str, ip_connection: &IpConnection) → RemoteSwitchV2Bricklet
Parameters:
  • uid – Type: &str
  • ip_connection – Type: &IPConnection
Returns:
  • remote_switch_v2 – Type: RemoteSwitchV2Bricklet

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

let remote_switch_v2 = RemoteSwitchV2Bricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn RemoteSwitchV2Bricklet::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 calls of switch socket functions until the state changes to ready.

How long the switching takes is dependent on the number of repeats, see RemoteSwitchV2Bricklet::set_repeats.

The following constants are available for this function:

For state:

  • REMOTE_SWITCH_V2_BRICKLET_SWITCHING_STATE_READY = 0
  • REMOTE_SWITCH_V2_BRICKLET_SWITCHING_STATE_BUSY = 1
pub fn RemoteSwitchV2Bricklet::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_V2_BRICKLET_SWITCH_TO_OFF = 0
  • REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_ON = 1
pub fn RemoteSwitchV2Bricklet::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_V2_BRICKLET_SWITCH_TO_OFF = 0
  • REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_ON = 1
pub fn RemoteSwitchV2Bricklet::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.

pub fn RemoteSwitchV2Bricklet::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_V2_BRICKLET_SWITCH_TO_OFF = 0
  • REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_ON = 1
pub fn RemoteSwitchV2Bricklet::set_remote_configuration(&self, remote_type: u8, minimum_repeats: u16, callback_enabled: bool) → ConvertingReceiver<()>
Parameters:
  • remote_type – Type: u8, Range: See constants, Default: 0
  • minimum_repeats – Type: u16, Range: [0 to 216 - 1], Default: 2
  • callback_enabled – Type: bool, Default: false

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

The following constants are available for this function:

For remote_type:

  • REMOTE_SWITCH_V2_BRICKLET_REMOTE_TYPE_A = 0
  • REMOTE_SWITCH_V2_BRICKLET_REMOTE_TYPE_B = 1
  • REMOTE_SWITCH_V2_BRICKLET_REMOTE_TYPE_C = 2
pub fn RemoteSwitchV2Bricklet::get_remote_configuration(&self) → ConvertingReceiver<RemoteConfiguration>
Return Object:
  • remote_type – Type: u8, Range: See constants, Default: 0
  • minimum_repeats – Type: u16, Range: [0 to 216 - 1], Default: 2
  • callback_enabled – Type: bool, Default: false

Returns the remote configuration as set by RemoteSwitchV2Bricklet::set_remote_configuration

The following constants are available for this function:

For remote_type:

  • REMOTE_SWITCH_V2_BRICKLET_REMOTE_TYPE_A = 0
  • REMOTE_SWITCH_V2_BRICKLET_REMOTE_TYPE_B = 1
  • REMOTE_SWITCH_V2_BRICKLET_REMOTE_TYPE_C = 2
pub fn RemoteSwitchV2Bricklet::get_remote_status_a(&self) → ConvertingReceiver<RemoteStatusA>
Return Object:
  • house_code – Type: u8, Range: [0 to 31]
  • receiver_code – Type: u8, Range: [0 to 31]
  • switch_to – Type: u8, Range: See constants
  • repeats – Type: u16, Range: [0 to 216 - 1]

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 callback to get this data automatically when a button is pressed, see RemoteSwitchV2Bricklet::set_remote_configuration and RemoteSwitchV2Bricklet::get_remote_status_a_callback_receiver callback.

The following constants are available for this function:

For switch_to:

  • REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_OFF = 0
  • REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_ON = 1
pub fn RemoteSwitchV2Bricklet::get_remote_status_b(&self) → ConvertingReceiver<RemoteStatusB>
Return Object:
  • address – Type: u32, Range: [0 to 226 - 1]
  • unit – Type: u8, Range: [0 to 15]
  • switch_to – Type: u8, Range: See constants
  • dim_value – Type: u8, Range: [0 to 255]
  • repeats – Type: u16, Range: [0 to 216 - 1]

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 callback to get this data automatically when a button is pressed, see RemoteSwitchV2Bricklet::set_remote_configuration and RemoteSwitchV2Bricklet::get_remote_status_b_callback_receiver callback.

The following constants are available for this function:

For switch_to:

  • REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_OFF = 0
  • REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_ON = 1
pub fn RemoteSwitchV2Bricklet::get_remote_status_c(&self) → ConvertingReceiver<RemoteStatusC>
Return Object:
  • system_code – Type: char, Range: ['A' to 'P']
  • device_code – Type: u8, Range: [1 to 16]
  • switch_to – Type: u8, Range: See constants
  • repeats – Type: u16, Range: [0 to 216 - 1]

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 callback to get this data automatically when a button is pressed, see RemoteSwitchV2Bricklet::set_remote_configuration and RemoteSwitchV2Bricklet::get_remote_status_c_callback_receiver callback.

The following constants are available for this function:

For switch_to:

  • REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_OFF = 0
  • REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_ON = 1

Advanced Functions

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

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

pub fn RemoteSwitchV2Bricklet::get_spitfp_error_count(&self) → ConvertingReceiver<SpitfpErrorCount>
Return Object:
  • error_count_ack_checksum – Type: u32, Range: [0 to 232 - 1]
  • error_count_message_checksum – Type: u32, Range: [0 to 232 - 1]
  • error_count_frame – Type: u32, Range: [0 to 232 - 1]
  • error_count_overflow – Type: u32, Range: [0 to 232 - 1]

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 fn RemoteSwitchV2Bricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>
Parameters:
  • config – Type: u8, Range: See constants, Default: 3

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.

The following constants are available for this function:

For config:

  • REMOTE_SWITCH_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • REMOTE_SWITCH_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • REMOTE_SWITCH_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • REMOTE_SWITCH_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn RemoteSwitchV2Bricklet::get_status_led_config(&self) → ConvertingReceiver<u8>
Returns:
  • config – Type: u8, Range: See constants, Default: 3

Returns the configuration as set by RemoteSwitchV2Bricklet::set_status_led_config

The following constants are available for this function:

For config:

  • REMOTE_SWITCH_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • REMOTE_SWITCH_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • REMOTE_SWITCH_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • REMOTE_SWITCH_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn RemoteSwitchV2Bricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>
Returns:
  • temperature – Type: i16, Unit: 1 °C, Range: [-215 to 215 - 1]

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 fn RemoteSwitchV2Bricklet::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!

pub fn RemoteSwitchV2Bricklet::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', '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). A Bricklet connected to an Isolator Bricklet is always at 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 RemoteSwitchV2Bricklet::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 RemoteSwitchV2Bricklet::get_switching_state.

pub fn RemoteSwitchV2Bricklet::get_remote_status_a_callback_receiver(&self) → ConvertingCallbackReceiver<RemoteStatusAEvent>
Event Object:
  • house_code – Type: u8, Range: [0 to 31]
  • receiver_code – Type: u8, Range: [0 to 31]
  • switch_to – Type: u8, Range: See constants
  • repeats – Type: u16, Range: [0 to 216 - 1]

Receivers created with this function receive Remote Status A events.

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 callback is triggered with every repeat.

You have to enable the callback with RemoteSwitchV2Bricklet::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 callback is triggered for the first time.

The following constants are available for this function:

For switch_to:

  • REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_OFF = 0
  • REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_ON = 1
pub fn RemoteSwitchV2Bricklet::get_remote_status_b_callback_receiver(&self) → ConvertingCallbackReceiver<RemoteStatusBEvent>
Event Object:
  • address – Type: u32, Range: [0 to 226 - 1]
  • unit – Type: u8, Range: [0 to 15, 255]
  • switch_to – Type: u8, Range: See constants
  • dim_value – Type: u8, Range: [0 to 255]
  • repeats – Type: u16, Range: [0 to 216 - 1]

Receivers created with this function receive Remote Status B events.

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 callback is triggered with every repeat.

You have to enable the callback with RemoteSwitchV2Bricklet::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 callback is triggered for the first time.

The following constants are available for this function:

For switch_to:

  • REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_OFF = 0
  • REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_ON = 1
pub fn RemoteSwitchV2Bricklet::get_remote_status_c_callback_receiver(&self) → ConvertingCallbackReceiver<RemoteStatusCEvent>
Event Object:
  • system_code – Type: char, Range: ['A' to 'P']
  • device_code – Type: u8, Range: [1 to 16]
  • switch_to – Type: u8, Range: See constants
  • repeats – Type: u16, Range: [0 to 216 - 1]

Receivers created with this function receive Remote Status C events.

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 callback is triggered with every repeat.

You have to enable the callback with RemoteSwitchV2Bricklet::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 callback is triggered for the first time.

The following constants are available for this function:

For switch_to:

  • REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_OFF = 0
  • REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_ON = 1

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 RemoteSwitchV2Bricklet::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 RemoteSwitchV2Bricklet::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 RemoteSwitchV2Bricklet::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_V2_BRICKLET_FUNCTION_SET_REPEATS = 3
  • REMOTE_SWITCH_V2_BRICKLET_FUNCTION_SWITCH_SOCKET_A = 5
  • REMOTE_SWITCH_V2_BRICKLET_FUNCTION_SWITCH_SOCKET_B = 6
  • REMOTE_SWITCH_V2_BRICKLET_FUNCTION_DIM_SOCKET_B = 7
  • REMOTE_SWITCH_V2_BRICKLET_FUNCTION_SWITCH_SOCKET_C = 8
  • REMOTE_SWITCH_V2_BRICKLET_FUNCTION_SET_REMOTE_CONFIGURATION = 9
  • REMOTE_SWITCH_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • REMOTE_SWITCH_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • REMOTE_SWITCH_V2_BRICKLET_FUNCTION_RESET = 243
  • REMOTE_SWITCH_V2_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn RemoteSwitchV2Bricklet::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_V2_BRICKLET_FUNCTION_SET_REPEATS = 3
  • REMOTE_SWITCH_V2_BRICKLET_FUNCTION_SWITCH_SOCKET_A = 5
  • REMOTE_SWITCH_V2_BRICKLET_FUNCTION_SWITCH_SOCKET_B = 6
  • REMOTE_SWITCH_V2_BRICKLET_FUNCTION_DIM_SOCKET_B = 7
  • REMOTE_SWITCH_V2_BRICKLET_FUNCTION_SWITCH_SOCKET_C = 8
  • REMOTE_SWITCH_V2_BRICKLET_FUNCTION_SET_REMOTE_CONFIGURATION = 9
  • REMOTE_SWITCH_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • REMOTE_SWITCH_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • REMOTE_SWITCH_V2_BRICKLET_FUNCTION_RESET = 243
  • REMOTE_SWITCH_V2_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn RemoteSwitchV2Bricklet::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.

Internal Functions

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

pub fn RemoteSwitchV2Bricklet::set_bootloader_mode(&self, mode: u8) → ConvertingReceiver<u8>
Parameters:
  • mode – Type: u8, Range: See constants
Returns:
  • status – Type: u8, Range: See constants

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.

The following constants are available for this function:

For mode:

  • REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

  • REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_STATUS_OK = 0
  • REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
  • REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
  • REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5
pub fn RemoteSwitchV2Bricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>
Returns:
  • mode – Type: u8, Range: See constants

Returns the current bootloader mode, see RemoteSwitchV2Bricklet::set_bootloader_mode.

The following constants are available for this function:

For mode:

  • REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • REMOTE_SWITCH_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
pub fn RemoteSwitchV2Bricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>
Parameters:
  • pointer – Type: u32, Unit: 1 B, Range: [0 to 232 - 1]

Sets the firmware pointer for RemoteSwitchV2Bricklet::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 fn RemoteSwitchV2Bricklet::write_firmware(&self, data: [u8; 64]) → ConvertingReceiver<u8>
Parameters:
  • data – Type: [u8; 64], Range: [0 to 255]
Returns:
  • status – Type: u8, Range: [0 to 255]

Writes 64 Bytes of firmware at the position as written by RemoteSwitchV2Bricklet::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 fn RemoteSwitchV2Bricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>
Parameters:
  • uid – Type: u32, Range: [0 to 232 - 1]

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 fn RemoteSwitchV2Bricklet::read_uid(&self) → ConvertingReceiver<u32>
Returns:
  • uid – Type: u32, Range: [0 to 232 - 1]

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

Constants

pub const RemoteSwitchV2Bricklet::DEVICE_IDENTIFIER

This constant is used to identify a Remote Switch Bricklet 2.0.

The RemoteSwitchV2Bricklet::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 RemoteSwitchV2Bricklet::DEVICE_DISPLAY_NAME

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