Rust - RGB LED Button Bricklet

Dies ist die Beschreibung der Rust API Bindings für das RGB LED Button Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des RGB LED Button Bricklet 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).

Simple Color

Download (example_simple_color.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
use std::{error::Error, io};

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

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

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

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

    // Set light blue color
    rlb.set_color(0, 170, 234);

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

Simple Button

Download (example_simple_button.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
use std::{error::Error, io};

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

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

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

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

    // Get current button state.
    let state = rlb.get_button_state().recv()?;

    if state == RGB_LED_BUTTON_BRICKLET_BUTTON_STATE_PRESSED {
        println!("State: Pressed");
    } else if state == RGB_LED_BUTTON_BRICKLET_BUTTON_STATE_RELEASED {
        println!("State: Released");
    }

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

Callback

Download (example_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
use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, rgb_led_button_bricklet::*};

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

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

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

    let button_state_changed_receiver = rlb.get_button_state_changed_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `rlb` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for button_state_changed in button_state_changed_receiver {
            if button_state_changed == RGB_LED_BUTTON_BRICKLET_BUTTON_STATE_PRESSED {
                println!("State: Pressed");
            } else if button_state_changed == RGB_LED_BUTTON_BRICKLET_BUTTON_STATE_RELEASED {
                println!("State: Released");
            }
        }
    });

    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 RgbLedButtonBricklet::new(uid: &str, ip_connection: &IpConnection) → RgbLedButtonBricklet

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

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

pub fn RgbLedButtonBricklet::set_color(&self, red: u8, green: u8, blue: u8) → ConvertingReceiver<()>

Setzt die LED-Farbe.

Standardmäßig ist die LED aus (0, 0, 0).

pub fn RgbLedButtonBricklet::get_color(&self) → ConvertingReceiver<Color>

Gibt die LED-Farbe zurück, wie von RgbLedButtonBricklet::set_color gesetzt.

pub fn RgbLedButtonBricklet::get_button_state(&self) → ConvertingReceiver<u8>

Gibt den aktuellen Zustand des Knopfes zurück (entweder gedrückt oder nicht gedrückt).

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

  • RGB_LED_BUTTON_BRICKLET_BUTTON_STATE_PRESSED = 0
  • RGB_LED_BUTTON_BRICKLET_BUTTON_STATE_RELEASED = 1
pub fn RgbLedButtonBricklet::get_color_calibration(&self) → ConvertingReceiver<ColorCalibration>

Gibt die Farbwert-Kalibrierung zurück, wie von RgbLedButtonBricklet::set_color_calibration gesetzt.

Fortgeschrittene Funktionen

pub fn RgbLedButtonBricklet::set_color_calibration(&self, red: u8, green: u8, blue: u8) → ConvertingReceiver<()>

Setzt die Farbwert-Kalibrierung. Einige Farben erscheinen heller als andere, daher kann eine Kalibrierung nötig sein um gleichmäßige Farben zu erzielen.

Der Wertebereich ist 0% bis 100%

Die Kalibrierung wird im Flash des Bricklets gespeichert und muss daher nicht bei jedem Start erneut vorgenommen werden.

Standardwert ist (100, 100, 55).

pub fn RgbLedButtonBricklet::get_api_version(&self) → [u8; 3]

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 RgbLedButtonBricklet::get_response_expected(&mut self, function_id: u8) → 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 RgbLedButtonBricklet::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.

Siehe RgbLedButtonBricklet::set_response_expected für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

pub fn RgbLedButtonBricklet::set_response_expected(&mut self, function_id: u8, response_expected: 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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • RGB_LED_BUTTON_BRICKLET_FUNCTION_SET_COLOR = 1
  • RGB_LED_BUTTON_BRICKLET_FUNCTION_SET_COLOR_CALIBRATION = 5
  • RGB_LED_BUTTON_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • RGB_LED_BUTTON_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • RGB_LED_BUTTON_BRICKLET_FUNCTION_RESET = 243
  • RGB_LED_BUTTON_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn RgbLedButtonBricklet::set_response_expected_all(&mut self, response_expected: bool) → ()

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

pub fn RgbLedButtonBricklet::get_spitfp_error_count(&self) → ConvertingReceiver<SpitfpErrorCount>

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 RgbLedButtonBricklet::set_bootloader_mode(&self, mode: u8) → ConvertingReceiver<u8>

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:

  • RGB_LED_BUTTON_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • RGB_LED_BUTTON_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • RGB_LED_BUTTON_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • RGB_LED_BUTTON_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • RGB_LED_BUTTON_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • RGB_LED_BUTTON_BRICKLET_BOOTLOADER_STATUS_OK = 0
  • RGB_LED_BUTTON_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
  • RGB_LED_BUTTON_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
  • RGB_LED_BUTTON_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • RGB_LED_BUTTON_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • RGB_LED_BUTTON_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5
pub fn RgbLedButtonBricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>

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

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

  • RGB_LED_BUTTON_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • RGB_LED_BUTTON_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • RGB_LED_BUTTON_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • RGB_LED_BUTTON_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • RGB_LED_BUTTON_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
pub fn RgbLedButtonBricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>

Setzt den Firmware-Pointer für RgbLedButtonBricklet::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 RgbLedButtonBricklet::write_firmware(&self, data: [u8; 64]) → ConvertingReceiver<u8>

Schreibt 64 Bytes Firmware an die Position die vorher von RgbLedButtonBricklet::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 RgbLedButtonBricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>

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:

  • RGB_LED_BUTTON_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • RGB_LED_BUTTON_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • RGB_LED_BUTTON_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • RGB_LED_BUTTON_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn RgbLedButtonBricklet::get_status_led_config(&self) → ConvertingReceiver<u8>

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

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

  • RGB_LED_BUTTON_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • RGB_LED_BUTTON_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • RGB_LED_BUTTON_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • RGB_LED_BUTTON_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn RgbLedButtonBricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>

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 RgbLedButtonBricklet::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 RgbLedButtonBricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>

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 RgbLedButtonBricklet::read_uid(&self) → ConvertingReceiver<u32>

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 RgbLedButtonBricklet::get_identity(&self) → ConvertingReceiver<Identity>

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 RgbLedButtonBricklet::get_button_state_changed_callback_receiver(&self) → ConvertingCallbackReceiver<u8>

Receiver die mit dieser Funktion erstellt werden, empfangen Button State Changed-Events.

Dieser Callback wird jedes mal ausgelöst wenn sich der Zustand es Knopfes ändert von gedrückt zu nicht gedrückt oder anders herum

Das empfangene Variable ist der aktuelle Zustand des Knopfes.

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

  • RGB_LED_BUTTON_BRICKLET_BUTTON_STATE_PRESSED = 0
  • RGB_LED_BUTTON_BRICKLET_BUTTON_STATE_RELEASED = 1

Konstanten

RgbLedButtonBricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein RGB LED Button Bricklet zu identifizieren.

Die RgbLedButtonBricklet::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.

RgbLedButtonBricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines RGB LED Button Bricklet dar.