MQTT - RGB LED Matrix Bricklet

Dies ist die Beschreibung der MQTT API Bindings für das RGB LED Matrix Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des RGB LED Matrix 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).

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"-Attribut enthält. Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/... für .../request/... und .../callback/... für .../register/....

Grundfunktionen

request/rgb_led_matrix_bricklet/<UID>/set_red
Request-Payload:
 
  • red -- [int,... (x64)]

Setzt die Werte der 64 roten LEDs der Matrix.

request/rgb_led_matrix_bricklet/<UID>/get_red
Response-Payload:
 
  • red -- [int,... (x64)]

Gibt die Werte der roten LED zurück, wie von request/rgb_led_matrix_bricklet/<UID>/set_red gesetzt.

request/rgb_led_matrix_bricklet/<UID>/set_green
Request-Payload:
 
  • green -- [int,... (x64)]

Setzt die Werte der 64 grünen LEDs der Matrix.

request/rgb_led_matrix_bricklet/<UID>/get_green
Response-Payload:
 
  • green -- [int,... (x64)]

Gibt die Werte der grünen LED zurück, wie von request/rgb_led_matrix_bricklet/<UID>/set_green gesetzt.

request/rgb_led_matrix_bricklet/<UID>/set_blue
Request-Payload:
 
  • blue -- [int,... (x64)]

Setzt die Werte der 64 blauen LEDs der Matrix.

request/rgb_led_matrix_bricklet/<UID>/get_blue
Response-Payload:
 
  • blue -- [int,... (x64)]

Gibt die Werte der blauen LED zurück, wie von request/rgb_led_matrix_bricklet/<UID>/set_blue gesetzt.

request/rgb_led_matrix_bricklet/<UID>/set_frame_duration
Request-Payload:
 
  • frame_duration -- int

Setzt die Frame Duration (Dauer 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).

Setze diesen Wert auf 0 um das automatische schreiben der Frames auszustellen.

Vorgehensweise:

Für eine Frame Duration von 0 siehe request/rgb_led_matrix_bricklet/<UID>/draw_frame.

Standardwert: 0 = aus.

request/rgb_led_matrix_bricklet/<UID>/get_frame_duration
Response-Payload:
 
  • frame_duration -- int

Gibt die Frame Duration (Dauer des Frames) in ms zurück, wie von request/rgb_led_matrix_bricklet/<UID>/set_frame_duration gesetzt.

request/rgb_led_matrix_bricklet/<UID>/draw_frame

Wenn die Frame Duration (Dauer des Frames) auf 0 gesetzt ist (siehe request/rgb_led_matrix_bricklet/<UID>/set_frame_duration), dann kann diese Funktionen aufgerufen werden um den Frame auf die Matrix zu übertragen.

Vorgehensweise:

Fortgeschrittene Funktionen

request/rgb_led_matrix_bricklet/<UID>/get_supply_voltage
Response-Payload:
 
  • voltage -- int

Gibt die aktuelle Versorgungsspannung des Bricklets zurück. Die Spannung ist in mV angegeben.

request/rgb_led_matrix_bricklet/<UID>/get_spitfp_error_count
Response-Payload:
 
  • error_count_ack_checksum -- int
  • error_count_message_checksum -- int
  • error_count_frame -- int
  • error_count_overflow -- int

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/rgb_led_matrix_bricklet/<UID>/set_bootloader_mode
Request-Payload:
 
  • mode -- int (hat Symbole)
Response-Payload:
 
  • status -- int (hat 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 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 Symbole sind für diese Funktion verfügbar:

für mode:

  • "Bootloader" = 0
  • "Firmware" = 1
  • "BootloaderWaitForReboot" = 2
  • "FirmwareWaitForReboot" = 3
  • "FirmwareWaitForEraseAndReboot" = 4

für status:

  • "OK" = 0
  • "InvalidMode" = 1
  • "NoChange" = 2
  • "EntryFunctionNotPresent" = 3
  • "DeviceIdentifierIncorrect" = 4
  • "CRCMismatch" = 5
request/rgb_led_matrix_bricklet/<UID>/get_bootloader_mode
Response-Payload:
 
  • mode -- int (hat Symbole)

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

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

für mode:

  • "Bootloader" = 0
  • "Firmware" = 1
  • "BootloaderWaitForReboot" = 2
  • "FirmwareWaitForReboot" = 3
  • "FirmwareWaitForEraseAndReboot" = 4
request/rgb_led_matrix_bricklet/<UID>/set_write_firmware_pointer
Request-Payload:
 
  • pointer -- int

Setzt den Firmware-Pointer für request/rgb_led_matrix_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/rgb_led_matrix_bricklet/<UID>/write_firmware
Request-Payload:
 
  • data -- [int,... (x64)]
Response-Payload:
 
  • status -- int

Schreibt 64 Bytes Firmware an die Position die vorher von request/rgb_led_matrix_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/rgb_led_matrix_bricklet/<UID>/set_status_led_config
Request-Payload:
 
  • config -- int (hat Symbole)

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
  • "ShowHeartbeat" = 2
  • "ShowStatus" = 3
request/rgb_led_matrix_bricklet/<UID>/get_status_led_config
Response-Payload:
 
  • config -- int (hat Symbole)

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

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

für config:

  • "Off" = 0
  • "On" = 1
  • "ShowHeartbeat" = 2
  • "ShowStatus" = 3
request/rgb_led_matrix_bricklet/<UID>/get_chip_temperature
Response-Payload:
 
  • temperature -- int

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.

request/rgb_led_matrix_bricklet/<UID>/reset

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/rgb_led_matrix_bricklet/<UID>/write_uid
Request-Payload:
 
  • uid -- int

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/rgb_led_matrix_bricklet/<UID>/read_uid
Response-Payload:
 
  • uid -- int

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

request/rgb_led_matrix_bricklet/<UID>/get_identity
Response-Payload:
 
  • uid -- string
  • connected_uid -- string
  • position -- string
  • hardware_version -- [int,int,int]
  • firmware_version -- [int,int,int]
  • device_identifier -- int (hat Symbole)
  • _display_name -- 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 kann 'a', 'b', 'c' oder 'd' sein.

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 RGB LED Matrix.

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/rgb_led_matrix_bricklet/<UID>/frame_started
Request-Payload:
 
  • register -- bool
Response-Payload:
 
  • frame_number -- int

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

Dieser Callback wird aufgerufen sobald die Übertragung des Frames auf die Matrix beginnt. Die LED Werte werden in einem Doublebuffer gespeichert, so dass der nächste Frame an das Bricklet übertragen werden kann sobald dieser Callback ausgelöst wird.