Software / API Bindings / Go / API Referenz und Beispiele / Bricklets / GPS Bricklet 3.0

Go - GPS Bricklet 3.0¶

Dies ist die Beschreibung der Go API Bindings für das GPS Bricklet 3.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des GPS Bricklet 3.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)

package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/gps_v3_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 3.0.

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

Callback¶

Download (example_callback.go)

package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/gps_v3_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 3.0.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    gps, _ := gps_v3_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 3.0 ist im Package github.com/Tinkerforge/go-api-bindings/gps_v3_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:

ipconnection.DeviceErrorSuccess = 0
ipconnection.DeviceErrorInvalidParameter = 1
ipconnection.DeviceErrorFunctionNotSupported = 2
ipconnection.DeviceErrorUnknownError = 3

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

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

func gps_v3_bricklet.New(uid string, ipcon *IPConnection) (device GPSV3Bricklet, err error)¶

Parameter:	uid – Typ: string ipcon – Typ: *IPConnection
Rückgabe:	device – Typ: GPSV3Bricklet err – Typ: error

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

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

Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden.

func (*GPSV3Bricklet) GetCoordinates() (latitude uint32, ns rune, longitude uint32, ew rune, err error)¶

Rückgabe:	latitude – Typ: uint32, Einheit: 1/1000000 °, Wertebereich: [0 bis 90000000] ns – Typ: rune, Wertebereich: ['N', 'S'] longitude – Typ: uint32, Einheit: 1/1000000 °, Wertebereich: [0 bis 180000000] ew – Typ: rune, Wertebereich: ['E', 'W'] err – Typ: 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 (*GPSV3Bricklet) GetStatus() (hasFix bool, satellitesView uint8, err error)¶

Rückgabe:	hasFix – Typ: bool satellitesView – Typ: uint8, Wertebereich: [0 bis 255] err – Typ: 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 (*GPSV3Bricklet) GetAltitude() (altitude int32, geoidalSeparation int32, err error)¶

Rückgabe:	altitude – Typ: int32, Einheit: 1 cm, Wertebereich: [-2³¹ bis 2³¹ - 1] geoidalSeparation – Typ: int32, Einheit: 1 cm, Wertebereich: [-2³¹ bis 2³¹ - 1] err – Typ: error

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

func (*GPSV3Bricklet) GetMotion() (course uint32, speed uint32, err error)¶

Rückgabe:	course – Typ: uint32, Einheit: 1/100 °, Wertebereich: [0 bis 36000] speed – Typ: uint32, Einheit: 1/100 km/h, Wertebereich: [0 bis 2³² - 1] err – Typ: error

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

func (*GPSV3Bricklet) GetDateTime() (date uint32, time uint32, err error)¶

Rückgabe:	date – Typ: uint32, Wertebereich: [10100 bis 311299] time – Typ: uint32, Wertebereich: [0 bis 235959999] err – Typ: 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 (*GPSV3Bricklet) GetSatelliteSystemStatus(satelliteSystem uint8) (satelliteNumbers []uint8, fix uint8, pdop uint16, hdop uint16, vdop uint16, err error)¶

Parameter:	satelliteSystem – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:	satelliteNumbers – Typ: []uint8, Länge: variabel, Wertebereich: [0 bis 255] fix – Typ: uint8, Wertebereich: Siehe Konstanten pdop – Typ: uint16, Einheit: 1/100, Wertebereich: [0 bis 2¹⁶ - 1] hdop – Typ: uint16, Einheit: 1/100, Wertebereich: [0 bis 2¹⁶ - 1] vdop – Typ: uint16, Einheit: 1/100, Wertebereich: [0 bis 2¹⁶ - 1] err – Typ: 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:

Für satelliteSystem:

gps_v3_bricklet.SatelliteSystemGPS = 0
gps_v3_bricklet.SatelliteSystemGLONASS = 1
gps_v3_bricklet.SatelliteSystemGalileo = 2

Für fix:

gps_v3_bricklet.FixNoFix = 1
gps_v3_bricklet.Fix2DFix = 2
gps_v3_bricklet.Fix3DFix = 3

func (*GPSV3Bricklet) GetSatelliteStatus(satelliteSystem uint8, satelliteNumber uint8) (elevation int16, azimuth int16, snr int16, err error)¶

Parameter:	satelliteSystem – Typ: uint8, Wertebereich: Siehe Konstanten satelliteNumber – Typ: uint8, Wertebereich: [1 bis 32]
Rückgabe:	elevation – Typ: int16, Einheit: 1 °, Wertebereich: [0 bis 90] azimuth – Typ: int16, Einheit: 1 °, Wertebereich: [0 bis 359] snr – Typ: int16, Einheit: 1 dB, Wertebereich: [0 bis 99] err – Typ: error

Gibt die aktuellen Werte von Elevation, Azimutwinkel und SNR 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:

gps_v3_bricklet.SatelliteSystemGPS = 0
gps_v3_bricklet.SatelliteSystemGLONASS = 1
gps_v3_bricklet.SatelliteSystemGalileo = 2

Fortgeschrittene Funktionen¶

func (*GPSV3Bricklet) Restart(restartType uint8) (err error)¶

Parameter:	restartType – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:	err – Typ: 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:

Für restartType:

gps_v3_bricklet.RestartTypeHotStart = 0
gps_v3_bricklet.RestartTypeWarmStart = 1
gps_v3_bricklet.RestartTypeColdStart = 2
gps_v3_bricklet.RestartTypeFactoryReset = 3

func (*GPSV3Bricklet) SetFixLEDConfig(config uint8) (err error)¶

Parameter:	config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	err – Typ: 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 Rhythmus des PPS (Puls pro Sekunde) Ausgangs des GPS Moduls blinken.

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

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

Für config:

gps_v3_bricklet.FixLEDConfigOff = 0
gps_v3_bricklet.FixLEDConfigOn = 1
gps_v3_bricklet.FixLEDConfigShowHeartbeat = 2
gps_v3_bricklet.FixLEDConfigShowFix = 3
gps_v3_bricklet.FixLEDConfigShowPPS = 4

func (*GPSV3Bricklet) GetFixLEDConfig() (config uint8, err error)¶

Rückgabe:	config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3 err – Typ: error

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

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

Für config:

gps_v3_bricklet.FixLEDConfigOff = 0
gps_v3_bricklet.FixLEDConfigOn = 1
gps_v3_bricklet.FixLEDConfigShowHeartbeat = 2
gps_v3_bricklet.FixLEDConfigShowFix = 3
gps_v3_bricklet.FixLEDConfigShowPPS = 4

func (*GPSV3Bricklet) SetSBASConfig(sbasConfig uint8) (err error)¶

Parameter:	sbasConfig – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	err – Typ: 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.

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

Für sbasConfig:

gps_v3_bricklet.SBASEnabled = 0
gps_v3_bricklet.SBASDisabled = 1

func (*GPSV3Bricklet) GetSBASConfig() (sbasConfig uint8, err error)¶

Rückgabe:	sbasConfig – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0 err – Typ: error

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

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

Für sbasConfig:

gps_v3_bricklet.SBASEnabled = 0
gps_v3_bricklet.SBASDisabled = 1

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

Rückgabe:	errorCountAckChecksum – Typ: uint32, Wertebereich: [0 bis 2³² - 1] errorCountMessageChecksum – Typ: uint32, Wertebereich: [0 bis 2³² - 1] errorCountFrame – Typ: uint32, Wertebereich: [0 bis 2³² - 1] errorCountOverflow – Typ: uint32, Wertebereich: [0 bis 2³² - 1] err – Typ: 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 (*GPSV3Bricklet) SetStatusLEDConfig(config uint8) (err error)¶

Parameter:	config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	err – Typ: 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:

Für config:

gps_v3_bricklet.StatusLEDConfigOff = 0
gps_v3_bricklet.StatusLEDConfigOn = 1
gps_v3_bricklet.StatusLEDConfigShowHeartbeat = 2
gps_v3_bricklet.StatusLEDConfigShowStatus = 3

func (*GPSV3Bricklet) GetStatusLEDConfig() (config uint8, err error)¶

Rückgabe:	config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3 err – Typ: error

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

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

Für config:

gps_v3_bricklet.StatusLEDConfigOff = 0
gps_v3_bricklet.StatusLEDConfigOn = 1
gps_v3_bricklet.StatusLEDConfigShowHeartbeat = 2
gps_v3_bricklet.StatusLEDConfigShowStatus = 3

func (*GPSV3Bricklet) GetChipTemperature() (temperature int16, err error)¶

Rückgabe:	temperature – Typ: int16, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1] err – Typ: error

Gibt die Temperatur, 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 (*GPSV3Bricklet) Reset() (err error)¶

Rückgabe:	err – Typ: 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 (*GPSV3Bricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)¶

Rückgabe:

Rückgabe:	uid – Typ: string, Länge: bis zu 8 connectedUid – Typ: string, Länge: bis zu 8 position – Typ: rune, Wertebereich: ['a' bis 'h', 'z'] hardwareVersion – Typ: [3]uint8 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] firmwareVersion – Typ: [3]uint8 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] deviceIdentifier – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1] err – Typ: error

uid – Typ: string, Länge: bis zu 8
connectedUid – Typ: string, Länge: bis zu 8
position – Typ: rune, Wertebereich: ['a' bis 'h', 'z']
hardwareVersion – Typ: [3]uint8

0: major – Typ: uint8, Wertebereich: [0 bis 255]
1: minor – Typ: uint8, Wertebereich: [0 bis 255]
2: revision – Typ: uint8, Wertebereich: [0 bis 255]

firmwareVersion – Typ: [3]uint8

0: major – Typ: uint8, Wertebereich: [0 bis 255]
1: minor – Typ: uint8, Wertebereich: [0 bis 255]
2: revision – Typ: uint8, Wertebereich: [0 bis 255]

deviceIdentifier – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1]
err – Typ: 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 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.

Konfigurationsfunktionen für Callbacks¶

func (*GPSV3Bricklet) SetCoordinatesCallbackPeriod(period uint32) (err error)¶

Parameter:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	err – Typ: error

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.

func (*GPSV3Bricklet) GetCoordinatesCallbackPeriod() (period uint32, err error)¶

Rückgabe:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 err – Typ: error

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

func (*GPSV3Bricklet) SetStatusCallbackPeriod(period uint32) (err error)¶

Parameter:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	err – Typ: error

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.

func (*GPSV3Bricklet) GetStatusCallbackPeriod() (period uint32, err error)¶

Rückgabe:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 err – Typ: error

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

func (*GPSV3Bricklet) SetAltitudeCallbackPeriod(period uint32) (err error)¶

Parameter:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	err – Typ: error

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.

func (*GPSV3Bricklet) GetAltitudeCallbackPeriod() (period uint32, err error)¶

Rückgabe:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 err – Typ: error

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

func (*GPSV3Bricklet) SetMotionCallbackPeriod(period uint32) (err error)¶

Parameter:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	err – Typ: error

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.

func (*GPSV3Bricklet) GetMotionCallbackPeriod() (period uint32, err error)¶

Rückgabe:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 err – Typ: error

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

func (*GPSV3Bricklet) SetDateTimeCallbackPeriod(period uint32) (err error)¶

Parameter:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	err – Typ: error

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.

func (*GPSV3Bricklet) GetDateTimeCallbackPeriod() (period uint32, err error)¶

Rückgabe:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0 err – Typ: 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 (*GPSV3Bricklet) RegisterPulsePerSecondCallback(func()) (registrationId uint64)¶

Rückgabe:	registrationId – Typ: uint64

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 (*GPSV3Bricklet) RegisterCoordinatesCallback(func(latitude uint32, ns rune, longitude uint32, ew rune)) (registrationId uint64)¶

Callback-Parameter:	latitude – Typ: uint32, Einheit: 1/1000000 °, Wertebereich: [0 bis 90000000] ns – Typ: rune, Wertebereich: ['N', 'S'] longitude – Typ: uint32, Einheit: 1/1000000 °, Wertebereich: [0 bis 180000000] ew – Typ: rune, Wertebereich: ['E', 'W']
Rückgabe:	registrationId – Typ: uint64

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

func (*GPSV3Bricklet) RegisterStatusCallback(func(hasFix bool, satellitesView uint8)) (registrationId uint64)¶

Callback-Parameter:	hasFix – Typ: bool satellitesView – Typ: uint8, Wertebereich: [0 bis 255]
Rückgabe:	registrationId – Typ: uint64

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.

func (*GPSV3Bricklet) RegisterAltitudeCallback(func(altitude int32, geoidalSeparation int32)) (registrationId uint64)¶

Callback-Parameter:	altitude – Typ: int32, Einheit: 1 cm, Wertebereich: [-2³¹ bis 2³¹ - 1] geoidalSeparation – Typ: int32, Einheit: 1 cm, Wertebereich: [-2³¹ bis 2³¹ - 1]
Rückgabe:	registrationId – Typ: uint64

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

func (*GPSV3Bricklet) RegisterMotionCallback(func(course uint32, speed uint32)) (registrationId uint64)¶

Callback-Parameter:	course – Typ: uint32, Einheit: 1/100 °, Wertebereich: [0 bis 36000] speed – Typ: uint32, Einheit: 1/100 km/h, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	registrationId – Typ: uint64

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

func (*GPSV3Bricklet) RegisterDateTimeCallback(func(date uint32, time uint32)) (registrationId uint64)¶

Callback-Parameter:	date – Typ: uint32, Wertebereich: [10100 bis 311299] time – Typ: uint32, Wertebereich: [0 bis 235959999]
Rückgabe:	registrationId – Typ: uint64

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¶

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.

func (*GPSV3Bricklet) GetAPIVersion() (apiVersion [3]uint8, err error)¶

Rückgabe:	apiVersion – Typ: [3]uint8 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] err – Typ: error

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.

func (*GPSV3Bricklet) GetResponseExpected(functionId uint8) (responseExpected bool, err error)¶

Parameter:	functionId – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:	responseExpected – Typ: bool err – Typ: 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:

Für functionId:

gps_v3_bricklet.FunctionRestart = 6
gps_v3_bricklet.FunctionSetFixLEDConfig = 9
gps_v3_bricklet.FunctionSetCoordinatesCallbackPeriod = 11
gps_v3_bricklet.FunctionSetStatusCallbackPeriod = 13
gps_v3_bricklet.FunctionSetAltitudeCallbackPeriod = 15
gps_v3_bricklet.FunctionSetMotionCallbackPeriod = 17
gps_v3_bricklet.FunctionSetDateTimeCallbackPeriod = 19
gps_v3_bricklet.FunctionSetSBASConfig = 27
gps_v3_bricklet.FunctionSetWriteFirmwarePointer = 237
gps_v3_bricklet.FunctionSetStatusLEDConfig = 239
gps_v3_bricklet.FunctionReset = 243
gps_v3_bricklet.FunctionWriteUID = 248

func (*GPSV3Bricklet) SetResponseExpected(functionId uint8, responseExpected bool) (err error)¶

Parameter:	functionId – Typ: uint8, Wertebereich: Siehe Konstanten responseExpected – Typ: bool
Rückgabe:	err – Typ: 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.

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

Für functionId:

gps_v3_bricklet.FunctionRestart = 6
gps_v3_bricklet.FunctionSetFixLEDConfig = 9
gps_v3_bricklet.FunctionSetCoordinatesCallbackPeriod = 11
gps_v3_bricklet.FunctionSetStatusCallbackPeriod = 13
gps_v3_bricklet.FunctionSetAltitudeCallbackPeriod = 15
gps_v3_bricklet.FunctionSetMotionCallbackPeriod = 17
gps_v3_bricklet.FunctionSetDateTimeCallbackPeriod = 19
gps_v3_bricklet.FunctionSetSBASConfig = 27
gps_v3_bricklet.FunctionSetWriteFirmwarePointer = 237
gps_v3_bricklet.FunctionSetStatusLEDConfig = 239
gps_v3_bricklet.FunctionReset = 243
gps_v3_bricklet.FunctionWriteUID = 248

func (*GPSV3Bricklet) SetResponseExpectedAll(responseExpected bool) (err error)¶

Parameter:	responseExpected – Typ: bool
Rückgabe:	err – Typ: error

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

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

func (*GPSV3Bricklet) SetBootloaderMode(mode uint8) (status uint8, err error)¶

Parameter:	mode – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:	status – Typ: uint8, Wertebereich: Siehe Konstanten err – Typ: 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 Bootloader- 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:

gps_v3_bricklet.BootloaderModeBootloader = 0
gps_v3_bricklet.BootloaderModeFirmware = 1
gps_v3_bricklet.BootloaderModeBootloaderWaitForReboot = 2
gps_v3_bricklet.BootloaderModeFirmwareWaitForReboot = 3
gps_v3_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4

Für status:

gps_v3_bricklet.BootloaderStatusOK = 0
gps_v3_bricklet.BootloaderStatusInvalidMode = 1
gps_v3_bricklet.BootloaderStatusNoChange = 2
gps_v3_bricklet.BootloaderStatusEntryFunctionNotPresent = 3
gps_v3_bricklet.BootloaderStatusDeviceIdentifierIncorrect = 4
gps_v3_bricklet.BootloaderStatusCRCMismatch = 5

func (*GPSV3Bricklet) GetBootloaderMode() (mode uint8, err error)¶

Rückgabe:	mode – Typ: uint8, Wertebereich: Siehe Konstanten err – Typ: error

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

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

Für mode:

gps_v3_bricklet.BootloaderModeBootloader = 0
gps_v3_bricklet.BootloaderModeFirmware = 1
gps_v3_bricklet.BootloaderModeBootloaderWaitForReboot = 2
gps_v3_bricklet.BootloaderModeFirmwareWaitForReboot = 3
gps_v3_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4

func (*GPSV3Bricklet) SetWriteFirmwarePointer(pointer uint32) (err error)¶

Parameter:	pointer – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	err – Typ: 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 (*GPSV3Bricklet) WriteFirmware(data [64]uint8) (status uint8, err error)¶

Parameter:	data – Typ: [64]uint8, Wertebereich: [0 bis 255]
Rückgabe:	status – Typ: uint8, Wertebereich: [0 bis 255] err – Typ: 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 (*GPSV3Bricklet) WriteUID(uid uint32) (err error)¶

Parameter:	uid – Typ: uint32, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	err – Typ: 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 (*GPSV3Bricklet) ReadUID() (uid uint32, err error)¶

Rückgabe:	uid – Typ: uint32, Wertebereich: [0 bis 2³² - 1] err – Typ: error

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

Konstanten¶

gps_v3_bricklet.DeviceIdentifier¶

Diese Konstante wird verwendet um ein GPS Bricklet 3.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_v3_bricklet.DeviceDisplayName¶: Diese Konstante stellt den Anzeigenamen eines GPS Bricklet 3.0 dar.