Dies ist die Beschreibung der MQTT API Bindings für das Tilt Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Tilt 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 | # Change XYZ to the UID of your Tilt Bricklet
setup:
# Get current tilt state
subscribe to tinkerforge/response/tilt_bricklet/XYZ/get_tilt_state
publish '' to tinkerforge/request/tilt_bricklet/XYZ/get_tilt_state
|
Download (example-callback.txt)
1 2 3 4 5 6 7 8 9 | # Change XYZ to the UID of your Tilt Bricklet
setup:
# Enable tilt state callback
publish '' to tinkerforge/request/tilt_bricklet/XYZ/enable_tilt_state_callback
# Handle incoming tilt state callbacks
subscribe to tinkerforge/callback/tilt_bricklet/XYZ/tilt_state
publish '{"register": true}' to tinkerforge/register/tilt_bricklet/XYZ/tilt_state # Register tilt_state 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/...
.
request/
tilt_bricklet/
<UID>/
get_tilt_state
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt den aktuellen Tilt-Zustand zurück. Der Zustand kann folgende Werte annehmen:
Die folgenden Symbole sind für diese Funktion verfügbar:
Für state:
request/
tilt_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 Tilt.
request/
tilt_bricklet/
<UID>/
enable_tilt_state_callback
¶Anfrage: |
|
---|---|
Antwort: |
|
Aktiviert den register/tilt_bricklet/<UID>/tilt_state
Callback.
request/
tilt_bricklet/
<UID>/
disable_tilt_state_callback
¶Anfrage: |
|
---|---|
Antwort: |
|
Deaktiviert den register/tilt_bricklet/<UID>/tilt_state
Callback.
request/
tilt_bricklet/
<UID>/
is_tilt_state_callback_enabled
¶Anfrage: |
|
---|---|
Antwort: |
|
Gibt true zurück wenn der register/tilt_bricklet/<UID>/tilt_state
Callback aktiviert ist.
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/
tilt_bricklet/
<UID>/
tilt_state
¶Registrierungsanfrage: |
|
---|---|
Callback-Antwort: |
|
Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/tilt_bricklet/<UID>/tilt_state[/<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/tilt_bricklet/<UID>/tilt_state[/<SUFFIX>]
-Topic veröffentlicht.
Dieser Callback übergibt den aktuellen Tilt-Status. Der Callback wird aufgerufen wenn sich der Status ändert.
Siehe request/tilt_bricklet/<UID>/get_tilt_state
für eine Beschreibung der Zustände.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für state: