Base class for units. More...

#include <M5UnitComponent.hpp>
#include <vector>

Classes
class	m5::unit::UnitKeyboard
	Base class of the Keyboard Unit. More...

class	m5::unit::UnitKeyboardBitwise
	Class supporting keyboard state acquisition by key press bits. More...

Namespaces
namespace	m5
	Top level namespace of M5stack.

namespace	keyboard
	For keyboard.

Typedefs
using	m5::unit::keyboard::key_index_t = uint8_t
	Key index (Not character)

using	m5::unit::keyboard::key_status_bits_t = uint64_t
	key state bits [56...63]:modifier, bits [0...55]:key bits

Enumerations
enum class	m5::unit::keyboard::Mode : uint8_t { Conventional , M5UnitUnified }
	Operation mode for M5Unit-KEYBOARD firmware. More...

Functions
constexpr key_status_bits_t	m5::unit::keyboard::modifier_bits (const key_status_bits_t kbs)
	Gets the modifier bits from key_status_bits_t.

Variables
constexpr uint8_t	m5::unit::keyboard::command::CMD_SCAN_REG {0x10}

constexpr uint8_t	m5::unit::keyboard::command::CMD_MODE_REG {0x20}

constexpr uint8_t	m5::unit::keyboard::command::CMD_FIRMWARE_VERSION_REG {0xFE}

Modifier's bit [56...63]
constexpr key_status_bits_t	m5::unit::keyboard::MODIFIER_SHIFT_BIT {0x0100000000000000}
	Shift.

constexpr key_status_bits_t	m5::unit::keyboard::MODIFIER_SYMBOL_BIT {0x0200000000000000}
	Symbol.

constexpr key_status_bits_t	m5::unit::keyboard::MODIFIER_FUNCTION_BIT {0x0400000000000000}
	Function.

constexpr key_status_bits_t	m5::unit::keyboard::MODIFIER_ALT_BIT {0x0800000000000000}
	Alt.

constexpr key_status_bits_t	m5::unit::keyboard::MODIFIER_CONTROL_BIT {0x1000000000000000}
	Control.

constexpr key_status_bits_t	m5::unit::keyboard::MODIFIER_OPTION_BIT {0x2000000000000000}
	Option.

Detailed Description

Base class for units.

Enumeration Type Documentation

strong

Operation mode for M5Unit-KEYBOARD firmware.

Enumerator

Conventional

Conventional behavior

CardKB,FacesQWERTY:Gets the released key

M5UnitUnified

M5Unit-KEYBOARD mode behavior

CardKB, FacesQWERTY:Gets the pressed key status