Go - GPS Bricklet

Dies ist die Beschreibung der Go 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 Go API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf godoc.org.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example_simple.go)

 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
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/gps_bricklet"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your GPS Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    gps, _ := gps_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    // Get current coordinates.
    latitude, ns, longitude, ew, _, _, _, _, _ := gps.GetCoordinates()

    fmt.Printf("Latitude: %f °\n", float64(latitude)/1000000.0)
    fmt.Printf("N/S: \n", ns)
    fmt.Printf("Longitude: %f °\n", float64(longitude)/1000000.0)
    fmt.Printf("E/W: \n", ew)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

Callback

Download (example_callback.go)

 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
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/gps_bricklet"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your GPS Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    gps, _ := gps_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    gps.RegisterCoordinatesCallback(func(latitude uint32, ns rune, longitude uint32, ew rune, pdop uint16, hdop uint16, vdop uint16, epe uint16) {
        fmt.Printf("Latitude: %f °\n", float64(latitude)/1000000.0)
        fmt.Printf("N/S: %c\n", ns)
        fmt.Printf("Longitude: %f °\n", float64(longitude)/1000000.0)
        fmt.Printf("E/W: %c\n", ew)
        fmt.Println()
    })

    // Set period for coordinates receiver to 1s (1000ms).
    // Note: The coordinates callback is only called every second
    //       if the coordinates has changed since the last call!
    gps.SetCoordinatesCallbackPeriod(1000)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

API

Die API des GPS Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/gps_bricklet definiert.

Fast alle Funktionen der Go Bindings können einen DeviceError, der das error-Interface implementiert, zurückgeben. Dieser kann folgende Werte annehmen:

  • DeviceErrorSuccess = 0
  • DeviceErrorInvalidParameter = 1
  • DeviceErrorFunctionNotSupported = 2
  • DeviceErrorUnknownError = 3

welche den Werten entsprechen, die der Brick oder das Bricklet zurückgeben.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

func gps_bricklet.New(uid string, ipcon *IPConnection) (device GPSBricklet, err error)

Erzeugt ein neues GPSBricklet-Objekt mit der eindeutigen Geräte ID uid und fügt es der IPConnection ipcon hinzu:

device, err := gps_bricklet.New("YOUR_DEVICE_UID", &ipcon)

Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden wurde (siehe Beispiele oben).

func (*GPSBricklet) GetCoordinates() (latitude uint32, ns rune, longitude uint32, ew rune, pdop uint16, hdop uint16, vdop uint16, epe uint16, err error)

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

func (*GPSBricklet) GetStatus() (fix Fix, satellitesView uint8, satellitesUsed uint8, err error)

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:

  • gps_bricklet.FixNoFix = 1
  • gps_bricklet.Fix2DFix = 2
  • gps_bricklet.Fix3DFix = 3
func (*GPSBricklet) GetAltitude() (altitude int32, geoidalSeparation int32, err error)

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

func (*GPSBricklet) GetMotion() (course uint32, speed uint32, err error)

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

func (*GPSBricklet) GetDateTime() (date uint32, time uint32, err error)

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

func (*GPSBricklet) Restart(restartType RestartType) (err error)

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:

  • gps_bricklet.RestartTypeHotStart = 0
  • gps_bricklet.RestartTypeWarmStart = 1
  • gps_bricklet.RestartTypeColdStart = 2
  • gps_bricklet.RestartTypeFactoryReset = 3
func (*GPSBricklet) GetAPIVersion() (apiVersion [3]uint8, err error)

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.

func (*GPSBricklet) GetResponseExpected(functionId Function) (responseExpected bool, err error)

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:

  • gps_bricklet.FunctionRestart = 6
  • gps_bricklet.FunctionSetCoordinatesCallbackPeriod = 7
  • gps_bricklet.FunctionSetStatusCallbackPeriod = 9
  • gps_bricklet.FunctionSetAltitudeCallbackPeriod = 11
  • gps_bricklet.FunctionSetMotionCallbackPeriod = 13
  • gps_bricklet.FunctionSetDateTimeCallbackPeriod = 15
func (*GPSBricklet) SetResponseExpected(functionId Function, responseExpected bool) (err error)

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

  • gps_bricklet.FunctionRestart = 6
  • gps_bricklet.FunctionSetCoordinatesCallbackPeriod = 7
  • gps_bricklet.FunctionSetStatusCallbackPeriod = 9
  • gps_bricklet.FunctionSetAltitudeCallbackPeriod = 11
  • gps_bricklet.FunctionSetMotionCallbackPeriod = 13
  • gps_bricklet.FunctionSetDateTimeCallbackPeriod = 15
func (*GPSBricklet) SetResponseExpectedAll(responseExpected bool) (err error)

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

func (*GPSBricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)

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

func (*GPSBricklet) SetCoordinatesCallbackPeriod(period uint32) (err error)

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

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

Der Standardwert ist 0.

func (*GPSBricklet) GetCoordinatesCallbackPeriod() (period uint32, err error)

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

func (*GPSBricklet) SetStatusCallbackPeriod(period uint32) (err error)

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

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

Der Standardwert ist 0.

func (*GPSBricklet) GetStatusCallbackPeriod() (period uint32, err error)

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

func (*GPSBricklet) SetAltitudeCallbackPeriod(period uint32) (err error)

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

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

Der Standardwert ist 0.

func (*GPSBricklet) GetAltitudeCallbackPeriod() (period uint32, err error)

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

func (*GPSBricklet) SetMotionCallbackPeriod(period uint32) (err error)

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

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

Der Standardwert ist 0.

func (*GPSBricklet) GetMotionCallbackPeriod() (period uint32, err error)

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

func (*GPSBricklet) SetDateTimeCallbackPeriod(period uint32) (err error)

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

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

Der Standardwert ist 0.

func (*GPSBricklet) GetDateTimeCallbackPeriod() (period uint32, err error)

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 kann mit der entsprechenden Register*Callback-Function durchgeführt werden, welche eine eindeutige Callback-ID zurück gibt. Mit dieser ID kann das Callback später deregistriert werden.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

func (*GPSBricklet) RegisterCoordinatesCallback(func(latitude uint32, ns rune, longitude uint32, ew rune, pdop uint16, hdop uint16, vdop uint16, epe uint16)) (registrationId uint64)

Ein Callback für dieses Event kann mit der Funktion RegisterCoordinatesCallback() hinzugefügt werden. Diese gibt die ID des registrierten Callbacks zurück. Ein hinzugefügtes Callback kann mit der Funktion DeregisterCoordinatesCallback(registrationId uint64) wieder entfernt werden.

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

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

func (*GPSBricklet) RegisterStatusCallback(func(fix Fix, satellitesView uint8, satellitesUsed uint8)) (registrationId uint64)

Ein Callback für dieses Event kann mit der Funktion RegisterStatusCallback() hinzugefügt werden. Diese gibt die ID des registrierten Callbacks zurück. Ein hinzugefügtes Callback kann mit der Funktion DeregisterStatusCallback(registrationId uint64) wieder entfernt werden.

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

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

  • gps_bricklet.FixNoFix = 1
  • gps_bricklet.Fix2DFix = 2
  • gps_bricklet.Fix3DFix = 3
func (*GPSBricklet) RegisterAltitudeCallback(func(altitude int32, geoidalSeparation int32)) (registrationId uint64)

Ein Callback für dieses Event kann mit der Funktion RegisterAltitudeCallback() hinzugefügt werden. Diese gibt die ID des registrierten Callbacks zurück. Ein hinzugefügtes Callback kann mit der Funktion DeregisterAltitudeCallback(registrationId uint64) wieder entfernt werden.

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

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

func (*GPSBricklet) RegisterMotionCallback(func(course uint32, speed uint32)) (registrationId uint64)

Ein Callback für dieses Event kann mit der Funktion RegisterMotionCallback() hinzugefügt werden. Diese gibt die ID des registrierten Callbacks zurück. Ein hinzugefügtes Callback kann mit der Funktion DeregisterMotionCallback(registrationId uint64) wieder entfernt werden.

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

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

func (*GPSBricklet) RegisterDateTimeCallback(func(date uint32, time uint32)) (registrationId uint64)

Ein Callback für dieses Event kann mit der Funktion RegisterDateTimeCallback() hinzugefügt werden. Diese gibt die ID des registrierten Callbacks zurück. Ein hinzugefügtes Callback kann mit der Funktion DeregisterDateTimeCallback(registrationId uint64) wieder entfernt werden.

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

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

Konstanten

gps_bricklet.DeviceIdentifier

Diese Konstante wird verwendet um ein GPS Bricklet zu identifizieren.

Die GetIdentity() Funktion und der (*IPConnection) RegisterEnumerateCallback Callback der IPConnection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

gps_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines GPS Bricklet dar.