Shell - Remote Switch Bricklet

Dies ist die Beschreibung der Shell 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 Shell API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Switch Socket

Download (example-switch-socket.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Remote Switch Bricklet

# 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.
tinkerforge call remote-switch-bricklet $uid switch-socket-a 17 1 switch-to-on

API

Mögliche Exit Codes für alle tinkerforge Befehle sind:

  • 1: Unterbrochen (Ctrl+C)
  • 2: Syntaxfehler
  • 21: Python 2.5 oder neuer wird benötigt
  • 22: Python argparse Modul fehlt
  • 23: Socket-Fehler
  • 24: Andere Exception
  • 25: Ungültiger Platzhalter in Format-String
  • 26: Authentifizierungsfehler
  • 201: Timeout ist aufgetreten
  • 209: Ungültiger Argumentwert
  • 210: Funktion wird nicht unterstützt
  • 211: Unbekannter Fehler

Befehlsstruktur

Allgemeine Optionen des call und des dispatch Befehls sind hier zu finden. Im Folgenden wird die spezifische Befehlsstruktur dargestellt.

tinkerforge call remote-switch-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des Remote Switch Bricklet aufzurufen. Der Befehl kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifischen call Befehl an und endet dann
  • --list-functions zeigt eine Liste der bekannten Funktionen des Remote Switch Bricklet an und endet dann
tinkerforge dispatch remote-switch-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des Remote Switch Bricklet abzufertigen. Der Befehl kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifischen dispatch Befehl an und endet dann
  • --list-callbacks zeigt eine Liste der bekannten Callbacks des Remote Switch Bricklet an und endet dann
tinkerforge call remote-switch-bricklet <uid> <function> [<option>..] [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Abhängig von der Art der aufzurufenden <function> kennt diese verschiedene Optionen. Alle Funktionen kennen die folgenden Optionen:

  • --help zeigt Hilfe für die spezifische <function> an und endet dann

Getter-Funktionen kennen zusätzlich die folgenden Optionen:

  • --execute <command> Shell-Befehl der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Setter-Funktionen kennen zusätzlich die folgenden Optionen:

  • --expect-response fragt Antwort an und wartet auf diese

Mit der --expect-response Option für Setter-Funktionen können Timeouts und andere Fehlerfälle auch für Aufrufe von Setter-Funktionen detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn diese Option für eine Setter-Funktion nicht angegeben ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

tinkerforge dispatch remote-switch-bricklet <uid> <callback> [<option>..]
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der abzufertigende <callback> kennt mehrere Optionen:

  • --help zeigt Hilfe für den spezifische <callback> an und endet dann
  • --execute <command> Shell-Befehlszeile der für jede eingehende Antwort ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)

Grundfunktionen

tinkerforge call remote-switch-bricklet <uid> switch-socket <house-code> <receiver-code> <switch-to>
Parameter:
  • <house-code> – Typ: Int, Wertebereich: [0 bis 31]
  • <receiver-code> – Typ: Int, Wertebereich: [0 bis 31]
  • <switch-to> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • keine Ausgabe

Diese Funktion ist veraltet und wurde durch switch-socket-a ersetzt.

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

Für <switch-to>:

  • switch-to-off = 0
  • switch-to-on = 1
tinkerforge call remote-switch-bricklet <uid> get-switching-state
Ausgabe:
  • 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 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 set-repeats.

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

Für state:

  • switching-state-ready = 0
  • switching-state-busy = 1
tinkerforge call remote-switch-bricklet <uid> switch-socket-a <house-code> <receiver-code> <switch-to>
Parameter:
  • <house-code> – Typ: Int, Wertebereich: [0 bis 31]
  • <receiver-code> – Typ: Int, Wertebereich: [0 bis 31]
  • <switch-to> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • keine Ausgabe

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>:

  • switch-to-off = 0
  • switch-to-on = 1

Neu in Version 2.0.1 (Plugin).

tinkerforge call remote-switch-bricklet <uid> switch-socket-b <address> <unit> <switch-to>
Parameter:
  • <address> – Typ: Int, Wertebereich: [0 bis 67108863]
  • <unit> – Typ: Int, Wertebereich: [0 bis 15, 255]
  • <switch-to> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • keine Ausgabe

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>:

  • switch-to-off = 0
  • switch-to-on = 1

Neu in Version 2.0.1 (Plugin).

tinkerforge call remote-switch-bricklet <uid> dim-socket-b <address> <unit> <dim-value>
Parameter:
  • <address> – Typ: Int, Wertebereich: [0 bis 67108863]
  • <unit> – Typ: Int, Wertebereich: [0 bis 15, 255]
  • <dim-value> – Typ: Int, Wertebereich: [0 bis 255]
Ausgabe:
  • keine Ausgabe

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).

tinkerforge call remote-switch-bricklet <uid> switch-socket-c <system-code> <device-code> <switch-to>
Parameter:
  • <system-code> – Typ: Char, Wertebereich: [A bis P]
  • <device-code> – Typ: Int, Wertebereich: [1 bis 16]
  • <switch-to> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • keine Ausgabe

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>:

  • switch-to-off = 0
  • switch-to-on = 1

Neu in Version 2.0.1 (Plugin).

Fortgeschrittene Funktionen

tinkerforge call remote-switch-bricklet <uid> set-repeats <repeats>
Parameter:
  • <repeats> – Typ: Int, Wertebereich: [0 bis 255], Standardwert: 5
Ausgabe:
  • keine Ausgabe

Setzt die Anzahl der Wiederholungen die verwendet werden um einen Code zu senden wenn eine der 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.

tinkerforge call remote-switch-bricklet <uid> get-repeats
Ausgabe:
  • repeats – Typ: Int, Wertebereich: [0 bis 255], Standardwert: 5

Gibt die Anzahl der Wiederholungen zurück, wie von set-repeats gesetzt.

tinkerforge call remote-switch-bricklet <uid> get-identity
Ausgabe:
  • 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 Array, 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 Array, 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]

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

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:

tinkerforge dispatch remote-switch-bricklet <uid> example

Die verfügbaren Callbacks werden weiter unten beschrieben.

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.

tinkerforge dispatch remote-switch-bricklet <uid> switching-done
Ausgabe:
  • keine Ausgabe

Dieser Callback wird aufgerufen wenn der Schaltzustand von busy auf ready wechselt, siehe get-switching-state.