.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. .TH ESPTOOL.PY "1" "January 2024" "esptool.py 4.7.0" "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 a binary file (bootloader or application) .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 merge_bin Merge multiple raw binary files into a single file for later flashing .TP get_security_info Get some security\-related data .TP version Print esptool version .SS "options:" .TP \fB\-h\fR, \fB\-\-help\fR show this help message and exit .TP \fB\-\-chip\fR {auto,CHIP} 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,usb_reset,no_reset,no_reset_no_sync} What to do before connecting to the chip .TP \fB\-\-after, \fB\-a\fR {hard_reset,soft_reset,no_reset,no_reset_stub} What to do after esptool is finished .TP \fB\-\-no\-stub\fR Disable launching the flasher stub, only talk to ROM bootloader. Some features will not be available. .TP \fB\-\-trace\fR, \fB\-t\fR Enable trace\-level output of esptool interactions. .TP \fB\-\-override\-vddsdio\fR Override ESP32 VDDSDIO internal voltage regulator (use with care) .TP \fB\-\-connect\-attempts\fR CONNECT_ATTEMPTS Number of attempts to connect, negative or 0 for infinite. Default: 7. .SH EXAMPLES Display device features, SPI flash manufacturer and device ID: .IP "" 4 .EX esptool flash_id .EE .PP Flash ESP8266 Espressif AT v1.6.2 firmware to ESP-WROOM-02 board: .IP "" 4 .EX 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_v08.bin 0x3fe000 blank.bin .EE .PP Flash ESP32 Espressif AT v1.1.1 firmware to ESP-WROOM-32 board: .IP "" 4 .EX esptool write_flash \-\-flash_mode dio \-\-flash_freq 40m \-\-flash_size detect 0x1000 bootloader/bootloader.bin 0x20000 at_customize.bin 0x21000 customized_partitions/ble_data.bin 0x24000 customized_partitions/server_cert.bin 0x26000 customized_partitions/server_key.bin 0x28000 customized_partitions/server_ca.bin 0x2a000 customized_partitions/client_cert.bin 0x2c000 customized_partitions/client_key.bin 0x2e000 customized_partitions/client_ca.bin 0xf000 phy_init_data.bin 0x100000 esp\-at.bin 0x8000 partitions_at.bin .EE .PP Display ESP32 efuse state summary: .IP "" 4 .EX espefuse \-\-port /dev/ttyUSB0 summary .EE .PP Generate a flash encryption key: .IP "" 4 .EX espsecure generate_flash_encryption_key key.bin .EE .PP Burn the key to the device (WARNING: one time only operation): .IP "" 4 .EX espefuse \-\-port /dev/ttyUSB1 burn_key flash_encryption key.bin .EE .PP Encrypt flash data: .IP "" 4 .EX espsecure encrypt_flash_data \-\-keyfile key.bin \-\-address 0x10000 \-o my\-app\-encrypted.bin my\-app.bin .EE .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 has been produced by Milan Kupcevic for the Debian project and can be used by others. .SH "REPORTING BUGS" Review: .br Known issues: .br Report new issues at: .SH COPYRIGHT Copyright \(co 2014-2017 Fredrik Ahlberg, Angus Gratton, Espressif Systems (Shanghai) PTE LTD, other contributors as noted. License GPLv2+: GNU GPL version 2 or later . 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)