Lamp-Da/sunset__timer_8h_source.html

#ifndef UTILS_SUNSET_TIMER_H

#define UTILS_SUNSET_TIMER_H


#include <cstdint>


namespace lampda {

namespace logic {

namespace sunset {


void init();


void set_deadline(const uint32_t timeshutdown_s);


void add_time_minutes(const uint8_t time_minutes);


void shortcut_to_phaseout();


void bump_timer();


void cancel_timer();


bool is_enabled();


void lock_brightness_update(bool shouldLock);


} // namespace sunset

} // namespace logic

} // namespace lampda


#endif

lampda::logic::sunset::lock_brightness_update
void lock_brightness_update(bool shouldLock)
Lock the hability of the sunset timer to control the brightness.
Definition: sunset_timer.cpp:245

lampda::logic::sunset::set_deadline
void set_deadline(const uint32_t timeshutdown_s)
Set the sunset timer to a known clock deadline, replacing existing timers. Start the timer,...
Definition: sunset_timer.cpp:128

lampda::logic::sunset::bump_timer
void bump_timer()
signal to the timer that some time may be added. Only add time if the timer is in the fadeout phase
Definition: sunset_timer.cpp:204

lampda::logic::sunset::add_time_minutes
void add_time_minutes(const uint8_t time_minutes)
add some time to the sunset timer. Limited in the range [1; 10] minutes. If the timer is not started ...
Definition: sunset_timer.cpp:168

lampda::logic::sunset::shortcut_to_phaseout
void shortcut_to_phaseout()
If a timer is enabled, shortcut it to the start of the shutdown animation.
Definition: sunset_timer.cpp:190

lampda::logic::sunset::cancel_timer
void cancel_timer()
cancel the current active timer
Definition: sunset_timer.cpp:228

lampda::logic::sunset::init
void init()
call once on program start
Definition: sunset_timer.cpp:122

lampda::logic::sunset::is_enabled
bool is_enabled()
Indicate if the sunset is set.
Definition: sunset_timer.cpp:24

lampda
Program scope.
Definition: control_fixed_modes.hpp:12