EduArt Sensor Ring Library 4.0.0
Loading...
Searching...
No Matches
eduart::sensorring::device::WS2812b_Params Struct Reference

Parameter structure of the WS2812b LEDs. More...

#include <WS2812b_Params.hpp>

Inheritance diagram for eduart::sensorring::device::WS2812b_Params:
[legend]
Collaboration diagram for eduart::sensorring::device::WS2812b_Params:
[legend]

Public Member Functions

 WS2812b_Params ()
 Default constructor.
 WS2812b_Params (const LightParams &params)
 Initializes the WS2812b_Params from a LightParams instance.
Public Member Functions inherited from eduart::sensorring::device::LightParams
void validateDistanceMapBrightness () const
 Validates the distance map parameters.
void validateDistanceMapRange () const
 Throws if the range cannot be represented by the firmware's float32 parameters.
virtual ~LightParams ()=default
 Destructor.

Additional Inherited Members

Public Attributes inherited from eduart::sensorring::device::LightParams
double distance_map_lower_m = 0.1
 Lower DistanceMap saturation threshold in meters. Lights are red below this distance.
double distance_map_upper_m = 0.5
 Upper DistanceMap saturation threshold in meters. Lights are green above this distance.
std::int64_t max_brightness = 50
 DistanceMap peak channel brightness on the LED's 0-255 scale (0 disables it).
Public Attributes inherited from eduart::sensorring::device::DeviceParams
DeviceID id
 Device identifier (type, name, index).
bool enable = true
 Whether the device is enabled at creation.
double max_rate_hz = 15.0

Detailed Description

Parameter structure of the WS2812b LEDs.


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