TCP/IP - Color Bricklet

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

API

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

Grundfunktionen

BrickletColor.get_color
Funktions-ID:
  • 1
Anfrage:
  • keine Nutzdaten
Antwort:
  • r – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • g – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • b – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • c – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Gibt die gemessene Farbe des Sensors zurück.

Die rot (r), grün (g), blau (b) und clear (c) werden mit vier unterschiedlichen Fotodioden gemessen. Diese sind Empfindlich in unterschiedlichen Wellenlängen:

Chart Responsivity / Wavelength

Wenn die Farbe periodisch abgefragt werden soll, wird empfohlen den CALLBACK_COLOR Callback zu nutzen und die Periode mit set_color_callback_period vorzugeben.

BrickletColor.light_on
Funktions-ID:
  • 10
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Aktiviert die LED.

BrickletColor.light_off
Funktions-ID:
  • 11
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Deaktiviert die LED.

BrickletColor.is_light_on
Funktions-ID:
  • 12
Anfrage:
  • keine Nutzdaten
Antwort:
  • light – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 1

Gibt den Zustand der LED zurück. Mögliche Werte sind:

  • 0: On
  • 1: Off

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

Für light:

  • 0 = On
  • 1 = Off
BrickletColor.set_config
Funktions-ID:
  • 13
Anfrage:
  • gain – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3
  • integration_time – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3
Antwort:
  • keine Antwort

Setzt die Konfiguration des Sensors. Verstärkung und Integrationszeit können eingestellt werden.

Für die Konfiguration der Verstärkung:

  • 0: 1x Gain
  • 1: 4x Gain
  • 2: 16x Gain
  • 3: 60x Gain

Für die Konfiguration der Integrationszeit:

  • 0: 2,4ms
  • 1: 24ms
  • 2: 101ms
  • 3: 154ms
  • 4: 700ms

Eine Erhöhung der Verstärkung ermöglicht es dem Sensor Farben aus größeren Entfernungen zu erkennen.

Die Integrationszeit ist ein Trade-off zwischen Konvertierungszeit und Genauigkeit. Mit einer höheren Integrationszeit werden die Werte genauer, es dauert allerdings länger bis ein Resultat bereitsteht.

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

Für gain:

  • 0 = 1x
  • 1 = 4x
  • 2 = 16x
  • 3 = 60x

Für integration_time:

  • 0 = 2ms
  • 1 = 24ms
  • 2 = 101ms
  • 3 = 154ms
  • 4 = 700ms
BrickletColor.get_config
Funktions-ID:
  • 14
Anfrage:
  • keine Nutzdaten
Antwort:
  • gain – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3
  • integration_time – Typ: uint8, Wertebereich: Siehe Bedeutungen, Standardwert: 3

Gibt die Einstellungen zurück, wie von set_config gesetzt.

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

Für gain:

  • 0 = 1x
  • 1 = 4x
  • 2 = 16x
  • 3 = 60x

Für integration_time:

  • 0 = 2ms
  • 1 = 24ms
  • 2 = 101ms
  • 3 = 154ms
  • 4 = 700ms
BrickletColor.get_illuminance
Funktions-ID:
  • 15
Anfrage:
  • keine Nutzdaten
Antwort:
  • illuminance – Typ: uint32, Wertebereich: [0 bis 103438]

Gibt die Beleuchtungsstärke beeinflusst durch die Verstärkung und die Integrationszeit zurück. Verstärkung und Integrationszeit können mit set_config eingestellt werden. Um die Beleuchtungsstärke in Lux zu ermitteln muss folgende Formel angewendet werden:

lux = illuminance * 700 / gain / integration_time

Für eine korrekte Messung der Beleuchtungsstärke muss sichergestellt sein, dass die Farbwerte (R, G oder B) nicht saturiert sind. Ein Farbwert ist saturiert wenn der Wert 65535 beträgt. In diesem Fall kann die Verstärkung per set_config reduziert werden.

BrickletColor.get_color_temperature
Funktions-ID:
  • 16
Anfrage:
  • keine Nutzdaten
Antwort:
  • color_temperature – Typ: uint16, Einheit: 1 K, Wertebereich: [0 bis 216 - 1]

Gibt die Farbtemperatur zurück.

Für eine korrekte Messung der Farbtemperatur muss sichergestellt sein das die Farbwerte (R, G oder B) nicht saturiert sind. Ein Farbwert ist saturiert wenn der Wert 65535 beträgt. In diesem Fall kann die Verstärkung per set_config reduziert werden.

Fortgeschrittene Funktionen

BrickletColor.get_identity
Funktions-ID:
  • 255
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: char[8]
  • connected_uid – Typ: char[8]
  • position – Typ: char
  • hardware_version – Typ: uint8[3], Wertebereich: [0 bis 255]
  • firmware_version – Typ: uint8[3], 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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. 

Konfigurationsfunktionen für Callbacks

BrickletColor.set_color_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_COLOR Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

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

BrickletColor.get_color_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_color_callback_period gesetzt.

BrickletColor.set_color_callback_threshold
Funktions-ID:
  • 4
Anfrage:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min_r – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max_r – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • min_g – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max_g – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • min_b – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max_b – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • min_c – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max_c – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt den Schwellwert für den CALLBACK_COLOR_REACHED Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Callback ist inaktiv
'o' Callback wird ausgelöst, wenn die Temperatur außerhalb des min und max Wertes ist
'i' Callback wird ausgelöst, wenn die Temperatur innerhalb des min und max Wertes ist
'<' Callback wird ausgelöst, wenn die Temperatur kleiner als der min Wert ist (max wird ignoriert)
'>' Callback wird ausgelöst, wenn die Temperatur 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
BrickletColor.get_color_callback_threshold
Funktions-ID:
  • 5
Anfrage:
  • keine Nutzdaten
Antwort:
  • option – Typ: char, Wertebereich: Siehe Bedeutungen, Standardwert: 'x'
  • min_r – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max_r – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • min_g – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max_g – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • min_b – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max_b – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • min_c – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max_c – Typ: uint16, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von set_color_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
BrickletColor.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 Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

BrickletColor.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.

BrickletColor.set_illuminance_callback_period
Funktions-ID:
  • 17
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.

BrickletColor.get_illuminance_callback_period
Funktions-ID:
  • 18
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.

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

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

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

BrickletColor.get_color_temperature_callback_period
Funktions-ID:
  • 20
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_color_temperature_callback_period gesetzt.

Callbacks

BrickletColor.CALLBACK_COLOR
Funktions-ID:
  • 8
Antwort:
  • r – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • g – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • b – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • c – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit set_color_callback_period, ausgelöst. Der Rückgabewert ist die Farbe des Sensors als RGBC.

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

BrickletColor.CALLBACK_COLOR_REACHED
Funktions-ID:
  • 9
Antwort:
  • r – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • g – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • b – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • c – Typ: uint16, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von set_color_callback_threshold gesetzt, erreicht wird. Der Rückgabewert ist die Farbe des Sensors als RGBC.

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

BrickletColor.CALLBACK_ILLUMINANCE
Funktions-ID:
  • 21
Antwort:
  • illuminance – Typ: uint32, Wertebereich: [0 bis 103438]

Dieser Callback wird mit der Periode, wie gesetzt mit set_illuminance_callback_period, ausgelöst. Der Rückgabewert ist die Beleuchtungsstärke des Sensors. Siehe get_illuminance für eine Erklärung wie dieser zu interpretieren ist.

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

BrickletColor.CALLBACK_COLOR_TEMPERATURE
Funktions-ID:
  • 22
Antwort:
  • color_temperature – Typ: uint16, Einheit: 1 K, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit set_color_temperature_callback_period, ausgelöst. Der Rückgabewert ist die Farbtemperatur des Sensors.

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