indicator.h File Reference

Interface for the physical components of the RGB user indicator. More...

Go to the source code of this file.

Namespaces
namespace	lampda
	Program scope.
namespace	lampda::physical
	Handle the physical modules drivers.
namespace	lampda::physical::indicator
	Handle the RGB indicator display.

Functions
void	lampda::physical::indicator::init ()
	Initialize the RGB indicator. Call once on program start.
void	lampda::physical::indicator::set_color (const utils::ColorSpace::RGB &c)
	Set the color of the indicator.
void	lampda::physical::indicator::set_brightness (const uint8_t brightness)
	Set an indicator brightness (0-255)
uint8_t	lampda::physical::indicator::get_brightness ()
	Return the brightness of the indicator (0-255)
bool	lampda::physical::indicator::breeze (const uint32_t periodOn, const uint32_t periodOff, const utils::ColorSpace::RGB &color)
	Breeze animation.
bool	lampda::physical::indicator::color_loop (const uint32_t colorDuration, std::initializer_list< utils::ColorSpace::RGB > colors)
	color loop animation
bool	lampda::physical::indicator::blink (const uint32_t offFreq, const uint32_t onFreq, std::initializer_list< utils::ColorSpace::RGB > colors)
	Blink animation.
bool	lampda::physical::indicator::blink (const uint32_t offFreq, const uint32_t onFreq, const utils::ColorSpace::RGB &color)
	Blink animation.

Variables
static constexpr float	lampda::physical::indicator::redColorCorrection = 1.0f
	Scaling for the red color channel of an this RGB diode.
static constexpr float	lampda::physical::indicator::greenColorCorrection = 1.0f / 3.0f
	Scaling for the green color channel of an this RGB diode.
static constexpr float	lampda::physical::indicator::blueColorCorrection = 1.0f / 4.0f
	Scaling for the blue color channel of an this RGB diode.

Detailed Description

Interface for the physical components of the RGB user indicator.