MultiPurposeButton.hpp

Go to the documentation of this file.

/* ✔ */
 
#pragma once
 
#include <AH/Settings/Warnings.hpp>
AH_DIAGNOSTIC_WERROR() // Enable errors on warnings
 
#include "Button.hpp"
 
BEGIN_AH_NAMESPACE
 
class MultiPurposeButton {
  public:
    MultiPurposeButton(pin_t pin) : button(pin) {}
 
    enum Event {
        None,              
        PressStart,        
        ShortPressRelease, 
        LongPress,         
        LongPressRelease,  
        MultiPress,        
        MultiPressDone,    
    };
 
    void begin() { button.begin(); }
 
    Event update() {
        Event event = None;
        auto now = millis();
        auto stableTime = button.stableTime(now);
        switch (button.update()) {
            case Button::Released: {
                if (multiPressCountNew > 0 && stableTime > multiPressDelay) {
                    multiPressCount = multiPressCountNew;
                    multiPressCountNew = 0;
                    event = MultiPressDone;
                }
            } break;
            case Button::Falling: {
                event = (stableTime <= multiPressDelay) ? MultiPress //
                                                        : PressStart;
                multiPressCountNew += event == MultiPress;
            } break;
            case Button::Pressed: {
                if (not longPress && stableTime >= longPressDelay) {
                    event = LongPress;
                    longPress = true;
                }
            } break;
            case Button::Rising: {
                event = longPress ? LongPressRelease : ShortPressRelease;
                longPress = false;
            } break;
        }
        return event;
    }
 
    uint8_t getMultiPressCount() const { return multiPressCount; }
    uint8_t getCurrentMultiPressCount() const { return multiPressCountNew; }
 
    unsigned long getLongPressDelay() const { return longPressDelay; }
    void setLongPressDelay(unsigned long longPressDelay) {
        this->longPressDelay = longPressDelay;
    }
 
    unsigned long getMultiPressDelay() const { return multiPressDelay; }
    void setMultiPressDelay(unsigned long multiPressDelay) {
        this->multiPressDelay = multiPressDelay;
    }
 
    unsigned long previousBounceTime() const {
        return button.previousBounceTime();
    }
    unsigned long stableTime() const { return button.stableTime(); }
    unsigned long stableTime(unsigned long now) const {
        return button.stableTime(now);
    }
 
    unsigned long getPressedTime() const {
        return getButtonState() == Button::Pressed ? stableTime() : 0;
    }
    unsigned long getLongPressedTime() const {
        return longPress ? stableTime() : 0;
    }
 
    static FlashString_t getName(Event ev) { return to_string(ev); }
 
    Button::State getButtonState() const { return button.getState(); }
    void invert() { button.invert(); }
 
  protected:
    Button button;
    unsigned long longPressDelay = 1000;
    unsigned long multiPressDelay = 400;
    bool longPress = false;
    uint8_t multiPressCountNew = 0;
    uint8_t multiPressCount = 0;
 
  public:
    friend FlashString_t to_string(Event ev) {
        switch (ev) {
            case None: return F("None");
            case PressStart: return F("PressStart");
            case ShortPressRelease: return F("ShortPressRelease");
            case LongPress: return F("LongPress");
            case LongPressRelease: return F("LongPressRelease");
            case MultiPress: return F("MultiPress");
            case MultiPressDone: return F("MultiPressDone");
        }
        return F("<invalid>");
    }
};
 
END_AH_NAMESPACE
 
AH_DIAGNOSTIC_POP()