Dies ist die Beschreibung der Shell API Bindings für das Tilt Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Tilt Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die Shell API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
1 2 3 4 5 6 7 | #!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this
uid=XYZ # Change XYZ to the UID of your Tilt Bricklet
# Get current tilt state
tinkerforge call tilt-bricklet $uid get-tilt-state
|
Download (example-callback.sh)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | #!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this
uid=XYZ # Change XYZ to the UID of your Tilt Bricklet
# Enable tilt state callback
tinkerforge call tilt-bricklet $uid enable-tilt-state-callback
# Handle incoming tilt state callbacks
tinkerforge dispatch tilt-bricklet $uid tilt-state &
echo "Press key to exit"; read dummy
kill -- -$$ # Stop callback dispatch in background
|
Mögliche Exit Codes für alle tinkerforge
Befehle sind:
argparse
Modul fehltAllgemeine Optionen des call
und des dispatch
Befehls sind
hier zu finden. Im Folgenden wird die spezifische
Befehlsstruktur dargestellt.
call
tilt-bricklet
[<option>..] <uid> <function> [<argument>..]¶Parameter: |
|
---|
Der call
Befehl wird verwendet um eine Funktion des Tilt 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 Tilt Bricklet an
und endet danndispatch
tilt-bricklet
[<option>..] <uid> <callback>¶Parameter: |
|
---|
Der dispatch
Befehl wird verwendet um eingehende Callbacks des Tilt 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 Tilt Bricklet an
und endet danntilt-bricklet
<uid> <function>
[<option>..] [<argument>..]¶Parameter: |
|
---|
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 dannGetter-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 dieseMit 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.
tilt-bricklet
<uid> <callback>
[<option>..]¶Parameter: |
|
---|
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)tilt-bricklet
<uid> get-tilt-state
¶Ausgabe: |
|
---|
Gibt den aktuellen Tilt-Zustand zurück. Der Zustand kann folgende Werte annehmen:
Die folgenden Symbole sind für diese Funktion verfügbar:
Für state:
tilt-bricklet
<uid> get-identity
¶Ausgabe: |
|
---|
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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.
Eine Liste der Device Identifier Werte ist hier zu finden.
tilt-bricklet
<uid> enable-tilt-state-callback
¶Ausgabe: |
|
---|
Aktiviert den tilt-state
Callback.
tilt-bricklet
<uid> disable-tilt-state-callback
¶Ausgabe: |
|
---|
Deaktiviert den tilt-state
Callback.
tilt-bricklet
<uid> is-tilt-state-callback-enabled
¶Ausgabe: |
|
---|
Gibt true zurück wenn der tilt-state
Callback aktiviert ist.
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:
tinkerforge dispatch tilt-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.
tilt-bricklet
<uid> tilt-state
¶Ausgabe: |
|
---|
Dieser Callback übergibt den aktuellen Tilt-Status. Der Callback wird aufgerufen wenn sich der Status ändert.
Siehe get-tilt-state
für eine Beschreibung der Zustände.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für state: