espressif/esptool
1
0
Fork 0
mirror of https://github.com/espressif/esptool.git synced 2025-10-21 23:30:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(serial port): Update basic-options with more linux instructions

Browse Source 
Closes https://github.com/espressif/esptool/pull/766
This commit is contained in:
Robin Gower
2022-08-09 10:46:46 +02:00
committed by radim.karnis
parent 2eff1be0f7
commit b37496f86d
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/en/esptool/basic-options.rst
View File

@@ -33,7 +33,9 @@ Serial Port
If using Cygwin or WSL on Windows, you have to convert the Windows-style name into a Unix-style path (``COM1`` -> ``/dev/ttyS0``, and so on). (This is not necessary if using ESP-IDF with the supplied Windows MSYS2 environment, If using Cygwin or WSL on Windows, you have to convert the Windows-style name into a Unix-style path (``COM1`` -> ``/dev/ttyS0``, and so on). (This is not necessary if using ESP-IDF with the supplied Windows MSYS2 environment,
this environment uses a native Windows Python which accepts COM ports as-is.) this environment uses a native Windows Python which accepts COM ports as-is.)
In Linux, the current user may not have access to serial ports and a "Permission Denied" error will appear. On most Linux distributions, the solution is to add the user to the ``dialout`` group with a command like ``sudo usermod -a -G dialout <USERNAME>``. In Linux, the current user may not have access to serial ports and a "Permission Denied" or "Port doesn't exist" errors may appear.
On most Linux distributions, the solution is to add the user to the ``dialout`` group (check e.g. ``ls -l /dev/ttyUSB0`` to find the group) with a command like ``sudo usermod -a -G dialout $USER``.
You can call ``su - $USER`` to enable read and write permissions for the serial port without having to log out and back in again.
Check your Linux distribution's documentation for more information. Check your Linux distribution's documentation for more information.
Baud Rate Baud Rate