MQTT - Dust Detector Bricklet

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

setup:
    # Get current dust density
    subscribe to tinkerforge/response/dust_detector_bricklet/XYZ/get_dust_density
    publish '' to tinkerforge/request/dust_detector_bricklet/XYZ/get_dust_density

Callback

Download (example-callback.txt)

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

setup:
    # Handle incoming dust density callbacks
    subscribe to tinkerforge/callback/dust_detector_bricklet/XYZ/dust_density
    publish '{"register": true}' to tinkerforge/register/dust_detector_bricklet/XYZ/dust_density # Register dust_density callback
    
    # Set period for dust density callback to 1s (1000ms)
    # Note: The dust density callback is only called every second
    #       if the dust density has changed since the last call!
    publish '{"period": 1000}' to tinkerforge/request/dust_detector_bricklet/XYZ/set_dust_density_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 Dust Detector Bricklet

setup:
    # Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    publish '{"debounce": 10000}' to tinkerforge/request/dust-detector_bricklet/XYZ/set_debounce_period
    
    # Handle incoming dust density reached callbacks
    subscribe to tinkerforge/callback/dust_detector_bricklet/XYZ/dust_density_reached
    publish '{"register": true}' to tinkerforge/register/dust_detector_bricklet/XYZ/dust_density_reached # Register dust_density_reached callback
    
    # Configure threshold for dust density "greater than 10 µg/m³"
    publish '{"option": "greater", "min": 10, "max": 0}' to tinkerforge/request/dust_detector_bricklet/XYZ/set_dust_density_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-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/dust_detector_bricklet/<UID>/get_dust_density
Anfrage:
  • keine Nutzdaten
Antwort:
  • dust_density – Typ: int, Einheit: 1 µg/m³, Wertebereich: [0 bis 500]

Gibt die Staubdichte zurück.

Wenn die Staubdichte periodisch abgefragt werden soll, wird empfohlen den register/dust_detector_bricklet/<UID>/dust_density Callback zu nutzen und die Periode mit request/dust_detector_bricklet/<UID>/set_dust_density_callback_period vorzugeben.

Fortgeschrittene Funktionen

request/dust_detector_bricklet/<UID>/set_moving_average
Anfrage:
  • average – Typ: int, Wertebereich: [0 bis 100], Standardwert: 100
Antwort:
  • keine Antwort

Setzt die Länge eines gleitenden Mittelwerts für die Staubdichte.

Wenn die Länge auf 0 gesetzt wird, ist das Averaging komplett aus. Desto kleiner die Länge des Mittelwerts ist, desto mehr Rauschen ist auf den Daten.

request/dust_detector_bricklet/<UID>/get_moving_average
Anfrage:
  • keine Nutzdaten
Antwort:
  • average – Typ: int, Wertebereich: [0 bis 100], Standardwert: 100

Gibt die Länge des gleitenden Mittelwerts zurück, wie von request/dust_detector_bricklet/<UID>/set_moving_average gesetzt.

request/dust_detector_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, Wertebereich: ["a" bis "h", "i", "z"]
  • hardware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • firmware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, 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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

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 Dust Detector.

Konfigurationsfunktionen für Callbacks

request/dust_detector_bricklet/<UID>/set_dust_density_callback_period
Anfrage:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt die Periode mit welcher der register/dust_detector_bricklet/<UID>/dust_density Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/dust_detector_bricklet/<UID>/dust_density Callback wird nur ausgelöst, wenn sich die Staubdichte seit der letzten Auslösung geändert hat.

request/dust_detector_bricklet/<UID>/get_dust_density_callback_period
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

request/dust_detector_bricklet/<UID>/set_dust_density_callback_threshold
Anfrage:
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min – Typ: int, Einheit: 1 µg/m³, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 µg/m³, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt den Schwellwert für den register/dust_detector_bricklet/<UID>/dust_density_reached Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

  • "off" = "x"
  • "outside" = "o"
  • "inside" = "i"
  • "smaller" = "<"
  • "greater" = ">"
request/dust_detector_bricklet/<UID>/get_dust_density_callback_threshold
Anfrage:
  • keine Nutzdaten
Antwort:
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min – Typ: int, Einheit: 1 µg/m³, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1 µg/m³, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von request/dust_detector_bricklet/<UID>/set_dust_density_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/dust_detector_bricklet/<UID>/set_debounce_period
Anfrage:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Antwort:
  • keine Antwort

Setzt die Periode mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

request/dust_detector_bricklet/<UID>/get_debounce_period
Anfrage:
  • keine Nutzdaten
Antwort:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von request/dust_detector_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/dust_detector_bricklet/<UID>/dust_density
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • dust_density – Typ: int, Einheit: 1 µg/m³, Wertebereich: [0 bis 500]

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

Dieser Callback wird mit der Periode, wie gesetzt mit request/dust_detector_bricklet/<UID>/set_dust_density_callback_period, ausgelöst. Der Payload des Callbacks ist die Staubdichte des Sensors.

Der register/dust_detector_bricklet/<UID>/dust_density Callback wird nur ausgelöst, wenn sich die Staubdichte seit der letzten Auslösung geändert hat.

register/dust_detector_bricklet/<UID>/dust_density_reached
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • dust_density – Typ: int, Einheit: 1 µg/m³, Wertebereich: [0 bis 500]

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/dust_detector_bricklet/<UID>/set_dust_density_callback_threshold gesetzt, erreicht wird. Der Payload des Callbacks ist die Staubdichte des Sensors.

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