Shell - Barometer Bricklet

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.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example-simple.sh)

 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

Callback

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

Threshold

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

API

Mögliche Exit Codes für alle tinkerforge Befehle sind:

  • 1: Unterbrochen (Ctrl+C)
  • 2: Syntaxfehler
  • 21: Python 2.5 oder neuer wird benötigt
  • 22: Python argparse Modul fehlt
  • 23: Socket-Fehler
  • 24: Andere Exception
  • 25: Ungültiger Platzhalter in Format-String
  • 26: Authentifizierungsfehler
  • 201: Timeout ist aufgetreten
  • 209: Ungültiger Argumentwert
  • 210: Funktion wird nicht unterstützt
  • 211: Unbekannter Fehler

Befehlsstruktur

Allgemeine Optionen des call und des dispatch Befehls sind hier zu finden. Im Folgenden wird die spezifische Befehlsstruktur dargestellt.

tinkerforge call barometer-bricklet [<option>..] <uid> <function> [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

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 dann
tinkerforge dispatch barometer-bricklet [<option>..] <uid> <callback>
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

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 dann
tinkerforge call barometer-bricklet <uid> <function> [<option>..] [<argument>..]
Parameter:
  • <uid> – Typ: String
  • <function> – Typ: String

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 dann

Getter-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 diese

Mit 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.

tinkerforge dispatch barometer-bricklet <uid> <callback> [<option>..]
Parameter:
  • <uid> – Typ: String
  • <callback> – Typ: String

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)

Grundfunktionen

tinkerforge call barometer-bricklet <uid> get-air-pressure
Ausgabe:
  • air-pressure – Typ: Int, Einheit: 1/1000 hPa, Wertebereich: [10000 bis 1200000]

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.

tinkerforge call barometer-bricklet <uid> get-altitude
Ausgabe:
  • altitude – Typ: Int, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1]

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.

tinkerforge call barometer-bricklet <uid> set-reference-air-pressure <air-pressure>
Parameter:
  • <air-pressure> – Typ: Int, Einheit: 1/1000 hPa, Wertebereich: [0, 10000 bis 1200000], Standardwert: 1013250
Ausgabe:
  • keine 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.

tinkerforge call barometer-bricklet <uid> get-reference-air-pressure
Ausgabe:
  • air-pressure – Typ: Int, Einheit: 1/1000 hPa, Wertebereich: [10000 bis 1200000], Standardwert: 1013250

Gibt den Referenzluftdruckwert zurück, wie von set-reference-air-pressure gesetzt.

Fortgeschrittene Funktionen

tinkerforge call barometer-bricklet <uid> get-chip-temperature
Ausgabe:
  • temperature – Typ: Int, Einheit: 1/100 °C, Wertebereich: [-4000 bis 8500]

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.

tinkerforge call barometer-bricklet <uid> set-averaging <moving-average-pressure> <average-pressure> <average-temperature>
Parameter:
  • <moving-average-pressure> – Typ: Int, Wertebereich: [0 bis 25], Standardwert: 25
  • <average-pressure> – Typ: Int, Wertebereich: [0 bis 10], Standardwert: 10
  • <average-temperature> – Typ: Int, Wertebereich: [0 bis 255], Standardwert: 10
Ausgabe:
  • keine 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).

tinkerforge call barometer-bricklet <uid> get-averaging
Ausgabe:
  • moving-average-pressure – Typ: Int, Wertebereich: [0 bis 25], Standardwert: 25
  • average-pressure – Typ: Int, Wertebereich: [0 bis 10], Standardwert: 10
  • average-temperature – Typ: Int, Wertebereich: [0 bis 255], Standardwert: 10

Gibt die Averaging-Konfiguration zurück, wie von set-averaging gesetzt.

Neu in Version 2.0.1 (Plugin).

tinkerforge call barometer-bricklet <uid> get-identity
Ausgabe:
  • uid – Typ: String, Länge: bis zu 8
  • connected-uid – Typ: String, Länge: bis zu 8
  • position – Typ: Char, Wertebereich: [a bis i, z]
  • hardware-version – Typ: Int Array, 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]
  • firmware-version – Typ: Int Array, 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]
  • 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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. 

Konfigurationsfunktionen für Callbacks

tinkerforge call barometer-bricklet <uid> set-air-pressure-callback-period <period>
Parameter:
  • <period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Ausgabe:
  • keine 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.

tinkerforge call barometer-bricklet <uid> get-air-pressure-callback-period
Ausgabe:
  • period – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von set-air-pressure-callback-period gesetzt.

tinkerforge call barometer-bricklet <uid> set-altitude-callback-period <period>
Parameter:
  • <period> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Ausgabe:
  • keine 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.

tinkerforge call barometer-bricklet <uid> get-altitude-callback-period
Ausgabe:
  • 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.

tinkerforge call barometer-bricklet <uid> set-air-pressure-callback-threshold <option> <min> <max>
Parameter:
  • <option> – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x
  • <min> – Typ: Int, Einheit: 1/1000 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • <max> – Typ: Int, Einheit: 1/1000 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Ausgabe:
  • keine 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>:

  • threshold-option-off = x
  • threshold-option-outside = o
  • threshold-option-inside = i
  • threshold-option-smaller = <
  • threshold-option-greater = >
tinkerforge call barometer-bricklet <uid> get-air-pressure-callback-threshold
Ausgabe:
  • option – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x
  • min – Typ: Int, Einheit: 1/1000 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: Int, Einheit: 1/1000 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

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:

  • threshold-option-off = x
  • threshold-option-outside = o
  • threshold-option-inside = i
  • threshold-option-smaller = <
  • threshold-option-greater = >
tinkerforge call barometer-bricklet <uid> set-altitude-callback-threshold <option> <min> <max>
Parameter:
  • <option> – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x
  • <min> – Typ: Int, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • <max> – Typ: Int, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Ausgabe:
  • keine 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>:

  • threshold-option-off = x
  • threshold-option-outside = o
  • threshold-option-inside = i
  • threshold-option-smaller = <
  • threshold-option-greater = >
tinkerforge call barometer-bricklet <uid> get-altitude-callback-threshold
Ausgabe:
  • option – Typ: Char, Wertebereich: Siehe Symbole, Standardwert: x
  • min – Typ: Int, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: Int, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

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:

  • threshold-option-off = x
  • threshold-option-outside = o
  • threshold-option-inside = i
  • threshold-option-smaller = <
  • threshold-option-greater = >
tinkerforge call barometer-bricklet <uid> set-debounce-period <debounce>
Parameter:
  • <debounce> – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Ausgabe:
  • keine Ausgabe

Setzt die Periode mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

tinkerforge call barometer-bricklet <uid> get-debounce-period
Ausgabe:
  • debounce – Typ: Int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von set-debounce-period gesetzt.

Callbacks

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.

tinkerforge dispatch barometer-bricklet <uid> air-pressure
Ausgabe:
  • air-pressure – Typ: Int, Einheit: 1/1000 hPa, Wertebereich: [10000 bis 1200000]

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.

tinkerforge dispatch barometer-bricklet <uid> altitude
Ausgabe:
  • altitude – Typ: Int, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1]

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.

tinkerforge dispatch barometer-bricklet <uid> air-pressure-reached
Ausgabe:
  • air-pressure – Typ: Int, Einheit: 1/1000 hPa, Wertebereich: [10000 bis 1200000]

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.

tinkerforge dispatch barometer-bricklet <uid> altitude-reached
Ausgabe:
  • altitude – Typ: Int, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1]

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.