Skip to content

API reference

Every class, member and function of the driver, generated from the headers by Doxygen.

Open the API reference

Start here

Page What it documents
WS2812Strip One strip: pixels, brightness, timing, Show()
WS2812Animator The effects and Tick()
WS2812MultiAnimator One effect over several strips
ws2812::RmtTx The RMT transmit channel underneath
ws2812_control.h The older C interface and the Kconfig-derived constants
File list Every header

The API guide shows the same API by task, with code that compiles.