Software / API Bindings / C/C++ für Mikrocontroller / API Referenz und Beispiele / Bricklets / GPS Bricklet 3.0

C/C++ für Mikrocontroller - GPS Bricklet 3.0¶

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

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple¶

Download (example_simple.c)

// This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.

#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_gps_v3.h"

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

static TF_GPSV3 gps;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_gps_v3_create(&gps, NULL, hal), "create device object");

    // Get current coordinates
    uint32_t latitude, longitude; char ns, ew;
    check(tf_gps_v3_get_coordinates(&gps, &latitude, &ns, &longitude,
                                    &ew), "get coordinates");

    tf_hal_printf("Latitude: %d 1/%d °\n", latitude, 1000000);
    tf_hal_printf("N/S: %c\n", ns);
    tf_hal_printf("Longitude: %d 1/%d °\n", longitude, 1000000);
    tf_hal_printf("E/W: %c\n", ew);
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    tf_hal_callback_tick(hal, 0);
}

Callback¶

Download (example_callback.c)

// This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.

#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_gps_v3.h"

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

// Callback function for coordinates callback
static void coordinates_handler(TF_GPSV3 *device, uint32_t latitude, char ns,
                                uint32_t longitude, char ew, void *user_data) {
    (void)device; (void)user_data; // avoid unused parameter warning

    tf_hal_printf("Latitude: %d 1/%d °\n", latitude, 1000000);
    tf_hal_printf("N/S: %c\n", ns);
    tf_hal_printf("Longitude: %d 1/%d °\n", longitude, 1000000);
    tf_hal_printf("E/W: %c\n", ew);
    tf_hal_printf("\n");
}

static TF_GPSV3 gps;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_gps_v3_create(&gps, NULL, hal), "create device object");

    // Register coordinates callback to function coordinates_handler
    tf_gps_v3_register_coordinates_callback(&gps,
                                            coordinates_handler,
                                            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!
    check(tf_gps_v3_set_coordinates_callback_period(&gps, 1000), "set coordinates callback period");
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    tf_hal_callback_tick(hal, 0);
}

API¶

Die meistens Funktionen der C/C++ Bindings für Mikrocontroller geben einen Fehlercode (e_code) zurück

Mögliche Fehlercodes sind:

TF_E_OK = 0
TF_E_TIMEOUT = -1
TF_E_INVALID_PARAMETER = -2
TF_E_NOT_SUPPORTED = -3
TF_E_UNKNOWN_ERROR_CODE = -4
TF_E_STREAM_OUT_OF_SYNC = -5
TF_E_INVALID_CHAR_IN_UID = -6
TF_E_UID_TOO_LONG = -7
TF_E_UID_OVERFLOW = -8
TF_E_TOO_MANY_DEVICES = -9
TF_E_DEVICE_NOT_FOUND = -10
TF_E_WRONG_DEVICE_TYPE = -11
TF_E_CALLBACK_EXEC = -12
TF_E_PORT_NOT_FOUND = -13

(wie in errors.h definiert), sowie die Fehlercodes des verwendeten Hardware-Abstraction-Layers (HALs). Mit tf_hal_strerror (im Header das HALs definiert) kann ein Fehlerstring zu einem Fehlercode abgefragt werden.

Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet. Die Bindings schreiben einen Ausgabeparameter nicht, wenn NULL bzw. nullptr übergeben wird. So können uninteressante Ausgaben ignoriert werden.

Keine der folgend aufgelisteten Funktionen ist Thread-sicher. Details finden sich in der Beschreibung der API-Bindings.

Grundfunktionen¶

int tf_gps_v3_create(TF_GPSV3 *gps_v3, const char *uid, TF_HAL *hal)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 * uid – Typ: const char * hal – Typ: TF_HAL *
Rückgabe:	e_code – Typ: int

Erzeugt ein Geräteobjekt gps_v3 mit der optionalen eindeutigen Geräte ID oder dem Portnamen uid_or_port_name und fügt es dem HAL hal hinzu:

TF_GPSV3 gps_v3;
tf_gps_v3_create(&gps_v3, NULL, &ipcon);

Im Normalfall kann uid_or_port_name auf NULL belassen werden. Für weitere Details siehe Abschnitt UID oder Port-Name.

int tf_gps_v3_destroy(TF_GPSV3 *gps_v3)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 *
Rückgabe:	e_code – Typ: int

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

int tf_gps_v3_get_coordinates(TF_GPSV3 *gps_v3, uint32_t *ret_latitude, char *ret_ns, uint32_t *ret_longitude, char *ret_ew)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 *
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']
Rückgabe:	e_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).

Diese Daten sind nur gültig wenn ein Fix vorhanden ist (siehe tf_gps_v3_get_status()).

int tf_gps_v3_get_status(TF_GPSV3 *gps_v3, bool *ret_has_fix, uint8_t *ret_satellites_view)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 *
Ausgabeparameter:	ret_has_fix – Typ: bool ret_satellites_view – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

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.

int tf_gps_v3_get_altitude(TF_GPSV3 *gps_v3, int32_t *ret_altitude, int32_t *ret_geoidal_separation)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 *
Ausgabeparameter:	ret_altitude – Typ: int32_t, Einheit: 1 cm, Wertebereich: [-2³¹ bis 2³¹ - 1] ret_geoidal_separation – Typ: int32_t, Einheit: 1 cm, Wertebereich: [-2³¹ bis 2³¹ - 1]
Rückgabe:	e_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 tf_gps_v3_get_status()).

int tf_gps_v3_get_motion(TF_GPSV3 *gps_v3, uint32_t *ret_course, uint32_t *ret_speed)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 *
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 2³² - 1]
Rückgabe:	e_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 tf_gps_v3_get_status()).

int tf_gps_v3_get_date_time(TF_GPSV3 *gps_v3, uint32_t *ret_date, uint32_t *ret_time)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 *
Ausgabeparameter:	ret_date – Typ: uint32_t, Wertebereich: [10100 bis 311299] ret_time – Typ: uint32_t, Wertebereich: [0 bis 235959999]
Rückgabe:	e_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.

int tf_gps_v3_get_satellite_system_status(TF_GPSV3 *gps_v3, uint8_t satellite_system, uint8_t *ret_satellite_numbers, uint8_t *ret_satellite_numbers_length, uint8_t *ret_fix, uint16_t *ret_pdop, uint16_t *ret_hdop, uint16_t *ret_vdop)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 * satellite_system – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_satellite_numbers – Typ: uint8_t , Wertebereich: [0 bis 255] ret_satellite_numbers_length* – Typ: uint8_t ret_fix – Typ: uint8_t, Wertebereich: Siehe Konstanten ret_pdop – Typ: uint16_t, Einheit: 1/100, Wertebereich: [0 bis 2¹⁶ - 1] ret_hdop – Typ: uint16_t, Einheit: 1/100, Wertebereich: [0 bis 2¹⁶ - 1] ret_vdop – Typ: uint16_t, Einheit: 1/100, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	e_code – Typ: int

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, GLONASS und Galileo unterstützt.

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

Für satellite_system:

TF_GPS_V3_SATELLITE_SYSTEM_GPS = 0
TF_GPS_V3_SATELLITE_SYSTEM_GLONASS = 1
TF_GPS_V3_SATELLITE_SYSTEM_GALILEO = 2

Für ret_fix:

TF_GPS_V3_FIX_NO_FIX = 1
TF_GPS_V3_FIX_2D_FIX = 2
TF_GPS_V3_FIX_3D_FIX = 3

int tf_gps_v3_get_satellite_status(TF_GPSV3 *gps_v3, uint8_t satellite_system, uint8_t satellite_number, int16_t *ret_elevation, int16_t *ret_azimuth, int16_t *ret_snr)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 * satellite_system – Typ: uint8_t, Wertebereich: Siehe Konstanten satellite_number – Typ: uint8_t, Wertebereich: [1 bis 32]
Ausgabeparameter:	ret_elevation – Typ: int16_t, Einheit: 1 °, Wertebereich: [0 bis 90] ret_azimuth – Typ: int16_t, Einheit: 1 °, Wertebereich: [0 bis 359] ret_snr – Typ: int16_t, Einheit: 1 dB, Wertebereich: [0 bis 99]
Rückgabe:	e_code – Typ: int

Gibt die aktuellen Werte von Elevation, Azimutwinkel und SNR für einen gegebenen Satelliten und ein gegebenes Satellitensystem zurück.

Die Satellitennummern teilen sich wie folgt auf:

GPS: 1-32
GLONASS: 65-96
Galileo: 301-332

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

Für satellite_system:

TF_GPS_V3_SATELLITE_SYSTEM_GPS = 0
TF_GPS_V3_SATELLITE_SYSTEM_GLONASS = 1
TF_GPS_V3_SATELLITE_SYSTEM_GALILEO = 2

Fortgeschrittene Funktionen¶

int tf_gps_v3_restart(TF_GPSV3 *gps_v3, uint8_t restart_type)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 * restart_type – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_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:

TF_GPS_V3_RESTART_TYPE_HOT_START = 0
TF_GPS_V3_RESTART_TYPE_WARM_START = 1
TF_GPS_V3_RESTART_TYPE_COLD_START = 2
TF_GPS_V3_RESTART_TYPE_FACTORY_RESET = 3

int tf_gps_v3_set_fix_led_config(TF_GPSV3 *gps_v3, uint8_t config)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 * config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

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

Für config:

TF_GPS_V3_FIX_LED_CONFIG_OFF = 0
TF_GPS_V3_FIX_LED_CONFIG_ON = 1
TF_GPS_V3_FIX_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_GPS_V3_FIX_LED_CONFIG_SHOW_FIX = 3
TF_GPS_V3_FIX_LED_CONFIG_SHOW_PPS = 4

int tf_gps_v3_get_fix_led_config(TF_GPSV3 *gps_v3, uint8_t *ret_config)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 *
Ausgabeparameter:	ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

Gibt die Konfiguration zurück, wie von tf_gps_v3_set_fix_led_config() gesetzt.

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

Für ret_config:

TF_GPS_V3_FIX_LED_CONFIG_OFF = 0
TF_GPS_V3_FIX_LED_CONFIG_ON = 1
TF_GPS_V3_FIX_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_GPS_V3_FIX_LED_CONFIG_SHOW_FIX = 3
TF_GPS_V3_FIX_LED_CONFIG_SHOW_PPS = 4

int tf_gps_v3_set_sbas_config(TF_GPSV3 *gps_v3, uint8_t sbas_config)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 * sbas_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

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

Für sbas_config:

TF_GPS_V3_SBAS_ENABLED = 0
TF_GPS_V3_SBAS_DISABLED = 1

int tf_gps_v3_get_sbas_config(TF_GPSV3 *gps_v3, uint8_t *ret_sbas_config)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 *
Ausgabeparameter:	ret_sbas_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	e_code – Typ: int

Gibt die SBAS-Konfiguration zurück, wie von tf_gps_v3_set_sbas_config() gesetzt.

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

Für ret_sbas_config:

TF_GPS_V3_SBAS_ENABLED = 0
TF_GPS_V3_SBAS_DISABLED = 1

int tf_gps_v3_get_spitfp_error_count(TF_GPSV3 *gps_v3, uint32_t *ret_error_count_ack_checksum, uint32_t *ret_error_count_message_checksum, uint32_t *ret_error_count_frame, uint32_t *ret_error_count_overflow)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 *
Ausgabeparameter:	ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1] ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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.

int tf_gps_v3_set_status_led_config(TF_GPSV3 *gps_v3, uint8_t config)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 * config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

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

Für config:

TF_GPS_V3_STATUS_LED_CONFIG_OFF = 0
TF_GPS_V3_STATUS_LED_CONFIG_ON = 1
TF_GPS_V3_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_GPS_V3_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_gps_v3_get_status_led_config(TF_GPSV3 *gps_v3, uint8_t *ret_config)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 *
Ausgabeparameter:	ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	e_code – Typ: int

Gibt die Konfiguration zurück, wie von tf_gps_v3_set_status_led_config() gesetzt.

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

Für ret_config:

TF_GPS_V3_STATUS_LED_CONFIG_OFF = 0
TF_GPS_V3_STATUS_LED_CONFIG_ON = 1
TF_GPS_V3_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
TF_GPS_V3_STATUS_LED_CONFIG_SHOW_STATUS = 3

int tf_gps_v3_get_chip_temperature(TF_GPSV3 *gps_v3, int16_t *ret_temperature)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 *
Ausgabeparameter:	ret_temperature – Typ: int16_t, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]
Rückgabe:	e_code – Typ: int

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.

int tf_gps_v3_reset(TF_GPSV3 *gps_v3)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 *
Rückgabe:	e_code – Typ: int

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.

int tf_gps_v3_get_identity(TF_GPSV3 *gps_v3, 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_v3 – Typ: TF_GPSV3 *
Ausgabeparameter:	ret_uid – Typ: char[8] ret_connected_uid – Typ: char[8] ret_position – Typ: char, Wertebereich: ['a' bis 'h', '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 2¹⁶ - 1]
Rückgabe:	e_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 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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks¶

int tf_gps_v3_set_coordinates_callback_period(TF_GPSV3 *gps_v3, uint32_t period)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

int tf_gps_v3_get_coordinates_callback_period(TF_GPSV3 *gps_v3, uint32_t *ret_period)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

int tf_gps_v3_set_status_callback_period(TF_GPSV3 *gps_v3, uint32_t period)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

int tf_gps_v3_get_status_callback_period(TF_GPSV3 *gps_v3, uint32_t *ret_period)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

int tf_gps_v3_set_altitude_callback_period(TF_GPSV3 *gps_v3, uint32_t period)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

int tf_gps_v3_get_altitude_callback_period(TF_GPSV3 *gps_v3, uint32_t *ret_period)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

int tf_gps_v3_set_motion_callback_period(TF_GPSV3 *gps_v3, uint32_t period)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

int tf_gps_v3_get_motion_callback_period(TF_GPSV3 *gps_v3, uint32_t *ret_period)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

int tf_gps_v3_set_date_time_callback_period(TF_GPSV3 *gps_v3, uint32_t period)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 * period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

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

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

int tf_gps_v3_get_date_time_callback_period(TF_GPSV3 *gps_v3, uint32_t *ret_period)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 *
Ausgabeparameter:	ret_period – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	e_code – Typ: int

Gibt die Periode zurück, wie von tf_gps_v3_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 entsprechenden tf_gps_v3_register_*_callback Funktion durchgeführt werden. Die user_data, sowie das Gerät, dass das Callback ausgelöst hat, werden dem registrierten Callback-Handler übergeben.

Nur ein Handler kann gleichzeitig auf das selbe Callback registriert werden. Um einen Handler zu deregistrieren, kann die tf_gps_v3_register_*_callback-Funktion mit NULL als Handler aufgerufen werden.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist gegenüber der Verwendung von Abfragen zu bevorzugen. Es muss nur ein Byte abgefragt werden um zu prüfen ob ein Callback vorliegt. Siehe hier Performanceoptimierungen.

Warnung

Aus Callback-Handlern heraus können keine Bindings-Funktionen verwendet werden. Siehe hier Callbacks.

int tf_gps_v3_register_pulse_per_second_callback(TF_GPSV3 *gps_v3, TF_GPSV3_PulsePerSecondHandler handler, void *user_data)¶

void handler(TF_GPSV3 *gps_v3, void *user_data)

Callback-Parameter:	gps_v3 – Typ: TF_GPSV3 * user_data – Typ: void *

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.

int tf_gps_v3_register_coordinates_callback(TF_GPSV3 *gps_v3, TF_GPSV3_CoordinatesHandler handler, void *user_data)¶

void handler(TF_GPSV3 *gps_v3, uint32_t latitude, char ns, uint32_t longitude, char ew, void *user_data)

Callback-Parameter:	gps_v3 – Typ: TF_GPSV3 * 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'] user_data – Typ: void *

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

Der Coordinates Callback wird nur ausgelöst, wenn sich die Koordinaten seit der letzten Auslösung geändert haben und ein Fix vorhanden ist (siehe tf_gps_v3_get_status()).

int tf_gps_v3_register_status_callback(TF_GPSV3 *gps_v3, TF_GPSV3_StatusHandler handler, void *user_data)¶

void handler(TF_GPSV3 *gps_v3, bool has_fix, uint8_t satellites_view, void *user_data)

Callback-Parameter:	gps_v3 – Typ: TF_GPSV3 * has_fix – Typ: bool satellites_view – Typ: uint8_t, Wertebereich: [0 bis 255] user_data – Typ: void *

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

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

int tf_gps_v3_register_altitude_callback(TF_GPSV3 *gps_v3, TF_GPSV3_AltitudeHandler handler, void *user_data)¶

void handler(TF_GPSV3 *gps_v3, int32_t altitude, int32_t geoidal_separation, void *user_data)

Callback-Parameter:	gps_v3 – Typ: TF_GPSV3 * altitude – Typ: int32_t, Einheit: 1 cm, Wertebereich: [-2³¹ bis 2³¹ - 1] geoidal_separation – Typ: int32_t, Einheit: 1 cm, Wertebereich: [-2³¹ bis 2³¹ - 1] user_data – Typ: void *

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

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

int tf_gps_v3_register_motion_callback(TF_GPSV3 *gps_v3, TF_GPSV3_MotionHandler handler, void *user_data)¶

void handler(TF_GPSV3 *gps_v3, uint32_t course, uint32_t speed, void *user_data)

Callback-Parameter:	gps_v3 – Typ: TF_GPSV3 * course – Typ: uint32_t, Einheit: 1/100 °, Wertebereich: [0 bis 36000] speed – Typ: uint32_t, Einheit: 1/100 km/h, Wertebereich: [0 bis 2³² - 1] user_data – Typ: void *

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

Der Motion Callback wird nur ausgelöst, wenn sich die Bewegung seit der letzten Auslösung geändert hat und ein Fix vorhanden ist (siehe tf_gps_v3_get_status()).

int tf_gps_v3_register_date_time_callback(TF_GPSV3 *gps_v3, TF_GPSV3_DateTimeHandler handler, void *user_data)¶

void handler(TF_GPSV3 *gps_v3, uint32_t date, uint32_t time, void *user_data)

Callback-Parameter:	gps_v3 – Typ: TF_GPSV3 * 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 tf_gps_v3_set_date_time_callback_period(), ausgelöst. Die Parameter sind die gleichen wie die von tf_gps_v3_get_date_time().

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

int tf_gps_v3_get_response_expected(TF_GPSV3 *gps_v3, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_response_expected – Typ: bool
Rückgabe:	e_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 tf_gps_v3_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:

TF_GPS_V3_FUNCTION_RESTART = 6
TF_GPS_V3_FUNCTION_SET_FIX_LED_CONFIG = 9
TF_GPS_V3_FUNCTION_SET_COORDINATES_CALLBACK_PERIOD = 11
TF_GPS_V3_FUNCTION_SET_STATUS_CALLBACK_PERIOD = 13
TF_GPS_V3_FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 15
TF_GPS_V3_FUNCTION_SET_MOTION_CALLBACK_PERIOD = 17
TF_GPS_V3_FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 19
TF_GPS_V3_FUNCTION_SET_SBAS_CONFIG = 27
TF_GPS_V3_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_GPS_V3_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_GPS_V3_FUNCTION_RESET = 243
TF_GPS_V3_FUNCTION_WRITE_UID = 248

int tf_gps_v3_set_response_expected(TF_GPSV3 *gps_v3, uint8_t function_id, bool response_expected)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten response_expected – Typ: bool
Rückgabe:	e_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.

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

Für function_id:

TF_GPS_V3_FUNCTION_RESTART = 6
TF_GPS_V3_FUNCTION_SET_FIX_LED_CONFIG = 9
TF_GPS_V3_FUNCTION_SET_COORDINATES_CALLBACK_PERIOD = 11
TF_GPS_V3_FUNCTION_SET_STATUS_CALLBACK_PERIOD = 13
TF_GPS_V3_FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 15
TF_GPS_V3_FUNCTION_SET_MOTION_CALLBACK_PERIOD = 17
TF_GPS_V3_FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 19
TF_GPS_V3_FUNCTION_SET_SBAS_CONFIG = 27
TF_GPS_V3_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
TF_GPS_V3_FUNCTION_SET_STATUS_LED_CONFIG = 239
TF_GPS_V3_FUNCTION_RESET = 243
TF_GPS_V3_FUNCTION_WRITE_UID = 248

int tf_gps_v3_set_response_expected_all(TF_GPSV3 *gps_v3, bool response_expected)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 * response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

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

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.

int tf_gps_v3_set_bootloader_mode(TF_GPSV3 *gps_v3, uint8_t mode, uint8_t *ret_status)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 * mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

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

Für mode:

TF_GPS_V3_BOOTLOADER_MODE_BOOTLOADER = 0
TF_GPS_V3_BOOTLOADER_MODE_FIRMWARE = 1
TF_GPS_V3_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_GPS_V3_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_GPS_V3_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

TF_GPS_V3_BOOTLOADER_STATUS_OK = 0
TF_GPS_V3_BOOTLOADER_STATUS_INVALID_MODE = 1
TF_GPS_V3_BOOTLOADER_STATUS_NO_CHANGE = 2
TF_GPS_V3_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
TF_GPS_V3_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
TF_GPS_V3_BOOTLOADER_STATUS_CRC_MISMATCH = 5

int tf_gps_v3_get_bootloader_mode(TF_GPSV3 *gps_v3, uint8_t *ret_mode)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 *
Ausgabeparameter:	ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:	e_code – Typ: int

Gibt den aktuellen Bootloader-Modus zurück, siehe tf_gps_v3_set_bootloader_mode().

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

Für ret_mode:

TF_GPS_V3_BOOTLOADER_MODE_BOOTLOADER = 0
TF_GPS_V3_BOOTLOADER_MODE_FIRMWARE = 1
TF_GPS_V3_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
TF_GPS_V3_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
TF_GPS_V3_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

int tf_gps_v3_set_write_firmware_pointer(TF_GPSV3 *gps_v3, uint32_t pointer)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 * pointer – Typ: uint32_t, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

Setzt den Firmware-Pointer für tf_gps_v3_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.

int tf_gps_v3_write_firmware(TF_GPSV3 *gps_v3, const uint8_t data[64], uint8_t *ret_status)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 * data – Typ: const uint8_t[64], Wertebereich: [0 bis 255]
Ausgabeparameter:	ret_status – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

Schreibt 64 Bytes Firmware an die Position die vorher von tf_gps_v3_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.

int tf_gps_v3_write_uid(TF_GPSV3 *gps_v3, uint32_t uid)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 * uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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.

int tf_gps_v3_read_uid(TF_GPSV3 *gps_v3, uint32_t *ret_uid)¶

Parameter:	gps_v3 – Typ: TF_GPSV3 *
Ausgabeparameter:	ret_uid – Typ: uint32_t, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	e_code – Typ: int

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

Konstanten¶

TF_GPS_V3_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein GPS Bricklet 3.0 zu identifizieren.

Die Funktionen tf_gps_v3_get_identity() und tf_hal_get_device_info() haben einen device_identifier Ausgabe-Parameter um den Typ des Bricks oder Bricklets anzugeben.

TF_GPS_V3_DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines GPS Bricklet 3.0 dar.