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)

Provides Extra

optional

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.22.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.

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

Uploaded Python 3

File details

Details for the file adafruit_circuitpython_miniesptool-0.2.22.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_miniesptool-0.2.22.tar.gz
Algorithm Hash digest
SHA256 26353c0d3c1bdd682c5c099ee81c341096db6ba3ef80f59683a7cc3ac06cf00f
MD5 35bc18a3c5213ae6d9ba8f8f79f3f8fe
BLAKE2b-256 d30705f4087ba80c4b4e1c768895aeb5050d7becb6e41442ea8f54f6e67682f9

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_miniesptool-0.2.22-py3-none-any.whl
Algorithm Hash digest
SHA256 758b7d5b41b20430610f644110b5bcf1724e97077b6546b3c737a2a7d0a0519e
MD5 9d6165ca5ddcb19943fd92474a57f69f
BLAKE2b-256 91cc7f339e3c3c4342bd6ad2b187260bcf30bfc0f2da7aaca708d71dd4b1b051

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