TCP/IP - Barometer Bricklet

Dies ist die Beschreibung des TCP/IP 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 TCP/IP Protokollstruktur findet sich hier.

Grundfunktionen

BrickletBarometer.get_air_pressure
Funktions ID:

1

Anfrage:

keine Nutzdaten

Antwort:
  • air_pressure -- int32

Gibt den Luftdruck des Luftdrucksensors zurück. Der Wertbereich geht von 10000 bis 1200000 und ist in mbar/1000 angegeben, d.h. bei einem Wert von 1001092 wurde ein Luftdruck von 1001,092 mbar gemessen.

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 -- int32

Gibt die relative Höhe des Luftdrucksensors zurück. Der Wert ist in cm angegeben und 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 -- int32
Antwort:

keine Antwort

Setzt den Referenzluftdruck in mbar/1000 für die Höhenberechnung. Gültige Werte liegen zwischen 10000 und 1200000. 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.

Der Standardwert ist 1013,25mbar.

BrickletBarometer.get_reference_air_pressure
Funktions ID:

19

Anfrage:

keine Nutzdaten

Antwort:
  • air_pressure -- int32

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 -- int16

Gibt die Temperatur des Luftdrucksensors zurück. Der Wertbereich ist von -4000 bis 8500 und ist in °C/100 angegeben, d.h. bei einem Wert von 2007 wurde eine Temperatur von 20,07 °C gemessen.

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 -- uint8
  • average_pressure -- uint8
  • average_temperature -- uint8
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.

Die maximale Länge des Luftdruckmittelwerts ist 10, des Temperaturmittelwerts 255 und des gleitenden Mittelwertes 25.

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.

Der Standardwert ist 10 für die normalen Mittelwerte und 25 für den gleitenden Mittelwert

Neu in Version 2.0.1 (Plugin).

BrickletBarometer.get_averaging
Funktions ID:

21

Anfrage:

keine Nutzdaten

Antwort:
  • moving_average_pressure -- uint8
  • average_pressure -- uint8
  • average_temperature -- uint8

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 -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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 kann 'a', 'b', 'c' oder 'd' sein.

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 -- uint32
Antwort:

keine Antwort

Setzt die Periode in ms 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.

Der Standardwert ist 0.

BrickletBarometer.get_air_pressure_callback_period
Funktions ID:

4

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32

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

BrickletBarometer.set_altitude_callback_period
Funktions ID:

5

Anfrage:
  • period -- uint32
Antwort:

keine Antwort

Setzt die Periode in ms 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.

Der Standardwert ist 0.

BrickletBarometer.get_altitude_callback_period
Funktions ID:

6

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32

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

BrickletBarometer.set_air_pressure_callback_threshold
Funktions ID:

7

Anfrage:
  • option -- char
  • min -- int32
  • max -- int32
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)

Der Standardwert ist ('x', 0, 0).

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

  • x: off, für option
  • o: outside, für option
  • i: inside, für option
  • <: smaller, für option
  • >: greater, für option
BrickletBarometer.get_air_pressure_callback_threshold
Funktions ID:

8

Anfrage:

keine Nutzdaten

Antwort:
  • option -- char
  • min -- int32
  • max -- int32

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

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

  • x: off, für option
  • o: outside, für option
  • i: inside, für option
  • <: smaller, für option
  • >: greater, für option
BrickletBarometer.set_altitude_callback_threshold
Funktions ID:

9

Anfrage:
  • option -- char
  • min -- int32
  • max -- int32
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)

Der Standardwert ist ('x', 0, 0).

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

  • x: off, für option
  • o: outside, für option
  • i: inside, für option
  • <: smaller, für option
  • >: greater, für option
BrickletBarometer.get_altitude_callback_threshold
Funktions ID:

10

Anfrage:

keine Nutzdaten

Antwort:
  • option -- char
  • min -- int32
  • max -- int32

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

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

  • x: off, für option
  • o: outside, für option
  • i: inside, für option
  • <: smaller, für option
  • >: greater, für option
BrickletBarometer.set_debounce_period
Funktions ID:

11

Anfrage:
  • debounce -- uint32
Antwort:

keine Antwort

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

BrickletBarometer.get_debounce_period
Funktions ID:

12

Anfrage:

keine Nutzdaten

Antwort:
  • debounce -- uint32

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

Callbacks

BrickletBarometer.CALLBACK_AIR_PRESSURE
Funktions ID:

15

Antwort:
  • air_pressure -- int32

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 -- int32

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 -- int32

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 -- int32

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.