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

Java - GPS Bricklet 3.0¶

Dies ist die Beschreibung der Java 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 Java API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple¶

Download (ExampleSimple.java)

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletGPSV3;
import com.tinkerforge.BrickletGPSV3.Coordinates;

public class ExampleSimple {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your GPS Bricklet 3.0
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletGPSV3 gps = new BrickletGPSV3(UID, ipcon); // Create device object

        ipcon.connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Get current coordinates
        Coordinates coordinates = gps.getCoordinates(); // Can throw com.tinkerforge.TimeoutException

        System.out.println("Latitude: " + coordinates.latitude/1000000.0 + " °");
        System.out.println("N/S: " + coordinates.ns);
        System.out.println("Longitude: " + coordinates.longitude/1000000.0 + " °");
        System.out.println("E/W: " + coordinates.ew);

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

Callback¶

Download (ExampleCallback.java)

import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletGPSV3;

public class ExampleCallback {
    private static final String HOST = "localhost";
    private static final int PORT = 4223;

    // Change XYZ to the UID of your GPS Bricklet 3.0
    private static final String UID = "XYZ";

    // Note: To make the example code cleaner we do not handle exceptions. Exceptions
    //       you might normally want to catch are described in the documentation
    public static void main(String args[]) throws Exception {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletGPSV3 gps = new BrickletGPSV3(UID, ipcon); // Create device object

        ipcon.connect(HOST, PORT); // Connect to brickd
        // Don't use device before ipcon is connected

        // Add coordinates listener
        gps.addCoordinatesListener(new BrickletGPSV3.CoordinatesListener() {
            public void coordinates(long latitude, char ns, long longitude, char ew) {
                System.out.println("Latitude: " + latitude/1000000.0 + " °");
                System.out.println("N/S: " + ns);
                System.out.println("Longitude: " + longitude/1000000.0 + " °");
                System.out.println("E/W: " + ew);
                System.out.println("");
            }
        });

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

        System.out.println("Press key to exit"); System.in.read();
        ipcon.disconnect();
    }
}

API¶

Prinzipiell kann jede Methode der Java Bindings eine TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Neben der TimeoutException kann auch noch eine NotConnectedException geworfen werden, wenn versucht wird mit einem Brick oder Bricklet zu kommunizieren, aber die IP Connection nicht verbunden ist.

Da Java nicht mehrere Rückgabewerte unterstützt und eine Referenzrückgabe für elementare Type nicht möglich ist, werden kleine Klassen verwendet, die nur aus Member-Variablen bestehen. Die Member-Variablen des zurückgegebenen Objektes werden in der jeweiligen Methodenbeschreibung erläutert.

Das Package für alle Brick/Bricklet Bindings und die IP Connection ist com.tinkerforge.*

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen¶

class BrickletGPSV3(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	gpsV3 – Typ: BrickletGPSV3

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

BrickletGPSV3 gpsV3 = new BrickletGPSV3("YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

BrickletGPSV3.Coordinates BrickletGPSV3.getCoordinates()¶

Rückgabeobjekt:	latitude – Typ: long, Einheit: 1/1000000 °, Wertebereich: [0 bis 90000000] ns – Typ: char, Wertebereich: ['N', 'S'] longitude – Typ: long, Einheit: 1/1000000 °, Wertebereich: [0 bis 180000000] ew – Typ: char, Wertebereich: ['E', 'W']

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

BrickletGPSV3.Status BrickletGPSV3.getStatus()¶

Rückgabeobjekt:	hasFix – Typ: boolean satellitesView – Typ: int, Wertebereich: [0 bis 255]

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.

BrickletGPSV3.Altitude BrickletGPSV3.getAltitude()¶

Rückgabeobjekt:	altitude – Typ: int, Einheit: 1 cm, Wertebereich: [-2³¹ bis 2³¹ - 1] geoidalSeparation – Typ: int, Einheit: 1 cm, Wertebereich: [-2³¹ bis 2³¹ - 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()).

BrickletGPSV3.Motion BrickletGPSV3.getMotion()¶

Rückgabeobjekt:	course – Typ: long, Einheit: 1/100 °, Wertebereich: [0 bis 36000] speed – Typ: long, Einheit: 1/100 km/h, Wertebereich: [0 bis 2³² - 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()).

BrickletGPSV3.DateTime BrickletGPSV3.getDateTime()¶

Rückgabeobjekt:	date – Typ: long, Wertebereich: [10100 bis 311299] time – Typ: long, 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.

BrickletGPSV3.SatelliteSystemStatus BrickletGPSV3.getSatelliteSystemStatus(int satelliteSystem)¶

Parameter:	satelliteSystem – Typ: int, Wertebereich: Siehe Konstanten
Rückgabeobjekt:	satelliteNumbers – Typ: int[], Länge: variabel, Wertebereich: [0 bis 255] fix – Typ: int, Wertebereich: Siehe Konstanten pdop – Typ: int, Einheit: 1/100, Wertebereich: [0 bis 2¹⁶ - 1] hdop – Typ: int, Einheit: 1/100, Wertebereich: [0 bis 2¹⁶ - 1] vdop – Typ: int, Einheit: 1/100, Wertebereich: [0 bis 2¹⁶ - 1]

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:

BrickletGPSV3.SATELLITE_SYSTEM_GPS = 0
BrickletGPSV3.SATELLITE_SYSTEM_GLONASS = 1
BrickletGPSV3.SATELLITE_SYSTEM_GALILEO = 2

Für fix:

BrickletGPSV3.FIX_NO_FIX = 1
BrickletGPSV3.FIX_2D_FIX = 2
BrickletGPSV3.FIX_3D_FIX = 3

BrickletGPSV3.SatelliteStatus BrickletGPSV3.getSatelliteStatus(int satelliteSystem, int satelliteNumber)¶

Parameter:	satelliteSystem – Typ: int, Wertebereich: Siehe Konstanten satelliteNumber – Typ: int, Wertebereich: [1 bis 32]
Rückgabeobjekt:	elevation – Typ: int, Einheit: 1 °, Wertebereich: [0 bis 90] azimuth – Typ: int, Einheit: 1 °, Wertebereich: [0 bis 359] snr – Typ: int, Einheit: 1 dB, Wertebereich: [0 bis 99]

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:

BrickletGPSV3.SATELLITE_SYSTEM_GPS = 0
BrickletGPSV3.SATELLITE_SYSTEM_GLONASS = 1
BrickletGPSV3.SATELLITE_SYSTEM_GALILEO = 2

Fortgeschrittene Funktionen¶

void BrickletGPSV3.restart(int restartType)¶

Parameter:	restartType – Typ: int, 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:

BrickletGPSV3.RESTART_TYPE_HOT_START = 0
BrickletGPSV3.RESTART_TYPE_WARM_START = 1
BrickletGPSV3.RESTART_TYPE_COLD_START = 2
BrickletGPSV3.RESTART_TYPE_FACTORY_RESET = 3

void BrickletGPSV3.setFixLEDConfig(int config)¶

Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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:

BrickletGPSV3.FIX_LED_CONFIG_OFF = 0
BrickletGPSV3.FIX_LED_CONFIG_ON = 1
BrickletGPSV3.FIX_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletGPSV3.FIX_LED_CONFIG_SHOW_FIX = 3
BrickletGPSV3.FIX_LED_CONFIG_SHOW_PPS = 4

int BrickletGPSV3.getFixLEDConfig()¶

Rückgabe:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

BrickletGPSV3.FIX_LED_CONFIG_OFF = 0
BrickletGPSV3.FIX_LED_CONFIG_ON = 1
BrickletGPSV3.FIX_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletGPSV3.FIX_LED_CONFIG_SHOW_FIX = 3
BrickletGPSV3.FIX_LED_CONFIG_SHOW_PPS = 4

void BrickletGPSV3.setSBASConfig(int sbasConfig)¶

Parameter:	sbasConfig – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

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:

BrickletGPSV3.SBAS_ENABLED = 0
BrickletGPSV3.SBAS_DISABLED = 1

int BrickletGPSV3.getSBASConfig()¶

Rückgabe:	sbasConfig – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

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

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

Für sbasConfig:

BrickletGPSV3.SBAS_ENABLED = 0
BrickletGPSV3.SBAS_DISABLED = 1

BrickletGPSV3.SPITFPErrorCount BrickletGPSV3.getSPITFPErrorCount()¶

Rückgabeobjekt:	errorCountAckChecksum – Typ: long, Wertebereich: [0 bis 2³² - 1] errorCountMessageChecksum – Typ: long, Wertebereich: [0 bis 2³² - 1] errorCountFrame – Typ: long, Wertebereich: [0 bis 2³² - 1] errorCountOverflow – Typ: long, Wertebereich: [0 bis 2³² - 1]

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.

void BrickletGPSV3.setStatusLEDConfig(int config)¶

Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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:

BrickletGPSV3.STATUS_LED_CONFIG_OFF = 0
BrickletGPSV3.STATUS_LED_CONFIG_ON = 1
BrickletGPSV3.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletGPSV3.STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletGPSV3.getStatusLEDConfig()¶

Rückgabe:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

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

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

Für config:

BrickletGPSV3.STATUS_LED_CONFIG_OFF = 0
BrickletGPSV3.STATUS_LED_CONFIG_ON = 1
BrickletGPSV3.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletGPSV3.STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletGPSV3.getChipTemperature()¶

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

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.

void BrickletGPSV3.reset()¶

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.

BrickletGPSV3.Identity BrickletGPSV3.getIdentity()¶

Rückgabeobjekt:

Rückgabeobjekt:	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: short[], Länge: 3 0: major – Typ: short, Wertebereich: [0 bis 255] 1: minor – Typ: short, Wertebereich: [0 bis 255] 2: revision – Typ: short, Wertebereich: [0 bis 255] firmwareVersion – Typ: short[], Länge: 3 0: major – Typ: short, Wertebereich: [0 bis 255] 1: minor – Typ: short, Wertebereich: [0 bis 255] 2: revision – Typ: short, Wertebereich: [0 bis 255] deviceIdentifier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

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: short[], Länge: 3

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

firmwareVersion – Typ: short[], Länge: 3

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

deviceIdentifier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 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 Listener¶

void BrickletGPSV3.setCoordinatesCallbackPeriod(long period)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Setzt die Periode mit welcher der CoordinatesListener Listener ausgelöst wird. Ein Wert von 0 deaktiviert den Listener.

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

long BrickletGPSV3.getCoordinatesCallbackPeriod()¶

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

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

void BrickletGPSV3.setStatusCallbackPeriod(long period)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Setzt die Periode mit welcher der StatusListener Listener ausgelöst wird. Ein Wert von 0 deaktiviert den Listener.

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

long BrickletGPSV3.getStatusCallbackPeriod()¶

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

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

void BrickletGPSV3.setAltitudeCallbackPeriod(long period)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Setzt die Periode mit welcher der AltitudeListener Listener ausgelöst wird. Ein Wert von 0 deaktiviert den Listener.

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

long BrickletGPSV3.getAltitudeCallbackPeriod()¶

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

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

void BrickletGPSV3.setMotionCallbackPeriod(long period)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Setzt die Periode mit welcher der MotionListener Listener ausgelöst wird. Ein Wert von 0 deaktiviert den Listener.

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

long BrickletGPSV3.getMotionCallbackPeriod()¶

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

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

void BrickletGPSV3.setDateTimeCallbackPeriod(long period)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Setzt die Periode mit welcher der DateTimeListener Listener ausgelöst wird. Ein Wert von 0 deaktiviert den Listener.

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

long BrickletGPSV3.getDateTimeCallbackPeriod()¶

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

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

Listener¶

Listener können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit add*Listener() Funktionen eines Geräteobjekts durchgeführt werden.

Der Parameter ist ein Listener Klassen Objekt, z.B.:

device.addExampleListener(new BrickletGPSV3.ExampleListener() {
    public void property(int value) {
        System.out.println("Value: " + value);
    }
});

Die verfügbaren Listener Klassen mit den Methoden welche überschrieben werden können werden unterhalb beschrieben. Es ist möglich mehrere Listener hinzuzufügen und auch mit einem korrespondierenden remove*Listener() wieder zu entfernen.

Bemerkung

Listener 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.

class BrickletGPSV3.PulsePerSecondListener()¶

Dieser Listener kann mit der Funktion addPulsePerSecondListener() hinzugefügt werden. Ein hinzugefügter Listener kann mit der Funktion removePulsePerSecondListener() wieder entfernt werden.

void pulsePerSecond()

Dieser Listener 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.

class BrickletGPSV3.CoordinatesListener()¶

Dieser Listener kann mit der Funktion addCoordinatesListener() hinzugefügt werden. Ein hinzugefügter Listener kann mit der Funktion removeCoordinatesListener() wieder entfernt werden.

void coordinates(long latitude, char ns, long longitude, char ew)

Parameter:	latitude – Typ: long, Einheit: 1/1000000 °, Wertebereich: [0 bis 90000000] ns – Typ: char, Wertebereich: ['N', 'S'] longitude – Typ: long, Einheit: 1/1000000 °, Wertebereich: [0 bis 180000000] ew – Typ: char, Wertebereich: ['E', 'W']

Dieser Listener wird mit der Periode, wie gesetzt mit setCoordinatesCallbackPeriod(), ausgelöst. Die Parameter sind die gleichen wie die von getCoordinates().

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

class BrickletGPSV3.StatusListener()¶

Dieser Listener kann mit der Funktion addStatusListener() hinzugefügt werden. Ein hinzugefügter Listener kann mit der Funktion removeStatusListener() wieder entfernt werden.

void status(boolean hasFix, int satellitesView)

Parameter:	hasFix – Typ: boolean satellitesView – Typ: int, Wertebereich: [0 bis 255]

Dieser Listener wird mit der Periode, wie gesetzt mit setStatusCallbackPeriod(), ausgelöst. Die Parameter sind die gleichen wie die von getStatus().

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

class BrickletGPSV3.AltitudeListener()¶

Dieser Listener kann mit der Funktion addAltitudeListener() hinzugefügt werden. Ein hinzugefügter Listener kann mit der Funktion removeAltitudeListener() wieder entfernt werden.

void altitude(int altitude, int geoidalSeparation)

Parameter:	altitude – Typ: int, Einheit: 1 cm, Wertebereich: [-2³¹ bis 2³¹ - 1] geoidalSeparation – Typ: int, Einheit: 1 cm, Wertebereich: [-2³¹ bis 2³¹ - 1]

Dieser Listener wird mit der Periode, wie gesetzt mit setAltitudeCallbackPeriod(), ausgelöst. Die Parameter sind die gleichen wie die von getAltitude().

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

class BrickletGPSV3.MotionListener()¶

Dieser Listener kann mit der Funktion addMotionListener() hinzugefügt werden. Ein hinzugefügter Listener kann mit der Funktion removeMotionListener() wieder entfernt werden.

void motion(long course, long speed)

Parameter:	course – Typ: long, Einheit: 1/100 °, Wertebereich: [0 bis 36000] speed – Typ: long, Einheit: 1/100 km/h, Wertebereich: [0 bis 2³² - 1]

Dieser Listener wird mit der Periode, wie gesetzt mit setMotionCallbackPeriod(), ausgelöst. Die Parameter sind die gleichen wie die von getMotion().

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

class BrickletGPSV3.DateTimeListener()¶

Dieser Listener kann mit der Funktion addDateTimeListener() hinzugefügt werden. Ein hinzugefügter Listener kann mit der Funktion removeDateTimeListener() wieder entfernt werden.

void dateTime(long date, long time)

Parameter:	date – Typ: long, Wertebereich: [10100 bis 311299] time – Typ: long, Wertebereich: [0 bis 235959999]

Dieser Listener wird mit der Periode, wie gesetzt mit setDateTimeCallbackPeriod(), ausgelöst. Die Parameter sind die gleichen wie die von getDateTime().

Der DateTimeListener Listener 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.

short[] BrickletGPSV3.getAPIVersion()¶

Rückgabeobjekt:	apiVersion – Typ: short[], Länge: 3 0: major – Typ: short, Wertebereich: [0 bis 255] 1: minor – Typ: short, Wertebereich: [0 bis 255] 2: revision – Typ: short, 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.

boolean BrickletGPSV3.getResponseExpected(byte functionId)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:	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 Listeners 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:

BrickletGPSV3.FUNCTION_RESTART = 6
BrickletGPSV3.FUNCTION_SET_FIX_LED_CONFIG = 9
BrickletGPSV3.FUNCTION_SET_COORDINATES_CALLBACK_PERIOD = 11
BrickletGPSV3.FUNCTION_SET_STATUS_CALLBACK_PERIOD = 13
BrickletGPSV3.FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 15
BrickletGPSV3.FUNCTION_SET_MOTION_CALLBACK_PERIOD = 17
BrickletGPSV3.FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 19
BrickletGPSV3.FUNCTION_SET_SBAS_CONFIG = 27
BrickletGPSV3.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletGPSV3.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletGPSV3.FUNCTION_RESET = 243
BrickletGPSV3.FUNCTION_WRITE_UID = 248

void BrickletGPSV3.setResponseExpected(byte functionId, boolean responseExpected)¶

Parameter:	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 Listeners (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:

BrickletGPSV3.FUNCTION_RESTART = 6
BrickletGPSV3.FUNCTION_SET_FIX_LED_CONFIG = 9
BrickletGPSV3.FUNCTION_SET_COORDINATES_CALLBACK_PERIOD = 11
BrickletGPSV3.FUNCTION_SET_STATUS_CALLBACK_PERIOD = 13
BrickletGPSV3.FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 15
BrickletGPSV3.FUNCTION_SET_MOTION_CALLBACK_PERIOD = 17
BrickletGPSV3.FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 19
BrickletGPSV3.FUNCTION_SET_SBAS_CONFIG = 27
BrickletGPSV3.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletGPSV3.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletGPSV3.FUNCTION_RESET = 243
BrickletGPSV3.FUNCTION_WRITE_UID = 248

void BrickletGPSV3.setResponseExpectedAll(boolean responseExpected)¶

Parameter:	responseExpected – Typ: boolean

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Listeners 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.

int BrickletGPSV3.setBootloaderMode(int mode)¶

Parameter:	mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	status – Typ: int, Wertebereich: Siehe Konstanten

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:

BrickletGPSV3.BOOTLOADER_MODE_BOOTLOADER = 0
BrickletGPSV3.BOOTLOADER_MODE_FIRMWARE = 1
BrickletGPSV3.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletGPSV3.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletGPSV3.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

BrickletGPSV3.BOOTLOADER_STATUS_OK = 0
BrickletGPSV3.BOOTLOADER_STATUS_INVALID_MODE = 1
BrickletGPSV3.BOOTLOADER_STATUS_NO_CHANGE = 2
BrickletGPSV3.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BrickletGPSV3.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BrickletGPSV3.BOOTLOADER_STATUS_CRC_MISMATCH = 5

int BrickletGPSV3.getBootloaderMode()¶

Rückgabe:	mode – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für mode:

BrickletGPSV3.BOOTLOADER_MODE_BOOTLOADER = 0
BrickletGPSV3.BOOTLOADER_MODE_FIRMWARE = 1
BrickletGPSV3.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletGPSV3.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletGPSV3.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

void BrickletGPSV3.setWriteFirmwarePointer(long pointer)¶

Parameter:	pointer – Typ: long, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]

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.

int BrickletGPSV3.writeFirmware(int[] data)¶

Parameter:	data – Typ: int[], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:	status – Typ: int, Wertebereich: [0 bis 255]

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.

void BrickletGPSV3.writeUID(long uid)¶

Parameter:	uid – Typ: long, Wertebereich: [0 bis 2³² - 1]

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.

long BrickletGPSV3.readUID()¶

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

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

Konstanten¶

int BrickletGPSV3.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein GPS Bricklet 3.0 zu identifizieren.

Die getIdentity() Funktion und der IPConnection.EnumerateListener Listener der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

String BrickletGPSV3.DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines GPS Bricklet 3.0 dar.