Skip to main content

Introduction

Documentation Status Discord Build Status Code Style: Black

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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit-circuitpython-miniesptool-0.2.19.tar.gz (31.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file adafruit-circuitpython-miniesptool-0.2.19.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-miniesptool-0.2.19.tar.gz
Algorithm Hash digest
SHA256 9a86119a4622c67507fc1ad09bd043141c7a8cae04e14268b57ee403008a9cca
MD5 e4db76ead4205f44afc79d5940aa712a
BLAKE2b-256 fdab3f15720f82f98604d352a5a942d24460065a1e6d38a176a0617dc8368b91

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_miniesptool-0.2.19-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_miniesptool-0.2.19-py3-none-any.whl
Algorithm Hash digest
SHA256 92fa2b01b31af30451b5c844fbb7df86b3e993e3cd62b9d9f481e81a3cbe579b
MD5 e626e25a3d8fda0ab0e177496182efdd
BLAKE2b-256 aa168869d30d3e37d4bb0d9c2db10313524c8bea404941cc0fb5b5db1e954836

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page