NAME

Tinkerforge::BrickletLEDStripV2 - Controls up to 2048 RGB(W) LEDs

CONSTANTS

DEVICE_IDENTIFIER

This constant is used to identify a LED Strip Bricklet 2.0.

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 2.0.

CALLBACK_FRAME_STARTED

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

FUNCTION_SET_LED_VALUES_LOW_LEVEL

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

FUNCTION_GET_LED_VALUES_LOW_LEVEL

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_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_SET_FRAME_STARTED_CALLBACK_CONFIGURATION

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

FUNCTION_GET_FRAME_STARTED_CALLBACK_CONFIGURATION

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

FUNCTION_GET_SPITFP_ERROR_COUNT

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

FUNCTION_SET_BOOTLOADER_MODE

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

FUNCTION_GET_BOOTLOADER_MODE

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

FUNCTION_SET_WRITE_FIRMWARE_POINTER

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

FUNCTION_WRITE_FIRMWARE

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

FUNCTION_SET_STATUS_LED_CONFIG

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

FUNCTION_GET_STATUS_LED_CONFIG

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

FUNCTION_GET_CHIP_TEMPERATURE

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

FUNCTION_RESET

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

FUNCTION_WRITE_UID

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

FUNCTION_READ_UID

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_led_values_low_level()

Sets the RGB(W) values for the LEDs starting from *index*. You can set at most 2048 RGB values or 1536 RGBW values.

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

If the channel mapping has 3 colors, you need to give the data in the sequence RGBRGBRGB... if the channel mapping has 4 colors you need to give data in the sequence RGBWRGBWRGBW...

The data is double buffered and the colors will be transfered to the 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 Started` callback. * Set all of the LED colors for next frame. * Wait for the :cb:`Frame Started` callback. * And so on.

This approach ensures that you can change the LED colors with a fixed frame rate.

get_led_values_low_level()

Returns the RGB(W) values as set by :func:`Set LED 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 LED 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.

get_clock_frequency()

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

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).

get_chip_type()

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

set_channel_mapping()

Sets the channel mapping for the connected LEDs.

If the mapping has 4 colors, the function :func:`Set LED Values` expects 4 values per pixel and if the mapping has 3 colors it expects 3 values per pixel.

The function always expects the order RGB(W). 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, then 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.

The default value is BGR (36).

get_channel_mapping()

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

set_frame_started_callback_configuration()

Enables/disables the :cb:`Frame Started` callback.

By default the callback is enabled.

get_frame_started_callback_configuration()

Returns the configuration as set by :func:`Set Frame Started Callback Configuration`.

get_spitfp_error_count()

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

* ack checksum errors, * message checksum errors, * frameing errors and * overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

set_bootloader_mode()

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier und crc are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

get_bootloader_mode()

Returns the current bootloader mode, see :func:`Set Bootloader Mode`.

set_write_firmware_pointer()

Sets the firmware pointer for :func:`Write Firmware`. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

write_firmware()

Writes 64 Bytes of firmware at the position as written by :func:`Set Write Firmware Pointer` before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

set_status_led_config()

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

get_status_led_config()

Returns the configuration as set by :func:`Set Status LED Config`

get_chip_temperature()

Returns the temperature in °C as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

reset()

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

write_uid()

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

read_uid()

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

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|

set_led_values()

Sets the RGB(W) values for the LEDs starting from *index*. You can set at most 2048 RGB values or 1536 RGBW values.

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

If the channel mapping has 3 colors, you need to give the data in the sequence RGBRGBRGB... if the channel mapping has 4 colors you need to give data in the sequence RGBWRGBWRGBW...

The data is double buffered and the colors will be transfered to the 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 Started` callback. * Set all of the LED colors for next frame. * Wait for the :cb:`Frame Started` callback. * And so on.

This approach ensures that you can change the LED colors with a fixed frame rate.

get_led_values()

Returns the RGB(W) values as set by :func:`Set LED Values`.