indicator.hpp

Go to the documentation of this file.

 
#ifndef LSHCORE_PERIPHERALS_OUTPUT_INDICATOR_HPP
#define LSHCORE_PERIPHERALS_OUTPUT_INDICATOR_HPP
 
#include <etl/vector.h>
#include <stdint.h>
 
#include "internal/user_config_bridge.hpp"
#include "util/constants/indicatormodes.hpp"
 
class Indicator
{
private:
#ifndef CONFIG_USE_FAST_INDICATORS
    const uint8_t pinNumber; 
#else
    const uint8_t pinMask;           
    volatile uint8_t *const pinPort; 
#endif
    uint8_t index = 0U;                                               
    constants::IndicatorMode mode = constants::IndicatorMode::ANY;    
    etl::vector<uint8_t, CONFIG_MAX_ACTUATORS> controlledActuators{}; 
    bool actualState = false;                                         
 
public:
#ifndef CONFIG_USE_FAST_INDICATORS
    explicit constexpr Indicator(uint8_t pin) noexcept : pinNumber(pin)
    {
        pinMode(pin, OUTPUT); // PinMode to Output
    }
#else
    explicit Indicator(uint8_t pin) noexcept : pinMask(digitalPinToBitMask(pin)), pinPort(portOutputRegister(digitalPinToPort(pin)))
    {
        // PinMode to OUTPUT
        uint8_t port = digitalPinToPort(pin);
        volatile uint8_t *const reg = portModeRegister(port);
        const uint8_t oldSREG = SREG;
        cli();
        *reg |= this->pinMask;
        SREG = oldSREG;
    }
#endif
 
#if (__cplusplus >= 201703L) && (__GNUC__ >= 7)
    Indicator(const Indicator &) = delete;
    Indicator(Indicator &&) = delete;
    auto operator=(const Indicator &) -> Indicator & = delete;
    auto operator=(Indicator &&) -> Indicator & = delete;
#endif // (__cplusplus >= 201703L) && (__GNUC__ >= 7)
 
    inline 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 setIndex(uint8_t indexToSet);                                   // Set the indicator index on Indicators namespace Array
    auto addActuator(uint8_t actuatorIndex) -> Indicator &;              // Add one actuator to controlled actuators vector
    auto setMode(constants::IndicatorMode indicatorMode) -> Indicator &; // Set indicator mode
    void check();                                                        // Perform the actual check
 
    [[nodiscard]] auto getIndex() const -> uint8_t;                      // Get the indicator index on Indicators namespace Array
};
 
#endif // LSHCORE_PERIPHERALS_OUTPUT_INDICATOR_HPP