..
 #############################################################
 # 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 - LED Strip Bricklet

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

.. _led_strip_bricklet_php:

PHP - LED Strip Bricklet
========================

This is the description of the :ref:`PHP API bindings <api_bindings_php>` for the :ref:`LED Strip Bricklet <led_strip_bricklet>`. General information and technical
specifications for the LED Strip Bricklet are summarized in its :ref:`hardware description
<led_strip_bricklet_description>`.

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

.. _led_strip_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/led-strip-bricklet/raw/master/software/examples/php/ExampleSimple.php>`__

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

Callback
^^^^^^^^

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

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

.. _led_strip_bricklet_php_api:

API
---

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




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


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

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

 .. code-block:: php

    <?php   $led_strip = new BrickletLEDStrip('YOUR_DEVICE_UID', $ipcon);   ?>

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


.. php:function:: void BrickletLEDStrip::setRGBValues(int $index, int $length, array $r, array $g, array $b)

 Sets the *rgb* values for the LEDs with the given *length* starting 
 from *index*.
 
 The maximum length is 16, the index goes from 0 to 319 and the rgb values
 have 8 bits each.
 
 Example: If you set
 
 * index to 5,
 * length to 3,
 * r to array(255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0),
 * g to array(0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) and
 * b to array(0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0)
 
 the LED with index 5 will be red, 6 will be green and 7 will be blue.
 
 .. note:: Depending on the LED circuitry colors can be permuted.
 
 The colors will be transfered to actual LEDs when the next
 frame duration ends, see :php:func:`setFrameDuration() <BrickletLEDStrip::setFrameDuration>`.
 
 Generic approach: 
 
 * Set the frame duration to a value that represents
   the number of frames per second you want to achieve. 
 * Set all of the LED colors for one frame.
 * Wait for the :php:member:`CALLBACK_FRAME_RENDERED <BrickletLEDStrip::CALLBACK_FRAME_RENDERED>` callback.
 * Set all of the LED colors for next frame.
 * Wait for the :php:member:`CALLBACK_FRAME_RENDERED <BrickletLEDStrip::CALLBACK_FRAME_RENDERED>` callback.
 * and so on.
 
 This approach ensures that you can change the LED colors with
 a fixed frame rate.
 
 The actual number of controllable LEDs depends on the number of free
 Bricklet ports. See :ref:`here <led_strip_bricklet_ram_constraints>` for more
 information. A call of :php:func:`setRGBValues() <BrickletLEDStrip::setRGBValues>` with index + length above the
 bounds is ignored completely.
 
.. php:function:: array BrickletLEDStrip::getRGBValues(int $index, int $length)

 Returns the rgb with the given *length* starting from the
 given *index*.
 
 The values are the last values that were set by :php:func:`setRGBValues() <BrickletLEDStrip::setRGBValues>`.
 
 The returned array has the keys ``r``, ``g`` and ``b``.

.. php:function:: void BrickletLEDStrip::setFrameDuration(int $duration)

 Sets the frame duration in ms.
 
 Example: If you want to achieve 20 frames per second, you should
 set the frame duration to 50ms (50ms * 20 = 1 second). 
 
 For an explanation of the general approach see :php:func:`setRGBValues() <BrickletLEDStrip::setRGBValues>`.
 
 Default value: 100ms (10 frames per second).
 
.. php:function:: int BrickletLEDStrip::getFrameDuration()

 Returns the frame duration as set by :php:func:`setFrameDuration() <BrickletLEDStrip::setFrameDuration>`.
 
.. php:function:: int BrickletLEDStrip::getSupplyVoltage()

 Returns the current supply voltage of the LEDs. The voltage is given in mV.
 
.. php:function:: void BrickletLEDStrip::setClockFrequency(int $frequency)

 Sets the frequency of the clock in Hz. The range is 10000Hz (10kHz) up to
 2000000Hz (2MHz).
 
 The Bricklet will choose the nearest achievable frequency, which may
 be off by a few Hz. You can get the exact frequency that is used by
 calling :php:func:`getClockFrequency() <BrickletLEDStrip::getClockFrequency>`.
 
 If you have problems with flickering LEDs, they may be bits flipping. You
 can fix this by either making the connection between the LEDs and the
 Bricklet shorter or by reducing the frequency.
 
 With a decreasing frequency your maximum frames per second will decrease
 too.
 
 The default value is 1.66MHz.
 
 .. note::
  The frequency in firmware version 2.0.0 is fixed at 2MHz.
 
 .. versionadded:: 2.0.1~(Plugin)
 
.. php:function:: int BrickletLEDStrip::getClockFrequency()

 Returns the currently used clock frequency as set by :php:func:`setClockFrequency() <BrickletLEDStrip::setClockFrequency>`.
 
 .. versionadded:: 2.0.1~(Plugin)
 
.. php:function:: void BrickletLEDStrip::setChipType(int $chip)

 Sets the type of the led driver chip. We currently support
 the chips
 
 * WS2801 (``chip`` = 2801),
 * WS2811 (``chip`` = 2811) and
 * WS2812 (``chip`` = 2812).
 
 The WS2812 is sometimes also called "NeoPixel", a name coined by
 Adafruit.
 
 The default value is WS2801 (``chip`` = 2801).
 
 The following constants are available for this function:
 
 * BrickletLEDStrip::CHIP_TYPE_WS2801 = 2801
 * BrickletLEDStrip::CHIP_TYPE_WS2811 = 2811
 * BrickletLEDStrip::CHIP_TYPE_WS2812 = 2812
 
 .. versionadded:: 2.0.2~(Plugin)
 
.. php:function:: int BrickletLEDStrip::getChipType()

 Returns the currently used chip type as set by :php:func:`setChipType() <BrickletLEDStrip::setChipType>`.
 
 The following constants are available for this function:
 
 * BrickletLEDStrip::CHIP_TYPE_WS2801 = 2801
 * BrickletLEDStrip::CHIP_TYPE_WS2811 = 2811
 * BrickletLEDStrip::CHIP_TYPE_WS2812 = 2812
 
 .. versionadded:: 2.0.2~(Plugin)
 


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

.. php:function:: array BrickletLEDStrip::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 BrickletLEDStrip::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() <BrickletLEDStrip::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() <BrickletLEDStrip::setResponseExpected>`
 for the list of function ID constants available for this function.
 
.. php:function:: void BrickletLEDStrip::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:
 
 * BrickletLEDStrip::FUNCTION_SET_RGB_VALUES = 1
 * BrickletLEDStrip::FUNCTION_SET_FRAME_DURATION = 3
 * BrickletLEDStrip::FUNCTION_SET_CLOCK_FREQUENCY = 7
 * BrickletLEDStrip::FUNCTION_SET_CHIP_TYPE = 9
 
.. php:function:: void BrickletLEDStrip::setResponseExpectedAll(bool $response_expected)

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. php:function:: array BrickletLEDStrip::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 BrickletLEDStrip::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 <led_strip_bricklet_php_callbacks>`.




.. _led_strip_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() <BrickletLEDStrip::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";
    }

    $led_strip->registerCallback(BrickletLEDStrip::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 BrickletLEDStrip::CALLBACK_FRAME_RENDERED

 .. code-block:: php

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

 This callback is triggered directly after a new frame is rendered.
 
 You should send the data for the next frame directly after this callback
 was triggered.
 
 For an explanation of the general approach see :php:func:`setRGBValues() <BrickletLEDStrip::setRGBValues>`.
 


.. _led_strip_bricklet_php_constants:

Constants
^^^^^^^^^

.. php:member:: int BrickletLEDStrip::DEVICE_IDENTIFIER

 This constant is used to identify a LED Strip Bricklet.

 The :php:func:`getIdentity() <BrickletLEDStrip::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.

