Software / API Bindings / MQTT / API Referenz und Beispiele / Bricklets / GPS Bricklet 3.0

MQTT - GPS Bricklet 3.0¶

Dies ist die Beschreibung der MQTT API Bindings 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 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 3.0

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

Callback¶

Download (example-callback.txt)

# Change XYZ to the UID of your GPS Bricklet 3.0

setup:
    # Handle incoming coordinates callbacks
    subscribe to tinkerforge/callback/gps_v3_bricklet/XYZ/coordinates
    publish '{"register": true}' to tinkerforge/register/gps_v3_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_v3_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_v3_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"]

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

request/gps_v3_bricklet/<UID>/get_status¶

Anfrage:	keine Nutzdaten
Antwort:	has_fix – Typ: bool satellites_view – Typ: int, Wertebereich: [0 bis 255]

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.

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

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

request/gps_v3_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.

request/gps_v3_bricklet/<UID>/get_satellite_system_status¶

Anfrage:	satellite_system – Typ: int, Wertebereich: Siehe Symbole
Antwort:	satellite_numbers – Typ: [int, ...], Länge: variabel, Wertebereich: [0 bis 255] fix – Typ: int, Wertebereich: Siehe Symbole 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]

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 Symbole sind für diese Funktion verfügbar:

Für satellite_system:

"gps" = 0
"glonass" = 1
"galileo" = 2

Für fix:

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

request/gps_v3_bricklet/<UID>/get_satellite_status¶

Anfrage:	satellite_system – Typ: int, Wertebereich: Siehe Symbole satellite_number – Typ: int, Wertebereich: [1 bis 32]
Antwort:	elevation – Typ: int, Einheit: 1 °, Wertebereich: [0 bis 90] azimuth – Typ: int, Einheit: 1 °, Wertebereich: [0 bis 359] snr – Typ: int, Einheit: 1 dB, Wertebereich: [0 bis 99]

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 Symbole sind für diese Funktion verfügbar:

Für satellite_system:

"gps" = 0
"glonass" = 1
"galileo" = 2

Fortgeschrittene Funktionen¶

request/gps_v3_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_v3_bricklet/<UID>/set_fix_led_config¶

Anfrage:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
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 Rhythmus des PPS (Puls pro Sekunde) Ausgangs des GPS Moduls blinken.

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

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

Für config:

"off" = 0
"on" = 1
"show_heartbeat" = 2
"show_fix" = 3
"show_pps" = 4

request/gps_v3_bricklet/<UID>/get_fix_led_config¶

Anfrage:	keine Nutzdaten
Antwort:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von request/gps_v3_bricklet/<UID>/set_fix_led_config gesetzt.

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

Für config:

"off" = 0
"on" = 1
"show_heartbeat" = 2
"show_fix" = 3
"show_pps" = 4

request/gps_v3_bricklet/<UID>/set_sbas_config¶

Anfrage:	sbas_config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0
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.

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

Für sbas_config:

"enabled" = 0
"disabled" = 1

request/gps_v3_bricklet/<UID>/get_sbas_config¶

Anfrage:	keine Nutzdaten
Antwort:	sbas_config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt die SBAS-Konfiguration zurück, wie von request/gps_v3_bricklet/<UID>/set_sbas_config gesetzt.

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

Für sbas_config:

"enabled" = 0
"disabled" = 1

request/gps_v3_bricklet/<UID>/get_spitfp_error_count¶

Anfrage:	keine Nutzdaten
Antwort:	error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 2³² - 1] error_count_message_checksum – Typ: int, Wertebereich: [0 bis 2³² - 1] error_count_frame – Typ: int, Wertebereich: [0 bis 2³² - 1] error_count_overflow – Typ: int, Wertebereich: [0 bis 2³² - 1]

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.

request/gps_v3_bricklet/<UID>/set_status_led_config¶

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

Für config:

"off" = 0
"on" = 1
"show_heartbeat" = 2
"show_status" = 3

request/gps_v3_bricklet/<UID>/get_status_led_config¶

Anfrage:	keine Nutzdaten
Antwort:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von request/gps_v3_bricklet/<UID>/set_status_led_config gesetzt.

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

Für config:

"off" = 0
"on" = 1
"show_heartbeat" = 2
"show_status" = 3

request/gps_v3_bricklet/<UID>/get_chip_temperature¶

Anfrage:	keine Nutzdaten
Antwort:	temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]

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.

request/gps_v3_bricklet/<UID>/reset¶

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.

request/gps_v3_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 3.0.

Konfigurationsfunktionen für Callbacks¶

request/gps_v3_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_v3_bricklet/<UID>/coordinates Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

request/gps_v3_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_v3_bricklet/<UID>/set_coordinates_callback_period gesetzt.

request/gps_v3_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_v3_bricklet/<UID>/status Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

request/gps_v3_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_v3_bricklet/<UID>/set_status_callback_period gesetzt.

request/gps_v3_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_v3_bricklet/<UID>/altitude Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

request/gps_v3_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_v3_bricklet/<UID>/set_altitude_callback_period gesetzt.

request/gps_v3_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_v3_bricklet/<UID>/motion Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

request/gps_v3_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_v3_bricklet/<UID>/set_motion_callback_period gesetzt.

request/gps_v3_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_v3_bricklet/<UID>/date_time Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/gps_v3_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_v3_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_v3_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_v3_bricklet/<UID>/pulse_per_second¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	keine Nutzdaten

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/gps_v3_bricklet/<UID>/pulse_per_second[/<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_v3_bricklet/<UID>/pulse_per_second[/<SUFFIX>]-Topic veröffentlicht.

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.

register/gps_v3_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"]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/gps_v3_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_v3_bricklet/<UID>/coordinates[/<SUFFIX>]-Topic veröffentlicht.

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

Der register/gps_v3_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_v3_bricklet/<UID>/get_status).

register/gps_v3_bricklet/<UID>/status¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	has_fix – Typ: bool satellites_view – Typ: int, Wertebereich: [0 bis 255]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/gps_v3_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_v3_bricklet/<UID>/status[/<SUFFIX>]-Topic veröffentlicht.

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

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

register/gps_v3_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_v3_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_v3_bricklet/<UID>/altitude[/<SUFFIX>]-Topic veröffentlicht.

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

Der register/gps_v3_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_v3_bricklet/<UID>/get_status).

register/gps_v3_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_v3_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_v3_bricklet/<UID>/motion[/<SUFFIX>]-Topic veröffentlicht.

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

Der register/gps_v3_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_v3_bricklet/<UID>/get_status).

register/gps_v3_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_v3_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_v3_bricklet/<UID>/date_time[/<SUFFIX>]-Topic veröffentlicht.

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

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

Interne Funktionen¶

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.

request/gps_v3_bricklet/<UID>/set_bootloader_mode¶

Anfrage:	mode – Typ: int, Wertebereich: Siehe Symbole
Antwort:	status – Typ: int, Wertebereich: Siehe Symbole

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 Symbole sind für diese Funktion verfügbar:

Für mode:

"bootloader" = 0
"firmware" = 1
"bootloader_wait_for_reboot" = 2
"firmware_wait_for_reboot" = 3
"firmware_wait_for_erase_and_reboot" = 4

Für status:

"ok" = 0
"invalid_mode" = 1
"no_change" = 2
"entry_function_not_present" = 3
"device_identifier_incorrect" = 4
"crc_mismatch" = 5

request/gps_v3_bricklet/<UID>/get_bootloader_mode¶

Anfrage:	keine Nutzdaten
Antwort:	mode – Typ: int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe request/gps_v3_bricklet/<UID>/set_bootloader_mode.

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

Für mode:

"bootloader" = 0
"firmware" = 1
"bootloader_wait_for_reboot" = 2
"firmware_wait_for_reboot" = 3
"firmware_wait_for_erase_and_reboot" = 4

request/gps_v3_bricklet/<UID>/set_write_firmware_pointer¶

Anfrage:	pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Antwort:	keine Antwort

Setzt den Firmware-Pointer für request/gps_v3_bricklet/<UID>/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.

request/gps_v3_bricklet/<UID>/write_firmware¶

Anfrage:	data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Antwort:	status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von request/gps_v3_bricklet/<UID>/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.

request/gps_v3_bricklet/<UID>/write_uid¶

Anfrage:	uid – Typ: int, Wertebereich: [0 bis 2³² - 1]
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.

request/gps_v3_bricklet/<UID>/read_uid¶

Anfrage:	keine Nutzdaten
Antwort:	uid – Typ: int, Wertebereich: [0 bis 2³² - 1]

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