Skip to content

Instantly share code, notes, and snippets.

@tyeth
Created March 13, 2025 23:23
Show Gist options
  • Save tyeth/8f1ad51c3616e7e22a91d4596a897cfe to your computer and use it in GitHub Desktop.
Save tyeth/8f1ad51c3616e7e22a91d4596a897cfe to your computer and use it in GitHub Desktop.
TinyUSB Example for Device reports, with added prints and import for mouse wheel +(x/y)
/*********************************************************************
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
Copyright (c) 2025 Tyeth Gundry for Adafruit Industries
All text above, and the splash screen below must be included in
any redistribution
*********************************************************************/
// Adapted from https://github.com/adafruit/Adafruit_TinyUSB_Arduino/blob/3.4.3/examples/DualRole/HID/hid_device_report/hid_device_report.ino
/* This example demonstrates use of both device and host, where
* - Device run on native usb controller (roothub port0)
* - Host depending on MCUs run on either:
* - rp2040: bit-banging 2 GPIOs with the help of Pico-PIO-USB library (roothub port1)
* - samd21/51, nrf52840, esp32: using MAX3421e controller (host shield)
*
* Requirements:
* - For rp2040:
* - [Pico-PIO-USB](https://github.com/sekigon-gonnoc/Pico-PIO-USB) library
* - 2 consecutive GPIOs: D+ is defined by PIN_USB_HOST_DP, D- = D+ +1
* - Provide VBus (5v) and GND for peripheral
* - CPU Speed must be either 120 or 240 Mhz. Selected via "Menu -> CPU Speed"
* - For samd21/51, nrf52840, esp32:
* - Additional MAX2341e USB Host shield or featherwing is required
* - SPI instance, CS pin, INT pin are correctly configured in usbh_helper.h
*/
// USBHost is defined in usbh_helper.h
#include "usbh_helper.h"
#include "class/hid/hid.h"
#if defined(CFG_TUH_MAX3421) && CFG_TUH_MAX3421
//--------------------------------------------------------------------+
// Using Host shield MAX3421E controller
//--------------------------------------------------------------------+
void setup() {
Serial.begin(115200);
// init host stack on controller (rhport) 1
USBHost.begin(1);
// while ( !Serial ) delay(10); // wait for native usb
Serial.println("TinyUSB Dual: HID Device Report Example");
}
void loop() {
USBHost.task();
Serial.flush();
}
#elif defined(ARDUINO_ARCH_RP2040)
//--------------------------------------------------------------------+
// For RP2040 use both core0 for device stack, core1 for host stack
//--------------------------------------------------------------------+
//------------- Core0 -------------//
void setup() {
Serial.begin(115200);
//while ( !Serial ) delay(10); // wait for native usb
Serial.println("TinyUSB Dual: HID Device Report Example");
}
void loop() {
Serial.flush();
}
//------------- Core1 -------------//
void setup1() {
// configure pio-usb: defined in usbh_helper.h
rp2040_configure_pio_usb();
// run host stack on controller (rhport) 1
// Note: For rp2040 pico-pio-usb, calling USBHost.begin() on core1 will have most of the
// host bit-banging processing works done in core1 to free up core0 for other works
USBHost.begin(1);
}
void loop1() {
USBHost.task();
}
#endif
extern "C" {
// Invoked when device with hid interface is mounted
// Report descriptor is also available for use.
// tuh_hid_parse_report_descriptor() can be used to parse common/simple enough
// descriptor. Note: if report descriptor length > CFG_TUH_ENUMERATION_BUFSIZE,
// it will be skipped therefore report_desc = NULL, desc_len = 0
void tuh_hid_mount_cb(uint8_t dev_addr, uint8_t instance, uint8_t const *desc_report, uint16_t desc_len) {
(void) desc_report;
(void) desc_len;
uint16_t vid, pid;
tuh_vid_pid_get(dev_addr, &vid, &pid);
Serial.printf("HID device address = %d, instance = %d is mounted\r\n", dev_addr, instance);
Serial.printf("VID = %04x, PID = %04x\r\n", vid, pid);
if (!tuh_hid_receive_report(dev_addr, instance)) {
Serial.printf("Error: cannot request to receive report\r\n");
}
}
// Invoked when device with hid interface is un-mounted
void tuh_hid_umount_cb(uint8_t dev_addr, uint8_t instance) {
Serial.printf("HID device address = %d, instance = %d is unmounted\r\n", dev_addr, instance);
}
// Invoked when received report from device via interrupt endpoint
void tuh_hid_report_received_cb(uint8_t dev_addr, uint8_t instance, uint8_t const *report, uint16_t len) {
Serial.printf("HIDreport : ");
for (uint16_t i = 0; i < len; i++) {
Serial.printf("0x%02X ", report[i]);
}
Serial.println();
hid_mouse_report_t new_report = *((hid_mouse_report_t const *) report);
Serial.print("Mouse X:"); Serial.println(new_report.x);
Serial.print("Mouse Y:"); Serial.println(new_report.y);
Serial.print("Mouse W:"); Serial.println(new_report.wheel);
Serial.println();
// continue to request to receive report
if (!tuh_hid_receive_report(dev_addr, instance)) {
Serial.printf("Error: cannot request to receive report\r\n");
}
}
} // extern C
@tyeth
Copy link
Author

tyeth commented Mar 13, 2025

Expected output (with logitech M150 mouse scrolled up / down):

23:20:15.182 -> HID device address = 1, instance = 0 is mounted
23:20:15.182 -> VID = 046d, PID = c534
23:20:15.188 -> HID device address = 1, instance = 1 is mounted
23:20:15.188 -> VID = 046d, PID = c534
23:20:19.297 -> HIDreport : 0x01 0x00 0x00 0x00 
23:20:19.297 -> Mouse X:0
23:20:19.297 -> Mouse Y:0
23:20:19.297 -> Mouse W:0
23:20:19.297 -> 
....TRUNCATED LOG...
23:20:22.586 -> HIDreport : 0x00 0x00 0x00 0xFF 
23:20:22.586 -> Mouse X:0
23:20:22.586 -> Mouse Y:0
23:20:22.586 -> Mouse W:-1
23:20:22.586 -> 
23:20:23.810 -> HIDreport : 0x00 0x00 0x00 0x01 
23:20:23.810 -> Mouse X:0
23:20:23.810 -> Mouse Y:0
23:20:23.810 -> Mouse W:1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment