[Docs] Added USB documentation #6036
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pedrominatel
added
the
Type: Documentation
me-no-dev
reviewed
Dec 20, 2021
me-no-dev
reviewed
Dec 20, 2021
me-no-dev
reviewed
Dec 20, 2021
|
Seems you have added docs only for CDC and MSC so far. Will those show on separate pages? They should :) Also once you cover all exposed classes, maybe we can add doc on how to add a custom device as well. |
|
My suggestion is to create a separate page for CDC ( |
me-no-dev
reviewed
Dec 21, 2021
docs/source/api/usb_cdc.rst
Outdated
|
|
||
| USB Communications Device Class API. This class is used to enable communication between the host and the device. | ||
|
|
||
| This class is often used to enable serial communication and can be used to flash the firmware on the ESP32-S2 without the external USB to Serial chip. |
me-no-dev
reviewed
Dec 21, 2021
docs/source/api/usb_cdc.rst
Outdated
| HIDVendor | ||
| ********* | ||
|
|
||
| .. literalinclude:: ../../../libraries/USB/examples/HIDVendor/HIDVendor.ino |
There was a problem hiding this comment.
examples here seem unrelated to CDC. We do have CDC examples that you can add here
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Added USB documentation.
Impact
None.
Related links
Closes: #5784