led.hpp

Go to the documentation of this file.

/**
 * @file led.hpp
 * @brief LED control interface for status indication
 * @ingroup components
 */
 
#ifndef SBL_CORE_COMPONENTS_DISPLAY_LED_HPP_
#define SBL_CORE_COMPONENTS_DISPLAY_LED_HPP_
 
#include <sbl/hal/gpio_pin.hpp>
 
namespace sbl {
namespace core {
namespace components {
namespace display {
 
/**
 * @brief LED control interface
 * 
 * Wraps GPIO pin operations with LED-specific semantics.
 * Template-based design provides compile-time optimization.
 * 
 * @tparam GpioPinImpl GPIO pin implementation type
 */
template<typename GpioPinImpl>
class Led {
public:
    /**
     * @brief Construct LED controller
     * 
     * @param active_high true if LED is on when pin is high
     */
    explicit Led(bool active_high = true) 
        : active_high_(active_high), is_on_(false) {
        GpioPinImpl::setMode(sbl::core::hal::PinMode::Output);
        off();  // Start in known state
    }
    
    /**
     * @brief Turn LED on
     */
    void on() {
        is_on_ = true;
        GpioPinImpl::write(active_high_ ? sbl::core::hal::PinLevel::High : sbl::core::hal::PinLevel::Low);
    }
    
    /**
     * @brief Turn LED off
     */
    void off() {
        is_on_ = false;
        GpioPinImpl::write(active_high_ ? sbl::core::hal::PinLevel::Low : sbl::core::hal::PinLevel::High);
    }
    
    /**
     * @brief Toggle LED state
     */
    void toggle() {
        if (is_on_) {
            off();
        } else {
            on();
        }
    }
    
    /**
     * @brief Set LED state
     * @param state true to turn on, false to turn off
     */
    void set(bool state) {
        if (state) {
            on();
        } else {
            off();
        }
    }
    
    /**
     * @brief Get current LED state
     * @return true if LED is on
     */
    bool isOn() const {
        return is_on_;
    }
    
    /**
     * @brief Get current LED state
     * @return true if LED is off
     */
    bool isOff() const {
        return !is_on_;
    }
 
private:
    bool active_high_;
    bool is_on_;
};
 
} // namespace display
} // namespace components
} // namespace core
} // namespace sbl
 
#endif // SBL_CORE_COMPONENTS_DISPLAY_LED_HPP_