flash_led.hpp

Go to the documentation of this file.

#ifndef SBL_CORE_COMPONENTS_DISPLAY_FLASH_LED_HPP_
#define SBL_CORE_COMPONENTS_DISPLAY_FLASH_LED_HPP_
 
/**
 * @file flash_led.hpp
 * @brief LED flasher for beat indication
 * @ingroup components
 */
 
#include <sbl/patterns/timing/non_blocking_delay.hpp>
 
namespace sbl {
namespace core {
namespace components {
namespace display {
 
/**
 * @brief LED flasher for beat and event indication
 * 
 * Provides timed LED flashing for visual feedback.
 * Encapsulates flash timing patterns for clean application code.
 * 
 * @tparam LedImpl LED implementation
 * @tparam TimerImpl Timer implementation for flash timing
 */
template<typename LedImpl, typename TimerImpl>
class FlashLed {
public:
    /**
     * @brief Construct LED flasher
     * @param led LED instance to control
     * @param flash_ms Flash duration in milliseconds (default: 50ms)
     */
    FlashLed(LedImpl& led, uint32_t flash_ms = 50) 
        : led_(led), flashDuration_(flash_ms), active_(false) {}
    
    /**
     * @brief Flash LED
     * 
     * Starts LED flash. Call update() regularly to handle timing.
     */
    void flash() {
        led_.on();
        flashTimer_.start(flashDuration_);
        active_ = true;
    }
    
    /**
     * @brief Update flash state
     * 
     * Call regularly from main loop to handle flash timing.
     */
    void update() {
        if (active_ && flashTimer_.hasExpired()) {
            led_.off();
            active_ = false;
        }
    }
    
    /**
     * @brief Check if LED is currently flashing
     * @return true if flash is active
     */
    bool isActive() const {
        return active_;
    }
    
    /**
     * @brief Set flash duration
     * @param flash_ms New flash duration in milliseconds
     */
    void setFlashDuration(uint32_t flash_ms) {
        flashDuration_ = flash_ms;
    }
    
private:
    LedImpl& led_;
    sbl::core::patterns::timing::NonBlockingDelay<TimerImpl> flashTimer_;
    uint32_t flashDuration_;
    bool active_;
};
 
} // namespace display
} // namespace components
} // namespace core
} // namespace sbl
 
#endif // SBL_CORE_COMPONENTS_DISPLAY_FLASH_LED_HPP_