summaryrefslogtreecommitdiff
path: root/docs/library
diff options
context:
space:
mode:
authorAngus Gratton <angus@redyak.com.au>2024-12-18 17:23:45 +1100
committerAngus Gratton <gus@projectgus.com>2024-12-20 14:02:17 +1100
commit4e76acc88d8673ce4f43698fbb4c2913e63b0135 (patch)
tree1ac653ea4324d7fe3d4ef0bf8c33bc5e273866cb /docs/library
parent39538e4c9a54e44ea27bcc374e17774ac2b9796d (diff)
doc: Note that machine.USBDevice is now available on esp32 port.
Support was added in commit 5f2d05d, this updates the docs to match. This work was funded through GitHub Sponsors. Signed-off-by: Angus Gratton <angus@redyak.com.au>
Diffstat (limited to 'docs/library')
-rw-r--r--docs/library/machine.USBDevice.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/library/machine.USBDevice.rst b/docs/library/machine.USBDevice.rst
index 5c18c49a7..5291679ac 100644
--- a/docs/library/machine.USBDevice.rst
+++ b/docs/library/machine.USBDevice.rst
@@ -4,8 +4,9 @@
class USBDevice -- USB Device driver
====================================
-.. note:: ``machine.USBDevice`` is currently only supported on the rp2 and samd
- ports.
+.. note:: ``machine.USBDevice`` is currently only supported for esp32, rp2 and
+ samd ports. Native USB support is also required, and not every board
+ supports native USB.
USBDevice provides a low-level Python API for implementing USB device functions using
Python code.