MQTT - UV Light Bricklet

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

setup:
    # Get current UV light
    subscribe to tinkerforge/response/uv_light_bricklet/XYZ/get_uv_light
    publish '' to tinkerforge/request/uv_light_bricklet/XYZ/get_uv_light

Callback

Download (example-callback.txt)

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

setup:
    # Handle incoming UV light callbacks
    subscribe to tinkerforge/callback/uv_light_bricklet/XYZ/uv_light
    publish '{"register": true}' to tinkerforge/register/uv_light_bricklet/XYZ/uv_light # Register uv_light callback

    # Set period for UV light callback to 1s (1000ms)
    # Note: The UV light callback is only called every second
    #       if the UV light has changed since the last call!
    publish '{"period": 1000}' to tinkerforge/request/uv_light_bricklet/XYZ/set_uv_light_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 UV Light Bricklet

setup:
    # Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    publish '{"debounce": 10000}' to tinkerforge/request/uv_light_bricklet/XYZ/set_debounce_period

    # Handle incoming UV light reached callbacks
    subscribe to tinkerforge/callback/uv_light_bricklet/XYZ/uv_light_reached
    publish '{"register": true}' to tinkerforge/register/uv_light_bricklet/XYZ/uv_light_reached # Register uv_light_reached callback

    # Configure threshold for UV light "greater than 75 mW/m²"
    publish '{"option": "greater", "min": 750, "max": 0}' to tinkerforge/request/uv_light_bricklet/XYZ/set_uv_light_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/uv_light_bricklet/<UID>/get_uv_light
Anfrage:
  • keine Nutzdaten
Antwort:
  • uv_light – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [0 bis 3280]

Gibt die UV-Licht-Intensität des Sensors zurück. Der Sensor hat die Intensität bereits mit dem Erythem-Wirkungsspektrum gewichtet, um die hautbeeinflussende Bestrahlungsstärke zu bestimmen.

Die Intensität kann dann einfach durch 250 geteilt werden um den UV Index zu bestimmen. Beispiel: Eine UV-Licht-Intensität von 500 entspricht einem UV Index von 2.

Wenn die Intensität periodisch abgefragt werden soll, wird empfohlen den register/uv_light_bricklet/<UID>/uv_light Callback zu nutzen und die Periode mit request/uv_light_bricklet/<UID>/set_uv_light_callback_period vorzugeben.

Fortgeschrittene Funktionen

request/uv_light_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 UV Light.

Konfigurationsfunktionen für Callbacks

request/uv_light_bricklet/<UID>/set_uv_light_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/uv_light_bricklet/<UID>/uv_light Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/uv_light_bricklet/<UID>/uv_light Callback wird nur ausgelöst, wenn sich die Intensität seit der letzten Auslösung geändert hat.

request/uv_light_bricklet/<UID>/get_uv_light_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/uv_light_bricklet/<UID>/set_uv_light_callback_period gesetzt.

request/uv_light_bricklet/<UID>/set_uv_light_callback_threshold
Anfrage:
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt den Schwellwert für den register/uv_light_bricklet/<UID>/uv_light_reached Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Intensität außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Intensität innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Intensität kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Intensität 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/uv_light_bricklet/<UID>/get_uv_light_callback_threshold
Anfrage:
  • keine Nutzdaten
Antwort:
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von request/uv_light_bricklet/<UID>/set_uv_light_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/uv_light_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 Callbacks

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

request/uv_light_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/uv_light_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/uv_light_bricklet/<UID>/uv_light
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • uv_light – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [0 bis 32800000]

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

Dieser Callback wird mit der Periode, wie gesetzt mit request/uv_light_bricklet/<UID>/set_uv_light_callback_period, ausgelöst. Der Payload des Callbacks ist die UV-Licht-Intensität des Sensors.

Der register/uv_light_bricklet/<UID>/uv_light Callback wird nur ausgelöst, wenn sich die Intensität seit der letzten Auslösung geändert hat.

register/uv_light_bricklet/<UID>/uv_light_reached
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • uv_light – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [0 bis 32800000]

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/uv_light_bricklet/<UID>/set_uv_light_callback_threshold gesetzt, erreicht wird. Der Payload des Callbacks ist die UV-Licht-Intensität des Sensors.

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