Rust - LED Strip Bricklet

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

Download (example_simple.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, led_strip_bricklet::*};

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

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

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

    // Set first 10 LEDs to green
    ls.set_rgb_values(
        0,
        10,
        [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
        [255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 0, 0, 0, 0, 0, 0],
        [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
    );

    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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, led_strip_bricklet::*};

const HOST: &str = "127.0.0.1";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your LED Strip Bricklet
const NUM_LEDS: u8 = 16;

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection
    let ls = LedStripBricklet::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_rendered_receiver = ls.get_frame_rendered_callback_receiver();

    let r = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0];
    let g = [255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 0, 0, 0, 0, 0, 0];
    let mut b = [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0];
    ls.set_rgb_values(0, NUM_LEDS, r, g, b);

    // Spawn thread to handle received events.
    // This thread ends when the `ls` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        let mut r_index = 0u8;
        for _frame_rendered in frame_rendered_receiver {
            b[r_index as usize] = 0;
            if r_index == NUM_LEDS - 1 {
                r_index = 0;
            } else {
                r_index += 1;
            }
            b[r_index as usize] = 255;

            // Set new data for next render cycle
            ls.set_rgb_values(0, NUM_LEDS, r, g, b);
        }
    });

    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 LedStripBricklet::new(uid: &str, ip_connection: &IpConnection) → LedStripBricklet
Parameter:
  • uid – Typ: &str
  • ip_connection – Typ: &IPConnection
Rückgabe:
  • led_strip – Typ: LedStripBricklet

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

let led_strip = LedStripBricklet::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn LedStripBricklet::set_rgb_values(&self, index: u16, length: u8, r: [u8; 16], g: [u8; 16], b: [u8; 16]) → ConvertingReceiver<()>
Parameter:
  • index – Typ: u16, Wertebereich: [0 bis 319]
  • length – Typ: u8, Wertebereich: [0 bis 16]
  • r – Typ: [u8; 16], Wertebereich: [0 bis 255]
  • g – Typ: [u8; 16], Wertebereich: [0 bis 255]
  • b – Typ: [u8; 16], Wertebereich: [0 bis 255]

Setzt length RGB Werte für die LEDs, beginnend vom angegebenen index.

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

Beispiel: Wenn

  • index auf 5,
  • length auf 3,
  • r auf [255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
  • g auf [0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0] und
  • b auf [0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]

gesetzt wird, wird die LED an Index 5 die Farbe Rot annehmen, 6 wird Grün und 7 wird Blau.

Bemerkung

Abhängig von der internen LED Schaltung können die Farben vertauscht sein.

Die Farben werden auf die tatsächlichen LEDs transferiert wenn die nächste frame duration abgelaufen ist, siehe LedStripBricklet::set_frame_duration.

Genereller Ansatz:

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

Die effektive Anzahl steuerbarer LEDs ist abhängig von der Anzahl der freien Bricklet Ports (siehe hier). Ein Aufruf von LedStripBricklet::set_rgb_values mit index + length größer als die Begrenzung werden komplett ingnoriert.

pub fn LedStripBricklet::get_rgb_values(&self, index: u16, length: u8) → ConvertingReceiver<RgbValues>
Parameter:
  • index – Typ: u16, Wertebereich: [0 bis 319]
  • length – Typ: u8, Wertebereich: [0 bis 16]
Rückgabeobjekt:
  • r – Typ: [u8; 16], Wertebereich: [0 bis 255]
  • g – Typ: [u8; 16], Wertebereich: [0 bis 255]
  • b – Typ: [u8; 16], Wertebereich: [0 bis 255]

Gibt length R, G und B Werte zurück, beginnend von der übergebenen LED index.

Die Werte sind die letzten von LedStripBricklet::set_rgb_values gesetzten Werte.

pub fn LedStripBricklet::set_frame_duration(&self, duration: u16) → ConvertingReceiver<()>
Parameter:
  • duration – Typ: u16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 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 LedStripBricklet::set_rgb_values.

pub fn LedStripBricklet::get_frame_duration(&self) → ConvertingReceiver<u16>
Rückgabe:
  • duration – Typ: u16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 100

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

pub fn LedStripBricklet::get_supply_voltage(&self) → ConvertingReceiver<u16>
Rückgabe:
  • voltage – Typ: u16, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Gibt die aktuelle Versorgungsspannung der LEDs zurück.

pub fn LedStripBricklet::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. Der erlaubte Wertebereich beläuft von sich 10000Hz (10kHz) bis 2000000Hz (2MHz).

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

Bemerkung

Die Frequenz in Firmware Version 2.0.0 ist fest auf 2MHz gesetzt.

Neu in Version 2.0.1 (Plugin).

pub fn LedStripBricklet::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 LedStripBricklet::set_clock_frequency gesetzt.

Neu in Version 2.0.1 (Plugin).

pub fn LedStripBricklet::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),
  • LPD8806 and
  • APA102 / DotStar.

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

Für chip:

  • LED_STRIP_BRICKLET_CHIP_TYPE_WS2801 = 2801
  • LED_STRIP_BRICKLET_CHIP_TYPE_WS2811 = 2811
  • LED_STRIP_BRICKLET_CHIP_TYPE_WS2812 = 2812
  • LED_STRIP_BRICKLET_CHIP_TYPE_LPD8806 = 8806
  • LED_STRIP_BRICKLET_CHIP_TYPE_APA102 = 102

Neu in Version 2.0.2 (Plugin).

pub fn LedStripBricklet::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 LedStripBricklet::set_chip_type gesetzt.

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

Für chip:

  • LED_STRIP_BRICKLET_CHIP_TYPE_WS2801 = 2801
  • LED_STRIP_BRICKLET_CHIP_TYPE_WS2811 = 2811
  • LED_STRIP_BRICKLET_CHIP_TYPE_WS2812 = 2812
  • LED_STRIP_BRICKLET_CHIP_TYPE_LPD8806 = 8806
  • LED_STRIP_BRICKLET_CHIP_TYPE_APA102 = 102

Neu in Version 2.0.2 (Plugin).

pub fn LedStripBricklet::set_rgbw_values(&self, index: u16, length: u8, r: [u8; 12], g: [u8; 12], b: [u8; 12], w: [u8; 12]) → ConvertingReceiver<()>
Parameter:
  • index – Typ: u16, Wertebereich: [0 bis 239]
  • length – Typ: u8, Wertebereich: [0 bis 12]
  • r – Typ: [u8; 12], Wertebereich: [0 bis 255]
  • g – Typ: [u8; 12], Wertebereich: [0 bis 255]
  • b – Typ: [u8; 12], Wertebereich: [0 bis 255]
  • w – Typ: [u8; 12], Wertebereich: [0 bis 255]

Setzt length RGBW Werte für die LEDs beginnend vom angegebenen index.

Damit die Farben richtig angezeigt werden muss den LEDs der entsprechende Chip Type (LedStripBricklet::set_chip_type) und das richtige 4-Kanal Channel Mapping (LedStripBricklet::set_channel_mapping) eingestellt werden.

Beispiel: Wenn

  • index auf 5,
  • length auf 4,
  • r auf [255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
  • g auf [0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
  • b auf [0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0] und
  • w auf [0, 0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0]

gesetzt wird, wird die LED an Index 5 die Farbe Rot annehmen, 6 wird Grün, 7 wird Blau und 8 wird Weiß.

Bemerkung

Abhängig von der internen LED Schaltung können die Farben vertauscht sein.

Die Farben werden auf die tatsächlichen LEDs transferiert wenn die nächste frame duration abgelaufen ist, siehe LedStripBricklet::set_frame_duration.

Genereller Ansatz:

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

Die effektive Anzahl steuerbarer LEDs ist abhängig von der Anzahl der freien Bricklet Ports (siehe hier). Ein Aufruf von LedStripBricklet::set_rgbw_values mit index + length größer als die Begrenzung werden komplett ignoriert.

Die LPD8806 LED-Treiber-Chips haben 7-Bit Kanäle für RGB. Intern teilt das LED Strip Bricklet die 8-Bit Werte die mit dieser Funktion gesetzt werden durch 2, um daraus 7-Bit Werte zu machen. Daher kann der normale Wertebereich (0-255) auch für LPD8806 LEDs verwendet werden.

Der Helligkeitskanal der APA102 LED-Treiber-Chips hat 5-Bit. Intern teilt das LED Strip Bricklet die 8-Bit Werte die mit dieser Funktion gesetzt werden durch 8, um daraus 5-Bit Werte zu machen. Daher kann der normale Wertebereich (0-255) auch für den Helligkeitskanal von APA102 LEDs verwendet werden.

Neu in Version 2.0.6 (Plugin).

pub fn LedStripBricklet::get_rgbw_values(&self, index: u16, length: u8) → ConvertingReceiver<RgbwValues>
Parameter:
  • index – Typ: u16, Wertebereich: [0 bis 239]
  • length – Typ: u8, Wertebereich: [0 bis 12]
Rückgabeobjekt:
  • r – Typ: [u8; 12], Wertebereich: [0 bis 255]
  • g – Typ: [u8; 12], Wertebereich: [0 bis 255]
  • b – Typ: [u8; 12], Wertebereich: [0 bis 255]
  • w – Typ: [u8; 12], Wertebereich: [0 bis 255]

Gibt length RGBW Werte zurück, beginnend vom übergebenen index.

Die Werte sind die letzten von LedStripBricklet::set_rgbw_values gesetzten Werte.

Neu in Version 2.0.6 (Plugin).

pub fn LedStripBricklet::set_channel_mapping(&self, mapping: u8) → ConvertingReceiver<()>
Parameter:
  • mapping – Typ: u8, Wertebereich: Siehe Konstanten, Standardwert: 36

Setzt das Channel Mapping für die angeschlossenene LEDs.

LedStripBricklet::set_rgb_values und LedStripBricklet::set_rgbw_values nehmen die Daten in RGB(W) Reihenfolge entgegen. Aber die angeschlossenen LED-Treiber-Chips erwarten die Daten für ihre 3 oder 4 Kanäle in einer anderen Reihenfolge. 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.

Wenn ein 3-Kanal Mapping ausgewählt wurde, dann muss auch LedStripBricklet::set_rgb_values für das setzen der Farben verwendet werden. LedStripBricklet::set_rgbw_values zusammen mit einem 3-Kanal Mapping führt zu falscher Darstellung der Farben. Im Gegenzug muss bei einem 4-Kanal Mapping LedStripBricklet::set_rgbw_values für das setzen der Farben verwendet werden. LedStripBricklet::set_rgb_values zusammen mit einem 4-Kanal Mapping führt zu falscher Darstellung der Farben.

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

Für mapping:

  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_RGB = 6
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_RBG = 9
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_BRG = 33
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_BGR = 36
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_GRB = 18
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_GBR = 24
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_RGBW = 27
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_RGWB = 30
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_RBGW = 39
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_RBWG = 45
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_RWGB = 54
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_RWBG = 57
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_GRWB = 78
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_GRBW = 75
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_GBWR = 108
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_GBRW = 99
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_GWBR = 120
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_GWRB = 114
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_BRGW = 135
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_BRWG = 141
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_BGRW = 147
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_BGWR = 156
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_BWRG = 177
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_BWGR = 180
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_WRBG = 201
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_WRGB = 198
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_WGBR = 216
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_WGRB = 210
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_WBGR = 228
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_WBRG = 225

Neu in Version 2.0.6 (Plugin).

pub fn LedStripBricklet::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 LedStripBricklet::set_channel_mapping gesetzt.

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

Für mapping:

  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_RGB = 6
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_RBG = 9
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_BRG = 33
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_BGR = 36
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_GRB = 18
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_GBR = 24
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_RGBW = 27
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_RGWB = 30
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_RBGW = 39
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_RBWG = 45
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_RWGB = 54
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_RWBG = 57
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_GRWB = 78
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_GRBW = 75
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_GBWR = 108
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_GBRW = 99
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_GWBR = 120
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_GWRB = 114
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_BRGW = 135
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_BRWG = 141
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_BGRW = 147
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_BGWR = 156
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_BWRG = 177
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_BWGR = 180
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_WRBG = 201
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_WRGB = 198
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_WGBR = 216
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_WGRB = 210
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_WBGR = 228
  • LED_STRIP_BRICKLET_CHANNEL_MAPPING_WBRG = 225

Neu in Version 2.0.6 (Plugin).

Fortgeschrittene Funktionen

pub fn LedStripBricklet::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, Wertebereich: ['a' bis 'h', 'i', '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 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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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 LedStripBricklet::enable_frame_rendered_callback(&self) → ConvertingReceiver<()>

Aktiviert den LedStripBricklet::get_frame_rendered_callback_receiver Callback.

Standardmäßig ist der Callback aktiviert.

Neu in Version 2.0.6 (Plugin).

pub fn LedStripBricklet::disable_frame_rendered_callback(&self) → ConvertingReceiver<()>

Deaktiviert den LedStripBricklet::get_frame_rendered_callback_receiver Callback.

Standardmäßig ist der Callback aktiviert.

Neu in Version 2.0.6 (Plugin).

pub fn LedStripBricklet::is_frame_rendered_callback_enabled(&self) → ConvertingReceiver<bool>
Rückgabe:
  • enabled – Typ: bool, Standardwert: true

Gibt true zurück falls der LedStripBricklet::get_frame_rendered_callback_receiver Callback aktiviert ist, false sonst.

Neu in Version 2.0.6 (Plugin).

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 LedStripBricklet::get_frame_rendered_callback_receiver(&self) → ConvertingCallbackReceiver<u16>
Event:
  • length – Typ: u16, Wertebereich: [0 bis 320]

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

Dieser Callback wird direkt direkt nachdem ein Frame gerendert wurde ausgelöst. Der empfangene Variable ist die Anzahl der RGB oder RGBW 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 LedStripBricklet::set_rgb_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 LedStripBricklet::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 LedStripBricklet::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 LedStripBricklet::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_BRICKLET_FUNCTION_SET_RGB_VALUES = 1
  • LED_STRIP_BRICKLET_FUNCTION_SET_FRAME_DURATION = 3
  • LED_STRIP_BRICKLET_FUNCTION_SET_CLOCK_FREQUENCY = 7
  • LED_STRIP_BRICKLET_FUNCTION_SET_CHIP_TYPE = 9
  • LED_STRIP_BRICKLET_FUNCTION_SET_RGBW_VALUES = 11
  • LED_STRIP_BRICKLET_FUNCTION_SET_CHANNEL_MAPPING = 13
  • LED_STRIP_BRICKLET_FUNCTION_ENABLE_FRAME_RENDERED_CALLBACK = 15
  • LED_STRIP_BRICKLET_FUNCTION_DISABLE_FRAME_RENDERED_CALLBACK = 16
pub fn LedStripBricklet::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:

  • LED_STRIP_BRICKLET_FUNCTION_SET_RGB_VALUES = 1
  • LED_STRIP_BRICKLET_FUNCTION_SET_FRAME_DURATION = 3
  • LED_STRIP_BRICKLET_FUNCTION_SET_CLOCK_FREQUENCY = 7
  • LED_STRIP_BRICKLET_FUNCTION_SET_CHIP_TYPE = 9
  • LED_STRIP_BRICKLET_FUNCTION_SET_RGBW_VALUES = 11
  • LED_STRIP_BRICKLET_FUNCTION_SET_CHANNEL_MAPPING = 13
  • LED_STRIP_BRICKLET_FUNCTION_ENABLE_FRAME_RENDERED_CALLBACK = 15
  • LED_STRIP_BRICKLET_FUNCTION_DISABLE_FRAME_RENDERED_CALLBACK = 16
pub fn LedStripBricklet::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.

Konstanten

pub const LedStripBricklet::DEVICE_IDENTIFIER

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

Die LedStripBricklet::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 LedStripBricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines LED Strip Bricklet dar.