.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.4.
.TH ESPTOOL "1" "April 2018" "esptool.py 2.1" "User Commands"
.SH NAME
esptool \- ESP8266 and ESP32 ROM Bootloader Utility
.SH DESCRIPTION
usage: esptool [OPTION] COMMAND 
.IP



\&
.PP

.SS "command arguments:"
.TP

Run esptool {command} \fB\-h\fR for additional help
.TP
load_ram
Download an image to RAM and execute
.TP
dump_mem
Dump arbitrary memory to disk
.TP
read_mem
Read arbitrary memory location
.TP
write_mem
Read\-modify\-write to arbitrary memory location
.TP
write_flash
Write a binary blob to flash
.TP
run
Run application code in flash
.TP
image_info
Dump headers from an application image
.TP
make_image
Create an application image from binary files
.TP
elf2image
Create an application image from ELF file
.TP
read_mac
Read MAC address from OTP ROM
.TP
chip_id
Read Chip ID from OTP ROM
.TP
flash_id
Read SPI flash manufacturer and device ID
.TP
read_flash_status
Read SPI flash status register
.TP
write_flash_status
Write SPI flash status register
.TP
read_flash
Read SPI flash content
.TP
verify_flash
Verify a binary blob against flash
.TP
erase_flash
Perform Chip Erase on SPI flash
.TP
erase_region
Erase a region of the flash
.TP
version
Print esptool version
.SS "optional arguments:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-chip, \fB\-c\fR {auto,esp8266,esp32}
Target chip type
.TP
\fB\-\-port\fR PORT, \fB\-p\fR PORT
Serial port device
.TP
\fB\-\-baud\fR BAUD, \fB\-b\fR BAUD
Serial port baud rate used when flashing/reading
.TP
\fB\-\-before\fR {default_reset,no_reset}
What to do before connecting to the chip
.TP
\fB\-\-after, \fB\-a\fR {hard_reset,soft_reset,no_reset}
What to do after esptool is finished
.SH EXAMPLES
Flash Espressif AT v1.4 firmware to an ESP-12S board:
.IP
esptool write_flash \-\-flash_mode dio \-\-flash_size 4MB\-c1 0x00 boot_v1.7.bin 0x1000 at/1024+1024/user1.2048.new.5.bin 0xfe000 blank.bin 0x3fc000 esp_init_data_default.bin 0x3fe000 blank.bin
.PP
Display ESP32 efuse state summary:
.IP
espefuse \-\-port /dev/ttyUSB0 summary
.PP
Generate a flash encryption key:
.IP
espsecure generate_flash_encryption_key key.bin
.PP
Burn the key to the device (WARNING: one time only operation):
.IP
espefuse \-\-port /dev/ttyUSB1 burn_key flash_encryption key.bin
.PP
Encrypt flash data:
.IP
espsecure encrypt_flash_data \-\-keyfile key.bin \-\-address 0x10000 \-o my\-app\-encrypted.bin my\-app.bin
.SH AUTHOR
esptool.py was started by Fredrik Ahlberg as an unofficial community project, 
currently maintained by Angus Gratton and supported by Espressif Systems 
(Shanghai) PTE LTD. This manual page was generated by Milan Kupcevic 
<milan@debian.org> for the Debian project and can be used by others.
.SH "REPORTING BUGS"
Review: <https://github.com/espressif/esptool/#troubleshooting>
.br
Known issues: <https://github.com/espressif/esptool/issues>
.br
Report new issues at: <https://github.com/espressif/esptool/issues/new>
.SH COPYRIGHT
Copyright \(co 2014-2016 Fredrik Ahlberg, Angus Gratton, 
Espressif Systems (Shanghai) PTE LTD, other contributors as noted.
License GPLv2+: GNU GPL version 2 or later <http://gnu.org/licenses/gpl.html>.
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.SH "SEE ALSO"
.PP
.BR esptool (1),
.BR espefuse (1),
.BR espsecure (1)