MQTT - Moisture Bricklet

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

setup:
    # Get current moisture value
    subscribe to tinkerforge/response/moisture_bricklet/XYZ/get_moisture_value
    publish '' to tinkerforge/request/moisture_bricklet/XYZ/get_moisture_value

Callback

Download (example-callback.txt)

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

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

setup:
    # Get threshold callbacks with a debounce time of 1 second (1000ms)
    publish '{"debounce": 1000}' to tinkerforge/request/moisture_bricklet/XYZ/set_debounce_period
    
    # Handle incoming moisture value reached callbacks
    subscribe to tinkerforge/callback/moisture_bricklet/XYZ/moisture_reached
    publish '{"register": true}' to tinkerforge/register/moisture_bricklet/XYZ/moisture_reached # Register moisture_reached callback
    
    # Configure threshold for moisture value "greater than 200"
    publish '{"option": "greater", "min": 200, "max": 0}' to tinkerforge/request/moisture_bricklet/XYZ/set_moisture_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/moisture_bricklet/<UID>/get_moisture_value
Response-Payload:
  • moisture -- int

Gibt den aktuellen Feuchtigkeitswert zurück. Der Wert hat einen Wertebereich von 0 bis 4095. Ein kleiner Wert entspricht einer geringen Feuchtigkeit, ein großer Wert entspricht einer hohen Feuchtigkeit.

Wenn der Feuchtigkeitswert periodisch abgefragt werden soll, wird empfohlen den register/moisture_bricklet/<UID>/moisture Callback zu nutzen und die Periode mit request/moisture_bricklet/<UID>/set_moisture_callback_period vorzugeben.

Fortgeschrittene Funktionen

request/moisture_bricklet/<UID>/set_moving_average
Request-Payload:
  • average -- int

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

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.

Der Wertebereich liegt bei 0-100.

Der Standardwert ist 100.

request/moisture_bricklet/<UID>/get_moving_average
Response-Payload:
  • average -- int

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

request/moisture_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 Moisture.

Konfigurationsfunktionen für Callbacks

request/moisture_bricklet/<UID>/set_moisture_callback_period
Request-Payload:
  • period -- int

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

Der register/moisture_bricklet/<UID>/moisture Callback wird nur ausgelöst, wenn sich der Feuchtigkeitswert seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

request/moisture_bricklet/<UID>/get_moisture_callback_period
Response-Payload:
  • period -- int

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

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

Setzt den Schwellwert für den register/moisture_bricklet/<UID>/moisture_reached Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn der Feuchtigkeitswert außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn der Feuchtigkeitswert innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn der Feuchtigkeitswert kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn der Feuchtigkeitswert 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/moisture_bricklet/<UID>/get_moisture_callback_threshold
Response-Payload:
  • option -- string (hat Symbole)
  • min -- int
  • max -- int

Gibt den Schwellwert zurück, wie von request/moisture_bricklet/<UID>/set_moisture_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/moisture_bricklet/<UID>/set_debounce_period
Request-Payload:
  • debounce -- int

Setzt die Periode in ms mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

Der Standardwert ist 100.

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

Gibt die Entprellperiode zurück, wie von request/moisture_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/moisture_bricklet/<UID>/moisture
Request-Payload:
  • register -- bool
Response-Payload:
  • moisture -- int

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

Dieser Callback wird mit der Periode, wie gesetzt mit request/moisture_bricklet/<UID>/set_moisture_callback_period, ausgelöst. Der Payload des Callbacks ist der Feuchtigkeitswert des Sensors.

The register/moisture_bricklet/<UID>/moisture Callback wird nur ausgelöst, wenn sich der Feuchtigkeitswert seit der letzten Auslösung geändert hat.

register/moisture_bricklet/<UID>/moisture_reached
Request-Payload:
  • register -- bool
Response-Payload:
  • moisture -- int

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

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

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