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)

1
2
3
4
5
6
# 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)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# 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"-Attribut 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
Response-Payload:
 
  • latitude -- int
  • ns -- string
  • longitude -- int
  • ew -- string
  • pdop -- int
  • hdop -- int
  • vdop -- int
  • epe -- int

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

request/gps_bricklet/<UID>/get_status
Response-Payload:
 
  • fix -- int (hat Symbole)
  • satellites_view -- int
  • satellites_used -- int

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:

  • "NoFix" = 1
  • "2DFix" = 2
  • "3DFix" = 3
request/gps_bricklet/<UID>/get_altitude
Response-Payload:
 
  • altitude -- int
  • geoidal_separation -- int

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

request/gps_bricklet/<UID>/get_motion
Response-Payload:
 
  • course -- int
  • speed -- int

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

request/gps_bricklet/<UID>/get_date_time
Response-Payload:
 
  • date -- int
  • time -- int

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

request/gps_bricklet/<UID>/restart
Request-Payload:
 
  • restart_type -- int (hat Symbole)

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:

  • "HotStart" = 0
  • "WarmStart" = 1
  • "ColdStart" = 2
  • "FactoryReset" = 3
request/gps_bricklet/<UID>/get_identity
Response-Payload:
 
  • uid -- string
  • connected_uid -- string
  • position -- string
  • hardware_version -- [int,int,int]
  • firmware_version -- [int,int,int]
  • device_identifier -- int (hat Symbole)
  • _display_name -- 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 kann 'a', 'b', 'c' oder 'd' sein.

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
Request-Payload:
 
  • period -- int

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

Der Standardwert ist 0.

request/gps_bricklet/<UID>/get_coordinates_callback_period
Response-Payload:
 
  • period -- int

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

request/gps_bricklet/<UID>/set_status_callback_period
Request-Payload:
 
  • period -- int

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

Der Standardwert ist 0.

request/gps_bricklet/<UID>/get_status_callback_period
Response-Payload:
 
  • period -- int

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

request/gps_bricklet/<UID>/set_altitude_callback_period
Request-Payload:
 
  • period -- int

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

Der Standardwert ist 0.

request/gps_bricklet/<UID>/get_altitude_callback_period
Response-Payload:
 
  • period -- int

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

request/gps_bricklet/<UID>/set_motion_callback_period
Request-Payload:
 
  • period -- int

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

Der Standardwert ist 0.

request/gps_bricklet/<UID>/get_motion_callback_period
Response-Payload:
 
  • period -- int

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
Request-Payload:
 
  • period -- int

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

Der Standardwert ist 0.

request/gps_bricklet/<UID>/get_date_time_callback_period
Response-Payload:
 
  • period -- int

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
Request-Payload:
 
  • register -- bool
Response-Payload:
 
  • latitude -- int
  • ns -- string
  • longitude -- int
  • ew -- string
  • pdop -- int
  • hdop -- int
  • vdop -- int
  • epe -- int

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
Request-Payload:
 
  • register -- bool
Response-Payload:
 
  • fix -- int (hat Symbole)
  • satellites_view -- int
  • satellites_used -- int

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:

  • "NoFix" = 1
  • "2DFix" = 2
  • "3DFix" = 3
register/gps_bricklet/<UID>/altitude
Request-Payload:
 
  • register -- bool
Response-Payload:
 
  • altitude -- int
  • geoidal_separation -- int

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
Request-Payload:
 
  • register -- bool
Response-Payload:
 
  • course -- int
  • speed -- int

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
Request-Payload:
 
  • register -- bool
Response-Payload:
 
  • date -- int
  • time -- int

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.