Shell - LED Strip Bricklet 2.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

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> – Typ: String <function> – Typ: 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> – Typ: String <callback> – Typ: 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> – 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-v2-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-v2-bricklet <uid> set-led-values <index> <value>¶

Parameter:	<index> – Typ: Int, Wertebereich: [0 bis 6144] <value> – Typ: Int Array, Länge: variabel, Wertebereich: [0 bis 255]
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 (jeweils 6144 Byte) 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> – Typ: Int, Wertebereich: [0 bis 6144] <length> – Typ: Int, Wertebereich: [0 bis 6144]
Ausgabe:	value – Typ: Int Array, Länge: variabel, 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).

tinkerforge call led-strip-v2-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-led-values.

Standardwert: 100ms (10 Frames pro Sekunde).

tinkerforge call led-strip-v2-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-v2-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-v2-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.

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.

tinkerforge call led-strip-v2-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.

tinkerforge call led-strip-v2-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),
• WS2813 / WS2815 (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

tinkerforge call led-strip-v2-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

tinkerforge call led-strip-v2-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 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.

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

tinkerforge call led-strip-v2-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

Fortgeschrittene Funktionen¶

tinkerforge call led-strip-v2-bricklet <uid> get-spitfp-error-count¶

Ausgabe:	error-count-ack-checksum – Typ: Int, Wertebereich: [0 bis 232 - 1] error-count-message-checksum – Typ: Int, Wertebereich: [0 bis 232 - 1] error-count-frame – Typ: Int, Wertebereich: [0 bis 232 - 1] error-count-overflow – Typ: Int, Wertebereich: [0 bis 232 - 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.

tinkerforge call led-strip-v2-bricklet <uid> set-status-led-config <config>¶

Parameter:	<config> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
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:

Für <config>:

• status-led-config-off = 0
• status-led-config-on = 1
• status-led-config-show-heartbeat = 2
• status-led-config-show-status = 3

tinkerforge call led-strip-v2-bricklet <uid> get-status-led-config¶

Ausgabe:	config – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

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

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

Für config:

• status-led-config-off = 0
• status-led-config-on = 1
• status-led-config-show-heartbeat = 2
• status-led-config-show-status = 3

tinkerforge call led-strip-v2-bricklet <uid> get-chip-temperature¶

Ausgabe:	temperature – Typ: Int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 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.

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

Konfigurationsfunktionen für Callbacks¶

tinkerforge call led-strip-v2-bricklet <uid> set-frame-started-callback-configuration <enable>¶

Parameter:	<enable> – Typ: Bool, Standardwert: true
Ausgabe:	keine Ausgabe

Aktiviert/deaktiviert den frame-started Callback.

tinkerforge call led-strip-v2-bricklet <uid> get-frame-started-callback-configuration¶

Ausgabe:	enable – Typ: Bool, Standardwert: true

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.

tinkerforge dispatch led-strip-v2-bricklet <uid> frame-started¶

Ausgabe:	length – Typ: Int, Wertebereich: [0 bis 6144]

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.

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.

tinkerforge call led-strip-v2-bricklet <uid> set-bootloader-mode <mode>¶

Parameter:	<mode> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:	status – Typ: Int, Wertebereich: Siehe 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 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 Symbole sind für diese Funktion verfügbar:

Für <mode>:

• bootloader-mode-bootloader = 0
• bootloader-mode-firmware = 1
• bootloader-mode-bootloader-wait-for-reboot = 2
• bootloader-mode-firmware-wait-for-reboot = 3
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

Für status:

• bootloader-status-ok = 0
• bootloader-status-invalid-mode = 1
• bootloader-status-no-change = 2
• bootloader-status-entry-function-not-present = 3
• bootloader-status-device-identifier-incorrect = 4
• bootloader-status-crc-mismatch = 5

tinkerforge call led-strip-v2-bricklet <uid> get-bootloader-mode¶

Ausgabe:	mode – Typ: Int, Wertebereich: Siehe Symbole

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

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

Für mode:

• bootloader-mode-bootloader = 0
• bootloader-mode-firmware = 1
• bootloader-mode-bootloader-wait-for-reboot = 2
• bootloader-mode-firmware-wait-for-reboot = 3
• bootloader-mode-firmware-wait-for-erase-and-reboot = 4

tinkerforge call led-strip-v2-bricklet <uid> set-write-firmware-pointer <pointer>¶

Parameter:	<pointer> – Typ: Int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
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> – Typ: Int Array, Länge: 64, Wertebereich: [0 bis 255]
Ausgabe:	status – Typ: Int, Wertebereich: [0 bis 255]

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> write-uid <uid>¶

Parameter:	<uid> – Typ: Int, Wertebereich: [0 bis 232 - 1]
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 – Typ: Int, Wertebereich: [0 bis 232 - 1]

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