Spezifikationen / TCP/IP Protokoll / API / Bricks und Bricklets / Bricklets (Abgekündigt) / CO2 Bricklet

TCP/IP - CO2 Bricklet¶

Dies ist die Beschreibung des TCP/IP Protokolls für das CO2 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des CO2 Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API¶

Eine allgemeine Beschreibung der TCP/IP Protokollstruktur findet sich hier.

Grundfunktionen¶

BrickletCO2.get_co2_concentration¶

Funktions-ID:	1
Anfrage:	keine Nutzdaten
Antwort:	co2_concentration – Typ: uint16, Einheit: 1 ppm, Wertebereich: [0 bis 10000]

Gibt die gemessene CO2-Konzentration zurück.

Wenn die CO2-Konzentration periodisch abgefragt werden soll, wird empfohlen den CALLBACK_CO2_CONCENTRATION Callback zu nutzen und die Periode mit set_co2_concentration_callback_period vorzugeben.

Fortgeschrittene Funktionen¶

BrickletCO2.get_identity¶

Funktions-ID:	255
Anfrage:	keine Nutzdaten
Antwort:	uid – Typ: char[8] connected_uid – Typ: char[8] position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardware_version – Typ: uint8[3] 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] firmware_version – Typ: uint8[3] 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] device_identifier – Typ: uint16, Wertebereich: [0 bis 2¹⁶ - 1]

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.

Konfigurationsfunktionen für Callbacks¶

BrickletCO2.set_co2_concentration_callback_period¶

Funktions-ID:	2
Anfrage:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt die Periode mit welcher der CALLBACK_CO2_CONCENTRATION Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der CALLBACK_CO2_CONCENTRATION Callback wird nur ausgelöst, wenn sich die CO2-Konzentration seit der letzten Auslösung geändert hat.

BrickletCO2.get_co2_concentration_callback_period¶

Funktions-ID:	3
Anfrage:	keine Nutzdaten
Antwort:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

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

BrickletCO2.set_co2_concentration_callback_threshold¶

Funktions-ID:	4
Anfrage:	option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x' min – Typ: uint16, Einheit: 1 ppm, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max – Typ: uint16, Einheit: 1 ppm, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt den Schwellwert für den CALLBACK_CO2_CONCENTRATION_REACHED Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn die CO2-Konzentration außerhalb des min und max Wertes ist
'i'	Callback wird ausgelöst, wenn die CO2-Konzentration innerhalb des min und max Wertes ist
'<'	Callback wird ausgelöst, wenn die CO2-Konzentration kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die CO2-Konzentration größer als der min Wert ist (max wird ignoriert)

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

Für option:

'x' = Off
'o' = Outside
'i' = Inside
'<' = Smaller
'>' = Greater

BrickletCO2.get_co2_concentration_callback_threshold¶

Funktions-ID:	5
Anfrage:	keine Nutzdaten
Antwort:	option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x' min – Typ: uint16, Einheit: 1 ppm, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0 max – Typ: uint16, Einheit: 1 ppm, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 0

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

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

Für option:

'x' = Off
'o' = Outside
'i' = Inside
'<' = Smaller
'>' = Greater

BrickletCO2.set_debounce_period¶

Funktions-ID:	6
Anfrage:	debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100
Antwort:	keine Antwort

Setzt die Periode mit welcher die Schwellwert Callbacks

CALLBACK_CO2_CONCENTRATION_REACHED,

ausgelöst werden, wenn die Schwellwerte

set_co2_concentration_callback_threshold,

weiterhin erreicht bleiben.

BrickletCO2.get_debounce_period¶

Funktions-ID:	7
Anfrage:	keine Nutzdaten
Antwort:	debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 100

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

Callbacks¶

BrickletCO2.CALLBACK_CO2_CONCENTRATION¶

Funktions-ID:	8
Antwort:	co2_concentration – Typ: uint16, Einheit: 1 ppm, Wertebereich: [0 bis 10000]

Dieser Callback wird mit der Periode, wie gesetzt mit set_co2_concentration_callback_period, ausgelöst. Der Rückgabewert ist die gemessene CO2-Konzentration des Sensors.

Der CALLBACK_CO2_CONCENTRATION Callback wird nur ausgelöst, wenn sich die CO2-Konzentration seit der letzten Auslösung geändert hat.

BrickletCO2.CALLBACK_CO2_CONCENTRATION_REACHED¶

Funktions-ID:	9
Antwort:	co2_concentration – Typ: uint16, Einheit: 1 ppm, Wertebereich: [0 bis 10000]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set_co2_concentration_callback_threshold gesetzt, erreicht wird. Der Rückgabewert ist die gemessene CO2-Konzentration.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit set_debounce_period gesetzt, ausgelöst.