brightness_handle.h File Reference

Handle the output LED strip brightness. More...

Go to the source code of this file.

Namespaces
namespace	lampda
	Program scope.
namespace	lampda::logic
	Handle the main high level logics.
namespace	lampda::logic::brightness
	Handle the LED output brightness.
namespace	lampda::logic::indicator
	Handle the indicator brightness.

Functions
brightness_t	lampda::logic::brightness::get_brightness ()
	Return the current brightness value (in range 0 - brightness::absoluteMaximumBrightness). It's value depends on a lot of factors and can be cantrolled by any actors.
brightness_t	lampda::logic::brightness::get_saved_brightness ()
	Return the saved brightness level. This shoudl be the prefered option in all computations.
brightness_t	lampda::logic::brightness::get_max_brightness ()
	Return the maximum allowed brightness.
brightness_t	lampda::logic::brightness::get_max_user_brightness ()
	Return the maximum allowed brightness for the user modes.
void	lampda::logic::brightness::set_max_brightness (const brightness_t brg)
	Set the new max brightness.
void	lampda::logic::brightness::set_max_user_brightness (const brightness_t brg)
	Set the maximum allowed brightness for the user modes.
void	lampda::logic::brightness::update_saved_brightness ()
	Update the saved brightness value with the current brightness.
void	lampda::logic::brightness::update_brightness (const brightness_t newBrightness, const bool shouldCallUserBrightnessCallback=false)
	update the internal brightness values
void	lampda::logic::brightness::force_brightness_user_callback ()
	force an update call to the user brightness callback
uint32_t	lampda::logic::brightness::when_last_update_brightness ()
	Get time in milliseconds when brightness was last updated.
void	lampda::logic::indicator::set_brightness_level (const uint8_t level)
	Set the brightness of the RGB indicator. Indicator level can be 0 : indicator and alerts displayed as 100% brightness 1 : indicator off, alerts displayed as 25% brightness 2 : indicator and alerts displayed as 25% brightness.
uint8_t	lampda::logic::indicator::get_brightness_level ()
	Get the brightness of the RGB indicator. Indicator level can be 0 : indicator and alerts displayed as 100% brightness 1 : indicator off, alerts displayed as 25% brightness 2 : indicator and alerts displayed as 25% brightness.
bool	lampda::logic::indicator::should_indicator_be_visible ()
	indicates if the indicator should be visible or not

Detailed Description

Handle the output LED strip brightness.