unit_CardKB2_defs.hpp File Reference

Shared constants and types for CardKB2 I2C and UART classes. More...

#include "unit_Keyboard.hpp"

Go to the source code of this file.

Namespaces
namespace	m5
	Top level namespace of M5stack.

Functions
key_index_t	m5::unit::cardkb2::character_to_key_index (const char ch)
	Character to key index.
uint8_t	m5::unit::cardkb2::character_to_mode_bits (const char ch)
	Character to mode bits.

Variables
constexpr uint8_t	m5::unit::cardkb2::NUMBER_OF_KEYS {43}
key index (bit position in scan result)
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_1 {0}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_2 {1}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_3 {2}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_4 {3}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_5 {4}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_6 {5}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_7 {6}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_8 {7}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_9 {8}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_0 {9}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_Q {11}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_W {12}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_E {13}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_R {14}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_T {15}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_Y {16}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_U {17}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_I {18}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_O {19}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_P {20}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_DELETE {21}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_AA {22}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_A {23}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_S {24}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_D {25}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_F {26}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_G {27}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_H {28}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_J {29}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_K {30}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_L {31}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_ENTER {32}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_FN {33}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_SYM {34}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_Z {35}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_X {36}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_C {37}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_V {38}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_B {39}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_N {40}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_M {41}
constexpr keyboard::key_index_t	m5::unit::cardkb2::KEY_SPACE {42}
Character code for special keys
constexpr char	m5::unit::cardkb2::SCHAR_LEFT {static_cast<char>(180)}
constexpr char	m5::unit::cardkb2::SCHAR_UP {static_cast<char>(181)}
constexpr char	m5::unit::cardkb2::SCHAR_DOWN {static_cast<char>(182)}
constexpr char	m5::unit::cardkb2::SCHAR_RIGHT {static_cast<char>(183)}

Detailed Description

Shared constants and types for CardKB2 I2C and UART classes.

Function Documentation

character_to_key_index()

keyboard::key_index_t m5::unit::cardkb2::character_to_key_index

(

const char

ch

)

Character to key index.

Return values

!=	0xFF keyboard::key_index_t
==	0xFF No corresponding key index exists

character_to_mode_bits()

uint8_t m5::unit::cardkb2::character_to_mode_bits

(

const char

ch

)

Character to mode bits.

Return values

==	0 Not exists
!=	0 Bits in corresponding mode

Note

0x01:normal 0x02:shift 0x04:symbol 0x08:function