Shell - LED Strip Bricklet

Dies ist die Beschreibung der Shell 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 Shell API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example-simple.sh)

1
2
3
4
5
6
7
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your LED Strip Bricklet

# Set first 10 LEDs to green
tinkerforge call led-strip-bricklet $uid 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

API

Mögliche Exit Codes für alle tinkerforge Befehle sind:

  • 1: Unterbrochen (Ctrl+C)
  • 2: Syntaxfehler
  • 21: Python 2.5 oder neuer wird benötigt
  • 22: Python argparse Modul fehlt
  • 23: Socket-Fehler
  • 24: Andere Exception
  • 25: Ungültiger Platzhalter in Format-String
  • 26: Authentifizierungsfehler
  • 201: Timeout ist aufgetreten
  • 209: Ungültiger Argumentwert
  • 210: Funktion wird nicht unterstützt
  • 211: Unbekannter Fehler

Befehlsstruktur

Allgemeine Optionen des call und des dispatch Befehls sind hier zu finden. Im Folgenden wird die spezifische Befehlsstruktur dargestellt.

tinkerforge call led-strip-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des LED Strip Bricklet aufzurufen. Der Befehl kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifischen call Befehl an und endet dann
  • --list-functions zeigt eine Liste der bekannten Funktionen des LED Strip Bricklet an und endet dann
tinkerforge dispatch led-strip-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des LED Strip Bricklet abzufertigen. Der Befehl kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifischen dispatch Befehl an und endet dann
  • --list-callbacks zeigt eine Liste der bekannten Callbacks des LED Strip Bricklet an und endet dann
tinkerforge call led-strip-bricklet <uid> <function> [<option>..] [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Abhängig von der Art der aufzurufenden <function> kennt diese verschiedene Optionen. Alle Funktionen kennen die folgenden Optionen:

  • --help zeigt Hilfe für die spezifische <function> an und endet dann

Getter-Funktionen kennen zusätzlich die folgenden Optionen:

  • --execute <command> Shell-Befehl der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Setter-Funktionen kennen zusätzlich die folgenden Optionen:

  • --expect-response fragt Antwort an und wartet auf diese

Mit der --expect-response Option für Setter-Funktionen können Timeouts und andere Fehlerfälle auch für Aufrufe von Setter-Funktionen detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn diese Option für eine Setter-Funktion nicht angegeben ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

tinkerforge dispatch led-strip-bricklet <uid> <callback> [<option>..]
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der abzufertigende <callback> kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifische <callback> an und endet dann
  • --execute <command> Shell-Befehlszeile der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Grundfunktionen

tinkerforge call led-strip-bricklet <uid> set-rgb-values <index> <length> <r> <g> <b>
Parameter:
  • <index> – Typ: Int, Wertebereich: [0 bis 319]
  • <length> – Typ: Int, Wertebereich: [0 bis 16]
  • <r> – Typ: Int Array, Länge: 16, Wertebereich: [0 bis 255]
  • <g> – Typ: Int Array, Länge: 16, Wertebereich: [0 bis 255]
  • <b> – Typ: Int Array, Länge: 16, Wertebereich: [0 bis 255]
Ausgabe:
  • keine Ausgabe

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 (set-chip-type) und das richtige 3-Kanal Channel Mapping (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 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 frame-rendered Callback.
  • Setze alle LEDs für den nächsten Frame.
  • Warte auf frame-rendered Callback.
  • Und so weiter.

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 set-rgb-values mit index + length größer als die Begrenzung werden komplett ingnoriert.

tinkerforge call led-strip-bricklet <uid> get-rgb-values <index> <length>
Parameter:
  • <index> – Typ: Int, Wertebereich: [0 bis 319]
  • <length> – Typ: Int, Wertebereich: [0 bis 16]
Ausgabe:
  • r – Typ: Int Array, Länge: 16, Wertebereich: [0 bis 255]
  • g – Typ: Int Array, Länge: 16, Wertebereich: [0 bis 255]
  • b – Typ: Int Array, Länge: 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 set-rgb-values gesetzten Werte.

tinkerforge call led-strip-bricklet <uid> set-frame-duration <duration>
Parameter:
  • <duration> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 100
Ausgabe:
  • keine Ausgabe

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 set-rgb-values.

tinkerforge call led-strip-bricklet <uid> get-frame-duration
Ausgabe:
  • duration – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 100

Gibt die frame duration (Länge des Frames) zurück, wie von set-frame-duration gesetzt.

tinkerforge call led-strip-bricklet <uid> get-supply-voltage
Ausgabe:
  • voltage – Typ: Int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Gibt die aktuelle Versorgungsspannung der LEDs zurück.

tinkerforge call led-strip-bricklet <uid> set-clock-frequency <frequency>
Parameter:
  • <frequency> – Typ: Int, Einheit: 1 Hz, Wertebereich: [10000 bis 2000000], Standardwert: 1666666
Ausgabe:
  • keine Ausgabe

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

tinkerforge call led-strip-bricklet <uid> get-clock-frequency
Ausgabe:
  • frequency – Typ: Int, Einheit: 1 Hz, Wertebereich: [10000 bis 2000000], Standardwert: 1666666

Gibt die aktuell genutzte Clock-Frequenz zurück, wie von set-clock-frequency gesetzt.

Neu in Version 2.0.1 (Plugin).

tinkerforge call led-strip-bricklet <uid> set-chip-type <chip>
Parameter:
  • <chip> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 2801
Ausgabe:
  • keine Ausgabe

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 Symbole sind für diese Funktion verfügbar:

Für <chip>:

  • chip-type-ws2801 = 2801
  • chip-type-ws2811 = 2811
  • chip-type-ws2812 = 2812
  • chip-type-lpd8806 = 8806
  • chip-type-apa102 = 102

Neu in Version 2.0.2 (Plugin).

tinkerforge call led-strip-bricklet <uid> get-chip-type
Ausgabe:
  • chip – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 2801

Gibt den aktuell genutzten Typ des Chips zurück, wie von set-chip-type gesetzt.

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

Für chip:

  • chip-type-ws2801 = 2801
  • chip-type-ws2811 = 2811
  • chip-type-ws2812 = 2812
  • chip-type-lpd8806 = 8806
  • chip-type-apa102 = 102

Neu in Version 2.0.2 (Plugin).

tinkerforge call led-strip-bricklet <uid> set-rgbw-values <index> <length> <r> <g> <b> <w>
Parameter:
  • <index> – Typ: Int, Wertebereich: [0 bis 239]
  • <length> – Typ: Int, Wertebereich: [0 bis 12]
  • <r> – Typ: Int Array, Länge: 12, Wertebereich: [0 bis 255]
  • <g> – Typ: Int Array, Länge: 12, Wertebereich: [0 bis 255]
  • <b> – Typ: Int Array, Länge: 12, Wertebereich: [0 bis 255]
  • <w> – Typ: Int Array, Länge: 12, Wertebereich: [0 bis 255]
Ausgabe:
  • keine Ausgabe

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 (set-chip-type) und das richtige 4-Kanal Channel Mapping (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 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 frame-rendered Callback.
  • Setze alle LEDs für den nächsten Frame.
  • Warte auf frame-rendered Callback.
  • Und so weiter.

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

tinkerforge call led-strip-bricklet <uid> get-rgbw-values <index> <length>
Parameter:
  • <index> – Typ: Int, Wertebereich: [0 bis 239]
  • <length> – Typ: Int, Wertebereich: [0 bis 12]
Ausgabe:
  • r – Typ: Int Array, Länge: 12, Wertebereich: [0 bis 255]
  • g – Typ: Int Array, Länge: 12, Wertebereich: [0 bis 255]
  • b – Typ: Int Array, Länge: 12, Wertebereich: [0 bis 255]
  • w – Typ: Int Array, Länge: 12, Wertebereich: [0 bis 255]

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

Die Werte sind die letzten von set-rgbw-values gesetzten Werte.

Neu in Version 2.0.6 (Plugin).

tinkerforge call led-strip-bricklet <uid> set-channel-mapping <mapping>
Parameter:
  • <mapping> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 36
Ausgabe:
  • keine Ausgabe

Setzt das Channel Mapping für die angeschlossenene LEDs.

set-rgb-values und 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 set-rgb-values für das setzen der Farben verwendet werden. set-rgbw-values zusammen mit einem 3-Kanal Mapping führt zu falscher Darstellung der Farben. Im Gegenzug muss bei einem 4-Kanal Mapping set-rgbw-values für das setzen der Farben verwendet werden. set-rgb-values zusammen mit einem 4-Kanal Mapping führt zu falscher Darstellung der Farben.

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

Für <mapping>:

  • channel-mapping-rgb = 6
  • channel-mapping-rbg = 9
  • channel-mapping-brg = 33
  • channel-mapping-bgr = 36
  • channel-mapping-grb = 18
  • channel-mapping-gbr = 24
  • channel-mapping-rgbw = 27
  • channel-mapping-rgwb = 30
  • channel-mapping-rbgw = 39
  • channel-mapping-rbwg = 45
  • channel-mapping-rwgb = 54
  • channel-mapping-rwbg = 57
  • channel-mapping-grwb = 78
  • channel-mapping-grbw = 75
  • channel-mapping-gbwr = 108
  • channel-mapping-gbrw = 99
  • channel-mapping-gwbr = 120
  • channel-mapping-gwrb = 114
  • channel-mapping-brgw = 135
  • channel-mapping-brwg = 141
  • channel-mapping-bgrw = 147
  • channel-mapping-bgwr = 156
  • channel-mapping-bwrg = 177
  • channel-mapping-bwgr = 180
  • channel-mapping-wrbg = 201
  • channel-mapping-wrgb = 198
  • channel-mapping-wgbr = 216
  • channel-mapping-wgrb = 210
  • channel-mapping-wbgr = 228
  • channel-mapping-wbrg = 225

Neu in Version 2.0.6 (Plugin).

tinkerforge call led-strip-bricklet <uid> get-channel-mapping
Ausgabe:
  • mapping – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 36

Gibt die aktuell genutzten Channel Mapping zurück, wie von set-channel-mapping gesetzt.

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

Für mapping:

  • channel-mapping-rgb = 6
  • channel-mapping-rbg = 9
  • channel-mapping-brg = 33
  • channel-mapping-bgr = 36
  • channel-mapping-grb = 18
  • channel-mapping-gbr = 24
  • channel-mapping-rgbw = 27
  • channel-mapping-rgwb = 30
  • channel-mapping-rbgw = 39
  • channel-mapping-rbwg = 45
  • channel-mapping-rwgb = 54
  • channel-mapping-rwbg = 57
  • channel-mapping-grwb = 78
  • channel-mapping-grbw = 75
  • channel-mapping-gbwr = 108
  • channel-mapping-gbrw = 99
  • channel-mapping-gwbr = 120
  • channel-mapping-gwrb = 114
  • channel-mapping-brgw = 135
  • channel-mapping-brwg = 141
  • channel-mapping-bgrw = 147
  • channel-mapping-bgwr = 156
  • channel-mapping-bwrg = 177
  • channel-mapping-bwgr = 180
  • channel-mapping-wrbg = 201
  • channel-mapping-wrgb = 198
  • channel-mapping-wgbr = 216
  • channel-mapping-wgrb = 210
  • channel-mapping-wbgr = 228
  • channel-mapping-wbrg = 225

Neu in Version 2.0.6 (Plugin).

Fortgeschrittene Funktionen

tinkerforge call led-strip-bricklet <uid> get-identity
Ausgabe:
  • 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: Int Array, Länge: 3
    • 0: major – Typ: Int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Int, Wertebereich: [0 bis 255]
  • firmware-version – Typ: Int Array, Länge: 3
    • 0: major – Typ: Int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Int, Wertebereich: [0 bis 255]
  • device-identifier – Typ: Int, 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. 

Konfigurationsfunktionen für Callbacks

tinkerforge call led-strip-bricklet <uid> enable-frame-rendered-callback
Ausgabe:
  • keine Ausgabe

Aktiviert den frame-rendered Callback.

Standardmäßig ist der Callback aktiviert.

Neu in Version 2.0.6 (Plugin).

tinkerforge call led-strip-bricklet <uid> disable-frame-rendered-callback
Ausgabe:
  • keine Ausgabe

Deaktiviert den frame-rendered Callback.

Standardmäßig ist der Callback aktiviert.

Neu in Version 2.0.6 (Plugin).

tinkerforge call led-strip-bricklet <uid> is-frame-rendered-callback-enabled
Ausgabe:
  • enabled – Typ: Bool, Standardwert: true

Gibt true zurück falls der frame-rendered 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:

tinkerforge dispatch led-strip-bricklet <uid> example

Die verfügbaren Callbacks werden weiter unten beschrieben.

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.

tinkerforge dispatch led-strip-bricklet <uid> frame-rendered
Ausgabe:
  • length – Typ: Int, Wertebereich: [0 bis 320]

Dieser Callback wird direkt direkt nachdem ein Frame gerendert wurde ausgelöst. Der Parameter 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 set-rgb-values.