Rust - GPS Bricklet

Dies ist die Beschreibung der Rust 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 Rust API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf docs.rs.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example_simple.rs)

 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
use std::{error::Error, io};

use tinkerforge::{gps_bricklet::*, ip_connection::IpConnection};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your GPS Bricklet.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let gps = GpsBricklet::new(UID, &ipcon); // Create device object.

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

    // Get current coordinates.
    let coordinates = gps.get_coordinates().recv()?;

    println!("Latitude: {} °", coordinates.latitude as f32 / 1000000.0);
    println!("N/S: {}", coordinates.ns);
    println!("Longitude: {} °", coordinates.longitude as f32 / 1000000.0);
    println!("E/W: {}", coordinates.ew);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

Callback

Download (example_callback.rs)

 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
use std::{error::Error, io, thread};
use tinkerforge::{gps_bricklet::*, ip_connection::IpConnection};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your GPS Bricklet.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let gps = GpsBricklet::new(UID, &ipcon); // Create device object.

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

    let coordinates_receiver = gps.get_coordinates_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `gps` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for coordinates in coordinates_receiver {
            println!("Latitude: {} °", coordinates.latitude as f32 / 1000000.0);
            println!("N/S: {}", coordinates.ns);
            println!("Longitude: {} °", coordinates.longitude as f32 / 1000000.0);
            println!("E/W: {}", coordinates.ew);
            println!();
        }
    });

    // Set period for coordinates receiver 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);

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

API

Um eine nicht-blockierende Verwendung zu erlauben, gibt fast jede Funktion der Rust-Bindings einen Wrapper um einen mpsc::Receiver zurück. Um das Ergebnis eines Funktionsaufrufs zu erhalten und zu blockieren, bis das Gerät die Anfrage verarbeitet hat, können die recv-Varianten des Receivers verwendet werden. Diese geben entweder das vom Gerät gesendete Ergebnis, oder einen aufgetretenen Fehler zurück.

Funktionen die direkt ein Result zurückgeben, blockieren bis das Gerät die Anfrage verarbeitet hat.

Alle folgend aufgelisteten Funktionen sind Thread-sicher, diese, die einen Receiver zurückgeben, sind Lock-frei.

Grundfunktionen

pub fn GpsBricklet::new(uid: &str, ip_connection: &IpConnection) → GpsBricklet

Erzeugt ein neues GpsBricklet-Objekt mit der eindeutigen Geräte ID uid und fügt es der IP-Connection ipcon hinzu:

Dieses Geräteobjekt kann benutzt werden, nachdem die IP-Connection verbunden wurde (siehe Beispiele oben).

pub fn GpsBricklet::get_coordinates(&self) → ConvertingReceiver<Coordinates>

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". Der EPE wird in cm gegeben. 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 GpsBricklet::get_status).

pub fn GpsBricklet::get_status(&self) → ConvertingReceiver<Status>

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, GpsBricklet::get_coordinates, GpsBricklet::get_altitude und GpsBricklet::get_motion geben ungültige Daten zurück
2 2D Fix, nur GpsBricklet::get_coordinates und GpsBricklet::get_motion geben gültige Daten zurück
3 3D Fix, GpsBricklet::get_coordinates, GpsBricklet::get_altitude und GpsBricklet::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:

  • GPS_BRICKLET_FIX_NO_FIX = 1
  • GPS_BRICKLET_FIX_2D_FIX = 2
  • GPS_BRICKLET_FIX_3D_FIX = 3
pub fn GpsBricklet::get_altitude(&self) → ConvertingReceiver<Altitude>

Gibt die aktuelle Höhe und die dazu gehörige "Geoidal Separation" zurück.

Beide Werte werden in cm angegeben.

Diese Daten sind nur gültig wenn ein Fix vorhanden ist (siehe GpsBricklet::get_status).

pub fn GpsBricklet::get_motion(&self) → ConvertingReceiver<Motion>

Gibt die aktuelle Richtung und Geschwindigkeit zurück. Die Richtung wird in hundertstel Grad und die Geschwindigkeit in hundertstel km/h angegeben. 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 GpsBricklet::get_status).

pub fn GpsBricklet::get_date_time(&self) → ConvertingReceiver<DateTime>

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.05.13 als Datum und 195923568 bedeutet 19:59:23.568 als Zeit.

Fortgeschrittene Funktionen

pub fn GpsBricklet::restart(&self, restart_type: u8) → ConvertingReceiver<()>

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:

  • GPS_BRICKLET_RESTART_TYPE_HOT_START = 0
  • GPS_BRICKLET_RESTART_TYPE_WARM_START = 1
  • GPS_BRICKLET_RESTART_TYPE_COLD_START = 2
  • GPS_BRICKLET_RESTART_TYPE_FACTORY_RESET = 3
pub fn GpsBricklet::get_api_version(&self) → [u8; 3]

Gibt die Version der API Definition (Major, Minor, Revision) 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.

pub fn GpsBricklet::get_response_expected(&mut self, function_id: u8) → 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 GpsBricklet::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.

Siehe GpsBricklet::set_response_expected für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

pub fn GpsBricklet::set_response_expected(&mut self, function_id: u8, response_expected: bool) → ()

Ä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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • GPS_BRICKLET_FUNCTION_RESTART = 6
  • GPS_BRICKLET_FUNCTION_SET_COORDINATES_CALLBACK_PERIOD = 7
  • GPS_BRICKLET_FUNCTION_SET_STATUS_CALLBACK_PERIOD = 9
  • GPS_BRICKLET_FUNCTION_SET_ALTITUDE_CALLBACK_PERIOD = 11
  • GPS_BRICKLET_FUNCTION_SET_MOTION_CALLBACK_PERIOD = 13
  • GPS_BRICKLET_FUNCTION_SET_DATE_TIME_CALLBACK_PERIOD = 15
pub fn GpsBricklet::set_response_expected_all(&mut self, response_expected: bool) → ()

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

pub fn GpsBricklet::get_identity(&self) → ConvertingReceiver<Identity>

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 kann 'a', 'b', 'c' oder 'd' sein.

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

pub fn GpsBricklet::set_coordinates_callback_period(&self, period: u32) → ConvertingReceiver<()>

Setzt die Periode in ms mit welcher der GpsBricklet::get_coordinates_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der GpsBricklet::get_coordinates_callback_receiver Callback wird nur ausgelöst, wenn sich die Koordinaten seit der letzten Auslösung geändert haben.

Der Standardwert ist 0.

pub fn GpsBricklet::get_coordinates_callback_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von GpsBricklet::set_coordinates_callback_period gesetzt.

pub fn GpsBricklet::set_status_callback_period(&self, period: u32) → ConvertingReceiver<()>

Setzt die Periode in ms mit welcher der GpsBricklet::get_status_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der GpsBricklet::get_status_callback_receiver Callback wird nur ausgelöst, wenn sich der Status seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

pub fn GpsBricklet::get_status_callback_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von GpsBricklet::set_status_callback_period gesetzt.

pub fn GpsBricklet::set_altitude_callback_period(&self, period: u32) → ConvertingReceiver<()>

Setzt die Periode in ms mit welcher der GpsBricklet::get_altitude_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der GpsBricklet::get_altitude_callback_receiver Callback wird nur ausgelöst, wenn sich die Höhe seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

pub fn GpsBricklet::get_altitude_callback_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von GpsBricklet::set_altitude_callback_period gesetzt.

pub fn GpsBricklet::set_motion_callback_period(&self, period: u32) → ConvertingReceiver<()>

Setzt die Periode in ms mit welcher der GpsBricklet::get_motion_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der GpsBricklet::get_motion_callback_receiver Callback wird nur ausgelöst, wenn sich die Bewegung seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

pub fn GpsBricklet::get_motion_callback_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von GpsBricklet::set_motion_callback_period gesetzt.

pub fn GpsBricklet::set_date_time_callback_period(&self, period: u32) → ConvertingReceiver<()>

Setzt die Periode in ms mit welcher der GpsBricklet::get_date_time_callback_receiver Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der GpsBricklet::get_date_time_callback_receiver Callback wird nur ausgelöst, wenn sich das Datum oder die Zeit seit der letzten Auslösung geändert haben.

Der Standardwert ist 0.

pub fn GpsBricklet::get_date_time_callback_period(&self) → ConvertingReceiver<u32>

Gibt die Periode zurück, wie von GpsBricklet::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 entsprechenden get_*_callback_receiver-Function durchgeführt werden, welche einen Receiver für Callback-Events zurück gibt.

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.

pub fn GpsBricklet::get_coordinates_callback_receiver(&self) → ConvertingCallbackReceiver<CoordinatesEvent>

Receiver die mit dieser Funktion erstellt werden, empfangen Coordinates-Events.

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

Der GpsBricklet::get_coordinates_callback_receiver Callback wird nur ausgelöst, wenn sich die Koordinaten seit der letzten Auslösung geändert haben und ein Fix vorhanden ist (siehe GpsBricklet::get_status).

pub fn GpsBricklet::get_status_callback_receiver(&self) → ConvertingCallbackReceiver<StatusEvent>

Receiver die mit dieser Funktion erstellt werden, empfangen Status-Events.

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

Der GpsBricklet::get_status_callback_receiver 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:

  • GPS_BRICKLET_FIX_NO_FIX = 1
  • GPS_BRICKLET_FIX_2D_FIX = 2
  • GPS_BRICKLET_FIX_3D_FIX = 3
pub fn GpsBricklet::get_altitude_callback_receiver(&self) → ConvertingCallbackReceiver<AltitudeEvent>

Receiver die mit dieser Funktion erstellt werden, empfangen Altitude-Events.

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

Der GpsBricklet::get_altitude_callback_receiver Callback wird nur ausgelöst, wenn sich die Höhe seit der letzten Auslösung geändert hat und ein Fix vorhanden ist (siehe GpsBricklet::get_status).

pub fn GpsBricklet::get_motion_callback_receiver(&self) → ConvertingCallbackReceiver<MotionEvent>

Receiver die mit dieser Funktion erstellt werden, empfangen Motion-Events.

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

Der GpsBricklet::get_motion_callback_receiver Callback wird nur ausgelöst, wenn sich die Bewegung seit der letzten Auslösung geändert hat und ein Fix vorhanden ist (siehe GpsBricklet::get_status).

pub fn GpsBricklet::get_date_time_callback_receiver(&self) → ConvertingCallbackReceiver<DateTimeEvent>

Receiver die mit dieser Funktion erstellt werden, empfangen Date Time-Events.

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

Der GpsBricklet::get_date_time_callback_receiver Callback wird nur ausgelöst, wenn sich das Datum oder die Zeit seit der letzten Auslösung geändert haben.

Konstanten

GpsBricklet::DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein GPS Bricklet zu identifizieren.

Die GpsBricklet::get_identity Funktion und der IpConnection::get_enumerate_callback_receiver Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

GpsBricklet::DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines GPS Bricklet dar.