Alligned mouse examples, added newer hid in/out example from main repo, added new composite example for ramdisk and hid in/out. Moved ramdisk.h to src.

Author: Timon Skerutsch

examples/Composite/hid_generic_inout_ramdisk/README.md

@@ -0,0 +1 @@
+Check the example host application in `examples/HID/hid_generic_inout`

examples/Composite/hid_generic_inout_ramdisk/hid_generic_inout_ramdisk.ino

@@ -0,0 +1,131 @@
+/*********************************************************************
+ Adafruit invests time and resources providing this open source code,
+ please support Adafruit and open-source hardware by purchasing
+ products from Adafruit!
+
+ MIT license, check LICENSE for more information
+ Copyright (c) 2019 Ha Thach for Adafruit Industries
+ All text above, and the splash screen below must be included in
+ any redistribution
+*********************************************************************/
+
+/* This example demonstrate HID Generic raw Input & Output.
+ * It will receive data from Host (In endpoint) and echo back (Out endpoint).
+ * HID Report descriptor use vendor for usage page (using template TUD_HID_REPORT_DESC_GENERIC_INOUT)
+ *
+ * There are 2 ways to test the sketch
+ * 1. Using nodejs
+ *    - Install nodejs and nmp to your PC
+ *    - Install execellent node-hid (https://github.com/node-hid/node-hid) by
+ *      $ npm install node-hid
+ *    - Run provided hid test script 
+ *      $ node hid_test.js
+ *    
+ * 2. Using python hidRun 
+ *    - Python and `hid` package is required, for installation please follow https://pypi.org/project/hid/
+ *    - Run provided hid test script to send and receive data to this device.
+ *      $ python3 hid_test.py
+ */
+
+#include "Adafruit_TinyUSB.h"
+
+// 8KB is the smallest size that windows allow to mount
+#define DISK_BLOCK_NUM  16
+#define DISK_BLOCK_SIZE 512
+#include "ramdisk.h"
+
+// HID report descriptor using TinyUSB's template
+// Generic In Out with 64 bytes report (max)
+uint8_t const desc_hid_report[] =
+{
+  TUD_HID_REPORT_DESC_GENERIC_INOUT(64)
+};
+
+Adafruit_USBD_HID usb_hid;
+Adafruit_USBD_MSC usb_msc;
+
+// the setup function runs once when you press reset or power the board
+void setup()
+{
+  usb_msc.setID("Adafruit", "Mass Storage", "1.0");
+  
+  // Set disk size
+  usb_msc.setCapacity(DISK_BLOCK_NUM, DISK_BLOCK_SIZE);
+
+  // Set callback
+  usb_msc.setReadWriteCallback(msc_read_cb, msc_write_cb, msc_flush_cb);
+
+  // Set Lun ready (RAM disk is always ready)
+  usb_msc.setUnitReady(true);
+  
+  usb_msc.begin();
+  
+  usb_hid.enableOutEndpoint(true);
+  usb_hid.setPollInterval(2);
+  usb_hid.setReportDescriptor(desc_hid_report, sizeof(desc_hid_report));
+  usb_hid.setReportCallback(get_report_callback, set_report_callback);
+
+  usb_hid.begin();
+
+  Serial.begin(115200);
+  Serial.println("Waiting for USBDevice mount");
+  // wait until device mounted
+  while( !USBDevice.mounted() ) delay(1);
+
+  Serial.println("Adafruit TinyUSB HID Generic In Out example");
+}
+
+void loop()
+{
+  // nothing to do
+}
+
+// Invoked when received GET_REPORT control request
+// Application must fill buffer report's content and return its length.
+// Return zero will cause the stack to STALL request
+uint16_t get_report_callback (uint8_t report_id, hid_report_type_t report_type, uint8_t* buffer, uint16_t reqlen)
+{
+  // not used in this example
+  return 0;
+}
+
+// Invoked when received SET_REPORT control request or
+// received data on OUT endpoint ( Report ID = 0, Type = 0 )
+void set_report_callback(uint8_t report_id, hid_report_type_t report_type, uint8_t const* buffer, uint16_t bufsize)
+{
+  // This example doesn't use multiple report and report ID
+  (void) report_id;
+  (void) report_type;
+
+  // echo back anything we received from host
+  usb_hid.sendReport(0, buffer, bufsize);
+}
+
+// Callback invoked when received READ10 command.
+// Copy disk's data to buffer (up to bufsize) and 
+// return number of copied bytes (must be multiple of block size) 
+int32_t msc_read_cb (uint32_t lba, void* buffer, uint32_t bufsize)
+{
+  uint8_t const* addr = msc_disk[lba];
+  memcpy(buffer, addr, bufsize);
+
+  return bufsize;
+}
+
+// Callback invoked when received WRITE10 command.
+// Process data in buffer to disk's storage and 
+// return number of written bytes (must be multiple of block size)
+int32_t msc_write_cb (uint32_t lba, uint8_t* buffer, uint32_t bufsize)
+{
+  uint8_t* addr = msc_disk[lba];
+  memcpy(addr, buffer, bufsize);
+
+  return bufsize;
+}
+
+// Callback invoked when WRITE10 command is completed (status received and accepted by host).
+// used to flush any pending cache.
+void msc_flush_cb (void)
+{
+  // nothing to do
+}

examples/Composite/mouse_external_flash/mouse_external_flash.ino

@@ -42,7 +42,16 @@ uint8_t const desc_hid_report[] =
 
 Adafruit_USBD_HID usb_hid;
 
-const int pin = 7;
+#if defined ARDUINO_SAMD_CIRCUITPLAYGROUND_EXPRESS
+  const int pin = 4; // Left Button
+  bool activeState = true;
+#elif defined ARDUINO_NRF52840_FEATHER
+  const int pin = 7; // UserSw
+  bool activeState = false;
+#else
+  const int pin = 12;
+  bool activeState = false;
+#endif
 
 // the setup function runs once when you press reset or power the board
 void setup()
@@ -67,7 +76,7 @@ void setup()
 
 
   // Set up button
-  pinMode(pin, INPUT_PULLUP);
+  pinMode(pin, activeState ? INPUT_PULLDOWN : INPUT_PULLUP);
 
   usb_hid.setReportDescriptor(desc_hid_report, sizeof(desc_hid_report));
   usb_hid.begin();
@@ -84,7 +93,7 @@ void loop()
   delay(10);
 
   // button is active low
-  uint32_t const btn = 1 - digitalRead(pin);
+  uint32_t const btn = (digitalRead(pin) == activeState);
 
   // Remote wakeup
   if ( USBDevice.suspended() && btn )
@@ -133,4 +142,4 @@ int32_t msc_write_cb (uint32_t lba, uint8_t* buffer, uint32_t bufsize)
 void msc_flush_cb (void)
 {
   flash.syncBlocks();
-}
+}

examples/Composite/mouse_ramdisk/mouse_ramdisk.ino

@@ -31,7 +31,16 @@ uint8_t const desc_hid_report[] =
 Adafruit_USBD_HID usb_hid;
 Adafruit_USBD_MSC usb_msc;
 
-const int pin = 7;
+#if defined ARDUINO_SAMD_CIRCUITPLAYGROUND_EXPRESS
+  const int pin = 4; // Left Button
+  bool activeState = true;
+#elif defined ARDUINO_NRF52840_FEATHER
+  const int pin = 7; // UserSw
+  bool activeState = false;
+#else
+  const int pin = 12;
+  bool activeState = false;
+#endif
 
 // the setup function runs once when you press reset or power the board
 void setup()
@@ -51,13 +60,13 @@ void setup()
   usb_msc.begin();
 
   // Set up button
-  pinMode(pin, INPUT_PULLUP);
+  pinMode(pin, activeState ? INPUT_PULLDOWN : INPUT_PULLUP);
 
   usb_hid.setReportDescriptor(desc_hid_report, sizeof(desc_hid_report));
   usb_hid.begin();
 
   Serial.begin(115200);
-  while ( !Serial ) delay(10);   // wait for native usb
+  while( !USBDevice.mounted() ) delay(1);   // wait for native usb
 
   Serial.println("Adafruit TinyUSB Mouse + Mass Storage (ramdisk) example");
 }
@@ -68,7 +77,7 @@ void loop()
   delay(10);
 
   // button is active low
-  uint32_t const btn = 1 - digitalRead(pin);
+  uint32_t const btn = (digitalRead(pin) == activeState);
 
   // Remote wakeup
   if ( USBDevice.suspended() && btn )
@@ -119,4 +128,4 @@ int32_t msc_write_cb (uint32_t lba, uint8_t* buffer, uint32_t bufsize)
 void msc_flush_cb (void)
 {
   // nothing to do
-}
+}

examples/HID/hid_generic_inout/README.md

@@ -0,0 +1,10 @@
+Instructions for node.js based example
+
+===Setup===
+
+1. Upload example code to your board
+2. Install node.js if you haven't already
+3. Run `npm install` to install the dependencies
+4. If this should fail on windows try installing the build tools via `npm i -g windows-build-tools`
+5. While the board is connected run `node hid_test.js`
+6. If this should fail make sure the VID and PID of your board is listed in boards.js

examples/HID/hid_generic_inout/boards.js

@@ -0,0 +1,5 @@
+module.exports = {
+	"Feather_nRF52840":[0X239A,0X8029],
+	"Metro_nRF52840":[0X239A,0X803F],
+	"Circuit_Playground_Express":[0X239A,0X8018],
+}

examples/HID/hid_generic_inout/hid_test.js

@@ -1,16 +1,16 @@
-// IMPORTANT: install dependency via 'npm i node-hid' in the same location as the script
+// IMPORTANT: install the dependency via 'npm i node-hid' in the same location as the script
 // If the install fails on windows you may need to run 'npm i -g windows-build-tools' first to be able to compile native code needed for this library
 
 var HID = require('node-hid');
 var os = require('os')
+// list of supported devices
+var boards = require('./boards.js')
 
 var isWin = (os.platform() === 'win32');
 var devices = HID.devices();
 
-// choose either of the following supported devices:
-// Metro_nRF52840, Feather_nRF52840
-
-var deviceInfo = devices.find(Feather_nRF52840);
+// this will choose any device found in the boards.js file
+var deviceInfo = devices.find(anySupportedBoard);
 var reportLen = 64;
 
 var message = "Hello World!"
@@ -51,17 +51,21 @@ if( deviceInfo ) {
 }
 
 
-
-
-function Feather_nRF52840(d) {
-    return isDevice(0X239A,0X8029,d)
+function anySupportedBoard(d) {
+	
+	for (var key in boards) {
+	    if (boards.hasOwnProperty(key)) {
+	        if (isDevice(boards[key],d)) {
+	        	console.log("Found " + d.product);
+	        	return true;
+	        }
+	    }
+	}
+	return false;
 }
 
-function Metro_nRF52840(d) {
-    return isDevice(0X239A,0X803F,d)
-}
 
+function isDevice(board,d){
+	return d.vendorId==board[0] && d.productId==board[1];
+}
 
-function isDevice(vid,pid,d){
-	return d.vendorId==vid && d.productId==pid;
-}