Delphi/Lazarus - GPS Bricklet 2.0

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

Eine Installationanleitung für die Delphi/Lazarus API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.pas)

 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
program ExampleSimple;

{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}

uses
  SysUtils, IPConnection, BrickletGPSV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    gps: TBrickletGPSV2;
  public
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your GPS Bricklet 2.0 }

var
  e: TExample;

procedure TExample.Execute;
var latitude, longitude: longword; ns, ew: char;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  gps := TBrickletGPSV2.Create(UID, ipcon);

  { Connect to brickd }
  ipcon.Connect(HOST, PORT);
  { Don't use device before ipcon is connected }

  { Get current coordinates }
  gps.GetCoordinates(latitude, ns, longitude, ew);

  WriteLn(Format('Latitude: %f °', [latitude/1000000.0]));
  WriteLn(Format('N/S: %s', [ns]));
  WriteLn(Format('Longitude: %f °', [longitude/1000000.0]));
  WriteLn(Format('E/W: %s', [ew]));

  WriteLn('Press key to exit');
  ReadLn;
  ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;

begin
  e := TExample.Create;
  e.Execute;
  e.Destroy;
end.

Callback

Download (ExampleCallback.pas)

 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
57
58
59
60
61
62
63
64
65
66
67
68
69
program ExampleCallback;

{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}

uses
  SysUtils, IPConnection, BrickletGPSV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    gps: TBrickletGPSV2;
  public
    procedure CoordinatesCB(sender: TBrickletGPSV2; const latitude: longword;
                            const ns: char; const longitude: longword; const ew: char);
    procedure Execute;
  end;

const
  HOST = 'localhost';
  PORT = 4223;
  UID = 'XYZ'; { Change XYZ to the UID of your GPS Bricklet 2.0 }

var
  e: TExample;

{ Callback procedure for coordinates callback }
procedure TExample.CoordinatesCB(sender: TBrickletGPSV2; const latitude: longword;
                                 const ns: char; const longitude: longword;
                                 const ew: char);
begin
  WriteLn(Format('Latitude: %f °', [latitude/1000000.0]));
  WriteLn(Format('N/S: %s', [ns]));
  WriteLn(Format('Longitude: %f °', [longitude/1000000.0]));
  WriteLn(Format('E/W: %s', [ew]));
  WriteLn('');
end;

procedure TExample.Execute;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  gps := TBrickletGPSV2.Create(UID, ipcon);

  { Connect to brickd }
  ipcon.Connect(HOST, PORT);
  { Don't use device before ipcon is connected }

  { Register coordinates callback to procedure CoordinatesCB }
  gps.OnCoordinates := {$ifdef FPC}@{$endif}CoordinatesCB;

  { 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.SetCoordinatesCallbackPeriod(1000);

  WriteLn('Press key to exit');
  ReadLn;
  ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;

begin
  e := TExample.Create;
  e.Execute;
  e.Destroy;
end.

API

Da Delphi nicht mehrere Rückgabewerte direkt unterstützt, wird das out Schlüsselwort genutzt um mehrere Werte von einer Funktion zurückzugeben.

Alle folgend aufgelisteten Funktionen und Prozeduren sind Thread-sicher.

Grundfunktionen

constructor TBrickletGPSV2.Create(const uid: string; ipcon: TIPConnection)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: TIPConnection
Rückgabe:
  • gpsV2 – Typ: TBrickletGPSV2

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

gpsV2 := TBrickletGPSV2.Create('YOUR_DEVICE_UID', ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

procedure TBrickletGPSV2.GetCoordinates(out latitude: longword; out ns: char; out longitude: longword; out ew: char)
Ausgabeparameter:
  • latitude – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • ns – Typ: char
  • longitude – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • ew – Typ: char

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 GetStatus).

procedure TBrickletGPSV2.GetStatus(out hasFix: boolean; out satellitesView: byte)
Ausgabeparameter:
  • hasFix – Typ: boolean
  • satellitesView – Typ: byte, 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.

procedure TBrickletGPSV2.GetAltitude(out altitude: longint; out geoidalSeparation: longint)
Ausgabeparameter:
  • altitude – Typ: longint, Wertebereich: [-231 bis 231 - 1]
  • geoidalSeparation – Typ: longint, Wertebereich: [-231 bis 231 - 1]

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 GetStatus).

procedure TBrickletGPSV2.GetMotion(out course: longword; out speed: longword)
Ausgabeparameter:
  • course – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • speed – Typ: longword, Wertebereich: [0 bis 232 - 1]

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 GetStatus).

procedure TBrickletGPSV2.GetDateTime(out date: longword; out time: longword)
Ausgabeparameter:
  • date – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • time – Typ: longword, Wertebereich: [0 bis 232 - 1]

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.

procedure TBrickletGPSV2.GetSatelliteSystemStatus(const satelliteSystem: byte; out satelliteNumbers: array of byte; out fix: byte; out pdop: word; out hdop: word; out vdop: word)
Parameter:
  • satelliteSystem – Typ: byte, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • satelliteNumbers – Typ: array of byte, Wertebereich: [0 bis 255]
  • fix – Typ: byte, Wertebereich: Siehe Konstanten
  • pdop – Typ: word, Wertebereich: [0 bis 216 - 1]
  • hdop – Typ: word, Wertebereich: [0 bis 216 - 1]
  • vdop – Typ: word, Wertebereich: [0 bis 216 - 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 Konstanten sind für diese Funktion verfügbar:

Für satelliteSystem:

  • BRICKLET_GPS_V2_SATELLITE_SYSTEM_GPS = 0
  • BRICKLET_GPS_V2_SATELLITE_SYSTEM_GLONASS = 1
  • BRICKLET_GPS_V2_SATELLITE_SYSTEM_GALILEO = 2

Für fix:

  • BRICKLET_GPS_V2_FIX_NO_FIX = 1
  • BRICKLET_GPS_V2_FIX_2D_FIX = 2
  • BRICKLET_GPS_V2_FIX_3D_FIX = 3
procedure TBrickletGPSV2.GetSatelliteStatus(const satelliteSystem: byte; const satelliteNumber: byte; out elevation: smallint; out azimuth: smallint; out snr: smallint)
Parameter:
  • satelliteSystem – Typ: byte, Wertebereich: Siehe Konstanten
  • satelliteNumber – Typ: byte, Wertebereich: [0 bis 255]
Ausgabeparameter:
  • elevation – Typ: smallint, Wertebereich: [-215 bis 215 - 1]
  • azimuth – Typ: smallint, Wertebereich: [-215 bis 215 - 1]
  • snr – Typ: smallint, Wertebereich: [-215 bis 215 - 1]

Gibt die aktuellen Werte von

  • Elevation (0° - 90°),
  • Azimutwinkel (0° - 359°) und
  • SNR (0dB - 99dB)

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

Für satelliteSystem:

  • BRICKLET_GPS_V2_SATELLITE_SYSTEM_GPS = 0
  • BRICKLET_GPS_V2_SATELLITE_SYSTEM_GLONASS = 1
  • BRICKLET_GPS_V2_SATELLITE_SYSTEM_GALILEO = 2

Fortgeschrittene Funktionen

procedure TBrickletGPSV2.Restart(const restartType: byte)
Parameter:
  • restartType – Typ: byte, Wertebereich: Siehe Konstanten

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 restartType:

  • BRICKLET_GPS_V2_RESTART_TYPE_HOT_START = 0
  • BRICKLET_GPS_V2_RESTART_TYPE_WARM_START = 1
  • BRICKLET_GPS_V2_RESTART_TYPE_COLD_START = 2
  • BRICKLET_GPS_V2_RESTART_TYPE_FACTORY_RESET = 3
procedure TBrickletGPSV2.SetFixLEDConfig(const config: byte)
Parameter:
  • config – Typ: byte, Wertebereich: Siehe Konstanten

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 Rythmus des PPS (Puls pro Sekunde) Ausgangs des GPS Moduls blinken.

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

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

Für config:

  • BRICKLET_GPS_V2_FIX_LED_CONFIG_OFF = 0
  • BRICKLET_GPS_V2_FIX_LED_CONFIG_ON = 1
  • BRICKLET_GPS_V2_FIX_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_GPS_V2_FIX_LED_CONFIG_SHOW_FIX = 3
  • BRICKLET_GPS_V2_FIX_LED_CONFIG_SHOW_PPS = 4
function TBrickletGPSV2.GetFixLEDConfig: byte
Rückgabe:
  • config – Typ: byte, Wertebereich: Siehe Konstanten

Gibt die Konfiguration zurück, wie von SetFixLEDConfig gesetzt.

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

Für config:

  • BRICKLET_GPS_V2_FIX_LED_CONFIG_OFF = 0
  • BRICKLET_GPS_V2_FIX_LED_CONFIG_ON = 1
  • BRICKLET_GPS_V2_FIX_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_GPS_V2_FIX_LED_CONFIG_SHOW_FIX = 3
  • BRICKLET_GPS_V2_FIX_LED_CONFIG_SHOW_PPS = 4
procedure TBrickletGPSV2.SetSBASConfig(const sbasConfig: byte)
Parameter:
  • sbasConfig – Typ: byte, Wertebereich: Siehe Konstanten

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.

Standardmäßig ist SBAS aktiviert und die Aktualisierungsrate 5Hz.

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

Für sbasConfig:

  • BRICKLET_GPS_V2_SBAS_ENABLED = 0
  • BRICKLET_GPS_V2_SBAS_DISABLED = 1

Neu in Version 2.0.2 (Plugin).

function TBrickletGPSV2.GetSBASConfig: byte
Rückgabe:
  • sbasConfig – Typ: byte, Wertebereich: Siehe Konstanten

Gibt die SBAS-Konfiguration zurück, wie von SetSBASConfig gesetzt.

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

Für sbasConfig:

  • BRICKLET_GPS_V2_SBAS_ENABLED = 0
  • BRICKLET_GPS_V2_SBAS_DISABLED = 1

Neu in Version 2.0.2 (Plugin).

function TBrickletGPSV2.GetAPIVersion: array [0..2] of byte
Rückgabe:
  • apiVersion – Typ: array [0..2] of byte, Wertebereich: [0 bis 255]

Gibt die Version der API Definition (Major, Minor, Revision) 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.

function TBrickletGPSV2.GetResponseExpected(const functionId: byte): boolean
Parameter:
  • functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: boolean

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 SetResponseExpected. 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 functionId:

  • BRICKLET_GPS_V2_FUNCTION_RESTART = 6
  • BRICKLET_GPS_V2_FUNCTION_SET_FIX_LED_CONFIG = 9
  • BRICKLET_GPS_V2_FUNCTION_SET_COORDINATES_CALLBACK_PERIOD = 11
  • BRICKLET_GPS_V2_FUNCTION_SET_STATUS_CALLBACK_PERIOD = 13
  • BRICKLET_GPS_V2_FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 15
  • BRICKLET_GPS_V2_FUNCTION_SET_MOTION_CALLBACK_PERIOD = 17
  • BRICKLET_GPS_V2_FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 19
  • BRICKLET_GPS_V2_FUNCTION_SET_SBAS_CONFIG = 27
  • BRICKLET_GPS_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_GPS_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_GPS_V2_FUNCTION_RESET = 243
  • BRICKLET_GPS_V2_FUNCTION_WRITE_UID = 248
procedure TBrickletGPSV2.SetResponseExpected(const functionId: byte; const responseExpected: boolean)
Parameter:
  • functionId – Typ: byte, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: boolean

Ä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 functionId:

  • BRICKLET_GPS_V2_FUNCTION_RESTART = 6
  • BRICKLET_GPS_V2_FUNCTION_SET_FIX_LED_CONFIG = 9
  • BRICKLET_GPS_V2_FUNCTION_SET_COORDINATES_CALLBACK_PERIOD = 11
  • BRICKLET_GPS_V2_FUNCTION_SET_STATUS_CALLBACK_PERIOD = 13
  • BRICKLET_GPS_V2_FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 15
  • BRICKLET_GPS_V2_FUNCTION_SET_MOTION_CALLBACK_PERIOD = 17
  • BRICKLET_GPS_V2_FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 19
  • BRICKLET_GPS_V2_FUNCTION_SET_SBAS_CONFIG = 27
  • BRICKLET_GPS_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_GPS_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_GPS_V2_FUNCTION_RESET = 243
  • BRICKLET_GPS_V2_FUNCTION_WRITE_UID = 248
procedure TBrickletGPSV2.SetResponseExpectedAll(const responseExpected: boolean)
Parameter:
  • responseExpected – Typ: boolean

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

procedure TBrickletGPSV2.GetSPITFPErrorCount(out errorCountAckChecksum: longword; out errorCountMessageChecksum: longword; out errorCountFrame: longword; out errorCountOverflow: longword)
Ausgabeparameter:
  • errorCountAckChecksum – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: longword, Wertebereich: [0 bis 232 - 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.

function TBrickletGPSV2.SetBootloaderMode(const mode: byte): byte
Parameter:
  • mode – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: byte, Wertebereich: Siehe Konstanten

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 Bootlodaer- 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:

  • BRICKLET_GPS_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_GPS_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_GPS_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_GPS_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_GPS_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • BRICKLET_GPS_V2_BOOTLOADER_STATUS_OK = 0
  • BRICKLET_GPS_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • BRICKLET_GPS_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • BRICKLET_GPS_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BRICKLET_GPS_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BRICKLET_GPS_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
function TBrickletGPSV2.GetBootloaderMode: byte
Rückgabe:
  • mode – Typ: byte, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode.

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

Für mode:

  • BRICKLET_GPS_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_GPS_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_GPS_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_GPS_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_GPS_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
procedure TBrickletGPSV2.SetWriteFirmwarePointer(const pointer: longword)
Parameter:
  • pointer – Typ: longword, Wertebereich: [0 bis 232 - 1]

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

function TBrickletGPSV2.WriteFirmware(const data: array [0..63] of byte): byte
Parameter:
  • data – Typ: array [0..63] of byte, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: byte, Wertebereich: [0 bis 255]

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

procedure TBrickletGPSV2.SetStatusLEDConfig(const config: byte)
Parameter:
  • config – Typ: byte, Wertebereich: Siehe Konstanten

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:

  • BRICKLET_GPS_V2_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_GPS_V2_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_GPS_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_GPS_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletGPSV2.GetStatusLEDConfig: byte
Rückgabe:
  • config – Typ: byte, Wertebereich: Siehe Konstanten

Gibt die Konfiguration zurück, wie von SetStatusLEDConfig gesetzt.

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

Für config:

  • BRICKLET_GPS_V2_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_GPS_V2_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_GPS_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_GPS_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletGPSV2.GetChipTemperature: smallint
Rückgabe:
  • temperature – Typ: smallint, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur in °C, 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.

procedure TBrickletGPSV2.Reset

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.

procedure TBrickletGPSV2.WriteUID(const uid: longword)
Parameter:
  • uid – Typ: longword, Wertebereich: [0 bis 232 - 1]

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.

function TBrickletGPSV2.ReadUID: longword
Rückgabe:
  • uid – Typ: longword, Wertebereich: [0 bis 232 - 1]

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

procedure TBrickletGPSV2.GetIdentity(out uid: string; out connectedUid: string; out position: char; out hardwareVersion: array [0..2] of byte; out firmwareVersion: array [0..2] of byte; out deviceIdentifier: word)
Ausgabeparameter:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: char
  • hardwareVersion – Typ: array [0..2] of byte, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: array [0..2] of byte, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: word, Wertebereich: [0 bis 216 - 1]

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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks

procedure TBrickletGPSV2.SetCoordinatesCallbackPeriod(const period: longword)
Parameter:
  • period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

function TBrickletGPSV2.GetCoordinatesCallbackPeriod: longword
Rückgabe:
  • period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetCoordinatesCallbackPeriod gesetzt.

procedure TBrickletGPSV2.SetStatusCallbackPeriod(const period: longword)
Parameter:
  • period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

function TBrickletGPSV2.GetStatusCallbackPeriod: longword
Rückgabe:
  • period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetStatusCallbackPeriod gesetzt.

procedure TBrickletGPSV2.SetAltitudeCallbackPeriod(const period: longword)
Parameter:
  • period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

function TBrickletGPSV2.GetAltitudeCallbackPeriod: longword
Rückgabe:
  • period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetAltitudeCallbackPeriod gesetzt.

procedure TBrickletGPSV2.SetMotionCallbackPeriod(const period: longword)
Parameter:
  • period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

function TBrickletGPSV2.GetMotionCallbackPeriod: longword
Rückgabe:
  • period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetMotionCallbackPeriod gesetzt.

procedure TBrickletGPSV2.SetDateTimeCallbackPeriod(const period: longword)
Parameter:
  • period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

function TBrickletGPSV2.GetDateTimeCallbackPeriod: longword
Rückgabe:
  • period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetDateTimeCallbackPeriod gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:

procedure TExample.MyCallback(sender: TBrickletGPSV2; const param: word);
begin
  WriteLn(param);
end;

gpsV2.OnExample := {$ifdef FPC}@{$endif}example.MyCallback;

Die verfügbaren Callback Properties und ihre Parametertypen 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.

property TBrickletGPSV2.OnPulsePerSecond
procedure(sender: TBrickletGPSV2) of object;
Callback-Parameter:
  • sender – Typ: TBrickletGPSV2

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.

property TBrickletGPSV2.OnCoordinates
procedure(sender: TBrickletGPSV2; const latitude: longword; const ns: char; const longitude: longword; const ew: char) of object;
Callback-Parameter:
  • sender – Typ: TBrickletGPSV2
  • latitude – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • ns – Typ: char
  • longitude – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • ew – Typ: char

Dieser Callback wird mit der Periode, wie gesetzt mit SetCoordinatesCallbackPeriod, ausgelöst. Die Parameter sind die gleichen wie die von GetCoordinates.

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

property TBrickletGPSV2.OnStatus
procedure(sender: TBrickletGPSV2; const hasFix: boolean; const satellitesView: byte) of object;
Callback-Parameter:
  • sender – Typ: TBrickletGPSV2
  • hasFix – Typ: boolean
  • satellitesView – Typ: byte, Wertebereich: [0 bis 255]

Dieser Callback wird mit der Periode, wie gesetzt mit SetStatusCallbackPeriod, ausgelöst. Die Parameter sind die gleichen wie die von GetStatus.

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

property TBrickletGPSV2.OnAltitude
procedure(sender: TBrickletGPSV2; const altitude: longint; const geoidalSeparation: longint) of object;
Callback-Parameter:
  • sender – Typ: TBrickletGPSV2
  • altitude – Typ: longint, Wertebereich: [-231 bis 231 - 1]
  • geoidalSeparation – Typ: longint, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit SetAltitudeCallbackPeriod, ausgelöst. Die Parameter sind die gleichen wie die von GetAltitude.

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

property TBrickletGPSV2.OnMotion
procedure(sender: TBrickletGPSV2; const course: longword; const speed: longword) of object;
Callback-Parameter:
  • sender – Typ: TBrickletGPSV2
  • course – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • speed – Typ: longword, Wertebereich: [0 bis 232 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit SetMotionCallbackPeriod, ausgelöst. Die Parameter sind die gleichen wie die von GetMotion.

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

property TBrickletGPSV2.OnDateTime
procedure(sender: TBrickletGPSV2; const date: longword; const time: longword) of object;
Callback-Parameter:
  • sender – Typ: TBrickletGPSV2
  • date – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • time – Typ: longword, Wertebereich: [0 bis 232 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit SetDateTimeCallbackPeriod, ausgelöst. Die Parameter sind die gleichen wie die von GetDateTime.

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

Konstanten

const BRICKLET_GPS_V2_DEVICE_IDENTIFIER

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

Die GetIdentity Funktion und der TIPConnection.OnEnumerate Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

const BRICKLET_GPS_V2_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines GPS Bricklet 2.0 dar.