Skip to content

Commit b50f90a

Browse files
SergioGasquezjessebraham
authored andcommitted
docs: 📝 Add note about permissions on Linux
1 parent f262403 commit b50f90a

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

cargo-espflash/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,11 @@ Options:
6666
-V, --version Print version information
6767
```
6868

69+
> **Note**
70+
>
71+
> #### Permissions on Linux
72+
> In Linux, when using any of the commands that requires using a serial port, 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.
73+
6974
## Bootloader and Partition Table
7075

7176
`cargo-espflash` is able to detect if the package being built and flashed depends on [esp-idf-sys]; if it does, then the bootloader and partition table built by the `esp-idf-sys` build script will be used, otherwise the bundled bootloader and partition tables will be used instead.

espflash/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,11 @@ Options:
6868
-V, --version Print version
6969
```
7070

71+
> **Note**
72+
>
73+
> #### Permissions on Linux
74+
> In Linux, when using any of the commands that requires using a serial port, 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.
75+
7176
### Cargo Runner
7277

7378
You can also use `espflash` as a Cargo runner by adding the following to your project's `.cargo/config.toml` file, for example:

0 commit comments

Comments
 (0)