Tinkerforge::BrickletLEDStrip - Controls up to 320 RGB LEDs
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.
This constant represents the display name of a LED Strip Bricklet.
This constant is used with the register_callback() subroutine to specify the CALLBACK_FRAME_RENDERED callback.
This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.
Creates an object with the unique device ID *uid* and adds it to the IP Connection *ipcon*.
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:`SetChipType`) and a 3-channel channel mapping (:func:`SetChannelMapping`) 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:`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 :func:`FrameRendered` callback. * Set all of the LED colors for next frame. * Wait for the :func:`FrameRendered` 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:`SetRGBValues` with index + length above the bounds is ignored completely.
Returns RGB value with the given *length* starting from the given *index*.
The values are the last values that were set by :func:`SetRGBValues`.
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:`SetRGBValues`.
Default value: 100ms (10 frames per second).
Returns the frame duration in ms as set by :func:`SetFrameDuration`.
Returns the current supply voltage of the LEDs. The voltage is given in mV.
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:`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$nbsp;(Plugin)
Returns the currently used clock frequency as set by :func:`SetClockFrequency`.
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)
Returns the currently used chip type as set by :func:`SetChipType`.
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:`SetChipType`) and a 4-channel channel mapping (:func:`SetChannelMapping`) 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.
* 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.
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:`SetRGBWValues` 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)
Returns RGBW values with the given *length* starting from the given *index*.
The values are the last values that were set by :func:`SetRGBWValues`.
Sets the channel mapping for the connected LEDs.
:func:`SetRGBValues` and :func:`SetRGBWValues` 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:`SetRGBValues` has to be used. Calling :func:`SetRGBWValues` with a 3-channel mapping will produce incorrect results. Vice-versa if a 4-channel mapping is selected then :func:`SetRGBWValues` has to be used. Calling :func:`SetRGBValues` with a 4-channel mapping will produce incorrect results.
The default value is BGR (36).
Returns the currently used channel mapping as set by :func:`SetChannelMapping`.
Enables the :func:`FrameRendered` callback.
By default the callback is enabled.
Disables the :func:`FrameRendered` callback.
Returns *true* if the :func:`FrameRendered` callback is enabled, *false* otherwise.
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|
To install Tinkerforge, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Tinkerforge
CPAN shell
perl -MCPAN -e shell install Tinkerforge
For more information on module installation, please visit the detailed CPAN module installation guide.