functions.h File Reference

Define specific needed user functions. More...

Go to the source code of this file.

Namespaces
namespace	lampda
	Program scope.
namespace	lampda::user
	Contains code handling custom user mode functions for indexable strips.

Functions
void	lampda::user::power_on_sequence ()
	Called when the system powers on (must be non blocking function!)
void	lampda::user::power_off_sequence ()
	Called when the system powers off (must be non blocking function!)
void	lampda::user::brightness_update (const lampda::brightness_t brightness)
	Called when the system changes the LED strip brightness.
void	lampda::user::sunset_timer_update (const float progress)
	Called when the sunset timer progresses [0; 1].
void	lampda::user::write_parameters ()
	Called when system wants to write parameters to filesystem.
void	lampda::user::read_parameters ()
	Called when system wants to read parameters from filesystem.
bool	lampda::user::button_start_click_default (const uint8_t clicks)
	Called to handle button click on lamp start.
bool	lampda::user::button_start_hold_default (const uint8_t clicks, const bool isEndOfHoldEvent, const uint32_t holdDuration)
	Called to handle button hold on lamp start.
void	lampda::user::button_clicked_default (const uint8_t clicks)
	Called to handle button click events for default user mode behaviors.
void	lampda::user::button_hold_default (const uint8_t nbClickAndHold, const bool isEndOfHoldEvent, const uint32_t holdDuration)
	Called to handle button click+hold events for user mode behaviors.
bool	lampda::user::button_clicked_usermode (const uint8_t nbClick)
	Called to handle button click events if "usermode UI" is active.
bool	lampda::user::button_hold_usermode (const uint8_t nbClickAndHold, const bool isEndOfHoldEvent, const uint32_t holdDuration)
	Called to handle button click+hold events if "usermode UI" is on.
void	lampda::user::loop ()
	Called at each tick of the main loop.
bool	lampda::user::should_spawn_thread ()
	Determine if a second user_thread() loop thread should be spawned.
void	lampda::user::user_thread ()
	Called at each tick of the secondary thread.
void	lampda::user::handle_elk_command (const utils::ELK::Package &elkControlCommand)
	Handle a ELK BLE package.

Variables
lampda::physical::LedStrip	lampda::user::_private::strip

Detailed Description

Define specific needed user functions.