Skip to content

Commit c3301da

Browse files
projectgusdpgeorge
authored andcommitted
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>
1 parent 9a43989 commit c3301da

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/library/machine.USBDevice.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,11 @@ class USBDevice -- USB Device driver
88
ports.
99

1010
USBDevice provides a low-level Python API for implementing USB device functions using
11-
Python code. This low-level API assumes familiarity with the USB standard. It's
12-
not recommended to use this API directly, instead install the high-level usbd
13-
module from micropython-lib.
11+
Python code.
1412

15-
.. warning:: This functionality is very new and the high-level usbd module is
16-
not yet merged into micropython-lib. It can be found `here on
17-
GitHub <https://github.com/micropython/micropython-lib/pull/558>`_.
13+
.. warning:: This low-level API assumes familiarity with the USB standard. There
14+
are high-level `usb driver modules in micropython-lib`_ which provide a
15+
simpler interface and more built-in functionality.
1816

1917
Terminology
2018
-----------
@@ -186,7 +184,7 @@ Methods
186184
necessary if the runtime device configuration has changed, so that
187185
the host sees the new device.
188186

189-
.. attribute:: USDBD.builtin_driver
187+
.. attribute:: USBDevice.builtin_driver
190188

191189
This attribute holds the current built-in driver configuration, and must be
192190
set to one of the ``USBDevice.BUILTIN_`` named constants defined on this object.
@@ -294,3 +292,5 @@ Constants
294292
descriptor.
295293
- ``desc_cfg`` - ``bytes`` object containing the complete built-in USB
296294
configuration descriptor.
295+
296+
.. _usb driver modules in micropython-lib: https://github.com/micropython/micropython-lib/tree/master/micropython/usb#readme

0 commit comments

Comments
 (0)