Software / API Bindings / Perl / API Referenz und Beispiele / Bricklets (Abgekündigt) / GPS Bricklet

Perl - GPS Bricklet¶

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

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple¶

Download (example_simple.pl)

#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletGPS;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your GPS Bricklet

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $gps = Tinkerforge::BrickletGPS->new(&UID, $ipcon); # Create device object

$ipcon->connect(&HOST, &PORT); # Connect to brickd
# Don't use device before ipcon is connected

# Get current coordinates
my ($latitude, $ns, $longitude, $ew, $pdop, $hdop, $vdop, $epe) = $gps->get_coordinates();

print "Latitude: " . $latitude/1000000.0 . " °\n";
print "N/S: $ns\n";
print "Longitude: " . $longitude/1000000.0 . " °\n";
print "E/W: $ew\n";

print "Press key to exit\n";
<STDIN>;
$ipcon->disconnect();

Callback¶

Download (example_callback.pl)

#!/usr/bin/perl

use strict;
use Tinkerforge::IPConnection;
use Tinkerforge::BrickletGPS;

use constant HOST => 'localhost';
use constant PORT => 4223;
use constant UID => 'XYZ'; # Change XYZ to the UID of your GPS Bricklet

# Callback subroutine for coordinates callback
sub cb_coordinates
{
    my ($latitude, $ns, $longitude, $ew, $pdop, $hdop, $vdop, $epe) = @_;

    print "Latitude: " . $latitude/1000000.0 . " °\n";
    print "N/S: $ns\n";
    print "Longitude: " . $longitude/1000000.0 . " °\n";
    print "E/W: $ew\n";
    print "\n";
}

my $ipcon = Tinkerforge::IPConnection->new(); # Create IP connection
my $gps = Tinkerforge::BrickletGPS->new(&UID, $ipcon); # Create device object

$ipcon->connect(&HOST, &PORT); # Connect to brickd
# Don't use device before ipcon is connected

# Register coordinates callback to subroutine cb_coordinates
$gps->register_callback($gps->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->set_coordinates_callback_period(1000);

print "Press key to exit\n";
<STDIN>;
$ipcon->disconnect();

API¶

Allgemein kann jede Subroutine der Perl Bindings Fehler als Tinkerforge::Error Objekt mittels croak() melden. Das Objekt hat eine get_code() und eine get_message() Subroutine. Es sind verschiedene Fehlercodes definiert:

Error->ALREADY_CONNECTED = 11
Error->NOT_CONNECTED = 12
Error->CONNECT_FAILED = 13
Error->INVALID_FUNCTION_ID = 21
Error->TIMEOUT = 31
Error->INVALID_PARAMETER = 41
Error->FUNCTION_NOT_SUPPORTED = 42
Error->UNKNOWN_ERROR = 43
Error->STREAM_OUT_OF_SYNC = 51
Error->INVALID_UID = 61
Error->NON_ASCII_CHAR_IN_SECRET = 71
Error->WRONG_DEVICE_TYPE = 81
Error->DEVICE_REPLACED = 82

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

BrickletGPS->new($uid, $ipcon)¶

Parameter:	$uid – Typ: string $ipcon – Typ: IPConnection
Rückgabe:	$gps – Typ: BrickletGPS

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

$gps = BrickletGPS->new("YOUR_DEVICE_UID", $ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

BrickletGPS->get_coordinates()¶

Rückgabe-Array:

Rückgabe-Array:	0: $latitude – Typ: int, Einheit: 1/1000000 °, Wertebereich: [0 bis 90000000] 1: $ns – Typ: char, Wertebereich: ['N', 'S'] 2: $longitude – Typ: int, Einheit: 1/1000000 °, Wertebereich: [0 bis 180000000] 3: $ew – Typ: char, Wertebereich: ['E', 'W'] 4: $pdop – Typ: int, Einheit: 1/100, Wertebereich: [0 bis 2¹⁶ - 1] 5: $hdop – Typ: int, Einheit: 1/100, Wertebereich: [0 bis 2¹⁶ - 1] 6: $vdop – Typ: int, Einheit: 1/100, Wertebereich: [0 bis 2¹⁶ - 1] 7: $epe – Typ: int, Einheit: 1 cm, Wertebereich: [0 bis 2¹⁶ - 1]

0: $latitude – Typ: int, Einheit: 1/1000000 °, Wertebereich: [0 bis 90000000]
1: $ns – Typ: char, Wertebereich: ['N', 'S']
2: $longitude – Typ: int, Einheit: 1/1000000 °, Wertebereich: [0 bis 180000000]
3: $ew – Typ: char, Wertebereich: ['E', 'W']
4: $pdop – Typ: int, Einheit: 1/100, Wertebereich: [0 bis 2¹⁶ - 1]
5: $hdop – Typ: int, Einheit: 1/100, Wertebereich: [0 bis 2¹⁶ - 1]
6: $vdop – Typ: int, Einheit: 1/100, Wertebereich: [0 bis 2¹⁶ - 1]
7: $epe – Typ: int, Einheit: 1 cm, Wertebereich: [0 bis 2¹⁶ - 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 get_status()).

BrickletGPS->get_status()¶

Rückgabe-Array:	0: $fix – Typ: int, Wertebereich: Siehe Konstanten 1: $satellites_view – Typ: int, Wertebereich: [0 bis 255] 2: $satellites_used – Typ: int, 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, `get_coordinates()`, `get_altitude()` und `get_motion()` geben ungültige Daten zurück
2	2D Fix, nur `get_coordinates()` und `get_motion()` geben gültige Daten zurück
3	3D Fix, `get_coordinates()`, `get_altitude()` und `get_motion()` 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->get_altitude()¶

Rückgabe-Array:	0: $altitude – Typ: int, Einheit: 1 cm, Wertebereich: [-2³¹ bis 2³¹ - 1] 1: $geoidal_separation – 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 get_status()).

BrickletGPS->get_motion()¶

Rückgabe-Array:	0: $course – Typ: int, Einheit: 1/100 °, Wertebereich: [0 bis 36000] 1: $speed – Typ: int, 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 get_status()).

BrickletGPS->get_date_time()¶

Rückgabe-Array:	0: $date – Typ: int, Wertebereich: [10100 bis 311299] 1: $time – Typ: int, 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($restart_type)¶

Parameter:	$restart_type – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	undef

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->RESTART_TYPE_HOT_START = 0
BrickletGPS->RESTART_TYPE_WARM_START = 1
BrickletGPS->RESTART_TYPE_COLD_START = 2
BrickletGPS->RESTART_TYPE_FACTORY_RESET = 3

BrickletGPS->get_identity()¶

Rückgabe-Array:

Rückgabe-Array:	0: $uid – Typ: string, Länge: bis zu 8 1: $connected_uid – Typ: string, Länge: bis zu 8 2: $position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z'] 3: @hardware_version – Typ: [int, ...], Länge: 3 0: $major – Typ: int, Wertebereich: [0 bis 255] 1: $minor – Typ: int, Wertebereich: [0 bis 255] 2: $revision – Typ: int, Wertebereich: [0 bis 255] 4: @firmware_version – Typ: [int, ...], Länge: 3 0: $major – Typ: int, Wertebereich: [0 bis 255] 1: $minor – Typ: int, Wertebereich: [0 bis 255] 2: $revision – Typ: int, Wertebereich: [0 bis 255] 5: $device_identifier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

0: $uid – Typ: string, Länge: bis zu 8
1: $connected_uid – Typ: string, Länge: bis zu 8
2: $position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
3: @hardware_version – Typ: [int, ...], Länge: 3

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

4: @firmware_version – Typ: [int, ...], Länge: 3

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

5: $device_identifier – 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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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->register_callback($callback_id, $function)¶

Parameter:	$callback_id – Typ: int $function – Typ: string
Rückgabe:	undef

Registriert den $function Namen für die gegebene $callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

BrickletGPS->set_coordinates_callback_period($period)¶

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

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->get_coordinates_callback_period()¶

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

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

BrickletGPS->set_status_callback_period($period)¶

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

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->get_status_callback_period()¶

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

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

BrickletGPS->set_altitude_callback_period($period)¶

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

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->get_altitude_callback_period()¶

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

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

BrickletGPS->set_motion_callback_period($period)¶

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

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->get_motion_callback_period()¶

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

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

BrickletGPS->set_date_time_callback_period($period)¶

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

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->get_date_time_callback_period()¶

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

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

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion register_callback() des Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID und der zweite Parameter ist der Name der Callback-Funktion:

sub my_callback
{
    print "@_[0]";
}

$gps->register_callback(BrickletGPS->CALLBACK_EXAMPLE, 'my_callback')

Die Callback Funktion wird dann von einem internen Thread der IP Connection aufgerufen werden. Im Gegensatz zu vielen anderen Programmiersprachen werden Variablen nicht automatisch zwischen Threads geteilt. Wenn eine Variable gleichzeitig in einer Callback Funktion und dem Rest des Programms genutzt werden soll, dann muss diese als :shared markiert werden. Siehe dazu auch die Dokumentation des threads::shared Perl Moduls für weitere Details.

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen 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¶

Callback-Parameter:

Callback-Parameter:	$latitude – Typ: int, Einheit: 1/1000000 °, Wertebereich: [0 bis 90000000] $ns – Typ: char, Wertebereich: ['N', 'S'] $longitude – Typ: int, Einheit: 1/1000000 °, Wertebereich: [0 bis 180000000] $ew – Typ: char, Wertebereich: ['E', 'W'] $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] $epe – Typ: int, Einheit: 1 cm, Wertebereich: [0 bis 2¹⁶ - 1]

$latitude – Typ: int, Einheit: 1/1000000 °, Wertebereich: [0 bis 90000000]
$ns – Typ: char, Wertebereich: ['N', 'S']
$longitude – Typ: int, Einheit: 1/1000000 °, Wertebereich: [0 bis 180000000]
$ew – Typ: char, Wertebereich: ['E', 'W']
$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]
$epe – Typ: int, Einheit: 1 cm, Wertebereich: [0 bis 2¹⁶ - 1]

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

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

BrickletGPS->CALLBACK_STATUS¶

Callback-Parameter:	$fix – Typ: int, Wertebereich: Siehe Konstanten $satellites_view – Typ: int, Wertebereich: [0 bis 255] $satellites_used – Typ: int, Wertebereich: [0 bis 255]

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

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->FIX_NO_FIX = 1
BrickletGPS->FIX_2D_FIX = 2
BrickletGPS->FIX_3D_FIX = 3

BrickletGPS->CALLBACK_ALTITUDE¶

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

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

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

BrickletGPS->CALLBACK_MOTION¶

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

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

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

BrickletGPS->CALLBACK_DATE_TIME¶

Callback-Parameter:	$date – Typ: int, Wertebereich: [10100 bis 311299] $time – Typ: int, Wertebereich: [0 bis 235959999]

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

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¶

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->get_api_version()¶

Rückgabe-Array:	0: @api_version – Typ: [int, ...], Länge: 3 0: $major – Typ: int, Wertebereich: [0 bis 255] 1: $minor – Typ: int, Wertebereich: [0 bis 255] 2: $revision – Typ: int, 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->get_response_expected($function_id)¶

Parameter:	$function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	$response_expected – Typ: bool

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 set_response_expected(). 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->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->set_response_expected($function_id, $response_expected)¶

Parameter:	$function_id – Typ: int, Wertebereich: Siehe Konstanten $response_expected – Typ: bool
Rückgabe:	undef

Ä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 $function_id:

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->set_response_expected_all($response_expected)¶

Parameter:	$response_expected – Typ: bool
Rückgabe:	undef

Ä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 get_identity() Funktion und der IPConnection->CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletGPS->DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines GPS Bricklet dar.