TCP/IP - Ambient Light Bricklet

Dies ist die Beschreibung des TCP/IP Protokolls für das Ambient Light Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Ambient Light Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

API

Eine allgemeine Beschreibung der TCP/IP Protokollstruktur findet sich hier.

Grundfunktionen

BrickletAmbientLight.get_illuminance
Funktions-ID:
  • 1
Anfrage:
  • keine Nutzdaten
Antwort:
  • illuminance – Typ: uint16, Einheit: 1/10 lx, Wertebereich: [0 bis 9000]

Gibt die Beleuchtungsstärke des Umgebungslichtsensors zurück.

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

BrickletAmbientLight.get_analog_value
Funktions-ID:
  • 2
Anfrage:
  • keine Nutzdaten
Antwort:
  • value – Typ: uint16, Wertebereich: [0 bis 4095]

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.

Bemerkung

Der von get_illuminance zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während get_analog_value unverarbeitete Analogwerte zurück gibt. Der einzige Grund get_analog_value zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

Weiterhin deckt der Analog-Digital-Wandler drei unterschiedliche Bereiche ab, welche dynamisch gewechselt werden abhängig von der Lichtintensität. Es ist nicht möglich, anhand der Analogwerte, zwischen diesen Bereichen zu unterscheiden.

Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen den CALLBACK_ANALOG_VALUE Callback zu nutzen und die Periode mit set_analog_value_callback_period vorzugeben.

BrickletAmbientLight.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', 'i', '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 '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. 

Konfigurationsfunktionen für Callbacks

BrickletAmbientLight.set_illuminance_callback_period
Funktions-ID:
  • 3
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.

BrickletAmbientLight.get_illuminance_callback_period
Funktions-ID:
  • 4
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.

BrickletAmbientLight.set_analog_value_callback_period
Funktions-ID:
  • 5
Anfrage:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:
  • keine Antwort

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

Der CALLBACK_ANALOG_VALUE Callback wird nur ausgelöst, wenn sich der Analogwert seit der letzten Auslösung geändert hat.

BrickletAmbientLight.get_analog_value_callback_period
Funktions-ID:
  • 6
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_analog_value_callback_period gesetzt.

BrickletAmbientLight.set_illuminance_callback_threshold
Funktions-ID:
  • 7
Anfrage:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: uint16, Einheit: 1/10 lx, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: uint16, Einheit: 1/10 lx, Wertebereich: [0 bis 216 - 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
BrickletAmbientLight.get_illuminance_callback_threshold
Funktions-ID:
  • 8
Anfrage:
  • keine Nutzdaten
Antwort:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: uint16, Einheit: 1/10 lx, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: uint16, Einheit: 1/10 lx, Wertebereich: [0 bis 216 - 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
BrickletAmbientLight.set_analog_value_callback_threshold
Funktions-ID:
  • 9
Anfrage:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt den Schwellwert für den CALLBACK_ANALOG_VALUE_REACHED Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn der Analogwert außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn der Analogwert innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn der Analogwert kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn der Analogwert 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
BrickletAmbientLight.get_analog_value_callback_threshold
Funktions-ID:
  • 10
Anfrage:
  • keine Nutzdaten
Antwort:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von set_analog_value_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
BrickletAmbientLight.set_debounce_period
Funktions-ID:
  • 11
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

ausgelöst werden, wenn die Schwellwerte

weiterhin erreicht bleiben.

BrickletAmbientLight.get_debounce_period
Funktions-ID:
  • 12
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

BrickletAmbientLight.CALLBACK_ILLUMINANCE
Funktions-ID:
  • 13
Antwort:
  • illuminance – Typ: uint16, Einheit: 1/10 lx, Wertebereich: [0 bis 9000]

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.

BrickletAmbientLight.CALLBACK_ANALOG_VALUE
Funktions-ID:
  • 14
Antwort:
  • value – Typ: uint16, Wertebereich: [0 bis 4095]

Dieser Callback wird mit der Periode, wie gesetzt mit set_analog_value_callback_period, ausgelöst. Der Rückgabewert ist der Analogwert des Umgebungslichtsensors.

Der CALLBACK_ANALOG_VALUE Callback wird nur ausgelöst, wenn sich der Analogwert seit der letzten Auslösung geändert hat.

BrickletAmbientLight.CALLBACK_ILLUMINANCE_REACHED
Funktions-ID:
  • 15
Antwort:
  • illuminance – Typ: uint16, Einheit: 1/10 lx, Wertebereich: [0 bis 9000]

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.

BrickletAmbientLight.CALLBACK_ANALOG_VALUE_REACHED
Funktions-ID:
  • 16
Antwort:
  • value – Typ: uint16, Wertebereich: [0 bis 4095]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set_analog_value_callback_threshold gesetzt, erreicht wird. Der Rückgabewert ist der Analogwert des Umgebungslichtsensors.

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