Rust - Remote Switch Bricklet 2.0

Dies ist die Beschreibung der Rust API Bindings für das Remote Switch Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Remote Switch Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Rust API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf docs.rs.

Beispiele

Der folgende Beispielcode ist 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);

    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);

    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

Um eine nicht-blockierende Verwendung zu erlauben, gibt fast jede Funktion der Rust-Bindings einen Wrapper um einen mpsc::Receiver zurück. Um das Ergebnis eines Funktionsaufrufs zu erhalten und zu blockieren, bis das Gerät die Anfrage verarbeitet hat, können die recv-Varianten des Receivers verwendet werden. Diese geben entweder das vom Gerät gesendete Ergebnis, oder einen aufgetretenen Fehler zurück.

Funktionen die direkt ein Result zurückgeben, blockieren bis das Gerät die Anfrage verarbeitet hat.

Alle folgend aufgelisteten Funktionen sind Thread-sicher, diese, die einen Receiver zurückgeben, sind Lock-frei.

Grundfunktionen

pub fn RemoteSwitchV2Bricklet::new(uid: &str, ip_connection: &IpConnection) → RemoteSwitchV2Bricklet
Parameter:
  • uid – Typ: &str
  • ip_connection – Typ: &IPConnection
Rückgabe:
  • remote_switch_v2 – Typ: RemoteSwitchV2Bricklet

Erzeugt ein neues RemoteSwitchV2Bricklet-Objekt mit der eindeutigen Geräte ID uid und fügt es der IP-Connection ip_connection hinzu:

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

Dieses Geräteobjekt kann benutzt werden, nachdem die IP-Connection verbunden wurde (siehe Beispiele oben).

pub fn RemoteSwitchV2Bricklet::get_switching_state(&self) → ConvertingReceiver<u8>
Rückgabe:
  • state – Typ: u8, Wertebereich: Siehe Konstanten

Gibt den aktuellen Zustand des Schaltens zurück. Wenn der aktuell Zustand busy (beschäftigt) ist, sendet das Bricklet gerade einen Code um eine Steckdose zu schalten. Weitere Aufrufe der Switch Socket Funktionen werden ignoriert bis der Zustand auf ready (fertig) wechselt.

Die Länge des Schaltvorgangs ist abhängig von der Anzahl der Wiederholungen, siehe RemoteSwitchV2Bricklet::set_repeats.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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<()>
Parameter:
  • house_code – Typ: u8, Wertebereich: [0 bis 255]
  • receiver_code – Typ: u8, Wertebereich: [0 bis 255]
  • switch_to – Typ: u8, Wertebereich: Siehe Konstanten

Um eine Typ A Steckdose zu schalten muss der Housecode, Receivercode sowie der Zustand (an oder aus) zu dem geschaltet werden soll übergeben werden.

Der House- und Receivercode hat einen Wertebereich von 0 bis 31 (5Bit).

Eine detaillierte Beschreibung wie man den House- und Receivercode herausfinden kann gibt es hier.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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<()>
Parameter:
  • address – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • unit – Typ: u8, Wertebereich: [0 bis 255]
  • switch_to – Typ: u8, Wertebereich: Siehe Konstanten

Um eine Typ B Steckdose zu schalten muss die Adresse und Unit sowie der Zustand (an oder aus) zu dem geschaltet werden soll übergeben werden.

Die Adresse hat einen Wertebereich von 0 bis 67108863 (26Bit) und die Unit hat einen Wertebereich von 0 bis 15 (4Bit). Um alle Geräte mit der selben Adresse zu schalten kann die Unit auf 255 gesetzt werden.

Eine detaillierte Beschreibung wie man Adresse und Unit einer Steckdose anlernen kann gibt es hier.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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<()>
Parameter:
  • address – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • unit – Typ: u8, Wertebereich: [0 bis 255]
  • dim_value – Typ: u8, Wertebereich: [0 bis 255]

Um eine Typ B Dimmer zu steuern muss die Adresse und Unit sowie der Dimmwert auf der Dimmer gesetzt werden soll übergeben werden.

Die Adresse hat einen Wertebereich von 0 bis 67108863 (26Bit), die Unit und der Dimmwert haben einen Wertebereich von 0 bis 15 (4Bit).

Eine detaillierte Beschreibung wie man Adresse und Unit einem Dimmer anlernen kann gibt es hier.

pub fn RemoteSwitchV2Bricklet::switch_socket_c(&self, system_code: char, device_code: u8, switch_to: u8) → ConvertingReceiver<()>
Parameter:
  • system_code – Typ: char
  • device_code – Typ: u8, Wertebereich: [0 bis 255]
  • switch_to – Typ: u8, Wertebereich: Siehe Konstanten

Um eine Typ C Steckdose zu schalten muss der Systemcode, Gerätecode sowie der Zustand (an oder aus) zu dem geschaltet werden soll übergeben werden.

Der Systemcode hat einen Wertebereich von 'A' bis 'P' (4Bit) und der Gerätecode hat einen Wertebereich von 1 bis 16 (4Bit).

Eine detaillierte Beschreibung wie man den System- und Gerätecode herausfinden kann gibt es hier.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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<()>
Parameter:
  • remote_type – Typ: u8, Wertebereich: Siehe Konstanten
  • minimum_repeats – Typ: u16, Wertebereich: [0 bis 216 - 1]
  • callback_enabled – Typ: bool

Setzt die Konfiguration für das Empfangen von Daten von Fernbedienungen der Typen A, B und C.

Der Standardwert ist ('A', 2, false).

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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>
Rückgabeobjekt:
  • remote_type – Typ: u8, Wertebereich: Siehe Konstanten
  • minimum_repeats – Typ: u16, Wertebereich: [0 bis 216 - 1]
  • callback_enabled – Typ: bool

Gibt die Konfiguration zurück wie von RemoteSwitchV2Bricklet::set_remote_configuration gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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>
Rückgabeobjekt:
  • house_code – Typ: u8, Wertebereich: [0 bis 255]
  • receiver_code – Typ: u8, Wertebereich: [0 bis 255]
  • switch_to – Typ: u8, Wertebereich: Siehe Konstanten
  • repeats – Typ: u16, Wertebereich: [0 bis 216 - 1]

Gibt den Housecode, Receivercode, Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ A Fernbedienung zurück.

Repeats == 0 bedeutet, dass kein Knopf auf der Fernbedienung gedrückt wurde. Repeats >= 1 bedeutet, dass ein Knopf mit dem angegebenen House/Receivercode auf der Fernbedienung gedrückt wurde. Die repeats sind die Anzahl der empfangenen identischen Datenpakete.

Es kann auch automatisch ein Callback ausgelöst werden, wenn Daten empfangen werden, siehe RemoteSwitchV2Bricklet::set_remote_configuration und RemoteSwitchV2Bricklet::get_remote_status_a_callback_receiver Callback.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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>
Rückgabeobjekt:
  • address – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • unit – Typ: u8, Wertebereich: [0 bis 255]
  • switch_to – Typ: u8, Wertebereich: Siehe Konstanten
  • dim_value – Typ: u8, Wertebereich: [0 bis 255]
  • repeats – Typ: u16, Wertebereich: [0 bis 216 - 1]

Gibt die Address (eindeutig für jede Fernbedienung), Unit (Knopfnummer), Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ B Fernbedienung zurück.

Falls die Fernbedienung Dimmen unterstützt, dann wie der Dimmwert anstatt des Schaltzustandes verwendet.

Repeats == 0 bedeutet, dass kein Knopf auf der Fernbedienung gedrückt wurde. Repeats >= 1 bedeutet, dass ein Knopf mit der angegebenen Address/Unit auf der Fernbedienung gedrückt wurde. Die repeats sind die Anzahl der empfangenen identischen Datenpakete.

Es kann auch automatisch ein Callback ausgelöst werden, wenn Daten empfangen werden, siehe RemoteSwitchV2Bricklet::set_remote_configuration und RemoteSwitchV2Bricklet::get_remote_status_b_callback_receiver Callback.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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>
Rückgabeobjekt:
  • system_code – Typ: char
  • device_code – Typ: u8, Wertebereich: [0 bis 255]
  • switch_to – Typ: u8, Wertebereich: Siehe Konstanten
  • repeats – Typ: u16, Wertebereich: [0 bis 216 - 1]

Gibt die Systemcode, Gerätecode, Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ C Fernbedienung zurück.

Repeats == 0 bedeutet, dass kein Knopf auf der Fernbedienung gedrückt wurde. Repeats >= 1 bedeutet, dass ein Knopf mit der angegebenen System/Gerätecode auf der Fernbedienung gedrückt wurde. Die repeats sind die Anzahl der empfangenen identischen Datenpakete.

Es kann auch automatisch ein Callback ausgelöst werden, wenn Daten empfangen werden, siehe RemoteSwitchV2Bricklet::set_remote_configuration und RemoteSwitchV2Bricklet::get_remote_status_c_callback_receiver Callback.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für switch_to:

  • REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_OFF = 0
  • REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_ON = 1

Fortgeschrittene Funktionen

pub fn RemoteSwitchV2Bricklet::set_repeats(&self, repeats: u8) → ConvertingReceiver<()>
Parameter:
  • repeats – Typ: u8, Wertebereich: [0 bis 255]

Setzt die Anzahl der Wiederholungen die verwendet werden um einen Code zu senden wenn eine der Switch Socket Funktionen aufgerufen wird. Die Wiederholungen korrespondieren zu der Zeit die eine Taste auf der Fernbedienung gedrückt wird.

Einige Dimmer werden über die Länge des Tastendrucks kontrolliert, dies kann simuliert werden indem man die Anzahl der Wiederholungen inkrementiert.

Der Standardwert ist 5.

pub fn RemoteSwitchV2Bricklet::get_repeats(&self) → ConvertingReceiver<u8>
Rückgabe:
  • repeats – Typ: u8, Wertebereich: [0 bis 255]

Gibt die Anzahl der Wiederholungen zurück, wie von RemoteSwitchV2Bricklet::set_repeats gesetzt.

pub fn RemoteSwitchV2Bricklet::get_api_version(&self) → [u8; 3]
Rückgabe:
  • api_version – Typ: [u8; 3], Wertebereich: [0 bis 255]

Gibt die Version der API Definition (Major, Minor, Revision) zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

pub fn RemoteSwitchV2Bricklet::get_response_expected(&mut self, function_id: u8) → bool
Parameter:
  • function_id – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:
  • response_expected – Typ: bool

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels RemoteSwitchV2Bricklet::set_response_expected. Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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) → ()
Parameter:
  • function_id – Typ: u8, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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) → ()
Parameter:
  • response_expected – Typ: bool

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

pub fn RemoteSwitchV2Bricklet::get_spitfp_error_count(&self) → ConvertingReceiver<SpitfpErrorCount>
Rückgabeobjekt:
  • error_count_ack_checksum – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: u32, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

pub fn RemoteSwitchV2Bricklet::set_bootloader_mode(&self, mode: u8) → ConvertingReceiver<u8>
Parameter:
  • mode – Typ: u8, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: u8, Wertebereich: Siehe Konstanten

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootlodaer- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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

Für 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>
Rückgabe:
  • mode – Typ: u8, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe RemoteSwitchV2Bricklet::set_bootloader_mode.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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<()>
Parameter:
  • pointer – Typ: u32, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für RemoteSwitchV2Bricklet::write_firmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

pub fn RemoteSwitchV2Bricklet::write_firmware(&self, data: [u8; 64]) → ConvertingReceiver<u8>
Parameter:
  • data – Typ: [u8; 64], Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: u8, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von RemoteSwitchV2Bricklet::set_write_firmware_pointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

pub fn RemoteSwitchV2Bricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>
Parameter:
  • config – Typ: u8, Wertebereich: Siehe Konstanten

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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>
Rückgabe:
  • config – Typ: u8, Wertebereich: Siehe Konstanten

Gibt die Konfiguration zurück, wie von RemoteSwitchV2Bricklet::set_status_led_config gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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>
Rückgabe:
  • temperature – Typ: i16, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur in °C, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

pub fn RemoteSwitchV2Bricklet::reset(&self) → ConvertingReceiver<()>

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

pub fn RemoteSwitchV2Bricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>
Parameter:
  • uid – Typ: u32, Wertebereich: [0 bis 232 - 1]

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

pub fn RemoteSwitchV2Bricklet::read_uid(&self) → ConvertingReceiver<u32>
Rückgabe:
  • uid – Typ: u32, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

pub fn RemoteSwitchV2Bricklet::get_identity(&self) → ConvertingReceiver<Identity>
Rückgabeobjekt:
  • uid – Typ: String, Länge: bis zu 8
  • connected_uid – Typ: String, Länge: bis zu 8
  • position – Typ: char
  • hardware_version – Typ: [u8; 3], Wertebereich: [0 bis 255]
  • firmware_version – Typ: [u8; 3], Wertebereich: [0 bis 255]
  • device_identifier – Typ: u16, Wertebereich: [0 bis 216 - 1]

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der entsprechenden get_*_callback_receiver-Function durchgeführt werden, welche einen Receiver für Callback-Events zurück gibt.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

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

Receiver die mit dieser Funktion erstellt werden, empfangen Switching Done-Events.

Dieser Callback wird aufgerufen wenn der Schaltzustand von busy auf ready wechselt, siehe RemoteSwitchV2Bricklet::get_switching_state.

pub fn RemoteSwitchV2Bricklet::get_remote_status_a_callback_receiver(&self) → ConvertingCallbackReceiver<RemoteStatusAEvent>
Event-Objekt:
  • house_code – Typ: u8, Wertebereich: [0 bis 255]
  • receiver_code – Typ: u8, Wertebereich: [0 bis 255]
  • switch_to – Typ: u8, Wertebereich: Siehe Konstanten
  • repeats – Typ: u16, Wertebereich: [0 bis 216 - 1]

Receiver die mit dieser Funktion erstellt werden, empfangen Remote Status A-Events.

Gibt den Housecode, Receivercode, Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ A Fernbedienung zurück.

Die Wiederholungen ist die Anzahl empfangener identischer Datenpakete. Je länger der Knopf auf der Fernbedienung gedrückt wird, desto höher die Anzahl der Wiederholungen. Der Callback wird bei jeder Wiederholung ausgelöst.

Der Callback muss zuerst aktiviert werden mittels RemoteSwitchV2Bricklet::set_remote_configuration. Die Mindestanzahl an Wiederholungen die konfiguriert werden kann ist die Anzahl an Wiederholungen die empfangen worden sein muss bevor der Callback das erste mal ausgelöst wird.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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-Objekt:
  • address – Typ: u32, Wertebereich: [0 bis 232 - 1]
  • unit – Typ: u8, Wertebereich: [0 bis 255]
  • switch_to – Typ: u8, Wertebereich: Siehe Konstanten
  • dim_value – Typ: u8, Wertebereich: [0 bis 255]
  • repeats – Typ: u16, Wertebereich: [0 bis 216 - 1]

Receiver die mit dieser Funktion erstellt werden, empfangen Remote Status B-Events.

Gibt die Address (eindeutig für jede Fernbedienung), Unit (Knopfnummer), Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ B Fernbedienung zurück.

Die Wiederholungen ist die Anzahl empfangener identischer Datenpakete. Je länger der Knopf auf der Fernbedienung gedrückt wird, desto höher die Anzahl der Wiederholungen. Der Callback wird bei jeder Wiederholung ausgelöst.

Der Callback muss zuerst aktiviert werden mittels RemoteSwitchV2Bricklet::set_remote_configuration. Die Mindestanzahl an Wiederholungen die konfiguriert werden kann ist die Anzahl an Wiederholungen die empfangen worden sein muss bevor der Callback das erste mal ausgelöst wird.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für 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-Objekt:
  • system_code – Typ: char
  • device_code – Typ: u8, Wertebereich: [0 bis 255]
  • switch_to – Typ: u8, Wertebereich: Siehe Konstanten
  • repeats – Typ: u16, Wertebereich: [0 bis 216 - 1]

Receiver die mit dieser Funktion erstellt werden, empfangen Remote Status C-Events.

Gibt die Systemcode, Gerätecode, Schaltzustand (an/aus) und Anzahl der Wiederholungen für eine Typ C Fernbedienung zurück.

Die Wiederholungen ist die Anzahl empfangener identischer Datenpakete. Je länger der Knopf auf der Fernbedienung gedrückt wird, desto höher die Anzahl der Wiederholungen. Der Callback wird bei jeder Wiederholung ausgelöst.

Der Callback muss zuerst aktiviert werden mittels RemoteSwitchV2Bricklet::set_remote_configuration. Die Mindestanzahl an Wiederholungen die konfiguriert werden kann ist die Anzahl an Wiederholungen die empfangen worden sein muss bevor der Callback das erste mal ausgelöst wird.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für switch_to:

  • REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_OFF = 0
  • REMOTE_SWITCH_V2_BRICKLET_SWITCH_TO_ON = 1

Konstanten

pub const RemoteSwitchV2Bricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Remote Switch Bricklet 2.0 zu identifizieren.

Die RemoteSwitchV2Bricklet::get_identity Funktion und der IpConnection::get_enumerate_callback_receiver Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

pub const RemoteSwitchV2Bricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Remote Switch Bricklet 2.0 dar.