unit_FacesQWERTY.hpp

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2026 M5Stack Technology CO LTD
 *
 * SPDX-License-Identifier: MIT
 */
#ifndef M5_UNIT_KEYBOARD_UNIT_FACES_QWERTY_HPP
#define M5_UNIT_KEYBOARD_UNIT_FACES_QWERTY_HPP
 
#include "unit_Keyboard.hpp"
 
namespace m5 {
namespace unit {
 
namespace faces {
constexpr uint8_t TYPE_QWERTY{0x01};  
}  // namespace faces
 
class UnitFacesQWERTY : public UnitKeyboardBitwise {
    M5_UNIT_COMPONENT_HPP_BUILDER(UnitFacesQWERTY, 0x08);
 
public:
    static constexpr uint8_t NUMBER_OF_KEYS{35};
 
    static constexpr keyboard::key_index_t KEY_Q{0};
    static constexpr keyboard::key_index_t KEY_W{1};
    static constexpr keyboard::key_index_t KEY_E{2};
    static constexpr keyboard::key_index_t KEY_R{3};
    static constexpr keyboard::key_index_t KEY_T{4};
    static constexpr keyboard::key_index_t KEY_Y{5};
    static constexpr keyboard::key_index_t KEY_U{6};
    static constexpr keyboard::key_index_t KEY_I{7};
    static constexpr keyboard::key_index_t KEY_O{8};
    static constexpr keyboard::key_index_t KEY_P{9};
    static constexpr keyboard::key_index_t KEY_A{10};
    static constexpr keyboard::key_index_t KEY_S{11};
    static constexpr keyboard::key_index_t KEY_D{12};
    static constexpr keyboard::key_index_t KEY_F{13};
    static constexpr keyboard::key_index_t KEY_G{14};
    static constexpr keyboard::key_index_t KEY_H{15};
    static constexpr keyboard::key_index_t KEY_J{16};
    static constexpr keyboard::key_index_t KEY_K{17};
    static constexpr keyboard::key_index_t KEY_L{18};
    static constexpr keyboard::key_index_t KEY_BS{19};
    static constexpr keyboard::key_index_t KEY_NO_KEY_ALT{20};
    static constexpr keyboard::key_index_t KEY_Z{21};
    static constexpr keyboard::key_index_t KEY_X{22};
    static constexpr keyboard::key_index_t KEY_C{23};
    static constexpr keyboard::key_index_t KEY_V{24};
    static constexpr keyboard::key_index_t KEY_B{25};
    static constexpr keyboard::key_index_t KEY_N{26};
    static constexpr keyboard::key_index_t KEY_M{27};
    static constexpr keyboard::key_index_t KEY_DOLLAR{28};
    static constexpr keyboard::key_index_t KEY_ENTER{29};
    static constexpr keyboard::key_index_t KEY_NO_KEY_SHIFT{30};
    static constexpr keyboard::key_index_t KEY_0{31};
    static constexpr keyboard::key_index_t KEY_SPACE{32};
    static constexpr keyboard::key_index_t KEY_NO_KEY_SYM{33};
    static constexpr keyboard::key_index_t KEY_NO_KEY_FN{34};
 
    static constexpr char SCHAR_NOMARK_G{static_cast<char>(180)};
    static constexpr char SCHAR_NOMARK_H{static_cast<char>(181)};
    static constexpr char SCHAR_NOMARK_J{static_cast<char>(182)};
    static constexpr char SCHAR_UP{static_cast<char>(183)};
    static constexpr char SCHAR_INS{static_cast<char>(184)};
    static constexpr char SCHAR_HOME{static_cast<char>(187)};
    static constexpr char SCHAR_END{static_cast<char>(188)};
    static constexpr char SCHAR_PAGE_UP{static_cast<char>(189)};
    static constexpr char SCHAR_PAGE_DOWN{static_cast<char>(190)};
    static constexpr char SCHAR_LEFT{static_cast<char>(191)};
    static constexpr char SCHAR_DOWN{static_cast<char>(192)};
    static constexpr char SCHAR_RIGHT{static_cast<char>(193)};
    static constexpr char SCHAR_SPEAKER{static_cast<char>(194)};
 
    struct config_t {
        bool start_periodic{true};
        bool trigger_irq{true};
 
        keyboard::Mode mode{keyboard::Mode::Conventional};
        uint32_t interval{10};
        uint32_t repeating_threshold{400};
        uint32_t holding_threshold{800};
    };
 
    explicit UnitFacesQWERTY(const uint8_t addr = DEFAULT_ADDRESS) : UnitKeyboardBitwise(addr)
    {
        _repeat_start_at.resize(NUMBER_OF_KEYS);
        _hold_start_at.resize(NUMBER_OF_KEYS);
    }
    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 keyboard::key_index_t toKeyIndex(const char ch) const override
    {
        return character_to_key_index(ch);
    }
 
    static keyboard::key_index_t character_to_key_index(const char ch);
    static uint8_t character_to_mode_bits(const char ch);
 
 
    uint8_t facesType() const
    {
        return _type;
    }
    bool readFacesType(uint8_t& ftype);
 
#if defined(DOXYGEN_PROCESS)
    uint8_t released() const;
#endif
 
protected:
    bool update_new_firmware(const types::elapsed_time_t at);
    void push_back(m5::container::CircularBuffer<uint8_t>* container, const uint8_t kidx, const uint8_t mod8);
 
    inline virtual uint8_t to_mode_bits(const char ch) const override
    {
        return character_to_mode_bits(ch);
    }
 
protected:
    bool _handle_irq{};
    uint8_t _type{};
    config_t _cfg{};
};
 
namespace faces {
namespace command {
constexpr uint8_t CMD_FACES_TYPE_REG{0xFC};
}  // namespace command
}  // namespace faces
}  // namespace unit
}  // namespace m5
#endif