Dies ist die Beschreibung des Modbus Protokolls für das Barometer Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Barometer Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.
Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.
BrickletBarometerV2.
get_air_pressure
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt den Luftdruck des Luftdrucksensors zurück.
Wenn der Wert periodisch benötigt wird, kann auch der CALLBACK_AIR_PRESSURE
Callback
verwendet werden. Der Callback wird mit der Funktion
set_air_pressure_callback_configuration
konfiguriert.
BrickletBarometerV2.
get_altitude
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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 der Wert periodisch benötigt wird, kann auch der CALLBACK_ALTITUDE
Callback
verwendet werden. Der Callback wird mit der Funktion
set_altitude_callback_configuration
konfiguriert.
BrickletBarometerV2.
get_temperature
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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 2.0 oder dem Temperature IR Bricklet 2.0 gemessen wird.
Wenn der Wert periodisch benötigt wird, kann auch der CALLBACK_TEMPERATURE
Callback
verwendet werden. Der Callback wird mit der Funktion
set_temperature_callback_configuration
konfiguriert.
BrickletBarometerV2.
set_moving_average_configuration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt die Länge eines gleitenden Mittelwerts für die Luftdruck- und Temperaturmessung.
Wenn die Länge auf 1 gesetzt wird, ist die Mittelwertbildung deaktiviert. Je kürzer die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.
Bei Langzeitmessungen gibt ein langer Mittelwert die saubersten Resultate.
BrickletBarometerV2.
get_moving_average_configuration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Moving Average-Konfiguration zurück, wie von
set_moving_average_configuration
gesetzt.
BrickletBarometerV2.
set_reference_air_pressure
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt den Referenzluftdruck für die Höhenberechnung. Wenn der aktuelle Luftdruckwert als Referenz übergeben wird dann gibt die Höhenberechnung 0mm 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.
BrickletBarometerV2.
get_reference_air_pressure
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt den Referenzluftdruckwert zurück, wie von set_reference_air_pressure
gesetzt.
BrickletBarometerV2.
set_calibration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt den One Point Calibration (OPC) Werte für die Luftdruckmessung.
Bevor das Bricklet kalibriert werden kann muss die möglicherweise vorhandene
Kalibierung gelöschet werden, dazu muss Measured Air Pressure
und
Actual Air Pressure
auf 0 gesetzt werden.
Dann muss der aktuelle Luftdruck gleichzeitig mit dem Bricklet
(Measured Air Pressure
) und einem genauen Referenzbarometer
(Actual Air Pressure
) gemessen und die Werte an diese Funktion
übergeben werden.
Nach einer ordentlichen Kalibrierung kann der Luftdruck mit bis zu 0,2 hPa Genauigkeit gemessen werden
Die Kalibrierung wird im EEPROM des Bricklets gespeichert und muss nur einmal gesetzt werden.
BrickletBarometerV2.
get_calibration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Luftdruck One Point Calibration Werte zurück, wie von
set_calibration
gesetzt.
BrickletBarometerV2.
set_sensor_configuration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Konfiguriert die Datenrate und den Luftdrucktiefpassfilter. Die Grenzfrequenz des Tiefpassfilters (falls aktiviert) kann auf 1/9 oder 1/20 der eingestellten Datenrate gesetzt werden, um das Rauschen auf den Luftdruckdaten zu verringert.
Die Tiefpassfiltereinstellung gilt nur für die Luftdruckmessung. Es gibt keinen Tiefpassfilter für die Temperaturmessung.
Eine Verringerung der Datenrate oder des Wertebereichs verringert auch automatisch das Rauschen auf den Daten. Eine hohe Datenrate erhöht zusätzlich die Selbsterhitzung des Sensors. Wenn eine hohe Temperaturgenauigkeit wichtig ist empfehlen wir eine Datenrate von 1Hz.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für data_rate:
Für air_pressure_low_pass_filter:
BrickletBarometerV2.
get_sensor_configuration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Sensor-Konfiguration zurück, wie von set_sensor_configuration
gesetzt.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für data_rate:
Für air_pressure_low_pass_filter:
BrickletBarometerV2.
get_spitfp_error_count
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.
BrickletBarometerV2.
set_status_led_config
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.
Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.
Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für config:
BrickletBarometerV2.
get_status_led_config
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Konfiguration zurück, wie von set_status_led_config
gesetzt.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für config:
BrickletBarometerV2.
get_chip_temperature
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.
Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.
BrickletBarometerV2.
reset
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.
Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.
BrickletBarometerV2.
get_identity
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.
BrickletBarometerV2.
set_air_pressure_callback_configuration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Die Periode ist die Periode mit der der CALLBACK_AIR_PRESSURE
Callback ausgelöst wird. Ein Wert von 0
schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.
Der option-Parameter zusammen mit min/max setzt einen Threshold für den CALLBACK_AIR_PRESSURE
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Threshold ist abgeschaltet |
'o' | Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind |
'i' | Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind |
'<' | Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert) |
'>' | Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert) |
Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für option:
BrickletBarometerV2.
get_air_pressure_callback_configuration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Callback-Konfiguration zurück, wie mittels set_air_pressure_callback_configuration
gesetzt.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für option:
BrickletBarometerV2.
set_altitude_callback_configuration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Die Periode ist die Periode mit der der CALLBACK_ALTITUDE
Callback ausgelöst wird. Ein Wert von 0
schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.
Der option-Parameter zusammen mit min/max setzt einen Threshold für den CALLBACK_ALTITUDE
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Threshold ist abgeschaltet |
'o' | Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind |
'i' | Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind |
'<' | Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert) |
'>' | Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert) |
Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für option:
BrickletBarometerV2.
get_altitude_callback_configuration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Callback-Konfiguration zurück, wie mittels set_altitude_callback_configuration
gesetzt.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für option:
BrickletBarometerV2.
set_temperature_callback_configuration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Die Periode ist die Periode mit der der CALLBACK_TEMPERATURE
Callback ausgelöst wird. Ein Wert von 0
schaltet den Callback ab.
Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.
Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.
Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.
Der option-Parameter zusammen mit min/max setzt einen Threshold für den CALLBACK_TEMPERATURE
Callback.
Die folgenden Optionen sind möglich:
Option | Beschreibung |
---|---|
'x' | Threshold ist abgeschaltet |
'o' | Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind |
'i' | Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind |
'<' | Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert) |
'>' | Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert) |
Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für option:
BrickletBarometerV2.
get_temperature_callback_configuration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Callback-Konfiguration zurück, wie mittels set_temperature_callback_configuration
gesetzt.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für option:
BrickletBarometerV2.
CALLBACK_AIR_PRESSURE
¶Funktions-ID: |
|
---|---|
Antwort: |
|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
set_air_pressure_callback_configuration
gesetzten Konfiguration
Der Rückgabewert ist der gleiche wie get_air_pressure
.
BrickletBarometerV2.
CALLBACK_ALTITUDE
¶Funktions-ID: |
|
---|---|
Antwort: |
|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
set_altitude_callback_configuration
gesetzten Konfiguration
Der Rückgabewert ist der gleiche wie get_altitude
.
BrickletBarometerV2.
CALLBACK_TEMPERATURE
¶Funktions-ID: |
|
---|---|
Antwort: |
|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
set_temperature_callback_configuration
gesetzten Konfiguration
Der Rückgabewert ist der gleiche wie get_temperature
.
Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.
BrickletBarometerV2.
set_bootloader_mode
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.
Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für mode:
Für status:
BrickletBarometerV2.
get_bootloader_mode
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode
.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für mode:
BrickletBarometerV2.
set_write_firmware_pointer
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt den Firmware-Pointer für write_firmware
. Der Pointer
muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke
in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
BrickletBarometerV2.
write_firmware
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
set_write_firmware_pointer
gesetzt wurde. Die Firmware wird
alle 4 Datenblöcke in den Flash geschrieben.
Eine Firmware kann nur im Bootloader-Mode geschrieben werden.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
BrickletBarometerV2.
write_uid
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.
Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.
BrickletBarometerV2.
read_uid
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.