wrap up hid_composite exmaple

Author: hathach

examples/hid_composite/hid_composite.ino

@@ -1,5 +1,36 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2019 Ha Thach for Adafruit Industries
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
 #include "Adafruit_TinyUSB.h"
 
+/* This sketch demonstrates multiple report USB HID.
+ * Press button pin will move
+ * - mouse toward bottom right of monitor
+ * - send 'a' key
+ */
+
+// Report ID
 enum
 {
   RID_KEYBOARD = 1,
@@ -15,13 +46,19 @@ uint8_t const desc_hid_report[] =
 
 Adafruit_USBD_HID usb_hid;
 
+const int pin = 7;
+
 // the setup function runs once when you press reset or power the board
 void setup()
 {
-  usb_hid.setPollInterval(10);
+  usb_hid.setPollInterval(2);
   usb_hid.setReportDescriptor(desc_hid_report, sizeof(desc_hid_report));
+
   usb_hid.begin();
 
+  // Set up button
+  pinMode(pin, INPUT_PULLUP);
+
   Serial.begin(115200);
   while ( !Serial ) delay(10);   // wait for native usb
 
@@ -30,5 +67,52 @@ void setup()
 
 void loop()
 {
-  // nothing to do
+  // poll gpio once each 10 ms
+  delay(10);
+
+  // button is active low
+  uint32_t const btn = 1 - digitalRead(pin);
+
+  // 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();
+  }
+
+  /*------------- Mouse -------------*/
+  if ( usb_hid.ready() )
+  {
+    if ( btn )
+    {
+      int8_t const delta = 5;
+      usb_hid.mouseMove(RID_MOUSE, delta, delta); // right + down
+
+      // delay a bit before attempt to send keyboard report
+      delay(2);
+    }
+  }
+
+  /*------------- Keyboard -------------*/
+  if ( usb_hid.ready() )
+  {
+    // use to avoid send multiple consecutive zero report for keyboard
+    static bool has_key = false;
+
+    if ( btn )
+    {
+      uint8_t keycode[6] = { 0 };
+      keycode[0] = HID_KEY_A;
+
+      usb_hid.keyboadReport(RID_KEYBOARD, 0, keycode);
+
+      has_key = true;
+    }else
+    {
+      // send empty key report if previously has key pressed
+      if (has_key) usb_hid.keyboardKeyRelease(RID_KEYBOARD);
+      has_key = false;
+    }
+  }
 }

examples/msc_ramdisk/msc_ramdisk.ino

@@ -1,3 +1,27 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2019 Ha Thach for Adafruit Industries
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
 #include "Adafruit_TinyUSB.h"
 #include "ramdisk.h"
 

examples/msc_ramdisk_dual/msc_ramdisk_dual.ino

@@ -1,3 +1,27 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2019 Ha Thach for Adafruit Industries
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
 #include "Adafruit_TinyUSB.h"
 #include "ramdisk.h"
 

src/Adafruit_USBD_HID.cpp

@@ -88,4 +88,46 @@ bool Adafruit_USBD_HID::sendReport(uint8_t report_id, void const* report, uint8_
   return tud_hid_report(report_id, report, len);
 }
 
+//--------------------------------------------------------------------+
+// Keyboard
+//--------------------------------------------------------------------+
+
+bool Adafruit_USBD_HID::keyboadReport(uint8_t report_id, uint8_t modifier, uint8_t keycode[6])
+{
+  return tud_hid_keyboard_report(report_id, modifier, keycode);
+}
+
+bool Adafruit_USBD_HID::keyboardKeyRelease(uint8_t report_id)
+{
+  return tud_hid_keyboard_key_release(report_id);
+}
+
+//--------------------------------------------------------------------+
+// Mouse
+//--------------------------------------------------------------------+
+
+bool Adafruit_USBD_HID::mouseReport(uint8_t report_id, uint8_t buttons, int8_t x, int8_t y, int8_t scroll, int8_t pan)
+{
+  return tud_hid_mouse_report(report_id, buttons, x, y, scroll, pan);
+}
+
+bool Adafruit_USBD_HID::mouseMove(uint8_t report_id, int8_t x, int8_t y)
+{
+  return tud_hid_mouse_move(report_id, x, y);
+}
+
+bool Adafruit_USBD_HID::mouseScroll(uint8_t report_id, int8_t scroll, int8_t pan)
+{
+  return tud_hid_mouse_scroll(report_id, scroll, pan);
+}
+
+bool Adafruit_USBD_HID::mouseButtonPress(uint8_t report_id, uint8_t buttons)
+{
+  return tud_hid_mouse_report(report_id, buttons, 0, 0, 0, 0);
+}
+
+bool Adafruit_USBD_HID::mouseButtonRelease(uint8_t report_id)
+{
+  return tud_hid_mouse_report(report_id, 0, 0, 0, 0, 0);
+}
 

src/Adafruit_USBD_HID.h

@@ -45,6 +45,18 @@ class Adafruit_USBD_HID : Adafruit_USBD_Interface
     bool ready(void);
     bool sendReport(uint8_t report_id, void const* report, uint8_t len);
 
+    //------------- Keyboard API -------------//
+    bool keyboadReport(uint8_t report_id, uint8_t modifier, uint8_t keycode[6]);
+    bool keyboardKeyPress(uint8_t report_id, char ch);
+    bool keyboardKeyRelease(uint8_t report_id);
+
+    //------------- Mouse API -------------//
+    bool mouseReport(uint8_t report_id, uint8_t buttons, int8_t x, int8_t y, int8_t scroll, int8_t pan);
+    bool mouseMove(uint8_t report_id, int8_t x, int8_t y);
+    bool mouseScroll(uint8_t report_id, int8_t scroll, int8_t pan);
+    bool mouseButtonPress(uint8_t report_id, uint8_t buttons);
+    static inline bool mouseButtonRelease(uint8_t report_id);
+
     // from Adafruit_USBD_Interface
     virtual uint16_t getDescriptor(uint8_t* buf, uint16_t bufsize);