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.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.2.28)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for adafruit-travis from gravatar.com adafruit-travis

Credits

Author: Adafruit Industries

License

MIT License (MIT)

Tags

adafruit miniesptool esp8266 esp32 esp software micropython circuitpython

Classifiers

Report project as malware

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.15.tar.gz (32.8 kB view details)

Uploaded Source

Built Distribution

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

adafruit_circuitpython_miniesptool-0.2.15-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-miniesptool-0.2.15.tar.gz
Algorithm Hash digest
SHA256 22960c0a3610cba2c1ced43d4c088ca4d2341e819d4c35e3aa5c773ba59490a0
MD5 f7fe9f1408ccde4b439dad357770d975
BLAKE2b-256 aae468c03ef15cde087a0bc864981a70347371a47aca2727dfd223ea9c1c6fd7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_miniesptool-0.2.15-py3-none-any.whl
Algorithm Hash digest
SHA256 bd86a032267ac3cfc45ed9598bce1432b3019d961c5837d7fbfbacdbe2b73e1e
MD5 9ba384020bec5aa56f370f334eb0e337
BLAKE2b-256 7afdd00a3511177aa8e0d0f4557e3296e9e9a826af9a767c53b2458e93bea492

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 Sentry Error logging StatusPage Status page