..
 #############################################################
 # 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-java">Software</a> / Java - Color Bricklet

.. |device_identifier_constant| replace:: There is also a :ref:`constant <color_bricklet_java_constants>` for the device identifier of this Bricklet.

.. _color_bricklet_java:

Java - Color Bricklet
=====================

This is the description of the :ref:`Java API bindings <api_bindings_java>` 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_java_install>` for the Java API
bindings is part of their general description.

.. _color_bricklet_java_examples:


Examples
--------

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

Simple
^^^^^^

`Download (ExampleSimple.java) <https://github.com/Tinkerforge/color-bricklet/raw/master/software/examples/java/ExampleSimple.java>`__

.. literalinclude:: Color_Bricklet_Java_ExampleSimple.java
 :language: java
 :linenos:
 :tab-width: 4

Callback
^^^^^^^^

`Download (ExampleCallback.java) <https://github.com/Tinkerforge/color-bricklet/raw/master/software/examples/java/ExampleCallback.java>`__

.. literalinclude:: Color_Bricklet_Java_ExampleCallback.java
 :language: java
 :linenos:
 :tab-width: 4

Threshold
^^^^^^^^^

`Download (ExampleThreshold.java) <https://github.com/Tinkerforge/color-bricklet/raw/master/software/examples/java/ExampleThreshold.java>`__

.. literalinclude:: Color_Bricklet_Java_ExampleThreshold.java
 :language: java
 :linenos:
 :tab-width: 4

.. _color_bricklet_java_api:

API
---

Generally, every method of the Java bindings that returns a value can
throw a ``TimeoutException``. This exception gets thrown if the
device did not respond. If a cable based connection is used, it is
unlikely that this exception gets thrown (assuming nobody unplugs the
device). However, if a wireless connection is used, timeouts will occur
if the distance to the device gets too big.

Beside the ``TimeoutException`` there is also a ``NotConnectedException`` that
is thrown if a method needs to communicate with the device while the
IP Connection is not connected.

Since Java does not support multiple return values and return by reference
is not possible for primitive types, we use small classes that
only consist of member variables. The member variables of the returned objects
are described in the corresponding method descriptions.

The package for all Brick/Bricklet bindings and the IP Connection is
``com.tinkerforge.*``

All methods listed below are thread-safe.




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


.. java:function:: class BrickletColor(String uid, IPConnection ipcon)

 Creates an object with the unique device ID ``uid``:

 .. code-block:: java

  BrickletColor color = new BrickletColor("YOUR_DEVICE_UID", ipcon);

 This object can then be used after the IP Connection is connected
 (see examples :ref:`above <color_bricklet_java_examples>`).


.. java:function:: public BrickletColor.Color BrickletColor::getColor()

 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 listener :java:func:`ColorListener <BrickletColor.ColorListener>` and set the period with 
 :java:func:`setColorCallbackPeriod() <BrickletColor::setColorCallbackPeriod>`.
 
 The returned object has the public member variables ``int r``, ``int g``, ``int b`` and ``int c``.

.. java:function:: public void BrickletColor::lightOn()

 Turns the LED on.
 
.. java:function:: public void BrickletColor::lightOff()

 Turns the LED off.
 
.. java:function:: public short BrickletColor::isLightOn()

 Returns the state of the LED. Possible values are:
 
 * 0: On
 * 1: Off
 
 The following constants are available for this function:
 
 * BrickletColor.LIGHT_ON = 0
 * BrickletColor.LIGHT_OFF = 1
 
.. java:function:: public void BrickletColor::setConfig(short gain, short integrationTime)

 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 constants are available for this function:
 
 * BrickletColor.GAIN_1X = 0
 * BrickletColor.GAIN_4X = 1
 * BrickletColor.GAIN_16X = 2
 * BrickletColor.GAIN_60X = 3
 * BrickletColor.INTEGRATION_TIME_2MS = 0
 * BrickletColor.INTEGRATION_TIME_24MS = 1
 * BrickletColor.INTEGRATION_TIME_101MS = 2
 * BrickletColor.INTEGRATION_TIME_154MS = 3
 * BrickletColor.INTEGRATION_TIME_700MS = 4
 
.. java:function:: public BrickletColor.Config BrickletColor::getConfig()

 Returns the configuration as set by :java:func:`setConfig() <BrickletColor::setConfig>`.
 
 The following constants are available for this function:
 
 * BrickletColor.GAIN_1X = 0
 * BrickletColor.GAIN_4X = 1
 * BrickletColor.GAIN_16X = 2
 * BrickletColor.GAIN_60X = 3
 * BrickletColor.INTEGRATION_TIME_2MS = 0
 * BrickletColor.INTEGRATION_TIME_24MS = 1
 * BrickletColor.INTEGRATION_TIME_101MS = 2
 * BrickletColor.INTEGRATION_TIME_154MS = 3
 * BrickletColor.INTEGRATION_TIME_700MS = 4
 
 The returned object has the public member variables ``short gain`` and ``short integrationTime``.

.. java:function:: public long BrickletColor::getIlluminance()

 Returns the illuminance affected by the gain and integration time as
 set by :java:func:`setConfig() <BrickletColor::setConfig>`. 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 :java:func:`setConfig() <BrickletColor::setConfig>`.
 
.. java:function:: public int BrickletColor::getColorTemperature()

 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 :java:func:`setConfig() <BrickletColor::setConfig>`.
 


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

.. java:function:: public short[] BrickletColor::getAPIVersion()

 Returns the version of the API definition (major, minor, revision) implemented
 by this API bindings. This is neither the release version of this API bindings
 nor does it tell you anything about the represented Brick or Bricklet.
 
.. java:function:: public boolean BrickletColor::getResponseExpected(short functionId)

 Returns the response expected flag for the function specified by the function
 ID parameter. It is *true* if the function is expected to send a response,
 *false* otherwise.
 
 For getter functions this is enabled by default and cannot be disabled,
 because those functions will always send a response. For listener configuration
 functions it is enabled by default too, but can be disabled by
 :java:func:`setResponseExpected() <BrickletColor::setResponseExpected>`. For setter functions it is disabled by default
 and can be enabled.
 
 Enabling the response expected flag for a setter function allows to detect
 timeouts and other error conditions calls of this setter as well. The
 device will then send a response for this purpose. If this flag is disabled for
 a setter function then no response is send and errors are silently ignored,
 because they cannot be detected.
 
 See :java:func:`setResponseExpected() <BrickletColor::setResponseExpected>`
 for the list of function ID constants available for this function.
 
.. java:function:: public void BrickletColor::setResponseExpected(short functionId, boolean responseExpected)

 Changes the response expected flag of the function specified by the
 function ID parameter. This flag can only be changed for setter (default value:
 *false*) and listener configuration functions (default value: *true*). For
 getter functions it is always enabled and listeners it is always disabled.
 
 Enabling the response expected flag for a setter function allows to detect
 timeouts and other error conditions calls of this setter as well. The
 device will then send a response for this purpose. If this flag is disabled for
 a setter function then no response is send and errors are silently ignored,
 because they cannot be detected.
 
 The following function ID constants are available for this function:
 
 * BrickletColor.FUNCTION_SET_COLOR_CALLBACK_PERIOD = 2
 * BrickletColor.FUNCTION_SET_COLOR_CALLBACK_THRESHOLD = 4
 * BrickletColor.FUNCTION_SET_DEBOUNCE_PERIOD = 6
 * BrickletColor.FUNCTION_LIGHT_ON = 10
 * BrickletColor.FUNCTION_LIGHT_OFF = 11
 * BrickletColor.FUNCTION_SET_CONFIG = 13
 * BrickletColor.FUNCTION_SET_ILLUMINANCE_CALLBACK_PERIOD = 17
 * BrickletColor.FUNCTION_SET_COLOR_TEMPERATURE_CALLBACK_PERIOD = 19
 
.. java:function:: public void BrickletColor::setResponseExpectedAll(boolean responseExpected)

 Changes the response expected flag for all setter and listener configuration
 functions of this device at once.
 
.. java:function:: public BrickletColor.Identity BrickletColor::getIdentity()

 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|
 
 The returned object has the public member variables ``String uid``, ``String connectedUid``, ``char position``, ``short[] hardwareVersion``, ``short[] firmwareVersion`` and ``int deviceIdentifier``.



Listener Configuration Functions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. java:function:: public void BrickletColor::setColorCallbackPeriod(long period)

 Sets the period in ms with which the :java:func:`ColorListener <BrickletColor.ColorListener>` listener is triggered
 periodically. A value of 0 turns the listener off.
 
 :java:func:`ColorListener <BrickletColor.ColorListener>` is only triggered if the color has changed since the
 last triggering.
 
 The default value is 0.
 
.. java:function:: public long BrickletColor::getColorCallbackPeriod()

 Returns the period as set by :java:func:`setColorCallbackPeriod() <BrickletColor::setColorCallbackPeriod>`.
 
.. java:function:: public void BrickletColor::setColorCallbackThreshold(char option, int minR, int maxR, int minG, int maxG, int minB, int maxB, int minC, int maxC)

 Sets the thresholds for the :java:func:`ColorReachedListener <BrickletColor.ColorReachedListener>` listener. 
 
 The following options are possible:
 
 .. csv-table::
  :header: "Option", "Description"
  :widths: 10, 100
 
  "'x'",    "Listener is turned off"
  "'o'",    "Listener is triggered when the temperature is *outside* the min and max values"
  "'i'",    "Listener is triggered when the temperature is *inside* the min and max values"
  "'<'",    "Listener is triggered when the temperature is smaller than the min value (max is ignored)"
  "'>'",    "Listener 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 constants are available for this function:
 
 * BrickletColor.THRESHOLD_OPTION_OFF = 'x'
 * BrickletColor.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletColor.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletColor.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletColor.THRESHOLD_OPTION_GREATER = '>'
 
.. java:function:: public BrickletColor.ColorCallbackThreshold BrickletColor::getColorCallbackThreshold()

 Returns the threshold as set by :java:func:`setColorCallbackThreshold() <BrickletColor::setColorCallbackThreshold>`.
 
 The following constants are available for this function:
 
 * BrickletColor.THRESHOLD_OPTION_OFF = 'x'
 * BrickletColor.THRESHOLD_OPTION_OUTSIDE = 'o'
 * BrickletColor.THRESHOLD_OPTION_INSIDE = 'i'
 * BrickletColor.THRESHOLD_OPTION_SMALLER = '<'
 * BrickletColor.THRESHOLD_OPTION_GREATER = '>'
 
 The returned object has the public member variables ``char option``, ``int minR``, ``int maxR``, ``int minG``, ``int maxG``, ``int minB``, ``int maxB``, ``int minC`` and ``int maxC``.

.. java:function:: public void BrickletColor::setDebouncePeriod(long debounce)

 Sets the period in ms with which the threshold listener
 
 * :java:func:`ColorReachedListener <BrickletColor.ColorReachedListener>`
 
 is triggered, if the threshold
 
 * :java:func:`setColorCallbackThreshold() <BrickletColor::setColorCallbackThreshold>`
 
 keeps being reached.
 
 The default value is 100.
 
.. java:function:: public long BrickletColor::getDebouncePeriod()

 Returns the debounce period as set by :java:func:`setDebouncePeriod() <BrickletColor::setDebouncePeriod>`.
 
.. java:function:: public void BrickletColor::setIlluminanceCallbackPeriod(long period)

 Sets the period in ms with which the :java:func:`IlluminanceListener <BrickletColor.IlluminanceListener>` listener is triggered
 periodically. A value of 0 turns the listener off.
 
 :java:func:`IlluminanceListener <BrickletColor.IlluminanceListener>` is only triggered if the illuminance has changed since the
 last triggering.
 
 The default value is 0.
 
.. java:function:: public long BrickletColor::getIlluminanceCallbackPeriod()

 Returns the period as set by :java:func:`setIlluminanceCallbackPeriod() <BrickletColor::setIlluminanceCallbackPeriod>`.
 
.. java:function:: public void BrickletColor::setColorTemperatureCallbackPeriod(long period)

 Sets the period in ms with which the :java:func:`ColorTemperatureListener <BrickletColor.ColorTemperatureListener>` listener is triggered
 periodically. A value of 0 turns the listener off.
 
 :java:func:`ColorTemperatureListener <BrickletColor.ColorTemperatureListener>` is only triggered if the color temperature has changed since the
 last triggering.
 
 The default value is 0.
 
.. java:function:: public long BrickletColor::getColorTemperatureCallbackPeriod()

 Returns the period as set by :java:func:`setColorTemperatureCallbackPeriod() <BrickletColor::setColorTemperatureCallbackPeriod>`.
 


.. _color_bricklet_java_callbacks:

Listeners
^^^^^^^^^

Listeners can be registered to receive
time critical or recurring data from the device. The registration is done
with "add*Listener" functions of the device object.

The parameter is a listener class object, for example:

.. code-block:: java

    device.addExampleListener(new BrickletColor.ExampleListener() {
        public void property(int value) {
            System.out.println("Value: " + value);
        }
    });

The available listener classes with inherent methods to be overwritten
are described below. It is possible to add several listeners and
to remove them with the corresponding "remove*Listener" function.

.. note::
 Using listeners 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.


.. java:function:: public class BrickletColor.ColorListener()

 This listener can be added with the ``addColorListener()`` function.
 An added listener can be removed with the ``removeColorListener()`` function.

 .. java:function:: public void color(int r, int g, int b, int c)
  :noindex:


  This listener is triggered periodically with the period that is set by
  :java:func:`setColorCallbackPeriod() <BrickletColor::setColorCallbackPeriod>`. The parameter is the color
  of the sensor as RGBC.
  
  :java:func:`ColorListener <BrickletColor.ColorListener>` is only triggered if the color has changed since the
  last triggering.
  

.. java:function:: public class BrickletColor.ColorReachedListener()

 This listener can be added with the ``addColorReachedListener()`` function.
 An added listener can be removed with the ``removeColorReachedListener()`` function.

 .. java:function:: public void colorReached(int r, int g, int b, int c)
  :noindex:


  This listener is triggered when the threshold as set by
  :java:func:`setColorCallbackThreshold() <BrickletColor::setColorCallbackThreshold>` is reached.
  The parameter is the color
  of the sensor as RGBC.
  
  If the threshold keeps being reached, the listener is triggered periodically
  with the period as set by :java:func:`setDebouncePeriod() <BrickletColor::setDebouncePeriod>`.
  

.. java:function:: public class BrickletColor.IlluminanceListener()

 This listener can be added with the ``addIlluminanceListener()`` function.
 An added listener can be removed with the ``removeIlluminanceListener()`` function.

 .. java:function:: public void illuminance(long illuminance)
  :noindex:


  This listener is triggered periodically with the period that is set by
  :java:func:`setIlluminanceCallbackPeriod() <BrickletColor::setIlluminanceCallbackPeriod>`. The parameter is the illuminance.
  See :java:func:`getIlluminance() <BrickletColor::getIlluminance>` for how to interpret this value.
  
  :java:func:`IlluminanceListener <BrickletColor.IlluminanceListener>` is only triggered if the illuminance has changed since the
  last triggering.
  

.. java:function:: public class BrickletColor.ColorTemperatureListener()

 This listener can be added with the ``addColorTemperatureListener()`` function.
 An added listener can be removed with the ``removeColorTemperatureListener()`` function.

 .. java:function:: public void colorTemperature(int colorTemperature)
  :noindex:


  This listener is triggered periodically with the period that is set by
  :java:func:`setColorTemperatureCallbackPeriod() <BrickletColor::setColorTemperatureCallbackPeriod>`. The parameter is the 
  color temperature in Kelvin.
  
  :java:func:`ColorTemperatureListener <BrickletColor.ColorTemperatureListener>` is only triggered if the color temperature has 
  changed since the last triggering.
  


.. _color_bricklet_java_constants:

Constants
^^^^^^^^^

.. java:member:: public static final int BrickletColor.DEVICE_IDENTIFIER

 This constant is used to identify a Color Bricklet.

 The :java:func:`getIdentity() <BrickletColor::getIdentity>` function and the
 :java:func:`EnumerateListener <IPConnection.EnumerateListener>`
 listener of the IP Connection have a ``deviceIdentifier`` parameter to specify
 the Brick's or Bricklet's type.

