Skip to content

[Docs] Added USB documentation #6036

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Dec 21, 2021
Merged

[Docs] Added USB documentation #6036

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a30ebe3
[Docs] Added usb.rst file
pedrominatel Nov 23, 2021
90da36f
[Bug Fix] Added basic files for USB docs
pedrominatel Dec 13, 2021
59b978b
[Docs] Added structure for the USB API
pedrominatel Dec 16, 2021
d7dbd85
[Docs] First draft version for the USB docs
pedrominatel Dec 17, 2021
921f86c
[Docs] Splited USB CDC and MSC plus some changes based on the PR review.
pedrominatel Dec 20, 2021
9a74083
[Docs] Added more description on the USB classes section.
pedrominatel Dec 20, 2021
0a9aa74
[Docs] Fixed missing usb.org link ref
pedrominatel Dec 20, 2021
81b5d6a
[Docs] Revision on CDC and MSC examples and minor fixes
pedrominatel Dec 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
[Bug Fix] Added basic files for USB docs
  • Loading branch information
@pedrominatel
pedrominatel committed Dec 16, 2021
commit 90da36f8c7abcdad478e66d7fe37ca73be582f0b
10 changes: 9 additions & 1 deletion docs/source/api/usb.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,19 @@
USB API
#######

.. note:: This feature is only supported by ESP32-S2.

About
-----

USB as Device
*************

USB as Host
***********
***********

API Description
---------------

useStaticBuffers
****************
1 change: 1 addition & 0 deletions docs/source/libraries.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,4 +86,5 @@ The Arduino ESP32 offers some unique APIs, described in this section:
I2C <api/i2c>
RainMaker <api/rainmaker>
Reset Reason <api/reset_reason>
USB <api/usb.rst>
Wi-Fi <api/wifi>