Introduction¶
ROM loader for ESP chips, works with ESP8266 or ESP32. This is a ‘no-stub’ loader, so you can’t read MD5 or firmware back on ESP8266.
See this document for protocol we’re implementing: https://github.com/espressif/esptool/wiki/Serial-Protocol
See this for the ‘original’ code we’re miniaturizing: https://github.com/espressif/esptool/blob/master/esptool.py
There’s a very basic Arduino ROM loader here for ESP32: https://github.com/arduino-libraries/WiFiNINA/tree/master/examples/Tools/FirmwareUpdater
Dependencies¶
This driver depends on:
Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.
Installing from PyPI¶
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:
pip3 install adafruit-circuitpython-miniesptool
To install system-wide (this may be required in some cases):
sudo pip3 install adafruit-circuitpython-miniesptool
To install in a virtual environment in your current project:
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-miniesptool
Usage Example¶
Check the examples folder for demo sketches to upload firmware to ESP8266 and ESP32
Documentation¶
API documentation for this library can be found on Read the Docs.
For information on building library documentation, please check out this guide.
Contributing¶
Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.
Table of Contents¶
Examples
API Reference
adafruit_miniesptool
miniesptool
miniesptool.baudrate
miniesptool.check_command()
miniesptool.checksum()
miniesptool.chip_name
miniesptool.chip_type
miniesptool.debug
miniesptool.flash_begin()
miniesptool.flash_block()
miniesptool.flash_file()
miniesptool.get_erase_size()
miniesptool.get_response()
miniesptool.mac_addr
miniesptool.md5()
miniesptool.read_register()
miniesptool.reset()
miniesptool.send_command()
miniesptool.slip_encode()
miniesptool.sync()