Skip to content

Commit 59c62fd

Browse files
dzamlojessebraham
authored andcommitted
docs: add configuration file examples
1 parent 93fe962 commit 59c62fd

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed

cargo-espflash/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,21 @@ It's possible to specify a serial port and/or USB VID/PID values by setting them
100100
| macOS | `$HOME/Library/Application Support/rs.esp.espflash/espflash.toml` |
101101
| Windows | `%APPDATA%\esp\espflash\espflash.toml` |
102102

103+
### Configuration examples
104+
105+
You can either configure the serial port name like so:
106+
```
107+
[connection]
108+
serial = "/dev/ttyUSB0"
109+
```
110+
111+
Or specify one or more USB `vid`/`pid` couple:
112+
```
113+
[[usb_device]]
114+
vid = "303a"
115+
pid = "1001"
116+
```
117+
103118
## Windows Subsystem for Linux
104119

105120
It is not currently possible to use `cargo-espflash` from within WSL1.

espflash/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,21 @@ It's possible to specify a serial port and/or USB VID/PID values by setting them
9494
| macOS | `$HOME/Library/Application Support/rs.esp.espflash/espflash.toml` |
9595
| Windows | `%APPDATA%\esp\espflash\espflash.toml` |
9696

97+
### Configuration examples
98+
99+
You can either configure the serial port name like so:
100+
```
101+
[connection]
102+
serial = "/dev/ttyUSB0"
103+
```
104+
105+
Or specify one or more USB `vid`/`pid` couple:
106+
```
107+
[[usb_device]]
108+
vid = "303a"
109+
pid = "1001"
110+
```
111+
97112
## Windows Subsystem for Linux
98113

99114
It is not currently possible to use `espflash` from within WSL1.

0 commit comments

Comments
 (0)