PinEntryView.h

Go to the documentation of this file.

#pragma once
 
#include "cdc_ui/IView.h"
#include <cstdint>
 
namespace cdc::ui {

class PinEntryView : public ViewBase {
public:
    static constexpr uint8_t MAX_PIN_LENGTH = 8;
    static constexpr uint32_t LOCKOUT_DURATION_MS = 60000;  // 1 minute lockout

    using VerifyCallback = bool(*)(const char* pin);

    using SuccessCallback = void(*)();

    using CancelCallback = void(*)();

    using FailureCallback = void(*)(bool lockedOut);

    void init(const char* title, uint8_t maxPinLength = 6, uint8_t maxAttempts = 3);

    void setOnVerify(VerifyCallback callback) { onVerify_ = callback; }

    void setOnSuccess(SuccessCallback callback) { onSuccess_ = callback; }

    void setOnCancel(CancelCallback callback) { onCancel_ = callback; }

    void setOnFailure(FailureCallback callback) { onFailure_ = callback; }

    void setShowMessages(bool enabled) { showMessages_ = enabled; }

    const char* getPin() const { return buffer_; }

    uint8_t getAttempts() const { return attempts_; }

    bool isLockedOut() const { return lockedOut_; }

    void clear();

    void resetAttempts() { attempts_ = 0; lockedOut_ = false; }

    void setMinLength(uint8_t minLen) { minLength_ = minLen; }

    uint32_t getLockoutRemaining() const;
 
    // IView implementation
    void onEnter(void* context) override;
    void onTick(uint32_t nowMs) override;
    void render(bool partial) override;
    InputResult onKey(char key) override;
    const char* getName() const override { return "PinEntryView"; }
    const char* getFooterHint() const override;
 
private:
    const char* title_ = nullptr;
    char buffer_[MAX_PIN_LENGTH + 1] = {};
    uint8_t length_ = 0;
    uint8_t maxLength_ = 6;
    uint8_t minLength_ = 4;
    uint8_t attempts_ = 0;
    uint8_t maxAttempts_ = 3;
    bool lockedOut_ = false;
    uint32_t lockoutStartMs_ = 0;
 
    VerifyCallback onVerify_ = nullptr;
    SuccessCallback onSuccess_ = nullptr;
    CancelCallback onCancel_ = nullptr;
    FailureCallback onFailure_ = nullptr;
    bool showMessages_ = true;
 
    void addDigit(char digit);
    void backspace();
    void verify();
};
 
// ============================================================================
// Convenience Functions
// ============================================================================

PinEntryView* showPinEntry(const char* title,
                           PinEntryView::VerifyCallback onVerify,
                           PinEntryView::SuccessCallback onSuccess,
                           uint8_t maxLength = 6,
                           uint8_t minLength = 4,
                           uint8_t maxAttempts = 3);
 
} // namespace cdc::ui