EventEncoder.h

/*
 *
 * GPLv2 Licence https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt
 * 
 * Copyright (c) 2024 Philip Fletcher <philip.fletcher@stutchbury.com>
 * 
 */
 
#include "InputEvents.h"
 
#ifndef EXCLUDE_EVENT_ENCODER
 
#ifndef EVENT_ENCODER_H
#define EVENT_ENCODER_H
 
#include "Arduino.h"
#include "EventInputBase.h"
#include <EncoderAdapter.h>
 
class EventEncoder : public EventInputBase {
 
    protected:
 
    #if defined(FUNCTIONAL_SUPPORTED)
        typedef std::function<void(InputEventType et, EventEncoder &ie)> CallbackFunction;
    #else
        typedef void (*CallbackFunction)(InputEventType et, EventEncoder &);
    #endif
 
    CallbackFunction callbackFunction = NULL;
 
    void readIncrement();
 
public:
 
 
    EventEncoder(EncoderAdapter *encoderAdapter);
 
    ~EventEncoder();
 
 
    void begin();
 
    void setCallback(CallbackFunction f) {
        callbackFunction = f;
        callbackIsSet = true;
    }
 
    #if defined(FUNCTIONAL_SUPPORTED)
    // Method to set callback with instance and class method
    template <typename T>
    void setCallback(T* instance, void (T::*method)(InputEventType, EventEncoder&)) {
        // Wrap the method call in a lambda
        callbackFunction = [instance, method](InputEventType et, EventEncoder &ie) {
            (instance->*method)(et, ie); // Call the member function on the instance
        };
        callbackIsSet = true;
    }
    #endif
 
    void unsetCallback() override;
 
    void update();
 
 
    int16_t increment() { return encoderIncrement; }
 
    long position() { return currentPosition; }
 
 
    void setRateLimit(long ms=0) { rateLimit = ms; }
 
    void setPositionDivider(uint8_t divider=4) {
        if ( divider > 0 ) {
                positionDivider = divider;
            }
        }
 
    uint8_t getPositionDivider() { return positionDivider; }
 
 
    void resetPosition(long pos = 0) { currentPosition = pos; }
 
protected:
 
    void invoke(InputEventType et) override;
    void onEnabled() override;
 
private:
 
    EncoderAdapter *encoder;
 
    uint8_t positionDivider = 4;
    int32_t currentPosition  = 0;
    int32_t oldPosition  = 0;
    unsigned int rateLimit = 0;
    unsigned long rateLimitCounter = 0;   
    int encoderIncrement  = 0;
 
};
 
#endif
 
#endif