MQTT - LED Strip Bricklet

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

setup:
    # Set first 10 LEDs to green
    publish '{"index": 0, "length": 10, "r": [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0], "g": [255,255,255,255,255,255,255,255,255,255,0,0,0,0,0,0], "b": [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0]}' to tinkerforge/request/led_strip_bricklet/XYZ/set_rgb_values 

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_bricklet/<UID>/set_rgb_values
Anfrage:
  • index – Typ: int, Wertebereich: [0 bis 319]
  • length – Typ: int, Wertebereich: [0 bis 16]
  • r – Typ: [int, ...], Länge: 16, Wertebereich: [0 bis 255]
  • g – Typ: [int, ...], Länge: 16, Wertebereich: [0 bis 255]
  • b – Typ: [int, ...], Länge: 16, Wertebereich: [0 bis 255]
Antwort:
  • keine Antwort

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 (request/led_strip_bricklet/<UID>/set_chip_type) und das richtige 3-Kanal Channel Mapping (request/led_strip_bricklet/<UID>/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 request/led_strip_bricklet/<UID>/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 request/led_strip_bricklet/<UID>/set_rgb_values mit index + length größer als die Begrenzung werden komplett ingnoriert.

request/led_strip_bricklet/<UID>/get_rgb_values
Anfrage:
  • index – Typ: int, Wertebereich: [0 bis 319]
  • length – Typ: int, Wertebereich: [0 bis 16]
Antwort:
  • r – Typ: [int, ...], Länge: 16, Wertebereich: [0 bis 255]
  • g – Typ: [int, ...], Länge: 16, Wertebereich: [0 bis 255]
  • b – Typ: [int, ...], 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 request/led_strip_bricklet/<UID>/set_rgb_values gesetzten Werte.

request/led_strip_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_bricklet/<UID>/set_rgb_values.

request/led_strip_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_bricklet/<UID>/set_frame_duration gesetzt.

request/led_strip_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_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. 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 request/led_strip_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.

Bemerkung

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

Neu in Version 2.0.1 (Plugin).

request/led_strip_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_bricklet/<UID>/set_clock_frequency gesetzt.

Neu in Version 2.0.1 (Plugin).

request/led_strip_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),
  • 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

Neu in Version 2.0.2 (Plugin).

request/led_strip_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_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

Neu in Version 2.0.2 (Plugin).

request/led_strip_bricklet/<UID>/set_rgbw_values
Anfrage:
  • index – Typ: int, Wertebereich: [0 bis 239]
  • length – Typ: int, Wertebereich: [0 bis 12]
  • r – Typ: [int, ...], Länge: 12, Wertebereich: [0 bis 255]
  • g – Typ: [int, ...], Länge: 12, Wertebereich: [0 bis 255]
  • b – Typ: [int, ...], Länge: 12, Wertebereich: [0 bis 255]
  • w – Typ: [int, ...], Länge: 12, Wertebereich: [0 bis 255]
Antwort:
  • keine Antwort

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 (request/led_strip_bricklet/<UID>/set_chip_type) und das richtige 4-Kanal Channel Mapping (request/led_strip_bricklet/<UID>/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 request/led_strip_bricklet/<UID>/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 request/led_strip_bricklet/<UID>/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).

request/led_strip_bricklet/<UID>/get_rgbw_values
Anfrage:
  • index – Typ: int, Wertebereich: [0 bis 239]
  • length – Typ: int, Wertebereich: [0 bis 12]
Antwort:
  • r – Typ: [int, ...], Länge: 12, Wertebereich: [0 bis 255]
  • g – Typ: [int, ...], Länge: 12, Wertebereich: [0 bis 255]
  • b – Typ: [int, ...], Länge: 12, Wertebereich: [0 bis 255]
  • w – Typ: [int, ...], Länge: 12, Wertebereich: [0 bis 255]

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

Die Werte sind die letzten von request/led_strip_bricklet/<UID>/set_rgbw_values gesetzten Werte.

Neu in Version 2.0.6 (Plugin).

request/led_strip_bricklet/<UID>/set_channel_mapping
Anfrage:
  • mapping – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 36
Antwort:
  • keine Antwort

Setzt das Channel Mapping für die angeschlossenene LEDs.

request/led_strip_bricklet/<UID>/set_rgb_values und request/led_strip_bricklet/<UID>/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 request/led_strip_bricklet/<UID>/set_rgb_values für das setzen der Farben verwendet werden. request/led_strip_bricklet/<UID>/set_rgbw_values zusammen mit einem 3-Kanal Mapping führt zu falscher Darstellung der Farben. Im Gegenzug muss bei einem 4-Kanal Mapping request/led_strip_bricklet/<UID>/set_rgbw_values für das setzen der Farben verwendet werden. request/led_strip_bricklet/<UID>/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:

  • "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

Neu in Version 2.0.6 (Plugin).

request/led_strip_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_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

Neu in Version 2.0.6 (Plugin).

Fortgeschrittene Funktionen

request/led_strip_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.

Konfigurationsfunktionen für Callbacks

request/led_strip_bricklet/<UID>/enable_frame_rendered_callback
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Aktiviert den register/led_strip_bricklet/<UID>/frame_rendered Callback.

Standardmäßig ist der Callback aktiviert.

Neu in Version 2.0.6 (Plugin).

request/led_strip_bricklet/<UID>/disable_frame_rendered_callback
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Deaktiviert den register/led_strip_bricklet/<UID>/frame_rendered Callback.

Standardmäßig ist der Callback aktiviert.

Neu in Version 2.0.6 (Plugin).

request/led_strip_bricklet/<UID>/is_frame_rendered_callback_enabled
Anfrage:
  • keine Nutzdaten
Antwort:
  • enabled – Typ: bool, Standardwert: true

Gibt true zurück falls der register/led_strip_bricklet/<UID>/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. 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_bricklet/<UID>/frame_rendered
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • length – Typ: int, Wertebereich: [0 bis 320]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/led_strip_bricklet/<UID>/frame_rendered[/<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_bricklet/<UID>/frame_rendered[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird direkt direkt nachdem ein Frame gerendert wurde ausgelöst. Der Payload des Callbacks 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 request/led_strip_bricklet/<UID>/set_rgb_values.