Visual Basic .NET - GPS Bricklet

Dies ist die Beschreibung der Visual Basic .NET 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 Visual Basic .NET API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.vb)

 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
Imports System
Imports Tinkerforge

Module ExampleSimple
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your GPS Bricklet

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim gps As New BrickletGPS(UID, ipcon) ' Create device object

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

        ' Get current coordinates
        Dim latitude, longitude As Long
        Dim ns, ew As Char
        Dim pdop, hdop, vdop, epe As Integer

        gps.GetCoordinates(latitude, ns, longitude, ew, pdop, hdop, vdop, epe)

        Console.WriteLine("Latitude: " + (latitude/1000000.0).ToString() + " °")
        Console.WriteLine("N/S: " + ns)
        Console.WriteLine("Longitude: " + (longitude/1000000.0).ToString() + " °")
        Console.WriteLine("E/W: " + ew)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Callback

Download (ExampleCallback.vb)

 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
Imports System
Imports Tinkerforge

Module ExampleCallback
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your GPS Bricklet

    ' Callback subroutine for coordinates callback
    Sub CoordinatesCB(ByVal sender As BrickletGPS, ByVal latitude As Long, _
                      ByVal ns As Char, ByVal longitude As Long, ByVal ew As Char, _
                      ByVal pdop As Integer, ByVal hdop As Integer, _
                      ByVal vdop As Integer, ByVal epe As Integer)
        Console.WriteLine("Latitude: " + (latitude/1000000.0).ToString() + " °")
        Console.WriteLine("N/S: " + ns)
        Console.WriteLine("Longitude: " + (longitude/1000000.0).ToString() + " °")
        Console.WriteLine("E/W: " + ew)
        Console.WriteLine("")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim gps As New BrickletGPS(UID, ipcon) ' Create device object

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

        ' Register coordinates callback to subroutine CoordinatesCB
        AddHandler gps.CoordinatesCallback, AddressOf 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)

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

API

Da Visual Basic .NET nicht mehrere Rückgabewerte direkt unterstützt, wird das ByRef Schlüsselwort genutzt um mehrere Werte von einer Funktion zurückzugeben.

Alle folgend aufgelisteten Funktionen und Prozeduren sind Thread-sicher.

Grundfunktionen

Class BrickletGPS(ByVal uid As String, ByVal ipcon As IPConnection)

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

Dim gps As New BrickletGPS("YOUR_DEVICE_UID", ipcon)

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

Sub BrickletGPS.GetCoordinates(ByRef latitude As Long, ByRef ns As Char, ByRef longitude As Long, ByRef ew As Char, ByRef pdop As Integer, ByRef hdop As Integer, ByRef vdop As Integer, ByRef epe As Integer)

Gibt die GPS Koordinaten zurück. Breitengrad und Längengrad werden im Format DD.dddddd° angegeben, der Wert 57123468 bedeutet 57,123468°. Die Parameter ns und ew sind Himmelsrichtungen für Breiten- und Längengrad. Mögliche Werte für ns und ew sind 'N', 'S', 'E' und 'W' (Nord, Süd, Ost, West).

PDOP, HDOP und VDOP sind die "Dilution Of Precision" (DOP) Werte. Sie spezifizieren die zusätzlichen multiplikativen Effekte von der GPS Satellitengeometrie auf die GPS-Präzision. hier gibt es mehr Informationen dazu. Die Werte werden in Hundertstel gegeben.

EPE ist der "Estimated Position Error". Der EPE wird in cm gegeben. Dies ist nicht der absolut maximale Fehler, es ist der Fehler mit einer spezifischen Konfidenz. Siehe hier für mehr Informationen.

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

Sub BrickletGPS.GetStatus(ByRef fix As Byte, ByRef satellitesView As Byte, ByRef satellitesUsed As Byte)

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, GetCoordinates(), GetAltitude() und GetMotion() geben ungültige Daten zurück
2 2D Fix, nur GetCoordinates() und GetMotion() geben gültige Daten zurück
3 3D Fix, GetCoordinates(), GetAltitude() und GetMotion() 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:

  • BrickletGPS.FIX_NO_FIX = 1
  • BrickletGPS.FIX_2D_FIX = 2
  • BrickletGPS.FIX_3D_FIX = 3
Sub BrickletGPS.GetAltitude(ByRef altitude As Integer, ByRef geoidalSeparation As Integer)

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

Sub BrickletGPS.GetMotion(ByRef course As Long, ByRef speed As Long)

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

Sub BrickletGPS.GetDateTime(ByRef date As Long, ByRef time As Long)

Gibt das aktuelle Datum und die aktuelle Zeit zurück. Das Datum ist im Format ddmmyy und die Zeit im Format hhmmss.sss angegeben. Zum Beispiel, 140713 bedeutet 14.05.13 als Datum und 195923568 bedeutet 19:59:23.568 als Zeit.

Fortgeschrittene Funktionen

Sub BrickletGPS.Restart(ByVal restartType As Byte)

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:

  • BrickletGPS.RESTART_TYPE_HOT_START = 0
  • BrickletGPS.RESTART_TYPE_WARM_START = 1
  • BrickletGPS.RESTART_TYPE_COLD_START = 2
  • BrickletGPS.RESTART_TYPE_FACTORY_RESET = 3
Function BrickletGPS.GetAPIVersion() As Byte()

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 BrickletGPS.GetResponseExpected(ByVal functionId As Byte) As 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.

Siehe SetResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

Sub BrickletGPS.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As 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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletGPS.FUNCTION_RESTART = 6
  • BrickletGPS.FUNCTION_SET_COORDINATES_CALLBACK_PERIOD = 7
  • BrickletGPS.FUNCTION_SET_STATUS_CALLBACK_PERIOD = 9
  • BrickletGPS.FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 11
  • BrickletGPS.FUNCTION_SET_MOTION_CALLBACK_PERIOD = 13
  • BrickletGPS.FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 15
Sub BrickletGPS.SetResponseExpectedAll(ByVal responseExpected As Boolean)

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

Sub BrickletGPS.GetIdentity(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)

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

Sub BrickletGPS.SetCoordinatesCallbackPeriod(ByVal period As Long)

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

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

Der Standardwert ist 0.

Function BrickletGPS.GetCoordinatesCallbackPeriod() As Long

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

Sub BrickletGPS.SetStatusCallbackPeriod(ByVal period As Long)

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

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

Der Standardwert ist 0.

Function BrickletGPS.GetStatusCallbackPeriod() As Long

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

Sub BrickletGPS.SetAltitudeCallbackPeriod(ByVal period As Long)

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

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

Der Standardwert ist 0.

Function BrickletGPS.GetAltitudeCallbackPeriod() As Long

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

Sub BrickletGPS.SetMotionCallbackPeriod(ByVal period As Long)

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

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

Der Standardwert ist 0.

Function BrickletGPS.GetMotionCallbackPeriod() As Long

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

Sub BrickletGPS.SetDateTimeCallbackPeriod(ByVal period As Long)

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

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

Der Standardwert ist 0.

Function BrickletGPS.GetDateTimeCallbackPeriod() As Long

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:

Sub MyCallback(ByVal sender As BrickletGPS, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler gps.ExampleCallback, AddressOf 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.

Event BrickletGPS.CoordinatesCallback(ByVal sender As BrickletGPS, ByVal latitude As Long, ByVal ns As Char, ByVal longitude As Long, ByVal ew As Char, ByVal pdop As Integer, ByVal hdop As Integer, ByVal vdop As Integer, ByVal epe As Integer)

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

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

Event BrickletGPS.StatusCallback(ByVal sender As BrickletGPS, ByVal fix As Byte, ByVal satellitesView As Byte, ByVal satellitesUsed As Byte)

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

Der StatusCallback 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:

  • BrickletGPS.FIX_NO_FIX = 1
  • BrickletGPS.FIX_2D_FIX = 2
  • BrickletGPS.FIX_3D_FIX = 3
Event BrickletGPS.AltitudeCallback(ByVal sender As BrickletGPS, ByVal altitude As Integer, ByVal geoidalSeparation As Integer)

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

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

Event BrickletGPS.MotionCallback(ByVal sender As BrickletGPS, ByVal course As Long, ByVal speed As Long)

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

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

Event BrickletGPS.DateTimeCallback(ByVal sender As BrickletGPS, ByVal date As Long, ByVal time As Long)

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

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

Konstanten

Const BrickletGPS.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein GPS Bricklet zu identifizieren.

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

Const BrickletGPS.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines GPS Bricklet dar.