update lib and add usb keyboard demo

Gitshaoxiang · Gitshaoxiang · commit 2c0de0e91739 · 2023-10-16T10:22:02.000+08:00
diff --git a/examples/Basic/keyboard/inputText/inputText.ino b/examples/Basic/keyboard/inputText/inputText.ino
@@ -3,7 +3,7 @@
  * @author SeanKwok (shaoxiang@m5stack.com)
  * @brief M5Cardputer input text test
  * @version 0.1
- * @date 2023-10-09
+ * @date 2023-10-13
  *
  *
  * @Hardwares: M5Cardputer
@@ -47,7 +47,7 @@ void loop() {
         if (M5Cardputer.Keyboard.isPressed()) {
             Keyboard_Class::KeysState status = M5Cardputer.Keyboard.keysState();
 
-            for (auto i : status.values) {
+            for (auto i : status.word) {
                 data += i;
             }
 
diff --git a/examples/Basic/keyboard/multiPress/multiPress.ino b/examples/Basic/keyboard/multiPress/multiPress.ino
@@ -3,7 +3,7 @@
  * @author SeanKwok (shaoxiang@m5stack.com)
  * @brief M5Cardputer multi key test
  * @version 0.1
- * @date 2023-10-09
+ * @date 2023-10-13
  *
  *
  * @Hardwares: M5Cardputer
@@ -35,18 +35,13 @@ void loop() {
         if (M5Cardputer.Keyboard.isPressed()) {
             Keyboard_Class::KeysState status = M5Cardputer.Keyboard.keysState();
             String keyStr                    = "";
-            for (auto i : status.values) {
+            for (auto i : status.word) {
                 if (keyStr != "") {
                     keyStr = keyStr + "+" + i;
                 } else {
                     keyStr += i;
                 }
             }
-            Serial.println("key num: ");
-            for (auto i : status.keys) {
-                Serial.printf("%d ", i);
-            }
-            Serial.println("");
             M5Cardputer.Display.clear();
             M5Cardputer.Display.drawString(keyStr,
                                            M5Cardputer.Display.width() / 2,
diff --git a/examples/Basic/keyboard/singlePress/singlePress.ino b/examples/Basic/keyboard/singlePress/singlePress.ino
@@ -3,7 +3,7 @@
  * @author SeanKwok (shaoxiang@m5stack.com)
  * @brief M5Cardputer single key test
  * @version 0.1
- * @date 2023-10-09
+ * @date 2023-10-13
  *
  *
  * @Hardwares: M5Cardputer
@@ -23,22 +23,22 @@ void setup() {
     M5Cardputer.Display.setTextDatum(middle_center);
     M5Cardputer.Display.setTextFont(&fonts::FreeSerifBoldItalic18pt7b);
     M5Cardputer.Display.setTextSize(1);
-    M5Cardputer.Display.drawString("Press m Key",
+    M5Cardputer.Display.drawString("Press a Key",
                                    M5Cardputer.Display.width() / 2,
                                    M5Cardputer.Display.height() / 2);
 }
 
 void loop() {
     M5Cardputer.update();
     if (M5Cardputer.Keyboard.isChange()) {
-        if (M5Cardputer.Keyboard.isKeyPressed(KB_KEY_L_M)) {
+        if (M5Cardputer.Keyboard.isKeyPressed('a')) {
             M5Cardputer.Display.clear();
-            M5Cardputer.Display.drawString("m Pressed",
+            M5Cardputer.Display.drawString("a Pressed",
                                            M5Cardputer.Display.width() / 2,
                                            M5Cardputer.Display.height() / 2);
         } else {
             M5Cardputer.Display.clear();
-            M5Cardputer.Display.drawString("Press m Key",
+            M5Cardputer.Display.drawString("Press a Key",
                                            M5Cardputer.Display.width() / 2,
                                            M5Cardputer.Display.height() / 2);
         }
diff --git a/examples/Basic/keyboard/usbKeyboard/usbKeyboard.ino b/examples/Basic/keyboard/usbKeyboard/usbKeyboard.ino
@@ -0,0 +1,82 @@
+/**
+ * @file usbKeyboard.ino
+ * @author SeanKwok (shaoxiang@m5stack.com)
+ * @brief M5Cardputer USB Keyboard test
+ * @version 0.1
+ * @date 2023-10-13
+ *
+ *
+ * @Hardwares: M5Cardputer
+ * @Platform Version: Arduino M5Stack Board Manager v2.0.7
+ * @Dependent Library:
+ * M5GFX: https://github.com/m5stack/M5GFX
+ * M5Unified: https://github.com/m5stack/M5Unified
+ */
+
+#include "M5Cardputer.h"
+#include "USB.h"
+#include "USBHIDKeyboard.h"
+USBHIDKeyboard Keyboard;
+
+void setup() {
+    auto cfg = M5.config();
+    M5Cardputer.begin(cfg, true);
+    M5Cardputer.Display.setRotation(1);
+    M5Cardputer.Display.setTextColor(GREEN);
+    M5Cardputer.Display.setTextDatum(middle_center);
+    M5Cardputer.Display.setTextFont(&fonts::Orbitron_Light_24);
+    M5Cardputer.Display.setTextSize(1);
+    M5Cardputer.Display.drawString("USB Keyboard",
+                                   M5Cardputer.Display.width() / 2,
+                                   M5Cardputer.Display.height() / 2);
+    Keyboard.begin();
+    USB.begin();
+}
+
+void loop() {
+    M5Cardputer.update();
+    // max press 3 button at the same time
+    if (M5Cardputer.Keyboard.isChange()) {
+        if (M5Cardputer.Keyboard.isPressed()) {
+            Keyboard_Class::KeysState status = M5Cardputer.Keyboard.keysState();
+            // for (auto i : status.word) {
+            //     Keyboard.press(i);
+            // }
+            KeyReport report = {0};
+            report.modifiers = status.modifiers;
+            uint8_t index    = 0;
+            for (auto i : status.hid_keys) {
+                report.keys[index] = i;
+                index++;
+                if (index > 5) {
+                    index = 5;
+                }
+            }
+            Keyboard.sendReport(&report);
+            Keyboard.releaseAll();
+
+            // only text for display
+            String keyStr = "";
+            for (auto i : status.word) {
+                if (keyStr != "") {
+                    keyStr = keyStr + "+" + i;
+                } else {
+                    keyStr += i;
+                }
+            }
+
+            if (keyStr.length() > 0) {
+                M5Cardputer.Display.clear();
+                M5Cardputer.Display.drawString(
+                    keyStr, M5Cardputer.Display.width() / 2,
+                    M5Cardputer.Display.height() / 2);
+            }
+
+        } else {
+            M5Cardputer.Display.clear();
+            M5Cardputer.Display.drawString("USB Keyboard",
+                                           M5Cardputer.Display.width() / 2,
+                                           M5Cardputer.Display.height() / 2);
+        }
+    }
+}
diff --git a/library.json b/library.json
@@ -10,7 +10,7 @@
     "type": "git",
     "url": "https://github.com/m5stack/M5Cardputer.git"
   },
-  "version": "1.0.1",
+  "version": "1.0.2",
   "frameworks": ["arduino"],
   "platforms": ["espressif32", "native"],
   "headers": "M5Cardputer.h"
diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=M5Cardputer
-version=1.0.1
+version=1.0.2
 author=M5Stack
 maintainer=M5Stack
 sentence=Library for M5Stack M5Cardputer Board
diff --git a/src/utility/Keyboard.cpp b/src/utility/Keyboard.cpp
@@ -55,21 +55,18 @@ void Keyboard_Class::begin() {
     _set_output(output_list, 0);
 }
 
-int Keyboard_Class::getKeyCode(Point2D_t keyCoor) {
-    int ret = 0;
+uint8_t Keyboard_Class::getKey(Point2D_t keyCoor) {
+    uint8_t ret = 0;
 
     if ((keyCoor.x < 0) || (keyCoor.y < 0)) {
         return 0;
     }
-
-    // ret = (keyCoor.y * 14) + (keyCoor.x + 1);
     if (_keys_state_buffer.ctrl || _keys_state_buffer.shift ||
         _is_caps_locked) {
-        ret = _key_value_map[keyCoor.y][keyCoor.x].value_num_second;
+        ret = _key_value_map[keyCoor.y][keyCoor.x].value_second;
     } else {
-        ret = _key_value_map[keyCoor.y][keyCoor.x].value_num_first;
+        ret = _key_value_map[keyCoor.y][keyCoor.x].value_first;
     }
-
     return ret;
 }
 
@@ -117,10 +114,10 @@ bool Keyboard_Class::isChange() {
     }
 }
 
-bool Keyboard_Class::isKeyPressed(int keyCode) {
+bool Keyboard_Class::isKeyPressed(char c) {
     if (_key_list_buffer.size()) {
         for (const auto& i : _key_list_buffer) {
-            if (getKeyCode(i) == keyCode) return true;
+            if (getKey(i) == c) return true;
         }
     }
     return false;
@@ -130,66 +127,94 @@ bool Keyboard_Class::isKeyPressed(int keyCode) {
 
 void Keyboard_Class::updateKeysState() {
     _keys_state_buffer.reset();
-    _key_values_without_special_keys.clear();
+    _key_pos_print_keys.clear();
+    _key_pos_hid_keys.clear();
+    _key_pos_modifier_keys.clear();
 
     // Get special keys
     for (auto& i : _key_list_buffer) {
-        if (strcmp(getKeyValue(i).value_first, "tab") == 0) {
-            _keys_state_buffer.tab = true;
-            continue;
-        }
-
-        if (strcmp(getKeyValue(i).value_first, "fn") == 0) {
+        // modifier
+        if (getKeyValue(i).value_first == KEY_FN) {
             _keys_state_buffer.fn = true;
             continue;
         }
-
-        if (strcmp(getKeyValue(i).value_first, "shift") == 0) {
-            _keys_state_buffer.shift = true;
+        if (getKeyValue(i).value_first == KEY_OPT) {
+            _keys_state_buffer.opt = true;
             continue;
         }
 
-        if (strcmp(getKeyValue(i).value_first, "ctrl") == 0) {
+        if (getKeyValue(i).value_first == KEY_LEFT_CTRL) {
             _keys_state_buffer.ctrl = true;
+            _key_pos_modifier_keys.push_back(i);
             continue;
         }
-        if (strcmp(getKeyValue(i).value_first, "opt") == 0) {
-            _keys_state_buffer.opt = true;
+
+        if (getKeyValue(i).value_first == KEY_LEFT_SHIFT) {
+            _keys_state_buffer.shift = true;
+            _key_pos_modifier_keys.push_back(i);
             continue;
         }
 
-        if (strcmp(getKeyValue(i).value_first, "alt") == 0) {
+        if (getKeyValue(i).value_first == KEY_LEFT_ALT) {
             _keys_state_buffer.alt = true;
+            _key_pos_modifier_keys.push_back(i);
             continue;
         }
 
-        if (strcmp(getKeyValue(i).value_first, "del") == 0) {
+        // function
+        if (getKeyValue(i).value_first == KEY_TAB) {
+            _keys_state_buffer.tab = true;
+            _key_pos_hid_keys.push_back(i);
+            continue;
+        }
+
+        if (getKeyValue(i).value_first == KEY_BACKSPACE) {
             _keys_state_buffer.del = true;
+            _key_pos_hid_keys.push_back(i);
             continue;
         }
 
-        if (strcmp(getKeyValue(i).value_first, "enter") == 0) {
+        if (getKeyValue(i).value_first == KEY_ENTER) {
             _keys_state_buffer.enter = true;
+            _key_pos_hid_keys.push_back(i);
             continue;
         }
 
-        if (strcmp(getKeyValue(i).value_first, "space") == 0) {
+        if (getKeyValue(i).value_first == ' ') {
             _keys_state_buffer.space = true;
-            continue;
         }
+        _key_pos_hid_keys.push_back(i);
+        _key_pos_print_keys.push_back(i);
+    }
+
+    for (auto& i : _key_pos_modifier_keys) {
+        uint8_t key = getKeyValue(i).value_first;
+        _keys_state_buffer.modifier_keys.push_back(key);
+    }
+
+    for (auto& k : _keys_state_buffer.modifier_keys) {
+        _keys_state_buffer.modifiers |= (1 << (k - 0x80));
+    }
 
-        _key_values_without_special_keys.push_back(i);
+    for (auto& i : _key_pos_hid_keys) {
+        uint8_t k = getKeyValue(i).value_first;
+        if (k == KEY_TAB || k == KEY_BACKSPACE || k == KEY_ENTER) {
+            _keys_state_buffer.hid_keys.push_back(k);
+            continue;
+        }
+        uint8_t key = _kb_asciimap[k];
+        if (key) {
+            _keys_state_buffer.hid_keys.push_back(key);
+        }
     }
 
     // Deal what left
-    for (auto& i : _key_values_without_special_keys) {
+    for (auto& i : _key_pos_print_keys) {
         if (_keys_state_buffer.ctrl || _keys_state_buffer.shift ||
             _is_caps_locked) {
-            _keys_state_buffer.values.push_back(*getKeyValue(i).value_second);
-            _keys_state_buffer.keys.push_back(getKeyValue(i).value_num_second);
+            _keys_state_buffer.word.push_back(getKeyValue(i).value_second);
         } else {
-            _keys_state_buffer.values.push_back(*getKeyValue(i).value_first);
-            _keys_state_buffer.keys.push_back(getKeyValue(i).value_num_first);
+            _keys_state_buffer.word.push_back(getKeyValue(i).value_first);
         }
     }
 }
diff --git a/src/utility/Keyboard.h b/src/utility/Keyboard.h
diff --git a/src/utility/Keyboard_def.h b/src/utility/Keyboard_def.h

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`* @author SeanKwok (shaoxiang@m5stack.com)`
`4`	`4`	`* @brief M5Cardputer input text test`
`5`	`5`	`* @version 0.1`
`6`		`- * @date 2023-10-09`
	`6`	`+ * @date 2023-10-13`
`7`	`7`	`*`
`8`	`8`	`*`
`9`	`9`	`* @Hardwares: M5Cardputer`
`@@ -47,7 +47,7 @@ void loop() {`
`47`	`47`	`if (M5Cardputer.Keyboard.isPressed()) {`
`48`	`48`	`Keyboard_Class::KeysState status = M5Cardputer.Keyboard.keysState();`
`49`	`49`
`50`		`- for (auto i : status.values) {`
	`50`	`+ for (auto i : status.word) {`
`51`	`51`	`data += i;`
`52`	`52`	`}`
`53`	`53`