Zephyr Project API 4.3.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches

Texas Instruments TLC5971 (and compatible) LED strip controllers. More...

Files

file  tlc5971.h
 Header file for extended LED Strip API of TLC5971 LED strip controller.

Macros

#define TLC5971_GLOBAL_BRIGHTNESS_CONTROL_MAX   127
 Maximum value for global brightness control, i.e 100% brightness.

Functions

int tlc5971_set_global_brightness (const struct device *dev, struct led_rgb pixel)
 Set the global brightness control (BC) levels of a TLC5971 strip.

Detailed Description

Texas Instruments TLC5971 (and compatible) LED strip controllers.

Macro Definition Documentation

◆ TLC5971_GLOBAL_BRIGHTNESS_CONTROL_MAX

#define TLC5971_GLOBAL_BRIGHTNESS_CONTROL_MAX   127

#include </__w/bridle/bridle/workspace/zephyr/include/zephyr/drivers/led_strip/tlc5971.h>

Maximum value for global brightness control, i.e 100% brightness.

Function Documentation

◆ tlc5971_set_global_brightness()

int tlc5971_set_global_brightness ( const struct device * dev,
struct led_rgb pixel )

#include </__w/bridle/bridle/workspace/zephyr/include/zephyr/drivers/led_strip/tlc5971.h>

Set the global brightness control (BC) levels of a TLC5971 strip.

The TLC5971 has a 7-bit global brightness control (BC) for each color group (Red, Green, Blue). This function allows setting these values.

The brightness value of each channel of pixel (r, g, b) maps to the corresponding global brightness control register (BCR, BCG, BCB) and must be lower than or equal to TLC5971_GLOBAL_BRIGHTNESS_CONTROL_MAX.

The change takes effect on the next update of the LED strip.

Parameters
devLED strip device
pixelGlobal brightness values for RGB channels
Returns
0 on success, negative on error