C/C++ - GPS Bricklet

Dies ist die Beschreibung der C/C++ 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 C/C++ API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example_simple.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_gps.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your GPS Bricklet

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    GPS gps;
    gps_create(&gps, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Get current coordinates
    uint32_t latitude, longitude; char ns, ew; uint16_t pdop, hdop, vdop, epe;
    if(gps_get_coordinates(&gps, &latitude, &ns, &longitude, &ew, &pdop, &hdop, &vdop,
                           &epe) < 0) {
        fprintf(stderr, "Could not get coordinates, probably timeout\n");
        return 1;
    }

    printf("Latitude: %f °\n", latitude/1000000.0);
    printf("N/S: %c\n", ns);
    printf("Longitude: %f °\n", longitude/1000000.0);
    printf("E/W: %c\n", ew);

    printf("Press key to exit\n");
    getchar();
    gps_destroy(&gps);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Callback

Download (example_callback.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_gps.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your GPS Bricklet

// Callback function for coordinates callback
void cb_coordinates(uint32_t latitude, char ns, uint32_t longitude, char ew,
                    uint16_t pdop, uint16_t hdop, uint16_t vdop, uint16_t epe,
                    void *user_data) {
    (void)pdop; (void)hdop; (void)vdop; (void)epe;
    (void)user_data; // avoid unused parameter warning

    printf("Latitude: %f °\n", latitude/1000000.0);
    printf("N/S: %c\n", ns);
    printf("Longitude: %f °\n", longitude/1000000.0);
    printf("E/W: %c\n", ew);
    printf("\n");
}

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    GPS gps;
    gps_create(&gps, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Register coordinates callback to function cb_coordinates
    gps_register_callback(&gps,
                          GPS_CALLBACK_COORDINATES,
                          (void (*)(void))cb_coordinates,
                          NULL);

    // 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!
    gps_set_coordinates_callback_period(&gps, 1000);

    printf("Press key to exit\n");
    getchar();
    gps_destroy(&gps);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

API

Jede Funktion der C/C++ Bindings gibt einen Integer zurück, welcher einen Fehlercode beschreibt. Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet.

Mögliche Fehlercodes sind:

  • E_OK = 0
  • E_TIMEOUT = -1
  • E_NO_STREAM_SOCKET = -2
  • E_HOSTNAME_INVALID = -3
  • E_NO_CONNECT = -4
  • E_NO_THREAD = -5
  • E_NOT_ADDED = -6 (wird seit C/C++ Bindings Version 2.0.0 nicht mehr verwendet)
  • E_ALREADY_CONNECTED = -7
  • E_NOT_CONNECTED = -8
  • E_INVALID_PARAMETER = -9
  • E_NOT_SUPPORTED = -10
  • E_UNKNOWN_ERROR_CODE = -11
  • E_STREAM_OUT_OF_SYNC = -12
  • E_INVALID_UID = -13
  • E_NON_ASCII_CHAR_IN_SECRET = -14
  • E_WRONG_DEVICE_TYPE = -15
  • E_DEVICE_REPLACED = -16
  • E_WRONG_RESPONSE_LENGTH = -17

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void gps_create(GPS *gps, const char *uid, IPConnection *ipcon)
Parameter:
  • gps – Typ: GPS *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

Erzeugt ein Geräteobjekt gps mit der eindeutigen Geräte ID uid und fügt es der IP Connection ipcon hinzu:

GPS gps;
gps_create(&gps, "YOUR_DEVICE_UID", &ipcon);

Dieses Geräteobjekt kann benutzt werden, nachdem die IP Connection verbunden.

void gps_destroy(GPS *gps)
Parameter:
  • gps – Typ: GPS *

Entfernt das Geräteobjekt gps von dessen IP Connection und zerstört es. Das Geräteobjekt kann hiernach nicht mehr verwendet werden.

int gps_get_coordinates(GPS *gps, uint32_t *ret_latitude, char *ret_ns, uint32_t *ret_longitude, char *ret_ew, uint16_t *ret_pdop, uint16_t *ret_hdop, uint16_t *ret_vdop, uint16_t *ret_epe)
Parameter:
  • gps – Typ: GPS *
Ausgabeparameter:
  • ret_latitude – Typ: uint32_t, Einheit: 1/1000000 °, Wertebereich: [0 bis 90000000]
  • ret_ns – Typ: char, Wertebereich: ['N', 'S']
  • ret_longitude – Typ: uint32_t, Einheit: 1/1000000 °, Wertebereich: [0 bis 180000000]
  • ret_ew – Typ: char, Wertebereich: ['E', 'W']
  • ret_pdop – Typ: uint16_t, Einheit: 1/100, Wertebereich: [0 bis 216 - 1]
  • ret_hdop – Typ: uint16_t, Einheit: 1/100, Wertebereich: [0 bis 216 - 1]
  • ret_vdop – Typ: uint16_t, Einheit: 1/100, Wertebereich: [0 bis 216 - 1]
  • ret_epe – Typ: uint16_t, Einheit: 1 cm, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: 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". 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 gps_get_status()).

int gps_get_status(GPS *gps, uint8_t *ret_fix, uint8_t *ret_satellites_view, uint8_t *ret_satellites_used)
Parameter:
  • gps – Typ: GPS *
Ausgabeparameter:
  • ret_fix – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • ret_satellites_view – Typ: uint8_t, Wertebereich: [0 bis 255]
  • ret_satellites_used – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: 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, gps_get_coordinates(), gps_get_altitude() und gps_get_motion() geben ungültige Daten zurück
2 2D Fix, nur gps_get_coordinates() und gps_get_motion() geben gültige Daten zurück
3 3D Fix, gps_get_coordinates(), gps_get_altitude() und gps_get_motion() geben gültige Daten zurück

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

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

Für ret_fix:

  • GPS_FIX_NO_FIX = 1
  • GPS_FIX_2D_FIX = 2
  • GPS_FIX_3D_FIX = 3
int gps_get_altitude(GPS *gps, int32_t *ret_altitude, int32_t *ret_geoidal_separation)
Parameter:
  • gps – Typ: GPS *
Ausgabeparameter:
  • ret_altitude – Typ: int32_t, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1]
  • ret_geoidal_separation – Typ: int32_t, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1]
Rückgabe:
  • error_code – Typ: int

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

int gps_get_motion(GPS *gps, uint32_t *ret_course, uint32_t *ret_speed)
Parameter:
  • gps – Typ: GPS *
Ausgabeparameter:
  • ret_course – Typ: uint32_t, Einheit: 1/100 °, Wertebereich: [0 bis 36000]
  • ret_speed – Typ: uint32_t, Einheit: 1/100 km/h, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

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

int gps_get_date_time(GPS *gps, uint32_t *ret_date, uint32_t *ret_time)
Parameter:
  • gps – Typ: GPS *
Ausgabeparameter:
  • ret_date – Typ: uint32_t, Wertebereich: [10100 bis 311299]
  • ret_time – Typ: uint32_t, Wertebereich: [0 bis 235959999]
Rückgabe:
  • error_code – Typ: 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.07.13 als Datum und 195923568 bedeutet 19:59:23.568 als Zeit.

Fortgeschrittene Funktionen

int gps_restart(GPS *gps, uint8_t restart_type)
Parameter:
  • gps – Typ: GPS *
  • restart_type – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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

Für restart_type:

  • GPS_RESTART_TYPE_HOT_START = 0
  • GPS_RESTART_TYPE_WARM_START = 1
  • GPS_RESTART_TYPE_COLD_START = 2
  • GPS_RESTART_TYPE_FACTORY_RESET = 3
int gps_get_identity(GPS *gps, char ret_uid[8], char ret_connected_uid[8], char *ret_position, uint8_t ret_hardware_version[3], uint8_t ret_firmware_version[3], uint16_t *ret_device_identifier)
Parameter:
  • gps – Typ: GPS *
Ausgabeparameter:
  • ret_uid – Typ: char[8]
  • ret_connected_uid – Typ: char[8]
  • ret_position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • ret_hardware_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
  • ret_firmware_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
  • ret_device_identifier – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks

void gps_register_callback(GPS *gps, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • gps – Typ: GPS *
  • callback_id – Typ: int16_t
  • function – Typ: void (*)(void)
  • user_data – Typ: void *

Registriert die function für die gegebene callback_id. Die user_data werden der Funktion als letztes Parameter mit übergeben.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

int gps_set_coordinates_callback_period(GPS *gps, uint32_t period)
Parameter:
  • gps – Typ: GPS *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Setzt die Periode mit welcher der GPS_CALLBACK_COORDINATES Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der GPS_CALLBACK_COORDINATES Callback wird nur ausgelöst, wenn sich die Koordinaten seit der letzten Auslösung geändert haben.

int gps_get_coordinates_callback_period(GPS *gps, uint32_t *ret_period)
Parameter:
  • gps – Typ: GPS *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Gibt die Periode zurück, wie von gps_set_coordinates_callback_period() gesetzt.

int gps_set_status_callback_period(GPS *gps, uint32_t period)
Parameter:
  • gps – Typ: GPS *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Setzt die Periode mit welcher der GPS_CALLBACK_STATUS Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der GPS_CALLBACK_STATUS Callback wird nur ausgelöst, wenn sich der Status seit der letzten Auslösung geändert hat.

int gps_get_status_callback_period(GPS *gps, uint32_t *ret_period)
Parameter:
  • gps – Typ: GPS *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Gibt die Periode zurück, wie von gps_set_status_callback_period() gesetzt.

int gps_set_altitude_callback_period(GPS *gps, uint32_t period)
Parameter:
  • gps – Typ: GPS *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Setzt die Periode mit welcher der GPS_CALLBACK_ALTITUDE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der GPS_CALLBACK_ALTITUDE Callback wird nur ausgelöst, wenn sich die Höhe seit der letzten Auslösung geändert hat.

int gps_get_altitude_callback_period(GPS *gps, uint32_t *ret_period)
Parameter:
  • gps – Typ: GPS *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Gibt die Periode zurück, wie von gps_set_altitude_callback_period() gesetzt.

int gps_set_motion_callback_period(GPS *gps, uint32_t period)
Parameter:
  • gps – Typ: GPS *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Setzt die Periode mit welcher der GPS_CALLBACK_MOTION Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der GPS_CALLBACK_MOTION Callback wird nur ausgelöst, wenn sich die Bewegung seit der letzten Auslösung geändert hat.

int gps_get_motion_callback_period(GPS *gps, uint32_t *ret_period)
Parameter:
  • gps – Typ: GPS *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Gibt die Periode zurück, wie von gps_set_motion_callback_period() gesetzt.

int gps_set_date_time_callback_period(GPS *gps, uint32_t period)
Parameter:
  • gps – Typ: GPS *
  • period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Setzt die Periode mit welcher der GPS_CALLBACK_DATE_TIME Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der GPS_CALLBACK_DATE_TIME Callback wird nur ausgelöst, wenn sich das Datum oder die Zeit seit der letzten Auslösung geändert haben.

int gps_get_date_time_callback_period(GPS *gps, uint32_t *ret_period)
Parameter:
  • gps – Typ: GPS *
Ausgabeparameter:
  • ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • error_code – Typ: int

Gibt die Periode zurück, wie von gps_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 der gps_register_callback() Funktion durchgeführt werden:

void my_callback(int value, void *user_data) {
    printf("Value: %d\n", value);
}

gps_register_callback(&gps,
                      GPS_CALLBACK_EXAMPLE,
                      (void (*)(void))my_callback,
                      NULL);

Die verfügbaren Konstanten mit den zugehörigen Funktionssignaturen werden weiter unten beschrieben.

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.

GPS_CALLBACK_COORDINATES
void callback(uint32_t latitude, char ns, uint32_t longitude, char ew, uint16_t pdop, uint16_t hdop, uint16_t vdop, uint16_t epe, void *user_data)
Callback-Parameter:
  • latitude – Typ: uint32_t, Einheit: 1/1000000 °, Wertebereich: [0 bis 90000000]
  • ns – Typ: char, Wertebereich: ['N', 'S']
  • longitude – Typ: uint32_t, Einheit: 1/1000000 °, Wertebereich: [0 bis 180000000]
  • ew – Typ: char, Wertebereich: ['E', 'W']
  • pdop – Typ: uint16_t, Einheit: 1/100, Wertebereich: [0 bis 216 - 1]
  • hdop – Typ: uint16_t, Einheit: 1/100, Wertebereich: [0 bis 216 - 1]
  • vdop – Typ: uint16_t, Einheit: 1/100, Wertebereich: [0 bis 216 - 1]
  • epe – Typ: uint16_t, Einheit: 1 cm, Wertebereich: [0 bis 216 - 1]
  • user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit gps_set_coordinates_callback_period(), ausgelöst. Die Parameter sind die gleichen wie die von gps_get_coordinates().

Der GPS_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 gps_get_status()).

GPS_CALLBACK_STATUS
void callback(uint8_t fix, uint8_t satellites_view, uint8_t satellites_used, void *user_data)
Callback-Parameter:
  • fix – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • satellites_view – Typ: uint8_t, Wertebereich: [0 bis 255]
  • satellites_used – Typ: uint8_t, Wertebereich: [0 bis 255]
  • user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit gps_set_status_callback_period(), ausgelöst. Die Parameter sind die gleichen wie die von gps_get_status().

Der GPS_CALLBACK_STATUS Callback wird nur ausgelöst, wenn sich der Status seit der letzten Auslösung geändert hat.

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

Für fix:

  • GPS_FIX_NO_FIX = 1
  • GPS_FIX_2D_FIX = 2
  • GPS_FIX_3D_FIX = 3
GPS_CALLBACK_ALTITUDE
void callback(int32_t altitude, int32_t geoidal_separation, void *user_data)
Callback-Parameter:
  • altitude – Typ: int32_t, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1]
  • geoidal_separation – Typ: int32_t, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1]
  • user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit gps_set_altitude_callback_period(), ausgelöst. Die Parameter sind die gleichen wie die von gps_get_altitude().

Der GPS_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 gps_get_status()).

GPS_CALLBACK_MOTION
void callback(uint32_t course, uint32_t speed, void *user_data)
Callback-Parameter:
  • course – Typ: uint32_t, Einheit: 1/100 °, Wertebereich: [0 bis 36000]
  • speed – Typ: uint32_t, Einheit: 1/100 km/h, Wertebereich: [0 bis 232 - 1]
  • user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit gps_set_motion_callback_period(), ausgelöst. Die Parameter sind die gleichen wie die von gps_get_motion().

Der GPS_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 gps_get_status()).

GPS_CALLBACK_DATE_TIME
void callback(uint32_t date, uint32_t time, void *user_data)
Callback-Parameter:
  • date – Typ: uint32_t, Wertebereich: [10100 bis 311299]
  • time – Typ: uint32_t, Wertebereich: [0 bis 235959999]
  • user_data – Typ: void *

Dieser Callback wird mit der Periode, wie gesetzt mit gps_set_date_time_callback_period(), ausgelöst. Die Parameter sind die gleichen wie die von gps_get_date_time().

Der GPS_CALLBACK_DATE_TIME Callback wird nur ausgelöst, wenn sich das Datum oder die Zeit seit der letzten Auslösung geändert haben.

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

int gps_get_api_version(GPS *gps, uint8_t ret_api_version[3])
Parameter:
  • gps – Typ: GPS *
Ausgabeparameter:
  • ret_api_version – Typ: uint8_t[3]
    • 0: major – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

int gps_get_response_expected(GPS *gps, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • gps – Typ: GPS *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels gps_set_response_expected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für function_id:

  • GPS_FUNCTION_RESTART = 6
  • GPS_FUNCTION_SET_COORDINATES_CALLBACK_PERIOD = 7
  • GPS_FUNCTION_SET_STATUS_CALLBACK_PERIOD = 9
  • GPS_FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 11
  • GPS_FUNCTION_SET_MOTION_CALLBACK_PERIOD = 13
  • GPS_FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 15
int gps_set_response_expected(GPS *gps, uint8_t function_id, bool response_expected)
Parameter:
  • gps – Typ: GPS *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für function_id:

  • GPS_FUNCTION_RESTART = 6
  • GPS_FUNCTION_SET_COORDINATES_CALLBACK_PERIOD = 7
  • GPS_FUNCTION_SET_STATUS_CALLBACK_PERIOD = 9
  • GPS_FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 11
  • GPS_FUNCTION_SET_MOTION_CALLBACK_PERIOD = 13
  • GPS_FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 15
int gps_set_response_expected_all(GPS *gps, bool response_expected)
Parameter:
  • gps – Typ: GPS *
  • response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten

GPS_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein GPS Bricklet zu identifizieren.

Die gps_get_identity() Funktion und der IPCON_CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

GPS_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines GPS Bricklet dar.