MQTT - Color Bricklet¶

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

Basic Functions¶

request/color_bricklet/<UID>/get_color¶

Request:	empty payload
Response:	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:

If you want to get the color periodically, it is recommended to use the register/color_bricklet/<UID>/color callback and set the period with request/color_bricklet/<UID>/set_color_callback_period.

request/color_bricklet/<UID>/light_on¶

Request:	empty payload
Response:	no response

Turns the LED on.

request/color_bricklet/<UID>/light_off¶

Request:	empty payload
Response:	no response

Turns the LED off.

request/color_bricklet/<UID>/is_light_on¶

Request:	empty payload
Response:	light – Type: int, Range: See symbols, Default: 1

Returns the state of the LED. Possible values are:

• 0: On
• 1: Off

The following symbols are available for this function:

For light:

• "on" = 0
• "off" = 1

request/color_bricklet/<UID>/set_config¶

Request:	gain – Type: int, Range: See symbols, Default: 3 integration_time – Type: int, Range: See symbols, Default: 3
Response:	no response

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 following symbols are available for this function:

For gain:

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

For integration_time:

• "2ms" = 0
• "24ms" = 1
• "101ms" = 2
• "154ms" = 3
• "700ms" = 4

request/color_bricklet/<UID>/get_config¶

Request:	empty payload
Response:	gain – Type: int, Range: See symbols, Default: 3 integration_time – Type: int, Range: See symbols, Default: 3

Returns the configuration as set by request/color_bricklet/<UID>/set_config.

The following symbols are available for this function:

For gain:

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

For integration_time:

• "2ms" = 0
• "24ms" = 1
• "101ms" = 2
• "154ms" = 3
• "700ms" = 4

request/color_bricklet/<UID>/get_illuminance¶

Request:	empty payload
Response:	illuminance – Type: int, Unit: ? lx, Range: [0 to 103438]

Returns the illuminance affected by the gain and integration time as set by request/color_bricklet/<UID>/set_config. 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 request/color_bricklet/<UID>/set_config.

request/color_bricklet/<UID>/get_color_temperature¶

Request:	empty payload
Response:	color_temperature – 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 request/color_bricklet/<UID>/set_config.

Advanced Functions¶

request/color_bricklet/<UID>/get_identity¶

Request:

empty payload

Response:

uid – Type: string, Length: up to 8 connected_uid – Type: string, Length: up to 8 position – Type: char, Range: ["a" to "h", "z"] hardware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] firmware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] device_identifier – Type: int, Range: [0 to 216 - 1] _display_name – Type: string

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. If symbolic output is not disabled, the device identifier is mapped to the corresponding name in the format used in topics.

The display name contains the Color's name in a human readable form.

Callback Configuration Functions¶

request/color_bricklet/<UID>/set_color_callback_period¶

Request:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Response:	no response

Sets the period with which the register/color_bricklet/<UID>/color callback is triggered periodically. A value of 0 turns the callback off.

The register/color_bricklet/<UID>/color callback is only triggered if the color has changed since the last triggering.

request/color_bricklet/<UID>/get_color_callback_period¶

Request:	empty payload
Response:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by request/color_bricklet/<UID>/set_color_callback_period.

request/color_bricklet/<UID>/set_color_callback_threshold¶

Request:

option – Type: char, Range: See symbols, Default: "x" min_r – Type: int, Range: [0 to 216 - 1], Default: 0 max_r – Type: int, Range: [0 to 216 - 1], Default: 0 min_g – Type: int, Range: [0 to 216 - 1], Default: 0 max_g – Type: int, Range: [0 to 216 - 1], Default: 0 min_b – Type: int, Range: [0 to 216 - 1], Default: 0 max_b – Type: int, Range: [0 to 216 - 1], Default: 0 min_c – Type: int, Range: [0 to 216 - 1], Default: 0 max_c – Type: int, Range: [0 to 216 - 1], Default: 0

Response:

no response

Sets the thresholds for the register/color_bricklet/<UID>/color_reached 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 following symbols are available for this function:

For option:

• "off" = "x"
• "outside" = "o"
• "inside" = "i"
• "smaller" = "<"
• "greater" = ">"

request/color_bricklet/<UID>/get_color_callback_threshold¶

Request:

empty payload

Response:

option – Type: char, Range: See symbols, Default: "x" min_r – Type: int, Range: [0 to 216 - 1], Default: 0 max_r – Type: int, Range: [0 to 216 - 1], Default: 0 min_g – Type: int, Range: [0 to 216 - 1], Default: 0 max_g – Type: int, Range: [0 to 216 - 1], Default: 0 min_b – Type: int, Range: [0 to 216 - 1], Default: 0 max_b – Type: int, Range: [0 to 216 - 1], Default: 0 min_c – Type: int, Range: [0 to 216 - 1], Default: 0 max_c – Type: int, Range: [0 to 216 - 1], Default: 0

Returns the threshold as set by request/color_bricklet/<UID>/set_color_callback_threshold.

The following symbols are available for this function:

For option:

• "off" = "x"
• "outside" = "o"
• "inside" = "i"
• "smaller" = "<"
• "greater" = ">"

request/color_bricklet/<UID>/set_debounce_period¶

Request:	debounce – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100
Response:	no response

Sets the period with which the threshold callback

• register/color_bricklet/<UID>/color_reached

is triggered, if the threshold

• request/color_bricklet/<UID>/set_color_callback_threshold

keeps being reached.

request/color_bricklet/<UID>/get_debounce_period¶

Request:	empty payload
Response:	debounce – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 100

Returns the debounce period as set by request/color_bricklet/<UID>/set_debounce_period.

request/color_bricklet/<UID>/set_illuminance_callback_period¶

Request:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Response:	no response

Sets the period with which the register/color_bricklet/<UID>/illuminance callback is triggered periodically. A value of 0 turns the callback off.

The register/color_bricklet/<UID>/illuminance callback is only triggered if the illuminance has changed since the last triggering.

request/color_bricklet/<UID>/get_illuminance_callback_period¶

Request:	empty payload
Response:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by request/color_bricklet/<UID>/set_illuminance_callback_period.

request/color_bricklet/<UID>/set_color_temperature_callback_period¶

Request:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Response:	no response

Sets the period with which the register/color_bricklet/<UID>/color_temperature callback is triggered periodically. A value of 0 turns the callback off.

The register/color_bricklet/<UID>/color_temperature callback is only triggered if the color temperature has changed since the last triggering.

request/color_bricklet/<UID>/get_color_temperature_callback_period¶

Request:	empty payload
Response:	period – Type: int, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by request/color_bricklet/<UID>/set_color_temperature_callback_period.

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding .../register/... topic and an optional suffix. This suffix can be used to deregister the callback later.

register/color_bricklet/<UID>/color¶

Register Request:	register – Type: bool
Callback Response:	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]

A callback can be registered for this event by publishing to the .../register/color_bricklet/<UID>/color[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/color_bricklet/<UID>/color[/<SUFFIX>] topic for each registered suffix.

This callback is triggered periodically with the period that is set by request/color_bricklet/<UID>/set_color_callback_period. The callback payload is the color of the sensor as RGBC.

The register/color_bricklet/<UID>/color callback is only triggered if the color has changed since the last triggering.

register/color_bricklet/<UID>/color_reached¶

Register Request:	register – Type: bool
Callback Response:	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]

A callback can be registered for this event by publishing to the .../register/color_bricklet/<UID>/color_reached[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/color_bricklet/<UID>/color_reached[/<SUFFIX>] topic for each registered suffix.

This callback is triggered when the threshold as set by request/color_bricklet/<UID>/set_color_callback_threshold is reached. The callback payload 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 request/color_bricklet/<UID>/set_debounce_period.

register/color_bricklet/<UID>/illuminance¶

Register Request:	register – Type: bool
Callback Response:	illuminance – Type: int, Unit: ? lx, Range: [0 to 103438]

A callback can be registered for this event by publishing to the .../register/color_bricklet/<UID>/illuminance[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/color_bricklet/<UID>/illuminance[/<SUFFIX>] topic for each registered suffix.

This callback is triggered periodically with the period that is set by request/color_bricklet/<UID>/set_illuminance_callback_period. The callback payload is the illuminance. See request/color_bricklet/<UID>/get_illuminance for how to interpret this value.

The register/color_bricklet/<UID>/illuminance callback is only triggered if the illuminance has changed since the last triggering.

register/color_bricklet/<UID>/color_temperature¶

Register Request:	register – Type: bool
Callback Response:	color_temperature – Type: int, Unit: 1 K, Range: [0 to 216 - 1]

A callback can be registered for this event by publishing to the .../register/color_bricklet/<UID>/color_temperature[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/color_bricklet/<UID>/color_temperature[/<SUFFIX>] topic for each registered suffix.

This callback is triggered periodically with the period that is set by request/color_bricklet/<UID>/set_color_temperature_callback_period. The callback payload is the color temperature.

The register/color_bricklet/<UID>/color_temperature callback is only triggered if the color temperature has changed since the last triggering.