Dies ist die Beschreibung des TCP/IP Protokolls 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 allgemeine Beschreibung der TCP/IP Protokollstruktur findet sich hier.
BrickletCO2V2.
get_all_values
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt alle Werte zurück, die das CO2 Bricklet 2.0 misst.
Wenn der Wert periodisch benötigt wird, kann auch der CALLBACK_ALL_VALUES
Callback
verwendet werden. Der Callback wird mit der Funktion
set_all_values_callback_configuration
konfiguriert.
Bemerkung
Der Sensor kann bis zu 120 °C messen, ist aber nur bis 70 °C spezifiziert. Das Bricklet kann permanent beschädigt werden, falls es höheren Temperaturen ausgesetzt wird.
BrickletCO2V2.
set_air_pressure
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
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.
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.
BrickletCO2V2.
get_air_pressure
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt den Umgebungs-Luftdruch zurück, wie von set_air_pressure
gesetzt.
BrickletCO2V2.
set_temperature_offset
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt ein Temperatur-Offset. 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.
BrickletCO2V2.
get_temperature_offset
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt das Temperatur-Offset zurück, wie mittels
set_temperature_offset
gesetzt.
BrickletCO2V2.
get_co2_concentration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die CO2-Konzentration zurück.
Wenn der Wert periodisch benötigt wird, kann auch der CALLBACK_CO2_CONCENTRATION
Callback
verwendet werden. Der Callback wird mit der Funktion
set_co2_concentration_callback_configuration
konfiguriert.
BrickletCO2V2.
get_temperature
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Temperatur zurück.
Bemerkung
Der Sensor kann bis zu 120 °C messen, ist aber nur bis 70 °C spezifiziert. Das Bricklet kann permanent beschädigt werden, falls es höheren Temperaturen ausgesetzt 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.
BrickletCO2V2.
get_humidity
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die relative Luftfeuchtigkeit zurück.
Wenn der Wert periodisch benötigt wird, kann auch der CALLBACK_HUMIDITY
Callback
verwendet werden. Der Callback wird mit der Funktion
set_humidity_callback_configuration
konfiguriert.
BrickletCO2V2.
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.
BrickletCO2V2.
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:
BrickletCO2V2.
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:
BrickletCO2V2.
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.
BrickletCO2V2.
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.
BrickletCO2V2.
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.
BrickletCO2V2.
set_all_values_callback_configuration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Die Periode ist die Periode mit der der CALLBACK_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.
BrickletCO2V2.
get_all_values_callback_configuration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Callback-Konfiguration zurück, wie mittels
set_all_values_callback_configuration
gesetzt.
BrickletCO2V2.
set_co2_concentration_callback_configuration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Die Periode ist die Periode mit der der CALLBACK_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 CALLBACK_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.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für option:
BrickletCO2V2.
get_co2_concentration_callback_configuration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Callback-Konfiguration zurück, wie mittels set_co2_concentration_callback_configuration
gesetzt.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für option:
BrickletCO2V2.
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:
BrickletCO2V2.
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:
BrickletCO2V2.
set_humidity_callback_configuration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Die Periode ist die Periode mit der der CALLBACK_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 CALLBACK_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.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für option:
BrickletCO2V2.
get_humidity_callback_configuration
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Callback-Konfiguration zurück, wie mittels set_humidity_callback_configuration
gesetzt.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für option:
BrickletCO2V2.
CALLBACK_ALL_VALUES
¶Funktions-ID: |
|
---|---|
Antwort: |
|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
set_all_values_callback_configuration
gesetzten Konfiguration
Die Rückgabewerte sind die gleichen wie get_all_values
.
Bemerkung
Der Sensor kann bis zu 120 °C messen, ist aber nur bis 70 °C spezifiziert. Das Bricklet kann permanent beschädigt werden, falls es höheren Temperaturen ausgesetzt wird.
BrickletCO2V2.
CALLBACK_CO2_CONCENTRATION
¶Funktions-ID: |
|
---|---|
Antwort: |
|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
set_co2_concentration_callback_configuration
gesetzten Konfiguration
Der Rückgabewert ist der gleiche wie get_co2_concentration
.
BrickletCO2V2.
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
.
BrickletCO2V2.
CALLBACK_HUMIDITY
¶Funktions-ID: |
|
---|---|
Antwort: |
|
Dieser Callback wird periodisch ausgelöst abhängig von der mittels
set_humidity_callback_configuration
gesetzten Konfiguration
Der Rückgabewert ist der gleiche wie get_humidity
.
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.
BrickletCO2V2.
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:
BrickletCO2V2.
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:
BrickletCO2V2.
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.
BrickletCO2V2.
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.
BrickletCO2V2.
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.
BrickletCO2V2.
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.