Merge pull request #58 from adafruit/release-0.9.0

Added consumer control support to HID/hid_composite example

Author: hathach

.travis.yml.bck

@@ -1,5 +1,42 @@
 # Adafruit TinyUSB Arduino Library Changelog
 
+## 0.9.0 - 2020.04.23
+
+- Fixed mouseButtonRelease() error
+- Supported multiple cables for USB MIDI (requires BSP nRF52 0.20.0 and SAMD 1.5.12 )
+- Added consumer control support to HID/hid_composite example
+- Added Adafruit_USBD_HID send report helper: sendReport8(), sendReport16(), sendReport32()
+
+**Minor Breaking Changes**
+- Removed trailing comma in hid report descriptor, this is required to use with BSP nRF52 0.20.0 and SAMD 1.5.12 e.g
+
+from 
+
+```
+uint8_t const desc_hid_report[] =
+{
+  TUD_HID_REPORT_DESC_KEYBOARD( HID_REPORT_ID(RID_KEYBOARD), ),
+  TUD_HID_REPORT_DESC_MOUSE   ( HID_REPORT_ID(RID_MOUSE   ), ),
+};
+```
+to 
+
+```
+uint8_t const desc_hid_report[] =
+{
+  TUD_HID_REPORT_DESC_KEYBOARD( HID_REPORT_ID(RID_KEYBOARD) /*, no more trailing comma */ ),
+  TUD_HID_REPORT_DESC_MOUSE   ( HID_REPORT_ID(RID_MOUSE   )  /*, no more trailing comma */ ),
+};
+```
+
+## 0.8.2 - 2020.04.06
+
+- Removed package-lock.json in hid generic inout example due to security warning from github
+
+## 0.8.1 - 2020.01.08
+
+- More CI migrating work, no function changes
+
 ## 0.8.0 - 2019.12.30
 
 - Correct USB BCD version to 2.1 for webUSB

changelog.md

@@ -44,7 +44,7 @@ uint8_t const desc_hid_report[] =
 {
   TUD_HID_REPORT_DESC_KEYBOARD( HID_REPORT_ID(RID_KEYBOARD) ),
   TUD_HID_REPORT_DESC_MOUSE   ( HID_REPORT_ID(RID_MOUSE) ),
-  //TUD_HID_REPORT_DESC_CONSUMER( HID_REPORT_ID(RID_CONSUMER_CONTROL), )
+  TUD_HID_REPORT_DESC_CONSUMER( HID_REPORT_ID(RID_CONSUMER_CONTROL) )
 };
 
 // USB HID object
@@ -97,7 +97,7 @@ void loop()
   /*------------- Keyboard -------------*/
   if ( usb_hid.ready() )
   {
-    // use to prevent sending multiple consecutive zero report
+    // use to send key release report
     static bool has_key = false;
 
     if ( btn_pressed )
@@ -114,5 +114,31 @@ void loop()
       if (has_key) usb_hid.keyboardRelease(RID_KEYBOARD);
       has_key = false;
     }
+
+    // delay a bit before attempt to send consumer report
+    delay(10);
+  }
+
+  /*------------- Consumer Control -------------*/
+  if ( usb_hid.ready() )
+  {
+    // Consumer Control is used to control Media playback, Volume, Brightness etc ...
+    // Consumer report is 2-byte containing the control code of the key
+    // For list of control check out https://github.com/hathach/tinyusb/blob/master/src/class/hid/hid.h#L544
+
+    // use to send consumer release report
+    static bool has_consumer_key = false;
+
+    if ( btn_pressed )
+    {
+      // send volume down (0x00EA)
+      usb_hid.sendReport16(RID_CONSUMER_CONTROL, HID_USAGE_CONSUMER_VOLUME_DECREMENT);
+      has_consumer_key = true;
+    }else
+    {
+      // release the consume key by sending zero (0x0000)
+      if (has_consumer_key) usb_hid.sendReport16(RID_CONSUMER_CONTROL, 0);
+      has_consumer_key = false;
+    }
   }
 }

examples/HID/hid_composite/hid_composite.ino

@@ -1,5 +1,5 @@
 name=Adafruit TinyUSB Library
-version=0.8.2
+version=0.9.0
 author=Adafruit
 maintainer=Adafruit <info@adafruit.com>
 sentence=TinyUSB library for Arduino

library.properties

@@ -117,6 +117,18 @@ bool Adafruit_USBD_HID::sendReport(uint8_t report_id, void const *report,
   return tud_hid_report(report_id, report, len);
 }
 
+bool Adafruit_USBD_HID::sendReport8(uint8_t report_id, uint8_t num) {
+  return tud_hid_report(report_id, &num, sizeof(num));
+}
+
+bool Adafruit_USBD_HID::sendReport16(uint8_t report_id, uint16_t num) {
+  return tud_hid_report(report_id, &num, sizeof(num));
+}
+
+bool Adafruit_USBD_HID::sendReport32(uint8_t report_id, uint32_t num) {
+  return tud_hid_report(report_id, &num, sizeof(num));
+}
+
 //------------- TinyUSB callbacks -------------//
 extern "C" {
 

src/Adafruit_USBD_HID.cpp

@@ -51,6 +51,11 @@ class Adafruit_USBD_HID : Adafruit_USBD_Interface {
   bool ready(void);
   bool sendReport(uint8_t report_id, void const *report, uint8_t len);
 
+  // Report helpers
+  bool sendReport8(uint8_t report_id, uint8_t num);
+  bool sendReport16(uint8_t report_id, uint16_t num);
+  bool sendReport32(uint8_t report_id, uint32_t num);
+
   //------------- Keyboard API -------------//
   bool keyboardReport(uint8_t report_id, uint8_t modifier, uint8_t keycode[6]);
   bool keyboardPress(uint8_t report_id, char ch);