You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Cargo subcommand for flashing Espressif devices over serial
61
+
Cargo subcommand for flashing Espressif devices
52
62
53
-
Usage: cargo espflash <COMMAND>
63
+
Usage: cargo-espflash espflash <COMMAND>
54
64
55
65
Commands:
56
-
board-info Display information about the connected board and exit without flashing
57
-
completions Generate completions for the given shell. Resulting completions have to be appended to cargo's completions
58
-
flash Flash an application to a target device
66
+
board-info Establish a connection with a target device
67
+
completions Generate completions for the given shell
68
+
flash Build and flash an application to a target device
59
69
monitor Open the serial monitor without flashing
60
70
partition-table Operations for partitions tables
61
71
save-image Save the image to disk instead of flashing to device
62
72
help Print this message or the help of the given subcommand(s)
63
73
64
74
Options:
65
-
-h, --help Print help information
66
-
-V, --version Print version information
75
+
-h, --help Print help
76
+
-V, --version Print version
67
77
```
68
78
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.
79
+
### Permissions on Linux
80
+
81
+
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.
82
+
83
+
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.
84
+
85
+
Check your Linux distribution’s documentation for more information.
86
+
87
+
### Windows Subsystem for Linux
88
+
89
+
It is _not_ currently possible to use `cargo-espflash` from within WSL1. There are no plans to add support for WSL1 at this time.
90
+
91
+
It is also _not_ possible to flash chips using the built-in `USB_SERIAL_JTAG` peripheral when using WSL2, because resetting also resets `USB_SERIAL_JTAG` peripheral, which then disconnects the chip from WSL2. Chips _can_ be flashed via UART using WSL2, however.
format = "direct-boot"# Can be 'esp-bootloader' or 'direct-boot'
91
110
```
92
111
93
-
## Configuration
112
+
## Configuration File
94
113
95
114
It's possible to specify a serial port and/or USB VID/PID values by setting them in a configuration file. The location of this file differs based on your operating system:
96
115
@@ -103,24 +122,20 @@ It's possible to specify a serial port and/or USB VID/PID values by setting them
103
122
### Configuration examples
104
123
105
124
You can either configure the serial port name like so:
125
+
106
126
```
107
127
[connection]
108
128
serial = "/dev/ttyUSB0"
109
129
```
110
130
111
131
Or specify one or more USB `vid`/`pid` couple:
132
+
112
133
```
113
134
[[usb_device]]
114
135
vid = "303a"
115
136
pid = "1001"
116
137
```
117
138
118
-
## Windows Subsystem for Linux
119
-
120
-
It is not currently possible to use `cargo-espflash` from within WSL1.
121
-
122
-
It is not possible to flash chips using the built-in `USB_SERIAL_JTAG` when using WSL2, because the reset also resets `USB_SERIAL_JTAG` peripheral which then disconnects the chip from WSL2. Chips _can_ be flashed via UART using WSL2, however.
A command-line tool for flashing Espressif devices over serial
62
+
A command-line tool for flashing Espressif devices
53
63
54
64
Usage: espflash <COMMAND>
55
65
@@ -68,10 +78,19 @@ Options:
68
78
-V, --version Print version
69
79
```
70
80
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.
81
+
### Permissions on Linux
82
+
83
+
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.
84
+
85
+
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.
86
+
87
+
Check your Linux distribution’s documentation for more information.
88
+
89
+
### Windows Subsystem for Linux
90
+
91
+
It is _not_ currently possible to use `cargo-espflash` from within WSL1. There are no plans to add support for WSL1 at this time.
92
+
93
+
It is also _not_ possible to flash chips using the built-in `USB_SERIAL_JTAG` peripheral when using WSL2, because resetting also resets `USB_SERIAL_JTAG` peripheral, which then disconnects the chip from WSL2. Chips _can_ be flashed via UART using WSL2, however.
With this configuration you can flash and monitor you application using `cargo run`.
86
105
87
-
## Configuration
106
+
## Configuration File
88
107
89
108
It's possible to specify a serial port and/or USB VID/PID values by setting them in a configuration file. The location of this file differs based on your operating system:
90
109
@@ -97,24 +116,20 @@ It's possible to specify a serial port and/or USB VID/PID values by setting them
97
116
### Configuration examples
98
117
99
118
You can either configure the serial port name like so:
119
+
100
120
```
101
121
[connection]
102
122
serial = "/dev/ttyUSB0"
103
123
```
104
124
105
125
Or specify one or more USB `vid`/`pid` couple:
126
+
106
127
```
107
128
[[usb_device]]
108
129
vid = "303a"
109
130
pid = "1001"
110
131
```
111
132
112
-
## Windows Subsystem for Linux
113
-
114
-
It is not currently possible to use `espflash` from within WSL1.
115
-
116
-
It is not possible to flash chips using the built-in `USB_SERIAL_JTAG` when using WSL2, because the reset also resets `USB_SERIAL_JTAG` peripheral which then disconnects the chip from WSL2. Chips _can_ be flashed via UART using WSL2, however.
0 commit comments