Skip to content

Added troubleshooting doc for USB-CDC #8840

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 4 commits into from
Nov 17, 2023
Merged

Added troubleshooting doc for USB-CDC #8840

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4210c69
Added troubleshooting doc for USB-CDC
lbernstone Nov 6, 2023
30db58a
Clarification
lbernstone Nov 6, 2023
8ca8119
Change requested by @pedrominatel
lbernstone Nov 11, 2023
72e681f
Fixed the title level issue
pedrominatel Nov 16, 2023
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
11 changes: 11 additions & 0 deletions docs/source/troubleshooting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,17 @@ Sample code to check SDK WPA3 support at compile time:
#warning "No WPA3 support."
#endif

Serial not printing
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change to:

Serial not printing
*******************

-------------------
I have uploaded firmware to the ESP32 device, but I don't see any response from a Serial.print (HardwareSerial).

Solution
^^^^^^^^

Newer ESP32 variants have two possible USB connectors- USB and UART. The UART connector will go through a USB->UART adapter, and will typically present itself with the name of that mfr (eg, Silicon Labs CP210x UART Bridge). The USB connector can be used as a USB-CDC bridge and will appear as an Espressif device (Espressif USB JTAG/serial debug unit). On Espressif devkits, both connections are available, and will be labeled. ESP32 can only use UART, so will only have one connector. Other variants with one connector will typically be using USB.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would recommend adding the "Please check in the product product page/datasheet" link to products.espressif.com for the ESP32-X products with the embedded USB-Serial and JTAG.

If you use the UART connector, you should disable USB-CDC on boot under the Tools menu (-D ARDUINO_USB_CDC_ON_BOOT=0). If you use the USB connector, you should have that enabled (-D ARDUINO_USB_CDC_ON_BOOT=1) and set USB Mode to "Hardware CDC and JTAG" (-D ARDUINO_USB_MODE=0).
USB-CDC may not be able to initialize in time to catch all the data if your device is in a tight reboot loop. This can make it difficult to troubleshoot initialization issues.

SPIFFS mount failed
-------------------
When you come across an error like this:
Expand Down