Skip to content

usb host keyboard examples #3026

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Metro/Metro_RP2350_Chips_Challenge/game.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ def __init__(self, display, data_file, audio):
self._loading_group = displayio.Group()
self._tile_size = 24 # Default tile size (length and width)
self._digit_dims = (0, 0)
self._gamelogic = GameLogic(data_file, audio)
self._gamelogic = GameLogic(data_file, audio) # pylint: disable=too-many-function-args
self._databuffer = DataBuffer()
self._color_index = {}
self._init_display()
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
// SPDX-FileCopyrightText: 2024 Ha Thach for Adafruit Industries
//
// SPDX-License-Identifier: MIT

/*********************************************************************
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
*********************************************************************/

#ifndef USBH_HELPER_H
#define USBH_HELPER_H

#ifdef ARDUINO_ARCH_RP2040
// pio-usb is required for rp2040 host
#include "pio_usb.h"

// Pin D+ for host, D- = D+ + 1
#ifndef PIN_USB_HOST_DP
#define PIN_USB_HOST_DP 16
#endif

// Pin for enabling Host VBUS. comment out if not used
#ifndef PIN_5V_EN
#define PIN_5V_EN 18
#endif

#ifndef PIN_5V_EN_STATE
#define PIN_5V_EN_STATE 1
#endif
#endif // ARDUINO_ARCH_RP2040

#ifdef ARDUINO_ARCH_RP2350

// pio-usb is required for rp2040 host
#include "pio_usb.h"

// Pin D+ for host, D- = D+ + 1
#ifndef PIN_USB_HOST_DP
#define PIN_USB_HOST_DP 32
#endif

// Pin for enabling Host VBUS. comment out if not used
#ifndef PIN_5V_EN
#define PIN_5V_EN 29
#endif

#ifndef PIN_5V_EN_STATE
#define PIN_5V_EN_STATE 1
#endif
#endif // ARDUINO_ARCH_RP2350

#include "Adafruit_TinyUSB.h"

#if defined(CFG_TUH_MAX3421) && CFG_TUH_MAX3421
// USB Host using MAX3421E: SPI, CS, INT
#include "SPI.h"

#if defined(ARDUINO_METRO_ESP32S2)
Adafruit_USBH_Host USBHost(&SPI, 15, 14);
#elif defined(ARDUINO_ADAFRUIT_FEATHER_ESP32_V2)
Adafruit_USBH_Host USBHost(&SPI, 33, 15);
#else
// Default CS and INT are pin 10, 9
Adafruit_USBH_Host USBHost(&SPI, 10, 9);
#endif
#else
// Native USB Host such as rp2040
Adafruit_USBH_Host USBHost;
#endif

//--------------------------------------------------------------------+
// Helper Functions
//--------------------------------------------------------------------+

#ifdef ARDUINO_ARCH_RP2040
static void rp2040_configure_pio_usb(void) {
//while ( !Serial ) delay(10); // wait for native usb
Serial.println("Core1 setup to run TinyUSB host with pio-usb");

#ifdef PIN_5V_EN
pinMode(PIN_5V_EN, OUTPUT);
digitalWrite(PIN_5V_EN, PIN_5V_EN_STATE);
#endif

pio_usb_configuration_t pio_cfg = PIO_USB_DEFAULT_CONFIG;
pio_cfg.pin_dp = PIN_USB_HOST_DP;

#if defined(ARDUINO_RASPBERRY_PI_PICO_W)
// For pico-w, PIO is also used to communicate with cyw43
// Therefore we need to alternate the pio-usb configuration
// details https://github.com/sekigon-gonnoc/Pico-PIO-USB/issues/46
pio_cfg.sm_tx = 3;
pio_cfg.sm_rx = 2;
pio_cfg.sm_eop = 3;
pio_cfg.pio_rx_num = 0;
pio_cfg.pio_tx_num = 1;
pio_cfg.tx_ch = 9;
#endif

USBHost.configure_pio_usb(1, &pio_cfg);
}
#endif

#endif
Original file line number Diff line number Diff line change
@@ -0,0 +1,222 @@
// SPDX-FileCopyrightText: 2025 Tim Cocks for Adafruit Industries
//
// SPDX-License-Identifier: MIT

/*********************************************************************
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 demonstrates use of usb host with a standard HID boot keyboard.
* - Host depends on MCU:
* - rp2040: bit-banging 2 GPIOs with Pico-PIO-USB library (roothub port1)
*
* Requirements:
* - For rp2040:
* - 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
*/

// USBHost is defined in usbh_helper.h
#include "usbh_helper.h"
#include "tusb.h"
#include "Adafruit_TinyUSB.h"


bool printed_blank = false;

void setup() {
Serial.begin(115200);

// 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);
delay(3000);
Serial.print("USB D+ Pin:");
Serial.println(PIN_USB_HOST_DP);
Serial.print("USB 5V Pin:");
Serial.println(PIN_5V_EN);
}

void loop() {
USBHost.task();
Serial.flush();

}

//--------------------------------------------------------------------+
// HID Host Callback Functions
//--------------------------------------------------------------------+

void tuh_hid_mount_cb(uint8_t dev_addr, uint8_t instance, uint8_t const* desc_report, uint16_t desc_len)
{
Serial.printf("HID device mounted (address %d, instance %d)\n", dev_addr, instance);

// Start receiving HID reports
if (!tuh_hid_receive_report(dev_addr, instance))
{
Serial.printf("Error: cannot request to receive report\n");
}
}

void tuh_hid_umount_cb(uint8_t dev_addr, uint8_t instance)
{
Serial.printf("HID device unmounted (address %d, instance %d)\n", dev_addr, instance);
}

void tuh_hid_report_received_cb(uint8_t dev_addr, uint8_t instance, uint8_t const* report, uint16_t len) {

if (len > 0){

//debug print report data
// Serial.print("Report data: ");
// for (int i = 0; i < len; i++) {
// Serial.print(report[i], HEX);
// Serial.print(" ");

// }
// Serial.println();

printKeyboardReport(report);
}

// Continue to receive the next report
if (!tuh_hid_receive_report(dev_addr, instance)) {
Serial.println("Error: cannot request to receive report");
}
}

// Helper function to print key names
void printKeyName(uint8_t key) {
// This is a simplified list. Full HID keyboard has many more key codes
switch (key) {
case 0x04: Serial.print("A"); break;
case 0x05: Serial.print("B"); break;
case 0x06: Serial.print("C"); break;
case 0x07: Serial.print("D"); break;
case 0x08: Serial.print("E"); break;
case 0x09: Serial.print("F"); break;
case 0x0A: Serial.print("G"); break;
case 0x0B: Serial.print("H"); break;
case 0x0C: Serial.print("I"); break;
case 0x0D: Serial.print("J"); break;
case 0x0E: Serial.print("K"); break;
case 0x0F: Serial.print("L"); break;
case 0x10: Serial.print("M"); break;
case 0x11: Serial.print("N"); break;
case 0x12: Serial.print("O"); break;
case 0x13: Serial.print("P"); break;
case 0x14: Serial.print("Q"); break;
case 0x15: Serial.print("R"); break;
case 0x16: Serial.print("S"); break;
case 0x17: Serial.print("T"); break;
case 0x18: Serial.print("U"); break;
case 0x19: Serial.print("V"); break;
case 0x1A: Serial.print("W"); break;
case 0x1B: Serial.print("X"); break;
case 0x1C: Serial.print("Y"); break;
case 0x1D: Serial.print("Z"); break;
case 0x1E: Serial.print("1"); break;
case 0x1F: Serial.print("2"); break;
case 0x20: Serial.print("3"); break;
case 0x21: Serial.print("4"); break;
case 0x22: Serial.print("5"); break;
case 0x23: Serial.print("6"); break;
case 0x24: Serial.print("7"); break;
case 0x25: Serial.print("8"); break;
case 0x26: Serial.print("9"); break;
case 0x27: Serial.print("0"); break;
case 0x28: Serial.print("ENTER"); break;
case 0x29: Serial.print("ESC"); break;
case 0x2A: Serial.print("BACKSPACE"); break;
case 0x2B: Serial.print("TAB"); break;
case 0x2C: Serial.print("SPACE"); break;
case 0x2D: Serial.print("MINUS"); break;
case 0x2E: Serial.print("EQUAL"); break;
case 0x2F: Serial.print("LBRACKET"); break;
case 0x30: Serial.print("RBRACKET"); break;
case 0x31: Serial.print("BACKSLASH"); break;
case 0x33: Serial.print("SEMICOLON"); break;
case 0x34: Serial.print("QUOTE"); break;
case 0x35: Serial.print("GRAVE"); break;
case 0x36: Serial.print("COMMA"); break;
case 0x37: Serial.print("PERIOD"); break;
case 0x38: Serial.print("SLASH"); break;
case 0x39: Serial.print("CAPS_LOCK"); break;
case 0x4F: Serial.print("RIGHT_ARROW"); break;
case 0x50: Serial.print("LEFT_ARROW"); break;
case 0x51: Serial.print("DOWN_ARROW"); break;
case 0x52: Serial.print("UP_ARROW"); break;
default:
if (key >= 0x3A && key <= 0x45) { // F1-F12
Serial.print("F");
Serial.print(key - 0x3A + 1);
} else {
// For keys not handled above, just print the HID code
Serial.print("0x");
Serial.print(key, HEX);
}
break;
}
}

void printKeyboardReport(uint8_t const* report) {
// First byte contains modifier keys
uint8_t modifiers = report[0];

// Print modifier keys if pressed
if (modifiers > 0) {
Serial.print("Modifiers: ");

if (modifiers & 0x01) Serial.print("LEFT_CTRL ");
if (modifiers & 0x02) Serial.print("LEFT_SHIFT ");
if (modifiers & 0x04) Serial.print("LEFT_ALT ");
if (modifiers & 0x08) Serial.print("LEFT_GUI ");
if (modifiers & 0x10) Serial.print("RIGHT_CTRL ");
if (modifiers & 0x20) Serial.print("RIGHT_SHIFT ");
if (modifiers & 0x40) Serial.print("RIGHT_ALT ");
if (modifiers & 0x80) Serial.print("RIGHT_GUI ");

Serial.println();
}

// Second byte is reserved (usually 0)

// Bytes 2-7 contain up to 6 key codes
bool keysPressed = false;

for (int i = 2; i < 8; i++) {
uint8_t key = report[i];

// Skip if no key or error rollover
if (key == 0 || key == 1) {
continue;
}

if (!keysPressed) {
Serial.print("Keys: ");
keysPressed = true;
}

// Print key name based on HID Usage Tables for standard keyboard
printKeyName(key);
Serial.print(" ");
}

if (keysPressed) {
Serial.println();
} else if (modifiers == 0) {
Serial.println("No keys pressed");
}
}
Loading
Loading