Skip to content

Commit d652be3

Browse files
committed
Fixes README
1 parent e72c768 commit d652be3

1 file changed

Lines changed: 29 additions & 8 deletions

File tree

README.md

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,17 @@ QWERTY is a full-featured keyboard panel adapted to FACE_BOTTOM. There are 35 ke
1414
### SKU:U215
1515
Unit CardKB2 is a card-sized 42-key portable keyboard input unit. Its compact and lightweight form factor makes it ideal for on-the-go use and embedded integration.
1616

17+
### SKU:A164
18+
Tab5 Keyboard. (TODO: short product description to be added later.)
19+
1720

1821
## Related Link
1922
See also examples using conventional methods here.
2023

2124
- [Unit CardKB v1.1 & Datasheet](https://docs.m5stack.com/en/unit/cardkb_1.1)
2225
- [Faces QWERTY & Datasheet](https://docs.m5stack.com/en/module/faces_keyboard)
2326
- [Unit CardKB2 & Datasheet](https://docs.m5stack.com/en/products/sku/U215)
27+
- [Tab5 Keyboard & Datasheet](https://docs.m5stack.com/en/products/sku/A164)
2428

2529

2630
### Required Libraries:
@@ -44,22 +48,29 @@ You must choose a define symbol for the unit you will use.
4448
// *************************************************************
4549
// Choose one define symbol to match the unit you are using
4650
// *************************************************************
47-
#if !defined(USING_UNIT_CARDKB) && !defined(USING_UNIT_CARDKB2) && !defined(USING_UNIT_FACES_QWERTY)
48-
// For CardKB
51+
#if !defined(USING_UNIT_CARDKB) && !defined(USING_UNIT_CARDKB2) && !defined(USING_UNIT_FACES_QWERTY) && \
52+
!defined(USING_UNIT_TAB5_KEYBOARD)
53+
// For UnitCardKB (U035-B)
4954
// #define USING_UNIT_CARDKB
50-
// For CardKB2
55+
// For UnitCardKB2 (U215)
5156
// #define USING_UNIT_CARDKB2
57+
// For FacesQWERTY (A003)
58+
// #define USING_UNIT_FACES_QWERTY
59+
// For UnitTab5Keyboard (A164) (built into M5Stack Tab5)
60+
// #define USING_UNIT_TAB5_KEYBOARD
61+
// Choose Tab5 Keyboard operation mode (default: Normal)
62+
// #define USING_TAB5_KEYBOARD_NORMAL
63+
// #define USING_TAB5_KEYBOARD_HID
64+
// #define USING_TAB5_KEYBOARD_CHARACTER
65+
// *************************************************************
5266
#if defined(USING_UNIT_CARDKB2)
5367
// Choose one communication mode for CardKB2
5468
// For I2C
5569
// #define USING_I2C_FOR_CARDKB2
5670
// For UART
5771
// #define USING_UART_FOR_CARDKB2
5872
#endif
59-
// For FacesQWERTY
60-
// #define USING_UNIT_FACES_QWERTY
6173
#endif
62-
// *************************************************************
6374
```
6475

6576
## New firmware (CardKB / FacesQWERTY)
@@ -72,7 +83,17 @@ When this firmware is applied to CardKB or FacesQWERTY, the operating feel is ve
7283
- Individual modifier key state (Shift, Sym, Fn)
7384
- Configurable hold and repeat thresholds
7485

75-
### Doxygen document
86+
## CardKB2 firmware
87+
88+
The CardKB2 firmware source is maintained at [m5stack/M5Unit-CardKB2-UserDemo](https://github.com/m5stack/M5Unit-CardKB2-UserDemo).
89+
90+
## CardKB2 modifier state sync (UART mode only)
91+
92+
In UART mode, `UnitCardKB2UART` and the CardKB2 firmware track Sym toggle and Caps Lock state independently, with no query API between them. After resetting the host MCU (or restarting the application), also press the RST button on the CardKB2 so both sides start in the same cleared state.
93+
94+
I2C mode is unaffected — the firmware sends translated ASCII directly.
95+
96+
## Doxygen document
7697
[GitHub Pages](https://m5stack.github.io/M5Unit-KEYBOARD/)
7798

7899
If you want to generate documents on your local machine, execute the following command
@@ -84,7 +105,7 @@ bash docs/doxy.sh
84105
It will output it under docs/html
85106
If you want to output Git commit hashes to html, do it for the git cloned folder.
86107

87-
#### Required
108+
### Required
88109
- [Doxygen](https://www.doxygen.nl/)
89110
- [pcregrep](https://formulae.brew.sh/formula/pcre2)
90111
- [Git](https://git-scm.com/) (Output commit hash to html)

0 commit comments

Comments
 (0)