MQTT - Color Bricklet

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

setup:
    # Get current color
    subscribe to tinkerforge/response/color_bricklet/XYZ/get_color
    publish '' to tinkerforge/request/color_bricklet/XYZ/get_color

Callback

Download (example-callback.txt)

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

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

setup:
    # Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    publish '{"debounce": 10000}' to tinkerforge/request/color_bricklet/XYZ/set_debounce_period
    
    # Handle incoming color reached callbacks
    subscribe to tinkerforge/callback/color_bricklet/XYZ/color_reached
    publish '{"register": true}' to tinkerforge/register/color_bricklet/XYZ/color_reached # Register color_reached callback
    
    # Configure threshold for color "greater than 100, 200, 300, 400"
    publish '{"option": "greater", "min_r": 100, "max_r": 0, "min_g": 200, "max_g": 0, "min_b": 300, "max_b": 0, "min_c": 400, "max_c": 0}' to tinkerforge/request/color_bricklet/XYZ/set_color_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-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/color_bricklet/<UID>/get_color
Anfrage:
  • keine Nutzdaten
Antwort:
  • r – Typ: int, Wertebereich: [0 bis 216 - 1]
  • g – Typ: int, Wertebereich: [0 bis 216 - 1]
  • b – Typ: int, Wertebereich: [0 bis 216 - 1]
  • c – Typ: int, 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 register/color_bricklet/<UID>/color Callback zu nutzen und die Periode mit request/color_bricklet/<UID>/set_color_callback_period vorzugeben.

request/color_bricklet/<UID>/light_on
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Aktiviert die LED.

request/color_bricklet/<UID>/light_off
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Deaktiviert die LED.

request/color_bricklet/<UID>/is_light_on
Anfrage:
  • keine Nutzdaten
Antwort:
  • light – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 1

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

  • 0: On
  • 1: Off

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

Für light:

  • "on" = 0
  • "off" = 1
request/color_bricklet/<UID>/set_config
Anfrage:
  • gain – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
  • integration_time – Typ: int, Wertebereich: Siehe Symbole, 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 Symbole sind für diese Funktion verfügbar:

Für gain:

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

Für integration_time:

  • "2ms" = 0
  • "24ms" = 1
  • "101ms" = 2
  • "154ms" = 3
  • "700ms" = 4
request/color_bricklet/<UID>/get_config
Anfrage:
  • keine Nutzdaten
Antwort:
  • gain – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
  • integration_time – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Einstellungen zurück, wie von request/color_bricklet/<UID>/set_config gesetzt.

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

Für gain:

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

Für integration_time:

  • "2ms" = 0
  • "24ms" = 1
  • "101ms" = 2
  • "154ms" = 3
  • "700ms" = 4
request/color_bricklet/<UID>/get_illuminance
Anfrage:
  • keine Nutzdaten
Antwort:
  • illuminance – Typ: int, Einheit: ? lx, 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 request/color_bricklet/<UID>/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 request/color_bricklet/<UID>/set_config reduziert werden.

request/color_bricklet/<UID>/get_color_temperature
Anfrage:
  • keine Nutzdaten
Antwort:
  • color_temperature – Typ: int, 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 request/color_bricklet/<UID>/set_config reduziert werden.

Fortgeschrittene Funktionen

request/color_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", "i", "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 '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. 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 Color.

Konfigurationsfunktionen für Callbacks

request/color_bricklet/<UID>/set_color_callback_period
Anfrage:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt die Periode mit welcher der register/color_bricklet/<UID>/color Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/color_bricklet/<UID>/color Callback wird nur ausgelöst, wenn sich die Color seit der letzten Auslösung geändert hat.

request/color_bricklet/<UID>/get_color_callback_period
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

request/color_bricklet/<UID>/set_color_callback_threshold
Anfrage:
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min_r – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max_r – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • min_g – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max_g – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • min_b – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max_b – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • min_c – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max_c – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt den Schwellwert für den register/color_bricklet/<UID>/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 Symbole sind für diese Funktion verfügbar:

Für option:

  • "off" = "x"
  • "outside" = "o"
  • "inside" = "i"
  • "smaller" = "<"
  • "greater" = ">"
request/color_bricklet/<UID>/get_color_callback_threshold
Anfrage:
  • keine Nutzdaten
Antwort:
  • option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x"
  • min_r – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max_r – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • min_g – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max_g – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • min_b – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max_b – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • min_c – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • max_c – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von request/color_bricklet/<UID>/set_color_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/color_bricklet/<UID>/set_debounce_period
Anfrage:
  • debounce – Typ: int, 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.

request/color_bricklet/<UID>/get_debounce_period
Anfrage:
  • keine Nutzdaten
Antwort:
  • debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von request/color_bricklet/<UID>/set_debounce_period gesetzt.

request/color_bricklet/<UID>/set_illuminance_callback_period
Anfrage:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:
  • keine Antwort

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

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

request/color_bricklet/<UID>/get_illuminance_callback_period
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

request/color_bricklet/<UID>/set_color_temperature_callback_period
Anfrage:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:
  • keine Antwort

Setzt die Periode mit welcher der register/color_bricklet/<UID>/color_temperature Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/color_bricklet/<UID>/color_temperature Callback wird nur ausgelöst, wenn sich die Farbtemperatur seit der letzten Auslösung geändert hat.

request/color_bricklet/<UID>/get_color_temperature_callback_period
Anfrage:
  • keine Nutzdaten
Antwort:
  • period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von request/color_bricklet/<UID>/set_color_temperature_callback_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/color_bricklet/<UID>/color
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • r – Typ: int, Wertebereich: [0 bis 216 - 1]
  • g – Typ: int, Wertebereich: [0 bis 216 - 1]
  • b – Typ: int, Wertebereich: [0 bis 216 - 1]
  • c – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Dieser Callback wird mit der Periode, wie gesetzt mit request/color_bricklet/<UID>/set_color_callback_period, ausgelöst. Der Payload des Callbacks ist die Farbe des Sensors als RGBC.

Der register/color_bricklet/<UID>/color Callback wird nur ausgelöst, wenn sich die Farbe seit der letzten Auslösung geändert hat.

register/color_bricklet/<UID>/color_reached
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • r – Typ: int, Wertebereich: [0 bis 216 - 1]
  • g – Typ: int, Wertebereich: [0 bis 216 - 1]
  • b – Typ: int, Wertebereich: [0 bis 216 - 1]
  • c – Typ: int, Wertebereich: [0 bis 216 - 1]

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

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/color_bricklet/<UID>/set_color_callback_threshold gesetzt, erreicht wird. Der Payload des Callbacks ist die Farbe des Sensors als RGBC.

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

register/color_bricklet/<UID>/illuminance
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • illuminance – Typ: int, Einheit: ? lx, Wertebereich: [0 bis 103438]

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

Dieser Callback wird mit der Periode, wie gesetzt mit request/color_bricklet/<UID>/set_illuminance_callback_period, ausgelöst. Der Payload des Callbacks ist die Beleuchtungsstärke des Sensors. Siehe request/color_bricklet/<UID>/get_illuminance für eine Erklärung wie dieser zu interpretieren ist.

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

register/color_bricklet/<UID>/color_temperature
Registrierungsanfrage:
  • register – Typ: bool
Callback-Antwort:
  • color_temperature – Typ: int, Einheit: 1 K, Wertebereich: [0 bis 216 - 1]

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

Dieser Callback wird mit der Periode, wie gesetzt mit request/color_bricklet/<UID>/set_color_temperature_callback_period, ausgelöst. Der Payload des Callbacks ist die Farbtemperatur des Sensors.

Der register/color_bricklet/<UID>/color_temperature Callback wird nur ausgelöst, wenn sich die Farbtemperatur seit der letzten Auslösung geändert hat.