From a82b94f887d6fc02937bbe9a97ba6d15b8e7cf0f Mon Sep 17 00:00:00 2001 From: Angus Gratton Date: Thu, 2 May 2024 13:37:33 +1000 Subject: [PATCH] doc: Update note about high-level usb packages in micropython-lib. Also fix a small typo. Signed-off-by: Angus Gratton --- docs/library/machine.USBDevice.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/library/machine.USBDevice.rst b/docs/library/machine.USBDevice.rst index e02d3c02df..5fc7165161 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 `_. +.. 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