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

JavaScript - GPS Bricklet 3.0¶

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

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple (Node.js)¶

Download (ExampleSimple.js)

var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var gps = new Tinkerforge.BrickletGPSV3(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // Get current coordinates
        gps.getCoordinates(
            function (latitude, ns, longitude, ew) {
                console.log('Latitude: ' + latitude/1000000.0 + ' °');
                console.log('N/S: ' + ns);
                console.log('Longitude: ' + longitude/1000000.0 + ' °');
                console.log('E/W: ' + ew);
            },
            function (error) {
                console.log('Error: ' + error);
            }
        );
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Callback (Node.js)¶

Download (ExampleCallback.js)

var Tinkerforge = require('tinkerforge');

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

var ipcon = new Tinkerforge.IPConnection(); // Create IP connection
var gps = new Tinkerforge.BrickletGPSV3(UID, ipcon); // Create device object

ipcon.connect(HOST, PORT,
    function (error) {
        console.log('Error: ' + error);
    }
); // Connect to brickd
// Don't use device before ipcon is connected

ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
    function (connectReason) {
        // 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);
    }
);

// Register coordinates callback
gps.on(Tinkerforge.BrickletGPSV3.CALLBACK_COORDINATES,
    // Callback function for coordinates callback
    function (latitude, ns, longitude, ew) {
        console.log('Latitude: ' + latitude/1000000.0 + ' °');
        console.log('N/S: ' + ns);
        console.log('Longitude: ' + longitude/1000000.0 + ' °');
        console.log('E/W: ' + ew);
        console.log();
    }
);

console.log('Press key to exit');
process.stdin.on('data',
    function (data) {
        ipcon.disconnect();
        process.exit(0);
    }
);

Simple (HTML)¶

Download (ExampleSimple.html), Test (ExampleSimple.html)

<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>GPS Bricklet 3.0 Simple Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var gps = new Tinkerforge.BrickletGPSV3(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // Get current coordinates
                        gps.getCoordinates(
                            function (latitude, ns, longitude, ew) {
                                textArea.value += 'Latitude: ' + latitude/1000000.0 + ' °\n';
                                textArea.value += 'N/S: ' + ns + '\n';
                                textArea.value += 'Longitude: ' + longitude/1000000.0 + ' °\n';
                                textArea.value += 'E/W: ' + ew + '\n';
                            },
                            function (error) {
                                textArea.value += 'Error: ' + error + '\n';
                            }
                        );
                    }
                );
            }
        </script>
    </body>
</html>

Callback (HTML)¶

Download (ExampleCallback.html), Test (ExampleCallback.html)

<!DOCTYPE html>
<html>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <head>
        <title>Tinkerforge | JavaScript Example</title>
    </head>
    <body>
        <div style="text-align:center;">
            <h1>GPS Bricklet 3.0 Callback Example</h1>
            <p>
                <input value="localhost" id="host" type="text" size="20">:
                <input value="4280" id="port" type="text" size="5">,
                <input value="uid" id="uid" type="text" size="5">
                <input value="Start Example" id="start" type="button" onclick="startExample();">
            </p>
            <p>
                <textarea readonly id="text" cols="80" rows="24" style="resize:none;"
                          >Press "Start Example" to begin ...</textarea>
            </p>
        </div>
        <script src="./Tinkerforge.js" type='text/javascript'></script>
        <script type='text/javascript'>
            var ipcon;
            var textArea = document.getElementById("text");
            function startExample() {
                textArea.value = "";
                var HOST = document.getElementById("host").value;
                var PORT = parseInt(document.getElementById("port").value);
                var UID = document.getElementById("uid").value;
                if(ipcon !== undefined) {
                    ipcon.disconnect();
                }
                ipcon = new Tinkerforge.IPConnection(); // Create IP connection
                var gps = new Tinkerforge.BrickletGPSV3(UID, ipcon); // Create device object
                ipcon.connect(HOST, PORT,
                    function(error) {
                        textArea.value += 'Error: ' + error + '\n';
                    }
                ); // Connect to brickd
                // Don't use device before ipcon is connected

                ipcon.on(Tinkerforge.IPConnection.CALLBACK_CONNECTED,
                    function (connectReason) {
                        // 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);
                    }
                );

                // Register coordinates callback
                gps.on(Tinkerforge.BrickletGPSV3.CALLBACK_COORDINATES,
                    // Callback function for coordinates callback
                    function (latitude, ns, longitude, ew) {
                        textArea.value += 'Latitude: ' + latitude/1000000.0 + ' °\n';
                        textArea.value += 'N/S: ' + ns + '\n';
                        textArea.value += 'Longitude: ' + longitude/1000000.0 + ' °\n';
                        textArea.value += 'E/W: ' + ew + '\n';
                        textArea.value += '\n';
                        textArea.scrollTop = textArea.scrollHeight;
                    }
                );
            }
        </script>
    </body>
</html>

API¶

Allgemein kann jede Funktion der JavaScript Bindings zwei optionale Parameter haben, returnCallback und errorCallback. Dies sind benutzerdefinierte Callback-Funktionen. Die returnCallback-Funktion wird mit dem Ergebnissen der Funktion als Argumente aufgerufen, falls die Funktion ihre Ergebnisse asynchron zurückgibt. Die errorCallback-Funktion wird im Fehlerfall mit einem Fehlercode aufgerufen. Der Fehlercode kann einer der folgenden Werte sein:

IPConnection.ERROR_ALREADY_CONNECTED = 11
IPConnection.ERROR_NOT_CONNECTED = 12
IPConnection.ERROR_CONNECT_FAILED = 13
IPConnection.ERROR_INVALID_FUNCTION_ID = 21
IPConnection.ERROR_TIMEOUT = 31
IPConnection.ERROR_INVALID_PARAMETER = 41
IPConnection.ERROR_FUNCTION_NOT_SUPPORTED = 42
IPConnection.ERROR_UNKNOWN_ERROR = 43
IPConnection.ERROR_STREAM_OUT_OF_SYNC = 51
IPConnection.ERROR_NON_ASCII_CHAR_IN_SECRET = 71
IPConnection.ERROR_WRONG_DEVICE_TYPE = 81
IPConnection.ERROR_DEVICE_REPLACED = 82
IPConnection.ERROR_WRONG_RESPONSE_LENGTH = 83
IPConnection.ERROR_INT64_NOT_SUPPORTED = 91

Der Namespace der JavaScript Bindings ist Tinkerforge.*.

Grundfunktionen¶

new BrickletGPSV3(uid, ipcon)¶

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

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

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

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

BrickletGPSV3.getCoordinates([returnCallback][, errorCallback])¶

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']
Rückgabe:	undefined

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.getStatus([returnCallback][, errorCallback])¶

Callback-Parameter:	hasFix – Typ: boolean satellitesView – Typ: int, Wertebereich: [0 bis 255]
Rückgabe:	undefined

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.getAltitude([returnCallback][, errorCallback])¶

Callback-Parameter:	altitude – Typ: int, Einheit: 1 cm, Wertebereich: [-2³¹ bis 2³¹ - 1] geoidalSeparation – Typ: int, Einheit: 1 cm, Wertebereich: [-2³¹ bis 2³¹ - 1]
Rückgabe:	undefined

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.getMotion([returnCallback][, errorCallback])¶

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]
Rückgabe:	undefined

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.getDateTime([returnCallback][, errorCallback])¶

Callback-Parameter:	date – Typ: int, Wertebereich: [10100 bis 311299] time – Typ: int, Wertebereich: [0 bis 235959999]
Rückgabe:	undefined

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.getSatelliteSystemStatus(satelliteSystem[, returnCallback][, errorCallback])¶

Parameter:	satelliteSystem – Typ: int, Wertebereich: Siehe Konstanten
Callback-Parameter:	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]
Rückgabe:	undefined

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 satellite_system:

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.getSatelliteStatus(satelliteSystem, satelliteNumber[, returnCallback][, errorCallback])¶

Parameter:	satelliteSystem – Typ: int, Wertebereich: Siehe Konstanten satelliteNumber – Typ: int, Wertebereich: [1 bis 32]
Callback-Parameter:	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]
Rückgabe:	undefined

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 satellite_system:

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

Fortgeschrittene Funktionen¶

BrickletGPSV3.restart(restartType[, returnCallback][, errorCallback])¶

Parameter:	restartType – Typ: int, Wertebereich: Siehe Konstanten
Callback-Parameter:	undefined
Rückgabe:	undefined

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:

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

BrickletGPSV3.setFixLEDConfig(config[, returnCallback][, errorCallback])¶

Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
Callback-Parameter:	undefined
Rückgabe:	undefined

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

BrickletGPSV3.getFixLEDConfig([returnCallback][, errorCallback])¶

Callback-Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	undefined

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

BrickletGPSV3.setSBASConfig(sbasConfig[, returnCallback][, errorCallback])¶

Parameter:	sbasConfig – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
Callback-Parameter:	undefined
Rückgabe:	undefined

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 sbas_config:

BrickletGPSV3.SBAS_ENABLED = 0
BrickletGPSV3.SBAS_DISABLED = 1

BrickletGPSV3.getSBASConfig([returnCallback][, errorCallback])¶

Callback-Parameter:	sbasConfig – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	undefined

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

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

Für sbas_config:

BrickletGPSV3.SBAS_ENABLED = 0
BrickletGPSV3.SBAS_DISABLED = 1

BrickletGPSV3.getSPITFPErrorCount([returnCallback][, errorCallback])¶

Callback-Parameter:	errorCountAckChecksum – Typ: int, Wertebereich: [0 bis 2³² - 1] errorCountMessageChecksum – Typ: int, Wertebereich: [0 bis 2³² - 1] errorCountFrame – Typ: int, Wertebereich: [0 bis 2³² - 1] errorCountOverflow – Typ: int, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	undefined

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.

BrickletGPSV3.setStatusLEDConfig(config[, returnCallback][, errorCallback])¶

Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
Callback-Parameter:	undefined
Rückgabe:	undefined

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

BrickletGPSV3.getStatusLEDConfig([returnCallback][, errorCallback])¶

Callback-Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	undefined

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

BrickletGPSV3.getChipTemperature([returnCallback][, errorCallback])¶

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

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.

BrickletGPSV3.reset([returnCallback][, errorCallback])¶

Callback-Parameter:	undefined
Rückgabe:	undefined

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.getIdentity([returnCallback][, errorCallback])¶

Callback-Parameter:

Callback-Parameter:	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: [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] firmwareVersion – 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] deviceIdentifier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	undefined

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: [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]

firmwareVersion – 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]

deviceIdentifier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Rückgabe:

undefined

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 Callbacks¶

BrickletGPSV3.on(callback_id, function[, errorCallback])¶

Parameter:	callback_id – Typ: int function – Typ: function
Rückgabe:	undefined

Registriert die function für die gegebene callback_id.

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

BrickletGPSV3.setCoordinatesCallbackPeriod(period[, returnCallback][, errorCallback])¶

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

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.

BrickletGPSV3.getCoordinatesCallbackPeriod([returnCallback][, errorCallback])¶

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

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

BrickletGPSV3.setStatusCallbackPeriod(period[, returnCallback][, errorCallback])¶

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

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.

BrickletGPSV3.getStatusCallbackPeriod([returnCallback][, errorCallback])¶

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

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

BrickletGPSV3.setAltitudeCallbackPeriod(period[, returnCallback][, errorCallback])¶

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

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.

BrickletGPSV3.getAltitudeCallbackPeriod([returnCallback][, errorCallback])¶

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

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

BrickletGPSV3.setMotionCallbackPeriod(period[, returnCallback][, errorCallback])¶

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

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.

BrickletGPSV3.getMotionCallbackPeriod([returnCallback][, errorCallback])¶

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

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

BrickletGPSV3.setDateTimeCallbackPeriod(period[, returnCallback][, errorCallback])¶

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

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.

BrickletGPSV3.getDateTimeCallbackPeriod([returnCallback][, errorCallback])¶

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

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 kann mit der Funktion on() des Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID und der zweite Parameter die Callback-Funktion:

gpsV3.on(BrickletGPSV3.CALLBACK_EXAMPLE,
    function (param) {
        console.log(param);
    }
);

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.

BrickletGPSV3.CALLBACK_PULSE_PER_SECOND¶

Callback-Parameter:	undefined

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

BrickletGPSV3.CALLBACK_COORDINATES¶

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']

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

BrickletGPSV3.CALLBACK_STATUS¶

Callback-Parameter:	hasFix – Typ: boolean satellitesView – Typ: int, 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 CALLBACK_STATUS Callback wird nur ausgelöst, wenn sich der Status seit der letzten Auslösung geändert hat.

BrickletGPSV3.CALLBACK_ALTITUDE¶

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

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

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

BrickletGPSV3.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 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¶

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.

BrickletGPSV3.getAPIVersion()¶

Rückgabe:	apiVersion – 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.

BrickletGPSV3.getResponseExpected(functionId[, errorCallback])¶

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

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

BrickletGPSV3.setResponseExpected(functionId, responseExpected[, errorCallback])¶

Parameter:	functionId – Typ: int, Wertebereich: Siehe Konstanten responseExpected – Typ: boolean
Rückgabe:	undefined

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

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

BrickletGPSV3.setResponseExpectedAll(responseExpected)¶

Parameter:	responseExpected – Typ: boolean
Rückgabe:	undefined

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

BrickletGPSV3.setBootloaderMode(mode[, returnCallback][, errorCallback])¶

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

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

BrickletGPSV3.getBootloaderMode([returnCallback][, errorCallback])¶

Callback-Parameter:	mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	undefined

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

BrickletGPSV3.setWriteFirmwarePointer(pointer[, returnCallback][, errorCallback])¶

Parameter:	pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Callback-Parameter:	undefined
Rückgabe:	undefined

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.

BrickletGPSV3.writeFirmware(data[, returnCallback][, errorCallback])¶

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

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.

BrickletGPSV3.writeUID(uid[, returnCallback][, errorCallback])¶

Parameter:	uid – Typ: int, Wertebereich: [0 bis 2³² - 1]
Callback-Parameter:	undefined
Rückgabe:	undefined

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.

BrickletGPSV3.readUID([returnCallback][, errorCallback])¶

Callback-Parameter:	uid – Typ: int, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	undefined

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

Konstanten¶

BrickletGPSV3.DEVICE_IDENTIFIER¶

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

Die getIdentity() Funktion und der IPConnection.CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

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