EventInputBase.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_INPUT_BASE_H
#define EVENT_INPUT_BASE_H
 
#include <Arduino.h>
 
#include "InputEvents.h"
 
#ifdef FUNCTIONAL_SUPPORTED
    #include <functional>
#endif
 
 
class EventInputBase {
 
 
    protected:
 
    uint8_t input_id = 0; 
    uint8_t input_value = 0; 
    bool _enabled = true; 
    bool idleFlagged = true; 
    unsigned long lastEventMs = millis(); 
    unsigned long idleTimeout = 10000; 
 
 
    public:
 
    virtual void begin() = 0;
 
    virtual void unsetCallback();
 
    bool isCallbackSet() { return callbackIsSet; }
 
    void update();
 
    bool isEnabled() { return _enabled; }
    
    void enable(bool e = true);
 
 
    void setIdleTimeout(unsigned int timeoutMs=10000) { idleTimeout = timeoutMs; }
 
    unsigned long msSinceLastEvent() { return millis() - lastEventMs; }
 
    bool isIdle() { return (millis() - lastEventMs) > idleTimeout; }
 
    void resetIdleTimer();
 
 
    void blockEvent(InputEventType et);
 
    void allowEvent(InputEventType et);
 
    void blockAllEvents();
 
    void allowAllEvents() { memset(excludedEvents, 0, sizeof(excludedEvents)); } // Reset the bitmask to 0 
 
    bool isEventAllowed(InputEventType et);
 
 
    void setInputId(uint8_t id) { input_id = id; }
 
    uint8_t getInputId() {return input_id; }
 
    void setInputValue(uint8_t val) { input_value = val; }
 
    uint8_t getInputValue() { return input_value; }
 
 
protected:
    bool callbackIsSet = false; 
 
    bool isInvokable(InputEventType et);
 
    virtual void invoke(InputEventType et) = 0;
 
    virtual void onEnabled();
    virtual void onDisabled();
    virtual void onIdle();
 
 
 
 
private:
    uint8_t excludedEvents[2] = {0};
 
 
#ifndef FUNCTIONAL_SUPPORTED
public:
    void setOwner(void *own) { owner = own; }
    void *getOwner() { return owner; }
 
protected:
    void *owner = nullptr;
#endif
 
 
};
 
#endif