MQTT - Barometer Bricklet 2.0

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Callback

Download (example-callback.txt)

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

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

    # Set period for air pressure callback to 1s (1000ms) without a threshold
    publish '{"period": 1000, "value_has_to_change": false, "option": "off", "min": 0, "max": 0}' to tinkerforge/request/barometer_v2_bricklet/XYZ/set_air_pressure_callback_configuration

Simple

Download (example-simple.txt)

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

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

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

Threshold

Download (example-threshold.txt)

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

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

    # Configure threshold for air pressure "greater than 1025 hPa"
    # with a debounce period of 1s (1000ms)
    publish '{"period": 1000, "value_has_to_change": false, "option": "greater", "min": 1025000, "max": 0}' to tinkerforge/request/barometer_v2_bricklet/XYZ/set_air_pressure_callback_configuration

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_v2_bricklet/<UID>/get_air_pressure
Anfrage:
  • keine Nutzdaten
Antwort:
  • air_pressure – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [260000 bis 1260000]

Gibt den Luftdruck des Luftdrucksensors zurück.

Wenn der Wert periodisch benötigt wird, kann auch der register/barometer_v2_bricklet/<UID>/air_pressure Callback verwendet werden. Der Callback wird mit der Funktion request/barometer_v2_bricklet/<UID>/set_air_pressure_callback_configuration konfiguriert.

request/barometer_v2_bricklet/<UID>/get_altitude
Anfrage:
  • keine Nutzdaten
Antwort:
  • altitude – Typ: int, Einheit: 1 mm, 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_v2_bricklet/<UID>/set_reference_air_pressure gesetzt werden kann.

Wenn der Wert periodisch benötigt wird, kann auch der register/barometer_v2_bricklet/<UID>/altitude Callback verwendet werden. Der Callback wird mit der Funktion request/barometer_v2_bricklet/<UID>/set_altitude_callback_configuration konfiguriert.

request/barometer_v2_bricklet/<UID>/get_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 2.0 oder dem Temperature IR Bricklet 2.0 gemessen wird.

Wenn der Wert periodisch benötigt wird, kann auch der register/barometer_v2_bricklet/<UID>/temperature Callback verwendet werden. Der Callback wird mit der Funktion request/barometer_v2_bricklet/<UID>/set_temperature_callback_configuration konfiguriert.

request/barometer_v2_bricklet/<UID>/set_moving_average_configuration
Anfrage:
  • moving_average_length_air_pressure – Typ: int, Wertebereich: [1 bis 1000], Standardwert: 100
  • moving_average_length_temperature – Typ: int, Wertebereich: [1 bis 1000], Standardwert: 100
Antwort:
  • keine 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.

request/barometer_v2_bricklet/<UID>/get_moving_average_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • moving_average_length_air_pressure – Typ: int, Wertebereich: [1 bis 1000], Standardwert: 100
  • moving_average_length_temperature – Typ: int, Wertebereich: [1 bis 1000], Standardwert: 100

Gibt die Moving Average-Konfiguration zurück, wie von request/barometer_v2_bricklet/<UID>/set_moving_average_configuration gesetzt.

request/barometer_v2_bricklet/<UID>/set_reference_air_pressure
Anfrage:
  • air_pressure – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [0, 260000 bis 1260000], 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 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.

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

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

Fortgeschrittene Funktionen

request/barometer_v2_bricklet/<UID>/set_calibration
Anfrage:
  • measured_air_pressure – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [0, 260000 bis 1260000]
  • actual_air_pressure – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [0, 260000 bis 1260000]
Antwort:
  • keine 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.

request/barometer_v2_bricklet/<UID>/get_calibration
Anfrage:
  • keine Nutzdaten
Antwort:
  • measured_air_pressure – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [0, 260000 bis 1260000]
  • actual_air_pressure – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [0, 260000 bis 1260000]

Gibt die Luftdruck One Point Calibration Werte zurück, wie von request/barometer_v2_bricklet/<UID>/set_calibration gesetzt.

request/barometer_v2_bricklet/<UID>/set_sensor_configuration
Anfrage:
  • data_rate – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 4
  • air_pressure_low_pass_filter – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 1
Antwort:
  • keine 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 Symbole sind für diese Funktion verfügbar:

Für data_rate:

  • "off" = 0
  • "1hz" = 1
  • "10hz" = 2
  • "25hz" = 3
  • "50hz" = 4
  • "75hz" = 5

Für air_pressure_low_pass_filter:

  • "off" = 0
  • "1_9th" = 1
  • "1_20th" = 2
request/barometer_v2_bricklet/<UID>/get_sensor_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • data_rate – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 4
  • air_pressure_low_pass_filter – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 1

Gibt die Sensor-Konfiguration zurück, wie von request/barometer_v2_bricklet/<UID>/set_sensor_configuration gesetzt.

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

Für data_rate:

  • "off" = 0
  • "1hz" = 1
  • "10hz" = 2
  • "25hz" = 3
  • "50hz" = 4
  • "75hz" = 5

Für air_pressure_low_pass_filter:

  • "off" = 0
  • "1_9th" = 1
  • "1_20th" = 2
request/barometer_v2_bricklet/<UID>/get_spitfp_error_count
Anfrage:
  • keine Nutzdaten
Antwort:
  • error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

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.

request/barometer_v2_bricklet/<UID>/set_status_led_config
Anfrage:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
Antwort:
  • keine 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 Symbole sind für diese Funktion verfügbar:

Für config:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_status" = 3
request/barometer_v2_bricklet/<UID>/get_status_led_config
Anfrage:
  • keine Nutzdaten
Antwort:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von request/barometer_v2_bricklet/<UID>/set_status_led_config gesetzt.

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

Für config:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_status" = 3
request/barometer_v2_bricklet/<UID>/get_chip_temperature
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

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.

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

request/barometer_v2_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 2.0.

Konfigurationsfunktionen für Callbacks

request/barometer_v2_bricklet/<UID>/set_air_pressure_callback_configuration
Anfrage:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • 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

Die Periode ist die Periode mit der der register/barometer_v2_bricklet/<UID>/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 register/barometer_v2_bricklet/<UID>/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 Symbole sind für diese Funktion verfügbar:

Für option:

  • "off" = "x"
  • "outside" = "o"
  • "inside" = "i"
  • "smaller" = "<"
  • "greater" = ">"
request/barometer_v2_bricklet/<UID>/get_air_pressure_callback_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • 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 die Callback-Konfiguration zurück, wie mittels request/barometer_v2_bricklet/<UID>/set_air_pressure_callback_configuration gesetzt.

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

Für option:

  • "off" = "x"
  • "outside" = "o"
  • "inside" = "i"
  • "smaller" = "<"
  • "greater" = ">"
request/barometer_v2_bricklet/<UID>/set_altitude_callback_configuration
Anfrage:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min – Typ: int, Einheit: 1 mm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 mm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Die Periode ist die Periode mit der der register/barometer_v2_bricklet/<UID>/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 register/barometer_v2_bricklet/<UID>/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 Symbole sind für diese Funktion verfügbar:

Für option:

  • "off" = "x"
  • "outside" = "o"
  • "inside" = "i"
  • "smaller" = "<"
  • "greater" = ">"
request/barometer_v2_bricklet/<UID>/get_altitude_callback_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min – Typ: int, Einheit: 1 mm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 mm, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels request/barometer_v2_bricklet/<UID>/set_altitude_callback_configuration gesetzt.

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

Für option:

  • "off" = "x"
  • "outside" = "o"
  • "inside" = "i"
  • "smaller" = "<"
  • "greater" = ">"
request/barometer_v2_bricklet/<UID>/set_temperature_callback_configuration
Anfrage:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min – Typ: int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Die Periode ist die Periode mit der der register/barometer_v2_bricklet/<UID>/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 register/barometer_v2_bricklet/<UID>/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 Symbole sind für diese Funktion verfügbar:

Für option:

  • "off" = "x"
  • "outside" = "o"
  • "inside" = "i"
  • "smaller" = "<"
  • "greater" = ">"
request/barometer_v2_bricklet/<UID>/get_temperature_callback_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min – Typ: int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1/100 °C, Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels request/barometer_v2_bricklet/<UID>/set_temperature_callback_configuration gesetzt.

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

Für option:

  • "off" = "x"
  • "outside" = "o"
  • "inside" = "i"
  • "smaller" = "<"
  • "greater" = ">"

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_v2_bricklet/<UID>/air_pressure
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • air_pressure – Typ: int, Einheit: 1/1000 hPa, Wertebereich: [260000 bis 1260000]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/barometer_v2_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_v2_bricklet/<UID>/air_pressure[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird periodisch ausgelöst abhängig von der mittels request/barometer_v2_bricklet/<UID>/set_air_pressure_callback_configuration gesetzten Konfiguration

Der Payload des Callbacks ist der gleiche wie request/barometer_v2_bricklet/<UID>/get_air_pressure.

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

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/barometer_v2_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_v2_bricklet/<UID>/altitude[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird periodisch ausgelöst abhängig von der mittels request/barometer_v2_bricklet/<UID>/set_altitude_callback_configuration gesetzten Konfiguration

Der Payload des Callbacks ist der gleiche wie request/barometer_v2_bricklet/<UID>/get_altitude.

register/barometer_v2_bricklet/<UID>/temperature
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • temperature – Typ: int, Einheit: 1/100 °C, Wertebereich: [-4000 bis 8500]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/barometer_v2_bricklet/<UID>/temperature[/<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_v2_bricklet/<UID>/temperature[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird periodisch ausgelöst abhängig von der mittels request/barometer_v2_bricklet/<UID>/set_temperature_callback_configuration gesetzten Konfiguration

Der Payload des Callbacks ist der gleiche wie request/barometer_v2_bricklet/<UID>/get_temperature.

Interne Funktionen

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.

request/barometer_v2_bricklet/<UID>/set_bootloader_mode
Anfrage:
  • mode – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • status – Typ: int, Wertebereich: Siehe Symbole

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 Symbole sind für diese Funktion verfügbar:

Für mode:

  • "bootloader" = 0
  • "firmware" = 1
  • "bootloader_wait_for_reboot" = 2
  • "firmware_wait_for_reboot" = 3
  • "firmware_wait_for_erase_and_reboot" = 4

Für status:

  • "ok" = 0
  • "invalid_mode" = 1
  • "no_change" = 2
  • "entry_function_not_present" = 3
  • "device_identifier_incorrect" = 4
  • "crc_mismatch" = 5
request/barometer_v2_bricklet/<UID>/get_bootloader_mode
Anfrage:
  • keine Nutzdaten
Antwort:
  • mode – Typ: int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe request/barometer_v2_bricklet/<UID>/set_bootloader_mode.

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

Für mode:

  • "bootloader" = 0
  • "firmware" = 1
  • "bootloader_wait_for_reboot" = 2
  • "firmware_wait_for_reboot" = 3
  • "firmware_wait_for_erase_and_reboot" = 4
request/barometer_v2_bricklet/<UID>/set_write_firmware_pointer
Anfrage:
  • pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

Setzt den Firmware-Pointer für request/barometer_v2_bricklet/<UID>/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.

request/barometer_v2_bricklet/<UID>/write_firmware
Anfrage:
  • data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Antwort:
  • status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von request/barometer_v2_bricklet/<UID>/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.

request/barometer_v2_bricklet/<UID>/write_uid
Anfrage:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine 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.

request/barometer_v2_bricklet/<UID>/read_uid
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.