TCP/IP - Remote Switch Bricklet

Dies ist die Beschreibung des TCP/IP Protokolls für das Remote Switch Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Remote Switch Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API

Eine allgemeine Beschreibung der TCP/IP Protokollstruktur findet sich hier.

Grundfunktionen

BrickletRemoteSwitch.switch_socket
Funktions-ID:
  • 1
Anfrage:
  • house_code – Typ: uint8, Wertebereich: [0 bis 31]
  • receiver_code – Typ: uint8, Wertebereich: [0 bis 31]
  • switch_to – Typ: uint8, Wertebereich: Siehe Bedeutungen
Antwort:
  • keine Antwort

Diese Funktion ist veraltet und wurde durch switch_socket_a ersetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für switch_to:

  • 0 = Off
  • 1 = On
BrickletRemoteSwitch.get_switching_state
Funktions-ID:
  • 2
Anfrage:
  • keine Nutzdaten
Antwort:
  • state – Typ: uint8, Wertebereich: Siehe Bedeutungen

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 Schaltanforderungen werden ignoriert bis der Zustand auf ready (fertig) wechselt.

Die Länge des Schaltvorgangs ist abhängig von der Anzahl der Wiederholungen, siehe set_repeats.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für state:

  • 0 = Ready
  • 1 = Busy
BrickletRemoteSwitch.switch_socket_a
Funktions-ID:
  • 6
Anfrage:
  • house_code – Typ: uint8, Wertebereich: [0 bis 31]
  • receiver_code – Typ: uint8, Wertebereich: [0 bis 31]
  • switch_to – Typ: uint8, Wertebereich: Siehe Bedeutungen
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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für switch_to:

  • 0 = Off
  • 1 = On

Neu in Version 2.0.1 (Plugin).

BrickletRemoteSwitch.switch_socket_b
Funktions-ID:
  • 7
Anfrage:
  • address – Typ: uint32, Wertebereich: [0 bis 226 - 1]
  • unit – Typ: uint8, Wertebereich: [0 bis 15, 255]
  • switch_to – Typ: uint8, Wertebereich: Siehe Bedeutungen
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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für switch_to:

  • 0 = Off
  • 1 = On

Neu in Version 2.0.1 (Plugin).

BrickletRemoteSwitch.dim_socket_b
Funktions-ID:
  • 8
Anfrage:
  • address – Typ: uint32, Wertebereich: [0 bis 226 - 1]
  • unit – Typ: uint8, Wertebereich: [0 bis 15, 255]
  • dim_value – Typ: uint8, 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).

BrickletRemoteSwitch.switch_socket_c
Funktions-ID:
  • 9
Anfrage:
  • system_code – Typ: char, Wertebereich: ['A' bis 'P']
  • device_code – Typ: uint8, Wertebereich: [1 bis 16]
  • switch_to – Typ: uint8, Wertebereich: Siehe Bedeutungen
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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für switch_to:

  • 0 = Off
  • 1 = On

Neu in Version 2.0.1 (Plugin).

Fortgeschrittene Funktionen

BrickletRemoteSwitch.set_repeats
Funktions-ID:
  • 4
Anfrage:
  • repeats – Typ: uint8, 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 Schalt-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.

BrickletRemoteSwitch.get_repeats
Funktions-ID:
  • 5
Anfrage:
  • keine Nutzdaten
Antwort:
  • repeats – Typ: uint8, Wertebereich: [0 bis 255], Standardwert: 5

Gibt die Anzahl der Wiederholungen zurück, wie von set_repeats gesetzt.

BrickletRemoteSwitch.get_identity
Funktions-ID:
  • 255
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: char[8]
  • connected_uid – Typ: char[8]
  • position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • firmware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • device_identifier – Typ: uint16, Wertebereich: [0 bis 216 - 1]

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. 

Callbacks

BrickletRemoteSwitch.CALLBACK_SWITCHING_DONE
Funktions-ID:
  • 3
Antwort:
  • keine Nutzdaten

Dieser Callback wird aufgerufen wenn der Schaltzustand von busy auf ready wechselt, siehe get_switching_state.