Shell - GPS Bricklet 3.0

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.

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 3.0

# Get current coordinates
tinkerforge call gps-v3-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 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

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

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 dann
tinkerforge dispatch gps-v3-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

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 dann
tinkerforge call gps-v3-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-v3-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-v3-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]

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).

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

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.

tinkerforge call gps-v3-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-v3-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-v3-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.

tinkerforge call gps-v3-bricklet <uid> get-satellite-system-status <satellite-system>
Parameter:
  • <satellite-system> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • satellite-numbers – Typ: Int Array, Länge: variabel, Wertebereich: [0 bis 255]
  • fix – Typ: Int, Wertebereich: Siehe Symbole
  • 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]

Gibt die

  • Liste der Satellitennummern (bis zu 12 Elemente),
  • Fix-Wert,
  • PDOP-Wert,
  • HDOP-Wert and
  • VDOP-Wert zurück.

für ein gegebenes Satellitensystem zurück. Aktuell werden GPS und GLONASS unterstützt, Galileo hat noch keine Unterstützung.

Die GPS und GLONASS 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>:

  • satellite-system-gps = 0
  • satellite-system-glonass = 1
  • satellite-system-galileo = 2

Für fix:

  • fix-no-fix = 1
  • fix-2d-fix = 2
  • fix-3d-fix = 3
tinkerforge call gps-v3-bricklet <uid> get-satellite-status <satellite-system> <satellite-number>
Parameter:
  • <satellite-system> – Typ: Int, Wertebereich: Siehe Symbole
  • <satellite-number> – Typ: Int, Wertebereich: [1 bis 32]
Ausgabe:
  • elevation – Typ: Int, Einheit: 1 °, Wertebereich: [0 bis 90]
  • azimuth – Typ: Int, Einheit: 1 °, Wertebereich: [0 bis 359]
  • snr – Typ: Int, Einheit: 1 dB, Wertebereich: [0 bis 99]

Gibt die aktuellen Werte von Elevation, Azimutwinkel und SNR für einen gegebenen Satelliten und ein gegebenes Satellitensystem zurück.

Die Satellitennummer hat hier immer einen Bereich von 1 bis 32. Bei GLONASS entspricht dieser Bereich den Satelliten 65-96.

Galileo wird noch nicht unterstützt.

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

Für <satellite-system>:

  • satellite-system-gps = 0
  • satellite-system-glonass = 1
  • satellite-system-galileo = 2

Fortgeschrittene Funktionen

tinkerforge call gps-v3-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-v3-bricklet <uid> set-fix-led-config <config>
Parameter:
  • <config> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
Ausgabe:
  • keine 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>:

  • fix-led-config-off = 0
  • fix-led-config-on = 1
  • fix-led-config-show-heartbeat = 2
  • fix-led-config-show-fix = 3
  • fix-led-config-show-pps = 4
tinkerforge call gps-v3-bricklet <uid> get-fix-led-config
Ausgabe:
  • config – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

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:

  • fix-led-config-off = 0
  • fix-led-config-on = 1
  • fix-led-config-show-heartbeat = 2
  • fix-led-config-show-fix = 3
  • fix-led-config-show-pps = 4
tinkerforge call gps-v3-bricklet <uid> set-sbas-config <sbas-config>
Parameter:
  • <sbas-config> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0
Ausgabe:
  • keine 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>:

  • sbas-enabled = 0
  • sbas-disabled = 1
tinkerforge call gps-v3-bricklet <uid> get-sbas-config
Ausgabe:
  • sbas-config – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 0

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:

  • sbas-enabled = 0
  • sbas-disabled = 1
tinkerforge call gps-v3-bricklet <uid> get-spitfp-error-count
Ausgabe:
  • error-count-ack-checksum – Typ: Int, Wertebereich: [0 bis 232 - 1]
  • error-count-message-checksum – Typ: Int, Wertebereich: [0 bis 232 - 1]
  • error-count-frame – Typ: Int, Wertebereich: [0 bis 232 - 1]
  • error-count-overflow – Typ: Int, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

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.

tinkerforge call gps-v3-bricklet <uid> set-status-led-config <config>
Parameter:
  • <config> – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3
Ausgabe:
  • keine 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>:

  • status-led-config-off = 0
  • status-led-config-on = 1
  • status-led-config-show-heartbeat = 2
  • status-led-config-show-status = 3
tinkerforge call gps-v3-bricklet <uid> get-status-led-config
Ausgabe:
  • config – Typ: Int, Wertebereich: Siehe Symbole, Standardwert: 3

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:

  • status-led-config-off = 0
  • status-led-config-on = 1
  • status-led-config-show-heartbeat = 2
  • status-led-config-show-status = 3
tinkerforge call gps-v3-bricklet <uid> get-chip-temperature
Ausgabe:
  • temperature – Typ: Int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

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.

tinkerforge call gps-v3-bricklet <uid> reset
Ausgabe:
  • keine 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.

tinkerforge call gps-v3-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, 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 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. 

Konfigurationsfunktionen für Callbacks

tinkerforge call gps-v3-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-v3-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-v3-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-v3-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-v3-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-v3-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-v3-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-v3-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-v3-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-v3-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-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.

tinkerforge dispatch gps-v3-bricklet <uid> pulse-per-second
Ausgabe:
  • keine 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.

tinkerforge dispatch gps-v3-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]

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-v3-bricklet <uid> status
Ausgabe:
  • has-fix – Typ: Bool
  • satellites-view – 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.

tinkerforge dispatch gps-v3-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-v3-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-v3-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.

Interne Funktionen

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.

tinkerforge call gps-v3-bricklet <uid> set-bootloader-mode <mode>
Parameter:
  • <mode> – Typ: Int, Wertebereich: Siehe Symbole
Ausgabe:
  • status – Typ: Int, Wertebereich: Siehe Symbole

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

  • bootloader-mode-bootloader = 0
  • bootloader-mode-firmware = 1
  • bootloader-mode-bootloader-wait-for-reboot = 2
  • bootloader-mode-firmware-wait-for-reboot = 3
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4

Für status:

  • bootloader-status-ok = 0
  • bootloader-status-invalid-mode = 1
  • bootloader-status-no-change = 2
  • bootloader-status-entry-function-not-present = 3
  • bootloader-status-device-identifier-incorrect = 4
  • bootloader-status-crc-mismatch = 5
tinkerforge call gps-v3-bricklet <uid> get-bootloader-mode
Ausgabe:
  • mode – Typ: Int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe set-bootloader-mode.

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

Für mode:

  • bootloader-mode-bootloader = 0
  • bootloader-mode-firmware = 1
  • bootloader-mode-bootloader-wait-for-reboot = 2
  • bootloader-mode-firmware-wait-for-reboot = 3
  • bootloader-mode-firmware-wait-for-erase-and-reboot = 4
tinkerforge call gps-v3-bricklet <uid> set-write-firmware-pointer <pointer>
Parameter:
  • <pointer> – Typ: Int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Ausgabe:
  • keine 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.

tinkerforge call gps-v3-bricklet <uid> write-firmware <data>
Parameter:
  • <data> – Typ: Int Array, Länge: 64, Wertebereich: [0 bis 255]
Ausgabe:
  • status – Typ: Int, Wertebereich: [0 bis 255]

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.

tinkerforge call gps-v3-bricklet <uid> write-uid <uid>
Parameter:
  • <uid> – Typ: Int, Wertebereich: [0 bis 232 - 1]
Ausgabe:
  • keine 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.

tinkerforge call gps-v3-bricklet <uid> read-uid
Ausgabe:
  • uid – Typ: Int, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.