Modbus - Ambient Light Bricklet 2.0¶

Grundfunktionen¶

BrickletAmbientLightV2.get_illuminance¶

Funktions-ID:	1
Anfrage:	keine Nutzdaten
Antwort:	illuminance – Typ: uint32, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1]

Gibt die Beleuchtungsstärke des Umgebungslichtsensors zurück. Der Messbereich erstreckt sich bis über 100000Lux, aber ab 64000Lux nimmt die Messgenauigkeit ab.

Geändert in Version 2.0.2 (Plugin): Eine Beleuchtungsstärke von 0Lux bedeutet eine Ausnahmesituation in der der Sensor keine sinnvolle Messung durchführen kann. Dies kann bei sehr schwacher oder sehr starker Beleuchtung auftreten. Bei starker Beleuchtung bedeutet diese möglicherweise, dass der Sensor gesättigt (saturated) ist und die Konfiguration angepasst werden sollte (set_configuration), um besser der Beleuchtung zu entsprechen.

Wenn die Beleuchtungsstärke periodisch abgefragt werden soll, wird empfohlen den CALLBACK_ILLUMINANCE Callback zu nutzen und die Periode mit set_illuminance_callback_period vorzugeben.

Fortgeschrittene Funktionen¶

BrickletAmbientLightV2.set_configuration¶

Funktions-ID:	8
Anfrage:	illuminance_range – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3 integration_time – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3
Antwort:	keine Antwort

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 get_illuminance und der CALLBACK_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 get_illuminance und der CALLBACK_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 folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für illuminance_range:

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

Für integration_time:

• 0 = 50ms
• 1 = 100ms
• 2 = 150ms
• 3 = 200ms
• 4 = 250ms
• 5 = 300ms
• 6 = 350ms
• 7 = 400ms

BrickletAmbientLightV2.get_configuration¶

Funktions-ID:	9
Anfrage:	keine Nutzdaten
Antwort:	illuminance_range – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3 integration_time – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3

Gibt die Konfiguration zurück, wie von set_configuration gesetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für illuminance_range:

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

Für integration_time:

• 0 = 50ms
• 1 = 100ms
• 2 = 150ms
• 3 = 200ms
• 4 = 250ms
• 5 = 300ms
• 6 = 350ms
• 7 = 400ms

BrickletAmbientLightV2.get_identity¶

Funktions-ID:	255
Anfrage:	keine Nutzdaten
Antwort:	uid – Typ: char[8] connected_uid – Typ: char[8] position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardware_version – Typ: uint8[3] 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] firmware_version – Typ: uint8[3] 0: major – Typ: uint8, Wertebereich: [0 bis 255] 1: minor – Typ: uint8, Wertebereich: [0 bis 255] 2: revision – Typ: uint8, Wertebereich: [0 bis 255] device_identifier – Typ: uint16, Wertebereich: [0 bis 216 - 1]

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. 

Konfigurationsfunktionen für Callbacks¶

BrickletAmbientLightV2.set_illuminance_callback_period¶

Funktions-ID:	2
Anfrage:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt die Periode mit welcher der CALLBACK_ILLUMINANCE Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der CALLBACK_ILLUMINANCE Callback wird nur ausgelöst, wenn sich die Beleuchtungsstärke seit der letzten Auslösung geändert hat.

BrickletAmbientLightV2.get_illuminance_callback_period¶

Funktions-ID:	3
Anfrage:	keine Nutzdaten
Antwort:	period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von set_illuminance_callback_period gesetzt.

BrickletAmbientLightV2.set_illuminance_callback_threshold¶

Funktions-ID:	4
Anfrage:	option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x' min – Typ: uint32, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1], Standardwert: 0 max – Typ: uint32, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt den Schwellwert für den CALLBACK_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)

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für option:

• 'x' = Off
• 'o' = Outside
• 'i' = Inside
• '<' = Smaller
• '>' = Greater

BrickletAmbientLightV2.get_illuminance_callback_threshold¶

Funktions-ID:	5
Anfrage:	keine Nutzdaten
Antwort:	option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x' min – Typ: uint32, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1], Standardwert: 0 max – Typ: uint32, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von set_illuminance_callback_threshold gesetzt.

Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:

Für option:

• 'x' = Off
• 'o' = Outside
• 'i' = Inside
• '<' = Smaller
• '>' = Greater

BrickletAmbientLightV2.set_debounce_period¶

Funktions-ID:	6
Anfrage:	debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Antwort:	keine Antwort

Setzt die Periode mit welcher die Schwellwert Callbacks

• CALLBACK_ILLUMINANCE_REACHED,

ausgelöst werden, wenn die Schwellwerte

• set_illuminance_callback_threshold,

weiterhin erreicht bleiben.

BrickletAmbientLightV2.get_debounce_period¶

Funktions-ID:	7
Anfrage:	keine Nutzdaten
Antwort:	debounce – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von set_debounce_period gesetzt.

Callbacks¶

BrickletAmbientLightV2.CALLBACK_ILLUMINANCE¶

Funktions-ID:	10
Antwort:	illuminance – Typ: uint32, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit set_illuminance_callback_period, ausgelöst. Der Rückgabewert ist die Beleuchtungsstärke des Umgebungslichtsensors.

Der CALLBACK_ILLUMINANCE Callback wird nur ausgelöst, wenn sich die Beleuchtungsstärke seit der letzten Auslösung geändert hat.

BrickletAmbientLightV2.CALLBACK_ILLUMINANCE_REACHED¶

Funktions-ID:	11
Antwort:	illuminance – Typ: uint32, Einheit: 1/100 lx, Wertebereich: [0 bis 232 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set_illuminance_callback_threshold gesetzt, erreicht wird. Der Rückgabewert ist die Beleuchtungsstärke des Umgebungslichtsensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit set_debounce_period gesetzt, ausgelöst.