MQTT - Remote Switch Bricklet

Dies ist die Beschreibung der MQTT API Bindings für das Remote Switch Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Remote Switch 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).

Switch Socket

Download (example-switch-socket.txt)

1
2
3
4
5
6
7
8
9
# Change XYZ to the UID of your Remote Switch Bricklet

setup:
    # Switch on a type A socket with house code 17 and receiver code 1.
    # House code 17 is 10001 in binary (least-significant bit first)
    # and means that the DIP switches 1 and 5 are on and 2-4 are off.
    # Receiver code 1 is 10000 in binary (least-significant bit first)
    # and means that the DIP switch A is on and B-E are off.
    publish '{"house_code": 17, "receiver_code": 1, "switch_to": "on"}' to tinkerforge/request/remote_switch_bricklet/XYZ/switch_socket_a 

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/remote_switch_bricklet/<UID>/switch_socket
Anfrage:
  • house_code – Typ: int, Wertebereich: [0 bis 31]
  • receiver_code – Typ: int, Wertebereich: [0 bis 31]
  • switch_to – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • keine Antwort

Diese Funktion ist veraltet und wurde durch request/remote_switch_bricklet/<UID>/switch_socket_a ersetzt.

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

Für switch_to:

  • "off" = 0
  • "on" = 1
request/remote_switch_bricklet/<UID>/get_switching_state
Anfrage:
  • keine Nutzdaten
Antwort:
  • state – Typ: int, Wertebereich: Siehe Symbole

Gibt den aktuellen Zustand des Schaltens zurück. Wenn der aktuell Zustand busy (beschäftigt) ist, sendet das Bricklet gerade einen Code um eine Steckdose zu schalten. Weitere Aufrufe von request/remote_switch_bricklet/<UID>/switch_socket werden ignoriert bis der Zustand auf ready (fertig) wechselt.

Die Länge des Schaltvorgangs ist abhängig von der Anzahl der Wiederholungen, siehe request/remote_switch_bricklet/<UID>/set_repeats.

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

Für state:

  • "ready" = 0
  • "busy" = 1
request/remote_switch_bricklet/<UID>/switch_socket_a
Anfrage:
  • house_code – Typ: int, Wertebereich: [0 bis 31]
  • receiver_code – Typ: int, Wertebereich: [0 bis 31]
  • switch_to – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • keine Antwort

Um eine Typ A Steckdose zu schalten muss der Housecode, Receivercode sowie der Zustand (an oder aus) zu dem geschaltet werden soll übergeben werden.

Eine detaillierte Beschreibung wie man den House- und Receivercode herausfinden kann gibt es hier.

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

Für switch_to:

  • "off" = 0
  • "on" = 1

Neu in Version 2.0.1 (Plugin).

request/remote_switch_bricklet/<UID>/switch_socket_b
Anfrage:
  • address – Typ: int, Wertebereich: [0 bis 67108863]
  • unit – Typ: int, Wertebereich: [0 bis 15, 255]
  • switch_to – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • keine Antwort

Um eine Typ B Steckdose zu schalten muss die Adresse und Unit sowie der Zustand (an oder aus) zu dem geschaltet werden soll übergeben werden.

Um alle Geräte mit der selben Adresse zu schalten kann die Unit auf 255 gesetzt werden.

Eine detaillierte Beschreibung wie man Adresse und Unit einer Steckdose anlernen kann gibt es hier.

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

Für switch_to:

  • "off" = 0
  • "on" = 1

Neu in Version 2.0.1 (Plugin).

request/remote_switch_bricklet/<UID>/dim_socket_b
Anfrage:
  • address – Typ: int, Wertebereich: [0 bis 67108863]
  • unit – Typ: int, Wertebereich: [0 bis 15, 255]
  • dim_value – Typ: int, Wertebereich: [0 bis 255]
Antwort:
  • keine Antwort

Um eine Typ B Dimmer zu steuern muss die Adresse und Unit sowie der Dimmwert auf der Dimmer gesetzt werden soll übergeben werden.

Eine detaillierte Beschreibung wie man Adresse und Unit einem Dimmer anlernen kann gibt es hier.

Neu in Version 2.0.1 (Plugin).

request/remote_switch_bricklet/<UID>/switch_socket_c
Anfrage:
  • system_code – Typ: char, Wertebereich: ["A" bis "P"]
  • device_code – Typ: int, Wertebereich: [1 bis 16]
  • switch_to – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • keine Antwort

Um eine Typ C Steckdose zu schalten muss der Systemcode, Gerätecode sowie der Zustand (an oder aus) zu dem geschaltet werden soll übergeben werden.

Eine detaillierte Beschreibung wie man den System- und Gerätecode herausfinden kann gibt es hier.

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

Für switch_to:

  • "off" = 0
  • "on" = 1

Neu in Version 2.0.1 (Plugin).

Fortgeschrittene Funktionen

request/remote_switch_bricklet/<UID>/set_repeats
Anfrage:
  • repeats – Typ: int, Wertebereich: [0 bis 255], Standardwert: 5
Antwort:
  • keine Antwort

Setzt die Anzahl der Wiederholungen die verwendet werden um einen Code zu senden wenn eine der request/remote_switch_bricklet/<UID>/switch_socket Funktionen aufgerufen wird. Die Wiederholungen korrespondieren zu der Zeit die eine Taste auf der Fernbedienung gedrückt wird.

Einige Dimmer werden über die Länge des Tastendrucks kontrolliert, dies kann simuliert werden indem man die Anzahl der Wiederholungen inkrementiert.

request/remote_switch_bricklet/<UID>/get_repeats
Anfrage:
  • keine Nutzdaten
Antwort:
  • repeats – Typ: int, Wertebereich: [0 bis 255], Standardwert: 5

Gibt die Anzahl der Wiederholungen zurück, wie von request/remote_switch_bricklet/<UID>/set_repeats gesetzt.

request/remote_switch_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 Remote Switch.

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/remote_switch_bricklet/<UID>/switching_done
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • keine Nutzdaten

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/remote_switch_bricklet/<UID>/switching_done[/<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/remote_switch_bricklet/<UID>/switching_done[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird aufgerufen wenn der Schaltzustand von busy auf ready wechselt, siehe request/remote_switch_bricklet/<UID>/get_switching_state.