Modbus - GPS Bricklet

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

API

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen

BrickletGPS.get_coordinates
Funktions ID:

1

Anfrage:

keine Nutzdaten

Antwort:
  • latitude -- uint32
  • ns -- char
  • longitude -- uint32
  • ew -- char
  • pdop -- uint16
  • hdop -- uint16
  • vdop -- uint16
  • epe -- uint16

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". Der EPE wird in cm gegeben. 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).

BrickletGPS.get_status
Funktions ID:

2

Anfrage:

keine Nutzdaten

Antwort:
  • fix -- uint8
  • satellites_view -- uint8
  • satellites_used -- uint8

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

  • 1: no fix, für fix
  • 2: 2d fix, für fix
  • 3: 3d fix, für fix
BrickletGPS.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).

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

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

Fortgeschrittene Funktionen

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

BrickletGPS.set_coordinates_callback_period
Funktions ID:

7

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.

BrickletGPS.get_coordinates_callback_period
Funktions ID:

8

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32

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

BrickletGPS.set_status_callback_period
Funktions ID:

9

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.

BrickletGPS.get_status_callback_period
Funktions ID:

10

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32

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

BrickletGPS.set_altitude_callback_period
Funktions ID:

11

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.

BrickletGPS.get_altitude_callback_period
Funktions ID:

12

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32

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

BrickletGPS.set_motion_callback_period
Funktions ID:

13

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.

BrickletGPS.get_motion_callback_period
Funktions ID:

14

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32

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

BrickletGPS.set_date_time_callback_period
Funktions ID:

15

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.

BrickletGPS.get_date_time_callback_period
Funktions ID:

16

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32

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

Callbacks

BrickletGPS.CALLBACK_COORDINATES
Funktions ID:

17

Antwort:
  • latitude -- uint32
  • ns -- char
  • longitude -- uint32
  • ew -- char
  • pdop -- uint16
  • hdop -- uint16
  • vdop -- uint16
  • epe -- uint16

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

BrickletGPS.CALLBACK_STATUS
Funktions ID:

18

Antwort:
  • fix -- uint8
  • satellites_view -- uint8
  • satellites_used -- 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.

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

  • 1: no fix, für fix
  • 2: 2d fix, für fix
  • 3: 3d fix, für fix
BrickletGPS.CALLBACK_ALTITUDE
Funktions ID:

19

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

BrickletGPS.CALLBACK_MOTION
Funktions ID:

20

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

BrickletGPS.CALLBACK_DATE_TIME
Funktions ID:

21

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.