Go - GPS Bricklet 2.0

Dies ist die Beschreibung der Go 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 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_v2_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 2.0.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    gps, _ := gps_v2_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_v2_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 2.0.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    gps, _ := gps_v2_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) {
        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 2.0 ist im Package github.com/Tinkerforge/go-api-bindings/gps_v2_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_v2_bricklet.New(uid string, ipcon *IPConnection) (device GPSV2Bricklet, err error)

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

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

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

func (*GPSV2Bricklet) GetCoordinates() (latitude uint32, ns rune, longitude uint32, ew rune, 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).

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

func (*GPSV2Bricklet) GetStatus() (hasFix bool, satellitesView uint8, err error)

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.

func (*GPSV2Bricklet) 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 (*GPSV2Bricklet) 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 (*GPSV2Bricklet) 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.

func (*GPSV2Bricklet) GetSatelliteSystemStatus(satelliteSystem SatelliteSystem) (satelliteNumbers []uint8, fix Fix, pdop uint16, hdop uint16, vdop uint16, err error)

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:

  • gps_v2_bricklet.SatelliteSystemGPS = 0
  • gps_v2_bricklet.SatelliteSystemGLONASS = 1
  • gps_v2_bricklet.SatelliteSystemGalileo = 2
  • gps_v2_bricklet.FixNoFix = 1
  • gps_v2_bricklet.Fix2DFix = 2
  • gps_v2_bricklet.Fix3DFix = 3
func (*GPSV2Bricklet) GetSatelliteStatus(satelliteSystem SatelliteSystem, satelliteNumber uint8) (elevation int16, azimuth int16, snr int16, err error)

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:

  • gps_v2_bricklet.SatelliteSystemGPS = 0
  • gps_v2_bricklet.SatelliteSystemGLONASS = 1
  • gps_v2_bricklet.SatelliteSystemGalileo = 2

Fortgeschrittene Funktionen

func (*GPSV2Bricklet) 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_v2_bricklet.RestartTypeHotStart = 0
  • gps_v2_bricklet.RestartTypeWarmStart = 1
  • gps_v2_bricklet.RestartTypeColdStart = 2
  • gps_v2_bricklet.RestartTypeFactoryReset = 3
func (*GPSV2Bricklet) SetFixLEDConfig(config FixLEDConfig) (err error)

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:

  • gps_v2_bricklet.FixLEDConfigOff = 0
  • gps_v2_bricklet.FixLEDConfigOn = 1
  • gps_v2_bricklet.FixLEDConfigShowHeartbeat = 2
  • gps_v2_bricklet.FixLEDConfigShowFix = 3
  • gps_v2_bricklet.FixLEDConfigShowPPS = 4
func (*GPSV2Bricklet) GetFixLEDConfig() (config FixLEDConfig, err error)

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

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

  • gps_v2_bricklet.FixLEDConfigOff = 0
  • gps_v2_bricklet.FixLEDConfigOn = 1
  • gps_v2_bricklet.FixLEDConfigShowHeartbeat = 2
  • gps_v2_bricklet.FixLEDConfigShowFix = 3
  • gps_v2_bricklet.FixLEDConfigShowPPS = 4
func (*GPSV2Bricklet) SetSBASConfig(sbasConfig SBAS) (err error)

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:

  • gps_v2_bricklet.SBASEnabled = 0
  • gps_v2_bricklet.SBASDisabled = 1

Neu in Version 2.0.2 (Plugin).

func (*GPSV2Bricklet) GetSBASConfig() (sbasConfig SBAS, err error)

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

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

  • gps_v2_bricklet.SBASEnabled = 0
  • gps_v2_bricklet.SBASDisabled = 1

Neu in Version 2.0.2 (Plugin).

func (*GPSV2Bricklet) 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 (*GPSV2Bricklet) 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_v2_bricklet.FunctionRestart = 6
  • gps_v2_bricklet.FunctionSetFixLEDConfig = 9
  • gps_v2_bricklet.FunctionSetCoordinatesCallbackPeriod = 11
  • gps_v2_bricklet.FunctionSetStatusCallbackPeriod = 13
  • gps_v2_bricklet.FunctionSetAltitudeCallbackPeriod = 15
  • gps_v2_bricklet.FunctionSetMotionCallbackPeriod = 17
  • gps_v2_bricklet.FunctionSetDateTimeCallbackPeriod = 19
  • gps_v2_bricklet.FunctionSetSBASConfig = 27
  • gps_v2_bricklet.FunctionSetWriteFirmwarePointer = 237
  • gps_v2_bricklet.FunctionSetStatusLEDConfig = 239
  • gps_v2_bricklet.FunctionReset = 243
  • gps_v2_bricklet.FunctionWriteUID = 248
func (*GPSV2Bricklet) 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_v2_bricklet.FunctionRestart = 6
  • gps_v2_bricklet.FunctionSetFixLEDConfig = 9
  • gps_v2_bricklet.FunctionSetCoordinatesCallbackPeriod = 11
  • gps_v2_bricklet.FunctionSetStatusCallbackPeriod = 13
  • gps_v2_bricklet.FunctionSetAltitudeCallbackPeriod = 15
  • gps_v2_bricklet.FunctionSetMotionCallbackPeriod = 17
  • gps_v2_bricklet.FunctionSetDateTimeCallbackPeriod = 19
  • gps_v2_bricklet.FunctionSetSBASConfig = 27
  • gps_v2_bricklet.FunctionSetWriteFirmwarePointer = 237
  • gps_v2_bricklet.FunctionSetStatusLEDConfig = 239
  • gps_v2_bricklet.FunctionReset = 243
  • gps_v2_bricklet.FunctionWriteUID = 248
func (*GPSV2Bricklet) SetResponseExpectedAll(responseExpected bool) (err error)

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

func (*GPSV2Bricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)

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.

func (*GPSV2Bricklet) SetBootloaderMode(mode BootloaderMode) (status BootloaderStatus, err error)

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:

  • gps_v2_bricklet.BootloaderModeBootloader = 0
  • gps_v2_bricklet.BootloaderModeFirmware = 1
  • gps_v2_bricklet.BootloaderModeBootloaderWaitForReboot = 2
  • gps_v2_bricklet.BootloaderModeFirmwareWaitForReboot = 3
  • gps_v2_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4
  • gps_v2_bricklet.BootloaderStatusOK = 0
  • gps_v2_bricklet.BootloaderStatusInvalidMode = 1
  • gps_v2_bricklet.BootloaderStatusNoChange = 2
  • gps_v2_bricklet.BootloaderStatusEntryFunctionNotPresent = 3
  • gps_v2_bricklet.BootloaderStatusDeviceIdentifierIncorrect = 4
  • gps_v2_bricklet.BootloaderStatusCRCMismatch = 5
func (*GPSV2Bricklet) GetBootloaderMode() (mode BootloaderMode, err error)

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

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

  • gps_v2_bricklet.BootloaderModeBootloader = 0
  • gps_v2_bricklet.BootloaderModeFirmware = 1
  • gps_v2_bricklet.BootloaderModeBootloaderWaitForReboot = 2
  • gps_v2_bricklet.BootloaderModeFirmwareWaitForReboot = 3
  • gps_v2_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4
func (*GPSV2Bricklet) SetWriteFirmwarePointer(pointer uint32) (err error)

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.

func (*GPSV2Bricklet) WriteFirmware(data [64]uint8) (status uint8, err error)

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.

func (*GPSV2Bricklet) SetStatusLEDConfig(config StatusLEDConfig) (err error)

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:

  • gps_v2_bricklet.StatusLEDConfigOff = 0
  • gps_v2_bricklet.StatusLEDConfigOn = 1
  • gps_v2_bricklet.StatusLEDConfigShowHeartbeat = 2
  • gps_v2_bricklet.StatusLEDConfigShowStatus = 3
func (*GPSV2Bricklet) GetStatusLEDConfig() (config StatusLEDConfig, err error)

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

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

  • gps_v2_bricklet.StatusLEDConfigOff = 0
  • gps_v2_bricklet.StatusLEDConfigOn = 1
  • gps_v2_bricklet.StatusLEDConfigShowHeartbeat = 2
  • gps_v2_bricklet.StatusLEDConfigShowStatus = 3
func (*GPSV2Bricklet) GetChipTemperature() (temperature int16, err error)

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.

func (*GPSV2Bricklet) Reset() (err error)

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.

func (*GPSV2Bricklet) WriteUID(uid uint32) (err error)

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.

func (*GPSV2Bricklet) ReadUID() (uid uint32, err error)

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

func (*GPSV2Bricklet) 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 (*GPSV2Bricklet) 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 (*GPSV2Bricklet) GetCoordinatesCallbackPeriod() (period uint32, err error)

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

func (*GPSV2Bricklet) 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 (*GPSV2Bricklet) GetStatusCallbackPeriod() (period uint32, err error)

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

func (*GPSV2Bricklet) 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 (*GPSV2Bricklet) GetAltitudeCallbackPeriod() (period uint32, err error)

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

func (*GPSV2Bricklet) 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 (*GPSV2Bricklet) GetMotionCallbackPeriod() (period uint32, err error)

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

func (*GPSV2Bricklet) 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 (*GPSV2Bricklet) 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 (*GPSV2Bricklet) RegisterPulsePerSecondCallback(func()) (registrationId uint64)

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

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.

func (*GPSV2Bricklet) RegisterCoordinatesCallback(func(latitude uint32, ns rune, longitude uint32, ew rune)) (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 (*GPSV2Bricklet) RegisterStatusCallback(func(hasFix bool, satellitesView 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.

func (*GPSV2Bricklet) 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 (*GPSV2Bricklet) 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 (*GPSV2Bricklet) 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_v2_bricklet.DeviceIdentifier

Diese Konstante wird verwendet um ein GPS Bricklet 2.0 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_v2_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines GPS Bricklet 2.0 dar.