Dies ist die Beschreibung des TCP/IP Protokolls 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 allgemeine Beschreibung der TCP/IP Protokollstruktur findet sich hier.
BrickletGPSV3.
get_coordinates
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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
).
BrickletGPSV3.
get_status
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.
BrickletGPSV3.
get_altitude
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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
).
BrickletGPSV3.
get_motion
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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
).
BrickletGPSV3.
get_date_time
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.
BrickletGPSV3.
get_satellite_system_status_low_level
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die
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 Bedeutungen sind für die Elemente dieser Funktion definiert:
Für satellite_system:
Für fix:
BrickletGPSV3.
get_satellite_status
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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 Bedeutungen sind für die Elemente dieser Funktion definiert:
Für satellite_system:
BrickletGPSV3.
restart
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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 Bedeutungen sind für die Elemente dieser Funktion definiert:
Für restart_type:
BrickletGPSV3.
set_fix_led_config
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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 Bedeutungen sind für die Elemente dieser Funktion definiert:
Für config:
BrickletGPSV3.
get_fix_led_config
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Konfiguration zurück, wie von set_fix_led_config
gesetzt.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für config:
BrickletGPSV3.
set_sbas_config
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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 Bedeutungen sind für die Elemente dieser Funktion definiert:
Für sbas_config:
BrickletGPSV3.
get_sbas_config
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die SBAS-Konfiguration zurück, wie von set_sbas_config
gesetzt.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für sbas_config:
BrickletGPSV3.
get_spitfp_error_count
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.
BrickletGPSV3.
set_status_led_config
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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 Bedeutungen sind für die Elemente dieser Funktion definiert:
Für config:
BrickletGPSV3.
get_status_led_config
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Konfiguration zurück, wie von set_status_led_config
gesetzt.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für config:
BrickletGPSV3.
get_chip_temperature
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.
BrickletGPSV3.
reset
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.
BrickletGPSV3.
get_identity
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.
BrickletGPSV3.
set_coordinates_callback_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt die Periode mit welcher der CALLBACK_COORDINATES
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der CALLBACK_COORDINATES
Callback wird nur ausgelöst, wenn sich die Koordinaten seit der
letzten Auslösung geändert haben.
BrickletGPSV3.
get_coordinates_callback_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Periode zurück, wie von set_coordinates_callback_period
gesetzt.
BrickletGPSV3.
set_status_callback_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt die Periode mit welcher der CALLBACK_STATUS
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der CALLBACK_STATUS
Callback wird nur ausgelöst, wenn sich der Status seit der
letzten Auslösung geändert hat.
BrickletGPSV3.
get_status_callback_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Periode zurück, wie von set_status_callback_period
gesetzt.
BrickletGPSV3.
set_altitude_callback_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt die Periode mit welcher der CALLBACK_ALTITUDE
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der CALLBACK_ALTITUDE
Callback wird nur ausgelöst, wenn sich die Höhe seit der
letzten Auslösung geändert hat.
BrickletGPSV3.
get_altitude_callback_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Periode zurück, wie von set_altitude_callback_period
gesetzt.
BrickletGPSV3.
set_motion_callback_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt die Periode mit welcher der CALLBACK_MOTION
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der CALLBACK_MOTION
Callback wird nur ausgelöst, wenn sich die Bewegung seit der
letzten Auslösung geändert hat.
BrickletGPSV3.
get_motion_callback_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Periode zurück, wie von set_motion_callback_period
gesetzt.
BrickletGPSV3.
set_date_time_callback_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt die Periode mit welcher der CALLBACK_DATE_TIME
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der CALLBACK_DATE_TIME
Callback wird nur ausgelöst, wenn sich das Datum oder die
Zeit seit der letzten Auslösung geändert haben.
BrickletGPSV3.
get_date_time_callback_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Periode zurück, wie von set_date_time_callback_period
gesetzt.
BrickletGPSV3.
CALLBACK_PULSE_PER_SECOND
¶Funktions-ID: |
|
---|---|
Antwort: |
|
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.
BrickletGPSV3.
CALLBACK_COORDINATES
¶Funktions-ID: |
|
---|---|
Antwort: |
|
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 CALLBACK_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
).
BrickletGPSV3.
CALLBACK_STATUS
¶Funktions-ID: |
|
---|---|
Antwort: |
|
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 CALLBACK_STATUS
Callback wird nur ausgelöst, wenn sich der
Status seit der letzten Auslösung geändert hat.
BrickletGPSV3.
CALLBACK_ALTITUDE
¶Funktions-ID: |
|
---|---|
Antwort: |
|
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 CALLBACK_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
).
BrickletGPSV3.
CALLBACK_MOTION
¶Funktions-ID: |
|
---|---|
Antwort: |
|
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 CALLBACK_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
).
BrickletGPSV3.
CALLBACK_DATE_TIME
¶Funktions-ID: |
|
---|---|
Antwort: |
|
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 CALLBACK_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.
BrickletGPSV3.
set_bootloader_mode
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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 Bedeutungen sind für die Elemente dieser Funktion definiert:
Für mode:
Für status:
BrickletGPSV3.
get_bootloader_mode
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode
.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für mode:
BrickletGPSV3.
set_write_firmware_pointer
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.
BrickletGPSV3.
write_firmware
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.
BrickletGPSV3.
write_uid
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.
BrickletGPSV3.
read_uid
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.