Shell - GPS Bricklet

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

# Get current coordinates
tinkerforge call gps-bricklet $uid get-coordinates

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

# Handle incoming coordinates callbacks
tinkerforge dispatch gps-bricklet $uid coordinates &

# Set period for coordinates callback to 1s (1000ms)
# Note: The coordinates callback is only called every second
#       if the coordinates has changed since the last call!
tinkerforge call gps-bricklet $uid set-coordinates-callback-period 1000

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

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

Der dispatch Befehl wird verwendet um eingehende Callbacks des GPS 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 GPS Bricklet an und endet dann
tinkerforge call gps-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 gps-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 gps-bricklet <uid> get-coordinates
Ausgabe:
  • latitude – Typ: Int, Einheit: 1/1000000 °, Wertebereich: [0 bis 90000000]
  • ns – Typ: Char, Wertebereich: [N, S]
  • longitude – Typ: Int, Einheit: 1/1000000 °, Wertebereich: [0 bis 180000000]
  • ew – Typ: Char, Wertebereich: [E, W]
  • pdop – Typ: Int, Einheit: 1/100, Wertebereich: [0 bis 216 - 1]
  • hdop – Typ: Int, Einheit: 1/100, Wertebereich: [0 bis 216 - 1]
  • vdop – Typ: Int, Einheit: 1/100, Wertebereich: [0 bis 216 - 1]
  • epe – Typ: Int, Einheit: 1 cm, Wertebereich: [0 bis 216 - 1]

Gibt die GPS Koordinaten zurück. Breitengrad und Längengrad werden im Format DD.dddddd° angegeben, der Wert 57123468 bedeutet 57,123468°. Die Parameter ns und ew sind Himmelsrichtungen für Breiten- und Längengrad. Mögliche Werte für ns und ew sind 'N', 'S', 'E' und 'W' (Nord, Süd, Ost, West).

PDOP, HDOP und VDOP sind die "Dilution Of Precision" (DOP) Werte. Sie spezifizieren die zusätzlichen multiplikativen Effekte von der GPS Satellitengeometrie auf die GPS-Präzision. hier gibt es mehr Informationen dazu. Die Werte werden in Hundertstel gegeben.

EPE ist der "Estimated Position Error". Dies ist nicht der absolut maximale Fehler, es ist der Fehler mit einer spezifischen Konfidenz. Siehe hier für mehr Informationen.

Diese Daten sind nur gültig wenn ein Fix vorhanden ist (siehe get-status).

tinkerforge call gps-bricklet <uid> get-status
Ausgabe:
  • fix – Typ: Int, Wertebereich: Siehe Symbole
  • satellites-view – Typ: Int, Wertebereich: [0 bis 255]
  • satellites-used – Typ: Int, Wertebereich: [0 bis 255]

Gibt den aktuellen Fix-Status, die Anzahl der sichtbaren Satelliten und die Anzahl der im Moment benutzten Satelliten zurück.

Mögliche Fix-Status Werte sind:

Wert Beschreibung
1 Kein Fix, get-coordinates, get-altitude und get-motion geben ungültige Daten zurück
2 2D Fix, nur get-coordinates und get-motion geben gültige Daten zurück
3 3D Fix, get-coordinates, get-altitude und get-motion geben gültige Daten zurück

Auf dem Bricklet ist eine blaue LED, die den Fix-Status anzeigt.

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

Für fix:

  • fix-no-fix = 1
  • fix-2d-fix = 2
  • fix-3d-fix = 3
tinkerforge call gps-bricklet <uid> get-altitude
Ausgabe:
  • altitude – Typ: Int, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1]
  • geoidal-separation – Typ: Int, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1]

Gibt die aktuelle Höhe und die dazu gehörige "Geoidal Separation" zurück.

Diese Daten sind nur gültig wenn ein Fix vorhanden ist (siehe get-status).

tinkerforge call gps-bricklet <uid> get-motion
Ausgabe:
  • course – Typ: Int, Einheit: 1/100 °, Wertebereich: [0 bis 36000]
  • speed – Typ: Int, Einheit: 1/100 km/h, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle Richtung und Geschwindigkeit zurück. Eine Richtung von 0° bedeutet eine Bewegung des Bricklets nach Norden und 90° einer Bewegung nach Osten.

Dabei ist zu beachten: Diese Funktion liefert nur nützlich Werte wenn auch tatsächlich eine Bewegung stattfindet.

Diese Daten sind nur gültig wenn ein Fix vorhanden ist (siehe get-status).

tinkerforge call gps-bricklet <uid> get-date-time
Ausgabe:
  • date – Typ: Int, Wertebereich: [10100 bis 311299]
  • time – Typ: Int, Wertebereich: [0 bis 235959999]

Gibt das aktuelle Datum und die aktuelle Zeit zurück. Das Datum ist im Format ddmmyy und die Zeit im Format hhmmss.sss angegeben. Zum Beispiel, 140713 bedeutet 14.07.13 als Datum und 195923568 bedeutet 19:59:23.568 als Zeit.

Fortgeschrittene Funktionen

tinkerforge call gps-bricklet <uid> restart <restart-type>
Parameter:
  • <restart-type> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • keine Ausgabe

Startet das GPS Bricklet neu. Die folgenden Neustart-Typen stehen zur Verfügung:

Wert Beschreibung
0 Hot Start (alle verfügbaren Daten im NV-Speicher werden weiter genutzt)
1 Warm Start (Ephemerisdaten werden verworfen)
2 Cold Start (Zeit-, Position-, Almanach- und Ephemerisdaten werden verworfen)
3 Factory Reset (Alle System/User Einstellungen werden verworfen)

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

Für <restart-type>:

  • restart-type-hot-start = 0
  • restart-type-warm-start = 1
  • restart-type-cold-start = 2
  • restart-type-factory-reset = 3
tinkerforge call gps-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. 

Konfigurationsfunktionen für Callbacks

tinkerforge call gps-bricklet <uid> set-coordinates-callback-period <period>
Parameter:
  • <period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Ausgabe:
  • keine Ausgabe

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

Der coordinates Callback wird nur ausgelöst, wenn sich die Koordinaten seit der letzten Auslösung geändert haben.

tinkerforge call gps-bricklet <uid> get-coordinates-callback-period
Ausgabe:
  • period – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

tinkerforge call gps-bricklet <uid> set-status-callback-period <period>
Parameter:
  • <period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Ausgabe:
  • keine Ausgabe

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

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

tinkerforge call gps-bricklet <uid> get-status-callback-period
Ausgabe:
  • period – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

tinkerforge call gps-bricklet <uid> set-altitude-callback-period <period>
Parameter:
  • <period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Ausgabe:
  • keine Ausgabe

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

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

tinkerforge call gps-bricklet <uid> get-altitude-callback-period
Ausgabe:
  • period – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

tinkerforge call gps-bricklet <uid> set-motion-callback-period <period>
Parameter:
  • <period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Ausgabe:
  • keine Ausgabe

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

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

tinkerforge call gps-bricklet <uid> get-motion-callback-period
Ausgabe:
  • period – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

tinkerforge call gps-bricklet <uid> set-date-time-callback-period <period>
Parameter:
  • <period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Ausgabe:
  • keine Ausgabe

Setzt die Periode mit welcher der date-time Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der date-time Callback wird nur ausgelöst, wenn sich das Datum oder die Zeit seit der letzten Auslösung geändert haben.

tinkerforge call gps-bricklet <uid> get-date-time-callback-period
Ausgabe:
  • period – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

Callbacks

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

tinkerforge dispatch gps-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 gps-bricklet <uid> coordinates
Ausgabe:
  • latitude – Typ: Int, Einheit: 1/1000000 °, Wertebereich: [0 bis 90000000]
  • ns – Typ: Char, Wertebereich: [N, S]
  • longitude – Typ: Int, Einheit: 1/1000000 °, Wertebereich: [0 bis 180000000]
  • ew – Typ: Char, Wertebereich: [E, W]
  • pdop – Typ: Int, Einheit: 1/100, Wertebereich: [0 bis 216 - 1]
  • hdop – Typ: Int, Einheit: 1/100, Wertebereich: [0 bis 216 - 1]
  • vdop – Typ: Int, Einheit: 1/100, Wertebereich: [0 bis 216 - 1]
  • epe – Typ: Int, Einheit: 1 cm, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit set-coordinates-callback-period, ausgelöst. Die Parameter sind die gleichen wie die von get-coordinates.

Der coordinates Callback wird nur ausgelöst, wenn sich die Koordinaten seit der letzten Auslösung geändert haben und ein Fix vorhanden ist (siehe get-status).

tinkerforge dispatch gps-bricklet <uid> status
Ausgabe:
  • fix – Typ: Int, Wertebereich: Siehe Symbole
  • satellites-view – Typ: Int, Wertebereich: [0 bis 255]
  • satellites-used – Typ: Int, Wertebereich: [0 bis 255]

Dieser Callback wird mit der Periode, wie gesetzt mit set-status-callback-period, ausgelöst. Die Parameter sind die gleichen wie die von get-status.

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

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

Für fix:

  • fix-no-fix = 1
  • fix-2d-fix = 2
  • fix-3d-fix = 3
tinkerforge dispatch gps-bricklet <uid> altitude
Ausgabe:
  • altitude – Typ: Int, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1]
  • geoidal-separation – Typ: Int, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit set-altitude-callback-period, ausgelöst. Die Parameter sind die gleichen wie die von get-altitude.

Der altitude Callback wird nur ausgelöst, wenn sich die Höhe seit der letzten Auslösung geändert hat und ein Fix vorhanden ist (siehe get-status).

tinkerforge dispatch gps-bricklet <uid> motion
Ausgabe:
  • course – Typ: Int, Einheit: 1/100 °, Wertebereich: [0 bis 36000]
  • speed – Typ: Int, Einheit: 1/100 km/h, Wertebereich: [0 bis 232 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit set-motion-callback-period, ausgelöst. Die Parameter sind die gleichen wie die von get-motion.

Der motion Callback wird nur ausgelöst, wenn sich die Bewegung seit der letzten Auslösung geändert hat und ein Fix vorhanden ist (siehe get-status).

tinkerforge dispatch gps-bricklet <uid> date-time
Ausgabe:
  • date – Typ: Int, Wertebereich: [10100 bis 311299]
  • time – Typ: Int, Wertebereich: [0 bis 235959999]

Dieser Callback wird mit der Periode, wie gesetzt mit set-date-time-callback-period, ausgelöst. Die Parameter sind die gleichen wie die von get-date-time.

Der date-time Callback wird nur ausgelöst, wenn sich das Datum oder die Zeit seit der letzten Auslösung geändert haben.