indicator.hpp

Go to the documentation of this file.

 
#ifndef LSH_CORE_PERIPHERALS_OUTPUT_INDICATOR_HPP
#define LSH_CORE_PERIPHERALS_OUTPUT_INDICATOR_HPP
 
#include <stdint.h>
 
#include "internal/cpp_features.hpp"
#include "internal/pin_tag.hpp"
#include "internal/user_config_bridge.hpp"
#ifdef CONFIG_USE_FAST_INDICATORS
#include "internal/avr_fast_io.hpp"
#endif
 
class Indicator
{
private:
#ifndef CONFIG_USE_FAST_INDICATORS
    const uint8_t pinNumber;  
#else
    const uint8_t pinMask;            
    volatile uint8_t *const pinPort;  
 
    explicit Indicator(lsh::core::avr::FastOutputPinBinding binding) noexcept : pinMask(binding.mask), pinPort(binding.pinPort)
    {
        // Indicators default to OFF. Prime the output latch before enabling
        // OUTPUT so setup cannot briefly expose an inherited HIGH level.
        const uint8_t oldSREG = SREG;
        cli();
        *this->pinPort &= ~this->pinMask;
        *binding.modePort |= this->pinMask;
        SREG = oldSREG;
    }
#endif
#if defined(LSH_DEBUG) || defined(LSH_STATIC_CONFIG_RUNTIME_CHECKS)
    uint8_t index = UINT8_MAX;  
#endif
    bool actualState = false;  
 
public:
#ifndef CONFIG_USE_FAST_INDICATORS
    explicit LSH_OPTIONAL_CONSTEXPR_CTOR Indicator(uint8_t pin) noexcept : pinNumber(pin)
    {
        digitalWrite(pin, LOW);
        pinMode(pin, OUTPUT);
    }
 
    template <uint8_t Pin>
    explicit LSH_OPTIONAL_CONSTEXPR_CTOR Indicator(lsh::core::PinTag<Pin>) noexcept : Indicator(static_cast<uint8_t>(Pin))
    {}
#else
    explicit Indicator(uint8_t pin) noexcept : Indicator(lsh::core::avr::makeFastOutputPinBinding(pin))
    {}
 
    template <uint8_t Pin>
    explicit Indicator(lsh::core::PinTag<Pin>) noexcept : Indicator(lsh::core::avr::makeFastOutputPinBinding(lsh::core::PinTag<Pin>{}))
    {}
#endif
 
#if LSH_USING_CPP17
    Indicator(const Indicator &) = delete;
    Indicator(Indicator &&) = delete;
    auto operator=(const Indicator &) -> Indicator & = delete;
    auto operator=(Indicator &&) -> Indicator & = delete;
#endif  // LSH_USING_CPP17
 
    void setState(bool stateToSet)
    {
#ifdef CONFIG_USE_FAST_INDICATORS
        if (!stateToSet)
        {
            *this->pinPort &= ~this->pinMask;
        }
        else
        {
            *this->pinPort |= this->pinMask;
        }
#else
        digitalWrite(this->pinNumber, static_cast<uint8_t>(stateToSet));
#endif
    }
    void applyComputedState(bool newState)
    {
        // Generated static profiles compute the indicator expression directly.
        // Keep the state-change guard here so refreshIndicators() can avoid the
        // old index-based Indicator::check() path in release builds.
        if (newState == this->actualState)
        {
            return;
        }
        this->actualState = newState;
        this->setState(newState);
    }
    void setIndex(uint8_t indexToSet);  // Set the indicator index on Indicators namespace Array
    void check();                       // Perform the actual check
 
    [[nodiscard]] auto getIndex() const -> uint8_t;  // Get the indicator index on Indicators namespace Array
};
 
#endif  // LSH_CORE_PERIPHERALS_OUTPUT_INDICATOR_HPP