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

Parameter structure of the Light. More...

#include <LightParams.hpp>

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

Public Member Functions

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.

Public Attributes

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 Light.


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