..
 #############################################################
 # 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-matlab">Software</a> / MATLAB/Octave - LED Strip Bricklet

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

.. _led_strip_bricklet_matlab:

MATLAB/Octave - LED Strip Bricklet
==================================

This is the description of the :ref:`MATLAB/Octave API bindings <api_bindings_matlab>` 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_matlab_install>` for the MATLAB/Octave API
bindings is part of their general description.

.. _led_strip_bricklet_matlab_examples:


Examples
--------

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

Simple (MATLAB)
^^^^^^^^^^^^^^^

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

.. literalinclude:: LEDStrip_Bricklet_MATLAB_matlab_example_simple.m
 :language: matlab
 :linenos:
 :tab-width: 4

Callback (MATLAB)
^^^^^^^^^^^^^^^^^

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

.. literalinclude:: LEDStrip_Bricklet_MATLAB_matlab_example_callback.m
 :language: matlab
 :linenos:
 :tab-width: 4

Simple (Octave)
^^^^^^^^^^^^^^^

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

.. literalinclude:: LEDStrip_Bricklet_MATLAB_octave_example_simple.m
 :language: octave_fixed
 :linenos:
 :tab-width: 4

Callback (Octave)
^^^^^^^^^^^^^^^^^

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

.. literalinclude:: LEDStrip_Bricklet_MATLAB_octave_example_callback.m
 :language: octave_fixed
 :linenos:
 :tab-width: 4

.. _led_strip_bricklet_matlab_api:

API
---

Generally, every method of the MATLAB 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 the MATLAB bindings are based on Java and 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
^^^^^^^^^^^^^^^


.. matlab:function:: class BrickletLEDStrip(String uid, IPConnection ipcon)

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

 In MATLAB:

 .. code-block:: matlab

  import com.tinkerforge.BrickletLEDStrip;

  ledStrip = BrickletLEDStrip('YOUR_DEVICE_UID', ipcon);

 In Octave:

 .. code-block:: octave_fixed

  ledStrip = java_new("com.tinkerforge.BrickletLEDStrip", "YOUR_DEVICE_UID", ipcon);

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


.. matlab:function:: public void BrickletLEDStrip::setRGBValues(int index, short length, short[] r, short[] g, short[] 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 [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 :matlab: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 :matlab:member:`FrameRenderedCallback <BrickletLEDStrip.FrameRenderedCallback>` callback.
 * Set all of the LED colors for next frame.
 * Wait for the :matlab:member:`FrameRenderedCallback <BrickletLEDStrip.FrameRenderedCallback>` 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 :matlab:func:`setRGBValues() <BrickletLEDStrip::setRGBValues>` with index + length above the
 bounds is ignored completely.
 
.. matlab:function:: public BrickletLEDStrip.RGBValues BrickletLEDStrip::getRGBValues(int index, short length)

 Returns the rgb with the given *length* starting from the
 given *index*.
 
 The values are the last values that were set by :matlab:func:`setRGBValues() <BrickletLEDStrip::setRGBValues>`.
 
 The returned object has the public member variables ``short[] r``, ``short[] g`` and ``short[] b``.

.. matlab:function:: public 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 :matlab:func:`setRGBValues() <BrickletLEDStrip::setRGBValues>`.
 
 Default value: 100ms (10 frames per second).
 
.. matlab:function:: public int BrickletLEDStrip::getFrameDuration()

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

 Returns the current supply voltage of the LEDs. The voltage is given in mV.
 
.. matlab:function:: public void BrickletLEDStrip::setClockFrequency(long 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 :matlab: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)
 
.. matlab:function:: public long BrickletLEDStrip::getClockFrequency()

 Returns the currently used clock frequency as set by :matlab:func:`setClockFrequency() <BrickletLEDStrip::setClockFrequency>`.
 
 .. versionadded:: 2.0.1~(Plugin)
 
.. matlab:function:: public 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)
 
.. matlab:function:: public int BrickletLEDStrip::getChipType()

 Returns the currently used chip type as set by :matlab: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
^^^^^^^^^^^^^^^^^^

.. matlab:function:: public short[] 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.
 
.. matlab:function:: public boolean BrickletLEDStrip::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 callback configuration
 functions it is enabled by default too, but can be disabled by
 :matlab: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 :matlab:func:`setResponseExpected() <BrickletLEDStrip::setResponseExpected>`
 for the list of function ID constants available for this function.
 
.. matlab:function:: public void BrickletLEDStrip::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 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
 
.. matlab:function:: public void BrickletLEDStrip::setResponseExpectedAll(boolean responseExpected)

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. matlab:function:: public BrickletLEDStrip.Identity 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 object has the public member variables ``String uid``, ``String connectedUid``, ``char position``, ``short[] hardwareVersion``, ``short[] firmwareVersion`` and ``int deviceIdentifier``.



.. _led_strip_bricklet_matlab_callbacks:

Callbacks
^^^^^^^^^

Callbacks can be registered to receive time critical or recurring data from
the device. The registration is done with "set" function of MATLAB. The
parameters consist of the IP Connection object, the callback name and the
callback function. For example, it looks like this in MATLAB:

.. code-block:: matlab

    function cb_example(e)
        fprintf('Parameter: %s\n', e.param);
    end

    set(device, 'ExampleCallback', @(h, e) cb_example(e));

Due to a difference in the Octave Java support the "set" function cannot be
used in Octave. The registration is done with "add*Callback" functions of the
device object. It looks like this in Octave:

.. code-block:: octave_fixed

    function cb_example(e)
        fprintf("Parameter: %s\n", e.param);
    end

    device.addExampleCallback(@cb_example);

It is possible to add several callbacks and to remove them with the
corresponding "remove*Callback" function.

The parameters of the callback are passed to the callback function as fields of
the structure ``e``, which is derived from the ``java.util.EventObject`` class.
The available callback names with corresponding structure fields 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.



.. matlab:member:: public callback BrickletLEDStrip.FrameRenderedCallback

 :param 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 :matlab:func:`setRGBValues() <BrickletLEDStrip::setRGBValues>`.
 

 In MATLAB the ``set()`` function can be used to register a callback function
 to this callback.

 In Octave a callback function can be added to this callback using the
 ``addFrameRenderedCallback()`` function. An added callback function can be removed with
 the ``removeFrameRenderedCallback()`` function.



.. _led_strip_bricklet_matlab_constants:

Constants
^^^^^^^^^

.. matlab:member:: public static final int BrickletLEDStrip.DEVICE_IDENTIFIER

 This constant is used to identify a LED Strip Bricklet.

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

