Shell - Color Bricklet

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

Examples

The example code below is Public Domain (CC0 1.0).

Simple

Download (example-simple.sh)

1
2
3
4
5
6
7
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Color Bricklet

# Get current color
tinkerforge call color-bricklet $uid get-color

Callback

Download (example-callback.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Color Bricklet

# Handle incoming color callbacks
tinkerforge dispatch color-bricklet $uid color &

# 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!
tinkerforge call color-bricklet $uid set-color-callback-period 1000

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

Threshold

Download (example-threshold.sh)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
#!/bin/sh
# Connects to localhost:4223 by default, use --host and --port to change this

uid=XYZ # Change XYZ to the UID of your Color Bricklet

# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
tinkerforge call color-bricklet $uid set-debounce-period 10000

# Handle incoming color reached callbacks
tinkerforge dispatch color-bricklet $uid color-reached &

# Configure threshold for color "greater than 100, 200, 300, 400"
tinkerforge call color-bricklet $uid set-color-callback-threshold threshold-option-greater 100 0 200 0 300 0 400 0

echo "Press key to exit"; read dummy

kill -- -$$ # Stop callback dispatch in background

API

Possible exit codes for all tinkerforge commands are:

  • 1: interrupted (ctrl+c)
  • 2: syntax error
  • 21: Python 2.5 or newer is required
  • 22: Python argparse module is missing
  • 23: socket error
  • 24: other exception
  • 25: invalid placeholder in format string
  • 26: authentication error
  • 201: timeout occurred
  • 209: invalid argument value
  • 210: function is not supported
  • 211: unknown error

Command Structure

The common options of the call and dispatch commands are documented here. The specific command structure is shown below.

tinkerforge call color-bricklet [<option>..] <uid> <function> [<argument>..]
Parameters:
  • <uid> -- string
  • <function> -- string

The call command is used to call a function of the Color Bricklet. It can take several options:

  • --help shows help for the specific call command and exits
  • --list-functions shows a list of known functions of the Color Bricklet and exits
tinkerforge dispatch color-bricklet [<option>..] <uid> <callback>
Parameters:
  • <uid> -- string
  • <callback> -- string

The dispatch command is used to dispatch a callback of the Color Bricklet. It can take several options:

  • --help shows help for the specific dispatch command and exits
  • --list-callbacks shows a list of known callbacks of the Color Bricklet and exits
tinkerforge call color-bricklet <uid> <function> [<option>..] [<argument>..]
Parameters:
  • <uid> -- string
  • <function> -- string

The <function> to be called can take different options depending of its kind. All functions can take the following options:

  • --help shows help for the specific function and exits

Getter functions can take the following options:

  • --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Setter functions can take the following options:

  • --expect-response requests response and waits for it

The --expect-response option for setter functions allows to detect timeouts and other error conditions calls of setters as well. The device will then send a response for this purpose. If this option is not given for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

tinkerforge dispatch color-bricklet <uid> <callback> [<option>..]
Parameters:
  • <uid> -- string
  • <callback> -- string

The <callback> to be dispatched can take several options:

  • --help shows help for the specific callback and exits
  • --execute <command> shell command line to execute for each incoming response (see section about output formatting for details)

Basic Functions

tinkerforge call color-bricklet <uid> get-color
Output:
  • r -- int
  • g -- int
  • b -- int
  • c -- int

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 color callback and set the period with set-color-callback-period.

tinkerforge call color-bricklet <uid> light-on
Output:no output

Turns the LED on.

tinkerforge call color-bricklet <uid> light-off
Output:no output

Turns the LED off.

tinkerforge call color-bricklet <uid> is-light-on
Output:
  • light -- int (has symbols)

Returns the state of the LED. Possible values are:

  • 0: On
  • 1: Off

The following symbols are available for this function:

  • light-on = 0, for light
  • light-off = 1, for light
tinkerforge call color-bricklet <uid> set-config <gain> <integration-time>
Parameters:
  • <gain> -- int (has symbols)
  • <integration-time> -- int (has symbols)
Output:

no output

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

  • gain-1x = 0, for <gain>
  • gain-4x = 1, for <gain>
  • gain-16x = 2, for <gain>
  • gain-60x = 3, for <gain>
  • integration-time-2ms = 0, for <integration-time>
  • integration-time-24ms = 1, for <integration-time>
  • integration-time-101ms = 2, for <integration-time>
  • integration-time-154ms = 3, for <integration-time>
  • integration-time-700ms = 4, for <integration-time>
tinkerforge call color-bricklet <uid> get-config
Output:
  • gain -- int (has symbols)
  • integration-time -- int (has symbols)

Returns the configuration as set by set-config.

The following symbols are available for this function:

  • gain-1x = 0, for gain
  • gain-4x = 1, for gain
  • gain-16x = 2, for gain
  • gain-60x = 3, for gain
  • integration-time-2ms = 0, for integration-time
  • integration-time-24ms = 1, for integration-time
  • integration-time-101ms = 2, for integration-time
  • integration-time-154ms = 3, for integration-time
  • integration-time-700ms = 4, for integration-time
tinkerforge call color-bricklet <uid> get-illuminance
Output:
  • illuminance -- int

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

tinkerforge call color-bricklet <uid> get-color-temperature
Output:
  • color-temperature -- int

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 set-config.

Advanced Functions

tinkerforge call color-bricklet <uid> get-identity
Output:
  • uid -- string
  • connected-uid -- string
  • position -- char
  • hardware-version -- int,int,int
  • firmware-version -- int,int,int
  • device-identifier -- int (has symbols)

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

Callback Configuration Functions

tinkerforge call color-bricklet <uid> set-color-callback-period <period>
Parameters:
  • <period> -- int
Output:

no output

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

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

The default value is 0.

tinkerforge call color-bricklet <uid> get-color-callback-period
Output:
  • period -- int

Returns the period as set by set-color-callback-period.

tinkerforge call color-bricklet <uid> set-color-callback-threshold <option> <min-r> <max-r> <min-g> <max-g> <min-b> <max-b> <min-c> <max-c>
Parameters:
  • <option> -- char (has symbols)
  • <min-r> -- int
  • <max-r> -- int
  • <min-g> -- int
  • <max-g> -- int
  • <min-b> -- int
  • <max-b> -- int
  • <min-c> -- int
  • <max-c> -- int
Output:

no output

Sets the thresholds for the 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 default value is ('x', 0, 0, 0, 0, 0, 0, 0, 0).

The following symbols are available for this function:

  • threshold-option-off = x, for <option>
  • threshold-option-outside = o, for <option>
  • threshold-option-inside = i, for <option>
  • threshold-option-smaller = <, for <option>
  • threshold-option-greater = >, for <option>
tinkerforge call color-bricklet <uid> get-color-callback-threshold
Output:
  • option -- char (has symbols)
  • min-r -- int
  • max-r -- int
  • min-g -- int
  • max-g -- int
  • min-b -- int
  • max-b -- int
  • min-c -- int
  • max-c -- int

Returns the threshold as set by set-color-callback-threshold.

The following symbols are available for this function:

  • threshold-option-off = x, for option
  • threshold-option-outside = o, for option
  • threshold-option-inside = i, for option
  • threshold-option-smaller = <, for option
  • threshold-option-greater = >, for option
tinkerforge call color-bricklet <uid> set-debounce-period <debounce>
Parameters:
  • <debounce> -- int
Output:

no output

Sets the period in ms with which the threshold callback

is triggered, if the threshold

keeps being reached.

The default value is 100.

tinkerforge call color-bricklet <uid> get-debounce-period
Output:
  • debounce -- int

Returns the debounce period as set by set-debounce-period.

tinkerforge call color-bricklet <uid> set-illuminance-callback-period <period>
Parameters:
  • <period> -- int
Output:

no output

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

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

The default value is 0.

tinkerforge call color-bricklet <uid> get-illuminance-callback-period
Output:
  • period -- int

Returns the period as set by set-illuminance-callback-period.

tinkerforge call color-bricklet <uid> set-color-temperature-callback-period <period>
Parameters:
  • <period> -- int
Output:

no output

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

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

The default value is 0.

tinkerforge call color-bricklet <uid> get-color-temperature-callback-period
Output:
  • period -- int

Returns the period as set by set-color-temperature-callback-period.

Callbacks

Callbacks can be used to receive time critical or recurring data from the device:

tinkerforge dispatch color-bricklet <uid> example

The available callbacks 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.

tinkerforge dispatch color-bricklet <uid> color
Output:
  • r -- int
  • g -- int
  • b -- int
  • c -- int

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

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

tinkerforge dispatch color-bricklet <uid> color-reached
Output:
  • r -- int
  • g -- int
  • b -- int
  • c -- int

This callback is triggered when the threshold as set by set-color-callback-threshold 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 set-debounce-period.

tinkerforge dispatch color-bricklet <uid> illuminance
Output:
  • illuminance -- int

This callback is triggered periodically with the period that is set by set-illuminance-callback-period. The parameter is the illuminance. See get-illuminance for how to interpret this value.

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

tinkerforge dispatch color-bricklet <uid> color-temperature
Output:
  • color-temperature -- int

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

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