Skip to content

Commit 6061a98

Browse files
committed
docs(tools/idf-monitor): add note about CH9102 USB-to-UART bridge issue on Windows
Closes espressif/esp-idf-monitor#26
1 parent 8a0e310 commit 6061a98

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/en/api-guides/tools/idf-monitor.rst

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -349,7 +349,14 @@ For more details on the configuration file, see the `IDF Monitor documentation`_
349349
Known Issues with IDF Monitor
350350
=============================
351351

352-
If you encounter any issues while using IDF Monitor, check our `GitHub repository <https://github.com/espressif/esp-idf-monitor/issues>`_ for a list of known issues and their current status. If you come across a problem that hasn't been documented yet, we encourage you to create a new issue report.
352+
The following issues are currently known:
353+
354+
- On Windows, if the terminal is closed without first closing the IDF Monitor, some drivers may not release the serial port. To release the port, you may need to unplug and replug the USB cable, or in some cases even restart the computer. This issue has been observed with the CH9102 USB-to-UART bridge. Other drivers, such as CP210x and CH340, should work fine.
355+
356+
To prevent this issue, make sure to close the IDF Monitor properly before exiting the terminal, or consider using an alternative USB-to-UART bridge.
357+
358+
359+
If you experience any other issues while using IDF Monitor, check our `GitHub repository <https://github.com/espressif/esp-idf-monitor/issues>`_ for a list of known issues and their current status. If you come across a problem that hasn't been documented yet, we encourage you to create a new issue report.
353360

354361
.. _esp-idf-monitor: https://github.com/espressif/esp-idf-monitor
355362
.. _IDF Monitor documentation: https://github.com/espressif/esp-idf-monitor/blob/v1.5.0/README.md#documentation

0 commit comments

Comments
 (0)