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

This commit is contained in:
Linda 2023-08-24 15:39:32 +08:00
parent b39180d7a1
commit cfd84269e7
4 changed files with 30 additions and 2 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB

After

Width:  |  Height:  |  Size: 37 KiB

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
^^^^^

View File

@ -276,12 +276,26 @@ Windows 和 Linux 操作系统
在 Linux 操作系统中使用 PuTTY 设置串口通信参数
然后,请检查 {IDF_TARGET_NAME} 是否有打印日志。如有,请在终端打开串口进行查看。这里的日志内容取决于加载到 {IDF_TARGET_NAME} 的应用程序,请参考 `输出示例`_
然后,请检查 {IDF_TARGET_NAME} 是否有打印日志。如有,请在终端打开串口进行查看。这里的日志内容取决于加载到 {IDF_TARGET_NAME} 的应用程序,请参考 `输出示例`_如果没有看到输出日志,请尝试重启开发板。
.. 注解::
请在验证完串口通信正常后,关闭串口终端。如果终端一直保持打开的状态,之后上传固件时将无法访问串口。
.. 注解::
如果没有日志输出,请检查以下原因:
- {IDF_TARGET_NAME} 的供电是否正常
- 启动终端程序后,是否重置开发板
- 使用 `在 Windows 上查看端口`_`在 Linux 和 macOS 上查看端口`_ 中描述的方法,检查所选串口是否正确
- 其他程序是否正在使用该串口
- 对于 `Windows 和 Linux 操作系统`_ 中描述的串口终端程序,其选择的端口是否正确
- 串口终端程序中的串口设置是否适用于该应用程序
- 开发板上选择的 USB 连接器UART是否正确
- 应用程序是否会输出日志
- 是否禁用了日志输出(使用 :example:`hello world 示例 <get-started/hello_world>` 进行测试)
macOS 操作系统
^^^^^^^^^^^^^^^^^