MQTT - Ambient Light Bricklet 2.0

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

Simple

Download (example-simple.txt)

1
2
3
4
5
6
# Change XYZ to the UID of your Ambient Light Bricklet 2.0

setup:
    # Get current illuminance
    subscribe to tinkerforge/response/ambient_light_v2_bricklet/XYZ/get_illuminance
    publish '' to tinkerforge/request/ambient_light_v2_bricklet/XYZ/get_illuminance

Callback

Download (example-callback.txt)

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

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

setup:
    # Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    publish '{"debounce": 10000}' to tinkerforge/request/ambient-light-v2_bricklet/XYZ/set_debounce_period
    
    # Handle incoming illuminance reached callbacks
    subscribe to tinkerforge/callback/ambient_light_v2_bricklet/XYZ/illuminance_reached
    publish '{"register": true}' to tinkerforge/register/ambient_light_v2_bricklet/XYZ/illuminance_reached # Register illuminance_reached callback
    
    # Configure threshold for illuminance "greater than 500 lx"
    publish '{"option": "greater", "min": 50000, "max": 0}' to tinkerforge/request/ambient_light_v2_bricklet/XYZ/set_illuminance_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/ambient_light_v2_bricklet/<UID>/get_illuminance
Response-Payload:
 
  • illuminance -- int

Gibt die Beleuchtungsstärke des Umgebungslichtsensors zurück. Der Messbereich erstreckt sich bis über 100000Lux, aber ab 64000Lux nimmt die Messgenauigkeit ab. Die Beleuchtungsstärke ist in Lux/100 angegeben, d.h. bei einem Wert von 450000 wurde eine Beleuchtungsstärke von 4500Lux gemessen.

Geändert in Version 2.0.2 (Plugin): Eine Beleuchtungsstärke von 0Lux bedeutet, dass der Sensor gesättigt (saturated) ist und die Konfiguration angepasst werden sollte, siehe request/ambient_light_v2_bricklet/<UID>/set_configuration.

Wenn die Beleuchtungsstärke periodisch abgefragt werden soll, wird empfohlen den register/ambient_light_v2_bricklet/<UID>/illuminance Callback zu nutzen und die Periode mit request/ambient_light_v2_bricklet/<UID>/set_illuminance_callback_period vorzugeben.

Fortgeschrittene Funktionen

request/ambient_light_v2_bricklet/<UID>/set_configuration
Request-Payload:
 
  • illuminance_range -- int (hat Symbole)
  • integration_time -- int (hat Symbole)

Setzt die Konfiguration. Es ist möglich den Helligkeitswertebereich zwischen 0-600Lux und 0-64000Lux sowie eine Integrationszeit zwischen 50ms und 400ms zu konfigurieren.

Neu in Version 2.0.2 (Plugin): Der unbeschränkt (unlimited) Helligkeitswertebereich ermöglicht es bis über 100000Lux zu messen, aber ab 64000Lux nimmt die Messgenauigkeit ab.

Ein kleinerer Helligkeitswertebereich erhöht die Auflösung der Daten. Eine längere Integrationszeit verringert das Rauschen auf den Daten.

Geändert in Version 2.0.2 (Plugin): Wenn der eigentliche Messwert außerhalb des eingestellten Helligkeitswertebereichs liegt, dann geben request/ambient_light_v2_bricklet/<UID>/get_illuminance und der register/ambient_light_v2_bricklet/<UID>/illuminance Callback das Maximum des eingestellten Helligkeitswertebereichs +0,01Lux zurück. Also z.B. 800001 für den 0-8000Lux Bereich.

Geändert in Version 2.0.2 (Plugin): Bei einer langen Integrationszeit kann es sein, dass der Sensor gesättigt (saturated) ist bevor der Messwert das Maximum des ausgewählten Helligkeitswertebereichs erreicht hat. In diesem Fall geben request/ambient_light_v2_bricklet/<UID>/get_illuminance und der register/ambient_light_v2_bricklet/<UID>/illuminance Callback 0Lux zurück.

Wenn der Messwert außerhalb des eingestellten Helligkeitswertebereichs liegt oder der Sensor gesättigt ist, dann sollte der nächst höhere Helligkeitswertebereich eingestellt werden. Wenn der höchste Helligkeitswertebereich schon erreicht ist, dann kann noch die Integrationszeit verringert werden.

Die Standardwerte sind 0-8000Lux Helligkeitsbereich und 200ms Integrationszeit.

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

für illuminance_range:

  • "Unlimited" = 6
  • "64000Lux" = 0
  • "32000Lux" = 1
  • "16000Lux" = 2
  • "8000Lux" = 3
  • "1300Lux" = 4
  • "600Lux" = 5

für integration_time:

  • "50ms" = 0
  • "100ms" = 1
  • "150ms" = 2
  • "200ms" = 3
  • "250ms" = 4
  • "300ms" = 5
  • "350ms" = 6
  • "400ms" = 7
request/ambient_light_v2_bricklet/<UID>/get_configuration
Response-Payload:
 
  • illuminance_range -- int (hat Symbole)
  • integration_time -- int (hat Symbole)

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

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

für illuminance_range:

  • "Unlimited" = 6
  • "64000Lux" = 0
  • "32000Lux" = 1
  • "16000Lux" = 2
  • "8000Lux" = 3
  • "1300Lux" = 4
  • "600Lux" = 5

für integration_time:

  • "50ms" = 0
  • "100ms" = 1
  • "150ms" = 2
  • "200ms" = 3
  • "250ms" = 4
  • "300ms" = 5
  • "350ms" = 6
  • "400ms" = 7
request/ambient_light_v2_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 Ambient Light 2.0.

Konfigurationsfunktionen für Callbacks

request/ambient_light_v2_bricklet/<UID>/set_illuminance_callback_period
Request-Payload:
 
  • period -- int

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

Der register/ambient_light_v2_bricklet/<UID>/illuminance Callback wird nur ausgelöst, wenn sich die Beleuchtungsstärke seit der letzten Auslösung geändert hat.

Der Standardwert ist 0.

request/ambient_light_v2_bricklet/<UID>/get_illuminance_callback_period
Response-Payload:
 
  • period -- int

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

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

Setzt den Schwellwert für den register/ambient_light_v2_bricklet/<UID>/illuminance_reached Callback.

Die folgenden Optionen sind möglich:

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

Gibt den Schwellwert zurück, wie von request/ambient_light_v2_bricklet/<UID>/set_illuminance_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/ambient_light_v2_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/ambient_light_v2_bricklet/<UID>/get_debounce_period
Response-Payload:
 
  • debounce -- int

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

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

Dieser Callback wird mit der Periode, wie gesetzt mit request/ambient_light_v2_bricklet/<UID>/set_illuminance_callback_period, ausgelöst. Der Payload des Callbacks ist die Beleuchtungsstärke des Umgebungslichtsensors.

Der register/ambient_light_v2_bricklet/<UID>/illuminance Callback wird nur ausgelöst, wenn sich die Beleuchtungsstärke seit der letzten Auslösung geändert hat.

register/ambient_light_v2_bricklet/<UID>/illuminance_reached
Request-Payload:
 
  • register -- bool
Response-Payload:
 
  • illuminance -- int

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/ambient_light_v2_bricklet/<UID>/set_illuminance_callback_threshold gesetzt, erreicht wird. Der Payload des Callbacks ist die Beleuchtungsstärke des Umgebungslichtsensors.

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