WS2812_RMT Driver 0.1.0
API reference
Loading...
Searching...
No Matches
Static Public Member Functions | Public Attributes | List of all members
ws2812_rmt::Config Struct Reference

Everything EnsureInitialized() uses. The defaults suit a current WS2812B (V5, V6). More...

#include <ws2812_rmt_types.hpp>

Static Public Member Functions

static constexpr Config Default () noexcept
 

Public Attributes

Variant variant {Variant::Ws2812bV5}
 The timing generation; no profile fits every part.
 
bool use_default_order {true}
 False: order is used. Always false for Custom.
 
ColourOrder order {}
 Wire order when use_default_order is false.
 
uint8_t brightness {255}
 Linear dimming at start, 0 to 255.
 
Gamma gamma {Gamma::None}
 Transfer curve at start.
 
uint32_t pixel_count {0}
 Pixels in the strip; 0 means the whole capacity.
 
uint32_t reset_us {0}
 Reset low time; 0 = datasheet minimum plus kResetMarginUs.
 
uint32_t power_on_settle_us {1000}
 Wait after PowerOn() (no datasheet value, A-16).
 
uint32_t transmit_slack_ms {20}
 Added to the frame time to form the port timeout.
 
Timing custom {}
 Used only with Variant::Custom; all zero otherwise.
 

Detailed Description

Everything EnsureInitialized() uses. The defaults suit a current WS2812B (V5, V6).

Member Function Documentation

◆ Default()

static constexpr Config ws2812_rmt::Config::Default ( )
inlinestaticconstexprnoexcept
Returns
The default configuration.

The documentation for this struct was generated from the following file: