From 47ae73940983caa2d109e7c4e5192db8294748f2 Mon Sep 17 00:00:00 2001 From: Angus Gratton Date: Tue, 14 May 2024 10:24:11 +1000 Subject: [PATCH] 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 --- examples/usb/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 examples/usb/README.md diff --git a/examples/usb/README.md b/examples/usb/README.md new file mode 100644 index 000000000..b3dad1763 --- /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.