LabVIEW - GPS Bricklet¶

Simple¶

Download (Example Simple.vi)

Callback¶

Download (Example Callback.vi), Download (Example Callback - Coordinates Callback.vi)

Grundfunktionen¶

BrickletGPS(uid, ipcon) → gps¶

Eingabe:	uid – Typ: String ipcon – Typ: .NET Refnum (IPConnection)
Ausgabe:	gps – Typ: .NET Refnum (BrickletGPS)

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid. Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

BrickletGPS.GetCoordinates() → latitude, ns, longitude, ew, pdop, hdop, vdop, epe¶

Ausgabe:

latitude – Typ: Int64, Einheit: 1/1000000 °, Wertebereich: [0 bis 90000000] ns – Typ: Char, Wertebereich: ["N", "S"] longitude – Typ: Int64, Einheit: 1/1000000 °, Wertebereich: [0 bis 180000000] ew – Typ: Char, Wertebereich: ["E", "W"] pdop – Typ: Int32, Einheit: 1/100, Wertebereich: [0 bis 216 - 1] hdop – Typ: Int32, Einheit: 1/100, Wertebereich: [0 bis 216 - 1] vdop – Typ: Int32, Einheit: 1/100, Wertebereich: [0 bis 216 - 1] epe – Typ: Int32, Einheit: 1 cm, Wertebereich: [0 bis 216 - 1]

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

BrickletGPS.GetStatus() → fix, satellitesView, satellitesUsed¶

Ausgabe:	fix – Typ: Byte, Wertebereich: Siehe Konstanten satellitesView – Typ: Byte, Wertebereich: [0 bis 255] satellitesUsed – Typ: Byte, Wertebereich: [0 bis 255]

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:

• BrickletGPS.FIX_NO_FIX = 1
• BrickletGPS.FIX_2D_FIX = 2
• BrickletGPS.FIX_3D_FIX = 3

BrickletGPS.GetAltitude() → altitude, geoidalSeparation¶

Ausgabe:	altitude – Typ: Int32, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1] geoidalSeparation – Typ: Int32, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1]

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

BrickletGPS.GetMotion() → course, speed¶

Ausgabe:	course – Typ: Int64, Einheit: 1/100 °, Wertebereich: [0 bis 36000] speed – Typ: Int64, Einheit: 1/100 km/h, Wertebereich: [0 bis 232 - 1]

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

BrickletGPS.GetDateTime() → date, time¶

Ausgabe:	date – Typ: Int64, Wertebereich: [10100 bis 311299] time – Typ: Int64, Wertebereich: [0 bis 235959999]

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¶

BrickletGPS.Restart(restartType)¶

Eingabe:	restartType – Typ: Byte, Wertebereich: Siehe Konstanten

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:

• BrickletGPS.RESTART_TYPE_HOT_START = 0
• BrickletGPS.RESTART_TYPE_WARM_START = 1
• BrickletGPS.RESTART_TYPE_COLD_START = 2
• BrickletGPS.RESTART_TYPE_FACTORY_RESET = 3

BrickletGPS.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier¶

Ausgabe:

uid – Typ: String, Länge: bis zu 8 connectedUid – Typ: String, Länge: bis zu 8 position – Typ: Char, Wertebereich: ["a" bis "h", "z"] hardwareVersion – Typ: Byte[3] 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, Wertebereich: [0 bis 255] firmwareVersion – Typ: Byte[3] 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, Wertebereich: [0 bis 255] deviceIdentifier – Typ: Int32, Wertebereich: [0 bis 216 - 1]

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¶

BrickletGPS.SetCoordinatesCallbackPeriod(period)¶

Eingabe:	period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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.

BrickletGPS.GetCoordinatesCallbackPeriod() → period¶

Ausgabe:	period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

BrickletGPS.SetStatusCallbackPeriod(period)¶

Eingabe:	period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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.

BrickletGPS.GetStatusCallbackPeriod() → period¶

Ausgabe:	period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

BrickletGPS.SetAltitudeCallbackPeriod(period)¶

Eingabe:	period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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.

BrickletGPS.GetAltitudeCallbackPeriod() → period¶

Ausgabe:	period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

BrickletGPS.SetMotionCallbackPeriod(period)¶

Eingabe:	period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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.

BrickletGPS.GetMotionCallbackPeriod() → period¶

Ausgabe:	period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

BrickletGPS.SetDateTimeCallbackPeriod(period)¶

Eingabe:	period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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.

BrickletGPS.GetDateTimeCallbackPeriod() → period¶

Ausgabe:	period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Funktion einem Callback Property des Geräte Objektes zugewiesen wird. Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten beschrieben.

event BrickletGPS.CoordinatesCallback → sender, latitude, ns, longitude, ew, pdop, hdop, vdop, epe¶

Callback-Ausgabe:

sender – Typ: .NET Refnum (BrickletGPS) latitude – Typ: Int64, Einheit: 1/1000000 °, Wertebereich: [0 bis 90000000] ns – Typ: Char, Wertebereich: ["N", "S"] longitude – Typ: Int64, Einheit: 1/1000000 °, Wertebereich: [0 bis 180000000] ew – Typ: Char, Wertebereich: ["E", "W"] pdop – Typ: Int32, Einheit: 1/100, Wertebereich: [0 bis 216 - 1] hdop – Typ: Int32, Einheit: 1/100, Wertebereich: [0 bis 216 - 1] vdop – Typ: Int32, Einheit: 1/100, Wertebereich: [0 bis 216 - 1] epe – Typ: Int32, Einheit: 1 cm, Wertebereich: [0 bis 216 - 1]

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

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

event BrickletGPS.StatusCallback → sender, fix, satellitesView, satellitesUsed¶

Callback-Ausgabe:	sender – Typ: .NET Refnum (BrickletGPS) fix – Typ: Byte, Wertebereich: Siehe Konstanten satellitesView – Typ: Byte, Wertebereich: [0 bis 255] satellitesUsed – Typ: Byte, Wertebereich: [0 bis 255]

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:

• BrickletGPS.FIX_NO_FIX = 1
• BrickletGPS.FIX_2D_FIX = 2
• BrickletGPS.FIX_3D_FIX = 3

event BrickletGPS.AltitudeCallback → sender, altitude, geoidalSeparation¶

Callback-Ausgabe:	sender – Typ: .NET Refnum (BrickletGPS) altitude – Typ: Int32, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1] geoidalSeparation – Typ: Int32, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1]

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

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

event BrickletGPS.MotionCallback → sender, course, speed¶

Callback-Ausgabe:	sender – Typ: .NET Refnum (BrickletGPS) course – Typ: Int64, Einheit: 1/100 °, Wertebereich: [0 bis 36000] speed – Typ: Int64, Einheit: 1/100 km/h, Wertebereich: [0 bis 232 - 1]

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

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

event BrickletGPS.DateTimeCallback → sender, date, time¶

Callback-Ausgabe:	sender – Typ: .NET Refnum (BrickletGPS) date – Typ: Int64, Wertebereich: [10100 bis 311299] time – Typ: Int64, Wertebereich: [0 bis 235959999]

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.

BrickletGPS.GetAPIVersion() → apiVersion¶

Ausgabe:	apiVersion – Typ: Byte[3] 0: major – Typ: Byte, Wertebereich: [0 bis 255] 1: minor – Typ: Byte, Wertebereich: [0 bis 255] 2: revision – Typ: Byte, Wertebereich: [0 bis 255]

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.

BrickletGPS.GetResponseExpected(functionId) → responseExpected¶

Eingabe:	functionId – Typ: Byte, Wertebereich: Siehe Konstanten
Ausgabe:	responseExpected – Typ: Boolean

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels SetResponseExpected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für functionId:

• BrickletGPS.FUNCTION_RESTART = 6
• BrickletGPS.FUNCTION_SET_COORDINATES_CALLBACK_PERIOD = 7
• BrickletGPS.FUNCTION_SET_STATUS_CALLBACK_PERIOD = 9
• BrickletGPS.FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 11
• BrickletGPS.FUNCTION_SET_MOTION_CALLBACK_PERIOD = 13
• BrickletGPS.FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 15

BrickletGPS.SetResponseExpected(functionId, responseExpected)¶

Eingabe:	functionId – Typ: Byte, Wertebereich: Siehe Konstanten responseExpected – Typ: Boolean

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für functionId:

• BrickletGPS.FUNCTION_RESTART = 6
• BrickletGPS.FUNCTION_SET_COORDINATES_CALLBACK_PERIOD = 7
• BrickletGPS.FUNCTION_SET_STATUS_CALLBACK_PERIOD = 9
• BrickletGPS.FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 11
• BrickletGPS.FUNCTION_SET_MOTION_CALLBACK_PERIOD = 13
• BrickletGPS.FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 15

BrickletGPS.SetResponseExpectedAll(responseExpected)¶

Eingabe:	responseExpected – Typ: Boolean

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

Konstanten¶

BrickletGPS.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein GPS Bricklet zu identifizieren.

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

BrickletGPS.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines GPS Bricklet dar.