led_strip_api.c File Reference

#include "esp_log.h"
#include "esp_check.h"
#include "led_strip.h"
#include "led_strip_interface.h"

Include dependency graph for led_strip_api.c:

Go to the source code of this file.

Functions
esp_err_t	led_strip_set_pixel (led_strip_handle_t strip, uint32_t index, uint32_t red, uint32_t green, uint32_t blue)
	Set RGB for a specific pixel.
esp_err_t	led_strip_set_pixel_hsv (led_strip_handle_t strip, uint32_t index, uint16_t hue, uint8_t saturation, uint8_t value)
	Set HSV for a specific pixel.
esp_err_t	led_strip_set_pixel_rgbw (led_strip_handle_t strip, uint32_t index, uint32_t red, uint32_t green, uint32_t blue, uint32_t white)
	Set RGBW for a specific pixel.
esp_err_t	led_strip_refresh (led_strip_handle_t strip)
	Refresh memory colors to LEDs.
esp_err_t	led_strip_clear (led_strip_handle_t strip)
	Clear LED strip (turn off all LEDs).
esp_err_t	led_strip_del (led_strip_handle_t strip)
	Free LED strip resources.

Variables
static const char *	TAG = "led_strip"

Function Documentation

led_strip_clear()

esp_err_t led_strip_clear

(

led_strip_handle_t

strip

)

Clear LED strip (turn off all LEDs).

Parameters

strip

LED strip

Returns

• ESP_OK: Clear LEDs successfully
• ESP_FAIL: Clear LEDs failed because some other error occurred

Definition at line 84 of file led_strip_api.c.

{
    ESP_RETURN_ON_FALSE(strip, ESP_ERR_INVALID_ARG, TAG, "invalid argument");
    return strip->clear(strip);
}

References led_strip_t::clear, and TAG.

led_strip_del()

esp_err_t led_strip_del

(

led_strip_handle_t

strip

)

Free LED strip resources.

Parameters

strip

LED strip

Returns

• ESP_OK: Free resources successfully
• ESP_FAIL: Free resources failed because error occurred

Definition at line 90 of file led_strip_api.c.

{
    ESP_RETURN_ON_FALSE(strip, ESP_ERR_INVALID_ARG, TAG, "invalid argument");
    return strip->del(strip);
}

References led_strip_t::del, and TAG.

led_strip_refresh()

esp_err_t led_strip_refresh

(

led_strip_handle_t

strip

)

Refresh memory colors to LEDs.

Parameters

strip

LED strip

Returns

• ESP_OK: Refresh successfully
• ESP_FAIL: Refresh failed because some other error occurred

Note

: After updating the LED colors in the memory, a following invocation of this API is needed to flush colors to strip.

Definition at line 78 of file led_strip_api.c.

{
    ESP_RETURN_ON_FALSE(strip, ESP_ERR_INVALID_ARG, TAG, "invalid argument");
    return strip->refresh(strip);
}

References led_strip_t::refresh, and TAG.

Referenced by cdc_tx_task().

Here is the caller graph for this function:

led_strip_set_pixel()

esp_err_t led_strip_set_pixel	(	led_strip_handle_t	strip,
		uint32_t	index,
		uint32_t	red,
		uint32_t	green,
		uint32_t	blue )

Set RGB for a specific pixel.

Parameters

strip	LED strip
index	index of pixel to set
red	red part of color
green	green part of color
blue	blue part of color

Returns

• ESP_OK: Set RGB for a specific pixel successfully
• ESP_ERR_INVALID_ARG: Set RGB for a specific pixel failed because of invalid parameters
• ESP_FAIL: Set RGB for a specific pixel failed because other error occurred

Definition at line 13 of file led_strip_api.c.

{
    ESP_RETURN_ON_FALSE(strip, ESP_ERR_INVALID_ARG, TAG, "invalid argument");
    return strip->set_pixel(strip, index, red, green, blue);
}

References led_strip_t::set_pixel, and TAG.

Referenced by cdc_tx_task().

Here is the caller graph for this function:

led_strip_set_pixel_hsv()

esp_err_t led_strip_set_pixel_hsv	(	led_strip_handle_t	strip,
		uint32_t	index,
		uint16_t	hue,
		uint8_t	saturation,
		uint8_t	value )

Set HSV for a specific pixel.

Parameters

strip	LED strip
index	index of pixel to set
hue	hue part of color (0 - 360)
saturation	saturation part of color (0 - 255, rescaled from 0 - 1. e.g. saturation = 0.5, rescaled to 127)
value	value part of color (0 - 255, rescaled from 0 - 1. e.g. value = 0.5, rescaled to 127)

Returns

• ESP_OK: Set HSV color for a specific pixel successfully
• ESP_ERR_INVALID_ARG: Set HSV color for a specific pixel failed because of an invalid argument
• ESP_FAIL: Set HSV color for a specific pixel failed because other error occurred

Definition at line 19 of file led_strip_api.c.

{
    ESP_RETURN_ON_FALSE(strip, ESP_ERR_INVALID_ARG, TAG, "invalid argument");
 
    uint32_t red = 0;
    uint32_t green = 0;
    uint32_t blue = 0;
 
    uint32_t rgb_max = value;
    uint32_t rgb_min = rgb_max * (255 - saturation) / 255.0f;
 
    uint32_t i = hue / 60;
    uint32_t diff = hue % 60;
 
    // RGB adjustment amount by hue
    uint32_t rgb_adj = (rgb_max - rgb_min) * diff / 60;
 
    switch (i) {
    case 0:
        red = rgb_max;
        green = rgb_min + rgb_adj;
        blue = rgb_min;
        break;
    case 1:
        red = rgb_max - rgb_adj;
        green = rgb_max;
        blue = rgb_min;
        break;
    case 2:
        red = rgb_min;
        green = rgb_max;
        blue = rgb_min + rgb_adj;
        break;
    case 3:
        red = rgb_min;
        green = rgb_max - rgb_adj;
        blue = rgb_max;
        break;
    case 4:
        red = rgb_min + rgb_adj;
        green = rgb_min;
        blue = rgb_max;
        break;
    default:
        red = rgb_max;
        green = rgb_min;
        blue = rgb_max - rgb_adj;
        break;
    }
 
    return strip->set_pixel(strip, index, red, green, blue);
}

References led_strip_t::set_pixel, and TAG.

led_strip_set_pixel_rgbw()

esp_err_t led_strip_set_pixel_rgbw	(	led_strip_handle_t	strip,
		uint32_t	index,
		uint32_t	red,
		uint32_t	green,
		uint32_t	blue,
		uint32_t	white )

Set RGBW for a specific pixel.

Note

Only call this function if your led strip does have the white component (e.g. SK6812-RGBW)

Also see led_strip_set_pixel if you only want to specify the RGB part of the color and bypass the white component

Parameters

strip	LED strip
index	index of pixel to set
red	red part of color
green	green part of color
blue	blue part of color
white	separate white component

Returns

• ESP_OK: Set RGBW color for a specific pixel successfully
• ESP_ERR_INVALID_ARG: Set RGBW color for a specific pixel failed because of an invalid argument
• ESP_FAIL: Set RGBW color for a specific pixel failed because other error occurred

Definition at line 72 of file led_strip_api.c.

{
    ESP_RETURN_ON_FALSE(strip, ESP_ERR_INVALID_ARG, TAG, "invalid argument");
    return strip->set_pixel_rgbw(strip, index, red, green, blue, white);
}

References led_strip_t::set_pixel_rgbw, and TAG.

Variable Documentation

TAG

const char* TAG = "led_strip"

static

Definition at line 11 of file led_strip_api.c.