espressif/esptool
1
0
Fork 0
mirror of https://github.com/espressif/esptool.git synced 2025-10-19 11:43:48 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(troubleshooting): Mention needed permissions to the serial port on Linux

Browse Source 
Closes https://github.com/espressif/esptool/pull/984
This commit is contained in:
Radim Karniš
2024-08-01 15:43:53 +02:00
parent 5dd3dccf8e
commit 8e39ef6fd6
2 changed files with 14 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/en/troubleshooting.rst
View File

@@ -197,15 +197,7 @@ A serial exception error occurred
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
``esptool.py`` uses the `pySerial <https://pyserial.readthedocs.io/en/latest/>`_ Python module for accessing the serial port. ``esptool.py`` uses the `pySerial <https://pyserial.readthedocs.io/en/latest/>`_ Python module for accessing the serial port.
If pySerial cannot operate normally, it raises an error and terminates. Some of the most common pySerial error causes are: If pySerial cannot operate normally, it raises an error and terminates.
.. list::
* You don't have permission to access the port.
* The port is being already used by other software.
* The port doesn't exist.
* The device gets unexpectedly disconnected.
* The necessary serial port drivers are not installed or are faulty.
An example of a pySerial error: An example of a pySerial error:
@@ -214,3 +206,15 @@ An example of a pySerial error:
A serial exception error occurred: read failed: [Errno 6] Device not configured A serial exception error occurred: read failed: [Errno 6] Device not configured
Errors originating from pySerial are, therefore, not a problem with ``esptool.py``, but are usually caused by a problem with hardware or drivers. Errors originating from pySerial are, therefore, not a problem with ``esptool.py``, but are usually caused by a problem with hardware or drivers.
Some of the most common pySerial error causes are:
.. list::
* The port is being already used by other software.
* The port doesn't exist.
* The device gets unexpectedly disconnected.
* The necessary serial port drivers are not installed or are faulty.
* You don't have permission to access the port.
On Linux, read and write access the serial port over USB is necessary. You can add your user to the ``dialout`` or ``uucp`` group to grant access to the serial port. See `Adding user to dialout or uucp on Linux <https://docs.espressif.com/projects/esp-idf/en/stable/get-started/establish-serial-connection.html#adding-user-to-dialout-or-uucp-on-linux>`_.

5
esptool/loader.py
View File

@@ -351,10 +351,7 @@ class ESPLoader(object):
port_issues.append( port_issues.append(
[ # permission denied error [ # permission denied error
re.compile(r"Permission denied", re.IGNORECASE), re.compile(r"Permission denied", re.IGNORECASE),
( ("Try to add user into dialout or uucp group."),
"Try to add user into dialout group: "
"sudo usermod -a -G dialout $USER"
),
], ],
) )