Merge pull request #124 from adafruit/update-hid-boot

add hid boot examples

Author: hathach

examples/Composite/mouse_ramdisk/mouse_ramdisk.ino

@@ -34,9 +34,11 @@ Adafruit_USBD_MSC usb_msc;
 #if defined ARDUINO_SAMD_CIRCUITPLAYGROUND_EXPRESS || defined ARDUINO_NRF52840_CIRCUITPLAY
   const int pin = 4; // Left Button
   bool activeState = true;
+
 #elif defined PIN_BUTTON1
   const int pin = PIN_BUTTON1;
   bool activeState = false;
+
 #else
   const int pin = 12;
   bool activeState = false;

examples/HID/hid_keyboard/hid_keyboard.ino renamed to examples/HID/hid_boot_keyboard/hid_boot_keyboard.ino

@@ -21,19 +21,20 @@
 // Single Report (no ID) descriptor
 uint8_t const desc_hid_report[] =
 {
-  TUD_HID_REPORT_DESC_KEYBOARD(),
+  TUD_HID_REPORT_DESC_KEYBOARD()
 };
 
 Adafruit_USBD_HID usb_hid;
 
 // Array of pins and its keycode
 // For keycode definition see BLEHidGeneric.h
 #ifdef ARDUINO_ARCH_RP2040
-uint8_t pins[]    = { D0, D1, D2, D3, D4, D5 };
+  uint8_t pins[]    = { D0, D1, D2, D3, D4, D5 };
 #else
-uint8_t pins[]    = { A0, A1, A2, A3, A4, A5 };
+  uint8_t pins[]    = { A0, A1, A2, A3, A4, A5 };
 #endif
-uint8_t hidcode[] = { HID_KEY_0, HID_KEY_1, HID_KEY_2, HID_KEY_3 , HID_KEY_4, HID_KEY_5 };
+
+uint8_t hidcode[] = { HID_KEY_ARROW_RIGHT, HID_KEY_ARROW_LEFT, HID_KEY_ARROW_DOWN, HID_KEY_ARROW_UP , HID_KEY_4, HID_KEY_5 };
 
 uint8_t pincount = sizeof(pins)/sizeof(pins[0]);
 
@@ -45,6 +46,7 @@ void setup()
   TinyUSB_Device_Init(0);
 #endif
 
+  usb_hid.setBootProtocol(HID_ITF_PROTOCOL_KEYBOARD);
   usb_hid.setPollInterval(2);
   usb_hid.setReportDescriptor(desc_hid_report, sizeof(desc_hid_report));
   usb_hid.setReportCallback(NULL, hid_report_callback);
@@ -72,18 +74,8 @@ void loop()
   // poll gpio once each 2 ms
   delay(2);
 
-//  // Remote wakeup
-//  if ( TinyUSBDevice.suspended() && btn )
-//  {
-//    // Wake up host if we are in suspend mode
-//    // and REMOTE_WAKEUP feature is enabled by host
-//    TinyUSBDevice.remoteWakeup();
-//  }
-
-  if ( !usb_hid.ready() ) return;
-
+  // used to avoid send multiple consecutive zero report for keyboard
   static bool keyPressedPreviously = false;
-  bool anyKeyPressed = false;
 
   uint8_t count=0;
   uint8_t keycode[6] = { 0 };
@@ -97,35 +89,38 @@ void loop()
       keycode[count++] = hidcode[i];
 
       // 6 is max keycode per report
-      if (count == 6)
-      {
-        usb_hid.keyboardReport(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;
+      if (count == 6) break;
     }
   }
 
-  // Send any remaining keys (not accumulated up to 6)
-  if ( count )
+  if ( TinyUSBDevice.suspended() && count )
   {
-    usb_hid.keyboardReport(0, 0, keycode);
+    // Wake up host if we are in suspend mode
+    // and REMOTE_WAKEUP feature is enabled by host
+    TinyUSBDevice.remoteWakeup();
   }
 
-  // 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 )
+  // skip if hid is not ready e.g still transferring previous report
+  if ( !usb_hid.ready() ) return;
+
+  if ( count )
+  {
+    // Send report if there is key pressed
+    uint8_t const report_id = 0;
+    uint8_t const modifier = 0;
+
+    keyPressedPreviously = true;
+    usb_hid.keyboardReport(report_id, modifier, keycode);
+  }else
   {
-    keyPressedPreviously = false;
-    usb_hid.keyboardRelease(0);
+    // 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 ( keyPressedPreviously )
+    {
+      keyPressedPreviously = false;
+      usb_hid.keyboardRelease(0);
+    }
   }
 }
 

examples/HID/hid_mouse/hid_mouse.ino renamed to examples/HID/hid_boot_mouse/hid_boot_mouse.ino

@@ -14,21 +14,23 @@
 /* This sketch demonstrates USB HID mouse
  * Press button pin will move
  * - mouse toward bottom right of monitor
- * 
+ *
  * Depending on the board, the button pin
  * and its active state (when pressed) are different
  */
-#if defined ARDUINO_SAMD_CIRCUITPLAYGROUND_EXPRESS
+#if defined ARDUINO_SAMD_CIRCUITPLAYGROUND_EXPRESS || defined ARDUINO_NRF52840_CIRCUITPLAY
   const int pin = 4; // Left Button
   bool activeState = true;
-#elif defined ARDUINO_NRF52840_FEATHER
-  const int pin = 7; // UserSw
+
+#elif defined PIN_BUTTON1
+  const int pin = PIN_BUTTON1;
   bool activeState = false;
+
 #else
   const int pin = 12;
   bool activeState = false;
 #endif
-  
+
 
 // HID report descriptor using TinyUSB's template
 // Single Report (no ID) descriptor
@@ -51,6 +53,7 @@ void setup()
   // Set up button, pullup opposite to active state
   pinMode(pin, activeState ? INPUT_PULLDOWN : INPUT_PULLUP);
 
+  usb_hid.setBootProtocol(HID_ITF_PROTOCOL_MOUSE);
   usb_hid.setPollInterval(2);
   usb_hid.setReportDescriptor(desc_hid_report, sizeof(desc_hid_report));
   //usb_hid.setStringDescriptor("TinyUSB Mouse");
@@ -86,7 +89,8 @@ void loop()
 
   if ( usb_hid.ready() )
   {
+    uint8_t const report_id = 0; // no ID
     int8_t const delta = 5;
-    usb_hid.mouseMove(0, delta, delta); // no ID: right + down
+    usb_hid.mouseMove(report_id, delta, delta); // right + down
   }
 }

examples/HID/hid_composite/hid_composite.ino

@@ -19,12 +19,14 @@
  * Depending on the board, the button pin
  * and its active state (when pressed) are different
  */
-#if defined ARDUINO_SAMD_CIRCUITPLAYGROUND_EXPRESS
+#if defined ARDUINO_SAMD_CIRCUITPLAYGROUND_EXPRESS || defined ARDUINO_NRF52840_CIRCUITPLAY
   const int pin = 4; // Left Button
   bool activeState = true;
-#elif defined ARDUINO_NRF52840_FEATHER
-  const int pin = 7; // UserSw
+
+#elif defined PIN_BUTTON1
+  const int pin = PIN_BUTTON1;
   bool activeState = false;
+
 #else
   const int pin = 12;
   bool activeState = false;