LED Driver#

Generic LED Driver.

Introduction#

The LED driver is a platfom level software module that manages the control of various types of LEDs. There are currently two types of LEDs supported by the LED driver:

• Simple LED Driver

• simple_rgbw_pwm_led

The common LED functions are called through the generic LED driver, while other functions specific to a certain type of LED are called directly through their own driver.

Configuration#

All LED instances are configured using an sl_led_t struct along with a type-specific context struct, and sometimes additional structs. For sl_led_XXX functions, the sl_led_t *led_handle is used, while for sl_simple_led_XXX functions, the sl_simple_led_context_t *context is used.

These structs are automatically generated when an LED is set up using Simplicity Studio's wizard. Specific configuration setups for the various LED types are described in the following sections.

• Simple LED Configuration

• RGBW PWM LED Configuration

Usage#

Once the LED structs are defined, the common LED functions can be called being passed an instance of sl_led_t, which will be redirected to calling the type specific version of that function. The common functions include the following:

• sl_led_init

• sl_led_turn_on

• sl_led_turn_off

• sl_led_toggle

• sl_led_get_state

These functions allow for initializing the LED, turning it on and off, toggling it, and retrieving its current state (on/off). Other functions specific to certain types of LEDs are called through their respective APIs. The usages of the different types of LEDs are described in detail in the following sections:

• Simple LED Usage

• rgbw_led_usage

Ensure that the appropriate context type is used in the function calls:

• Use sl_led_t *led_handle for sl_led_XXX functions.

• Use sl_simple_led_context_t *context for sl_simple_led_XXX functions.

These distinctions are handled by the Simplicity Studio auto-generated code.

Modules#

sl_led_t

Simple LED Driver

Simple RGB PWM LED Driver