uploaded 5 months ago
LED indicator driver

readme

## LED Indicator

As one of the simplest output peripherals, LED indicators can indicate the current operating state of the system by blinking in different types. ESP-IoT-Solution provides an LED indicator component with the following features:

* Can define multiple groups of different blink types
* Can define the priority of blink types
* Can set up multiple indicators
* LEDC and other drivers support adjustable brightness, gradient
* Support adjustment light with gamma
* Supports LED strips types like WS2812 and SK6812, and offers gradual color transitions based on the color wheel, brightness transitions, and the ability to specify LED index.

### Support LED Types

| LED TYPES  | ON_OFF | Brightness | Breath | Color | Color ring | Addressable |
| :--------: | :----: | :--------: | :----: | :---: | :--------: | :---------: |
|  GPIO LED  |   √    |     ×      |   ×    |   ×   |     ×      |      ×      |
|  PWN LED   |   √    |     √      |   √    |   ×   |     ×      |      ×      |
|  RGB LED   |   √    |     √      |   √    |   √   |     √      |      ×      |
| LED strips |   √    |     √      |   √    |   √   |     √      |      √      |

### LED Indicator User Guide

Please refer: https://docs.espressif.com/projects/esp-iot-solution/en/latest/display/led_indicator.html

changelog

# ChangeLog

## v0.8.0 -2023-11-21

### Enhancements:

* Supports RGB lights with three beads

## v0.7.2 - 2023-11-23

* Fix possible cmake_utilities dependency issue

## v0.7.1 - 2023-10-15

### BUG FIX

* Fix set HSV hue color.

### Enhancements:

* Added API for set color by temperature.

## v0.7.0 - 2023-11-09

### Enhancements:

* Renamed function `get_current_fade_value` to `get_brightness`.

* Added get functions for color (in RGB and HSV color format).

## v0.6.1 - 2023-10-31

### BUG FIX

* Fix preempt blink not stop as expected.

### Enhancements:

* Support LED RGB type by driver [led_strip](https://components.espressif.com/components/espressif/led_strip)

* Add api to control led indicator's brightness, HSV color, RGB color in real time

* Support change led indicator's color by type HSV and RGB.

* Support color gradient modification based on the color ring.

## v0.5.1 - 2023-10-23

### BUG FIX

* Fix the issue that led_indicator is destroyed but timer is still running.

## v0.5.0 - 2023-10-7

### Enhancements:

* Simplified the initialization process for LEDC.

### BUG FIX

* Resolved the blink issue in the breathing mode.

## v0.4.0 - 2023-4-12

### Enhancements:

* LED INDICATOR:
  * Add gamma adjustment
  * Update test_apps

## v0.3.0 - 2023-1-31

### Enhancements:

* LED INDICATOR:
  * Support customer mode: can customize multiple drivers
  * Support create LED by LEDC driver
  * Support breathe blink
  * Support set brightness
  * Support jump in line

## v0.2.0 - 2022-12-28

### Enhancements:

* LED INDICATOR:
  * Support customer-defined blink step
  * Support custom blink type

Links

Supports all targets

License: Apache-2.0

To add this component to your project, run:

idf.py add-dependency "espressif/led_indicator^0.8.0"

or download archive

Dependencies

  • espressif/cmake_utilities 0.*
  • ESP-IDF >=4.0
  • espressif/led_strip >=2.5.2
  • Stats

    • Downloaded in total
      Downloaded in total 7.0k times
    • Downloaded this version
      This version: 245 times

    Badge

    espressif/led_indicator version: 0.8.0
    |