Skip to content

Commit 47ae739

Browse files
projectgusdpgeorge
authored andcommitted
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>
1 parent abd1f28 commit 47ae739

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

examples/usb/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## USBDevice Examples
2+
3+
These are examples of how to use the low-level `machine.USBDevice` class to create custom
4+
USB device functionality.
5+
6+
Alternatively, there are [usb driver modules in
7+
micropython-lib](https://github.com/micropython/micropython-lib/tree/master/micropython/usb#readme)
8+
which provide a simpler interface and more built-in functionality.
9+
10+
In this directory:
11+
12+
* `usb_dfu_device.py` implements the USB Device Firmware Update protocol.
13+
* `usb_simple_device.py` implements a custom USB protocol, with a matching host
14+
program to run on a PC.
15+
16+
See comments at the top of each Python file for more details.

0 commit comments

Comments
 (0)