MQTT - Dual Button Bricklet

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.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Callback

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

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/dual_button_bricklet/<UID>/set_led_state
Anfrage:
  • led_l – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 1
  • led_r – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 1
Antwort:
  • keine Antwort

Setzt den Zustand der LEDs. Möglich Zustände sind:

  • 0 = AutoToggleOn: Aktiviert Auto-Toggle und anfänglich aktiviert LED
  • 1 = AutoToggleOff: Aktiviert Auto-Toggle und anfänglich deaktiviert LED.
  • 2 = On: Aktiviert LED (Auto-Toggle is deaktiviert).
  • 3 = Off: Deaktiviert LED (Auto-Toggle is deaktiviert).

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:

  • "auto_toggle_on" = 0
  • "auto_toggle_off" = 1
  • "on" = 2
  • "off" = 3

Für led_r:

  • "auto_toggle_on" = 0
  • "auto_toggle_off" = 1
  • "on" = 2
  • "off" = 3
request/dual_button_bricklet/<UID>/get_led_state
Anfrage:
  • keine Nutzdaten
Antwort:
  • led_l – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 1
  • led_r – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 1

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:

  • "auto_toggle_on" = 0
  • "auto_toggle_off" = 1
  • "on" = 2
  • "off" = 3

Für led_r:

  • "auto_toggle_on" = 0
  • "auto_toggle_off" = 1
  • "on" = 2
  • "off" = 3
request/dual_button_bricklet/<UID>/get_button_state
Anfrage:
  • keine Nutzdaten
Antwort:
  • button_l – Typ: int, Wertebereich: Siehe Symbole
  • button_r – Typ: int, Wertebereich: Siehe Symbole

Gibt den aktuellen Zustand beider Taster zurück. Mögliche Zustände sind:

  • 0 = pressed (gedrückt)
  • 1 = released (losgelassen)

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

Für button_l:

  • "pressed" = 0
  • "released" = 1

Für button_r:

  • "pressed" = 0
  • "released" = 1

Fortgeschrittene Funktionen

request/dual_button_bricklet/<UID>/set_selected_led_state
Anfrage:
  • led – Typ: int, Wertebereich: Siehe Symbole
  • state – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • keine 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:

  • "left" = 0
  • "right" = 1

Für state:

  • "auto_toggle_on" = 0
  • "auto_toggle_off" = 1
  • "on" = 2
  • "off" = 3
request/dual_button_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 Dual Button.

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/dual_button_bricklet/<UID>/state_changed
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • button_l – Typ: int, Wertebereich: Siehe Symbole
  • button_r – Typ: int, Wertebereich: Siehe Symbole
  • led_l – Typ: int, Wertebereich: Siehe Symbole
  • led_r – Typ: int, Wertebereich: Siehe Symbole

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:

  • 0 = pressed (gedrückt)
  • 1 = released (losgelassen)

Mögliche Zustände der LEDs sind:

  • 0 = AutoToggleOn: Auto-Toggle aktiv und LED an.
  • 1 = AutoToggleOff: Auto-Toggle aktiv und LED aus.
  • 2 = On: Aktiviert LED (Auto-Toggle ist deaktiviert).
  • 3 = Off: Deaktiviert LED (Auto-Toggle ist deaktiviert).

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

Für button_l:

  • "pressed" = 0
  • "released" = 1

Für button_r:

  • "pressed" = 0
  • "released" = 1

Für led_l:

  • "auto_toggle_on" = 0
  • "auto_toggle_off" = 1
  • "on" = 2
  • "off" = 3

Für led_r:

  • "auto_toggle_on" = 0
  • "auto_toggle_off" = 1
  • "on" = 2
  • "off" = 3