MQTT - Barometer Bricklet

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example-simple.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
# Change XYZ to the UID of your Barometer Bricklet

setup:
    # Get current air pressure
    subscribe to tinkerforge/response/barometer_bricklet/XYZ/get_air_pressure
    publish '' to tinkerforge/request/barometer_bricklet/XYZ/get_air_pressure

    # Get current altitude
    subscribe to tinkerforge/response/barometer_bricklet/XYZ/get_altitude
    publish '' to tinkerforge/request/barometer_bricklet/XYZ/get_altitude

Callback

Download (example-callback.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Change XYZ to the UID of your Barometer Bricklet

setup:
    # Handle incoming air pressure callbacks
    subscribe to tinkerforge/callback/barometer_bricklet/XYZ/air_pressure
    publish '{"register": true}' to tinkerforge/register/barometer_bricklet/XYZ/air_pressure # Register air_pressure callback

    # 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!
    publish '{"period": 1000}' to tinkerforge/request/barometer_bricklet/XYZ/set_air_pressure_callback_period

Threshold

Download (example-threshold.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
# Change XYZ to the UID of your Barometer Bricklet

setup:
    # Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    publish '{"debounce": 10000}' to tinkerforge/request/barometer_bricklet/XYZ/set_debounce_period

    # Handle incoming air pressure reached callbacks
    subscribe to tinkerforge/callback/barometer_bricklet/XYZ/air_pressure_reached
    publish '{"register": true}' to tinkerforge/register/barometer_bricklet/XYZ/air_pressure_reached # Register air_pressure_reached callback

    # Configure threshold for air pressure "greater than 1025 hPa"
    publish '{"option": "greater", "min": 1025000, "max": 0}' to tinkerforge/request/barometer_bricklet/XYZ/set_air_pressure_callback_threshold

API

Alle veröffentlichten Payloads an die und von den MQTT-Bindings sind im JSON Format.

Falls ein Fehler auftritt, veröffentlichen die Bindings ein JSON-Objekt, das die Fehlermeldung als _ERROR-Member enthält. Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/... für .../request/... und .../callback/... für .../register/....

Grundfunktionen

request/barometer_bricklet/<UID>/get_air_pressure
Anfrage:
  • keine Nutzdaten
Antwort:
  • 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 register/barometer_bricklet/<UID>/air_pressure Callback zu nutzen und die Periode mit request/barometer_bricklet/<UID>/set_air_pressure_callback_period vorzugeben.

request/barometer_bricklet/<UID>/get_altitude
Anfrage:
  • keine Nutzdaten
Antwort:
  • 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 request/barometer_bricklet/<UID>/set_reference_air_pressure gesetzt werden kann.

Wenn die Höhe periodisch abgefragt werden soll, wird empfohlen den register/barometer_bricklet/<UID>/altitude Callback zu nutzen und die Periode mit request/barometer_bricklet/<UID>/set_altitude_callback_period vorzugeben.

request/barometer_bricklet/<UID>/set_reference_air_pressure
Anfrage:
  • air_pressure – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [0, 10000 bis 1200000], Standardwert: 1013250
Antwort:
  • keine Antwort

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.

request/barometer_bricklet/<UID>/get_reference_air_pressure
Anfrage:
  • keine Nutzdaten
Antwort:
  • air_pressure – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [10000 bis 1200000], Standardwert: 1013250

Gibt den Referenzluftdruckwert zurück, wie von request/barometer_bricklet/<UID>/set_reference_air_pressure gesetzt.

Fortgeschrittene Funktionen

request/barometer_bricklet/<UID>/get_chip_temperature
Anfrage:
  • keine Nutzdaten
Antwort:
  • 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.

request/barometer_bricklet/<UID>/set_averaging
Anfrage:
  • 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
Antwort:
  • keine Antwort

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

request/barometer_bricklet/<UID>/get_averaging
Anfrage:
  • keine Nutzdaten
Antwort:
  • 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 request/barometer_bricklet/<UID>/set_averaging gesetzt.

Neu in Version 2.0.1 (Plugin).

request/barometer_bricklet/<UID>/set_i2c_mode
Anfrage:
  • mode – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0
Antwort:
  • keine Antwort

Setzt den I2C Modus. Mögliche Modi sind:

  • 0: Fast (400kHz)
  • 1: Slow (100kHz)

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:

  • "fast" = 0
  • "slow" = 1

Neu in Version 2.0.3 (Plugin).

request/barometer_bricklet/<UID>/get_i2c_mode
Anfrage:
  • keine Nutzdaten
Antwort:
  • mode – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt den I2C Modus zurück, wie von request/barometer_bricklet/<UID>/set_i2c_mode gesetzt.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für mode:

  • "fast" = 0
  • "slow" = 1

Neu in Version 2.0.3 (Plugin).

request/barometer_bricklet/<UID>/get_identity
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: string, Länge: bis zu 8
  • connected_uid – Typ: string, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ["a" bis "h", "i", "z"]
  • hardware_version – Typ: [int, ...], 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, ...], 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]
  • _display_name – Typ: string

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. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.

Der Display Name enthält den Anzeigenamen des Barometer.

Konfigurationsfunktionen für Callbacks

request/barometer_bricklet/<UID>/set_air_pressure_callback_period
Anfrage:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt die Periode mit welcher der register/barometer_bricklet/<UID>/air_pressure Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/barometer_bricklet/<UID>/air_pressure Callback wird nur ausgelöst, wenn sich der Luftdruck seit der letzten Auslösung geändert hat.

request/barometer_bricklet/<UID>/get_air_pressure_callback_period
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von request/barometer_bricklet/<UID>/set_air_pressure_callback_period gesetzt.

request/barometer_bricklet/<UID>/set_altitude_callback_period
Anfrage:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt die Periode mit welcher der register/barometer_bricklet/<UID>/altitude Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/barometer_bricklet/<UID>/altitude Callback wird nur ausgelöst, wenn sich Höhe seit der letzten Auslösung geändert hat.

request/barometer_bricklet/<UID>/get_altitude_callback_period
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von request/barometer_bricklet/<UID>/set_altitude_callback_period gesetzt.

request/barometer_bricklet/<UID>/set_air_pressure_callback_threshold
Anfrage:
  • 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
Antwort:
  • keine Antwort

Setzt den Schwellwert für den register/barometer_bricklet/<UID>/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:

  • "off" = "x"
  • "outside" = "o"
  • "inside" = "i"
  • "smaller" = "<"
  • "greater" = ">"
request/barometer_bricklet/<UID>/get_air_pressure_callback_threshold
Anfrage:
  • keine Nutzdaten
Antwort:
  • 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 request/barometer_bricklet/<UID>/set_air_pressure_callback_threshold gesetzt.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für option:

  • "off" = "x"
  • "outside" = "o"
  • "inside" = "i"
  • "smaller" = "<"
  • "greater" = ">"
request/barometer_bricklet/<UID>/set_altitude_callback_threshold
Anfrage:
  • 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
Antwort:
  • keine Antwort

Setzt den Schwellwert für den register/barometer_bricklet/<UID>/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:

  • "off" = "x"
  • "outside" = "o"
  • "inside" = "i"
  • "smaller" = "<"
  • "greater" = ">"
request/barometer_bricklet/<UID>/get_altitude_callback_threshold
Anfrage:
  • keine Nutzdaten
Antwort:
  • 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 request/barometer_bricklet/<UID>/set_altitude_callback_threshold gesetzt.

Die folgenden Symbole sind für diese Funktion verfügbar:

Für option:

  • "off" = "x"
  • "outside" = "o"
  • "inside" = "i"
  • "smaller" = "<"
  • "greater" = ">"
request/barometer_bricklet/<UID>/set_debounce_period
Anfrage:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Antwort:
  • keine Antwort

Setzt die Periode mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

request/barometer_bricklet/<UID>/get_debounce_period
Anfrage:
  • keine Nutzdaten
Antwort:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von request/barometer_bricklet/<UID>/set_debounce_period gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit dem entsprechenden .../register/...-Topic und einem optionalen Suffix durchgeführt werden. Mit diesem Suffix kann das Callback später deregistriert werden.

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.

register/barometer_bricklet/<UID>/air_pressure
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • air_pressure – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [10000 bis 1200000]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/barometer_bricklet/<UID>/air_pressure[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/barometer_bricklet/<UID>/air_pressure[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird mit der Periode, wie gesetzt mit request/barometer_bricklet/<UID>/set_air_pressure_callback_period, ausgelöst. Der Payload des Callbacks ist der Luftdruck des Luftdrucksensors.

Der register/barometer_bricklet/<UID>/air_pressure Callback wird nur ausgelöst, wenn sich der Luftdruck seit der letzten Auslösung geändert hat.

register/barometer_bricklet/<UID>/altitude
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • altitude – Typ: int, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/barometer_bricklet/<UID>/altitude[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/barometer_bricklet/<UID>/altitude[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird mit der Periode, wie gesetzt mit request/barometer_bricklet/<UID>/set_altitude_callback_period, ausgelöst. Der Payload des Callbacks ist die Höhe des Luftdrucksensors.

Der register/barometer_bricklet/<UID>/altitude Callback wird nur ausgelöst, wenn sich die Höhe seit der letzten Auslösung geändert hat.

register/barometer_bricklet/<UID>/air_pressure_reached
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • air_pressure – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [10000 bis 1200000]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/barometer_bricklet/<UID>/air_pressure_reached[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/barometer_bricklet/<UID>/air_pressure_reached[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/barometer_bricklet/<UID>/set_air_pressure_callback_threshold gesetzt, erreicht wird. Der Payload des Callbacks ist der Luftdruck des Luftdrucksensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit request/barometer_bricklet/<UID>/set_debounce_period gesetzt, ausgelöst.

register/barometer_bricklet/<UID>/altitude_reached
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • altitude – Typ: int, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/barometer_bricklet/<UID>/altitude_reached[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/barometer_bricklet/<UID>/altitude_reached[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/barometer_bricklet/<UID>/set_altitude_callback_threshold gesetzt, erreicht wird. Der Payload des Callbacks ist die Höhe des Luftdrucksensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit request/barometer_bricklet/<UID>/set_debounce_period gesetzt, ausgelöst.