unit_CardKB2UART.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_UART_HPP
#define M5_UNIT_KEYBOARD_UNIT_CARD_KB2_UART_HPP
 
#include "unit_CardKB2_defs.hpp"
#include "../utility/button_event_detector.hpp"
#include "../utility/cardkb2_modifier_state.hpp"
#include <m5_utility/container/circular_buffer.hpp>
#include <array>
 
namespace m5 {
namespace unit {
class UnitCardKB2UART : public UnitKeyboardBitwise {
    M5_UNIT_COMPONENT_HPP_BUILDER(UnitCardKB2UART, 0x5F);
 
public:
    using Packet = std::array<uint8_t, 5>;
 
    struct config_t {
        bool start_periodic{true};
        uint32_t interval{10};
    };
 
    explicit UnitCardKB2UART(const uint8_t addr = DEFAULT_ADDRESS) : UnitKeyboardBitwise(addr)
    {
    }
    virtual bool begin() override;
    virtual void update(const bool force = false) override;
 
 
    inline config_t config() const
    {
        return _cfg;
    }
    inline void config(const config_t& cfg)
    {
        _cfg = cfg;
    }
 
    inline virtual keyboard::key_index_t toKeyIndex(const char ch) const override
    {
        return cardkb2::character_to_key_index(ch);
    }
 
 
    virtual bool readFirmwareVersion(uint8_t& ver) override;
 
 
    virtual bool readMode(keyboard::Mode&) override
    {
        return false;
    }
    virtual bool writeMode(const keyboard::Mode) override
    {
        return false;
    }
 
protected:
    void update_uart(const bool force);
    uint8_t read_data(Packet& rbuf);
 
    inline virtual uint8_t to_mode_bits(const char ch) const override
    {
        return cardkb2::character_to_mode_bits(ch);
    }
 
protected:
    config_t _cfg{};
 
private:
    m5::unit::cardkb2::CardKB2ModifierState _mod{};
};
 
}  // namespace unit
}  // namespace m5
#endif