Shell - Joystick Bricklet

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

Simple

Download (example-simple.sh)

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 Joystick Bricklet

# Get current position
tinkerforge call joystick-bricklet $uid get-position

Callback

Download (example-callback.sh)

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

uid=XYZ # Change XYZ to the UID of your Joystick Bricklet

# Handle incoming pressed callbacks
tinkerforge dispatch joystick-bricklet $uid pressed\
 --execute "echo Pressed" &

# Handle incoming released callbacks
tinkerforge dispatch joystick-bricklet $uid released\
 --execute "echo Released" &

echo "Press key to exit"; read dummy

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

Find Borders

Download (example-find-borders.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Joystick Bricklet

# Get threshold callbacks with a debounce time of 0.2 seconds (200ms)
tinkerforge call joystick-bricklet $uid set-debounce-period 200

# Handle incoming position reached callbacks
tinkerforge dispatch joystick-bricklet $uid position-reached\
 --execute "if   [ {y} -eq 100 ];
            then echo Top;
            elif [ {y} -eq -100 ];
            then echo Bottom;
            fi;
            if   [ {x} -eq 100 ];
            then echo Right;
            elif [ {x} -eq -100 ];
            then echo Left;
            fi" &

# Configure threshold for position "outside of -99, -99 to 99, 99"
tinkerforge call joystick-bricklet $uid set-position-callback-threshold threshold-option-outside -99 99 -99 99

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 joystick-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> -- string
  • <function> -- string

Der call Befehl wird verwendet um eine Funktion des Joystick 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 Joystick Bricklet an und endet dann
tinkerforge dispatch joystick-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> -- string
  • <callback> -- string

Der dispatch Befehl wird verwendet um eingehende Callbacks des Joystick 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 Joystick Bricklet an und endet dann
tinkerforge call joystick-bricklet <uid> <function> [<option>..] [<argument>..]
Parameter:
  • <uid> -- string
  • <function> -- 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 joystick-bricklet <uid> <callback> [<option>..]
Parameter:
  • <uid> -- string
  • <callback> -- 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 joystick-bricklet <uid> get-position
Ausgabe:
  • x -- int
  • y -- int

Gibt die Position des Joystick zurück. Der Wertebereich ist von -100 bis 100 für beide Achsen. Die Mittelposition des Joysticks ist x=0, y=0. Die zurückgegebenen Werte sind gemittelt und kalibriert (siehe calibrate).

Wenn die Position periodisch abgefragt werden sollen, wird empfohlen den position Callback zu nutzen und die Periode mit set-position-callback-period vorzugeben.

tinkerforge call joystick-bricklet <uid> is-pressed
Ausgabe:
  • pressed -- bool

Gibt true zurück wenn die Taste gedrückt ist und sonst false.

Es wird empfohlen die pressed und released Callbacks zu nutzen, um die Taste programmatisch zu behandeln.

Fortgeschrittene Funktionen

tinkerforge call joystick-bricklet <uid> get-analog-value
Ausgabe:
  • x -- int
  • y -- int

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück. Der Wertebereich ist 0 bis 4095.

Bemerkung

Der von get-position zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während get-analog-value unverarbeitete Analogwerte zurück gibt. Der einzige Grund get-analog-value zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

Wenn die Analogwerte periodisch abgefragt werden sollen, wird empfohlen den analog-value Callback zu nutzen und die Periode mit set-analog-value-callback-period vorzugeben.

tinkerforge call joystick-bricklet <uid> calibrate
Ausgabe:keine Ausgabe

Kalibriert die Mittelposition des Joysticks. Sollte der Joystick Bricklet nicht x=0 und y=0 in der Mittelposition zurückgeben, kann diese Funktion aufgerufen werden wenn der Joystick sich unbewegt in der Mittelposition befindet.

Die resultierende Kalibrierung wird in den EEPROM des Joystick Bricklet gespeichert, somit ist die Kalibrierung nur einmalig notwendig.

tinkerforge call joystick-bricklet <uid> get-identity
Ausgabe:
  • uid -- string
  • connected-uid -- string
  • position -- char
  • hardware-version -- int,int,int
  • firmware-version -- int,int,int
  • device-identifier -- int (hat Symbole)

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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. 

Konfigurationsfunktionen für Callbacks

tinkerforge call joystick-bricklet <uid> set-position-callback-period <period>
Parameter:
  • <period> -- int
Ausgabe:

keine Ausgabe

Setzt die Periode in ms mit welcher der position Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

The position Callback wird nur ausgelöst, wenn sich die Position seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

tinkerforge call joystick-bricklet <uid> get-position-callback-period
Ausgabe:
  • period -- int

Gibt die Periode zurück, wie von set-position-callback-period gesetzt.

tinkerforge call joystick-bricklet <uid> set-analog-value-callback-period <period>
Parameter:
  • <period> -- int
Ausgabe:

keine Ausgabe

Setzt die Periode in ms mit welcher der analog-value Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der analog-value Callback wird nur ausgelöst, wenn sich die Analogwerte seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

tinkerforge call joystick-bricklet <uid> get-analog-value-callback-period
Ausgabe:
  • period -- int

Gibt die Periode zurück, wie von set-analog-value-callback-period gesetzt.

tinkerforge call joystick-bricklet <uid> set-position-callback-threshold <option> <min-x> <max-x> <min-y> <max-y>
Parameter:
  • <option> -- char (hat Symbole)
  • <min-x> -- int
  • <max-x> -- int
  • <min-y> -- int
  • <max-y> -- int
Ausgabe:

keine Ausgabe

Setzt den Schwellwert für den position-reached Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Position außerhalb der min und max Werte ist
'i' Callback wird ausgelöst, wenn die Position innerhalb der min und max Werte ist
'<' Callback wird ausgelöst, wenn die Position kleiner als die min Werte ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Position größer als die min Werte ist (max wird ignoriert)

Der Standardwert ist ('x', 0, 0, 0, 0).

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

  • threshold-option-off = x, für <option>
  • threshold-option-outside = o, für <option>
  • threshold-option-inside = i, für <option>
  • threshold-option-smaller = <, für <option>
  • threshold-option-greater = >, für <option>
tinkerforge call joystick-bricklet <uid> get-position-callback-threshold
Ausgabe:
  • option -- char (hat Symbole)
  • min-x -- int
  • max-x -- int
  • min-y -- int
  • max-y -- int

Gibt den Schwellwert zurück, wie von set-position-callback-threshold gesetzt.

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

  • threshold-option-off = x, für option
  • threshold-option-outside = o, für option
  • threshold-option-inside = i, für option
  • threshold-option-smaller = <, für option
  • threshold-option-greater = >, für option
tinkerforge call joystick-bricklet <uid> set-analog-value-callback-threshold <option> <min-x> <max-x> <min-y> <max-y>
Parameter:
  • <option> -- char (hat Symbole)
  • <min-x> -- int
  • <max-x> -- int
  • <min-y> -- int
  • <max-y> -- int
Ausgabe:

keine Ausgabe

Setzt den Schwellwert für den analog-value-reached Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Analogwerte außerhalb der min und max Werte ist
'i' Callback wird ausgelöst, wenn die Analogwerte innerhalb der min und max Werte ist
'<' Callback wird ausgelöst, wenn die Analogwerte kleiner als die min Werte ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Analogwerte größer als die min Werte ist (max wird ignoriert)

Der Standardwert ist ('x', 0, 0, 0, 0).

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

  • threshold-option-off = x, für <option>
  • threshold-option-outside = o, für <option>
  • threshold-option-inside = i, für <option>
  • threshold-option-smaller = <, für <option>
  • threshold-option-greater = >, für <option>
tinkerforge call joystick-bricklet <uid> get-analog-value-callback-threshold
Ausgabe:
  • option -- char (hat Symbole)
  • min-x -- int
  • max-x -- int
  • min-y -- int
  • max-y -- int

Gibt den Schwellwert zurück, wie von set-analog-value-callback-threshold gesetzt.

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

  • threshold-option-off = x, für option
  • threshold-option-outside = o, für option
  • threshold-option-inside = i, für option
  • threshold-option-smaller = <, für option
  • threshold-option-greater = >, für option
tinkerforge call joystick-bricklet <uid> set-debounce-period <debounce>
Parameter:
  • <debounce> -- int
Ausgabe:

keine Ausgabe

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

tinkerforge call joystick-bricklet <uid> get-debounce-period
Ausgabe:
  • debounce -- int

Gibt die Entprellperiode zurück, wie von set-debounce-period gesetzt.

Callbacks

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

tinkerforge dispatch joystick-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 joystick-bricklet <uid> position
Ausgabe:
  • x -- int
  • y -- int

Dieser Callback wird mit der Periode, wie gesetzt mit set-position-callback-period, ausgelöst. Der Parameter ist die Position des Joysticks.

Der position Callback wird nur ausgelöst, wenn sich die Position seit der letzten Auslösung geändert hat.

tinkerforge dispatch joystick-bricklet <uid> analog-value
Ausgabe:
  • x -- int
  • y -- int

Dieser Callback wird mit der Periode, wie gesetzt mit set-analog-value-callback-period, ausgelöst. Der Parameter sind die Analogwerte des Joysticks.

Der analog-value Callback wird nur ausgelöst, wenn sich die Analogwerte seit der letzten Auslösung geändert hat.

tinkerforge dispatch joystick-bricklet <uid> position-reached
Ausgabe:
  • x -- int
  • y -- int

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set-position-callback-threshold gesetzt, erreicht wird. Der Parameter ist die Position des Joysticks.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit set-debounce-period gesetzt, ausgelöst.

tinkerforge dispatch joystick-bricklet <uid> analog-value-reached
Ausgabe:
  • x -- int
  • y -- int

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set-analog-value-callback-threshold gesetzt, erreicht wird. Der Parameter sind die Analogwerte des Joystick.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit set-debounce-period gesetzt, ausgelöst.

tinkerforge dispatch joystick-bricklet <uid> pressed
Ausgabe:keine Ausgabe

Dieser Callback wird ausgelöst, wenn die Taste gedrückt wird.

tinkerforge dispatch joystick-bricklet <uid> released
Ausgabe:keine Ausgabe

Dieser Callback wird ausgelöst, wenn die Taste losgelassen wird.