Ruby - GPS Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example_simple.rb)

 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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_gps'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
gps = 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 as [latitude, ns, longitude, ew, pdop, hdop, vdop, epe]
coordinates = gps.get_coordinates

puts "Latitude: #{coordinates[0]/1000000.0} °"
puts "N/S: #{coordinates[1]}"
puts "Longitude: #{coordinates[2]/1000000.0} °"
puts "E/W: #{coordinates[3]}"

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Callback

Download (example_callback.rb)

 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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_gps'

include Tinkerforge

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

ipcon = IPConnection.new # Create IP connection
gps = 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
gps.register_callback(BrickletGPS::CALLBACK_COORDINATES) do |latitude, ns, longitude, ew,
                                                             pdop, hdop, vdop, epe|
  puts "Latitude: #{latitude/1000000.0} °"
  puts "N/S: #{ns}"
  puts "Longitude: #{longitude/1000000.0} °"
  puts "E/W: #{ew}"
  puts ''
end

# 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

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

API

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

BrickletGPS::new(uid, ipcon) → gps
Parameter:
  • uid – Typ: str
  • 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 → [int, chr, int, chr, int, int, int, int]
Rückgabe-Array:
  • 0: latitude – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 1: ns – Typ: chr
  • 2: longitude – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 3: ew – Typ: chr
  • 4: pdop – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 5: hdop – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 6: vdop – Typ: int, Wertebereich: [0 bis 216 - 1]
  • 7: epe – Typ: int, 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". 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 #get_status).

BrickletGPS#get_status → [int, int, int]
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 → [int, int]
Rückgabe-Array:
  • 0: altitude – Typ: int, Wertebereich: [-231 bis 231 - 1]
  • 1: geoidal_separation – Typ: int, Wertebereich: [-231 bis 231 - 1]

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

BrickletGPS#get_motion → [int, int]
Rückgabe-Array:
  • 0: course – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 1: speed – Typ: int, Wertebereich: [0 bis 232 - 1]

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

BrickletGPS#get_date_time → [int, int]
Rückgabe-Array:
  • 0: date – Typ: int, Wertebereich: [0 bis 232 - 1]
  • 1: time – Typ: int, Wertebereich: [0 bis 232 - 1]

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) → nil
Parameter:
  • restart_type – Typ: int, 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 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_api_version → [int, ...]
Rückgabe:
  • api_version – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]

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.

BrickletGPS#get_response_expected(function_id) → bool
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) → nil
Parameter:
  • function_id – Typ: int, Wertebereich: Siehe Konstanten
  • response_expected – Typ: 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 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) → nil
Parameter:
  • response_expected – Typ: bool

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

BrickletGPS#get_identity → [str, str, chr, [int, ...], [int, ...], int]
Rückgabe-Array:
  • 0: uid – Typ: str, Länge: bis zu 8
  • 1: connected_uid – Typ: str, Länge: bis zu 8
  • 2: position – Typ: chr
  • 3: hardware_version – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]
  • 4: firmware_version – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]
  • 5: device_identifier – 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 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

BrickletGPS#register_callback(callback_id) { |param [, ...]| block } → nil
Parameter:
  • callback_id – Typ: int

Registriert den block 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) → nil
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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 → int
Rückgabe:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

BrickletGPS#set_status_callback_period(period) → nil
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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 → int
Rückgabe:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

BrickletGPS#set_altitude_callback_period(period) → nil
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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 → int
Rückgabe:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

BrickletGPS#set_motion_callback_period(period) → nil
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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 → int
Rückgabe:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

BrickletGPS#set_date_time_callback_period(period) → nil
Parameter:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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 → int
Rückgabe:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 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 der Callback ID und der zweite Parameter der Block:

gps.register_callback BrickletGPS::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

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:
  • latitude – Typ: int, Wertebereich: [0 bis 232 - 1]
  • ns – Typ: chr
  • longitude – Typ: int, Wertebereich: [0 bis 232 - 1]
  • ew – Typ: chr
  • pdop – Typ: int, Wertebereich: [0 bis 216 - 1]
  • hdop – Typ: int, Wertebereich: [0 bis 216 - 1]
  • vdop – Typ: int, Wertebereich: [0 bis 216 - 1]
  • epe – Typ: int, Wertebereich: [0 bis 216 - 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, Wertebereich: [-231 bis 231 - 1]
  • geoidal_separation – Typ: int, Wertebereich: [-231 bis 231 - 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, Wertebereich: [0 bis 232 - 1]
  • speed – Typ: int, Wertebereich: [0 bis 232 - 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: [0 bis 232 - 1]
  • time – Typ: int, Wertebereich: [0 bis 232 - 1]

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.

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.