MATLAB/Octave - GPS Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple (MATLAB)

Download (matlab_example_simple.m)

 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
function matlab_example_simple()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletGPS;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your GPS Bricklet

    ipcon = IPConnection(); % Create IP connection
    gps = handle(BrickletGPS(UID, ipcon), 'CallbackProperties'); % Create device object

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

    % Get current coordinates
    coordinates = gps.getCoordinates();

    fprintf('Latitude: %g °\n', coordinates.latitude/1000000.0);
    fprintf('N/S: %s\n', coordinates.ns);
    fprintf('Longitude: %g °\n', coordinates.longitude/1000000.0);
    fprintf('E/W: %s\n', coordinates.ew);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

Callback (MATLAB)

Download (matlab_example_callback.m)

 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
function matlab_example_callback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletGPS;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your GPS Bricklet

    ipcon = IPConnection(); % Create IP connection
    gps = handle(BrickletGPS(UID, ipcon), 'CallbackProperties'); % 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
    set(gps, 'CoordinatesCallback', @(h, e) cb_coordinates(e));

    % 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);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for coordinates callback
function cb_coordinates(e)
    fprintf('Latitude: %g °\n', e.latitude/1000000.0);
    fprintf('N/S: %s\n', e.ns);
    fprintf('Longitude: %g °\n', e.longitude/1000000.0);
    fprintf('E/W: %s\n', e.ew);
    fprintf('\n');
end

Simple (Octave)

Download (octave_example_simple.m)

 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
function octave_example_simple()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your GPS Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    gps = javaObject("com.tinkerforge.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();

    fprintf("Latitude: %g °\n", java2int(coordinates.latitude)/1000000.0);
    fprintf("N/S: %s\n", coordinates.ns);
    fprintf("Longitude: %g °\n", java2int(coordinates.longitude)/1000000.0);
    fprintf("E/W: %s\n", coordinates.ew);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
end

Callback (Octave)

Download (octave_example_callback.m)

 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
41
function octave_example_callback()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your GPS Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    gps = javaObject("com.tinkerforge.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.addCoordinatesCallback(@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);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for coordinates callback
function cb_coordinates(e)
    fprintf("Latitude: %g °\n", java2int(e.latitude)/1000000.0);
    fprintf("N/S: %s\n", e.ns);
    fprintf("Longitude: %g °\n", java2int(e.longitude)/1000000.0);
    fprintf("E/W: %s\n", e.ew);
    fprintf("\n");
end

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
end

API

Prinzipiell kann jede Methode der MATLAB 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 die MATLAB Bindings auf Java basieren und 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 BrickletGPS(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • gps – Typ: BrickletGPS

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

In MATLAB:

import com.tinkerforge.BrickletGPS;

gps = BrickletGPS("YOUR_DEVICE_UID", ipcon);

In Octave:

gps = java_new("com.tinkerforge.BrickletGPS", "YOUR_DEVICE_UID", ipcon);

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

BrickletGPS.Coordinates BrickletGPS.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']
  • pdop – Typ: int, Einheit: 1/100, Wertebereich: [0 bis 216 - 1]
  • hdop – Typ: int, Einheit: 1/100, Wertebereich: [0 bis 216 - 1]
  • vdop – Typ: int, Einheit: 1/100, Wertebereich: [0 bis 216 - 1]
  • epe – Typ: int, 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.Status BrickletGPS.getStatus()
Rückgabeobjekt:
  • fix – Typ: short, Wertebereich: Siehe Konstanten
  • satellitesView – Typ: short, Wertebereich: [0 bis 255]
  • satellitesUsed – Typ: short, 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.Altitude BrickletGPS.getAltitude()
Rückgabeobjekt:
  • altitude – Typ: int, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1]
  • geoidalSeparation – Typ: int, 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.Motion BrickletGPS.getMotion()
Rückgabeobjekt:
  • course – Typ: long, Einheit: 1/100 °, Wertebereich: [0 bis 36000]
  • speed – Typ: long, 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.DateTime BrickletGPS.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.

Fortgeschrittene Funktionen

void BrickletGPS.restart(short restartType)
Parameter:
  • restartType – Typ: short, 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.Identity BrickletGPS.getIdentity()
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', 'i', 'z']
  • hardwareVersion – Typ: short[], Länge: 3
    • 1: major – Typ: short, Wertebereich: [0 bis 255]
    • 2: minor – Typ: short, Wertebereich: [0 bis 255]
    • 3: revision – Typ: short, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: short[], Länge: 3
    • 1: major – Typ: short, Wertebereich: [0 bis 255]
    • 2: minor – Typ: short, Wertebereich: [0 bis 255]
    • 3: revision – Typ: short, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: int, 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 '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

void BrickletGPS.setCoordinatesCallbackPeriod(long period)
Parameter:
  • period – Typ: long, 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.

long BrickletGPS.getCoordinatesCallbackPeriod()
Rückgabe:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

void BrickletGPS.setStatusCallbackPeriod(long period)
Parameter:
  • period – Typ: long, 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.

long BrickletGPS.getStatusCallbackPeriod()
Rückgabe:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

void BrickletGPS.setAltitudeCallbackPeriod(long period)
Parameter:
  • period – Typ: long, 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.

long BrickletGPS.getAltitudeCallbackPeriod()
Rückgabe:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

void BrickletGPS.setMotionCallbackPeriod(long period)
Parameter:
  • period – Typ: long, 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.

long BrickletGPS.getMotionCallbackPeriod()
Rückgabe:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

void BrickletGPS.setDateTimeCallbackPeriod(long period)
Parameter:
  • period – Typ: long, 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.

long BrickletGPS.getDateTimeCallbackPeriod()
Rückgabe:
  • period – Typ: long, 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 wird mit MATLABs "set" Funktion durchgeführt. Die Parameter sind ein Gerätobjekt, der Callback-Name und die Callback-Funktion. Hier ein Beispiel in MATLAB:

function my_callback(e)
    fprintf('Parameter: %s\n', e.param);
end

set(device, 'ExampleCallback', @(h, e) my_callback(e));

Die Octave Java Unterstützung unterscheidet sich hier von MATLAB, die "set" Funktion kann hier nicht verwendet werden. Die Registrierung wird in Octave mit "add*Callback" Funktionen des Gerätobjekts durchgeführt. Hier ein Beispiel in Octave:

function my_callback(e)
    fprintf("Parameter: %s\n", e.param);
end

device.addExampleCallback(@my_callback);

Es ist möglich mehrere Callback-Funktion hinzuzufügen und auch mit einem korrespondierenden "remove*Callback" wieder zu entfernen.

Die Parameter des Callbacks werden der Callback-Funktion als Felder der Struktur e übergeben. Diese ist von der java.util.EventObject Klasse abgeleitete. Die verfügbaren Callback-Namen mit den entsprechenden Strukturfeldern werden unterhalb 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.

callback BrickletGPS.CoordinatesCallback
Event-Objekt:
  • 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']
  • pdop – Typ: int, Einheit: 1/100, Wertebereich: [0 bis 216 - 1]
  • hdop – Typ: int, Einheit: 1/100, Wertebereich: [0 bis 216 - 1]
  • vdop – Typ: int, Einheit: 1/100, Wertebereich: [0 bis 216 - 1]
  • epe – Typ: int, 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()).

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addCoordinatesCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeCoordinatesCallback() wieder entfernt werden.

callback BrickletGPS.StatusCallback
Event-Objekt:
  • fix – Typ: short, Wertebereich: Siehe Konstanten
  • satellitesView – Typ: short, Wertebereich: [0 bis 255]
  • satellitesUsed – Typ: short, 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

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addStatusCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeStatusCallback() wieder entfernt werden.

callback BrickletGPS.AltitudeCallback
Event-Objekt:
  • altitude – Typ: int, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1]
  • geoidalSeparation – Typ: int, 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()).

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addAltitudeCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeAltitudeCallback() wieder entfernt werden.

callback BrickletGPS.MotionCallback
Event-Objekt:
  • course – Typ: long, Einheit: 1/100 °, Wertebereich: [0 bis 36000]
  • speed – Typ: long, 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()).

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addMotionCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeMotionCallback() wieder entfernt werden.

callback BrickletGPS.DateTimeCallback
Event-Objekt:
  • date – Typ: long, Wertebereich: [10100 bis 311299]
  • time – Typ: long, 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.

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addDateTimeCallback() eine Callback-Function hinzugefügt werde. Eine hinzugefügter Callback-Function kann mit removeDateTimeCallback() wieder entfernt werden.

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[] BrickletGPS.getAPIVersion()
Rückgabeobjekt:
  • apiVersion – Typ: short[], Länge: 3
    • 1: major – Typ: short, Wertebereich: [0 bis 255]
    • 2: minor – Typ: short, Wertebereich: [0 bis 255]
    • 3: 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 BrickletGPS.getResponseExpected(short functionId)
Parameter:
  • functionId – Typ: short, 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 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
void BrickletGPS.setResponseExpected(short functionId, boolean responseExpected)
Parameter:
  • functionId – Typ: short, 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
void BrickletGPS.setResponseExpectedAll(boolean responseExpected)
Parameter:
  • responseExpected – Typ: boolean

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

Konstanten

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

String BrickletGPS.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines GPS Bricklet dar.