From e64cf1a79322a4e6575ff8c2aa73362dff8cc12a Mon Sep 17 00:00:00 2001 From: Sergio Gasquez Date: Tue, 25 Apr 2023 11:37:27 +0200 Subject: [PATCH] =?UTF-8?q?docs:=20=F0=9F=93=9D=20Add=20note=20about=20per?= =?UTF-8?q?missions=20on=20Linux?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- cargo-espflash/README.md | 5 +++++ espflash/README.md | 5 +++++ 2 files changed, 10 insertions(+) diff --git a/cargo-espflash/README.md b/cargo-espflash/README.md index d2637793..2f0ca343 100644 --- a/cargo-espflash/README.md +++ b/cargo-espflash/README.md @@ -66,6 +66,11 @@ Options: -V, --version Print version information ``` +> **Note** +> +> #### Permissions on Linux +> 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. + ## Bootloader and Partition Table `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. diff --git a/espflash/README.md b/espflash/README.md index cd6e75be..f8e088db 100644 --- a/espflash/README.md +++ b/espflash/README.md @@ -68,6 +68,11 @@ Options: -V, --version Print version ``` +> **Note** +> +> #### Permissions on Linux +> 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. + ### Cargo Runner You can also use `espflash` as a Cargo runner by adding the following to your project's `.cargo/config.toml` file, for example: