Modbus - LED Strip Bricklet 2.0

Dies ist die Beschreibung des Modbus Protokolls 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.

API

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen

BrickletLEDStripV2.set_led_values_low_level
Funktions ID:

1

Anfrage:
  • index -- uint16
  • value_length -- uint16
  • value_chunk_offset -- uint16
  • value_chunk_data -- uint8[58]
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 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 CALLBACK_FRAME_STARTED Callback.
  • Setze alle LEDs für den nächsten Frame.
  • Warte auf den CALLBACK_FRAME_STARTED Callback.
  • Und so weiter.

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

BrickletLEDStripV2.get_led_values_low_level
Funktions ID:

2

Anfrage:
  • index -- uint16
  • length -- uint16
Antwort:
  • value_length -- uint16
  • value_chunk_offset -- uint16
  • value_chunk_data -- uint8[60]

Gibt die RGB(W) Werte zurück, wie von set_led_values_low_level gesetzt.

BrickletLEDStripV2.set_frame_duration
Funktions ID:

3

Anfrage:
  • duration -- uint16
Antwort:

keine Antwort

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

Standardwert: 100ms (10 Frames pro Sekunde).

BrickletLEDStripV2.get_frame_duration
Funktions ID:

4

Anfrage:

keine Nutzdaten

Antwort:
  • duration -- uint16

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

BrickletLEDStripV2.get_supply_voltage
Funktions ID:

5

Anfrage:

keine Nutzdaten

Antwort:
  • voltage -- uint16

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

BrickletLEDStripV2.set_clock_frequency
Funktions ID:

7

Anfrage:
  • frequency -- uint32
Antwort:

keine Antwort

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

BrickletLEDStripV2.get_clock_frequency
Funktions ID:

8

Anfrage:

keine Nutzdaten

Antwort:
  • frequency -- uint32

Gibt die aktuell genutzte Clock-Frequenz zurück, wie von set_clock_frequency gesetzt.

BrickletLEDStripV2.set_chip_type
Funktions ID:

9

Anfrage:
  • chip -- uint16
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.

Der Standardwert ist WS2801 (2801).

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

  • 2801: ws2801, für chip
  • 2811: ws2811, für chip
  • 2812: ws2812, für chip
  • 8806: lpd8806, für chip
  • 102: apa102, für chip
BrickletLEDStripV2.get_chip_type
Funktions ID:

10

Anfrage:

keine Nutzdaten

Antwort:
  • chip -- uint16

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

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

  • 2801: ws2801, für chip
  • 2811: ws2811, für chip
  • 2812: ws2812, für chip
  • 8806: lpd8806, für chip
  • 102: apa102, für chip
BrickletLEDStripV2.set_channel_mapping
Funktions ID:

11

Anfrage:
  • mapping -- uint8
Antwort:

keine Antwort

Setzt das Channel Mapping für die angeschlossenen LEDs.

Falls das Mapping 4 Farben hat, erwartet die Funktion set_led_values_low_level 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 Bedeutungen sind für die Parameter dieser Funktion definiert:

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

12

Anfrage:

keine Nutzdaten

Antwort:
  • mapping -- uint8

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

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

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

Fortgeschrittene Funktionen

BrickletLEDStripV2.get_spitfp_error_count
Funktions ID:

234

Anfrage:

keine Nutzdaten

Antwort:
  • error_count_ack_checksum -- uint32
  • error_count_message_checksum -- uint32
  • error_count_frame -- uint32
  • error_count_overflow -- uint32

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.

BrickletLEDStripV2.set_bootloader_mode
Funktions ID:

235

Anfrage:
  • mode -- uint8
Antwort:
  • status -- uint8

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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: bootloader, für mode
  • 1: firmware, für mode
  • 2: bootloader wait for reboot, für mode
  • 3: firmware wait for reboot, für mode
  • 4: firmware wait for erase and reboot, für mode
  • 0: ok, für status
  • 1: invalid mode, für status
  • 2: no change, für status
  • 3: entry function not present, für status
  • 4: device identifier incorrect, für status
  • 5: crc mismatch, für status
BrickletLEDStripV2.get_bootloader_mode
Funktions ID:

236

Anfrage:

keine Nutzdaten

Antwort:
  • mode -- uint8

Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode.

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

  • 0: bootloader, für mode
  • 1: firmware, für mode
  • 2: bootloader wait for reboot, für mode
  • 3: firmware wait for reboot, für mode
  • 4: firmware wait for erase and reboot, für mode
BrickletLEDStripV2.set_write_firmware_pointer
Funktions ID:

237

Anfrage:
  • pointer -- uint32
Antwort:

keine Antwort

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.

BrickletLEDStripV2.write_firmware
Funktions ID:

238

Anfrage:
  • data -- uint8[64]
Antwort:
  • status -- uint8

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.

BrickletLEDStripV2.set_status_led_config
Funktions ID:

239

Anfrage:
  • config -- uint8
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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show status, für config
BrickletLEDStripV2.get_status_led_config
Funktions ID:

240

Anfrage:

keine Nutzdaten

Antwort:
  • config -- uint8

Gibt die Konfiguration zurück, wie von set_status_led_config gesetzt.

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

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show status, für config
BrickletLEDStripV2.get_chip_temperature
Funktions ID:

242

Anfrage:

keine Nutzdaten

Antwort:
  • temperature -- int16

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.

BrickletLEDStripV2.reset
Funktions ID:243
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.

BrickletLEDStripV2.write_uid
Funktions ID:

248

Anfrage:
  • uid -- uint32
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.

BrickletLEDStripV2.read_uid
Funktions ID:

249

Anfrage:

keine Nutzdaten

Antwort:
  • uid -- uint32

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

BrickletLEDStripV2.get_identity
Funktions ID:

255

Anfrage:

keine Nutzdaten

Antwort:
  • uid -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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

BrickletLEDStripV2.set_frame_started_callback_configuration
Funktions ID:

13

Anfrage:
  • enable -- bool
Antwort:

keine Antwort

Aktiviert/deaktiviert den CALLBACK_FRAME_STARTED Callback.

Standardmäßig ist der Callback aktiviert.

BrickletLEDStripV2.get_frame_started_callback_configuration
Funktions ID:

14

Anfrage:

keine Nutzdaten

Antwort:
  • enable -- bool

Gibt die Konfiguration zurück, wie von set_frame_started_callback_configuration gesetzt.

Callbacks

BrickletLEDStripV2.CALLBACK_FRAME_STARTED
Funktions ID:

6

Antwort:
  • length -- uint16

Dieser Callback wird direkt nachdem dem start eines Frames ausgelöst. Der Rückgabewert 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_low_level.