IKeypad.h

Go to the documentation of this file.

#pragma once
 
#include "cdc_core/IService.h"
#include <cstdint>
 
namespace cdc::hal {

enum class Key : char {
    KEY_1 = '1', KEY_2 = '2', KEY_3 = '3',
    KEY_4 = '4', KEY_5 = '5', KEY_6 = '6',
    KEY_7 = '7', KEY_8 = '8', KEY_9 = '9',
    KEY_NO = 'N', KEY_0 = '0', KEY_YES = 'Y',
    KEY_NONE = 0
};

using KeyCallback = void(*)(Key key, bool pressed);

class IKeypad : public core::IService {
public:
    virtual ~IKeypad() = default;

    virtual void poll() = 0;

    virtual bool isKeyPressed(Key key) const = 0;

    virtual Key getNextKey() = 0;

    virtual bool hasKey() const = 0;

    virtual bool anyKeyDown() const = 0;

    virtual void setCallback(KeyCallback callback) = 0;

    virtual void setLongPressEnabled(bool enabled, uint32_t thresholdMs = 800) = 0;

    using LongPressCallback = void(*)(Key key);
    virtual void setLongPressCallback(LongPressCallback callback) = 0;

    using PanicChordCallback = void(*)();
    virtual void setPanicChordCallback(PanicChordCallback callback) = 0;

    static constexpr uint32_t DEFER_SRC_VIEW  = 1u << 0;  
    static constexpr uint32_t DEFER_SRC_EVENT = 1u << 1;  

    virtual void setDeferShortPress(uint32_t source, bool enabled) {
        (void)source;
        (void)enabled;
    }

    virtual void setKeyRepeat(uint16_t initial_ms, uint16_t period_ms) {
        (void)initial_ms;
        (void)period_ms;
    }

    virtual void prepareForSleep() = 0;

    virtual void recoverFromSleep() = 0;

    virtual void clearBuffer() = 0;
};
 
// Factory function to get keypad instance
IKeypad* getKeypadInstance();
 
} // namespace cdc::hal