..
 #############################################################
 # This file was automatically generated on 2015-05-08.      #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #
 # to the generators git repository on tinkerforge.com       #
 #############################################################


:breadcrumbs: <a href="../../index.html">Home</a> / <a href="../../index.html#software-shell">Software</a> / Shell - Color Bricklet

.. |device_identifier_constant| unicode:: 0xA0
   :trim:

.. _color_bricklet_shell:

Shell - Color Bricklet
======================

This is the description of the :ref:`Shell API bindings <api_bindings_shell>` for the :ref:`Color Bricklet <color_bricklet>`. General information and technical
specifications for the Color Bricklet are summarized in its :ref:`hardware description
<color_bricklet_description>`.

An :ref:`installation guide <api_bindings_shell_install>` for the Shell API
bindings is part of their general description.

.. _color_bricklet_shell_examples:


Examples
--------

The example code below is `Public Domain (CC0 1.0)
<http://creativecommons.org/publicdomain/zero/1.0/>`__.

Simple
^^^^^^

`Download (example-simple.sh) <https://github.com/Tinkerforge/color-bricklet/raw/master/software/examples/shell/example-simple.sh>`__

.. literalinclude:: Color_Bricklet_Shell_example-simple.sh
 :language: bash
 :linenos:
 :tab-width: 4

Callback
^^^^^^^^

`Download (example-callback.sh) <https://github.com/Tinkerforge/color-bricklet/raw/master/software/examples/shell/example-callback.sh>`__

.. literalinclude:: Color_Bricklet_Shell_example-callback.sh
 :language: bash
 :linenos:
 :tab-width: 4

Threshold
^^^^^^^^^

`Download (example-threshold.sh) <https://github.com/Tinkerforge/color-bricklet/raw/master/software/examples/shell/example-threshold.sh>`__

.. literalinclude:: Color_Bricklet_Shell_example-threshold.sh
 :language: bash
 :linenos:
 :tab-width: 4

.. _color_bricklet_shell_api:

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
:ref:`here <ipcon_shell_api>`. The specific command structure is shown below.

.. sh:function:: X Stinkerforge Pcall Ncolor-bricklet A[<option>..] L<uid> L<function> L[<argument>..]

 :param <uid>: string
 :param <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


.. sh:function:: X Stinkerforge Pdispatch Ncolor-bricklet A[<option>..] L<uid> L<callback>

 :param <uid>: string
 :param <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


.. sh:function:: X Stinkerforge Scall Pcolor-bricklet L<uid> N<function> A[<option>..] L[<argument>..]

 :param <uid>: string
 :param <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 :ref:`output formatting <ipcon_shell_output>`
   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.


.. sh:function:: X Stinkerforge Sdispatch Pcolor-bricklet L<uid> N<callback> A[<option>..]

 :param <uid>: string
 :param <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 :ref:`output formatting <ipcon_shell_output>`
   for details)



Basic Functions
^^^^^^^^^^^^^^^



.. sh:function:: tinkerforge call color-bricklet <uid> get-color  


 :returns r: int
 :returns g: int
 :returns b: int
 :returns 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:
 
 .. image:: /Images/Bricklets/bricklet_color_wavelength_chart_600.jpg
    :scale: 100 %
    :alt: Chart Responsivity / Wavelength
    :align: center
    :target: ../../_images/Bricklets/bricklet_color_wavelength_chart_600.jpg
 
 If you want to get the color periodically, it is recommended 
 to use the callback :sh:func:`color <color-bricklet color>` and set the period with 
 :sh:func:`set-color-callback-period <color-bricklet set-color-callback-period>`.
 
.. sh:function:: tinkerforge call color-bricklet <uid> light-on  


 :noreturn: no output

 Turns the LED on.
 
.. sh:function:: tinkerforge call color-bricklet <uid> light-off  


 :noreturn: no output

 Turns the LED off.
 
.. sh:function:: tinkerforge call color-bricklet <uid> is-light-on  


 :returns 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
 
.. sh:function:: tinkerforge call color-bricklet <uid> set-config <gain> <integration-time> 

 :param <gain>: int (has symbols)
 :param <integration-time>: int (has symbols)

 :noreturn: 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>
 
.. sh:function:: tinkerforge call color-bricklet <uid> get-config  


 :returns gain: int (has symbols)
 :returns integration-time: int (has symbols)

 Returns the configuration as set by :sh:func:`set-config <color-bricklet 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
 
.. sh:function:: tinkerforge call color-bricklet <uid> get-illuminance  


 :returns illuminance: int

 Returns the illuminance affected by the gain and integration time as
 set by :sh:func:`set-config <color-bricklet 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 :sh:func:`set-config <color-bricklet set-config>`.
 
.. sh:function:: tinkerforge call color-bricklet <uid> get-color-temperature  


 :returns 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 :sh:func:`set-config <color-bricklet set-config>`.
 


Advanced Functions
^^^^^^^^^^^^^^^^^^

.. sh:function:: tinkerforge call color-bricklet <uid> get-identity  


 :returns uid: string
 :returns connected-uid: string
 :returns position: char
 :returns hardware-version: int,int,int
 :returns firmware-version: int,int,int
 :returns 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 :ref:`here <device_identifier>`.
 |device_identifier_constant|
 


Callback Configuration Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



.. sh:function:: tinkerforge call color-bricklet <uid> set-color-callback-period <period> 

 :param <period>: int

 :noreturn: no output

 Sets the period in ms with which the :sh:func:`color <color-bricklet color>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :sh:func:`color <color-bricklet color>` is only triggered if the color has changed since the
 last triggering.
 
 The default value is 0.
 
.. sh:function:: tinkerforge call color-bricklet <uid> get-color-callback-period  


 :returns period: int

 Returns the period as set by :sh:func:`set-color-callback-period <color-bricklet set-color-callback-period>`.
 
.. sh:function:: 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> 

 :param <option>: char (has symbols)
 :param <min-r>: int
 :param <max-r>: int
 :param <min-g>: int
 :param <max-g>: int
 :param <min-b>: int
 :param <max-b>: int
 :param <min-c>: int
 :param <max-c>: int

 :noreturn: no output

 Sets the thresholds for the :sh:func:`color-reached <color-bricklet color-reached>` callback. 
 
 The following options are possible:
 
 .. csv-table::
  :header: "Option", "Description"
  :widths: 10, 100
 
  "'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>
 
.. sh:function:: tinkerforge call color-bricklet <uid> get-color-callback-threshold  


 :returns option: char (has symbols)
 :returns min-r: int
 :returns max-r: int
 :returns min-g: int
 :returns max-g: int
 :returns min-b: int
 :returns max-b: int
 :returns min-c: int
 :returns max-c: int

 Returns the threshold as set by :sh:func:`set-color-callback-threshold <color-bricklet 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
 
.. sh:function:: tinkerforge call color-bricklet <uid> set-debounce-period <debounce> 

 :param <debounce>: int

 :noreturn: no output

 Sets the period in ms with which the threshold callback
 
 * :sh:func:`color-reached <color-bricklet color-reached>`
 
 is triggered, if the threshold
 
 * :sh:func:`set-color-callback-threshold <color-bricklet set-color-callback-threshold>`
 
 keeps being reached.
 
 The default value is 100.
 
.. sh:function:: tinkerforge call color-bricklet <uid> get-debounce-period  


 :returns debounce: int

 Returns the debounce period as set by :sh:func:`set-debounce-period <color-bricklet set-debounce-period>`.
 
.. sh:function:: tinkerforge call color-bricklet <uid> set-illuminance-callback-period <period> 

 :param <period>: int

 :noreturn: no output

 Sets the period in ms with which the :sh:func:`illuminance <color-bricklet illuminance>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :sh:func:`illuminance <color-bricklet illuminance>` is only triggered if the illuminance has changed since the
 last triggering.
 
 The default value is 0.
 
.. sh:function:: tinkerforge call color-bricklet <uid> get-illuminance-callback-period  


 :returns period: int

 Returns the period as set by :sh:func:`set-illuminance-callback-period <color-bricklet set-illuminance-callback-period>`.
 
.. sh:function:: tinkerforge call color-bricklet <uid> set-color-temperature-callback-period <period> 

 :param <period>: int

 :noreturn: no output

 Sets the period in ms with which the :sh:func:`color-temperature <color-bricklet color-temperature>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :sh:func:`color-temperature <color-bricklet color-temperature>` is only triggered if the color temperature has changed since the
 last triggering.
 
 The default value is 0.
 
.. sh:function:: tinkerforge call color-bricklet <uid> get-color-temperature-callback-period  


 :returns period: int

 Returns the period as set by :sh:func:`set-color-temperature-callback-period <color-bricklet set-color-temperature-callback-period>`.
 


.. _color_bricklet_shell_callbacks:

Callbacks
^^^^^^^^^

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

.. code-block:: bash

    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.

.. sh:function::  tinkerforge dispatch color-bricklet <uid> color

 :returns r: int
 :returns g: int
 :returns b: int
 :returns c: int


 This callback is triggered periodically with the period that is set by
 :sh:func:`set-color-callback-period <color-bricklet set-color-callback-period>`. The parameter is the color
 of the sensor as RGBC.
 
 :sh:func:`color <color-bricklet color>` is only triggered if the color has changed since the
 last triggering.
 
.. sh:function::  tinkerforge dispatch color-bricklet <uid> color-reached

 :returns r: int
 :returns g: int
 :returns b: int
 :returns c: int


 This callback is triggered when the threshold as set by
 :sh:func:`set-color-callback-threshold <color-bricklet 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 :sh:func:`set-debounce-period <color-bricklet set-debounce-period>`.
 
.. sh:function::  tinkerforge dispatch color-bricklet <uid> illuminance

 :returns illuminance: int


 This callback is triggered periodically with the period that is set by
 :sh:func:`set-illuminance-callback-period <color-bricklet set-illuminance-callback-period>`. The parameter is the illuminance.
 See :sh:func:`get-illuminance <color-bricklet get-illuminance>` for how to interpret this value.
 
 :sh:func:`illuminance <color-bricklet illuminance>` is only triggered if the illuminance has changed since the
 last triggering.
 
.. sh:function::  tinkerforge dispatch color-bricklet <uid> color-temperature

 :returns color-temperature: int


 This callback is triggered periodically with the period that is set by
 :sh:func:`set-color-temperature-callback-period <color-bricklet set-color-temperature-callback-period>`. The parameter is the 
 color temperature in Kelvin.
 
 :sh:func:`color-temperature <color-bricklet color-temperature>` is only triggered if the color temperature has 
 changed since the last triggering.
 


