Dies ist die Beschreibung der Java API Bindings für das GPS Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des GPS Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die Java API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 | import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletGPS;
import com.tinkerforge.BrickletGPS.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
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
BrickletGPS gps = new BrickletGPS(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();
}
}
|
Download (ExampleCallback.java)
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 37 38 39 40 | import com.tinkerforge.IPConnection;
import com.tinkerforge.BrickletGPS;
public class ExampleCallback {
private static final String HOST = "localhost";
private static final int PORT = 4223;
// Change XYZ to the UID of your GPS Bricklet
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
BrickletGPS gps = new BrickletGPS(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 BrickletGPS.CoordinatesListener() {
public void coordinates(long latitude, char ns, long longitude, char ew,
int pdop, int hdop, int vdop, int epe) {
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();
}
}
|
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.
BrickletGPS
(String uid, IPConnection ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
BrickletGPS gps = new BrickletGPS("YOUR_DEVICE_UID", ipcon);
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletGPS.
getCoordinates
()¶Rückgabeobjekt: |
|
---|
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
()¶Rückgabeobjekt: |
|
---|
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.
getAltitude
()¶Rückgabeobjekt: |
|
---|
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
()¶Rückgabeobjekt: |
|
---|
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
()¶Rückgabeobjekt: |
|
---|
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.
BrickletGPS.
restart
(short restartType)¶Parameter: |
|
---|
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.
getIdentity
()¶Rückgabeobjekt: |
|
---|
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.
BrickletGPS.
setCoordinatesCallbackPeriod
(long period)¶Parameter: |
|
---|
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.
BrickletGPS.
getCoordinatesCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setCoordinatesCallbackPeriod()
gesetzt.
BrickletGPS.
setStatusCallbackPeriod
(long period)¶Parameter: |
|
---|
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.
BrickletGPS.
getStatusCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setStatusCallbackPeriod()
gesetzt.
BrickletGPS.
setAltitudeCallbackPeriod
(long period)¶Parameter: |
|
---|
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.
BrickletGPS.
getAltitudeCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setAltitudeCallbackPeriod()
gesetzt.
BrickletGPS.
setMotionCallbackPeriod
(long period)¶Parameter: |
|
---|
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.
BrickletGPS.
getMotionCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setMotionCallbackPeriod()
gesetzt.
BrickletGPS.
setDateTimeCallbackPeriod
(long period)¶Parameter: |
|
---|
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.
BrickletGPS.
getDateTimeCallbackPeriod
()¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von setDateTimeCallbackPeriod()
gesetzt.
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 BrickletGPS.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.
BrickletGPS.
CoordinatesListener
()¶Dieser Listener kann mit der Funktion addCoordinatesListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeCoordinatesListener()
wieder
entfernt werden.
coordinates
(long latitude, char ns, long longitude, char ew, int pdop, int hdop, int vdop, int epe)Parameter: |
|
---|
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()
).
BrickletGPS.
StatusListener
()¶Dieser Listener kann mit der Funktion addStatusListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeStatusListener()
wieder
entfernt werden.
status
(short fix, short satellitesView, short satellitesUsed)Parameter: |
|
---|
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.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für fix:
BrickletGPS.
AltitudeListener
()¶Dieser Listener kann mit der Funktion addAltitudeListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeAltitudeListener()
wieder
entfernt werden.
altitude
(int altitude, int geoidalSeparation)Parameter: |
|
---|
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()
).
BrickletGPS.
MotionListener
()¶Dieser Listener kann mit der Funktion addMotionListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeMotionListener()
wieder
entfernt werden.
motion
(long course, long speed)Parameter: |
|
---|
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()
).
BrickletGPS.
DateTimeListener
()¶Dieser Listener kann mit der Funktion addDateTimeListener()
hinzugefügt werden.
Ein hinzugefügter Listener kann mit der Funktion removeDateTimeListener()
wieder
entfernt werden.
dateTime
(long date, long time)Parameter: |
|
---|
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 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
()¶Rückgabeobjekt: |
|
---|
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
(byte functionId)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.
Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt
werden, da diese Funktionen immer eine Antwort senden. Für
Konfigurationsfunktionen für 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:
BrickletGPS.
setResponseExpected
(byte functionId, boolean responseExpected)¶Parameter: |
|
---|
Ä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.
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.
setResponseExpectedAll
(boolean responseExpected)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Listeners diese Gerätes.
BrickletGPS.
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein GPS Bricklet 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.
BrickletGPS.
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines GPS Bricklet dar.