unit_CardKB2.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2026 M5Stack Technology CO LTD
 *
 * SPDX-License-Identifier: MIT
 */
#ifndef M5_UNIT_KEYBOARD_UNIT_CARD_KB2_HPP
#define M5_UNIT_KEYBOARD_UNIT_CARD_KB2_HPP
 
#include "unit_CardKB2_defs.hpp"
 
namespace m5 {
namespace unit {
class UnitCardKB2 : public UnitKeyboard {
    M5_UNIT_COMPONENT_HPP_BUILDER(UnitCardKB2, 0x5F);
 
public:
    struct config_t {
        bool start_periodic{true};
        uint32_t interval{10};
    };
 
    explicit UnitCardKB2(const uint8_t addr = DEFAULT_ADDRESS) : UnitKeyboard(addr)
    {
    }
    virtual bool begin() override;
    virtual void update(const bool force = false) override;
 
 
    inline config_t config()
    {
        return _cfg;
    }
    inline void config(const config_t& cfg)
    {
        _cfg = cfg;
    }
 
    inline virtual char getchar() const override
    {
        return updated() ? _pressed_key : 0;
    }
    inline uint8_t available() const
    {
        return (updated() && _pressed_key) ? 1 : 0;
    }
    inline void discard()
    {
        _pressed_key = 0;
    }
 
 
    inline uint8_t firmwareVersion() const
    {
        return _firmware_version;
    }
    bool readFirmwareVersion(uint8_t& ver);
 
protected:
    config_t _cfg{};
    uint8_t _pressed_key{};
    uint8_t _firmware_version{};
};
 
}  // namespace unit
}  // namespace m5
#endif