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

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

.. _led_strip_bricklet_shell:

Shell - LED Strip Bricklet
==========================

This is the description of the :ref:`Shell API bindings <api_bindings_shell>` 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_shell_install>` for the Shell API
bindings is part of their general description.

.. _led_strip_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/led-strip-bricklet/raw/master/software/examples/shell/example-simple.sh>`__

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

.. _led_strip_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 Nled-strip-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 LED Strip 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 LED Strip Bricklet and exits


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

 :param <uid>: string
 :param <callback>: string

 The ``dispatch`` command is used to dispatch a callback of the LED Strip 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 LED Strip Bricklet and exits


.. sh:function:: X Stinkerforge Scall Pled-strip-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 Pled-strip-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 led-strip-bricklet <uid> set-rgb-values <index> <length> <r> <g> <b> 

 :param <index>: int
 :param <length>: int
 :param <r>: int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int
 :param <g>: int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int
 :param <b>: int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int

 :noreturn: no output

 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 [255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
 * g to [0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0] and
 * b to [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 :sh:func:`set-frame-duration <led-strip-bricklet set-frame-duration>`.
 
 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 :sh:func:`frame-rendered <led-strip-bricklet frame-rendered>` callback.
 * Set all of the LED colors for next frame.
 * Wait for the :sh:func:`frame-rendered <led-strip-bricklet 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 :sh:func:`set-rgb-values <led-strip-bricklet set-rgb-values>` with index + length above the
 bounds is ignored completely.
 
.. sh:function:: tinkerforge call led-strip-bricklet <uid> get-rgb-values <index> <length> 

 :param <index>: int
 :param <length>: int

 :returns r: int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int
 :returns g: int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int
 :returns b: int,int,int,int,int,int,int,int,int,int,int,int,int,int,int,int

 Returns the rgb with the given *length* starting from the
 given *index*.
 
 The values are the last values that were set by :sh:func:`set-rgb-values <led-strip-bricklet set-rgb-values>`.
 
.. sh:function:: tinkerforge call led-strip-bricklet <uid> set-frame-duration <duration> 

 :param <duration>: int

 :noreturn: no output

 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 :sh:func:`set-rgb-values <led-strip-bricklet set-rgb-values>`.
 
 Default value: 100ms (10 frames per second).
 
.. sh:function:: tinkerforge call led-strip-bricklet <uid> get-frame-duration  


 :returns duration: int

 Returns the frame duration as set by :sh:func:`set-frame-duration <led-strip-bricklet set-frame-duration>`.
 
.. sh:function:: tinkerforge call led-strip-bricklet <uid> get-supply-voltage  


 :returns voltage: int

 Returns the current supply voltage of the LEDs. The voltage is given in mV.
 
.. sh:function:: tinkerforge call led-strip-bricklet <uid> set-clock-frequency <frequency> 

 :param <frequency>: int

 :noreturn: no output

 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 :sh:func:`get-clock-frequency <led-strip-bricklet get-clock-frequency>`.
 
 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)
 
.. sh:function:: tinkerforge call led-strip-bricklet <uid> get-clock-frequency  


 :returns frequency: int

 Returns the currently used clock frequency as set by :sh:func:`set-clock-frequency <led-strip-bricklet set-clock-frequency>`.
 
 .. versionadded:: 2.0.1~(Plugin)
 
.. sh:function:: tinkerforge call led-strip-bricklet <uid> set-chip-type <chip> 

 :param <chip>: int (has symbols)

 :noreturn: no output

 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 symbols are available for this function:
 
 * ``ws2801`` = 2801, for <chip>
 * ``ws2811`` = 2811, for <chip>
 * ``ws2812`` = 2812, for <chip>
 
 .. versionadded:: 2.0.2~(Plugin)
 
.. sh:function:: tinkerforge call led-strip-bricklet <uid> get-chip-type  


 :returns chip: int (has symbols)

 Returns the currently used chip type as set by :sh:func:`set-chip-type <led-strip-bricklet set-chip-type>`.
 
 The following symbols are available for this function:
 
 * ``ws2801`` = 2801, for chip
 * ``ws2811`` = 2811, for chip
 * ``ws2812`` = 2812, for chip
 
 .. versionadded:: 2.0.2~(Plugin)
 


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

.. sh:function:: tinkerforge call led-strip-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|
 


.. _led_strip_bricklet_shell_callbacks:

Callbacks
^^^^^^^^^

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

.. code-block:: bash

    tinkerforge dispatch led-strip-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 led-strip-bricklet <uid> frame-rendered

 :returns length: int


 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 :sh:func:`set-rgb-values <led-strip-bricklet set-rgb-values>`.
 


