LabVIEW - Color Bricklet

This is the description of the LabVIEW API bindings for the Color Bricklet. General information and technical specifications for the Color Bricklet are summarized in its hardware description.

An installation guide for the LabVIEW API bindings is part of their general description.

API

Generally, every method of the LabVIEW bindings that outputs a value can report a Tinkerforge.TimeoutException. This error gets reported if the device did not respond. If a cable based connection is used, it is unlikely that this exception gets thrown (assuming nobody plugs the device out). However, if a wireless connection is used, timeouts will occur if the distance to the device gets too big.

The namespace for all Brick/Bricklet bindings and the IPConnection is Tinkerforge.*.

Basic Functions

BrickletColor(uid, ipcon) → color
Input:
  • uid -- String
  • ipcon -- .NET Refnum (IPConnection)
Output:
  • color -- .NET Refnum (BrickletColor)

Creates an object with the unique device ID uid. This object can then be used after the IP Connection is connected (see examples above).

BrickletColor.GetColor() → r, g, b, c
Output:
  • r -- Int32
  • g -- Int32
  • b -- Int32
  • c -- Int32

Returns the measured color of the sensor. The values have a range of 0 to 65535.

The red (r), green (g), blue (b) and clear (c) colors are measured with four different photodiodes that are responsive at different wavelengths:

Chart Responsivity / Wavelength

If you want to get the color periodically, it is recommended to use the ColorCallback callback and set the period with SetColorCallbackPeriod().

BrickletColor.LightOn()

Turns the LED on.

BrickletColor.LightOff()

Turns the LED off.

BrickletColor.IsLightOn() → light
Output:
  • light -- Byte

Returns the state of the LED. Possible values are:

  • 0: On
  • 1: Off

The following constants are available for this function:

  • BrickletColor.LIGHT_ON = 0
  • BrickletColor.LIGHT_OFF = 1
BrickletColor.SetConfig(gain, integrationTime)
Input:
  • gain -- Byte
  • integrationTime -- Byte

Sets the configuration of the sensor. Gain and integration time can be configured in this way.

For configuring the gain:

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

For configuring the integration time:

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

Increasing the gain enables the sensor to detect a color from a higher distance.

The integration time provides a trade-off between conversion time and accuracy. With a longer integration time the values read will be more accurate but it will take longer time to get the conversion results.

The default values are 60x gain and 154ms integration time.

The following constants are available for this function:

  • BrickletColor.GAIN_1X = 0
  • BrickletColor.GAIN_4X = 1
  • BrickletColor.GAIN_16X = 2
  • BrickletColor.GAIN_60X = 3
  • 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
Output:
  • gain -- Byte
  • integrationTime -- Byte

Returns the configuration as set by SetConfig().

The following constants are available for this function:

  • BrickletColor.GAIN_1X = 0
  • BrickletColor.GAIN_4X = 1
  • BrickletColor.GAIN_16X = 2
  • BrickletColor.GAIN_60X = 3
  • 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
Output:
  • illuminance -- Int64

Returns the illuminance affected by the gain and integration time as set by SetConfig(). To get the illuminance in Lux apply this formula:

lux = illuminance * 700 / gain / integration_time

To get a correct illuminance measurement make sure that the color values themself are not saturated. The color value (R, G or B) is saturated if it is equal to the maximum value of 65535. In that case you have to reduce the gain, see SetConfig().

BrickletColor.GetColorTemperature() → colorTemperature
Output:
  • colorTemperature -- Int32

Returns the color temperature in Kelvin.

To get a correct color temperature measurement make sure that the color values themself are not saturated. The color value (R, G or B) is saturated if it is equal to the maximum value of 65535. In that case you have to reduce the gain, see SetConfig().

Advanced Functions

BrickletColor.GetAPIVersion() → apiVersion
Output:
  • apiVersion -- Byte[3]

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

BrickletColor.GetResponseExpected(functionId) → responseExpected
Input:
  • functionId -- Byte
Output:
  • responseExpected -- Boolean

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

See SetResponseExpected() for the list of function ID constants available for this function.

BrickletColor.SetResponseExpected(functionId, responseExpected)
Input:
  • functionId -- Byte
  • responseExpected -- Boolean

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • 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)
Input:
  • responseExpected -- Boolean

Changes the response expected flag for all setter and callback configuration functions of this device at once.

BrickletColor.GetIdentity() → uid, connectedUid, position, hardwareVersion, firmwareVersion, deviceIdentifier
Output:
  • uid -- String
  • connectedUid -- String
  • position -- Char
  • hardwareVersion -- Byte[3]
  • firmwareVersion -- Byte[3]
  • deviceIdentifier -- Int32

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

BrickletColor.SetColorCallbackPeriod(period)
Input:
  • period -- Int64

Sets the period in ms with which the ColorCallback callback is triggered periodically. A value of 0 turns the callback off.

The ColorCallback callback is only triggered if the color has changed since the last triggering.

The default value is 0.

BrickletColor.GetColorCallbackPeriod() → period
Output:
  • period -- Int64

Returns the period as set by SetColorCallbackPeriod().

BrickletColor.SetColorCallbackThreshold(option, minR, maxR, minG, maxG, minB, maxB, minC, maxC)
Input:
  • option -- Char
  • minR -- Int32
  • maxR -- Int32
  • minG -- Int32
  • maxG -- Int32
  • minB -- Int32
  • maxB -- Int32
  • minC -- Int32
  • maxC -- Int32

Sets the thresholds for the ColorReachedCallback callback.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the temperature is outside the min and max values
'i' Callback is triggered when the temperature is inside the min and max values
'<' Callback is triggered when the temperature is smaller than the min value (max is ignored)
'>' Callback is triggered when the temperature is greater than the min value (max is ignored)

The default value is ('x', 0, 0, 0, 0, 0, 0, 0, 0).

The following constants are available for this function:

  • 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
Output:
  • option -- Char
  • minR -- Int32
  • maxR -- Int32
  • minG -- Int32
  • maxG -- Int32
  • minB -- Int32
  • maxB -- Int32
  • minC -- Int32
  • maxC -- Int32

Returns the threshold as set by SetColorCallbackThreshold().

The following constants are available for this function:

  • 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)
Input:
  • debounce -- Int64

Sets the period in ms with which the threshold callback

is triggered, if the threshold

keeps being reached.

The default value is 100.

BrickletColor.GetDebouncePeriod() → debounce
Output:
  • debounce -- Int64

Returns the debounce period as set by SetDebouncePeriod().

BrickletColor.SetIlluminanceCallbackPeriod(period)
Input:
  • period -- Int64

Sets the period in ms with which the IlluminanceCallback callback is triggered periodically. A value of 0 turns the callback off.

The IlluminanceCallback callback is only triggered if the illuminance has changed since the last triggering.

The default value is 0.

BrickletColor.GetIlluminanceCallbackPeriod() → period
Output:
  • period -- Int64

Returns the period as set by SetIlluminanceCallbackPeriod().

BrickletColor.SetColorTemperatureCallbackPeriod(period)
Input:
  • period -- Int64

Sets the period in ms with which the ColorTemperatureCallback callback is triggered periodically. A value of 0 turns the callback off.

The ColorTemperatureCallback callback is only triggered if the color temperature has changed since the last triggering.

The default value is 0.

BrickletColor.GetColorTemperatureCallbackPeriod() → period
Output:
  • period -- Int64

Returns the period as set by SetColorTemperatureCallbackPeriod().

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a function to a callback property of the device object. The available callback property and their type of parameters are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

event BrickletColor.ColorCallback(sender, r, g, b, c)
Input:
  • sender -- .NET Refnum (BrickletColor)
  • r -- Int32
  • g -- Int32
  • b -- Int32
  • c -- Int32

This callback is triggered periodically with the period that is set by SetColorCallbackPeriod(). The parameter is the color of the sensor as RGBC.

The ColorCallback callback is only triggered if the color has changed since the last triggering.

event BrickletColor.ColorReachedCallback(sender, r, g, b, c)
Input:
  • sender -- .NET Refnum (BrickletColor)
  • r -- Int32
  • g -- Int32
  • b -- Int32
  • c -- Int32

This callback is triggered when the threshold as set by SetColorCallbackThreshold() is reached. The parameter is the color of the sensor as RGBC.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by SetDebouncePeriod().

event BrickletColor.IlluminanceCallback(sender, illuminance)
Input:
  • sender -- .NET Refnum (BrickletColor)
  • illuminance -- Int64

This callback is triggered periodically with the period that is set by SetIlluminanceCallbackPeriod(). The parameter is the illuminance. See GetIlluminance() for how to interpret this value.

The IlluminanceCallback callback is only triggered if the illuminance has changed since the last triggering.

event BrickletColor.ColorTemperatureCallback(sender, colorTemperature)
Input:
  • sender -- .NET Refnum (BrickletColor)
  • colorTemperature -- Int32

This callback is triggered periodically with the period that is set by SetColorTemperatureCallbackPeriod(). The parameter is the color temperature in Kelvin.

The ColorTemperatureCallback callback is only triggered if the color temperature has changed since the last triggering.

Constants

BrickletColor.DEVICE_IDENTIFIER

This constant is used to identify a Color Bricklet.

The GetIdentity() function and the EnumerateCallback callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

BrickletColor.DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Color Bricklet.