MQTT - LED Strip Bricklet 2.0

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example-simple.txt)

1
2
3
4
5
# Change XYZ to the UID of your LED Strip Bricklet 2.0

setup:
    # Set first 3 LEDs to red, green and blue
    publish '{"index": 0, "value": [255,0,0,0,255,0,0,0,255]}' to tinkerforge/request/led_strip_v2_bricklet/XYZ/set_led_values 

Callback

Download (example-callback.txt)

1
2
3
4
5
6
7
8
9
# FIXME: This example is incomplete

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

setup:
    # Set frame duration to 50ms (20 frames per second)
    publish '{"duration": 50}' to tinkerforge/request/led_strip_v2_bricklet/XYZ/set_frame_duration 
    # Use frame started callback to move the active LED every frame
    subscribe to tinkerforge/callback/led_strip_v2_bricklet/XYZ/frame_started

API

Alle veröffentlichten Payloads an die und von den MQTT-Bindings sind im JSON Format.

Falls ein Fehler auftritt, veröffentlichen die Bindings ein JSON-Objekt, das die Fehlermeldung als _ERROR-Member enthält. Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/... für .../request/... und .../callback/... für .../register/....

Grundfunktionen

request/led_strip_v2_bricklet/<UID>/set_led_values
Anfrage:
  • index – Typ: int, Wertebereich: [0 bis 6144]
  • value – Typ: [int, ...], Länge: variabel, Wertebereich: [0 bis 255]
Antwort:
  • keine Antwort

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 request/led_strip_v2_bricklet/<UID>/set_chip_type) und das richtige Channel Mapping (siehe request/led_strip_v2_bricklet/<UID>/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 request/led_strip_v2_bricklet/<UID>/set_frame_duration).

Genereller Ansatz:

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

request/led_strip_v2_bricklet/<UID>/get_led_values
Anfrage:
  • index – Typ: int, Wertebereich: [0 bis 6144]
  • length – Typ: int, Wertebereich: [0 bis 6144]
Antwort:
  • value – Typ: [int, ...], 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).

request/led_strip_v2_bricklet/<UID>/set_frame_duration
Anfrage:
  • duration – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 100
Antwort:
  • keine Antwort

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 request/led_strip_v2_bricklet/<UID>/set_led_values.

Standardwert: 100ms (10 Frames pro Sekunde).

request/led_strip_v2_bricklet/<UID>/get_frame_duration
Anfrage:
  • keine Nutzdaten
Antwort:
  • 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 request/led_strip_v2_bricklet/<UID>/set_frame_duration gesetzt.

request/led_strip_v2_bricklet/<UID>/get_supply_voltage
Anfrage:
  • keine Nutzdaten
Antwort:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Gibt die aktuelle Versorgungsspannung der LEDs zurück.

request/led_strip_v2_bricklet/<UID>/set_clock_frequency
Anfrage:
  • frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [10000 bis 2000000], Standardwert: 1666666
Antwort:
  • keine Antwort

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 request/led_strip_v2_bricklet/<UID>/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.

request/led_strip_v2_bricklet/<UID>/get_clock_frequency
Anfrage:
  • keine Nutzdaten
Antwort:
  • frequency – Typ: int, Einheit: 1 Hz, Wertebereich: [10000 bis 2000000], Standardwert: 1666666

Gibt die aktuell genutzte Clock-Frequenz zurück, wie von request/led_strip_v2_bricklet/<UID>/set_clock_frequency gesetzt.

request/led_strip_v2_bricklet/<UID>/set_chip_type
Anfrage:
  • chip – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 2801
Antwort:
  • keine Antwort

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:

  • "ws2801" = 2801
  • "ws2811" = 2811
  • "ws2812" = 2812
  • "lpd8806" = 8806
  • "apa102" = 102
request/led_strip_v2_bricklet/<UID>/get_chip_type
Anfrage:
  • keine Nutzdaten
Antwort:
  • chip – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 2801

Gibt den aktuell genutzten Typ des Chips zurück, wie von request/led_strip_v2_bricklet/<UID>/set_chip_type gesetzt.

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

Für chip:

  • "ws2801" = 2801
  • "ws2811" = 2811
  • "ws2812" = 2812
  • "lpd8806" = 8806
  • "apa102" = 102
request/led_strip_v2_bricklet/<UID>/set_channel_mapping
Anfrage:
  • mapping – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 36
Antwort:
  • keine Antwort

Setzt das Channel Mapping für die angeschlossenen LEDs.

Falls das Mapping 4 Farben hat, erwartet die Funktion request/led_strip_v2_bricklet/<UID>/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:

  • "rgb" = 6
  • "rbg" = 9
  • "brg" = 33
  • "bgr" = 36
  • "grb" = 18
  • "gbr" = 24
  • "rgbw" = 27
  • "rgwb" = 30
  • "rbgw" = 39
  • "rbwg" = 45
  • "rwgb" = 54
  • "rwbg" = 57
  • "grwb" = 78
  • "grbw" = 75
  • "gbwr" = 108
  • "gbrw" = 99
  • "gwbr" = 120
  • "gwrb" = 114
  • "brgw" = 135
  • "brwg" = 141
  • "bgrw" = 147
  • "bgwr" = 156
  • "bwrg" = 177
  • "bwgr" = 180
  • "wrbg" = 201
  • "wrgb" = 198
  • "wgbr" = 216
  • "wgrb" = 210
  • "wbgr" = 228
  • "wbrg" = 225
request/led_strip_v2_bricklet/<UID>/get_channel_mapping
Anfrage:
  • keine Nutzdaten
Antwort:
  • mapping – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 36

Gibt die aktuell genutzten Channel Mapping zurück, wie von request/led_strip_v2_bricklet/<UID>/set_channel_mapping gesetzt.

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

Für mapping:

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

Fortgeschrittene Funktionen

request/led_strip_v2_bricklet/<UID>/get_spitfp_error_count
Anfrage:
  • keine Nutzdaten
Antwort:
  • 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.

request/led_strip_v2_bricklet/<UID>/set_bootloader_mode
Anfrage:
  • mode – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • 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" = 0
  • "firmware" = 1
  • "bootloader_wait_for_reboot" = 2
  • "firmware_wait_for_reboot" = 3
  • "firmware_wait_for_erase_and_reboot" = 4

Für status:

  • "ok" = 0
  • "invalid_mode" = 1
  • "no_change" = 2
  • "entry_function_not_present" = 3
  • "device_identifier_incorrect" = 4
  • "crc_mismatch" = 5
request/led_strip_v2_bricklet/<UID>/get_bootloader_mode
Anfrage:
  • keine Nutzdaten
Antwort:
  • mode – Typ: int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe request/led_strip_v2_bricklet/<UID>/set_bootloader_mode.

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

Für mode:

  • "bootloader" = 0
  • "firmware" = 1
  • "bootloader_wait_for_reboot" = 2
  • "firmware_wait_for_reboot" = 3
  • "firmware_wait_for_erase_and_reboot" = 4
request/led_strip_v2_bricklet/<UID>/set_write_firmware_pointer
Anfrage:
  • pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

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

request/led_strip_v2_bricklet/<UID>/write_firmware
Anfrage:
  • data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Antwort:
  • status – Typ: int, Wertebereich: [0 bis 255]

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

request/led_strip_v2_bricklet/<UID>/set_status_led_config
Anfrage:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
Antwort:
  • keine Antwort

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:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_status" = 3
request/led_strip_v2_bricklet/<UID>/get_status_led_config
Anfrage:
  • keine Nutzdaten
Antwort:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von request/led_strip_v2_bricklet/<UID>/set_status_led_config gesetzt.

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

Für config:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_status" = 3
request/led_strip_v2_bricklet/<UID>/get_chip_temperature
Anfrage:
  • keine Nutzdaten
Antwort:
  • 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.

request/led_strip_v2_bricklet/<UID>/reset
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

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.

request/led_strip_v2_bricklet/<UID>/write_uid
Anfrage:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

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.

request/led_strip_v2_bricklet/<UID>/read_uid
Anfrage:
  • keine Nutzdaten
Antwort:
  • 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.

request/led_strip_v2_bricklet/<UID>/get_identity
Anfrage:
  • keine Nutzdaten
Antwort:
  • 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, ...], 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, ...], 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]
  • _display_name – Typ: string

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. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.

Der Display Name enthält den Anzeigenamen des LED Strip 2.0.

Konfigurationsfunktionen für Callbacks

request/led_strip_v2_bricklet/<UID>/set_frame_started_callback_configuration
Anfrage:
  • enable – Typ: bool, Standardwert: true
Antwort:
  • keine Antwort

Aktiviert/deaktiviert den register/led_strip_v2_bricklet/<UID>/frame_started Callback.

request/led_strip_v2_bricklet/<UID>/get_frame_started_callback_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • enable – Typ: bool, Standardwert: true

Gibt die Konfiguration zurück, wie von request/led_strip_v2_bricklet/<UID>/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 dem entsprechenden .../register/...-Topic und einem optionalen Suffix durchgeführt werden. Mit diesem Suffix kann das Callback später deregistriert werden.

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.

register/led_strip_v2_bricklet/<UID>/frame_started
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • length – Typ: int, Wertebereich: [0 bis 6144]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/led_strip_v2_bricklet/<UID>/frame_started[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/led_strip_v2_bricklet/<UID>/frame_started[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird direkt nachdem dem start eines Frames ausgelöst. Der Payload des Callbacks 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 request/led_strip_v2_bricklet/<UID>/set_led_values.