Rust - LED Strip Bricklet 2.0¶

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

Simple¶

Download (example_simple.rs)

use std::{error::Error, io};

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

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

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

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

    // Set first 3 LEDs to red, green and blue
    ls.set_led_values(0, &[255, 0, 0, 0, 255, 0, 0, 0, 255])?;

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

Callback¶

Download (example_callback.rs)

use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, led_strip_v2_bricklet::*};

// FIXME: This example is incomplete

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

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

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

    // Set frame duration to 50ms (20 frames per second)
    ls.set_frame_duration(50);

    let frame_started_receiver = ls.get_frame_started_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `ls` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for frame_started in frame_started_receiver {
            println!("Length: {}", frame_started);
        }
    });

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

Parameter:	uid – Typ: &str ip_connection – Typ: &IPConnection
Rückgabe:	led_strip_v2 – Typ: LedStripV2Bricklet

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

let led_strip_v2 = LedStripV2Bricklet::new("YOUR_DEVICE_UID", &ip_connection);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP-Connection verbunden.

pub fn LedStripV2Bricklet::set_led_values(&self, index: u16, value: &[u8]) → Result<(), BrickletRecvTimeoutError>¶

Parameter:	index – Typ: u16, Wertebereich: [0 bis 6144] value – Typ: &[u8], Wertebereich: [0 bis 255]

Setzt die RGB(W) Werte der LEDs beginnend beim index. Es können bis zu 2048 RGB Werte oder 1536 RGBW Werte (jeweils 6144 Byte) gesetzt werden.

Damit die Farben richtig angezeigt werden muss den LEDs entsprechend der richtig Chip Type (siehe LedStripV2Bricklet::set_chip_type()) und das richtige Channel Mapping (siehe LedStripV2Bricklet::set_channel_mapping()) eingestellt werden.

Wenn das Channel Mapping 3 Farben hat, müssen die Werte in der Sequenz RGBRGBRGB... übergeben werden. Hat das Mapping 4 Farben, müssen die Werte in der Sequenz RGBWRGBWRGBW... übergeben werden.

Die Daten werden Zwischengespeichert und die Farben werden auf die LEDs transferiert wenn die nächste frame duration abgelaufen ist (siehe LedStripV2Bricklet::set_frame_duration()).

Genereller Ansatz:

Setze frame duration auf einen Wert welcher der Anzahl der Bilder pro Sekunde entspricht die erreicht werden sollen.
Setze alle LEDs für einen Frame.
Warte auf den LedStripV2Bricklet::get_frame_started_callback_receiver() Callback.
Setze alle LEDs für den nächsten Frame.
Warte auf den LedStripV2Bricklet::get_frame_started_callback_receiver() Callback.
Und so weiter.

Dieser Ansatz garantiert, dass die LED Farben mit einer festen Framerate angezeigt werden.

pub fn LedStripV2Bricklet::get_led_values(&self, index: u16, length: u16) → Result<Vec<u8>, BrickletRecvTimeoutError>¶

Parameter:	index – Typ: u16, Wertebereich: [0 bis 6144] length – Typ: u16, Wertebereich: [0 bis 6144]
Rückgabe:	value – Typ: Vec<u8>, Wertebereich: [0 bis 255]

Gibt length RGB(W) Werte zurück, beginnend vom übergebenen index.

Wenn das Channel Mapping 3 Farben hat, werden die Werte in der Sequenz RGBRGBRGB... zurückgegeben, hat das Mapping 4 Farben, werden die Werte in der Sequenz RGBWRGBWRGBW... zurückgegeben (unter der Annahme, dass ein durch 3 (RGB) oder 4 (RGBW) teilbarer Index übergeben wird).

pub fn LedStripV2Bricklet::set_frame_duration(&self, duration: u16) → ConvertingReceiver<()>¶

Parameter:	duration – Typ: u16, Einheit: 1 ms, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 100

Setzt die frame duration (Länge des Frames).

Beispiel: Wenn 20 Frames pro Sekunde erreicht werden sollen, muss die Länge des Frames auf 50ms gesetzt werden (50ms * 20 = 1 Sekunde).

Für eine Erklärung des generellen Ansatzes siehe LedStripV2Bricklet::set_led_values().

Standardwert: 100ms (10 Frames pro Sekunde).

pub fn LedStripV2Bricklet::get_frame_duration(&self) → ConvertingReceiver<u16>¶

Rückgabe:	duration – Typ: u16, Einheit: 1 ms, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 100

Gibt die frame duration (Länge des Frames) zurück, wie von LedStripV2Bricklet::set_frame_duration() gesetzt.

pub fn LedStripV2Bricklet::get_supply_voltage(&self) → ConvertingReceiver<u16>¶

Rückgabe:	voltage – Typ: u16, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt die aktuelle Versorgungsspannung der LEDs zurück.

pub fn LedStripV2Bricklet::set_clock_frequency(&self, frequency: u32) → ConvertingReceiver<()>¶

Parameter:	frequency – Typ: u32, Einheit: 1 Hz, Wertebereich: [10000 bis 2000000], Standardwert: 1666666

Setzt die Frequenz der Clock-Leitung.

Das Bricklet wählt die nächst mögliche erreichbare Frequenz. Diese kann ein paar Hz neben des gesetzten Wertes liegen. Die exakte Frequenz wie sie genutzt wird kann mit LedStripV2Bricklet::get_clock_frequency() erfragt werden.

Wenn Probleme mit flackernden LEDs auftreten kann es daran liegen das Bits auf der Leitung flippen. Dies kann behoben werden in dem man die Verbindung zwischen Bricklet und LEDs verringert oder in dem man die Frequenz reduziert.

Mit abnehmender Frequenz nimmt allerdings auch die maximale Framerate ab.

pub fn LedStripV2Bricklet::get_clock_frequency(&self) → ConvertingReceiver<u32>¶

Rückgabe:	frequency – Typ: u32, Einheit: 1 Hz, Wertebereich: [10000 bis 2000000], Standardwert: 1666666

Gibt die aktuell genutzte Clock-Frequenz zurück, wie von LedStripV2Bricklet::set_clock_frequency() gesetzt.

pub fn LedStripV2Bricklet::set_chip_type(&self, chip: u16) → ConvertingReceiver<()>¶

Parameter:	chip – Typ: u16, Wertebereich: Siehe Konstanten, Standardwert: 2801

Setzt den Typ des LED-Treiber-Chips. Aktuell unterstützen wir die folgenden Chips

WS2801,
WS2811,
WS2812 / SK6812 / NeoPixel RGB,
SK6812RGBW / NeoPixel RGBW (Chip Type = WS2812),
WS2813 / WS2815 (Chip Type = WS2812)
LPD8806 and
APA102 / DotStar.

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

Für chip:

LED_STRIP_V2_BRICKLET_CHIP_TYPE_WS2801 = 2801
LED_STRIP_V2_BRICKLET_CHIP_TYPE_WS2811 = 2811
LED_STRIP_V2_BRICKLET_CHIP_TYPE_WS2812 = 2812
LED_STRIP_V2_BRICKLET_CHIP_TYPE_LPD8806 = 8806
LED_STRIP_V2_BRICKLET_CHIP_TYPE_APA102 = 102

pub fn LedStripV2Bricklet::get_chip_type(&self) → ConvertingReceiver<u16>¶

Rückgabe:	chip – Typ: u16, Wertebereich: Siehe Konstanten, Standardwert: 2801

Gibt den aktuell genutzten Typ des Chips zurück, wie von LedStripV2Bricklet::set_chip_type() gesetzt.

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

Für chip:

LED_STRIP_V2_BRICKLET_CHIP_TYPE_WS2801 = 2801
LED_STRIP_V2_BRICKLET_CHIP_TYPE_WS2811 = 2811
LED_STRIP_V2_BRICKLET_CHIP_TYPE_WS2812 = 2812
LED_STRIP_V2_BRICKLET_CHIP_TYPE_LPD8806 = 8806
LED_STRIP_V2_BRICKLET_CHIP_TYPE_APA102 = 102

pub fn LedStripV2Bricklet::set_channel_mapping(&self, mapping: u8) → ConvertingReceiver<()>¶

Parameter:	mapping – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 36

Setzt das Channel Mapping für die angeschlossenen LEDs.

Falls das Mapping 4 Farben hat, erwartet die Funktion LedStripV2Bricklet::set_led_values() 4 Werte pro Pixel. Bei einem Mapping mit 3 Farben werden 3 Werte pro Pixel erwartet.

Die Funktion erwartet immer die Reihenfolge RGB(W). Die angeschlossenen LED-Treiber-Chips können die Daten für ihre 3 oder 4 Kanäle in einer anderen Reihenfolge erwarten. Zum Beispiel verwenden WS2801 Chips typischerweise BGR Reihenfolge, WS2812 Chips verwenden typischerweise GRB Reihenfolge und APA102 verwenden typischerweise WBGR Reihenfolge.

Die APA102 haben eine Besonderheit. Sie haben drei 8-Bit Kanäle für RGB und einen zusätzlichen 5-Bit Kanal für die Helligkeit der RGB LED. Dadurch ist der APA102 insgesamt ein 4-Kanal Chip. Intern ist der Helligkeitskanal der erste Kanal. Daher sollte eines der Wxyz Channel Mappings verwendet werden. Dann kann über den W Kanal die Helligkeit eingestellt werden.

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

Für mapping:

LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RGB = 6
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RBG = 9
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BRG = 33
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BGR = 36
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GRB = 18
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GBR = 24
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RGBW = 27
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RGWB = 30
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RBGW = 39
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RBWG = 45
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RWGB = 54
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RWBG = 57
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GRWB = 78
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GRBW = 75
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GBWR = 108
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GBRW = 99
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GWBR = 120
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GWRB = 114
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BRGW = 135
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BRWG = 141
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BGRW = 147
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BGWR = 156
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BWRG = 177
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BWGR = 180
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WRBG = 201
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WRGB = 198
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WGBR = 216
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WGRB = 210
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WBGR = 228
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WBRG = 225

pub fn LedStripV2Bricklet::get_channel_mapping(&self) → ConvertingReceiver<u8>¶

Rückgabe:	mapping – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 36

Gibt die aktuell genutzten Channel Mapping zurück, wie von LedStripV2Bricklet::set_channel_mapping() gesetzt.

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

Für mapping:

LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RGB = 6
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RBG = 9
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BRG = 33
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BGR = 36
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GRB = 18
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GBR = 24
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RGBW = 27
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RGWB = 30
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RBGW = 39
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RBWG = 45
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RWGB = 54
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_RWBG = 57
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GRWB = 78
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GRBW = 75
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GBWR = 108
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GBRW = 99
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GWBR = 120
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_GWRB = 114
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BRGW = 135
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BRWG = 141
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BGRW = 147
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BGWR = 156
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BWRG = 177
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_BWGR = 180
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WRBG = 201
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WRGB = 198
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WGBR = 216
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WGRB = 210
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WBGR = 228
LED_STRIP_V2_BRICKLET_CHANNEL_MAPPING_WBRG = 225

Fortgeschrittene Funktionen¶

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

Rückgabeobjekt:	error_count_ack_checksum – Typ: u32, Wertebereich: [0 bis 2³² - 1] error_count_message_checksum – Typ: u32, Wertebereich: [0 bis 2³² - 1] error_count_frame – Typ: u32, Wertebereich: [0 bis 2³² - 1] error_count_overflow – Typ: u32, Wertebereich: [0 bis 2³² - 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 LedStripV2Bricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>¶

Parameter:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

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:

LED_STRIP_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
LED_STRIP_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
LED_STRIP_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
LED_STRIP_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

pub fn LedStripV2Bricklet::get_status_led_config(&self) → ConvertingReceiver<u8>¶

Rückgabe:	config – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von LedStripV2Bricklet::set_status_led_config() gesetzt.

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

Für config:

LED_STRIP_V2_BRICKLET_STATUS_LED_CONFIG_OFF = 0
LED_STRIP_V2_BRICKLET_STATUS_LED_CONFIG_ON = 1
LED_STRIP_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
LED_STRIP_V2_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3

pub fn LedStripV2Bricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>¶

Rückgabe:	temperature – Typ: i16, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]

Gibt die Temperatur, 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 LedStripV2Bricklet::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 LedStripV2Bricklet::get_identity(&self) → ConvertingReceiver<Identity>¶

Rückgabeobjekt:

Rückgabeobjekt:	uid – Typ: String, Länge: bis zu 8 connected_uid – Typ: String, Länge: bis zu 8 position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardware_version – Typ: [u8; 3] 0: major – Typ: u8, Wertebereich: [0 bis 255] 1: minor – Typ: u8, Wertebereich: [0 bis 255] 2: revision – Typ: u8, Wertebereich: [0 bis 255] firmware_version – Typ: [u8; 3] 0: major – Typ: u8, Wertebereich: [0 bis 255] 1: minor – Typ: u8, Wertebereich: [0 bis 255] 2: revision – Typ: u8, Wertebereich: [0 bis 255] device_identifier – Typ: u16, Wertebereich: [0 bis 2¹⁶ - 1]

uid – Typ: String, Länge: bis zu 8
connected_uid – Typ: String, Länge: bis zu 8
position – Typ: char, Wertebereich: ['a' bis 'h', 'z']
hardware_version – Typ: [u8; 3]

0: major – Typ: u8, Wertebereich: [0 bis 255]
1: minor – Typ: u8, Wertebereich: [0 bis 255]
2: revision – Typ: u8, Wertebereich: [0 bis 255]

firmware_version – Typ: [u8; 3]

0: major – Typ: u8, Wertebereich: [0 bis 255]
1: minor – Typ: u8, Wertebereich: [0 bis 255]
2: revision – Typ: u8, Wertebereich: [0 bis 255]

device_identifier – Typ: u16, Wertebereich: [0 bis 2¹⁶ - 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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

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

Konfigurationsfunktionen für Callbacks¶

pub fn LedStripV2Bricklet::set_frame_started_callback_configuration(&self, enable: bool) → ConvertingReceiver<()>¶

Parameter:	enable – Typ: bool, Standardwert: true

Aktiviert/deaktiviert den LedStripV2Bricklet::get_frame_started_callback_receiver() Callback.

pub fn LedStripV2Bricklet::get_frame_started_callback_configuration(&self) → ConvertingReceiver<bool>¶

Rückgabe:	enable – Typ: bool, Standardwert: true

Gibt die Konfiguration zurück, wie von LedStripV2Bricklet::set_frame_started_callback_configuration() gesetzt.

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 LedStripV2Bricklet::get_frame_started_callback_receiver(&self) → ConvertingCallbackReceiver<u16>¶

Event:	length – Typ: u16, Wertebereich: [0 bis 6144]

Receiver die mit dieser Funktion erstellt werden, empfangen Frame Started-Events.

Dieser Callback wird direkt nachdem dem start eines Frames ausgelöst. Der empfangene Variable ist die Anzahl der LEDs in diesem Frame.

Die Daten für das nächste Frame sollten direkt nach dem auslösen dieses Callbacks übertragen werden.

Für eine Erklärung des generellen Ansatzes siehe LedStripV2Bricklet::set_led_values().

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

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

Rückgabeobjekt:	api_version – Typ: [u8; 3] 0: major – Typ: u8, Wertebereich: [0 bis 255] 1: minor – Typ: u8, Wertebereich: [0 bis 255] 2: revision – Typ: u8, Wertebereich: [0 bis 255]

Gibt die Version der API Definition 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 LedStripV2Bricklet::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 LedStripV2Bricklet::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:

LED_STRIP_V2_BRICKLET_FUNCTION_SET_LED_VALUES = 1
LED_STRIP_V2_BRICKLET_FUNCTION_SET_FRAME_DURATION = 3
LED_STRIP_V2_BRICKLET_FUNCTION_SET_CLOCK_FREQUENCY = 7
LED_STRIP_V2_BRICKLET_FUNCTION_SET_CHIP_TYPE = 9
LED_STRIP_V2_BRICKLET_FUNCTION_SET_CHANNEL_MAPPING = 11
LED_STRIP_V2_BRICKLET_FUNCTION_SET_FRAME_STARTED_CALLBACK_CONFIGURATION = 13
LED_STRIP_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
LED_STRIP_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
LED_STRIP_V2_BRICKLET_FUNCTION_RESET = 243
LED_STRIP_V2_BRICKLET_FUNCTION_WRITE_UID = 248

pub fn LedStripV2Bricklet::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.

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

Für function_id:

LED_STRIP_V2_BRICKLET_FUNCTION_SET_LED_VALUES = 1
LED_STRIP_V2_BRICKLET_FUNCTION_SET_FRAME_DURATION = 3
LED_STRIP_V2_BRICKLET_FUNCTION_SET_CLOCK_FREQUENCY = 7
LED_STRIP_V2_BRICKLET_FUNCTION_SET_CHIP_TYPE = 9
LED_STRIP_V2_BRICKLET_FUNCTION_SET_CHANNEL_MAPPING = 11
LED_STRIP_V2_BRICKLET_FUNCTION_SET_FRAME_STARTED_CALLBACK_CONFIGURATION = 13
LED_STRIP_V2_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
LED_STRIP_V2_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
LED_STRIP_V2_BRICKLET_FUNCTION_RESET = 243
LED_STRIP_V2_BRICKLET_FUNCTION_WRITE_UID = 248

pub fn LedStripV2Bricklet::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.

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

pub fn LedStripV2Bricklet::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 Bootloader- 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:

LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

LED_STRIP_V2_BRICKLET_BOOTLOADER_STATUS_OK = 0
LED_STRIP_V2_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
LED_STRIP_V2_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
LED_STRIP_V2_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
LED_STRIP_V2_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
LED_STRIP_V2_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5

pub fn LedStripV2Bricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>¶

Rückgabe:	mode – Typ: u8, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe LedStripV2Bricklet::set_bootloader_mode().

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

Für mode:

LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
LED_STRIP_V2_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

pub fn LedStripV2Bricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>¶

Parameter:	pointer – Typ: u32, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]

Setzt den Firmware-Pointer für LedStripV2Bricklet::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 LedStripV2Bricklet::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 LedStripV2Bricklet::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 LedStripV2Bricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>¶

Parameter:	uid – Typ: u32, Wertebereich: [0 bis 2³² - 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 LedStripV2Bricklet::read_uid(&self) → ConvertingReceiver<u32>¶

Rückgabe:	uid – Typ: u32, Wertebereich: [0 bis 2³² - 1]

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

Konstanten¶

pub const LedStripV2Bricklet::DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein LED Strip Bricklet 2.0 zu identifizieren.

Die LedStripV2Bricklet::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 LedStripV2Bricklet::DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines LED Strip Bricklet 2.0 dar.