examples/usb: Add README that points out the alternative usb modules.

If someone starts from this directory then they won't know they exist,
otherwise.

Signed-off-by: Angus Gratton <angus@redyak.com.au>
This commit is contained in:
Angus Gratton 2024-05-14 10:24:11 +10:00 committed by Damien George
parent abd1f28bc2
commit 47ae739409

16
examples/usb/README.md Normal file
View File

@ -0,0 +1,16 @@
## USBDevice Examples
These are examples of how to use the low-level `machine.USBDevice` class to create custom
USB device functionality.
Alternatively, there are [usb driver modules in
micropython-lib](https://github.com/micropython/micropython-lib/tree/master/micropython/usb#readme)
which provide a simpler interface and more built-in functionality.
In this directory:
* `usb_dfu_device.py` implements the USB Device Firmware Update protocol.
* `usb_simple_device.py` implements a custom USB protocol, with a matching host
program to run on a PC.
See comments at the top of each Python file for more details.