Dies ist die Beschreibung der MQTT API Bindings für das Dual Button Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Dual Button 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).
Download (example-callback.txt)
1 2 3 4 5 6 | # Change XYZ to the UID of your Dual Button Bricklet
setup:
# Handle incoming state changed callbacks
subscribe to tinkerforge/callback/dual_button_bricklet/XYZ/state_changed
publish '{"register": true}' to tinkerforge/register/dual_button_bricklet/XYZ/state_changed # Register state_changed callback
|
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/...
.
Anfrage: |
|
---|---|
Antwort: |
|
Setzt den Zustand der LEDs. Möglich Zustände sind:
Im Auto-Toggle Modus wechselt die LED automatisch zwischen aus und an bei jedem Tasterdruck.
Wenn nur eine der LEDs gesetzt werden soll und der aktuelle Zustand der anderen LED
nicht bekannt ist, dann kann der Zustand mit request/dual_button_bricklet/<UID>/get_led_state
ausgelesen werden oder
es kann request/dual_button_bricklet/<UID>/set_selected_led_state
genutzt werden.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für led_l:
Für led_r:
Anfrage: |
|
---|---|
Antwort: |
|
Gibt den aktuellen Zustand der LEDs zurück, wie von request/dual_button_bricklet/<UID>/set_led_state
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für led_l:
Für led_r:
Anfrage: |
|
---|---|
Antwort: |
|
Gibt den aktuellen Zustand beider Taster zurück. Mögliche Zustände sind:
Die folgenden Symbole sind für diese Funktion verfügbar:
Für button_l:
Für button_r:
Anfrage: |
|
---|---|
Antwort: |
|
Setzt den Zustand der selektierten LED (0 oder 1).
Die andere LED bleibt unangetastet.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für led:
Für state:
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 Dual Button.
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.
Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/dual_button_bricklet/<UID>/state_changed[/<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/dual_button_bricklet/<UID>/state_changed[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback wird aufgerufen wenn einer der Taster gedrückt wird.
Mögliche Zustände der Taster sind:
Mögliche Zustände der LEDs sind:
Die folgenden Symbole sind für diese Funktion verfügbar:
Für button_l:
Für button_r:
Für led_l:
Für led_r: