MQTT - UV Light Bricklet 2.0

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

Callback

Download (example-callback.txt)

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

setup:
    # Handle incoming UV index callbacks
    subscribe to tinkerforge/callback/uv_light_v2_bricklet/XYZ/uvi
    publish '{"register": true}' to tinkerforge/register/uv_light_v2_bricklet/XYZ/uvi # Register uvi callback

    # Set period for UVI callback to 1s (1000ms) without a threshold
    publish '{"period": 1000, "value_has_to_change": false, "option": "off", "min": 0, "max": 0}' to tinkerforge/request/uv_light_v2_bricklet/XYZ/set_uvi_callback_configuration

Threshold

Download (example-threshold.txt)

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

setup:
    # Handle incoming UV index callbacks
    subscribe to tinkerforge/callback/uv_light_v2_bricklet/XYZ/uvi
    publish '{"register": true}' to tinkerforge/register/uv_light_v2_bricklet/XYZ/uvi # Register uvi callback

    # Configure threshold for UV index "greater than 3"
    # with a debounce period of 1s (1000ms)
    publish '{"period": 1000, "value_has_to_change": false, "option": "greater", "min": 30, "max": 0}' to tinkerforge/request/uv_light_v2_bricklet/XYZ/set_uvi_callback_configuration

Simple

Download (example-simple.txt)

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

setup:
    # Get current UV-A
    subscribe to tinkerforge/response/uv_light_v2_bricklet/XYZ/get_uva
    publish '' to tinkerforge/request/uv_light_v2_bricklet/XYZ/get_uva

    # Get current UV-B
    subscribe to tinkerforge/response/uv_light_v2_bricklet/XYZ/get_uvb
    publish '' to tinkerforge/request/uv_light_v2_bricklet/XYZ/get_uvb

    # Get current UV index
    subscribe to tinkerforge/response/uv_light_v2_bricklet/XYZ/get_uvi
    publish '' to tinkerforge/request/uv_light_v2_bricklet/XYZ/get_uvi

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_v2_bricklet/<UID>/get_uva
Anfrage:
  • keine Nutzdaten
Antwort:
  • uva – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [-1 bis 231 - 1]

Gibt die UVA Intensität des Sensors zurück. Der Sensor hat die Intensität nicht mit dem Erythem-Wirkungsspektrum gewichtet, daher handelt es sich nicht um die hautbeeinflussende Bestrahlungsstärke. Der Wert kann nicht einfach durch 250 geteilt werden, um den UVA Index zu bestimmen. Um den UV Index zu bestimmen kann request/uv_light_v2_bricklet/<UID>/get_uvi verwendet werden.

Falls der Sensor gesättigt (saturated) ist, dann wird -1 zurückgegeben, siehe request/uv_light_v2_bricklet/<UID>/set_configuration.

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

Wenn der Wert periodisch benötigt wird, kann auch der register/uv_light_v2_bricklet/<UID>/uva Callback verwendet werden. Der Callback wird mit der Funktion request/uv_light_v2_bricklet/<UID>/set_uva_callback_configuration konfiguriert.

request/uv_light_v2_bricklet/<UID>/get_uvb
Anfrage:
  • keine Nutzdaten
Antwort:
  • uvb – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [-1 bis 231 - 1]

Gibt die UVB Intensität des Sensors zurück. Der Sensor hat die Intensität nicht mit dem Erythem-Wirkungsspektrum gewichtet, daher handelt es sich nicht um die hautbeeinflussende Bestrahlungsstärke. Der Wert kann nicht einfach durch 250 geteilt werde, um den UVB Index zu bestimmen. Um den UV Index zu bestimmen kann request/uv_light_v2_bricklet/<UID>/get_uvi verwendet werden.

Falls der Sensor gesättigt (saturated) ist, dann wird -1 zurückgegeben, siehe request/uv_light_v2_bricklet/<UID>/set_configuration.

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

Wenn der Wert periodisch benötigt wird, kann auch der register/uv_light_v2_bricklet/<UID>/uvb Callback verwendet werden. Der Callback wird mit der Funktion request/uv_light_v2_bricklet/<UID>/set_uvb_callback_configuration konfiguriert.

request/uv_light_v2_bricklet/<UID>/get_uvi
Anfrage:
  • keine Nutzdaten
Antwort:
  • uvi – Typ: int, Einheit: 1/10 , Wertebereich: [-1 bis 231 - 1]

Gibt den UV Index des Sensors in 1/10 zurück.

Falls der Sensor gesättigt (saturated) ist, dann wird -1 zurückgegeben, siehe request/uv_light_v2_bricklet/<UID>/set_configuration.

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

Wenn der Wert periodisch benötigt wird, kann auch der register/uv_light_v2_bricklet/<UID>/uvi Callback verwendet werden. Der Callback wird mit der Funktion request/uv_light_v2_bricklet/<UID>/set_uvi_callback_configuration konfiguriert.

Fortgeschrittene Funktionen

request/uv_light_v2_bricklet/<UID>/set_configuration
Anfrage:
  • integration_time – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
Antwort:
  • keine Antwort

Setzt die Konfiguration des Sensors. Die Integrationszeit kann zwischen 50 und 800 ms eingestellt werden. Mit einer kürzeren Integrationszeit wird der Sensorwert öfter aktualisiert, beinhaltet aber mehr Rauschen. Mit einer längeren Integrationszeit wird das Rauschen verringert aber der Sensorwert wird nicht so oft aktualisiert.

Mit einer längeren Integrationszeit (ins besondere 800 ms) und einer höheren UV Intensität kann der Sensor gesättigt (saturated) sein. Falls dies auftritt dann sind die UVA/UVB/UVI Messwerte alle -1. In diesem Fall muss eine kürzere Integrationszeit gewählt werden.

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

Für integration_time:

  • "50ms" = 0
  • "100ms" = 1
  • "200ms" = 2
  • "400ms" = 3
  • "800ms" = 4
request/uv_light_v2_bricklet/<UID>/get_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • integration_time – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von request/uv_light_v2_bricklet/<UID>/set_configuration gesetzt.

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

Für integration_time:

  • "50ms" = 0
  • "100ms" = 1
  • "200ms" = 2
  • "400ms" = 3
  • "800ms" = 4
request/uv_light_v2_bricklet/<UID>/get_spitfp_error_count
Anfrage:
  • keine Nutzdaten
Antwort:
  • error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1]
  • error_count_overflow – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

request/uv_light_v2_bricklet/<UID>/set_status_led_config
Anfrage:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
Antwort:
  • keine Antwort

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für config:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_status" = 3
request/uv_light_v2_bricklet/<UID>/get_status_led_config
Anfrage:
  • keine Nutzdaten
Antwort:
  • config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von request/uv_light_v2_bricklet/<UID>/set_status_led_config gesetzt.

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

Für config:

  • "off" = 0
  • "on" = 1
  • "show_heartbeat" = 2
  • "show_status" = 3
request/uv_light_v2_bricklet/<UID>/get_chip_temperature
Anfrage:
  • keine Nutzdaten
Antwort:
  • temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

request/uv_light_v2_bricklet/<UID>/reset
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

request/uv_light_v2_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", "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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein 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 2.0.

Konfigurationsfunktionen für Callbacks

request/uv_light_v2_bricklet/<UID>/set_uva_callback_configuration
Anfrage:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Die Periode ist die Periode mit der der register/uv_light_v2_bricklet/<UID>/uva Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den register/uv_light_v2_bricklet/<UID>/uva Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

  • "off" = "x"
  • "outside" = "o"
  • "inside" = "i"
  • "smaller" = "<"
  • "greater" = ">"
request/uv_light_v2_bricklet/<UID>/get_uva_callback_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels request/uv_light_v2_bricklet/<UID>/set_uva_callback_configuration 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_v2_bricklet/<UID>/set_uvb_callback_configuration
Anfrage:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Die Periode ist die Periode mit der der register/uv_light_v2_bricklet/<UID>/uvb Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den register/uv_light_v2_bricklet/<UID>/uvb Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

  • "off" = "x"
  • "outside" = "o"
  • "inside" = "i"
  • "smaller" = "<"
  • "greater" = ">"
request/uv_light_v2_bricklet/<UID>/get_uvb_callback_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels request/uv_light_v2_bricklet/<UID>/set_uvb_callback_configuration 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_v2_bricklet/<UID>/set_uvi_callback_configuration
Anfrage:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min – Typ: int, Einheit: 1/10 , Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1/10 , Wertebereich: [-231 bis 231 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Die Periode ist die Periode mit der der register/uv_light_v2_bricklet/<UID>/uvi Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den register/uv_light_v2_bricklet/<UID>/uvi Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

  • "off" = "x"
  • "outside" = "o"
  • "inside" = "i"
  • "smaller" = "<"
  • "greater" = ">"
request/uv_light_v2_bricklet/<UID>/get_uvi_callback_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • value_has_to_change – Typ: bool, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min – Typ: int, Einheit: 1/10 , Wertebereich: [-231 bis 231 - 1], Standardwert: 0
  • max – Typ: int, Einheit: 1/10 , Wertebereich: [-231 bis 231 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels request/uv_light_v2_bricklet/<UID>/set_uvi_callback_configuration gesetzt.

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

Für option:

  • "off" = "x"
  • "outside" = "o"
  • "inside" = "i"
  • "smaller" = "<"
  • "greater" = ">"

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_v2_bricklet/<UID>/uva
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • uva – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [-1 bis 231 - 1]

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

Dieser Callback wird periodisch ausgelöst abhängig von der mittels request/uv_light_v2_bricklet/<UID>/set_uva_callback_configuration gesetzten Konfiguration

Der Payload des Callbacks ist der gleiche wie request/uv_light_v2_bricklet/<UID>/get_uva.

register/uv_light_v2_bricklet/<UID>/uvb
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • uvb – Typ: int, Einheit: 1/10 mW/m², Wertebereich: [-1 bis 231 - 1]

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

Dieser Callback wird periodisch ausgelöst abhängig von der mittels request/uv_light_v2_bricklet/<UID>/set_uvb_callback_configuration gesetzten Konfiguration

Der Payload des Callbacks ist der gleiche wie request/uv_light_v2_bricklet/<UID>/get_uvb.

register/uv_light_v2_bricklet/<UID>/uvi
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • uvi – Typ: int, Einheit: 1/10 , Wertebereich: [-1 bis 231 - 1]

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

Dieser Callback wird periodisch ausgelöst abhängig von der mittels request/uv_light_v2_bricklet/<UID>/set_uvi_callback_configuration gesetzten Konfiguration

Der Payload des Callbacks ist der gleiche wie request/uv_light_v2_bricklet/<UID>/get_uvi.

Interne Funktionen

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

request/uv_light_v2_bricklet/<UID>/set_bootloader_mode
Anfrage:
  • mode – Typ: int, Wertebereich: Siehe Symbole
Antwort:
  • status – Typ: int, Wertebereich: Siehe Symbole

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Für mode:

  • "bootloader" = 0
  • "firmware" = 1
  • "bootloader_wait_for_reboot" = 2
  • "firmware_wait_for_reboot" = 3
  • "firmware_wait_for_erase_and_reboot" = 4

Für status:

  • "ok" = 0
  • "invalid_mode" = 1
  • "no_change" = 2
  • "entry_function_not_present" = 3
  • "device_identifier_incorrect" = 4
  • "crc_mismatch" = 5
request/uv_light_v2_bricklet/<UID>/get_bootloader_mode
Anfrage:
  • keine Nutzdaten
Antwort:
  • mode – Typ: int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe request/uv_light_v2_bricklet/<UID>/set_bootloader_mode.

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

Für mode:

  • "bootloader" = 0
  • "firmware" = 1
  • "bootloader_wait_for_reboot" = 2
  • "firmware_wait_for_reboot" = 3
  • "firmware_wait_for_erase_and_reboot" = 4
request/uv_light_v2_bricklet/<UID>/set_write_firmware_pointer
Anfrage:
  • pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

Setzt den Firmware-Pointer für request/uv_light_v2_bricklet/<UID>/write_firmware. Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

request/uv_light_v2_bricklet/<UID>/write_firmware
Anfrage:
  • data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Antwort:
  • status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von request/uv_light_v2_bricklet/<UID>/set_write_firmware_pointer gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

request/uv_light_v2_bricklet/<UID>/write_uid
Anfrage:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]
Antwort:
  • keine Antwort

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

request/uv_light_v2_bricklet/<UID>/read_uid
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: int, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.