Dies ist die Beschreibung der Shell 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 Shell 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 | #!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this
uid=XYZ # Change XYZ to the UID of your Barometer Bricklet
# Get current air pressure
tinkerforge call barometer-bricklet $uid get-air-pressure
# Get current altitude
tinkerforge call barometer-bricklet $uid get-altitude
|
Download (example-callback.sh)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | #!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this
uid=XYZ # Change XYZ to the UID of your Barometer Bricklet
# Handle incoming air pressure callbacks
tinkerforge dispatch barometer-bricklet $uid air-pressure &
# 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!
tinkerforge call barometer-bricklet $uid set-air-pressure-callback-period 1000
echo "Press key to exit"; read dummy
kill -- -$$ # Stop callback dispatch in background
|
Download (example-threshold.sh)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 | #!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this
uid=XYZ # Change XYZ to the UID of your Barometer Bricklet
# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
tinkerforge call barometer-bricklet $uid set-debounce-period 10000
# Handle incoming air pressure reached callbacks
tinkerforge dispatch barometer-bricklet $uid air-pressure-reached\
--execute "echo Air Pressure: {air_pressure}/1000 hPa. Enjoy the potentially good weather!" &
# Configure threshold for air pressure "greater than 1025 hPa"
tinkerforge call barometer-bricklet $uid set-air-pressure-callback-threshold threshold-option-greater 1025000 0
echo "Press key to exit"; read dummy
kill -- -$$ # Stop callback dispatch in background
|
Mögliche Exit Codes für alle tinkerforge
Befehle sind:
argparse
Modul fehltAllgemeine Optionen des call
und des dispatch
Befehls sind
hier zu finden. Im Folgenden wird die spezifische
Befehlsstruktur dargestellt.
call
barometer-bricklet
[<option>..] <uid> <function> [<argument>..]¶Parameter: |
|
---|
Der call
Befehl wird verwendet um eine Funktion des Barometer Bricklet aufzurufen. Der
Befehl kennt mehrere Optionen:
--help
zeigt Hilfe für den spezifischen call
Befehl an und endet dann--list-functions
zeigt eine Liste der bekannten Funktionen des Barometer Bricklet an
und endet danndispatch
barometer-bricklet
[<option>..] <uid> <callback>¶Parameter: |
|
---|
Der dispatch
Befehl wird verwendet um eingehende Callbacks des Barometer Bricklet
abzufertigen. Der Befehl kennt mehrere Optionen:
--help
zeigt Hilfe für den spezifischen dispatch
Befehl an und endet
dann--list-callbacks
zeigt eine Liste der bekannten Callbacks des Barometer Bricklet an
und endet dannbarometer-bricklet
<uid> <function>
[<option>..] [<argument>..]¶Parameter: |
|
---|
Abhängig von der Art der aufzurufenden <function>
kennt diese verschiedene
Optionen. Alle Funktionen kennen die folgenden Optionen:
--help
zeigt Hilfe für die spezifische <function>
an und endet dannGetter-Funktionen kennen zusätzlich die folgenden Optionen:
--execute <command>
Shell-Befehl der für jede eingehende Antwort
ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)Setter-Funktionen kennen zusätzlich die folgenden Optionen:
--expect-response
fragt Antwort an und wartet auf dieseMit der --expect-response
Option für Setter-Funktionen können Timeouts und
andere Fehlerfälle auch für Aufrufe von Setter-Funktionen detektiert werden.
Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn diese Option
für eine Setter-Funktion nicht angegeben ist, dann wird keine Antwort vom
Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht
detektiert werden können.
barometer-bricklet
<uid> <callback>
[<option>..]¶Parameter: |
|
---|
Der abzufertigende <callback>
kennt mehrere Optionen:
--help
zeigt Hilfe für den spezifische <callback>
an und endet dann--execute <command>
Shell-Befehlszeile der für jede eingehende Antwort
ausgeführt wird (siehe den Abschnitt über Ausgabeformatierung für Details)barometer-bricklet
<uid> get-air-pressure
¶Ausgabe: |
|
---|
Gibt den Luftdruck des Luftdrucksensors zurück.
Wenn der Luftdruck periodisch abgefragt werden soll, wird empfohlen
den air-pressure
Callback zu nutzen und die Periode mit
set-air-pressure-callback-period
vorzugeben.
barometer-bricklet
<uid> get-altitude
¶Ausgabe: |
|
---|
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
altitude
Callback zu nutzen und die Periode mit
set-altitude-callback-period
vorzugeben.
barometer-bricklet
<uid> set-reference-air-pressure
<air-pressure>¶Parameter: |
|
---|---|
Ausgabe: |
|
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.
barometer-bricklet
<uid> get-reference-air-pressure
¶Ausgabe: |
|
---|
Gibt den Referenzluftdruckwert zurück, wie von set-reference-air-pressure
gesetzt.
barometer-bricklet
<uid> get-chip-temperature
¶Ausgabe: |
|
---|
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.
barometer-bricklet
<uid> set-averaging
<moving-average-pressure> <average-pressure> <average-temperature>¶Parameter: |
|
---|---|
Ausgabe: |
|
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).
barometer-bricklet
<uid> get-averaging
¶Ausgabe: |
|
---|
Gibt die Averaging-Konfiguration zurück, wie von set-averaging
gesetzt.
Neu in Version 2.0.1 (Plugin).
barometer-bricklet
<uid> set-i2c-mode
<mode>¶Parameter: |
|
---|---|
Ausgabe: |
|
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 Symbole sind für diese Funktion verfügbar:
Für <mode>:
Neu in Version 2.0.3 (Plugin).
barometer-bricklet
<uid> get-i2c-mode
¶Ausgabe: |
|
---|
Gibt den I2C Modus zurück, wie von set-i2c-mode
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für mode:
Neu in Version 2.0.3 (Plugin).
barometer-bricklet
<uid> get-identity
¶Ausgabe: |
|
---|
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.
barometer-bricklet
<uid> set-air-pressure-callback-period
<period>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Periode mit welcher der air-pressure
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
Der air-pressure
Callback wird nur ausgelöst, wenn sich der Luftdruck
seit der letzten Auslösung geändert hat.
barometer-bricklet
<uid> get-air-pressure-callback-period
¶Ausgabe: |
|
---|
Gibt die Periode zurück, wie von set-air-pressure-callback-period
gesetzt.
barometer-bricklet
<uid> set-altitude-callback-period
<period>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Periode mit welcher der altitude
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der altitude
Callback wird nur ausgelöst, wenn sich Höhe seit der letzten
Auslösung geändert hat.
barometer-bricklet
<uid> get-altitude-callback-period
¶Ausgabe: |
|
---|
Gibt die Periode zurück, wie von set-altitude-callback-period
gesetzt.
barometer-bricklet
<uid> set-air-pressure-callback-threshold
<option> <min> <max>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt den Schwellwert für den 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 Symbole sind für diese Funktion verfügbar:
Für <option>:
barometer-bricklet
<uid> get-air-pressure-callback-threshold
¶Ausgabe: |
|
---|
Gibt den Schwellwert zurück, wie von set-air-pressure-callback-threshold
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für option:
barometer-bricklet
<uid> set-altitude-callback-threshold
<option> <min> <max>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt den Schwellwert für den 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 Symbole sind für diese Funktion verfügbar:
Für <option>:
barometer-bricklet
<uid> get-altitude-callback-threshold
¶Ausgabe: |
|
---|
Gibt den Schwellwert zurück, wie von set-altitude-callback-threshold
gesetzt.
Die folgenden Symbole sind für diese Funktion verfügbar:
Für option:
barometer-bricklet
<uid> set-debounce-period
<debounce>¶Parameter: |
|
---|---|
Ausgabe: |
|
Setzt die Periode mit welcher die Schwellwert Callbacks
ausgelöst werden, wenn die Schwellwerte
weiterhin erreicht bleiben.
barometer-bricklet
<uid> get-debounce-period
¶Ausgabe: |
|
---|
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:
tinkerforge dispatch barometer-bricklet <uid> example
Die verfügbaren Callbacks 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.
barometer-bricklet
<uid> air-pressure
¶Ausgabe: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
set-air-pressure-callback-period
, ausgelöst. Der Parameter ist
der Luftdruck des Luftdrucksensors.
Der air-pressure
Callback wird nur ausgelöst, wenn sich der Luftdruck
seit der letzten Auslösung geändert hat.
barometer-bricklet
<uid> altitude
¶Ausgabe: |
|
---|
Dieser Callback wird mit der Periode, wie gesetzt mit
set-altitude-callback-period
, ausgelöst. Der Parameter ist
die Höhe des Luftdrucksensors.
Der altitude
Callback wird nur ausgelöst, wenn sich die Höhe seit der
letzten Auslösung geändert hat.
barometer-bricklet
<uid> air-pressure-reached
¶Ausgabe: |
|
---|
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.
barometer-bricklet
<uid> altitude-reached
¶Ausgabe: |
|
---|
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.