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

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

.. _color_bricklet_php:

PHP - Color Bricklet
====================

This is the description of the :ref:`PHP API bindings <api_bindings_php>` 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_php_install>` for the PHP API
bindings is part of their general description.

.. _color_bricklet_php_examples:


Examples
--------

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

Simple
^^^^^^

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

.. literalinclude:: Color_Bricklet_PHP_ExampleSimple.php
 :language: php
 :linenos:
 :tab-width: 4

Callback
^^^^^^^^

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

.. literalinclude:: Color_Bricklet_PHP_ExampleCallback.php
 :language: php
 :linenos:
 :tab-width: 4

Threshold
^^^^^^^^^

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

.. literalinclude:: Color_Bricklet_PHP_ExampleThreshold.php
 :language: php
 :linenos:
 :tab-width: 4

.. _color_bricklet_php_api:

API
---

Functions that return multiple values return them in an associative array.




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


.. php:function:: class BrickletColor(string $uid, IPConnection $ipcon)

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

 .. code-block:: php

    <?php   $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_php_examples>`).


.. php:function:: array 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 callback :php:member:`CALLBACK_COLOR <BrickletColor::CALLBACK_COLOR>` and set the period with 
 :php:func:`setColorCallbackPeriod() <BrickletColor::setColorCallbackPeriod>`.
 
 The returned array has the keys ``r``, ``g``, ``b`` and ``c``.

.. php:function:: void BrickletColor::lightOn()

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

 Turns the LED off.
 
.. php:function:: int 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
 
.. php:function:: void BrickletColor::setConfig(int $gain, int $integration_time)

 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
 
.. php:function:: array BrickletColor::getConfig()

 Returns the configuration as set by :php: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 array has the keys ``gain`` and ``integration_time``.

.. php:function:: int BrickletColor::getIlluminance()

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


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

.. php:function:: array 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.
 
.. php:function:: bool BrickletColor::getResponseExpected(int $function_id)

 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 callback configuration
 functions it is enabled by default too, but can be disabled by
 :php: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 :php:func:`setResponseExpected() <BrickletColor::setResponseExpected>`
 for the list of function ID constants available for this function.
 
.. php:function:: void BrickletColor::setResponseExpected(int $function_id, bool $response_expected)

 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 callback configuration functions (default value: *true*). For
 getter functions it is always enabled and callbacks 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
 
.. php:function:: void BrickletColor::setResponseExpectedAll(bool $response_expected)

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. php:function:: array 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 array has the keys ``uid``, ``connected_uid``, ``position``, ``hardware_version``, ``firmware_version`` and ``device_identifier``.



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


.. php:function:: void BrickletColor::registerCallback(int $id, callable $callback, mixed $userData = NULL)

 Registers a callback with ID *$id* to the callable *$callback*.
 The *$userData*  will be given as a parameter of the callback.

 The available  IDs with corresponding function signatures are listed
 :ref:`below <color_bricklet_php_callbacks>`.


.. php:function:: void BrickletColor::setColorCallbackPeriod(int $period)

 Sets the period in ms with which the :php:member:`CALLBACK_COLOR <BrickletColor::CALLBACK_COLOR>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :php:member:`CALLBACK_COLOR <BrickletColor::CALLBACK_COLOR>` is only triggered if the color has changed since the
 last triggering.
 
 The default value is 0.
 
.. php:function:: int BrickletColor::getColorCallbackPeriod()

 Returns the period as set by :php:func:`setColorCallbackPeriod() <BrickletColor::setColorCallbackPeriod>`.
 
.. php:function:: void BrickletColor::setColorCallbackThreshold(string $option, int $min_r, int $max_r, int $min_g, int $max_g, int $min_b, int $max_b, int $min_c, int $max_c)

 Sets the thresholds for the :php:member:`CALLBACK_COLOR_REACHED <BrickletColor::CALLBACK_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 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 = '>'
 
.. php:function:: array BrickletColor::getColorCallbackThreshold()

 Returns the threshold as set by :php: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 array has the keys ``option``, ``min_r``, ``max_r``, ``min_g``, ``max_g``, ``min_b``, ``max_b``, ``min_c`` and ``max_c``.

.. php:function:: void BrickletColor::setDebouncePeriod(int $debounce)

 Sets the period in ms with which the threshold callback
 
 * :php:member:`CALLBACK_COLOR_REACHED <BrickletColor::CALLBACK_COLOR_REACHED>`
 
 is triggered, if the threshold
 
 * :php:func:`setColorCallbackThreshold() <BrickletColor::setColorCallbackThreshold>`
 
 keeps being reached.
 
 The default value is 100.
 
.. php:function:: int BrickletColor::getDebouncePeriod()

 Returns the debounce period as set by :php:func:`setDebouncePeriod() <BrickletColor::setDebouncePeriod>`.
 
.. php:function:: void BrickletColor::setIlluminanceCallbackPeriod(int $period)

 Sets the period in ms with which the :php:member:`CALLBACK_ILLUMINANCE <BrickletColor::CALLBACK_ILLUMINANCE>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :php:member:`CALLBACK_ILLUMINANCE <BrickletColor::CALLBACK_ILLUMINANCE>` is only triggered if the illuminance has changed since the
 last triggering.
 
 The default value is 0.
 
.. php:function:: int BrickletColor::getIlluminanceCallbackPeriod()

 Returns the period as set by :php:func:`setIlluminanceCallbackPeriod() <BrickletColor::setIlluminanceCallbackPeriod>`.
 
.. php:function:: void BrickletColor::setColorTemperatureCallbackPeriod(int $period)

 Sets the period in ms with which the :php:member:`CALLBACK_COLOR_TEMPERATURE <BrickletColor::CALLBACK_COLOR_TEMPERATURE>` callback is triggered
 periodically. A value of 0 turns the callback off.
 
 :php:member:`CALLBACK_COLOR_TEMPERATURE <BrickletColor::CALLBACK_COLOR_TEMPERATURE>` is only triggered if the color temperature has changed since the
 last triggering.
 
 The default value is 0.
 
.. php:function:: int BrickletColor::getColorTemperatureCallbackPeriod()

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


.. _color_bricklet_php_callbacks:

Callbacks
^^^^^^^^^

Callbacks can be registered to receive
time critical or recurring data from the device. The registration is done
with the :php:func:`registerCallback() <BrickletColor::registerCallback>` function of
the device object. The first parameter is the callback ID and the second
parameter the callback function:

.. code-block:: php

    <?php

    function myCallback($param)
    {
        echo $param . "\n";
    }

    $color->registerCallback(BrickletColor::CALLBACK_EXAMPLE, 'myCallback');

    ?>

The available constants with corresponding function signatures 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.

.. php:member:: int BrickletColor::CALLBACK_COLOR

 .. code-block:: php

  <?php   void callback(int $r, int $g, int $b, int $c [, mixed $userData])   ?>

 This callback is triggered periodically with the period that is set by
 :php:func:`setColorCallbackPeriod() <BrickletColor::setColorCallbackPeriod>`. The parameter is the color
 of the sensor as RGBC.
 
 :php:member:`CALLBACK_COLOR <BrickletColor::CALLBACK_COLOR>` is only triggered if the color has changed since the
 last triggering.
 
.. php:member:: int BrickletColor::CALLBACK_COLOR_REACHED

 .. code-block:: php

  <?php   void callback(int $r, int $g, int $b, int $c [, mixed $userData])   ?>

 This callback is triggered when the threshold as set by
 :php:func:`setColorCallbackThreshold() <BrickletColor::setColorCallbackThreshold>` 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 :php:func:`setDebouncePeriod() <BrickletColor::setDebouncePeriod>`.
 
.. php:member:: int BrickletColor::CALLBACK_ILLUMINANCE

 .. code-block:: php

  <?php   void callback(int $illuminance [, mixed $userData])   ?>

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

 .. code-block:: php

  <?php   void callback(int $color_temperature [, mixed $userData])   ?>

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


.. _color_bricklet_php_constants:

Constants
^^^^^^^^^

.. php:member:: int BrickletColor::DEVICE_IDENTIFIER

 This constant is used to identify a Color Bricklet.

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

