MQTT - Tilt Bricklet

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.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example-simple.txt)

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

Callback

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

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

Grundfunktionen

request/tilt_bricklet/<UID>/get_tilt_state
Anfrage:
  • keine Nutzdaten
Antwort:
  • state – Typ: int, Wertebereich: Siehe Symbole

Gibt den aktuellen Tilt-Zustand zurück. Der Zustand kann folgende Werte annehmen:

  • 0 = Closed: Der Ball im Neigungsschalter schließt den Stromkreis.
  • 1 = Open: Der Ball im Neigungsschalter schließt den Stromkreis nicht.
  • 2 = Closed Vibrating: Der Neigungsschalter ist in Bewegung (schnelle Änderungen zwischen open und close).
Tilt-Zustände

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

Für state:

  • "closed" = 0
  • "open" = 1
  • "closed_vibrating" = 2

Fortgeschrittene Funktionen

request/tilt_bricklet/<UID>/get_identity
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: string, Länge: bis zu 8
  • connected_uid – Typ: string, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ["a" bis "h", "i", "z"]
  • hardware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • firmware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • device_identifier – Typ: int, Wertebereich: [0 bis 216 - 1]
  • _display_name – Typ: 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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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.

Konfigurationsfunktionen für Callbacks

request/tilt_bricklet/<UID>/enable_tilt_state_callback
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Aktiviert den register/tilt_bricklet/<UID>/tilt_state Callback.

request/tilt_bricklet/<UID>/disable_tilt_state_callback
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Deaktiviert den register/tilt_bricklet/<UID>/tilt_state Callback.

request/tilt_bricklet/<UID>/is_tilt_state_callback_enabled
Anfrage:
  • keine Nutzdaten
Antwort:
  • enabled – Typ: bool, Standardwert: false

Gibt true zurück wenn der register/tilt_bricklet/<UID>/tilt_state Callback aktiviert ist.

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/tilt_bricklet/<UID>/tilt_state
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • state – Typ: int, Wertebereich: Siehe Symbole

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:

  • "closed" = 0
  • "open" = 1
  • "closed_vibrating" = 2