Dies ist die Beschreibung der Shell API Bindings für das GPS Bricklet 3.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des GPS Bricklet 3.0 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 GPS Bricklet 3.0
# Get current coordinates
tinkerforge call gps-v3-bricklet $uid get-coordinates
|
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 3.0
# Handle incoming coordinates callbacks
tinkerforge dispatch gps-v3-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-v3-bricklet $uid set-coordinates-callback-period 1000
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
gps-v3-bricklet
[<option>..] <uid> <function> [<argument>..]¶Parameter: |
|
---|
Der call
Befehl wird verwendet um eine Funktion des GPS Bricklet 3.0 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 3.0 an
und endet danndispatch
gps-v3-bricklet
[<option>..] <uid> <callback>¶Parameter: |
|
---|
Der dispatch
Befehl wird verwendet um eingehende Callbacks des GPS Bricklet 3.0
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 3.0 an
und endet danngps-v3-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.
gps-v3-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)gps-v3-bricklet
<uid> get-coordinates
¶Ausgabe: |
|
---|
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).
Diese Daten sind nur gültig wenn ein Fix vorhanden ist (siehe get-status
).
gps-v3-bricklet
<uid> get-status
¶Ausgabe: |
|
---|
Gibt zurück ob ein GPS Fix besteht sowie die Anzahl der sichtbaren Satelliten.
Auf dem Bricklet ist eine green LED, die den Fix-Status anzeigt.
gps-v3-bricklet
<uid> get-altitude
¶Ausgabe: |
|
---|
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
).
gps-v3-bricklet
<uid> get-motion
¶Ausgabe: |
|
---|
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
).
gps-v3-bricklet
<uid> get-date-time
¶Ausgabe: |
|
---|
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.
gps-v3-bricklet
<uid> get-satellite-system-status
<satellite-system>¶Parameter: |
|
---|---|
Ausgabe: |
|
Gibt die
für ein gegebenes Satellitensystem zurück. Aktuell werden GPS, GLONASS und Galileo unterstützt.
Die Satelliten haben eindeutige Nummern and die Satellitenliste gibt die Nummer der Satelliten die aktuell benutzt werden. Die Nummer 0 ist keine gültige Satellitennummer und kann ignoriert werden.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <satellite-system>:
Für fix:
gps-v3-bricklet
<uid> get-satellite-status
<satellite-system> <satellite-number>¶Parameter: |
|
---|---|
Ausgabe: |
|
Gibt die aktuellen Werte von Elevation, Azimutwinkel und SNR für einen gegebenen Satelliten und ein gegebenes Satellitensystem zurück.
Die Satellitennummern teilen sich wie folgt auf:
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <satellite-system>:
gps-v3-bricklet
<uid> restart
<restart-type>¶Parameter: |
|
---|---|
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>:
gps-v3-bricklet
<uid> set-fix-led-config
<config>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Konfiguration der Fix-LED. Standardmäßig zeigt die LED an ob ein GPS-Fix besteht. Wenn ein Fix da ist, geht die LED an. Wenn kein Fix da ist, geht die LED aus.
Die LED kann auch permanent an/aus gestellt werden, einen Herzschlag anzeigen oder im Rhythmus des PPS (Puls pro Sekunde) Ausgangs des GPS Moduls blinken.
Wenn das Bricklet sich im Bootloadermodus befindet ist die LED aus.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <config>:
gps-v3-bricklet
<uid> get-fix-led-config
¶Ausgabe: |
|
---|
Gibt die Konfiguration zurück, wie von set-fix-led-config
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
gps-v3-bricklet
<uid> set-sbas-config
<sbas-config>¶Parameter: |
|
---|---|
Ausgabe: |
|
Wenn SBAS aktiviert ist, erhöht sich die Positionsgenauigkeit der GPS Daten falls SBAS Satelliten zu sehen sind. Die Aktualisierungsrate der GPS Daten beträgt 5Hz falls SBAS aktiviert ist und 10Hz falls SBAS deaktiviert ist.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <sbas-config>:
gps-v3-bricklet
<uid> get-sbas-config
¶Ausgabe: |
|
---|
Gibt die SBAS-Konfiguration zurück, wie von set-sbas-config
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für sbas-config:
gps-v3-bricklet
<uid> get-spitfp-error-count
¶Ausgabe: |
|
---|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.
gps-v3-bricklet
<uid> set-status-led-config
<config>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.
Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.
Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <config>:
gps-v3-bricklet
<uid> get-status-led-config
¶Ausgabe: |
|
---|
Gibt die Konfiguration zurück, wie von set-status-led-config
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für config:
gps-v3-bricklet
<uid> get-chip-temperature
¶Ausgabe: |
|
---|
Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.
Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.
gps-v3-bricklet
<uid> reset
¶Ausgabe: |
|
---|
Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.
Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.
gps-v3-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.
gps-v3-bricklet
<uid> set-coordinates-callback-period
<period>¶Parameter: |
|
---|---|
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.
gps-v3-bricklet
<uid> get-coordinates-callback-period
¶Ausgabe: |
|
---|
Gibt die Periode zurück, wie von set-coordinates-callback-period
gesetzt.
gps-v3-bricklet
<uid> set-status-callback-period
<period>¶Parameter: |
|
---|---|
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.
gps-v3-bricklet
<uid> get-status-callback-period
¶Ausgabe: |
|
---|
Gibt die Periode zurück, wie von set-status-callback-period
gesetzt.
gps-v3-bricklet
<uid> set-altitude-callback-period
<period>¶Parameter: |
|
---|---|
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.
gps-v3-bricklet
<uid> get-altitude-callback-period
¶Ausgabe: |
|
---|
Gibt die Periode zurück, wie von set-altitude-callback-period
gesetzt.
gps-v3-bricklet
<uid> set-motion-callback-period
<period>¶Parameter: |
|
---|---|
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.
gps-v3-bricklet
<uid> get-motion-callback-period
¶Ausgabe: |
|
---|
Gibt die Periode zurück, wie von set-motion-callback-period
gesetzt.
gps-v3-bricklet
<uid> set-date-time-callback-period
<period>¶Parameter: |
|
---|---|
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.
gps-v3-bricklet
<uid> get-date-time-callback-period
¶Ausgabe: |
|
---|
Gibt die Periode zurück, wie von set-date-time-callback-period
gesetzt.
Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten:
tinkerforge dispatch gps-v3-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.
gps-v3-bricklet
<uid> pulse-per-second
¶Ausgabe: |
|
---|
Dieser Callback wird präzise einmal pro sekunde ausgeführt, siehe PPS.
Die Präzision von zwei direkt aufeinander folgenden Pulsen kann auf Grund von Latenzen in der USB/RS485/Ethernet-Verbindung verzerrt sein. Langfristig ist dies allerdings weiterhin sehr präzise. Zum Beispiel wird eine Zählung von 3600 Pulsen exakt eine Stund dauern.
gps-v3-bricklet
<uid> coordinates
¶Ausgabe: |
|
---|
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
).
gps-v3-bricklet
<uid> status
¶Ausgabe: |
|
---|
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.
gps-v3-bricklet
<uid> altitude
¶Ausgabe: |
|
---|
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
).
gps-v3-bricklet
<uid> motion
¶Ausgabe: |
|
---|
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
).
gps-v3-bricklet
<uid> date-time
¶Ausgabe: |
|
---|
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.
Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.
gps-v3-bricklet
<uid> set-bootloader-mode
<mode>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.
Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für <mode>:
Für status:
gps-v3-bricklet
<uid> get-bootloader-mode
¶Ausgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe set-bootloader-mode
.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für mode:
gps-v3-bricklet
<uid> set-write-firmware-pointer
<pointer>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt den Firmware-Pointer für write-firmware
. Der Pointer
muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke
in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
gps-v3-bricklet
<uid> write-firmware
<data>¶Parameter: |
|
---|---|
Ausgabe: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
set-write-firmware-pointer
gesetzt wurde. Die Firmware wird
alle 4 Datenblöcke in den Flash geschrieben.
Eine Firmware kann nur im Bootloader-Mode geschrieben werden.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
gps-v3-bricklet
<uid> write-uid
<uid>¶Parameter: |
|
---|---|
Ausgabe: |
|
Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.
Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.
gps-v3-bricklet
<uid> read-uid
¶Ausgabe: |
|
---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.