Shell - Dual Button Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Callback

Download (example-callback.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 Dual Button Bricklet

# Handle incoming state changed callbacks
tinkerforge dispatch dual-button-bricklet $uid state-changed &

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

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 dual-button-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

Der call Befehl wird verwendet um eine Funktion des Dual Button 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 Dual Button Bricklet an und endet dann
tinkerforge dispatch dual-button-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

Der dispatch Befehl wird verwendet um eingehende Callbacks des Dual Button 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 Dual Button Bricklet an und endet dann
tinkerforge call dual-button-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 dual-button-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 dual-button-bricklet <uid> set-led-state <led-l> <led-r>
Parameter:
  • <led-l> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 1
  • <led-r> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 1
Ausgabe:
  • keine Ausgabe

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 get-led-state ausgelesen werden oder es kann set-selected-led-state genutzt werden.

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

Für <led-l>:

  • led-state-auto-toggle-on = 0
  • led-state-auto-toggle-off = 1
  • led-state-on = 2
  • led-state-off = 3

Für <led-r>:

  • led-state-auto-toggle-on = 0
  • led-state-auto-toggle-off = 1
  • led-state-on = 2
  • led-state-off = 3
tinkerforge call dual-button-bricklet <uid> get-led-state
Ausgabe:
  • 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 set-led-state gesetzt.

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

Für led-l:

  • led-state-auto-toggle-on = 0
  • led-state-auto-toggle-off = 1
  • led-state-on = 2
  • led-state-off = 3

Für led-r:

  • led-state-auto-toggle-on = 0
  • led-state-auto-toggle-off = 1
  • led-state-on = 2
  • led-state-off = 3
tinkerforge call dual-button-bricklet <uid> get-button-state
Ausgabe:
  • 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:

  • button-state-pressed = 0
  • button-state-released = 1

Für button-r:

  • button-state-pressed = 0
  • button-state-released = 1

Fortgeschrittene Funktionen

tinkerforge call dual-button-bricklet <uid> set-selected-led-state <led> <state>
Parameter:
  • <led> – Typ: Int, Wertebereich: Siehe Symbole
  • <state> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • keine Ausgabe

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

  • led-left = 0
  • led-right = 1

Für <state>:

  • led-state-auto-toggle-on = 0
  • led-state-auto-toggle-off = 1
  • led-state-on = 2
  • led-state-off = 3
tinkerforge call dual-button-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 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 dual-button-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 dual-button-bricklet <uid> state-changed
Ausgabe:
  • 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

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:

  • button-state-pressed = 0
  • button-state-released = 1

Für button-r:

  • button-state-pressed = 0
  • button-state-released = 1

Für led-l:

  • led-state-auto-toggle-on = 0
  • led-state-auto-toggle-off = 1
  • led-state-on = 2
  • led-state-off = 3

Für led-r:

  • led-state-auto-toggle-on = 0
  • led-state-auto-toggle-off = 1
  • led-state-on = 2
  • led-state-off = 3