Shell - Color Bricklet – Tinkerforge

- Getting Started
  - Primer
  - Tutorials
  - FAQ
- Hardware
  - Bricks
  - Bricklets
  - Master Extensions
  - Power Supplies
  - Accessories
  - Timeline
- Software
  - Brick Daemon (brickd)
  - Brick Viewer (brickv)
  - API Bindings
    - C/C++
    - C/C++ (iOS)
    - C#
    - C# (Windows Phone)
    - Delphi/Lazarus
    - Java
    - Java (Android)
    - JavaScript
    - LabVIEW
    - Mathematica
    - MATLAB/Octave
    - Perl
    - PHP
    - Python
    - Ruby
    - Shell
      - Requirements
      - Installation
      - Testing an Example
      - API Reference and Examples
        - IP Connection
        - Bricks
        - Bricklets
          - Ambient Light Bricklet
          - Analog In Bricklet
          - Analog Out Bricklet
          - Barometer Bricklet
          - Color Bricklet
            - Examples
              - Simple
              - Callback
              - Threshold
            - API
              - Command Structure
              - Basic Functions
              - Advanced Functions
              - Callback Configuration Functions
              - Callbacks
          - Current12 Bricklet
          - Current25 Bricklet
          - Distance IR Bricklet
          - Distance US Bricklet
          - Dual Button Bricklet
          - Dual Relay Bricklet
          - GPS Bricklet
          - Hall Effect Bricklet
          - Humidity Bricklet
          - Industrial Digital In 4 Bricklet
          - Industrial Digital Out 4 Bricklet
          - Industrial Dual 0-20mA Bricklet
          - Industrial Quad Relay Bricklet
          - IO-16 Bricklet
          - IO-4 Bricklet
          - Joystick Bricklet
          - LCD 16x2 Bricklet
          - LCD 20x4 Bricklet
          - LED Strip Bricklet
          - Line Bricklet
          - Linear Poti Bricklet
          - Moisture Bricklet
          - Motion Detector Bricklet
          - Multi Touch Bricklet
          - NFC/RFID Bricklet
          - Piezo Buzzer Bricklet
          - Piezo Speaker Bricklet
          - PTC Bricklet
          - Remote Switch Bricklet
          - Rotary Encoder Bricklet
          - Rotary Poti Bricklet
          - Segment Display 4x7 Bricklet
          - Solid State Relay Bricklet
          - Sound Intensity Bricklet
          - Temperature Bricklet
          - Temperature IR Bricklet
          - Tilt Bricklet
          - Voltage Bricklet
          - Voltage/Current Bricklet
    - Visual Basic .NET
  - Firmwares and Plugins
  - Device Identifier
  - Source Code and Bug Tracking
  - Programming Interface
- Starter Kits
  - Weather Station
  - Hardware Hacking
  - Server Room Monitoring
  - Blinkenlights
  - Internet of Things
  - Camera Slider
- Embedded Boards
  - Raspberry Pi
- Specifications
  - Technical Data
  - TCP/IP Protocol
  - Modbus Protocol
  - Wireshark Dissector

# 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
    8

    #!/bin/sh
    # connects to localhost:4223 by default, use --host and --port to change it

    # change to your UID
    uid=abc

    # 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

    #!/bin/sh
    # connects to localhost:4223 by default, use --host and --port to change it

    # change to your UID
    uid=abc

    # 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

    # handle incoming color callbacks
    tinkerforge dispatch color-bricklet $uid color

### Threshold

Download (example-threshold.sh)

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23

    #!/bin/sh
    # connects to localhost:4223 by default, use --host and --port to change it

    # change to your UID
    uid=abc

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

    # Configure threshold for color values,
    # RED   greater than 100
    # GREEN greater than 200
    # BLUE  greater than 300
    # CLEAR greater than 400
    tinkerforge call color-bricklet $uid set-color-callback-threshold greater 100 0 200 0 300 0 400 0

    # handle incoming color-reached callbacks
    tinkerforge dispatch color-bricklet $uid color-reached\
     --execute "echo 'Color(R): {r}';
                echo 'Color(G): {g}';
                echo 'Color(B): {b}';
                echo 'Color(C): {c}';
                echo '';"

## 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:

  If you want to get the color periodically, it is recommended to use the callback `color` 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:

  - `on` = 0, for 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:

  - `1x` = 0, for <gain>
  - `4x` = 1, for <gain>
  - `16x` = 2, for <gain>
  - `60x` = 3, for <gain>
  - `2ms` = 0, for <integration-time>
  - `24ms` = 1, for <integration-time>
  - `101ms` = 2, for <integration-time>
  - `154ms` = 3, for <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:

  - `1x` = 0, for gain
  - `4x` = 1, for gain
  - `16x` = 2, for gain
  - `60x` = 3, for gain
  - `2ms` = 0, for integration-time
  - `24ms` = 1, for integration-time
  - `101ms` = 2, for integration-time
  - `154ms` = 3, for 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.

  `color` 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:

  - `off` = x, for <option>
  - `outside` = o, for <option>
  - `inside` = i, for <option>
  - `smaller` = <, for <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:

  - `off` = x, for option
  - `outside` = o, for option
  - `inside` = i, for option
  - `smaller` = <, for 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

  - `color-reached`

  is triggered, if the threshold

  - `set-color-callback-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.

  `illuminance` 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.

  `color-temperature` 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.

  `color` 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.

  `illuminance` 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.

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

The content of this page is licensed under Creative Commons Attribution 3.0 Unported License.