Modbus - Barometer Bricklet

Dies ist die Beschreibung des Modbus Protokolls für das Barometer Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Barometer Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API

Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.

Grundfunktionen

BrickletBarometer.get_air_pressure
Funktions-ID:
  • 1
Anfrage:
  • keine Nutzdaten
Antwort:
  • air_pressure – Typ: int32, 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 CALLBACK_AIR_PRESSURE Callback zu nutzen und die Periode mit set_air_pressure_callback_period vorzugeben.

BrickletBarometer.get_altitude
Funktions-ID:
  • 2
Anfrage:
  • keine Nutzdaten
Antwort:
  • altitude – Typ: int32, 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 CALLBACK_ALTITUDE Callback zu nutzen und die Periode mit set_altitude_callback_period vorzugeben.

BrickletBarometer.set_reference_air_pressure
Funktions-ID:
  • 13
Anfrage:
  • air_pressure – Typ: int32, 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.

BrickletBarometer.get_reference_air_pressure
Funktions-ID:
  • 19
Anfrage:
  • keine Nutzdaten
Antwort:
  • air_pressure – Typ: int32, Einheit: 1/1000 hPa, Wertebereich: [10000 bis 1200000], Standardwert: 1013250

Gibt den Referenzluftdruckwert zurück, wie von set_reference_air_pressure gesetzt.

Fortgeschrittene Funktionen

BrickletBarometer.get_chip_temperature
Funktions-ID:
  • 14
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int16, 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.

BrickletBarometer.set_averaging
Funktions-ID:
  • 20
Anfrage:
  • moving_average_pressure – Typ: uint8, Wertebereich: [0 bis 25], Standardwert: 25
  • average_pressure – Typ: uint8, Wertebereich: [0 bis 10], Standardwert: 10
  • average_temperature – Typ: uint8, 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).

BrickletBarometer.get_averaging
Funktions-ID:
  • 21
Anfrage:
  • keine Nutzdaten
Antwort:
  • moving_average_pressure – Typ: uint8, Wertebereich: [0 bis 25], Standardwert: 25
  • average_pressure – Typ: uint8, Wertebereich: [0 bis 10], Standardwert: 10
  • average_temperature – Typ: uint8, Wertebereich: [0 bis 255], Standardwert: 10

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

Neu in Version 2.0.1 (Plugin).

BrickletBarometer.get_identity
Funktions-ID:
  • 255
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: char[8]
  • connected_uid – Typ: char[8]
  • position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • firmware_version – Typ: uint8[3]
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • device_identifier – Typ: uint16, 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

BrickletBarometer.set_air_pressure_callback_period
Funktions-ID:
  • 3
Anfrage:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:
  • keine Antwort

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
Funktions-ID:
  • 4
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von set_air_pressure_callback_period gesetzt.

BrickletBarometer.set_altitude_callback_period
Funktions-ID:
  • 5
Anfrage:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:
  • keine Antwort

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
Funktions-ID:
  • 6
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

BrickletBarometer.set_air_pressure_callback_threshold
Funktions-ID:
  • 7
Anfrage:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: int32, Einheit: 1/1000 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32, Einheit: 1/1000 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Antwort:
  • keine Antwort

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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletBarometer.get_air_pressure_callback_threshold
Funktions-ID:
  • 8
Anfrage:
  • keine Nutzdaten
Antwort:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: int32, Einheit: 1/1000 hPa, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32, 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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletBarometer.set_altitude_callback_threshold
Funktions-ID:
  • 9
Anfrage:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: int32, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Antwort:
  • keine Antwort

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 Bedeutungen sind für die Elemente dieser Funktion definiert:

Für option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletBarometer.get_altitude_callback_threshold
Funktions-ID:
  • 10
Anfrage:
  • keine Nutzdaten
Antwort:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: int32, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int32, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von set_altitude_callback_threshold gesetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für option:

  • 'x' = Off
  • 'o' = Outside
  • 'i' = Inside
  • '<' = Smaller
  • '>' = Greater
BrickletBarometer.set_debounce_period
Funktions-ID:
  • 11
Anfrage:
  • debounce – Typ: uint32, 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.

BrickletBarometer.get_debounce_period
Funktions-ID:
  • 12
Anfrage:
  • keine Nutzdaten
Antwort:
  • debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von set_debounce_period gesetzt.

Callbacks

BrickletBarometer.CALLBACK_AIR_PRESSURE
Funktions-ID:
  • 15
Antwort:
  • air_pressure – Typ: int32, 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 Rückgabewert 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
Funktions-ID:
  • 16
Antwort:
  • altitude – Typ: int32, Einheit: 1 cm, Wertebereich: [-231 bis 231 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit set_altitude_callback_period, ausgelöst. Der Rückgabewert 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
Funktions-ID:
  • 17
Antwort:
  • air_pressure – Typ: int32, 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 Rückgabewert 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
Funktions-ID:
  • 18
Antwort:
  • altitude – Typ: int32, 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 Rückgabewert 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.