Ishraq Ibne Ashraf

NAME

Tinkerforge::BrickletLEDStrip - Controls up to 320 RGB LEDs

CONSTANTS

DEVICE_IDENTIFIER

This constant is used to identify a LED Strip Bricklet.

The get_identity() subroutine and the CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

DEVICE_DISPLAY_NAME

This constant represents the display name of a LED Strip Bricklet.

CALLBACK_FRAME_RENDERED

This constant is used with the register_callback() subroutine to specify the CALLBACK_FRAME_RENDERED callback.

FUNCTION_SET_RGB_VALUES

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_RGB_VALUES

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_FRAME_DURATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_FRAME_DURATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_SUPPLY_VOLTAGE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_CLOCK_FREQUENCY

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_CLOCK_FREQUENCY

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_CHIP_TYPE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_CHIP_TYPE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_RGBW_VALUES

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_RGBW_VALUES

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_CHANNEL_MAPPING

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_CHANNEL_MAPPING

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_ENABLE_FRAME_RENDERED_CALLBACK

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_DISABLE_FRAME_RENDERED_CALLBACK

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_IS_FRAME_RENDERED_CALLBACK_ENABLED

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_IDENTITY

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTIONS

new()

Creates an object with the unique device ID *uid* and adds it to the IP Connection *ipcon*.

set_rgb_values()

Sets the RGB values for the LEDs with the given *length* starting from *index*.

To make the colors show correctly you need to configure the chip type (:func:`Set Chip Type`) and a 3-channel channel mapping (:func:`Set Channel Mapping`) according to the connected LEDs.

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 :func:`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 :cb:`Frame Rendered` callback. * Set all of the LED colors for next frame. * Wait for the :cb:`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 :func:`Set RGB Values` with index + length above the bounds is ignored completely.

get_rgb_values()

Returns RGB value with the given *length* starting from the given *index*.

The values are the last values that were set by :func:`Set RGB Values`.

set_frame_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 :func:`Set RGB Values`.

Default value: 100ms (10 frames per second).

get_frame_duration()

Returns the frame duration in ms as set by :func:`Set Frame Duration`.

get_supply_voltage()

Returns the current supply voltage of the LEDs. The voltage is given in mV.

set_clock_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 :func:`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$nbsp;(Plugin)

get_clock_frequency()

Returns the currently used clock frequency as set by :func:`Set Clock Frequency`.

.. versionadded:: 2.0.1$nbsp;(Plugin)

set_chip_type()

Sets the type of the LED driver chip. We currently support the chips

* WS2801, * WS2811, * WS2812 / SK6812 / NeoPixel RGB, * SK6812RGBW / NeoPixel RGBW (Chip Type = WS2812), * LPD8806 and * APA102 / DotStar.

The default value is WS2801 (2801).

.. versionadded:: 2.0.2$nbsp;(Plugin)

get_chip_type()

Returns the currently used chip type as set by :func:`Set Chip Type`.

.. versionadded:: 2.0.2$nbsp;(Plugin)

set_rgbw_values()

Sets the RGBW values for the LEDs with the given *length* starting from *index*.

To make the colors show correctly you need to configure the chip type (:func:`Set Chip Type`) and a 4-channel channel mapping (:func:`Set Channel Mapping`) according to the connected LEDs.

The maximum length is 12, the index goes from 0 to 239 and the rgbw values have 8 bits each.

Example: If you set

* index to 5, * length to 4, * r to [255, 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], * b to [0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0] and * w to [0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0]

the LED with index 5 will be red, 6 will be green, 7 will be blue and 8 will be white.

.. 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 :func:`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 :cb:`Frame Rendered` callback. * Set all of the LED colors for next frame. * Wait for the :cb:`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 :func:`Set RGBW Values` with index + length above the bounds is ignored completely.

The LPD8806 LED driver chips have 7-bit channels for RGB. Internally the LED Strip Bricklets divides the 8-bit values set using this function by 2 to make them 7-bit. Therefore, you can just use the normal value range (0-255) for LPD8806 LEDs.

The brightness channel of the APA102 LED driver chips has 5-bit. Internally the LED Strip Bricklets divides the 8-bit values set using this function by 8 to make them 5-bit. Therefore, you can just use the normal value range (0-255) for the brightness channel of APA102 LEDs.

.. versionadded:: 2.0.6$nbsp;(Plugin)

get_rgbw_values()

Returns RGBW values with the given *length* starting from the given *index*.

The values are the last values that were set by :func:`Set RGBW Values`.

.. versionadded:: 2.0.6$nbsp;(Plugin)

set_channel_mapping()

Sets the channel mapping for the connected LEDs.

:func:`Set RGB Values` and :func:`Set RGBW Values` take the data in RGB(W) order. But the connected LED driver chips might have their 3 or 4 channels in a different order. For example, the WS2801 chips typically use BGR order, the WS2812 chips typically use GRB order and the APA102 chips typically use WBGR order.

The APA102 chips are special. They have three 8-bit channels for RGB and an additional 5-bit channel for the overall brightness of the RGB LED making them 4-channel chips. Internally the brightness channel is the first channel, therefore one of the Wxyz channel mappings should be used. Then the W channel controls the brightness.

If a 3-channel mapping is selected then :func:`Set RGB Values` has to be used. Calling :func:`Set RGBW Values` with a 3-channel mapping will produce incorrect results. Vice-versa if a 4-channel mapping is selected then :func:`Set RGBW Values` has to be used. Calling :func:`Set RGB Values` with a 4-channel mapping will produce incorrect results.

The default value is BGR (36).

.. versionadded:: 2.0.6$nbsp;(Plugin)

get_channel_mapping()

Returns the currently used channel mapping as set by :func:`Set Channel Mapping`.

.. versionadded:: 2.0.6$nbsp;(Plugin)

enable_frame_rendered_callback()

Enables the :cb:`Frame Rendered` callback.

By default the callback is enabled.

.. versionadded:: 2.0.6$nbsp;(Plugin)

disable_frame_rendered_callback()

Disables the :cb:`Frame Rendered` callback.

By default the callback is enabled.

.. versionadded:: 2.0.6$nbsp;(Plugin)

is_frame_rendered_callback_enabled()

Returns *true* if the :cb:`Frame Rendered` callback is enabled, *false* otherwise.

.. versionadded:: 2.0.6$nbsp;(Plugin)

get_identity()

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|