Dies ist die Beschreibung der PHP 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 PHP 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 | <?php
require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletGPS.php');
use Tinkerforge\IPConnection;
use Tinkerforge\BrickletGPS;
const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your GPS Bricklet
$ipcon = new IPConnection(); // Create IP connection
$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 = $gps->getCoordinates();
echo "Latitude: " . $coordinates['latitude']/1000000.0 . " °\n";
echo "N/S: " . $coordinates['ns'] . "\n";
echo "Longitude: " . $coordinates['longitude']/1000000.0 . " °\n";
echo "E/W: " . $coordinates['ew'] . "\n";
echo "Press key to exit\n";
fgetc(fopen('php://stdin', 'r'));
$ipcon->disconnect();
?>
|
Download (ExampleCallback.php)
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 | <?php
require_once('Tinkerforge/IPConnection.php');
require_once('Tinkerforge/BrickletGPS.php');
use Tinkerforge\IPConnection;
use Tinkerforge\BrickletGPS;
const HOST = 'localhost';
const PORT = 4223;
const UID = 'XYZ'; // Change XYZ to the UID of your GPS Bricklet
// Callback function for coordinates callback
function cb_coordinates($latitude, $ns, $longitude, $ew, $pdop, $hdop, $vdop, $epe)
{
echo "Latitude: " . $latitude/1000000.0 . " °\n";
echo "N/S: $ns\n";
echo "Longitude: " . $longitude/1000000.0 . " °\n";
echo "E/W: $ew\n";
echo "\n";
}
$ipcon = new IPConnection(); // Create IP connection
$gps = new BrickletGPS(UID, $ipcon); // Create device object
$ipcon->connect(HOST, PORT); // Connect to brickd
// Don't use device before ipcon is connected
// Register coordinates callback to function cb_coordinates
$gps->registerCallback(BrickletGPS::CALLBACK_COORDINATES, 'cb_coordinates');
// 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);
echo "Press ctrl+c to exit\n";
$ipcon->dispatchCallbacks(-1); // Dispatch callbacks forever
?>
|
Funktion die mehrere Werte zurückgeben geben diese in einem assoziativen Array zurück.
BrickletGPS
(string $uid, IPConnection $ipcon)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID $uid
:
<?php $gps = new BrickletGPS('YOUR_DEVICE_UID', $ipcon); ?>
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletGPS::
getCoordinates
()¶Rückgabe-Array: |
|
---|
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ückgabe-Array: |
|
---|
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ückgabe-Array: |
|
---|
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ückgabe-Array: |
|
---|
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ückgabe-Array: |
|
---|
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
(int $restart_type)¶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 $restart_type:
BrickletGPS::
getIdentity
()¶Rückgabe-Array: |
|
---|
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::
registerCallback
(int $callback_id, callable $callback, mixed $user_data=NULL)¶Parameter: |
|
---|
Registriert die $function
für die gegebene $callback_id
. Die optionalen
$user_data
werden der Funktion als letztes Parameter mit übergeben.
Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.
BrickletGPS::
setCoordinatesCallbackPeriod
(int $period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der CALLBACK_COORDINATES
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
Der CALLBACK_COORDINATES
Callback 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
(int $period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der CALLBACK_STATUS
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der CALLBACK_STATUS
Callback 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
(int $period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der CALLBACK_ALTITUDE
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der CALLBACK_ALTITUDE
Callback 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
(int $period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der CALLBACK_MOTION
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der CALLBACK_MOTION
Callback 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
(int $period)¶Parameter: |
|
---|
Setzt die Periode mit welcher der CALLBACK_DATE_TIME
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der CALLBACK_DATE_TIME
Callback 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.
Callbacks können registriert werden um zeitkritische
oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann
mit der Funktion registerCallback()
des
Geräte Objektes durchgeführt werden. Der erste Parameter ist der Callback ID
und der zweite die Callback-Funktion:
<?php
function myCallback($param)
{
echo $param . "\n";
}
$gps->registerCallback(BrickletGPS::CALLBACK_EXAMPLE, 'myCallback');
?>
Die verfügbaren IDs mit den dazugehörigen Funktionssignaturen werden weiter unten beschrieben.
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.
BrickletGPS::
CALLBACK_COORDINATES
¶<?php void callback(int $latitude, string $ns, int $longitude, string $ew, int $pdop, int $hdop, int $vdop, int $epe [, mixed $user_data]) ?>
Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
setCoordinatesCallbackPeriod()
, ausgelöst. Die Parameter sind die
gleichen wie die von getCoordinates()
.
Der CALLBACK_COORDINATES
Callback wird nur ausgelöst, wenn sich die
Koordinaten seit der letzten Auslösung geändert haben und ein Fix vorhanden
ist (siehe getStatus()
).
BrickletGPS::
CALLBACK_STATUS
¶<?php void callback(int $fix, int $satellites_view, int $satellites_used [, mixed $user_data]) ?>
Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
setStatusCallbackPeriod()
, ausgelöst. Die Parameter sind die
gleichen wie die von getStatus()
.
Der CALLBACK_STATUS
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::
CALLBACK_ALTITUDE
¶<?php void callback(int $altitude, int $geoidal_separation [, mixed $user_data]) ?>
Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
setAltitudeCallbackPeriod()
, ausgelöst. Die Parameter sind die
gleichen wie die von getAltitude()
.
Der CALLBACK_ALTITUDE
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()
).
BrickletGPS::
CALLBACK_MOTION
¶<?php void callback(int $course, int $speed [, mixed $user_data]) ?>
Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
setMotionCallbackPeriod()
, ausgelöst. Die Parameter sind die
gleichen wie die von getMotion()
.
Der CALLBACK_MOTION
Callback wird nur ausgelöst, wenn sich die
Bewegung seit der letzten Auslösung geändert hat und ein Fix vorhanden
ist (siehe getStatus()
).
BrickletGPS::
CALLBACK_DATE_TIME
¶<?php void callback(int $date, int $time [, mixed $user_data]) ?>
Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
setDateTimeCallbackPeriod()
, ausgelöst. Die Parameter sind die
gleichen wie die von getDateTime()
.
Der CALLBACK_DATE_TIME
Callback 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ückgabe-Array: |
|
---|
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
(int $function_id)¶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 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 $function_id:
BrickletGPS::
setResponseExpected
(int $function_id, bool $response_expected)¶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 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 $function_id:
BrickletGPS::
setResponseExpectedAll
(bool $response_expected)¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
BrickletGPS::
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein GPS Bricklet zu identifizieren.
Die getIdentity()
Funktion und der
IPConnection::CALLBACK_ENUMERATE
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.