Dies ist die Beschreibung der MQTT API Bindings für das DMX Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des DMX Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die MQTT API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
1 2 3 4 5 6 7 8 | # Change XYZ to the UID of your DMX Bricklet
setup:
# Configure Bricklet as DMX master
publish '{"dmx_mode": "master"}' to tinkerforge/request/dmx_bricklet/XYZ/set_dmx_mode
# Write DMX frame with 3 channels
publish '{"frame": [255,128,0]}' to tinkerforge/request/dmx_bricklet/XYZ/write_frame
|
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/...
.
request/
dmx_bricklet/
<UID>/
set_dmx_mode
¶Anfrage: |
|
---|---|
Antwort: |
|
Setzt den DMX Modus entweder auf Master oder Slave.
Ein Aufruf dieser Funktion setzt die Frame-Nummer auf 0.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für dmx_mode:
request/
dmx_bricklet/
<UID>/
get_dmx_mode
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt den DMX Modus zurück, wie von request/dmx_bricklet/<UID>/set_dmx_mode
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für dmx_mode:
request/
dmx_bricklet/
<UID>/
write_frame
¶Anfrage: |
|
---|---|
Antwort: |
|
Schreibt einen DMX Frame. Die maximale Framegröße ist 512 Byte. Jedes Byte stellt dabei einen Kanal dar.
Das nächste Frame kann geschrieben werden nachdem der register/dmx_bricklet/<UID>/frame_started
Callback aufgerufen wurde.
Das Frame verfügt über einen Doublebuffer, so dass ein neues Frame geschrieben werden kann, sobald das
vorherige Frame geschrieben wurde.
Die Daten werden transferiert, wenn die nächste Frame Duration abgelaufen ist, siehe
see request/dmx_bricklet/<UID>/set_frame_duration
.
Genereller Ansatz:
register/dmx_bricklet/<UID>/frame_started
Callback.register/dmx_bricklet/<UID>/frame_started
Callback.Dieser Ansatz garantiert, dass DMX Daten mit einer festen Framerate gesetzt werden.
Diese Funktion kann nur im Master Modus aufgerufen werden.
request/
dmx_bricklet/
<UID>/
read_frame
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt das letzte Frame zurück, dass von dem DMX Master geschrieben wurde. Die Größe des Arrays ist identisch zu der Anzahl der Kanäle im Frame. Jedes Byte repräsentiert ein Kanal.
Das nächste Frame ist verfügbar nachdem der register/dmx_bricklet/<UID>/frame_available
Callback aufgerufen
wurde.
Genereller Ansatz:
request/dmx_bricklet/<UID>/read_frame
um das erste Frame zu bekommen.register/dmx_bricklet/<UID>/frame_available
Callback.request/dmx_bricklet/<UID>/read_frame
um das zweite Frame zu bekommen.register/dmx_bricklet/<UID>/frame_available
Callback.Anstatt das diese Funktion gepollt wird, kann auch der register/dmx_bricklet/<UID>/frame
Callback genutzt werden.
Der Callback kann mit request/dmx_bricklet/<UID>/set_frame_callback_config
aktiviert werden.
Die frame number startet mit 0 und wird für jedes empfangene Frame erhöht.
Diese Funktion kann nur im Slave Modus aufgerufen werden.
request/
dmx_bricklet/
<UID>/
set_frame_duration
¶Anfrage: |
|
---|---|
Antwort: |
|
Setzt die Dauer eines Frames.
Beispiel: Wenn 20 Frames pro Sekunde erreicht werden sollen, muss die frame duration auf 50ms gesetzt werden (50ms * 20 = 1 Sekunde).
Soll jeweils ein Frame so schnell wie möglich gesendet werden, so sollte die frame duration auf 0 gesetzt werden.
Diese Einstellung wird nur im Master Modus genutzt.
request/
dmx_bricklet/
<UID>/
get_frame_duration
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Frame duration zurück die mittels request/dmx_bricklet/<UID>/set_frame_duration
gesetzt wurde.
request/
dmx_bricklet/
<UID>/
get_frame_error_count
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die aktuelle Anzahl an Overrun und Framing Fehlern zurück.
request/
dmx_bricklet/
<UID>/
set_communication_led_config
¶Anfrage: |
|
---|---|
Antwort: |
|
Setzt die Konfiguration der Kommunikations-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 Bootloadermodus befindet ist die LED aus.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
request/
dmx_bricklet/
<UID>/
get_communication_led_config
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Konfiguration zurück, wie von request/dmx_bricklet/<UID>/set_communication_led_config
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
request/
dmx_bricklet/
<UID>/
set_error_led_config
¶Anfrage: |
|
---|---|
Antwort: |
|
Setzt die Konfiguration der Error-LED.
Standardmäßig geht die LED an, wenn ein Error auftritt (siehe register/dmx_bricklet/<UID>/frame_error_count
Callback). Wenn diese Funktion danach nochmal mit der Show-Error-Option
aufgerufen wird, geht die LED wieder aus bis der nächste Error auftritt.
Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.
Wenn das Bricklet sich im Bootloadermodus befindet ist die LED aus.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
request/
dmx_bricklet/
<UID>/
get_error_led_config
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Konfiguration zurück, wie von request/dmx_bricklet/<UID>/set_error_led_config
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
request/
dmx_bricklet/
<UID>/
get_spitfp_error_count
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
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/
dmx_bricklet/
<UID>/
set_status_led_config
¶Anfrage: |
|
---|---|
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:
request/
dmx_bricklet/
<UID>/
get_status_led_config
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Konfiguration zurück, wie von request/dmx_bricklet/<UID>/set_status_led_config
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
request/
dmx_bricklet/
<UID>/
get_chip_temperature
¶Anfrage: |
|
---|---|
Antwort: |
|
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/
dmx_bricklet/
<UID>/
reset
¶Anfrage: |
|
---|---|
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/
dmx_bricklet/
<UID>/
get_identity
¶Anfrage: |
|
---|---|
Antwort: |
|
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. 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 DMX.
request/
dmx_bricklet/
<UID>/
set_frame_callback_config
¶Anfrage: |
|
---|---|
Antwort: |
|
Aktiviert/Deaktiviert die verschiedenen Callback. Standardmäßig sind der
register/dmx_bricklet/<UID>/frame_started
Callback und der register/dmx_bricklet/<UID>/frame_available
Callback aktiviert,
während der register/dmx_bricklet/<UID>/frame
Callback und der register/dmx_bricklet/<UID>/frame_error_count
Callback
deaktiviert sind.
Wenn der register/dmx_bricklet/<UID>/frame
Callback aktiviert wird dann kann der register/dmx_bricklet/<UID>/frame_available
Callback deaktiviert werden, da dieser dann redundant ist.
request/
dmx_bricklet/
<UID>/
get_frame_callback_config
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die Frame Callback Konfiguration zurück, wie von request/dmx_bricklet/<UID>/set_frame_callback_config
gesetzt.
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/
dmx_bricklet/
<UID>/
frame_started
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/dmx_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/dmx_bricklet/<UID>/frame_started[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird ausgelöst sobald ein neuer Frame gestartet wurde. Nachdem dieser Callback empfangen wurde sollten die Daten für den nächsten Frame geschrieben werden.
Für eine Erklärung siehe die Beschreibung in der Funktion request/dmx_bricklet/<UID>/write_frame
.
Der Callback kann mittels request/dmx_bricklet/<UID>/set_frame_callback_config
aktiviert werden.
Dieser Callback wird nur im Master Modus ausgelöst.
register/
dmx_bricklet/
<UID>/
frame_available
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/dmx_bricklet/<UID>/frame_available[/<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/dmx_bricklet/<UID>/frame_available[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird im Slave Modus ausgelöst, wenn ein neuer Frame vom DMX Master
empfangen wurde und nun ausgelesen werden kann. Der Frame muss ausgelesen werden, bevor
der Master ein neues Frame schreibt. Siehe request/dmx_bricklet/<UID>/read_frame
für weitere Details.
Der Parameter ist die Frame-Nummer, diese wird für jeden empfangenen Frame um eins erhöht.
Der Callback kann mittels request/dmx_bricklet/<UID>/set_frame_callback_config
aktiviert werden.
Dieser Callback kann nur im Slave Modus ausgelöst werden.
register/
dmx_bricklet/
<UID>/
frame
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/dmx_bricklet/<UID>/frame[/<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/dmx_bricklet/<UID>/frame[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird aufgerufen sobald ein neuer Frame verfügbar ist (vom DMX Master geschrieben).
Die Größe des Arrays ist gleichbedeutend zu der Anzahl an Kanälen in dem Frame. Jedes Byte stellt einen Kanal dar.
Der Callback kann mittels request/dmx_bricklet/<UID>/set_frame_callback_config
aktiviert werden.
Dieser Callback kann nur im Slave Modus ausgelöst werden.
Bemerkung
Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit null für frame ausgelöst.
register/
dmx_bricklet/
<UID>/
frame_error_count
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/dmx_bricklet/<UID>/frame_error_count[/<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/dmx_bricklet/<UID>/frame_error_count[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird aufgerufen wenn ein neuer Fehler auftritt. Er gibt die Anzahl der aufgetreten Overrun und Framing Fehler zurück.
Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.
request/
dmx_bricklet/
<UID>/
set_bootloader_mode
¶Anfrage: |
|
---|---|
Antwort: |
|
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:
Für status:
request/
dmx_bricklet/
<UID>/
get_bootloader_mode
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt den aktuellen Bootloader-Modus zurück, siehe request/dmx_bricklet/<UID>/set_bootloader_mode
.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für mode:
request/
dmx_bricklet/
<UID>/
set_write_firmware_pointer
¶Anfrage: |
|
---|---|
Antwort: |
|
Setzt den Firmware-Pointer für request/dmx_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/
dmx_bricklet/
<UID>/
write_firmware
¶Anfrage: |
|
---|---|
Antwort: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
request/dmx_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/
dmx_bricklet/
<UID>/
write_uid
¶Anfrage: |
|
---|---|
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/
dmx_bricklet/
<UID>/
read_uid
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.