Modbus - GPS Bricklet 2.0

Dies ist die Beschreibung des Modbus Protokolls für das GPS Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des GPS Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.

API

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen

BrickletGPSV2.get_coordinates
Funktions ID:

1

Anfrage:

keine Nutzdaten

Antwort:
  • latitude -- uint32
  • ns -- char
  • longitude -- uint32
  • ew -- char

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

BrickletGPSV2.get_status
Funktions ID:

2

Anfrage:

keine Nutzdaten

Antwort:
  • has_fix -- bool
  • satellites_view -- uint8

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.

BrickletGPSV2.get_altitude
Funktions ID:

3

Anfrage:

keine Nutzdaten

Antwort:
  • altitude -- int32
  • geoidal_separation -- int32

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

Beide Werte werden in cm angegeben.

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

BrickletGPSV2.get_motion
Funktions ID:

4

Anfrage:

keine Nutzdaten

Antwort:
  • course -- uint32
  • speed -- uint32

Gibt die aktuelle Richtung und Geschwindigkeit zurück. Die Richtung wird in hundertstel Grad und die Geschwindigkeit in hundertstel km/h angegeben. 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).

BrickletGPSV2.get_date_time
Funktions ID:

5

Anfrage:

keine Nutzdaten

Antwort:
  • date -- uint32
  • time -- uint32

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.05.13 als Datum und 195923568 bedeutet 19:59:23.568 als Zeit.

BrickletGPSV2.get_satellite_system_status_low_level
Funktions ID:

7

Anfrage:
  • satellite_system -- uint8
Antwort:
  • satellite_numbers_length -- uint8
  • satellite_numbers_data -- uint8[12]
  • fix -- uint8
  • pdop -- uint16
  • hdop -- uint16
  • vdop -- uint16

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 Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: gps, für satellite_system
  • 1: glonass, für satellite_system
  • 2: galileo, für satellite_system
  • 1: no fix, für fix
  • 2: 2d fix, für fix
  • 3: 3d fix, für fix
BrickletGPSV2.get_satellite_status
Funktions ID:

8

Anfrage:
  • satellite_system -- uint8
  • satellite_number -- uint8
Antwort:
  • elevation -- int16
  • azimuth -- int16
  • snr -- int16

Gibt die aktuellen Werte von

  • Elevation (0° - 90°),
  • Azimutwinkel (0° - 359°) und
  • SNR (0dB - 99dB)

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 Parameter dieser Funktion definiert:

  • 0: gps, für satellite_system
  • 1: glonass, für satellite_system
  • 2: galileo, für satellite_system

Fortgeschrittene Funktionen

BrickletGPSV2.restart
Funktions ID:

6

Anfrage:
  • restart_type -- uint8
Antwort:

keine 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 Parameter dieser Funktion definiert:

  • 0: hot start, für restart_type
  • 1: warm start, für restart_type
  • 2: cold start, für restart_type
  • 3: factory reset, für restart_type
BrickletGPSV2.set_fix_led_config
Funktions ID:

9

Anfrage:
  • config -- uint8
Antwort:

keine 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 Rythmus des PPS (Puls pro Sekunde) Ausgangs des GPS Moduls blinken.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show fix, für config
  • 4: show pps, für config
BrickletGPSV2.get_fix_led_config
Funktions ID:

10

Anfrage:

keine Nutzdaten

Antwort:
  • config -- uint8

Gibt die Konfiguration zurück, wie von set_fix_led_config gesetzt.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show fix, für config
  • 4: show pps, für config
BrickletGPSV2.set_sbas_config
Funktions ID:

27

Anfrage:
  • sbas_config -- uint8
Antwort:

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

Standardmäßig ist SBAS aktiviert und die Aktualisierungsrate 5Hz.

Neu in Version 2.0.2 (Plugin).

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: enabled, für sbas_config
  • 1: disabled, für sbas_config
BrickletGPSV2.get_sbas_config
Funktions ID:

28

Anfrage:

keine Nutzdaten

Antwort:
  • sbas_config -- uint8

Gibt die SBAS-Konfiguration zurück, wie von set_sbas_config gesetzt.

Neu in Version 2.0.2 (Plugin).

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: enabled, für sbas_config
  • 1: disabled, für sbas_config
BrickletGPSV2.get_spitfp_error_count
Funktions ID:

234

Anfrage:

keine Nutzdaten

Antwort:
  • error_count_ack_checksum -- uint32
  • error_count_message_checksum -- uint32
  • error_count_frame -- uint32
  • error_count_overflow -- uint32

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.

BrickletGPSV2.set_bootloader_mode
Funktions ID:

235

Anfrage:
  • mode -- uint8
Antwort:
  • status -- uint8

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 Bootlodaer- 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 Parameter dieser Funktion definiert:

  • 0: bootloader, für mode
  • 1: firmware, für mode
  • 2: bootloader wait for reboot, für mode
  • 3: firmware wait for reboot, für mode
  • 4: firmware wait for erase and reboot, für mode
  • 0: ok, für status
  • 1: invalid mode, für status
  • 2: no change, für status
  • 3: entry function not present, für status
  • 4: device identifier incorrect, für status
  • 5: crc mismatch, für status
BrickletGPSV2.get_bootloader_mode
Funktions ID:

236

Anfrage:

keine Nutzdaten

Antwort:
  • mode -- uint8

Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: bootloader, für mode
  • 1: firmware, für mode
  • 2: bootloader wait for reboot, für mode
  • 3: firmware wait for reboot, für mode
  • 4: firmware wait for erase and reboot, für mode
BrickletGPSV2.set_write_firmware_pointer
Funktions ID:

237

Anfrage:
  • pointer -- uint32
Antwort:

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

BrickletGPSV2.write_firmware
Funktions ID:

238

Anfrage:
  • data -- uint8[64]
Antwort:
  • status -- uint8

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.

BrickletGPSV2.set_status_led_config
Funktions ID:

239

Anfrage:
  • config -- uint8
Antwort:

keine 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 Parameter dieser Funktion definiert:

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show status, für config
BrickletGPSV2.get_status_led_config
Funktions ID:

240

Anfrage:

keine Nutzdaten

Antwort:
  • config -- uint8

Gibt die Konfiguration zurück, wie von set_status_led_config gesetzt.

Die folgenden Bedeutungen sind für die Parameter dieser Funktion definiert:

  • 0: off, für config
  • 1: on, für config
  • 2: show heartbeat, für config
  • 3: show status, für config
BrickletGPSV2.get_chip_temperature
Funktions ID:

242

Anfrage:

keine Nutzdaten

Antwort:
  • temperature -- int16

Gibt die Temperatur in °C, 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.

BrickletGPSV2.reset
Funktions ID:243
Anfrage:keine Nutzdaten
Antwort:keine 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.

BrickletGPSV2.write_uid
Funktions ID:

248

Anfrage:
  • uid -- uint32
Antwort:

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

BrickletGPSV2.read_uid
Funktions ID:

249

Anfrage:

keine Nutzdaten

Antwort:
  • uid -- uint32

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

BrickletGPSV2.get_identity
Funktions ID:

255

Anfrage:

keine Nutzdaten

Antwort:
  • uid -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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

BrickletGPSV2.set_coordinates_callback_period
Funktions ID:

11

Anfrage:
  • period -- uint32
Antwort:

keine Antwort

Setzt die Periode in ms 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.

Der Standardwert ist 0.

BrickletGPSV2.get_coordinates_callback_period
Funktions ID:

12

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32

Gibt die Periode zurück, wie von set_coordinates_callback_period gesetzt.

BrickletGPSV2.set_status_callback_period
Funktions ID:

13

Anfrage:
  • period -- uint32
Antwort:

keine Antwort

Setzt die Periode in ms 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.

Der Standardwert ist 0.

BrickletGPSV2.get_status_callback_period
Funktions ID:

14

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32

Gibt die Periode zurück, wie von set_status_callback_period gesetzt.

BrickletGPSV2.set_altitude_callback_period
Funktions ID:

15

Anfrage:
  • period -- uint32
Antwort:

keine Antwort

Setzt die Periode in ms 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.

Der Standardwert ist 0.

BrickletGPSV2.get_altitude_callback_period
Funktions ID:

16

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32

Gibt die Periode zurück, wie von set_altitude_callback_period gesetzt.

BrickletGPSV2.set_motion_callback_period
Funktions ID:

17

Anfrage:
  • period -- uint32
Antwort:

keine Antwort

Setzt die Periode in ms 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.

Der Standardwert ist 0.

BrickletGPSV2.get_motion_callback_period
Funktions ID:

18

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32

Gibt die Periode zurück, wie von set_motion_callback_period gesetzt.

BrickletGPSV2.set_date_time_callback_period
Funktions ID:

19

Anfrage:
  • period -- uint32
Antwort:

keine Antwort

Setzt die Periode in ms 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.

Der Standardwert ist 0.

BrickletGPSV2.get_date_time_callback_period
Funktions ID:

20

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32

Gibt die Periode zurück, wie von set_date_time_callback_period gesetzt.

Callbacks

BrickletGPSV2.CALLBACK_PULSE_PER_SECOND
Funktions ID:21
Antwort:keine Nutzdaten

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.

BrickletGPSV2.CALLBACK_COORDINATES
Funktions ID:

22

Antwort:
  • latitude -- uint32
  • ns -- char
  • longitude -- uint32
  • ew -- char

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

BrickletGPSV2.CALLBACK_STATUS
Funktions ID:

23

Antwort:
  • has_fix -- bool
  • satellites_view -- uint8

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.

BrickletGPSV2.CALLBACK_ALTITUDE
Funktions ID:

24

Antwort:
  • altitude -- int32
  • geoidal_separation -- int32

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

BrickletGPSV2.CALLBACK_MOTION
Funktions ID:

25

Antwort:
  • course -- uint32
  • speed -- uint32

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

BrickletGPSV2.CALLBACK_DATE_TIME
Funktions ID:

26

Antwort:
  • date -- uint32
  • time -- uint32

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.