doc: Update note about high-level usb packages in micropython-lib.

Also fix a small typo.

Signed-off-by: Angus Gratton <angus@redyak.com.au>
Angus Gratton 2024-05-02 13:37:33 +10:00
rodzic 64f28dc1eb
commit a82b94f887
1 zmienionych plików z 7 dodań i 7 usunięć

Wyświetl plik

@ -8,13 +8,11 @@ class USBDevice -- USB Device driver
ports. ports.
USBDevice provides a low-level Python API for implementing USB device functions using 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 Python code.
not recommended to use this API directly, instead install the high-level usbd
module from micropython-lib.
.. warning:: This functionality is very new and the high-level usbd module is .. warning:: This low-level API assumes familiarity with the USB standard. There
not yet merged into micropython-lib. It can be found `here on are high-level `usb driver modules in micropython-lib`_ which provide a
GitHub <https://github.com/micropython/micropython-lib/pull/558>`_. simpler interface and more built-in functionality.
Terminology Terminology
----------- -----------
@ -186,7 +184,7 @@ Methods
necessary if the runtime device configuration has changed, so that necessary if the runtime device configuration has changed, so that
the host sees the new device. 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 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. set to one of the ``USBDevice.BUILTIN_`` named constants defined on this object.
@ -294,3 +292,5 @@ Constants
descriptor. descriptor.
- ``desc_cfg`` - ``bytes`` object containing the complete built-in USB - ``desc_cfg`` - ``bytes`` object containing the complete built-in USB
configuration descriptor. configuration descriptor.
.. _usb driver modules in micropython-lib: https://github.com/micropython/micropython-lib/tree/master/micropython/usb#readme