Spezifikationen / Modbus Protokoll / API / Bricklets (Abgekündigt) / LED Strip Bricklet

Modbus - LED Strip Bricklet¶

Dies ist die Beschreibung des Modbus Protokolls für das LED Strip Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des LED Strip Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API¶

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen¶

BrickletLEDStrip.set_rgb_values¶

Funktions-ID:	1
Anfrage:	index – Typ: uint16, Wertebereich: [0 bis 319] length – Typ: uint8, Wertebereich: [0 bis 16] r – Typ: uint8[16], Wertebereich: [0 bis 255] g – Typ: uint8[16], Wertebereich: [0 bis 255] b – Typ: uint8[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 (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 CALLBACK_FRAME_RENDERED Callback.
Setze alle LEDs für den nächsten Frame.
Warte auf CALLBACK_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.

BrickletLEDStrip.get_rgb_values¶

Funktions-ID:	2
Anfrage:	index – Typ: uint16, Wertebereich: [0 bis 319] length – Typ: uint8, Wertebereich: [0 bis 16]
Antwort:	r – Typ: uint8[16], Wertebereich: [0 bis 255] g – Typ: uint8[16], Wertebereich: [0 bis 255] b – Typ: uint8[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.

BrickletLEDStrip.set_frame_duration¶

Funktions-ID:	3
Anfrage:	duration – Typ: uint16, Einheit: 1 ms, Wertebereich: [0 bis 2¹⁶ - 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 set_rgb_values.

BrickletLEDStrip.get_frame_duration¶

Funktions-ID:	4
Anfrage:	keine Nutzdaten
Antwort:	duration – Typ: uint16, Einheit: 1 ms, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 100

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

BrickletLEDStrip.get_supply_voltage¶

Funktions-ID:	5
Anfrage:	keine Nutzdaten
Antwort:	voltage – Typ: uint16, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt die aktuelle Versorgungsspannung der LEDs zurück.

BrickletLEDStrip.set_clock_frequency¶

Funktions-ID:	7
Anfrage:	frequency – Typ: uint32, 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 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).

BrickletLEDStrip.get_clock_frequency¶

Funktions-ID:	8
Anfrage:	keine Nutzdaten
Antwort:	frequency – Typ: uint32, 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).

BrickletLEDStrip.set_chip_type¶

Funktions-ID:	9
Anfrage:	chip – Typ: uint16, Wertebereich: Siehe Bedeutungen, 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.

Neu in Version 2.0.2 (Plugin).

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für chip:

2801 = WS2801
2811 = WS2811
2812 = WS2812
8806 = LPD8806
102 = APA102

BrickletLEDStrip.get_chip_type¶

Funktions-ID:	10
Anfrage:	keine Nutzdaten
Antwort:	chip – Typ: uint16, Wertebereich: Siehe Bedeutungen, Standardwert: 2801

Gibt den aktuell genutzten Typ des Chips zurück, wie von set_chip_type gesetzt.

Neu in Version 2.0.2 (Plugin).

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für chip:

2801 = WS2801
2811 = WS2811
2812 = WS2812
8806 = LPD8806
102 = APA102

BrickletLEDStrip.set_rgbw_values¶

Funktions-ID:	11
Anfrage:	index – Typ: uint16, Wertebereich: [0 bis 239] length – Typ: uint8, Wertebereich: [0 bis 12] r – Typ: uint8[12], Wertebereich: [0 bis 255] g – Typ: uint8[12], Wertebereich: [0 bis 255] b – Typ: uint8[12], Wertebereich: [0 bis 255] w – Typ: uint8[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 (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 CALLBACK_FRAME_RENDERED Callback.
Setze alle LEDs für den nächsten Frame.
Warte auf CALLBACK_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).

BrickletLEDStrip.get_rgbw_values¶

Funktions-ID:	12
Anfrage:	index – Typ: uint16, Wertebereich: [0 bis 239] length – Typ: uint8, Wertebereich: [0 bis 12]
Antwort:	r – Typ: uint8[12], Wertebereich: [0 bis 255] g – Typ: uint8[12], Wertebereich: [0 bis 255] b – Typ: uint8[12], Wertebereich: [0 bis 255] w – Typ: uint8[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).

BrickletLEDStrip.set_channel_mapping¶

Funktions-ID:	13
Anfrage:	mapping – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 36
Antwort:	keine Antwort

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.

Neu in Version 2.0.6 (Plugin).

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für mapping:

6 = RGB
9 = RBG
33 = BRG
36 = BGR
18 = GRB
24 = GBR
27 = RGBW
30 = RGWB
39 = RBGW
45 = RBWG
54 = RWGB
57 = RWBG
78 = GRWB
75 = GRBW
108 = GBWR
99 = GBRW
120 = GWBR
114 = GWRB
135 = BRGW
141 = BRWG
147 = BGRW
156 = BGWR
177 = BWRG
180 = BWGR
201 = WRBG
198 = WRGB
216 = WGBR
210 = WGRB
228 = WBGR
225 = WBRG

BrickletLEDStrip.get_channel_mapping¶

Funktions-ID:	14
Anfrage:	keine Nutzdaten
Antwort:	mapping – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 36

Gibt die aktuell genutzten Channel Mapping zurück, wie von set_channel_mapping gesetzt.

Neu in Version 2.0.6 (Plugin).

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für mapping:

6 = RGB
9 = RBG
33 = BRG
36 = BGR
18 = GRB
24 = GBR
27 = RGBW
30 = RGWB
39 = RBGW
45 = RBWG
54 = RWGB
57 = RWBG
78 = GRWB
75 = GRBW
108 = GBWR
99 = GBRW
120 = GWBR
114 = GWRB
135 = BRGW
141 = BRWG
147 = BGRW
156 = BGWR
177 = BWRG
180 = BWGR
201 = WRBG
198 = WRGB
216 = WGBR
210 = WGRB
228 = WBGR
225 = WBRG

Fortgeschrittene Funktionen¶

BrickletLEDStrip.get_identity¶

Funktions-ID:	255
Anfrage:	keine Nutzdaten
Antwort:	uid – Typ: char[8] connected_uid – Typ: char[8] position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardware_version – Typ: uint8[3] 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] firmware_version – Typ: uint8[3] 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] device_identifier – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 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¶

BrickletLEDStrip.enable_frame_rendered_callback¶

Funktions-ID:	15
Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

Aktiviert den CALLBACK_FRAME_RENDERED Callback.

Standardmäßig ist der Callback aktiviert.

Neu in Version 2.0.6 (Plugin).

BrickletLEDStrip.disable_frame_rendered_callback¶

Funktions-ID:	16
Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

Deaktiviert den CALLBACK_FRAME_RENDERED Callback.

Standardmäßig ist der Callback aktiviert.

Neu in Version 2.0.6 (Plugin).

BrickletLEDStrip.is_frame_rendered_callback_enabled¶

Funktions-ID:	17
Anfrage:	keine Nutzdaten
Antwort:	enabled – Typ: bool, Standardwert: true

Gibt true zurück falls der CALLBACK_FRAME_RENDERED Callback aktiviert ist, false sonst.

Neu in Version 2.0.6 (Plugin).

Callbacks¶

BrickletLEDStrip.CALLBACK_FRAME_RENDERED¶

Funktions-ID:	6
Antwort:	length – Typ: uint16, Wertebereich: [0 bis 320]

Dieser Callback wird direkt direkt nachdem ein Frame gerendert wurde ausgelöst. Der Rückgabewert 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.