EventButton.h

/*
 * GPLv2 Licence https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt
 * 
 * Copyright (c) 2024 Philip Fletcher <philip.fletcher@stutchbury.com>
 * 
 */
 
#ifndef EVENT_BUTTON_H
#define EVENT_BUTTON_H
 
#include "Arduino.h"
#include "EventInputBase.h"
#include "PinAdapter/FoltmanDebounceAdapter.h"
#include "PinAdapter/GpioPinAdapter.h"
 
class EventButton : public EventInputBase {
 
    protected:
 
    #if defined(FUNCTIONAL_SUPPORTED)
        typedef std::function<void(InputEventType et, EventButton &ie)> CallbackFunction;
    #else
        typedef void (*CallbackFunction)(InputEventType et, EventButton &);
    #endif
 
    CallbackFunction callbackFunction = nullptr;
 
 
    public:
 
 
    EventButton(byte buttonPin, bool useDefaultDebouncer=true);
 
    EventButton(PinAdapter* _pinAdapter, bool useDefaultDebouncer=true);
 
    EventButton(PinAdapter* _pinAdapter, DebounceAdapter* debounceAdapter);
 
 
 
 
    void begin();
 
    void setCallback(CallbackFunction f) {
        callbackFunction = f;
        callbackIsSet = true;
    }
 
    #if defined(FUNCTIONAL_SUPPORTED)
    template <typename T>
    void setCallback(T* instance, void (T::*method)(InputEventType, EventButton&)) {
        // Wrap the method call in a lambda
        callbackFunction = [instance, method](InputEventType et, EventButton& ie) {
            (instance->*method)(et, ie); // Call the member function on the instance
        };
        callbackIsSet = true;
    }
    #endif
 
    void unsetCallback() override;
 
    void update();
 
 
 
 
    uint8_t clickCount() { return prevClickCount; }
 
 
    uint8_t longPressCount() { return longPressCounter; }
 
    bool isPressed() { return currentState == pressedState; }
 
    uint32_t currentDuration();
 
    uint32_t previousDuration()  { return durationOfPreviousState; }
 
 
 
 
    void enableLongPressRepeat(bool repeat=true) { repeatLongPress = repeat; }
 
    void setLongClickDuration(uint16_t longDurationMs=750) { longClickDuration = longDurationMs; }
 
    void setLongPressInterval(uint16_t intervalMs=500) { longPressInterval = intervalMs; }
 
    void setMultiClickInterval(uint16_t intervalMs=250) { multiClickInterval = intervalMs; }
 
    void setDebouncer(DebounceAdapter* debounceAdapter);
 
    bool setDebounceInterval(uint16_t intervalMs=10);
 
    void setPressedState(bool state = LOW){ pressedState = state; }
 
 
 
    protected:
 
    void invoke(InputEventType et) override;
 
 
    void onDisabled() override;
 
    void changeState(bool newState);
 
    bool changedState();
 
    bool changedPinState();
 
    bool releasing() { return stateChanged && previousState == pressedState; }
    
    bool pressing() { return stateChanged && previousState != pressedState; }
 
    private:
 
    PinAdapter* pinAdapter;
    DebounceAdapter* debouncer;
 
    bool pressedState = LOW; //The state that represents 'pressed'
 
    //state
 
    bool currentPinState = HIGH;
    bool previousPinState = HIGH;
 
    bool currentState = HIGH; //set via PinAdapter->read()
    bool previousState = HIGH;
    bool stateChanged = false;
    uint32_t stateChangeLastTime;
    uint32_t durationOfPreviousState;
 
    uint8_t clickCounter = 0;
    uint8_t prevClickCount = 0;
    bool clickFired = true;
 
    //setup
    uint16_t multiClickInterval = 250;
    uint16_t longClickDuration = 750;
    bool repeatLongPress = true;
    uint16_t longPressInterval = 500;
    uint16_t longPressCounter = 0;
 
 
 
};
 
 
#endif