Dies ist die Beschreibung der Ruby API Bindings für das Barometer Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Barometer Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die Ruby API Bindings ist Teil deren allgemeine Beschreibung.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
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_barometer'
include Tinkerforge
HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Barometer Bricklet
ipcon = IPConnection.new # Create IP connection
b = BrickletBarometer.new UID, ipcon # Create device object
ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected
# Get current air pressure
air_pressure = b.get_air_pressure
puts "Air Pressure: #{air_pressure/1000.0} hPa"
# Get current altitude
altitude = b.get_altitude
puts "Altitude: #{altitude/100.0} m"
puts 'Press key to exit'
$stdin.gets
ipcon.disconnect
|
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 | #!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-
require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_barometer'
include Tinkerforge
HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Barometer Bricklet
ipcon = IPConnection.new # Create IP connection
b = BrickletBarometer.new UID, ipcon # Create device object
ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected
# Register air pressure callback
b.register_callback(BrickletBarometer::CALLBACK_AIR_PRESSURE) do |air_pressure|
puts "Air Pressure: #{air_pressure/1000.0} hPa"
end
# Set period for air pressure callback to 1s (1000ms)
# Note: The air pressure callback is only called every second
# if the air pressure has changed since the last call!
b.set_air_pressure_callback_period 1000
puts 'Press key to exit'
$stdin.gets
ipcon.disconnect
|
Download (example_threshold.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 | #!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-
require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_barometer'
include Tinkerforge
HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Barometer Bricklet
ipcon = IPConnection.new # Create IP connection
b = BrickletBarometer.new UID, ipcon # Create device object
ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected
# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
b.set_debounce_period 10000
# Register air pressure reached callback
b.register_callback(BrickletBarometer::CALLBACK_AIR_PRESSURE_REACHED) do |air_pressure|
puts "Air Pressure: #{air_pressure/1000.0} hPa"
puts 'Enjoy the potentially good weather!'
end
# Configure threshold for air pressure "greater than 1025 hPa"
b.set_air_pressure_callback_threshold '>', 1025*1000, 0
puts 'Press key to exit'
$stdin.gets
ipcon.disconnect
|
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
BrickletBarometer
::
new
(uid, ipcon) → barometer¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein Objekt mit der eindeutigen Geräte ID uid
:
barometer = BrickletBarometer.new 'YOUR_DEVICE_UID', ipcon
Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.
BrickletBarometer
#
get_air_pressure
→ int¶Rückgabe: |
|
---|
Gibt den Luftdruck des Luftdrucksensors zurück.
Wenn der Luftdruck periodisch abgefragt werden soll, wird empfohlen
den ::CALLBACK_AIR_PRESSURE
Callback zu nutzen und die Periode mit
#set_air_pressure_callback_period
vorzugeben.
BrickletBarometer
#
get_altitude
→ int¶Rückgabe: |
|
---|
Gibt die relative Höhe des Luftdrucksensors zurück. Der Wert wird
auf Basis der Differenz zwischen dem aktuellen Luftdruck und dem
Referenzluftdruck berechnet, welcher mit #set_reference_air_pressure
gesetzt werden kann.
Wenn die Höhe periodisch abgefragt werden soll, wird empfohlen den
::CALLBACK_ALTITUDE
Callback zu nutzen und die Periode mit
#set_altitude_callback_period
vorzugeben.
BrickletBarometer
#
set_reference_air_pressure
(air_pressure) → nil¶Parameter: |
|
---|
Setzt den Referenzluftdruck für die Höhenberechnung. Wenn der aktuelle Luftdruckwert als Referenz übergeben wird dann gibt die Höhenberechnung 0cm aus. Als Abkürzung kann auch 0 übergeben werden, dadurch wird der Referenzluftdruck intern auf den aktuellen Luftdruckwert gesetzt.
Wohl bekannte Referenzluftdruckwerte, die in der Luftfahrt verwendet werden, sind QNH und QFE aus dem Q-Schlüssel.
BrickletBarometer
#
get_reference_air_pressure
→ int¶Rückgabe: |
|
---|
Gibt den Referenzluftdruckwert zurück, wie von #set_reference_air_pressure
gesetzt.
BrickletBarometer
#
get_chip_temperature
→ int¶Rückgabe: |
|
---|
Gibt die Temperatur des Luftdrucksensors zurück.
Diese Temperatur wird intern zur Temperaturkompensation der Luftdruckmessung verwendet. Sie ist nicht so genau wie die Temperatur die vom Temperature Bricklet oder dem Temperature IR Bricklet gemessen wird.
BrickletBarometer
#
set_averaging
(moving_average_pressure, average_pressure, average_temperature) → nil¶Parameter: |
|
---|
Setzt die unterschiedlichen Averaging-Parameter (Mittelwertbildung). Es ist möglich die Länge des Mittelwerts für Temperatur und Luftdruck anzugeben. Zusätzlich gibt kann die Länge für einen gleitenden Mittelwert für den Luftdruck angegeben werden. Der gleitende Mittelwert wird mit den Werten des normalen Mittelwerts berechnet. Es gibt keinen gleitenden Mittelwert für die Temperatur.
Wenn alle drei Parameter auf 0 gesetzt werden, ist das Averaging komplett aus. In diesem Fall gibt es viel Rauschen auf den Daten, allerdings sind die Daten dann ohne Verzögerung. Wir empfehlen das Averaging auszustellen wenn die Daten des Barometer Bricklets zusammen mit anderen Sensordaten fusioniert werden sollen.
Neu in Version 2.0.1 (Plugin).
BrickletBarometer
#
get_averaging
→ [int, int, int]¶Rückgabe-Array: |
|
---|
Gibt die Averaging-Konfiguration zurück, wie von #set_averaging
gesetzt.
Neu in Version 2.0.1 (Plugin).
BrickletBarometer
#
set_i2c_mode
(mode) → nil¶Parameter: |
|
---|
Setzt den I2C Modus. Mögliche Modi sind:
Wenn Probleme mit offensichtlichen Ausreißern in den Barometer Bricklet Messungen auftreten, können diese eventuell aufgrund von elektromagnetischen Störungen sein. In diesem Fall kann es helfen die I2C Geschwindigkeit zu verringern.
Falls in einem System ein hoher Durchsatz an Nachrichten erwünscht ist, sollte die I2C Geschwindigkeit allerdings nicht verringert werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
Neu in Version 2.0.3 (Plugin).
BrickletBarometer
#
get_i2c_mode
→ int¶Rückgabe: |
|
---|
Gibt den I2C Modus zurück, wie von #set_i2c_mode
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
Neu in Version 2.0.3 (Plugin).
BrickletBarometer
#
get_identity
→ [str, str, chr, [int, ...], [int, ...], int]¶Rückgabe-Array: |
|
---|
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.
BrickletBarometer
#
register_callback
(callback_id) { |param [, ...]| block } → nil¶Parameter: |
|
---|
Registriert den block
für die gegebene callback_id
.
Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.
BrickletBarometer
#
set_air_pressure_callback_period
(period) → nil¶Parameter: |
|
---|
Setzt die Periode mit welcher der ::CALLBACK_AIR_PRESSURE
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
Der ::CALLBACK_AIR_PRESSURE
Callback wird nur ausgelöst, wenn sich der Luftdruck
seit der letzten Auslösung geändert hat.
BrickletBarometer
#
get_air_pressure_callback_period
→ int¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von #set_air_pressure_callback_period
gesetzt.
BrickletBarometer
#
set_altitude_callback_period
(period) → nil¶Parameter: |
|
---|
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 Höhe seit der letzten
Auslösung geändert hat.
BrickletBarometer
#
get_altitude_callback_period
→ int¶Rückgabe: |
|
---|
Gibt die Periode zurück, wie von #set_altitude_callback_period
gesetzt.
BrickletBarometer
#
set_air_pressure_callback_threshold
(option, min, max) → nil¶Parameter: |
|
---|
Setzt den Schwellwert für den ::CALLBACK_AIR_PRESSURE_REACHED
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn der Luftdruck außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn der Luftdruck innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn der Luftdruck kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn der Luftdruck größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletBarometer
#
get_air_pressure_callback_threshold
→ [chr, int, int]¶Rückgabe-Array: |
|
---|
Gibt den Schwellwert zurück, wie von #set_air_pressure_callback_threshold
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletBarometer
#
set_altitude_callback_threshold
(option, min, max) → nil¶Parameter: |
|
---|
Setzt den Schwellwert für den ::CALLBACK_ALTITUDE_REACHED
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Callback ist inaktiv |
'o' | Callback wird ausgelöst, wenn die Höhe außerhalb des min und max Wertes ist |
'i' | Callback wird ausgelöst, wenn die Höhe innerhalb des min und max Wertes ist |
'<' | Callback wird ausgelöst, wenn die Höhe kleiner als der min Wert ist (max wird ignoriert) |
'>' | Callback wird ausgelöst, wenn die Höhe größer als der min Wert ist (max wird ignoriert) |
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletBarometer
#
get_altitude_callback_threshold
→ [chr, int, int]¶Rückgabe-Array: |
|
---|
Gibt den Schwellwert zurück, wie von #set_altitude_callback_threshold
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für option:
BrickletBarometer
#
set_debounce_period
(debounce) → nil¶Parameter: |
|
---|
Setzt die Periode mit welcher die Schwellwert Callbacks
ausgelöst werden, wenn die Schwellwerte
weiterhin erreicht bleiben.
BrickletBarometer
#
get_debounce_period
→ int¶Rückgabe: |
|
---|
Gibt die Entprellperiode zurück, wie von #set_debounce_period
gesetzt.
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:
barometer.register_callback BrickletBarometer::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.
BrickletBarometer
::
CALLBACK_AIR_PRESSURE
¶Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
#set_air_pressure_callback_period
, ausgelöst. Der Parameter ist
der Luftdruck des Luftdrucksensors.
Der ::CALLBACK_AIR_PRESSURE
Callback wird nur ausgelöst, wenn sich der Luftdruck
seit der letzten Auslösung geändert hat.
BrickletBarometer
::
CALLBACK_ALTITUDE
¶Callback-Parameter: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
#set_altitude_callback_period
, ausgelöst. Der Parameter ist
die Höhe des Luftdrucksensors.
Der ::CALLBACK_ALTITUDE
Callback wird nur ausgelöst, wenn sich die Höhe seit der
letzten Auslösung geändert hat.
BrickletBarometer
::
CALLBACK_AIR_PRESSURE_REACHED
¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
#set_air_pressure_callback_threshold
gesetzt, erreicht wird.
Der Parameter ist der Luftdruck des Luftdrucksensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit #set_debounce_period
gesetzt, ausgelöst.
BrickletBarometer
::
CALLBACK_ALTITUDE_REACHED
¶Callback-Parameter: |
|
---|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
#set_altitude_callback_threshold
gesetzt, erreicht wird.
Der Parameter ist die Höhe des Luftdrucksensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit #set_debounce_period
gesetzt, ausgelöst.
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.
BrickletBarometer
#
get_api_version
→ [int, ...]¶Rückgabe-Array: |
|
---|
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.
BrickletBarometer
#
get_response_expected
(function_id) → bool¶Parameter: |
|
---|---|
Rückgabe: |
|
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:
BrickletBarometer
#
set_response_expected
(function_id, response_expected) → nil¶Parameter: |
|
---|
Ä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:
BrickletBarometer
#
set_response_expected_all
(response_expected) → nil¶Parameter: |
|
---|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
BrickletBarometer
::
DEVICE_IDENTIFIER
¶Diese Konstante wird verwendet um ein Barometer 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.
BrickletBarometer
::
DEVICE_DISPLAY_NAME
¶Diese Konstante stellt den Anzeigenamen eines Barometer Bricklet dar.