actuator.hpp

Go to the documentation of this file.

 
#ifndef LSHCORE_PERIPHERALS_OUTPUT_ACTUATOR_HPP
#define LSHCORE_PERIPHERALS_OUTPUT_ACTUATOR_HPP
 
#include <stdint.h>
 
#include "internal/user_config_bridge.hpp"
 
class Actuator
{
private:
#ifndef CONFIG_USE_FAST_ACTUATORS
    const uint8_t pinNumber; 
#else
    const uint8_t pinMask;           
    volatile uint8_t *const pinPort; 
#endif
    uint8_t index = 0U;             
    const bool defaultState;        
    bool actualState = false;       
    uint32_t lastTimeSwitched = 0U; 
    bool isProtected = false;       
    uint8_t id;                     
    bool hasAutoOffTimer = false;   
    uint32_t autoOffTimer_ms = 0U;  
 
public:
#ifndef CONFIG_USE_FAST_ACTUATORS
    explicit constexpr Actuator(uint8_t pin, uint8_t uniqueId, bool normalState = false) noexcept : pinNumber(pin), defaultState(normalState), id(uniqueId)
    {
        pinMode(pin, OUTPUT);                                 // PinMode to Output
        digitalWrite(pin, static_cast<uint8_t>(normalState)); // Set the default state
    }
#else
    explicit Actuator(uint8_t pin, uint8_t uniqueId, bool normalState = false) noexcept : pinMask(digitalPinToBitMask(pin)), pinPort(portOutputRegister(digitalPinToPort(pin))), defaultState(normalState), id(uniqueId)
    {
        // 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;
 
        // Set the default state
        if (!normalState)
        {
            *this->pinPort &= ~this->pinMask;
        }
        else
        {
            *this->pinPort |= this->pinMask;
        }
    }
#endif
 
    /*  Workaround for https://stackoverflow.com/questions/28788353/clang-wweak-vtables-and-pure-abstract-class
        and https://stackoverflow.com/questions/28786473/clang-no-out-of-line-virtual-method-definitions-pure-abstract-c-class/40550578 */
 
#if (__cplusplus >= 201703L) && (__GNUC__ >= 7)
    Actuator(const Actuator &) = delete;
    Actuator(Actuator &&) = delete;
    auto operator=(const Actuator &) -> Actuator & = delete;
    auto operator=(Actuator &&) -> Actuator & = delete;
#endif // (__cplusplus >= 201703L) && (__GNUC__ >= 7)
 
    // Setters
    [[nodiscard]] auto setState(bool state) -> bool; // Sets the new state of the actuator, respecting debounce time.
 
    void setIndex(uint8_t indexToSet);                    // Set the actuator index on Actuators namespace Array
    auto setAutoOffTimer(uint32_t time_ms) -> Actuator &; // Set "turn off" timer in ms
    auto setProtected(bool hasProtection) -> Actuator &;  // Set protection against global "turn-off" actions (e.g., a general super long click).
 
    // Getters
    [[nodiscard]] auto getIndex() const -> uint8_t;         // Get the actuator index on Actuators namespace Array
    [[nodiscard]] auto getId() const -> uint8_t;            // Return unique ID of the actuator
    [[nodiscard]] auto getState() const -> bool;            // Returns the state of the actuator (false=OFF, true=ON)
    [[nodiscard]] auto getDefaultState() const -> bool;     // Returns the default state of the actuator
    [[nodiscard]] auto hasAutoOff() const -> bool;          // Returns if the actuators has a timer set
    [[nodiscard]] auto getAutoOffTimer() const -> uint32_t; // Returns the timer of the actuator
    [[nodiscard]] auto hasProtection() const -> bool;       // Returns true if the actuator is protected from global "turn-off" actions.
 
    // Utils
    [[nodiscard]] auto toggleState() -> bool;       // Switch the actuator
    [[nodiscard]] auto checkAutoOffTimer() -> bool; // Checks if auto off timer is over, turn off if it's over
};
 
#endif // LSHCORE_PERIPHERALS_OUTPUT_ACTUATOR_HPP