summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAngus Gratton <angus@redyak.com.au>2024-05-02 13:37:33 +1000
committerDamien George <damien@micropython.org>2024-05-09 15:48:26 +1000
commitc3301da17626663d7d6e5fc79a1010842528c9b1 (patch)
tree4db6c0d2d83e0d3a6ecf0f685979c92d3773c04c
parent9a43989a8651dacc004f9bb8df6574c814ec98ca (diff)
docs/library/machine.USBDevice: Update note about packages in mp-lib.
Also fix a small typo. Signed-off-by: Angus Gratton <angus@redyak.com.au>
-rw-r--r--docs/library/machine.USBDevice.rst14
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/library/machine.USBDevice.rst b/docs/library/machine.USBDevice.rst
index e02d3c02d..5fc716516 100644
--- a/docs/library/machine.USBDevice.rst
+++ b/docs/library/machine.USBDevice.rst
@@ -8,13 +8,11 @@ class USBDevice -- USB Device driver
ports.
USBDevice provides a low-level Python API for implementing USB device functions using
-Python code. This low-level API assumes familiarity with the USB standard. It's
-not recommended to use this API directly, instead install the high-level usbd
-module from micropython-lib.
+Python code.
-.. warning:: This functionality is very new and the high-level usbd module is
- not yet merged into micropython-lib. It can be found `here on
- GitHub <https://github.com/micropython/micropython-lib/pull/558>`_.
+.. warning:: This low-level API assumes familiarity with the USB standard. There
+ are high-level `usb driver modules in micropython-lib`_ which provide a
+ simpler interface and more built-in functionality.
Terminology
-----------
@@ -186,7 +184,7 @@ Methods
necessary if the runtime device configuration has changed, so that
the host sees the new device.
-.. attribute:: USDBD.builtin_driver
+.. attribute:: USBDevice.builtin_driver
This attribute holds the current built-in driver configuration, and must be
set to one of the ``USBDevice.BUILTIN_`` named constants defined on this object.
@@ -294,3 +292,5 @@ Constants
descriptor.
- ``desc_cfg`` - ``bytes`` object containing the complete built-in USB
configuration descriptor.
+
+.. _usb driver modules in micropython-lib: https://github.com/micropython/micropython-lib/tree/master/micropython/usb#readme