diff options
| author | Angus Gratton <angus@redyak.com.au> | 2024-05-14 10:24:11 +1000 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2024-05-15 15:20:40 +1000 |
| commit | 47ae73940983caa2d109e7c4e5192db8294748f2 (patch) | |
| tree | 94e7a1d63d8945b90aaf25e127a69ced82c49372 /examples | |
| parent | abd1f28bc20a220658cfec8f03169edfd0097421 (diff) | |
| download | micropython-47ae73940983caa2d109e7c4e5192db8294748f2.tar.gz micropython-47ae73940983caa2d109e7c4e5192db8294748f2.zip | |
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>
Diffstat (limited to 'examples')
| -rw-r--r-- | examples/usb/README.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/examples/usb/README.md b/examples/usb/README.md new file mode 100644 index 0000000000..b3dad17633 --- /dev/null +++ b/examples/usb/README.md @@ -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. |