LabVIEW - Color Bricklet

Dies ist die Beschreibung der LabVIEW 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 LabVIEW API Bindings ist Teil deren allgemeine Beschreibung.

API

Prinzipiell kann jede Funktion der LabVIEW Bindings, welche einen Wert ausgibt eine Tinkerforge.TimeoutException melden. Dieser Fehler wird gemeldet wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist Tinkerforge.*.

Grundfunktionen

BrickletColor(uid, ipcon) → color
Eingabe:
  • uid – Typ: String
  • ipcon – Typ: .NET Refnum (IPConnection)
Ausgabe:
  • color – Typ: .NET Refnum (BrickletColor)

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid. Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

BrickletColor.GetColor() → r, g, b, c
Ausgabe:
  • r – Typ: Int32, Wertebereich: [0 bis 216 - 1]
  • g – Typ: Int32, Wertebereich: [0 bis 216 - 1]
  • b – Typ: Int32, Wertebereich: [0 bis 216 - 1]
  • c – Typ: Int32, 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 ColorCallback Callback zu nutzen und die Periode mit SetColorCallbackPeriod() vorzugeben.

BrickletColor.LightOn()

Aktiviert die LED.

BrickletColor.LightOff()

Deaktiviert die LED.

BrickletColor.IsLightOn() → light
Ausgabe:
  • light – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 1

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

  • 0: On
  • 1: Off

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

Für light:

  • BrickletColor.LIGHT_ON = 0
  • BrickletColor.LIGHT_OFF = 1
BrickletColor.SetConfig(gain, integrationTime)
Eingabe:
  • gain – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3
  • integrationTime – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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 Konstanten sind für diese Funktion verfügbar:

Für gain:

  • BrickletColor.GAIN_1X = 0
  • BrickletColor.GAIN_4X = 1
  • BrickletColor.GAIN_16X = 2
  • BrickletColor.GAIN_60X = 3

Für integrationTime:

  • BrickletColor.INTEGRATION_TIME_2MS = 0
  • BrickletColor.INTEGRATION_TIME_24MS = 1
  • BrickletColor.INTEGRATION_TIME_101MS = 2
  • BrickletColor.INTEGRATION_TIME_154MS = 3
  • BrickletColor.INTEGRATION_TIME_700MS = 4
BrickletColor.GetConfig() → gain, integrationTime
Ausgabe:
  • gain – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3
  • integrationTime – Typ: Byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Einstellungen zurück, wie von SetConfig() gesetzt.

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

Für gain:

  • BrickletColor.GAIN_1X = 0
  • BrickletColor.GAIN_4X = 1
  • BrickletColor.GAIN_16X = 2
  • BrickletColor.GAIN_60X = 3

Für integrationTime:

  • BrickletColor.INTEGRATION_TIME_2MS = 0
  • BrickletColor.INTEGRATION_TIME_24MS = 1
  • BrickletColor.INTEGRATION_TIME_101MS = 2
  • BrickletColor.INTEGRATION_TIME_154MS = 3
  • BrickletColor.INTEGRATION_TIME_700MS = 4
BrickletColor.GetIlluminance() → illuminance
Ausgabe:
  • illuminance – Typ: Int64, 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 SetConfig() 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 SetConfig() reduziert werden.

BrickletColor.GetColorTemperature() → colorTemperature
Ausgabe:
  • colorTemperature – Typ: Int32, 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 SetConfig() reduziert werden.

Fortgeschrittene Funktionen

BrickletColor.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier
Ausgabe:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: Char, Wertebereich: ["a" bis "h", "i", "z"]
  • hardwareVersion – Typ: Byte[3]
    • 0: major – Typ: Byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Byte, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: Byte[3]
    • 0: major – Typ: Byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Byte, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: Int32, 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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks

BrickletColor.SetColorCallbackPeriod(period)
Eingabe:
  • period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

BrickletColor.GetColorCallbackPeriod() → period
Ausgabe:
  • period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetColorCallbackPeriod() gesetzt.

BrickletColor.SetColorCallbackThreshold(option, minR, maxR, minG, maxG, minB, maxB, minC, maxC)
Eingabe:
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"
  • minR – Typ: Int32, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxR – Typ: Int32, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • minG – Typ: Int32, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxG – Typ: Int32, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • minB – Typ: Int32, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxB – Typ: Int32, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • minC – Typ: Int32, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxC – Typ: Int32, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den ColorReachedCallback 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 Konstanten sind für diese Funktion verfügbar:

Für option:

  • BrickletColor.THRESHOLD_OPTION_OFF = "x"
  • BrickletColor.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletColor.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletColor.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletColor.THRESHOLD_OPTION_GREATER = ">"
BrickletColor.GetColorCallbackThreshold() → option, minR, maxR, minG, maxG, minB, maxB, minC, maxC
Ausgabe:
  • option – Typ: Char, Wertebereich: Siehe Konstanten, Standardwert: "x"
  • minR – Typ: Int32, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxR – Typ: Int32, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • minG – Typ: Int32, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxG – Typ: Int32, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • minB – Typ: Int32, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxB – Typ: Int32, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • minC – Typ: Int32, Wertebereich: [0 bis 216 - 1], Standardwert: 0
  • maxC – Typ: Int32, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von SetColorCallbackThreshold() gesetzt.

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

Für option:

  • BrickletColor.THRESHOLD_OPTION_OFF = "x"
  • BrickletColor.THRESHOLD_OPTION_OUTSIDE = "o"
  • BrickletColor.THRESHOLD_OPTION_INSIDE = "i"
  • BrickletColor.THRESHOLD_OPTION_SMALLER = "<"
  • BrickletColor.THRESHOLD_OPTION_GREATER = ">"
BrickletColor.SetDebouncePeriod(debounce)
Eingabe:
  • debounce – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callback

ausgelöst wird, wenn der Schwellwert

weiterhin erreicht bleibt.

BrickletColor.GetDebouncePeriod() → debounce
Ausgabe:
  • debounce – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von SetDebouncePeriod() gesetzt.

BrickletColor.SetIlluminanceCallbackPeriod(period)
Eingabe:
  • period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

BrickletColor.GetIlluminanceCallbackPeriod() → period
Ausgabe:
  • period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetIlluminanceCallbackPeriod() gesetzt.

BrickletColor.SetColorTemperatureCallbackPeriod(period)
Eingabe:
  • period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

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

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

BrickletColor.GetColorTemperatureCallbackPeriod() → period
Ausgabe:
  • period – Typ: Int64, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetColorTemperatureCallbackPeriod() gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung erfolgt indem eine Funktion einem Callback Property des Geräte Objektes zugewiesen wird. Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten beschrieben.

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.

event BrickletColor.ColorCallback → sender, r, g, b, c
Callback-Ausgabe:
  • sender – Typ: .NET Refnum (BrickletColor)
  • r – Typ: Int32, Wertebereich: [0 bis 216 - 1]
  • g – Typ: Int32, Wertebereich: [0 bis 216 - 1]
  • b – Typ: Int32, Wertebereich: [0 bis 216 - 1]
  • c – Typ: Int32, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit SetColorCallbackPeriod(), ausgelöst. Der Parameter ist die Farbe des Sensors als RGBC.

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

event BrickletColor.ColorReachedCallback → sender, r, g, b, c
Callback-Ausgabe:
  • sender – Typ: .NET Refnum (BrickletColor)
  • r – Typ: Int32, Wertebereich: [0 bis 216 - 1]
  • g – Typ: Int32, Wertebereich: [0 bis 216 - 1]
  • b – Typ: Int32, Wertebereich: [0 bis 216 - 1]
  • c – Typ: Int32, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetColorCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die Farbe des Sensors als RGBC.

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

event BrickletColor.IlluminanceCallback → sender, illuminance
Callback-Ausgabe:
  • sender – Typ: .NET Refnum (BrickletColor)
  • illuminance – Typ: Int64, Einheit: ? lx, Wertebereich: [0 bis 103438]

Dieser Callback wird mit der Periode, wie gesetzt mit SetIlluminanceCallbackPeriod(), ausgelöst. Der Parameter ist die Beleuchtungsstärke des Sensors. Siehe GetIlluminance() für eine Erklärung wie dieser zu interpretieren ist.

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

event BrickletColor.ColorTemperatureCallback → sender, colorTemperature
Callback-Ausgabe:
  • sender – Typ: .NET Refnum (BrickletColor)
  • colorTemperature – Typ: Int32, Einheit: 1 K, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit SetColorTemperatureCallbackPeriod(), ausgelöst. Der Parameter ist die Farbtemperatur des Sensors.

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

Virtuelle Funktionen

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

BrickletColor.GetAPIVersion() → apiVersion
Ausgabe:
  • apiVersion – Typ: Byte[3]
    • 0: major – Typ: Byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: Byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: Byte, Wertebereich: [0 bis 255]

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

BrickletColor.GetResponseExpected(functionId) → responseExpected
Eingabe:
  • functionId – Typ: Byte, Wertebereich: Siehe Konstanten
Ausgabe:
  • responseExpected – Typ: Boolean

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels SetResponseExpected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für functionId:

  • BrickletColor.FUNCTION_SET_COLOR_CALLBACK_PERIOD = 2
  • BrickletColor.FUNCTION_SET_COLOR_CALLBACK_THRESHOLD = 4
  • BrickletColor.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletColor.FUNCTION_LIGHT_ON = 10
  • BrickletColor.FUNCTION_LIGHT_OFF = 11
  • BrickletColor.FUNCTION_SET_CONFIG = 13
  • BrickletColor.FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 17
  • BrickletColor.FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_PERIOD = 19
BrickletColor.SetResponseExpected(functionId, responseExpected)
Eingabe:
  • functionId – Typ: Byte, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: Boolean

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

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

Für functionId:

  • BrickletColor.FUNCTION_SET_COLOR_CALLBACK_PERIOD = 2
  • BrickletColor.FUNCTION_SET_COLOR_CALLBACK_THRESHOLD = 4
  • BrickletColor.FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletColor.FUNCTION_LIGHT_ON = 10
  • BrickletColor.FUNCTION_LIGHT_OFF = 11
  • BrickletColor.FUNCTION_SET_CONFIG = 13
  • BrickletColor.FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 17
  • BrickletColor.FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_PERIOD = 19
BrickletColor.SetResponseExpectedAll(responseExpected)
Eingabe:
  • responseExpected – Typ: Boolean

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Konstanten

BrickletColor.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Color Bricklet zu identifizieren.

Die GetIdentity() Funktion und der IPConnection.EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletColor.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Color Bricklet dar.