Button.hpp

Go to the documentation of this file.

/* ✔ */
 
#pragma once
 
#include <AH/Settings/Warnings.hpp>
AH_DIAGNOSTIC_WERROR() // Enable errors on warnings
 
#include <AH/Hardware/ExtendedInputOutput/ExtendedInputOutput.hpp>
#include <AH/Settings/SettingsWrapper.hpp>
 
BEGIN_AH_NAMESPACE
 
class Button {
  public:
    Button() : pin(NO_PIN) {}
 
    Button(pin_t pin);
    Button(ArduinoPin_t pin) : Button(pin_t(pin)) {}
 
    void begin();
 
    void invert();
 
    enum State {
        Pressed = 0b00,  
        Released = 0b11, 
        Falling = 0b10,  
        Rising = 0b01    
    };
 
    State update();
 
    State getState() const;
 
    static FlashString_t getName(State state);
 
    unsigned long previousBounceTime() const;
 
    unsigned long stableTime(unsigned long now) const;
 
    unsigned long stableTime() const;
 
    static void
    setDebounceTime(unsigned long debounceTime = BUTTON_DEBOUNCE_TIME);
 
    static unsigned long getDebounceTime();
 
  private:
    pin_t pin;
 
    struct InternalState {
        InternalState()
            : debounced(0b11), bouncing(true), prevInput(HIGH), invert(false),
              prevBounceTime(0) {}
        uint8_t debounced : 2;
        bool bouncing : 1;
        bool prevInput : 1;
        bool invert : 1;
        unsigned long prevBounceTime;
    } state;
 
    static unsigned long debounceTime;
};
 
END_AH_NAMESPACE
 
AH_DIAGNOSTIC_POP()