Skip to content

Commit 5699190

Browse files
committed
Add switches and feature to readme
1 parent 907724d commit 5699190

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

espflash/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ OPTIONS:
3636
--bootloader <BOOTLOADER>
3737
Path to a binary (.bin) bootloader file
3838
39+
--dtr <DTR> [only available when built with the "raspberry" feature]
40+
DTR pin to use for the internal UART hardware. Uses BCM numbering
41+
3942
--erase-otadata
4043
Erase the OTADATA partition This is useful when using multiple OTA partitions and still
4144
wanting to be able to reflash via espflash
@@ -67,6 +70,9 @@ OPTIONS:
6770
--ram
6871
Load the application to RAM instead of Flash
6972
73+
--rts <RTS> [only available when built with the "raspberry" feature]
74+
RTS pin to use for the internal UART hardware. Uses BCM numbering
75+
7076
-s, --flash-size <SIZE>
7177
Flash size of the target [possible values: 256KB, 512KB, 1MB, 2MB, 4MB, 8MB, 16MB, 32MB,
7278
64MB, 128MB]
@@ -90,6 +96,12 @@ SUBCOMMANDS:
9096
write-bin-to-flash Writes a binary file to a specific address in the chip's flash
9197
```
9298

99+
## Compile-time features
100+
101+
- `raspberry`: enables configuring DTR and RTS GPIOs which are necessary to use a Raspberry Pi's
102+
internal UART peripherals. This feature is optional (external USB <-> UART converters work
103+
without it) and adds a dependency on [`rppal`](https://crates.io/crates/rppal).
104+
93105
## Configuration
94106

95107
You can also specify the serial port and/or expected VID/PID values by setting them in the configuration file. This file is in different locations depending on your operating system:

0 commit comments

Comments
 (0)