host_api_pixel_strip.cpp File Reference

Addressable pixel strip host API (WS2811/WS2812/WS2813/SK6812). More...

#include "plugin_manager/host_api.h"
#include "plugin_manager/Plugin.h"
#include "plugin_manager/PluginGpioPolicy.h"
#include "led_strip.h"
#include "led_strip_rmt.h"
#include "led_strip_types.h"
#include "freertos/FreeRTOS.h"
#include "freertos/semphr.h"
#include <cstring>

Go to the source code of this file.

Functions
void *	plg_get_active_plugin (void)
int	host_pixel_strip_init (uint8_t gpio_pin, uint16_t num_pixels, uint8_t format)
	Initialise or reconfigure the global pixel strip.
int	host_pixel_strip_deinit (void)
	Tear down the global pixel strip.
int	host_pixel_strip_set (uint16_t index, uint8_t r, uint8_t g, uint8_t b)
	Set one pixel's RGB colour in the strip buffer.
int	host_pixel_strip_fill (uint8_t r, uint8_t g, uint8_t b)
	Fill every pixel with the same RGB colour.
int	host_pixel_strip_clear (void)
	Clear every pixel to off (0, 0, 0).
int	host_pixel_strip_refresh (void)
	Push the strip buffer out over the RMT bus.
uint16_t	host_pixel_strip_length (void)
	Number of pixels the strip was initialised with.
bool	host_pixel_strip_ready (void)
	True when the strip has been successfully initialised.

Detailed Description

Addressable pixel strip host API (WS2811/WS2812/WS2813/SK6812).

Thin wrapper on top of ESP-IDF espressif/led_strip v2.5.x. One global strip handle is shared between plugins; (gpio_pin, num_pixels, format) identifies the configured strip. Manifest must declare capabilities.pixel_strip = true.

Definition in file host_api_pixel_strip.cpp.

Function Documentation

plg_get_active_plugin()

void * plg_get_active_plugin

(

void

)

Definition at line 24 of file plugin_log_bridge.cpp.