MQTT - CO2 Bricklet 2.0

Dies ist die Beschreibung der MQTT API Bindings für das CO2 Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des CO2 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).

Simple

Download (example-simple.txt)

1
2
3
4
5
6
# Change XYZ to the UID of your CO2 Bricklet 2.0

setup:
    # Get current all values
    subscribe to tinkerforge/response/co2_v2_bricklet/XYZ/get_all_values
    publish '' to tinkerforge/request/co2_v2_bricklet/XYZ/get_all_values

Callback

Download (example-callback.txt)

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

setup:
    # Handle incoming all values callbacks
    subscribe to tinkerforge/callback/co2_v2_bricklet/XYZ/all_values
    publish '{"register": true}' to tinkerforge/register/co2_v2_bricklet/XYZ/all_values # Register all_values callback
    
    # Set period for all values callback to 1s (1000ms)
    publish '{"period": 1000, "value_has_to_change": false}' to tinkerforge/request/co2_v2_bricklet/XYZ/set_all_values_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/co2_v2_bricklet/<UID>/get_all_values
Anfrage:
  • keine Nutzdaten
Antwort:
  • co2_concentration – Typ: int, Wertebereich: [0 bis 216 - 1]
  • temperature – Typ: int, Wertebereich: [-215 bis 215 - 1]
  • humidity – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt alle Werte zurück, die das CO2 Bricklet 2.0 misst. Diese Werte umfassen: CO2-Konzentration (in ppm), Temperatur (in 0,01 °C) und Luftfeuchte (in 0,01 %RH).

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

request/co2_v2_bricklet/<UID>/set_air_pressure
Anfrage:
  • air_pressure – Typ: int, Wertebereich: [0 bis 216 - 1]
Antwort:
  • keine Antwort

Die CO2-Konzentration hängt (unter anderem) vom Umgebungs-Luftdruck ab.

Um die Genauigkeit des CO2 Bricklet 2.0 zu verbessern ist es möglich den aktuellen Luftdruck zu setzen. Dazu kann das Barometer Bricklet 2.0 oder auch das Air Quality Bricklet genutzt werden.

Die erwartete Einheit des Umgebungs-Luftdrucks ist mbar.

Standardmäßig ist die Luftdruck-Kompensation deaktiviert. Sobald ein Wert gesetzt wird, wird dieser zur Kompensation verwendet. Die Kompensation kann wieder ausgestellt werden in dem der Wert zurück auf 0 gesetzt wird.

Es ist hinreichend den Wert alle paar Minuten zu aktualisieren.

request/co2_v2_bricklet/<UID>/get_air_pressure
Anfrage:
  • keine Nutzdaten
Antwort:
  • air_pressure – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt den Umgebungs-Luftdruch zurück, wie von request/co2_v2_bricklet/<UID>/set_air_pressure gesetzt.

request/co2_v2_bricklet/<UID>/set_temperature_offset
Anfrage:
  • offset – Typ: int, Wertebereich: [0 bis 216 - 1]
Antwort:
  • keine Antwort

Setzt ein Temperatur-Offset mit Auflösung 1/100°C. Ein Offset von 10 verringert die gemessene Temperatur um 0,1°C.

Wenn das Bricklet in einem Gehäuse verbaut wird, aber die Umgebungstemperatur außerhalb des Gehäuses gemessen werden soll, dann muss vom gemessenen Temperatur ein bestimmter Wert abgezogen werden, um den Messfehler durch das Aufheizen des Gehäuses zu kompensieren.

Wir empfehlen den Messaufbau im Gehäuse mindestens 24 Stunden laufen zu lassen, damit sich ein Temperaturgleichgewicht einstellt. Danach muss die Temperatur außerhalb des Gehäuses gemessen werden und die Differenz zur Temperatur innerhalb des Gehäuses als Offset eingestellt werden.

Dieses Temperatur-Offset geht in die Berechnung der Luftfeuchte und der CO2-Konzentration mit ein. Um die Genauigkeit der Messwerte innerhalb eines Gehäuses zu verbessern sollte der Temperatur-Offset bestimmt und eingestellt werden.

Es ist hinreichend den Temperatur-Offset einmal zu setzen. Der Offset wird in einem nicht-flüchtigen Speicher gespeichert und auch nach einem Neustart wieder angewendet.

request/co2_v2_bricklet/<UID>/get_temperature_offset
Anfrage:
  • keine Nutzdaten
Antwort:
  • offset – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt das Temperatur-Offset zurück, wie mittels request/co2_v2_bricklet/<UID>/set_temperature_offset gesetzt.

request/co2_v2_bricklet/<UID>/get_co2_concentration
Anfrage:
  • keine Nutzdaten
Antwort:
  • co2_concentration – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die CO2-Konzentration in ppm zurück.

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

request/co2_v2_bricklet/<UID>/get_temperature
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur in 0,01 °C Schritten zurück.

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

request/co2_v2_bricklet/<UID>/get_humidity
Anfrage:
  • keine Nutzdaten
Antwort:
  • humidity – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die relative Luftfeuchtigkeit in 0,01 %RH Schritten zurück.

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

Fortgeschrittene Funktionen

request/co2_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/co2_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 Bootlodaer- 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
  • "BootloaderWaitForReboot" = 2
  • "FirmwareWaitForReboot" = 3
  • "FirmwareWaitForEraseAndReboot" = 4

Für status:

  • "OK" = 0
  • "InvalidMode" = 1
  • "NoChange" = 2
  • "EntryFunctionNotPresent" = 3
  • "DeviceIdentifierIncorrect" = 4
  • "CRCMismatch" = 5
request/co2_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/co2_v2_bricklet/<UID>/set_bootloader_mode.

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

Für mode:

  • "Bootloader" = 0
  • "Firmware" = 1
  • "BootloaderWaitForReboot" = 2
  • "FirmwareWaitForReboot" = 3
  • "FirmwareWaitForEraseAndReboot" = 4
request/co2_v2_bricklet/<UID>/set_write_firmware_pointer
Anfrage:
  • pointer – Typ: int, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

Setzt den Firmware-Pointer für request/co2_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/co2_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/co2_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/co2_v2_bricklet/<UID>/set_status_led_config
Anfrage:
  • config – Typ: int, Wertebereich: Siehe Symbole
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
  • "ShowHeartbeat" = 2
  • "ShowStatus" = 3
request/co2_v2_bricklet/<UID>/get_status_led_config
Anfrage:
  • keine Nutzdaten
Antwort:
  • config – Typ: int, Wertebereich: Siehe Symbole

Gibt die Konfiguration zurück, wie von request/co2_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
  • "ShowHeartbeat" = 2
  • "ShowStatus" = 3
request/co2_v2_bricklet/<UID>/get_chip_temperature
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur in °C, 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/co2_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/co2_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/co2_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.

request/co2_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
  • hardware_version – Typ: [int, ...], Länge: 3, Wertebereich: [0 bis 255]
  • firmware_version – Typ: [int, ...], Länge: 3, 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 kann 'a', 'b', 'c' oder 'd' sein.

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 CO2 2.0.

Konfigurationsfunktionen für Callbacks

request/co2_v2_bricklet/<UID>/set_all_values_callback_configuration
Anfrage:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
Antwort:
  • keine Antwort

Die Periode ist die Periode mit der der register/co2_v2_bricklet/<UID>/all_values 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 sich mindestens ein Wert im Vergleich zum letzten mal geändert hat. Ändert sich kein Wert innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn ein 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 der Werte.

request/co2_v2_bricklet/<UID>/get_all_values_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

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

request/co2_v2_bricklet/<UID>/set_co2_concentration_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, Wertebereich: [0 bis 216 - 1]
  • max – Typ: int, Wertebereich: [0 bis 216 - 1]
Antwort:
  • keine Antwort

Die Periode ist die Periode mit der der register/co2_v2_bricklet/<UID>/co2_concentration 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/co2_v2_bricklet/<UID>/co2_concentration 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.

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

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

Für option:

  • "Off" = "x"
  • "Outside" = "o"
  • "Inside" = "i"
  • "Smaller" = "<"
  • "Greater" = ">"
request/co2_v2_bricklet/<UID>/get_co2_concentration_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, Wertebereich: [0 bis 216 - 1]
  • max – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die Callback-Konfiguration zurück, wie mittels request/co2_v2_bricklet/<UID>/set_co2_concentration_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/co2_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, Wertebereich: [-215 bis 215 - 1]
  • max – Typ: int, Wertebereich: [-215 bis 215 - 1]
Antwort:
  • keine Antwort

Die Periode ist die Periode mit der der register/co2_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/co2_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.

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

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

Für option:

  • "Off" = "x"
  • "Outside" = "o"
  • "Inside" = "i"
  • "Smaller" = "<"
  • "Greater" = ">"
request/co2_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, Wertebereich: [-215 bis 215 - 1]
  • max – Typ: int, Wertebereich: [-215 bis 215 - 1]

Gibt die Callback-Konfiguration zurück, wie mittels request/co2_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" = ">"
request/co2_v2_bricklet/<UID>/set_humidity_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, Wertebereich: [0 bis 216 - 1]
  • max – Typ: int, Wertebereich: [0 bis 216 - 1]
Antwort:
  • keine Antwort

Die Periode ist die Periode mit der der register/co2_v2_bricklet/<UID>/humidity 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/co2_v2_bricklet/<UID>/humidity 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.

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

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

Für option:

  • "Off" = "x"
  • "Outside" = "o"
  • "Inside" = "i"
  • "Smaller" = "<"
  • "Greater" = ">"
request/co2_v2_bricklet/<UID>/get_humidity_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, Wertebereich: [0 bis 216 - 1]
  • max – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die Callback-Konfiguration zurück, wie mittels request/co2_v2_bricklet/<UID>/set_humidity_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/co2_v2_bricklet/<UID>/all_values
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • co2_concentration – Typ: int, Wertebereich: [0 bis 216 - 1]
  • temperature – Typ: int, Wertebereich: [-215 bis 215 - 1]
  • humidity – Typ: int, Wertebereich: [0 bis 216 - 1]

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

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

Die Payload-Member des Callbacks sind die gleichen wie request/co2_v2_bricklet/<UID>/get_all_values.

register/co2_v2_bricklet/<UID>/co2_concentration
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • co2_concentration – Typ: int, Wertebereich: [0 bis 216 - 1]

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

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

Der Payload des Callbacks ist der gleiche wie request/co2_v2_bricklet/<UID>/get_co2_concentration.

register/co2_v2_bricklet/<UID>/temperature
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • temperature – Typ: int, Wertebereich: [-215 bis 215 - 1]

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

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

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

register/co2_v2_bricklet/<UID>/humidity
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • humidity – Typ: int, Wertebereich: [0 bis 216 - 1]

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

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

Der Payload des Callbacks ist der gleiche wie request/co2_v2_bricklet/<UID>/get_humidity.