Deutsch
English
Menu
Software / API Bindings / openHAB / API Reference and Examples / Bricklets / Color Bricklet

openHAB - Color Bricklet

Warning

The openHAB bindings are still in beta, but the development was stopped.

This is the description of the openHAB 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 openHAB API bindings is part of their general description.

Thing

UID:
  • tinkerforge:brickletcolor:[UID]
Required firmware version:
  • 2.0.0
Firmware update supported:
  • yes
Channels:
Actions:
Parameters:
  • Gain – Type: Choice, Default: 60x
  • Increasing the gain enables the sensor to detect a color from a higher distance.
  • Options: 1x, 4x, 16x, 60x

  • Integration Time – Type: Choice, Default: 154ms
  • 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.
  • Options: 2ms, 24ms, 101ms, 154ms, 700ms

Channels

Color

The measured color

Type:
  • Color - Only HSBType commands are accepted. Updating the brightness without changing the hue (e.g. by sending a PercentType) may fail.
UID:
  • tinkerforge:brickletcolor:[UID]:BrickletColorColor
Read only:
  • No
Parameters:
  • Update Interval – Type: integer, Default: 1000, Unit: ms, Min: 0, Max: 4294967295
  • Specifies the update interval in milliseconds. A value of 0 disables automatic updates.
Illuminance

The measured illuminance. 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 255. In that case you have to reduce the gain.

Type:
  • Number:Illuminance
UID:
  • tinkerforge:brickletcolor:[UID]:BrickletColorIlluminance
Read only:
  • Yes
Unit:
  • Lux
Range:
  • 0 Lux to 103438 Lux (Step 1 Lux)
Parameters:
  • Update Interval – Type: integer, Default: 1000, Unit: ms, Min: 0, Max: 4294967295
  • Specifies the update interval in milliseconds. A value of 0 disables automatic updates.
Color Temperature

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 255. In that case you have to reduce the gain.

Type:
  • Number:Temperature
UID:
  • tinkerforge:brickletcolor:[UID]:BrickletColorColorTemperature
Read only:
  • Yes
Unit:
  • Kelvin
Parameters:
  • Update Interval – Type: integer, Default: 1000, Unit: ms, Min: 0, Max: 4294967295
  • Specifies the update interval in milliseconds. A value of 0 disables automatic updates.
Light

Turns the white LED on the Bricklet on/off.

Type:
  • Switch
UID:
  • tinkerforge:brickletcolor:[UID]:BrickletColorLight
Read only:
  • No

Actions

Actions can be used in rules by creating an action object. All actions return a Map<String, Object>. Returned values can be accessed by name, sometimes the type deduction needs some hints, as shown below:

val actions = getActions("tinkerforge", "tinkerforge:brickletcolor:[UID]")
val hwVersion = actions.brickletColorGetIdentity().get("hardwareVersion") as short[]
logInfo("Example", "Hardware version: " + hwVersion.get(0) + "." + hwVersion.get(1) + "." + hwVersion.get(2))

Basic Actions

brickletColorGetColor()
Return Map:
  • r – Type: int, Range: [0 to 216 - 1]
  • g – Type: int, Range: [0 to 216 - 1]
  • b – Type: int, Range: [0 to 216 - 1]
  • c – Type: int, Range: [0 to 216 - 1]

Returns the measured color of the sensor.

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 Color channel and set the period with the configuration of Color.

brickletColorLightOn()

Turns the LED on.

brickletColorLightOff()

Turns the LED off.

brickletColorIsLightOn()
Return Map:
  • light – Type: short, Range: See constants, Default: 1

Returns the state of the LED. Possible values are:

  • 0: On
  • 1: Off

The following constants are available for this function:

For light:

  • val LIGHT_ON = 0
  • val LIGHT_OFF = 1
brickletColorGetConfig()
Return Map:
  • gain – Type: short, Range: See constants, Default: 3
  • integrationTime – Type: short, Range: See constants, Default: 3

Returns the configuration as set by the thing configuration.

The following constants are available for this function:

For gain:

  • val GAIN_1X = 0
  • val GAIN_4X = 1
  • val GAIN_16X = 2
  • val GAIN_60X = 3

For integrationTime:

  • val INTEGRATION_TIME_2MS = 0
  • val INTEGRATION_TIME_24MS = 1
  • val INTEGRATION_TIME_101MS = 2
  • val INTEGRATION_TIME_154MS = 3
  • val INTEGRATION_TIME_700MS = 4
brickletColorGetIlluminance()
Return Map:
  • illuminance – Type: long, Unit: ? lx, Range: [0 to 103438]

Returns the illuminance affected by the gain and integration time as set by the thing configuration. 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 themselves 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 the thing configuration.

brickletColorGetColorTemperature()
Return Map:
  • colorTemperature – Type: int, Unit: 1 K, Range: [0 to 216 - 1]

Returns the color temperature.

To get a correct color temperature measurement make sure that the color values themselves 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 the thing configuration.

Advanced Actions

brickletColorGetIdentity()
Return Map:
  • uid – Type: String, Length: up to 8
  • connectedUid – Type: String, Length: up to 8
  • position – Type: char, Range: ['a' to 'h', 'z']
  • hardwareVersion – Type: short[], Length: 3
    • 0: major – Type: short, Range: [0 to 255]
    • 1: minor – Type: short, Range: [0 to 255]
    • 2: revision – Type: short, Range: [0 to 255]
  • firmwareVersion – Type: short[], Length: 3
    • 0: major – Type: short, Range: [0 to 255]
    • 1: minor – Type: short, Range: [0 to 255]
    • 2: revision – Type: short, Range: [0 to 255]
  • deviceIdentifier – Type: int, Range: [0 to 216 - 1]

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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here.