1Esptool.py Documentation
2========================
3
4This is the documentation for ``esptool.py`` - a Python-based, open source, platform independent utility to communicate with the ROM bootloader in `Espressif SoCs <https://www.espressif.com/en/products/hardware/socs>`_.
5
6``esptool.py``, ``espefuse.py`` and ``espsecure.py`` are a complete toolset for working with Espressif chips. They can do a number of things, for example:
7
8* Read, write, erase, and verify binary data stored in flash.
9* Read chip features and other related data such as MAC address or flash chip ID.
10* Read and write the one-time-programmable efuses.
11* Prepare binary executable images ready for flashing.
12* Analyze, assemble, and merge binary images.
13
14This document describes using ``esptool.py`` with the {IDF_TARGET_NAME} SoC. To switch to a different SoC target, choose target from the dropdown in the upper left.
15
16Quick Start
17-----------
18
19Getting started is easy:
20
211) Install ``esptool.py``:
22
23    ::
24
25        $ pip install esptool
26
27    For detailed instructions, see :ref:`installation`.
28
29
302) Connect an Espressif chip to your computer.
31
323) Run ``esptool.py`` commands:
33
34    ::
35
36        $ esptool.py -p PORT flash_id
37
38    Replace ``PORT`` with the name of used serial port. If connection fails, see :ref:`troubleshooting`.
39
40More Information
41----------------
42
43.. toctree::
44   :maxdepth: 1
45
46   Installation <installation>
47   Esptool <esptool/index>
48   :not esp8266:Espefuse <espefuse/index>
49   :not esp8266:Espsecure <espsecure/index>
50   Advanced Topics <advanced-topics/index>
51   Troubleshooting <troubleshooting>
52   Contribute <contributing>
53   Versions <versions>
54   About <about>
55