Modbus - CO2 Bricklet

Dies ist die Beschreibung des Modbus 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 Modbus Protokollstruktur findet sich hier.

Grundfunktionen

BrickletCO2.get_co2_concentration
Funktions ID:

1

Anfrage:

keine Nutzdaten

Antwort:
  • co2_concentration -- uint16

Gibt die gemessene CO2-Konzentration zurück. Der Wert ist in ppm (Teile pro Million) und im Bereich von 0 bis 10000.

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 -- char[8]
  • connected_uid -- char[8]
  • position -- char
  • hardware_version -- uint8[3]
  • firmware_version -- uint8[3]
  • device_identifier -- uint16

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. 

Konfigurationsfunktionen für Callbacks

BrickletCO2.set_co2_concentration_callback_period
Funktions ID:

2

Anfrage:
  • period -- uint32
Antwort:

keine Antwort

Setzt die Periode in ms 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.

Der Standardwert ist 0.

BrickletCO2.get_co2_concentration_callback_period
Funktions ID:

3

Anfrage:

keine Nutzdaten

Antwort:
  • period -- uint32

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

BrickletCO2.set_co2_concentration_callback_threshold
Funktions ID:

4

Anfrage:
  • option -- char
  • min -- uint16
  • max -- uint16
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)

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

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

  • x: off, für option
  • o: outside, für option
  • i: inside, für option
  • <: smaller, für option
  • >: greater, für option
BrickletCO2.get_co2_concentration_callback_threshold
Funktions ID:

5

Anfrage:

keine Nutzdaten

Antwort:
  • option -- char
  • min -- uint16
  • max -- uint16

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

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

  • x: off, für option
  • o: outside, für option
  • i: inside, für option
  • <: smaller, für option
  • >: greater, für option
BrickletCO2.set_debounce_period
Funktions ID:

6

Anfrage:
  • debounce -- uint32
Antwort:

keine Antwort

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

BrickletCO2.get_debounce_period
Funktions ID:

7

Anfrage:

keine Nutzdaten

Antwort:
  • debounce -- uint32

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

Callbacks

BrickletCO2.CALLBACK_CO2_CONCENTRATION
Funktions ID:

8

Antwort:
  • co2_concentration -- uint16

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 -- uint16

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.