add hid keyboard report

Author: hathach

examples/HID/hid_keyboard/hid_keyboard.ino

@@ -0,0 +1,128 @@
+// The MIT License (MIT)
+// Copyright (c) 2019 Ha Thach for Adafruit Industries
+
+#include "Adafruit_TinyUSB.h"
+
+/* This sketch demonstrates USB HID keyboard.
+ * - PIN A0-A5 is used to send digit '0' to '5' respectively
+ * - LED will be turned on when one of Caplock/NumLock/ScrollLock/Compose/Kana is set by Host
+ */
+
+
+// HID report descriptor using TinyUSB's template
+// Single Report (no ID) decriptor
+uint8_t const desc_hid_report[] =
+{
+  TUD_HID_REPORT_DESC_KEYBOARD(),
+};
+
+Adafruit_USBD_HID usb_hid;
+
+// Array of pins and its keycode
+// For keycode definition see BLEHidGeneric.h
+uint8_t pins[]    = { A0, A1, A2, A3, A4, A5 };
+uint8_t hidcode[] = { HID_KEY_0, HID_KEY_1, HID_KEY_2, HID_KEY_3 , HID_KEY_4, HID_KEY_5 };
+
+uint8_t pincount = sizeof(pins)/sizeof(pins[0]);
+
+// the setup function runs once when you press reset or power the board
+void setup()
+{
+  usb_hid.setPollInterval(2);
+  usb_hid.setReportDescriptor(desc_hid_report, sizeof(desc_hid_report));
+  usb_hid.setReportCallback(NULL, set_report_callback_t set_report);
+
+  usb_hid.begin();
+
+  // led pin
+  pinMode(PIN_LED, OUTPUT);
+  digitalWrite(PIN_LED, 0);
+
+  // Set up pin as input
+  for (uint8_t i=0; i<pincount; i++)
+  {
+    pinMode(pins[i], INPUT_PULLUP);
+  }
+
+  Serial.begin(115200);
+  while ( !Serial ) delay(10);   // wait for native usb
+
+  Serial.println("Adafruit TinyUSB HID Keyboard example");
+}
+
+
+void loop()
+{
+  // poll gpio once each 2 ms
+  delay(2);
+
+//  // Remote wakeup
+//  if ( tud_suspended() && btn )
+//  {
+//    // Wake up host if we are in suspend mode
+//    // and REMOTE_WAKEUP feature is enabled by host
+//    tud_remote_wakeup();
+//  }
+
+  if ( !usb_hid.ready() ) return;
+
+  static bool keyPressedPreviously = false;
+  bool anyKeyPressed = false;
+
+  uint8_t count=0;
+  uint8_t keycode[6] = { 0 };
+
+  // scan normal key and send report
+  for(uint8_t i=0; i < pincount; i++)
+  {
+    if ( 0 == digitalRead(pins[i]) )
+    {
+      // if pin is active (low), add its hid code to key report
+      keycode[count++] = hidcode[i];
+
+      // 6 is max keycode per report
+      if (count == 6)
+      {
+        usb_hid.keyboadReport(0, 0, keycode);
+        delay(2); // delay for report to send out
+
+        // reset report
+        count = 0;
+        memset(keycode, 0, 6);
+      }
+
+      // used later
+      anyKeyPressed = true;
+      keyPressedPreviously = true;
+    }
+  }
+
+  // Send any remaining keys (not accumulated up to 6)
+  if ( count )
+  {
+    usb_hid.keyboadReport(0, 0, keycode);
+  }
+
+  // Send All-zero report to indicate there is no keys pressed
+  // Most of the time, it is, though we don't need to send zero report
+  // every loop(), only a key is pressed in previous loop()
+  if ( !anyKeyPressed && keyPressedPreviously )
+  {
+    keyPressedPreviously = false;
+    usb_hid.keyboardRelease(0);
+  }
+}
+
+// Output report callback for LED indicator such as Caplocks
+void hid_report_callback(uint8_t report_id, hid_report_type_t report_type, uint8_t const* buffer, uint16_t bufsize)
+{
+  // LED indicator is output report with only 1 byte length
+  if ( report_type != HID_REPORT_TYPE_OUTPUT ) return;
+
+  // The LED bit map is as follows: (also defined by KEYBOARD_LED_* )
+  // Kana (4) | Compose (3) | ScrollLock (2) | CapsLock (1) | Numlock (0)
+  uint8_t ledIndicator = buffer[0];
+
+  // turn on LED if any indicator is set
+  digitalWrite(PIN_LED, ledIndicator);
+}