Software / API Bindings / MQTT / API Referenz und Beispiele / Bricklets (Abgekündigt) / GPS Bricklet

MQTT - GPS Bricklet¶

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

Eine Installationanleitung für die MQTT API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple¶

Download (example-simple.txt)

# Change XYZ to the UID of your GPS Bricklet

setup:
    # Get current coordinates
    subscribe to tinkerforge/response/gps_bricklet/XYZ/get_coordinates
    publish '' to tinkerforge/request/gps_bricklet/XYZ/get_coordinates

Callback¶

Download (example-callback.txt)

# Change XYZ to the UID of your GPS Bricklet

setup:
    # Handle incoming coordinates callbacks
    subscribe to tinkerforge/callback/gps_bricklet/XYZ/coordinates
    publish '{"register": true}' to tinkerforge/register/gps_bricklet/XYZ/coordinates # Register coordinates callback

    # 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!
    publish '{"period": 1000}' to tinkerforge/request/gps_bricklet/XYZ/set_coordinates_callback_period

API¶

Alle veröffentlichten Payloads an die und von den MQTT-Bindings sind im JSON Format.

Falls ein Fehler auftritt, veröffentlichen die Bindings ein JSON-Objekt, das die Fehlermeldung als _ERROR-Member enthält. Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/... für .../request/... und .../callback/... für .../register/....

Grundfunktionen¶

request/gps_bricklet/<UID>/get_coordinates¶

Anfrage:

keine Nutzdaten

Antwort:

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"]
pdop – Typ: int, Einheit: 1/100, Wertebereich: [0 bis 2¹⁶ - 1]
hdop – Typ: int, Einheit: 1/100, Wertebereich: [0 bis 2¹⁶ - 1]
vdop – Typ: int, Einheit: 1/100, Wertebereich: [0 bis 2¹⁶ - 1]
epe – Typ: int, Einheit: 1 cm, Wertebereich: [0 bis 2¹⁶ - 1]

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". 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 request/gps_bricklet/<UID>/get_status).

request/gps_bricklet/<UID>/get_status¶

Anfrage:	keine Nutzdaten
Antwort:	fix – Typ: int, Wertebereich: Siehe Symbole satellites_view – Typ: int, Wertebereich: [0 bis 255] satellites_used – Typ: int, Wertebereich: [0 bis 255]

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, `request/gps_bricklet/<UID>/get_coordinates`, `request/gps_bricklet/<UID>/get_altitude` und `request/gps_bricklet/<UID>/get_motion` geben ungültige Daten zurück
2	2D Fix, nur `request/gps_bricklet/<UID>/get_coordinates` und `request/gps_bricklet/<UID>/get_motion` geben gültige Daten zurück
3	3D Fix, `request/gps_bricklet/<UID>/get_coordinates`, `request/gps_bricklet/<UID>/get_altitude` und `request/gps_bricklet/<UID>/get_motion` geben gültige Daten zurück

Auf dem Bricklet ist eine blaue LED, die den Fix-Status anzeigt.

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

Für fix:

"no_fix" = 1
"2d_fix" = 2
"3d_fix" = 3

request/gps_bricklet/<UID>/get_altitude¶

Anfrage:	keine Nutzdaten
Antwort:	altitude – Typ: int, Einheit: 1 cm, Wertebereich: [-2³¹ bis 2³¹ - 1] geoidal_separation – Typ: int, Einheit: 1 cm, Wertebereich: [-2³¹ bis 2³¹ - 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 request/gps_bricklet/<UID>/get_status).

request/gps_bricklet/<UID>/get_motion¶

Anfrage:	keine Nutzdaten
Antwort:	course – Typ: int, Einheit: 1/100 °, Wertebereich: [0 bis 36000] speed – Typ: int, Einheit: 1/100 km/h, Wertebereich: [0 bis 2³² - 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 request/gps_bricklet/<UID>/get_status).

request/gps_bricklet/<UID>/get_date_time¶

Anfrage:	keine Nutzdaten
Antwort:	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.

Fortgeschrittene Funktionen¶

request/gps_bricklet/<UID>/restart¶

Anfrage:	restart_type – Typ: int, Wertebereich: Siehe Symbole
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 Symbole sind für diese Funktion verfügbar:

Für restart_type:

"hot_start" = 0
"warm_start" = 1
"cold_start" = 2
"factory_reset" = 3

request/gps_bricklet/<UID>/get_identity¶

Anfrage:

keine Nutzdaten

Antwort:

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, ...], 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, ...], 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 2¹⁶ - 1]
_display_name – Typ: string

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. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.

Der Display Name enthält den Anzeigenamen des GPS.

Konfigurationsfunktionen für Callbacks¶

request/gps_bricklet/<UID>/set_coordinates_callback_period¶

Anfrage:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt die Periode mit welcher der register/gps_bricklet/<UID>/coordinates Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/gps_bricklet/<UID>/coordinates Callback wird nur ausgelöst, wenn sich die Koordinaten seit der letzten Auslösung geändert haben.

request/gps_bricklet/<UID>/get_coordinates_callback_period¶

Anfrage:	keine Nutzdaten
Antwort:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von request/gps_bricklet/<UID>/set_coordinates_callback_period gesetzt.

request/gps_bricklet/<UID>/set_status_callback_period¶

Anfrage:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt die Periode mit welcher der register/gps_bricklet/<UID>/status Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/gps_bricklet/<UID>/status Callback wird nur ausgelöst, wenn sich der Status seit der letzten Auslösung geändert hat.

request/gps_bricklet/<UID>/get_status_callback_period¶

Anfrage:	keine Nutzdaten
Antwort:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von request/gps_bricklet/<UID>/set_status_callback_period gesetzt.

request/gps_bricklet/<UID>/set_altitude_callback_period¶

Anfrage:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt die Periode mit welcher der register/gps_bricklet/<UID>/altitude Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/gps_bricklet/<UID>/altitude Callback wird nur ausgelöst, wenn sich die Höhe seit der letzten Auslösung geändert hat.

request/gps_bricklet/<UID>/get_altitude_callback_period¶

Anfrage:	keine Nutzdaten
Antwort:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von request/gps_bricklet/<UID>/set_altitude_callback_period gesetzt.

request/gps_bricklet/<UID>/set_motion_callback_period¶

Anfrage:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt die Periode mit welcher der register/gps_bricklet/<UID>/motion Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/gps_bricklet/<UID>/motion Callback wird nur ausgelöst, wenn sich die Bewegung seit der letzten Auslösung geändert hat.

request/gps_bricklet/<UID>/get_motion_callback_period¶

Anfrage:	keine Nutzdaten
Antwort:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von request/gps_bricklet/<UID>/set_motion_callback_period gesetzt.

request/gps_bricklet/<UID>/set_date_time_callback_period¶

Anfrage:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt die Periode mit welcher der register/gps_bricklet/<UID>/date_time Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/gps_bricklet/<UID>/date_time Callback wird nur ausgelöst, wenn sich das Datum oder die Zeit seit der letzten Auslösung geändert haben.

request/gps_bricklet/<UID>/get_date_time_callback_period¶

Anfrage:	keine Nutzdaten
Antwort:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von request/gps_bricklet/<UID>/set_date_time_callback_period gesetzt.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit dem entsprechenden .../register/...-Topic und einem optionalen Suffix durchgeführt werden. Mit diesem Suffix kann das Callback später deregistriert werden.

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.

register/gps_bricklet/<UID>/coordinates¶

Registrierungsanfrage:

register – Typ: bool

Callback-Antwort:

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"]
pdop – Typ: int, Einheit: 1/100, Wertebereich: [0 bis 2¹⁶ - 1]
hdop – Typ: int, Einheit: 1/100, Wertebereich: [0 bis 2¹⁶ - 1]
vdop – Typ: int, Einheit: 1/100, Wertebereich: [0 bis 2¹⁶ - 1]
epe – Typ: int, Einheit: 1 cm, Wertebereich: [0 bis 2¹⁶ - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/gps_bricklet/<UID>/coordinates[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/gps_bricklet/<UID>/coordinates[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird mit der Periode, wie gesetzt mit request/gps_bricklet/<UID>/set_coordinates_callback_period, ausgelöst. Die Parameter sind die gleichen wie die von request/gps_bricklet/<UID>/get_coordinates.

Der register/gps_bricklet/<UID>/coordinates Callback wird nur ausgelöst, wenn sich die Koordinaten seit der letzten Auslösung geändert haben und ein Fix vorhanden ist (siehe request/gps_bricklet/<UID>/get_status).

register/gps_bricklet/<UID>/status¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	fix – Typ: int, Wertebereich: Siehe Symbole satellites_view – Typ: int, Wertebereich: [0 bis 255] satellites_used – Typ: int, Wertebereich: [0 bis 255]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/gps_bricklet/<UID>/status[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/gps_bricklet/<UID>/status[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird mit der Periode, wie gesetzt mit request/gps_bricklet/<UID>/set_status_callback_period, ausgelöst. Die Parameter sind die gleichen wie die von request/gps_bricklet/<UID>/get_status.

Der register/gps_bricklet/<UID>/status Callback wird nur ausgelöst, wenn sich der Status seit der letzten Auslösung geändert hat.

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

Für fix:

"no_fix" = 1
"2d_fix" = 2
"3d_fix" = 3

register/gps_bricklet/<UID>/altitude¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	altitude – Typ: int, Einheit: 1 cm, Wertebereich: [-2³¹ bis 2³¹ - 1] geoidal_separation – Typ: int, Einheit: 1 cm, Wertebereich: [-2³¹ bis 2³¹ - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/gps_bricklet/<UID>/altitude[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/gps_bricklet/<UID>/altitude[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird mit der Periode, wie gesetzt mit request/gps_bricklet/<UID>/set_altitude_callback_period, ausgelöst. Die Parameter sind die gleichen wie die von request/gps_bricklet/<UID>/get_altitude.

Der register/gps_bricklet/<UID>/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 request/gps_bricklet/<UID>/get_status).

register/gps_bricklet/<UID>/motion¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	course – Typ: int, Einheit: 1/100 °, Wertebereich: [0 bis 36000] speed – Typ: int, Einheit: 1/100 km/h, Wertebereich: [0 bis 2³² - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/gps_bricklet/<UID>/motion[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/gps_bricklet/<UID>/motion[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird mit der Periode, wie gesetzt mit request/gps_bricklet/<UID>/set_motion_callback_period, ausgelöst. Die Parameter sind die gleichen wie die von request/gps_bricklet/<UID>/get_motion.

Der register/gps_bricklet/<UID>/motion Callback wird nur ausgelöst, wenn sich die Bewegung seit der letzten Auslösung geändert hat und ein Fix vorhanden ist (siehe request/gps_bricklet/<UID>/get_status).

register/gps_bricklet/<UID>/date_time¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	date – Typ: int, Wertebereich: [10100 bis 311299] time – Typ: int, Wertebereich: [0 bis 235959999]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/gps_bricklet/<UID>/date_time[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/gps_bricklet/<UID>/date_time[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird mit der Periode, wie gesetzt mit request/gps_bricklet/<UID>/set_date_time_callback_period, ausgelöst. Die Parameter sind die gleichen wie die von request/gps_bricklet/<UID>/get_date_time.

Der register/gps_bricklet/<UID>/date_time Callback wird nur ausgelöst, wenn sich das Datum oder die Zeit seit der letzten Auslösung geändert haben.