Deutsch
English
Menu
Software / API Bindings / C/C++ for Microcontrollers / API Reference and Examples / Bricklets / LED Strip Bricklet 2.0

C/C++ for Microcontrollers - LED Strip Bricklet 2.0

This is the description of the C/C++ for Microcontrollers API bindings for the LED Strip Bricklet 2.0. General information and technical specifications for the LED Strip Bricklet 2.0 are summarized in its hardware description.

An installation guide for the C/C++ for Microcontrollers API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Simple

Download (example_simple.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
// This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.

#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_led_strip_v2.h"

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

static TF_LEDStripV2 ls;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_led_strip_v2_create(&ls, NULL, hal), "create device object");

    // Set first 3 LEDs to red, green and blue
    uint8_t value[9] = {255, 0, 0, 0, 255, 0, 0, 0, 255};
    check(tf_led_strip_v2_set_led_values(&ls, 0, value, 9), "call set_led_values");
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    tf_hal_callback_tick(hal, 0);
}

Callback

Download (example_callback.c)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
// This example is not self-contained.
// It requires usage of the example driver specific to your platform.
// See the HAL documentation.

#include "src/bindings/hal_common.h"
#include "src/bindings/bricklet_led_strip_v2.h"

void check(int rc, const char *msg);
void example_setup(TF_HAL *hal);
void example_loop(TF_HAL *hal);

#define NUM_LEDS 16

static uint8_t rgb[NUM_LEDS * 3] = {0};
static uint16_t idx = 0;

static bool frame_started = false;
// Use frame started callback to trigger drawing the next frame.
static void frame_started_handler(TF_LEDStripV2 *device, uint16_t length, void *user_data) {
    (void)device; (void)length; (void)user_data; // avoid unused parameter warning

    frame_started = true;
}

static TF_LEDStripV2 ls;

void example_setup(TF_HAL *hal) {
    // Create device object
    check(tf_led_strip_v2_create(&ls, NULL, hal), "create device object");

    // Set frame duration to 50ms (20 frames per second)
    check(tf_led_strip_v2_set_frame_duration(&ls, 50), "call set_frame_duration");

    // Register frame started callback to function frame_started_handler
    tf_led_strip_v2_register_frame_started_callback(&ls,
                                                    frame_started_handler,
                                                    NULL);

    // Write one frame to trigger the frame started callback.
    tf_led_strip_v2_set_led_values(&ls, 0, rgb, NUM_LEDS * 3);
}

void example_loop(TF_HAL *hal) {
    // Poll for callbacks
    // Polling with 0 will process one packet at most, so we can't miss a frame.
    tf_hal_callback_tick(hal, 0);
    if (!frame_started) {
        return;
    }

    frame_started = false;

    rgb[idx] = 0;
    idx += 3;
    if (idx >= NUM_LEDS * 3) {
        idx = 0;
    }
    rgb[idx] = 255;

    tf_led_strip_v2_set_led_values(&ls, 0, rgb, NUM_LEDS * 3);
}

API

Most functions of the C/C++ bindings for microcontrollers return an error code (e_code).

Possible error codes are:

  • TF_E_OK = 0
  • TF_E_TIMEOUT = -1
  • TF_E_INVALID_PARAMETER = -2
  • TF_E_NOT_SUPPORTED = -3
  • TF_E_UNKNOWN_ERROR_CODE = -4
  • TF_E_STREAM_OUT_OF_SYNC = -5
  • TF_E_INVALID_CHAR_IN_UID = -6
  • TF_E_UID_TOO_LONG = -7
  • TF_E_UID_OVERFLOW = -8
  • TF_E_TOO_MANY_DEVICES = -9
  • TF_E_DEVICE_NOT_FOUND = -10
  • TF_E_WRONG_DEVICE_TYPE = -11
  • TF_E_LOCKED = -12
  • TF_E_PORT_NOT_FOUND = -13

(as defined in errors.h) as well as the errors returned from the hardware abstraction layer (HAL) that is used.

Use :cpp:func`tf_hal_strerror` (defined in the HAL's header file) to get an error string for an error code.

Data returned from the device, when a getter is called, is handled via output parameters. These parameters are labeled with the ret_ prefix. The bindings will not write to an output parameter if NULL or nullptr is passed. This can be used to ignore outputs that you are not interested in.

None of the functions listed below are thread-safe. See the API bindings description for details.

Basic Functions

int tf_led_strip_v2_create(TF_LEDStripV2 *led_strip_v2, const char *uid_or_port_name, TF_HAL *hal)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
  • uid – Type: const char *
  • hal – Type: TF_HAL *
Returns:
  • e_code – Type: int

Creates the device object led_strip_v2 with the optional unique device ID or port name uid_or_port_name and adds it to the HAL hal:

TF_LEDStripV2 led_strip_v2;
tf_led_strip_v2_create(&led_strip_v2, NULL, &hal);

Normally uid_or_port_name can stay NULL. For more details about this see section UID or Port Name.

int tf_led_strip_v2_destroy(TF_LEDStripV2 *led_strip_v2)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
Returns:
  • e_code – Type: int

Removes the device object led_strip_v2 from its HAL and destroys it. The device object cannot be used anymore afterwards.

int tf_led_strip_v2_set_led_values(TF_LEDStripV2 *led_strip_v2, uint16_t index, const uint8_t *value, uint16_t value_length)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
  • index – Type: uint16_t, Range: [0 to 6144]
  • value – Type: const uint8_t *, Range: [0 to 255]
  • value_length – Type: uint16_t
Returns:
  • e_code – Type: int

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

To make the colors show correctly you need to configure the chip type (see tf_led_strip_v2_set_chip_type()) and a channel mapping (see tf_led_strip_v2_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 tf_led_strip_v2_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 Frame Started callback.
  • Set all of the LED colors for next frame.
  • Wait for the Frame Started callback.
  • And so on.

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

int tf_led_strip_v2_get_led_values(TF_LEDStripV2 *led_strip_v2, uint16_t index, uint16_t length, uint8_t *ret_value, uint16_t *ret_value_length)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
  • index – Type: uint16_t, Range: [0 to 6144]
  • length – Type: uint16_t, Range: [0 to 6144]
Output Parameters:
  • ret_value – Type: uint8_t *, Range: [0 to 255]
  • ret_value_length – Type: uint16_t
Returns:
  • e_code – Type: int

Returns length RGB(W) values starting from the given index.

If the channel mapping has 3 colors, you will get the data in the sequence RGBRGBRGB... if the channel mapping has 4 colors you will get the data in the sequence RGBWRGBWRGBW... (assuming you start at an index divisible by 3 (RGB) or 4 (RGBW)).

int tf_led_strip_v2_set_frame_duration(TF_LEDStripV2 *led_strip_v2, uint16_t duration)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
  • duration – Type: uint16_t, Unit: 1 ms, Range: [0 to 216 - 1], Default: 100
Returns:
  • e_code – Type: int

Sets the frame duration.

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

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

int tf_led_strip_v2_get_frame_duration(TF_LEDStripV2 *led_strip_v2, uint16_t *ret_duration)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
Output Parameters:
  • ret_duration – Type: uint16_t, Unit: 1 ms, Range: [0 to 216 - 1], Default: 100
Returns:
  • e_code – Type: int

Returns the frame duration as set by tf_led_strip_v2_set_frame_duration().

int tf_led_strip_v2_get_supply_voltage(TF_LEDStripV2 *led_strip_v2, uint16_t *ret_voltage)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
Output Parameters:
  • ret_voltage – Type: uint16_t, Unit: 1 mV, Range: [0 to 216 - 1]
Returns:
  • e_code – Type: int

Returns the current supply voltage of the LEDs.

int tf_led_strip_v2_set_clock_frequency(TF_LEDStripV2 *led_strip_v2, uint32_t frequency)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
  • frequency – Type: uint32_t, Unit: 1 Hz, Range: [10000 to 2000000], Default: 1666666
Returns:
  • e_code – Type: int

Sets the frequency of the clock.

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

int tf_led_strip_v2_get_clock_frequency(TF_LEDStripV2 *led_strip_v2, uint32_t *ret_frequency)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
Output Parameters:
  • ret_frequency – Type: uint32_t, Unit: 1 Hz, Range: [10000 to 2000000], Default: 1666666
Returns:
  • e_code – Type: int

Returns the currently used clock frequency as set by tf_led_strip_v2_set_clock_frequency().

int tf_led_strip_v2_set_chip_type(TF_LEDStripV2 *led_strip_v2, uint16_t chip)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
  • chip – Type: uint16_t, Range: See constants, Default: 2801
Returns:
  • e_code – Type: int

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),
  • WS2813 / WS2815 (Chip Type = WS2812)
  • LPD8806 and
  • APA102 / DotStar.

The following constants are available for this function:

For chip:

  • TF_LED_STRIP_V2_CHIP_TYPE_WS2801 = 2801
  • TF_LED_STRIP_V2_CHIP_TYPE_WS2811 = 2811
  • TF_LED_STRIP_V2_CHIP_TYPE_WS2812 = 2812
  • TF_LED_STRIP_V2_CHIP_TYPE_LPD8806 = 8806
  • TF_LED_STRIP_V2_CHIP_TYPE_APA102 = 102
int tf_led_strip_v2_get_chip_type(TF_LEDStripV2 *led_strip_v2, uint16_t *ret_chip)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
Output Parameters:
  • ret_chip – Type: uint16_t, Range: See constants, Default: 2801
Returns:
  • e_code – Type: int

Returns the currently used chip type as set by tf_led_strip_v2_set_chip_type().

The following constants are available for this function:

For ret_chip:

  • TF_LED_STRIP_V2_CHIP_TYPE_WS2801 = 2801
  • TF_LED_STRIP_V2_CHIP_TYPE_WS2811 = 2811
  • TF_LED_STRIP_V2_CHIP_TYPE_WS2812 = 2812
  • TF_LED_STRIP_V2_CHIP_TYPE_LPD8806 = 8806
  • TF_LED_STRIP_V2_CHIP_TYPE_APA102 = 102
int tf_led_strip_v2_set_channel_mapping(TF_LEDStripV2 *led_strip_v2, uint8_t mapping)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
  • mapping – Type: uint8_t, Range: See constants, Default: 36
Returns:
  • e_code – Type: int

Sets the channel mapping for the connected LEDs.

If the mapping has 4 colors, the function tf_led_strip_v2_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 following constants are available for this function:

For mapping:

  • TF_LED_STRIP_V2_CHANNEL_MAPPING_RGB = 6
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_RBG = 9
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_BRG = 33
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_BGR = 36
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_GRB = 18
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_GBR = 24
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_RGBW = 27
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_RGWB = 30
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_RBGW = 39
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_RBWG = 45
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_RWGB = 54
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_RWBG = 57
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_GRWB = 78
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_GRBW = 75
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_GBWR = 108
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_GBRW = 99
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_GWBR = 120
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_GWRB = 114
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_BRGW = 135
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_BRWG = 141
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_BGRW = 147
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_BGWR = 156
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_BWRG = 177
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_BWGR = 180
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_WRBG = 201
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_WRGB = 198
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_WGBR = 216
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_WGRB = 210
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_WBGR = 228
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_WBRG = 225
int tf_led_strip_v2_get_channel_mapping(TF_LEDStripV2 *led_strip_v2, uint8_t *ret_mapping)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
Output Parameters:
  • ret_mapping – Type: uint8_t, Range: See constants, Default: 36
Returns:
  • e_code – Type: int

Returns the currently used channel mapping as set by tf_led_strip_v2_set_channel_mapping().

The following constants are available for this function:

For ret_mapping:

  • TF_LED_STRIP_V2_CHANNEL_MAPPING_RGB = 6
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_RBG = 9
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_BRG = 33
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_BGR = 36
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_GRB = 18
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_GBR = 24
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_RGBW = 27
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_RGWB = 30
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_RBGW = 39
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_RBWG = 45
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_RWGB = 54
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_RWBG = 57
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_GRWB = 78
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_GRBW = 75
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_GBWR = 108
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_GBRW = 99
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_GWBR = 120
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_GWRB = 114
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_BRGW = 135
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_BRWG = 141
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_BGRW = 147
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_BGWR = 156
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_BWRG = 177
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_BWGR = 180
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_WRBG = 201
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_WRGB = 198
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_WGBR = 216
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_WGRB = 210
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_WBGR = 228
  • TF_LED_STRIP_V2_CHANNEL_MAPPING_WBRG = 225

Advanced Functions

int tf_led_strip_v2_get_spitfp_error_count(TF_LEDStripV2 *led_strip_v2, uint32_t *ret_error_count_ack_checksum, uint32_t *ret_error_count_message_checksum, uint32_t *ret_error_count_frame, uint32_t *ret_error_count_overflow)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
Output Parameters:
  • ret_error_count_ack_checksum – Type: uint32_t, Range: [0 to 232 - 1]
  • ret_error_count_message_checksum – Type: uint32_t, Range: [0 to 232 - 1]
  • ret_error_count_frame – Type: uint32_t, Range: [0 to 232 - 1]
  • ret_error_count_overflow – Type: uint32_t, Range: [0 to 232 - 1]
Returns:
  • e_code – Type: int

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

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing 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.

int tf_led_strip_v2_set_status_led_config(TF_LEDStripV2 *led_strip_v2, uint8_t config)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
  • config – Type: uint8_t, Range: See constants, Default: 3
Returns:
  • e_code – Type: int

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.

The following constants are available for this function:

For config:

  • TF_LED_STRIP_V2_STATUS_LED_CONFIG_OFF = 0
  • TF_LED_STRIP_V2_STATUS_LED_CONFIG_ON = 1
  • TF_LED_STRIP_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • TF_LED_STRIP_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int tf_led_strip_v2_get_status_led_config(TF_LEDStripV2 *led_strip_v2, uint8_t *ret_config)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
Output Parameters:
  • ret_config – Type: uint8_t, Range: See constants, Default: 3
Returns:
  • e_code – Type: int

Returns the configuration as set by tf_led_strip_v2_set_status_led_config()

The following constants are available for this function:

For ret_config:

  • TF_LED_STRIP_V2_STATUS_LED_CONFIG_OFF = 0
  • TF_LED_STRIP_V2_STATUS_LED_CONFIG_ON = 1
  • TF_LED_STRIP_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • TF_LED_STRIP_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int tf_led_strip_v2_get_chip_temperature(TF_LEDStripV2 *led_strip_v2, int16_t *ret_temperature)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
Output Parameters:
  • ret_temperature – Type: int16_t, Unit: 1 °C, Range: [-215 to 215 - 1]
Returns:
  • e_code – Type: int

Returns the temperature 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.

int tf_led_strip_v2_reset(TF_LEDStripV2 *led_strip_v2)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
Returns:
  • e_code – Type: int

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!

int tf_led_strip_v2_get_identity(TF_LEDStripV2 *led_strip_v2, char ret_uid[8], char ret_connected_uid[8], char *ret_position, uint8_t ret_hardware_version[3], uint8_t ret_firmware_version[3], uint16_t *ret_device_identifier)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
Output Parameters:
  • ret_uid – Type: char[8]
  • ret_connected_uid – Type: char[8]
  • ret_position – Type: char, Range: ['a' to 'h', 'z']
  • ret_hardware_version – Type: uint8_t[3]
    • 0: major – Type: uint8_t, Range: [0 to 255]
    • 1: minor – Type: uint8_t, Range: [0 to 255]
    • 2: revision – Type: uint8_t, Range: [0 to 255]
  • ret_firmware_version – Type: uint8_t[3]
    • 0: major – Type: uint8_t, Range: [0 to 255]
    • 1: minor – Type: uint8_t, Range: [0 to 255]
    • 2: revision – Type: uint8_t, Range: [0 to 255]
  • ret_device_identifier – Type: uint16_t, Range: [0 to 216 - 1]
Returns:
  • e_code – Type: int

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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

int tf_led_strip_v2_set_frame_started_callback_configuration(TF_LEDStripV2 *led_strip_v2, bool enable)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
  • enable – Type: bool, Default: true
Returns:
  • e_code – Type: int

Enables/disables the Frame Started callback.

int tf_led_strip_v2_get_frame_started_callback_configuration(TF_LEDStripV2 *led_strip_v2, bool *ret_enable)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
Output Parameters:
  • ret_enable – Type: bool, Default: true
Returns:
  • e_code – Type: int

Returns the configuration as set by tf_led_strip_v2_set_frame_started_callback_configuration().

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding tf_led_strip_v2_register_*_callback function. The user_data passed to the registration function as well as the device that triggered the callback are passed to the registered callback handler.

Only one handler can be registered to a callback at the same time. To deregister a callback, call the tf_led_strip_v2_register_*_callback function with NULL as handler.

Note

Using callbacks for recurring events is preferred compared to using getters. Polling for a callback requires writing one byte only. See here Optimizing Performance.

Warning

Calling bindings function from inside a callback handler is not allowed. See here Thread safety.

int tf_led_strip_v2_register_frame_started_callback(TF_LEDStripV2 *led_strip_v2, TF_LEDStripV2_FrameStartedHandler handler, void *user_data)
void handler(TF_LEDStripV2 *led_strip_v2, uint16_t length, void *user_data)
Callback Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
  • length – Type: uint16_t, Range: [0 to 6144]
  • user_data – Type: void *

This callback is triggered directly after a new frame render is started. The parameter is the number of LEDs in that frame.

You should send the data for the next frame directly after this callback was triggered.

For an explanation of the general approach see tf_led_strip_v2_set_led_values().

Virtual Functions

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object.

int tf_led_strip_v2_get_response_expected(TF_LEDStripV2 *led_strip_v2, uint8_t function_id, bool *ret_response_expected)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
  • function_id – Type: uint8_t, Range: See constants
Output Parameters:
  • ret_response_expected – Type: bool
Returns:
  • e_code – Type: int

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 tf_led_strip_v2_set_response_expected(). 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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

  • TF_LED_STRIP_V2_FUNCTION_SET_LED_VALUES = 1
  • TF_LED_STRIP_V2_FUNCTION_SET_FRAME_DURATION = 3
  • TF_LED_STRIP_V2_FUNCTION_SET_CLOCK_FREQUENCY = 7
  • TF_LED_STRIP_V2_FUNCTION_SET_CHIP_TYPE = 9
  • TF_LED_STRIP_V2_FUNCTION_SET_CHANNEL_MAPPING = 11
  • TF_LED_STRIP_V2_FUNCTION_SET_FRAME_STARTED_CALLBACK_CONFIGURATION = 13
  • TF_LED_STRIP_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • TF_LED_STRIP_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • TF_LED_STRIP_V2_FUNCTION_RESET = 243
  • TF_LED_STRIP_V2_FUNCTION_WRITE_UID = 248
int tf_led_strip_v2_set_response_expected(TF_LEDStripV2 *led_strip_v2, uint8_t function_id, bool response_expected)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
  • function_id – Type: uint8_t, Range: See constants
  • response_expected – Type: bool
Returns:
  • e_code – Type: int

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.

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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For function_id:

  • TF_LED_STRIP_V2_FUNCTION_SET_LED_VALUES = 1
  • TF_LED_STRIP_V2_FUNCTION_SET_FRAME_DURATION = 3
  • TF_LED_STRIP_V2_FUNCTION_SET_CLOCK_FREQUENCY = 7
  • TF_LED_STRIP_V2_FUNCTION_SET_CHIP_TYPE = 9
  • TF_LED_STRIP_V2_FUNCTION_SET_CHANNEL_MAPPING = 11
  • TF_LED_STRIP_V2_FUNCTION_SET_FRAME_STARTED_CALLBACK_CONFIGURATION = 13
  • TF_LED_STRIP_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • TF_LED_STRIP_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • TF_LED_STRIP_V2_FUNCTION_RESET = 243
  • TF_LED_STRIP_V2_FUNCTION_WRITE_UID = 248
int tf_led_strip_v2_set_response_expected_all(TF_LEDStripV2 *led_strip_v2, bool response_expected)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
  • response_expected – Type: bool
Returns:
  • e_code – Type: int

Changes the response expected flag for all setter and callback configuration functions of this device at once.

Internal Functions

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

int tf_led_strip_v2_set_bootloader_mode(TF_LEDStripV2 *led_strip_v2, uint8_t mode, uint8_t *ret_status)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
  • mode – Type: uint8_t, Range: See constants
Output Parameters:
  • ret_status – Type: uint8_t, Range: See constants
Returns:
  • e_code – Type: int

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

The following constants are available for this function:

For mode:

  • TF_LED_STRIP_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • TF_LED_STRIP_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • TF_LED_STRIP_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • TF_LED_STRIP_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • TF_LED_STRIP_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For ret_status:

  • TF_LED_STRIP_V2_BOOTLOADER_STATUS_OK = 0
  • TF_LED_STRIP_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • TF_LED_STRIP_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • TF_LED_STRIP_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • TF_LED_STRIP_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • TF_LED_STRIP_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int tf_led_strip_v2_get_bootloader_mode(TF_LEDStripV2 *led_strip_v2, uint8_t *ret_mode)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
Output Parameters:
  • ret_mode – Type: uint8_t, Range: See constants
Returns:
  • e_code – Type: int

Returns the current bootloader mode, see tf_led_strip_v2_set_bootloader_mode().

The following constants are available for this function:

For ret_mode:

  • TF_LED_STRIP_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • TF_LED_STRIP_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • TF_LED_STRIP_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • TF_LED_STRIP_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • TF_LED_STRIP_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int tf_led_strip_v2_set_write_firmware_pointer(TF_LEDStripV2 *led_strip_v2, uint32_t pointer)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
  • pointer – Type: uint32_t, Unit: 1 B, Range: [0 to 232 - 1]
Returns:
  • e_code – Type: int

Sets the firmware pointer for tf_led_strip_v2_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.

int tf_led_strip_v2_write_firmware(TF_LEDStripV2 *led_strip_v2, const uint8_t data[64], uint8_t *ret_status)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
  • data – Type: const uint8_t[64], Range: [0 to 255]
Output Parameters:
  • ret_status – Type: uint8_t, Range: [0 to 255]
Returns:
  • e_code – Type: int

Writes 64 Bytes of firmware at the position as written by tf_led_strip_v2_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.

int tf_led_strip_v2_write_uid(TF_LEDStripV2 *led_strip_v2, uint32_t uid)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
  • uid – Type: uint32_t, Range: [0 to 232 - 1]
Returns:
  • e_code – Type: int

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.

int tf_led_strip_v2_read_uid(TF_LEDStripV2 *led_strip_v2, uint32_t *ret_uid)
Parameters:
  • led_strip_v2 – Type: TF_LEDStripV2 *
Output Parameters:
  • ret_uid – Type: uint32_t, Range: [0 to 232 - 1]
Returns:
  • e_code – Type: int

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

Constants

TF_LED_STRIP_V2_DEVICE_IDENTIFIER

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

The functions tf_led_strip_v2_get_identity() and tf_hal_get_device_info() have a device_identifier output parameter to specify the Brick's or Bricklet's type.

TF_LED_STRIP_V2_DEVICE_DISPLAY_NAME

This constant represents the human readable name of a LED Strip Bricklet 2.0.