WS2812_RMT Driver 0.1.0
API reference
Loading...
Searching...
No Matches
Namespaces | Macros | Functions
ws2812_rmt_kconfig.hpp File Reference

Optional ESP-IDF layer: a Config built from the CONFIG_WS2812_RMT_* Kconfig options. More...

#include "ws2812_rmt_types.hpp"

Go to the source code of this file.

Namespaces

namespace  ws2812_rmt
 The WS2812_RMT driver: everything it declares lives here; internals in detail.
 

Macros

#define CONFIG_WS2812_RMT_DEFAULT_BRIGHTNESS   255
 
#define CONFIG_WS2812_RMT_RESET_US   0
 
#define CONFIG_WS2812_RMT_POWER_ON_SETTLE_US   1000
 

Functions

constexpr Variant ws2812_rmt::KconfigVariant () noexcept
 The variant menuconfig selected; Variant::Ws2812bV5 without a selection.
 
constexpr Config ws2812_rmt::KconfigDefaults () noexcept
 The configuration menuconfig selected, on top of the datasheet defaults.
 

Detailed Description

Optional ESP-IDF layer: a Config built from the CONFIG_WS2812_RMT_* Kconfig options.

Include it only where menuconfig should choose the defaults; without Kconfig KconfigDefaults() equals Config::Default(). One configuration per program: every translation unit of one program must see the same CONFIG_ values, and no driver header includes this one (handbook KB-CPP20-018).

Macro Definition Documentation

◆ CONFIG_WS2812_RMT_DEFAULT_BRIGHTNESS

#define CONFIG_WS2812_RMT_DEFAULT_BRIGHTNESS   255

Brightness at start when Kconfig does not set it: Config::Default().brightness.

◆ CONFIG_WS2812_RMT_POWER_ON_SETTLE_US

#define CONFIG_WS2812_RMT_POWER_ON_SETTLE_US   1000

Wait after PowerOn() when Kconfig does not set it: Config::Default().power_on_settle_us.

◆ CONFIG_WS2812_RMT_RESET_US

#define CONFIG_WS2812_RMT_RESET_US   0

Reset low time when Kconfig does not set it: 0, the datasheet minimum plus the margin.