#hid #usb-device #usb #keyboard #mouse

no-std usbd-human-interface-device

Batteries included embedded USB HID library for usb-device. Includes concrete Keyboard (boot and NKRO), Mouse, Joystick and Consumer Control implementations as well as support for building your own HID classes.

14 releases

0.4.5 Dec 29, 2023
0.4.4 Nov 17, 2023
0.4.3 Jul 14, 2023
0.3.4 Mar 11, 2023
0.2.1 Jun 12, 2022

#110 in Embedded development

Download history 67/week @ 2023-11-04 90/week @ 2023-11-11 77/week @ 2023-11-18 102/week @ 2023-11-25 143/week @ 2023-12-02 43/week @ 2023-12-09 62/week @ 2023-12-16 93/week @ 2023-12-23 45/week @ 2023-12-30 62/week @ 2024-01-06 37/week @ 2024-01-13 40/week @ 2024-01-20 69/week @ 2024-01-27 54/week @ 2024-02-03 70/week @ 2024-02-10 248/week @ 2024-02-17

445 downloads per month

MIT license

170KB
4.5K SLoC

Library build Example build Security audit

crates.io docs.rs

Batteries included embedded USB HID library for usb-device. Includes Keyboard (boot and NKRO), Mouse, Joystick and Consumer Control implementations as well as support for building your own HID classes.

Tested on the RP2040, but should work on any platform supported by usb-device.

Devices created with this library should work with any USB host. Tested on Windows, Linux, MacOS and Android.

Note: Managed interfaces that support HID idle, such as NKROBootKeyboardInterface and BootKeyboardInterface, require the UsbHidClass::tick() method calling every 1ms.

Features

  • Keyboard - boot compliant keyboard, boot compliant NKRO(N-Key Roll Over) keyboard
  • Mouse - boot compliant mouse, boot compliant mouse with scroll wheel and pan
  • Joystick - two axis joystick with eight buttons
  • Consumer Control - Media control device, generic consumer control device
  • Enums for the Consumer, Desktop, Game, Keyboard, LED, Simulation and Telephony HID usage pages
  • Support for multi-interface devices
  • Support for HID idle and HID protocol changing
  • Support for both single and multi report interfaces
  • Compatible with RTIC

Examples

See examples for demonstrations of how to use this library on the RP2040 (Raspberry Pi Pico)

Road map

  • Examples and testing for other micro-controllers such as the SAM D2x family.
  • Support for host device remote wakeup

Contact

https://github.com/dlkj/usbd-human-interface-device/issues

License

Distributed under the MIT License, see LICENSE.

Contributing

Contributions are welcome via pull requests

Acknowledgements

This library was inspired by existing rust USB libraries and the following sources of USB information:

Dependencies

~3.5MB
~78K SLoC