Shell - LED Strip Bricklet 2.0

Dies ist die Beschreibung der Shell 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 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 2.0

# Set first 3 LEDs to red, green and blue
tinkerforge call led-strip-v2-bricklet $uid set-led-values 0 255,0,0,0,255,0,0,0,255

Callback

Download (example-callback.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

# FIXME: This example is incomplete

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

# Set frame duration to 50ms (20 frames per second)
tinkerforge call led-strip-v2-bricklet $uid set-frame-duration 50

# Use frame started callback to move the active LED every frame
tinkerforge dispatch led-strip-v2-bricklet $uid frame-started &

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

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-v2-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> -- string
  • <function> -- string

Der call Befehl wird verwendet um eine Funktion des LED Strip Bricklet 2.0 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 2.0 an und endet dann
tinkerforge dispatch led-strip-v2-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> -- string
  • <callback> -- string

Der dispatch Befehl wird verwendet um eingehende Callbacks des LED Strip Bricklet 2.0 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 2.0 an und endet dann
tinkerforge call led-strip-v2-bricklet <uid> <function> [<option>..] [<argument>..]
Parameter:
  • <uid> -- string
  • <function> -- 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-v2-bricklet <uid> <callback> [<option>..]
Parameter:
  • <uid> -- string
  • <callback> -- 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-v2-bricklet <uid> set-led-values <index> <value>
Parameter:
  • <index> -- int
  • <value> -- int,int,...
Ausgabe:

keine Ausgabe

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

Damit die Farben richtig angezeigt werden muss den LEDs entsprechend der richtig Chip Type (siehe set-chip-type) und das richtige Channel Mapping (siehe 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 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 frame-started Callback.
  • Setze alle LEDs für den nächsten Frame.
  • Warte auf den frame-started Callback.
  • Und so weiter.

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

tinkerforge call led-strip-v2-bricklet <uid> get-led-values <index> <length>
Parameter:
  • <index> -- int
  • <length> -- int
Ausgabe:
  • value -- int,int,...

Gibt die RGB(W) Werte zurück, wie von set-led-values gesetzt.

tinkerforge call led-strip-v2-bricklet <uid> set-frame-duration <duration>
Parameter:
  • <duration> -- int
Ausgabe:

keine Ausgabe

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

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-led-values.

Standardwert: 100ms (10 Frames pro Sekunde).

tinkerforge call led-strip-v2-bricklet <uid> get-frame-duration
Ausgabe:
  • duration -- int

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

tinkerforge call led-strip-v2-bricklet <uid> get-supply-voltage
Ausgabe:
  • voltage -- int

Gibt die aktuelle Versorgungsspannung der LEDs zurück. Die Spannung ist in mV angegeben.

tinkerforge call led-strip-v2-bricklet <uid> set-clock-frequency <frequency>
Parameter:
  • <frequency> -- int
Ausgabe:

keine Ausgabe

Setzt die Frequenz der Clock-Leitung in Hz. 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.

Der Standardwert ist 1,66MHz

tinkerforge call led-strip-v2-bricklet <uid> get-clock-frequency
Ausgabe:
  • frequency -- int

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

tinkerforge call led-strip-v2-bricklet <uid> set-chip-type <chip>
Parameter:
  • <chip> -- int (hat Symbole)
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.

Der Standardwert ist WS2801 (2801).

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

  • chip-type-ws2801 = 2801, für <chip>
  • chip-type-ws2811 = 2811, für <chip>
  • chip-type-ws2812 = 2812, für <chip>
  • chip-type-lpd8806 = 8806, für <chip>
  • chip-type-apa102 = 102, für <chip>
tinkerforge call led-strip-v2-bricklet <uid> get-chip-type
Ausgabe:
  • chip -- int (hat Symbole)

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:

  • chip-type-ws2801 = 2801, für chip
  • chip-type-ws2811 = 2811, für chip
  • chip-type-ws2812 = 2812, für chip
  • chip-type-lpd8806 = 8806, für chip
  • chip-type-apa102 = 102, für chip
tinkerforge call led-strip-v2-bricklet <uid> set-channel-mapping <mapping>
Parameter:
  • <mapping> -- int (hat Symbole)
Ausgabe:

keine Ausgabe

Setzt das Channel Mapping für die angeschlossenen LEDs.

Falls das Mapping 4 Farben hat, erwartet die Funktion 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.

Der Standardwert ist BGR (36).

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

  • channel-mapping-rgb = 6, für <mapping>
  • channel-mapping-rbg = 9, für <mapping>
  • channel-mapping-brg = 33, für <mapping>
  • channel-mapping-bgr = 36, für <mapping>
  • channel-mapping-grb = 18, für <mapping>
  • channel-mapping-gbr = 24, für <mapping>
  • channel-mapping-rgbw = 27, für <mapping>
  • channel-mapping-rgwb = 30, für <mapping>
  • channel-mapping-rbgw = 39, für <mapping>
  • channel-mapping-rbwg = 45, für <mapping>
  • channel-mapping-rwgb = 54, für <mapping>
  • channel-mapping-rwbg = 57, für <mapping>
  • channel-mapping-grwb = 78, für <mapping>
  • channel-mapping-grbw = 75, für <mapping>
  • channel-mapping-gbwr = 108, für <mapping>
  • channel-mapping-gbrw = 99, für <mapping>
  • channel-mapping-gwbr = 120, für <mapping>
  • channel-mapping-gwrb = 114, für <mapping>
  • channel-mapping-brgw = 135, für <mapping>
  • channel-mapping-brwg = 141, für <mapping>
  • channel-mapping-bgrw = 147, für <mapping>
  • channel-mapping-bgwr = 156, für <mapping>
  • channel-mapping-bwrg = 177, für <mapping>
  • channel-mapping-bwgr = 180, für <mapping>
  • channel-mapping-wrbg = 201, für <mapping>
  • channel-mapping-wrgb = 198, für <mapping>
  • channel-mapping-wgbr = 216, für <mapping>
  • channel-mapping-wgrb = 210, für <mapping>
  • channel-mapping-wbgr = 228, für <mapping>
  • channel-mapping-wbrg = 225, für <mapping>
tinkerforge call led-strip-v2-bricklet <uid> get-channel-mapping
Ausgabe:
  • mapping -- int (hat Symbole)

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

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

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

Fortgeschrittene Funktionen

tinkerforge call led-strip-v2-bricklet <uid> get-spitfp-error-count
Ausgabe:
  • error-count-ack-checksum -- int
  • error-count-message-checksum -- int
  • error-count-frame -- int
  • error-count-overflow -- int

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.

tinkerforge call led-strip-v2-bricklet <uid> set-bootloader-mode <mode>
Parameter:
  • <mode> -- int (hat Symbole)
Ausgabe:
  • status -- int (hat Symbole)

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

  • bootloader-mode-bootloader = 0, für <mode>
  • bootloader-mode-firmware = 1, für <mode>
  • bootloader-mode-bootloader-wait-for-reboot = 2, für <mode>
  • bootloader-mode-firmware-wait-for-reboot = 3, für <mode>
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4, für <mode>
  • bootloader-status-ok = 0, für status
  • bootloader-status-invalid-mode = 1, für status
  • bootloader-status-no-change = 2, für status
  • bootloader-status-entry-function-not-present = 3, für status
  • bootloader-status-device-identifier-incorrect = 4, für status
  • bootloader-status-crc-mismatch = 5, für status
tinkerforge call led-strip-v2-bricklet <uid> get-bootloader-mode
Ausgabe:
  • mode -- int (hat Symbole)

Gibt den aktuellen Bootloader-Modus zurück, siehe set-bootloader-mode.

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

  • bootloader-mode-bootloader = 0, für mode
  • bootloader-mode-firmware = 1, für mode
  • bootloader-mode-bootloader-wait-for-reboot = 2, für mode
  • bootloader-mode-firmware-wait-for-reboot = 3, für mode
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4, für mode
tinkerforge call led-strip-v2-bricklet <uid> set-write-firmware-pointer <pointer>
Parameter:
  • <pointer> -- int
Ausgabe:

keine Ausgabe

Setzt den Firmware-Pointer für 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.

tinkerforge call led-strip-v2-bricklet <uid> write-firmware <data>
Parameter:
  • <data> -- int,int,..61x..,int
Ausgabe:
  • status -- int

Schreibt 64 Bytes Firmware an die Position die vorher von 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.

tinkerforge call led-strip-v2-bricklet <uid> set-status-led-config <config>
Parameter:
  • <config> -- int (hat Symbole)
Ausgabe:

keine Ausgabe

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

  • status-led-config-off = 0, für <config>
  • status-led-config-on = 1, für <config>
  • status-led-config-show-heartbeat = 2, für <config>
  • status-led-config-show-status = 3, für <config>
tinkerforge call led-strip-v2-bricklet <uid> get-status-led-config
Ausgabe:
  • config -- int (hat Symbole)

Gibt die Konfiguration zurück, wie von set-status-led-config gesetzt.

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

  • status-led-config-off = 0, für config
  • status-led-config-on = 1, für config
  • status-led-config-show-heartbeat = 2, für config
  • status-led-config-show-status = 3, für config
tinkerforge call led-strip-v2-bricklet <uid> get-chip-temperature
Ausgabe:
  • temperature -- int

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.

tinkerforge call led-strip-v2-bricklet <uid> reset
Ausgabe:keine Ausgabe

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.

tinkerforge call led-strip-v2-bricklet <uid> write-uid <uid>
Parameter:
  • <uid> -- int
Ausgabe:

keine Ausgabe

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.

tinkerforge call led-strip-v2-bricklet <uid> read-uid
Ausgabe:
  • uid -- int

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

tinkerforge call led-strip-v2-bricklet <uid> get-identity
Ausgabe:
  • uid -- string
  • connected-uid -- string
  • position -- char
  • hardware-version -- int,int,int
  • firmware-version -- int,int,int
  • device-identifier -- int (hat Symbole)

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. 

Konfigurationsfunktionen für Callbacks

tinkerforge call led-strip-v2-bricklet <uid> set-frame-started-callback-configuration <enable>
Parameter:
  • <enable> -- bool
Ausgabe:

keine Ausgabe

Aktiviert/deaktiviert den frame-started Callback.

Standardmäßig ist der Callback aktiviert.

tinkerforge call led-strip-v2-bricklet <uid> get-frame-started-callback-configuration
Ausgabe:
  • enable -- bool

Gibt die Konfiguration zurück, wie von set-frame-started-callback-configuration gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:

tinkerforge dispatch led-strip-v2-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-v2-bricklet <uid> frame-started
Ausgabe:
  • length -- int

Dieser Callback wird direkt nachdem dem start eines Frames ausgelöst. Der Parameter 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 set-led-values.