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.20.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.20-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-miniesptool-0.2.20.tar.gz
Algorithm Hash digest
SHA256 3ab4d1026c5bd59f35ead6da87a466d64345c3ea4b7fb3b794907506d1f3d4c8
MD5 0c953b385b9751c2dff154823a1e0497
BLAKE2b-256 66e1bb6a206c18725d3d725c0290436a37169b48da5bd241bec73d6af0c45ce3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_miniesptool-0.2.20-py3-none-any.whl
Algorithm Hash digest
SHA256 6cf94c778cb16cb3e8e7dcef41f33ed6acaea6f28daa13bb260bb5bd13a32359
MD5 78988d3243f6292c23c05e05ec779d14
BLAKE2b-256 e8710dfb7d93c51bda212a3b3b5e40f71a495fd99a2b57ea750a6582b1805a93

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