MQTT - CO2 Bricklet

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

setup:
    # Get current CO2 concentration
    subscribe to tinkerforge/response/co2_bricklet/XYZ/get_co2_concentration
    publish '' to tinkerforge/request/co2_bricklet/XYZ/get_co2_concentration

Callback

Download (example-callback.txt)

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

setup:
    # Handle incoming CO2 concentration callbacks
    subscribe to tinkerforge/callback/co2_bricklet/XYZ/co2_concentration
    publish '{"register": true}' to tinkerforge/register/co2_bricklet/XYZ/co2_concentration # Register co2_concentration callback
    
    # Set period for CO2 concentration callback to 1s (1000ms)
    # Note: The CO2 concentration callback is only called every second
    #       if the CO2 concentration has changed since the last call!
    publish '{"period": 1000}' to tinkerforge/request/co2_bricklet/XYZ/set_co2_concentration_callback_period

Threshold

Download (example-threshold.txt)

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

setup:
    # Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    publish '{"debounce": 10000}' to tinkerforge/request/co2_bricklet/XYZ/set_debounce_period
    
    # Handle incoming CO2 concentration reached callbacks
    subscribe to tinkerforge/callback/co2_bricklet/XYZ/co2_concentration_reached
    publish '{"register": true}' to tinkerforge/register/co2_bricklet/XYZ/co2_concentration_reached # Register co2_concentration_reached callback
    
    # Configure threshold for CO2 concentration "greater than 750 ppm"
    publish '{"option": "greater", "min": 750, "max": 0}' to tinkerforge/request/co2_bricklet/XYZ/set_co2_concentration_callback_threshold

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"-Attribut 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_bricklet/<UID>/get_co2_concentration
Response-Payload:
 
  • co2_concentration -- int

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 register/co2_bricklet/<UID>/co2_concentration Callback zu nutzen und die Periode mit request/co2_bricklet/<UID>/set_co2_concentration_callback_period vorzugeben.

Fortgeschrittene Funktionen

request/co2_bricklet/<UID>/get_identity
Response-Payload:
 
  • uid -- string
  • connected_uid -- string
  • position -- string
  • hardware_version -- [int,int,int]
  • firmware_version -- [int,int,int]
  • device_identifier -- int (hat Symbole)
  • _display_name -- 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.

Konfigurationsfunktionen für Callbacks

request/co2_bricklet/<UID>/set_co2_concentration_callback_period
Request-Payload:
 
  • period -- int

Setzt die Periode in ms mit welcher der register/co2_bricklet/<UID>/co2_concentration Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/co2_bricklet/<UID>/co2_concentration Callback wird nur ausgelöst wenn sich die CO2-Konzentration seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

request/co2_bricklet/<UID>/get_co2_concentration_callback_period
Response-Payload:
 
  • period -- int

Gibt die Periode zurück, wie von request/co2_bricklet/<UID>/set_co2_concentration_callback_period gesetzt.

request/co2_bricklet/<UID>/set_co2_concentration_callback_threshold
Request-Payload:
 
  • option -- string (hat Symbole)
  • min -- int
  • max -- int

Setzt den Schwellwert für den register/co2_bricklet/<UID>/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 Symbole sind für diese Funktion verfügbar:

für option:

  • "Off" = 'x'
  • "Outside" = 'o'
  • "Inside" = 'i'
  • "Smaller" = '<'
  • "Greater" = '>'
request/co2_bricklet/<UID>/get_co2_concentration_callback_threshold
Response-Payload:
 
  • option -- string (hat Symbole)
  • min -- int
  • max -- int

Gibt den Schwellwert zurück, wie von request/co2_bricklet/<UID>/set_co2_concentration_callback_threshold gesetzt.

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

für option:

  • "Off" = 'x'
  • "Outside" = 'o'
  • "Inside" = 'i'
  • "Smaller" = '<'
  • "Greater" = '>'
request/co2_bricklet/<UID>/set_debounce_period
Request-Payload:
 
  • debounce -- int

Setzt die Periode in ms mit welcher die Schwellwert Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

Der Standardwert ist 100.

request/co2_bricklet/<UID>/get_debounce_period
Response-Payload:
 
  • debounce -- int

Gibt die Entprellperiode zurück, wie von request/co2_bricklet/<UID>/set_debounce_period gesetzt.

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_bricklet/<UID>/co2_concentration
Request-Payload:
 
  • register -- bool
Response-Payload:
 
  • co2_concentration -- int

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

Dieser Callback wird mit der Periode, wie gesetzt mit request/co2_bricklet/<UID>/set_co2_concentration_callback_period, ausgelöst. Der Payload des Callbacks ist die gemessene CO2-Konzentration des Sensors.

Der register/co2_bricklet/<UID>/co2_concentration Callback wird nur ausgelöst wenn sich die CO2-Konzentration seit der letzten Auslösung geändert hat.

register/co2_bricklet/<UID>/co2_concentration_reached
Request-Payload:
 
  • register -- bool
Response-Payload:
 
  • co2_concentration -- int

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

Dieser Callback wird ausgelöst wenn der Schwellwert, wie von request/co2_bricklet/<UID>/set_co2_concentration_callback_threshold gesetzt, erreicht wird. Der Payload des Callbacks ist die gemessene CO2-Konzentration.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit request/co2_bricklet/<UID>/set_debounce_period gesetzt, ausgelöst.