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.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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: %c\n", ns)
fmt.Printf("Longitude: %f °\n", float64(longitude)/1000000.0)
fmt.Printf("E/W: %c\n", ew)
fmt.Print("Press enter to exit.")
fmt.Scanln()
}
|
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()
}
|
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 ipconnection.DeviceError
, der das error-Interface implementiert,
zurückgeben. Dieser kann folgende Werte annehmen:
welche den Werten entsprechen, die der Brick oder das Bricklet zurückgeben.
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
gps_bricklet.
New
(uid string, ipcon *IPConnection) (device GPSBricklet, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
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.
(*GPSBricklet)
GetCoordinates
() (latitude uint32, ns rune, longitude uint32, ew rune, pdop uint16, hdop uint16, vdop uint16, epe uint16, err error)¶Rückgabe: |
|
---|
Gibt die GPS Koordinaten zurück. Breitengrad und Längengrad werden im Format
DD.dddddd°
angegeben, der Wert 57123468 bedeutet 57,123468°.
Die Parameter ns
und ew
sind Himmelsrichtungen für
Breiten- und Längengrad. Mögliche Werte für ns
und ew
sind 'N', 'S', 'E'
und 'W' (Nord, Süd, Ost, West).
PDOP, HDOP und VDOP sind die "Dilution Of Precision" (DOP) Werte. Sie spezifizieren die zusätzlichen multiplikativen Effekte von der GPS Satellitengeometrie auf die GPS-Präzision. hier gibt es mehr Informationen dazu. Die Werte werden in Hundertstel gegeben.
EPE ist der "Estimated Position Error". Dies ist nicht der absolut maximale Fehler, es ist der Fehler mit einer spezifischen Konfidenz. Siehe hier für mehr Informationen.
Diese Daten sind nur gültig wenn ein Fix vorhanden ist (siehe GetStatus()
).
(*GPSBricklet)
GetStatus
() (fix uint8, satellitesView uint8, satellitesUsed uint8, err error)¶Rückgabe: |
|
---|
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:
Für fix:
(*GPSBricklet)
GetAltitude
() (altitude int32, geoidalSeparation int32, err error)¶Rückgabe: |
|
---|
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 GetStatus()
).
(*GPSBricklet)
GetMotion
() (course uint32, speed uint32, err error)¶Rückgabe: |
|
---|
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 GetStatus()
).
(*GPSBricklet)
GetDateTime
() (date uint32, time uint32, err error)¶Rückgabe: |
|
---|
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.
(*GPSBricklet)
Restart
(restartType uint8) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
(*GPSBricklet)
GetIdentity
() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)¶Rückgabe: |
|
---|
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.
(*GPSBricklet)
SetCoordinatesCallbackPeriod
(period uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode 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.
(*GPSBricklet)
GetCoordinatesCallbackPeriod
() (period uint32, err error)¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetCoordinatesCallbackPeriod()
gesetzt.
(*GPSBricklet)
SetStatusCallbackPeriod
(period uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode 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.
(*GPSBricklet)
GetStatusCallbackPeriod
() (period uint32, err error)¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetStatusCallbackPeriod()
gesetzt.
(*GPSBricklet)
SetAltitudeCallbackPeriod
(period uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode 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.
(*GPSBricklet)
GetAltitudeCallbackPeriod
() (period uint32, err error)¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetAltitudeCallbackPeriod()
gesetzt.
(*GPSBricklet)
SetMotionCallbackPeriod
(period uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode 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.
(*GPSBricklet)
GetMotionCallbackPeriod
() (period uint32, err error)¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetMotionCallbackPeriod()
gesetzt.
(*GPSBricklet)
SetDateTimeCallbackPeriod
(period uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Periode 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.
(*GPSBricklet)
GetDateTimeCallbackPeriod
() (period uint32, err error)¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von SetDateTimeCallbackPeriod()
gesetzt.
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.
(*GPSBricklet)
RegisterCoordinatesCallback
(func(latitude uint32, ns rune, longitude uint32, ew rune, pdop uint16, hdop uint16, vdop uint16, epe uint16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
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()
).
(*GPSBricklet)
RegisterStatusCallback
(func(fix uint8, satellitesView uint8, satellitesUsed uint8)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
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:
Für fix:
(*GPSBricklet)
RegisterAltitudeCallback
(func(altitude int32, geoidalSeparation int32)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
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()
).
(*GPSBricklet)
RegisterMotionCallback
(func(course uint32, speed uint32)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
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()
).
(*GPSBricklet)
RegisterDateTimeCallback
(func(date uint32, time uint32)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
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.
Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.
(*GPSBricklet)
GetAPIVersion
() (apiVersion [3]uint8, err error)¶Rückgabe: |
|
---|
Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.
(*GPSBricklet)
GetResponseExpected
(functionId uint8) (responseExpected bool, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
(*GPSBricklet)
SetResponseExpected
(functionId uint8, responseExpected bool) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ä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:
(*GPSBricklet)
SetResponseExpectedAll
(responseExpected bool) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
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.