espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2026-05-05 12:25:03 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'docs/add_troubleshooting_notes_to_establish_serial_connection' into 'master'

Browse Source 
docs: add troubleshooting notes to establish-serial-connection.rst

See merge request espressif/esp-idf!25534
This commit is contained in:
Zhang Xiao Yan
2023-09-13 02:27:38 +08:00
parent 170294ff5c cfd84269e7
commit 6bb7cb8c25
4 changed files with 30 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/get-started/establish-serial-connection.rst
+15 -1
View File
@@ -276,12 +276,26 @@ Run terminal and set identified serial port. Baud rate = 115200 (if needed, chan
Setting Serial Communication in PuTTY on Linux
Then open serial port in terminal and check, if you see any log printed out by {IDF_TARGET_NAME}. The log contents depend on application loaded to {IDF_TARGET_NAME}, see `Example Output`_.
Then open serial port in terminal and check, if you see any log printed out by {IDF_TARGET_NAME}. The log contents depend on application loaded to {IDF_TARGET_NAME}, see `Example Output`_. Reset the board if no log has been printed out.
.. note::
Close the serial terminal after verification that communication is working. If you keep the terminal session open, the serial port will be inaccessible for uploading firmware later.
.. note::
If there is no log output, check
- if the required power is supplied to {IDF_TARGET_NAME}
- if the board was reset after starting the terminal program
- if the selected serial port is the correct one by using the method stated in `Check Port on Windows`_ and `Check Port on Linux and macOS`_
- if the serial port is not being used by another program
- if the identified port has been selected in serial terminal programs you are using, as stated in `Windows and Linux`_
- if settings of the serial port in serial terminal programs are applicable to corresponding applications
- if the correct USB connector (UART) is used on the development board
- if your application is expected to output some log
- if the log output has not been disabled (use :example:`hello world application <get-started/hello_world>` to test)
macOS
^^^^^