Introduction

Documentation Status Discord Build Status Code Style: Ruff

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.24.tar.gz (27.7 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.24-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_miniesptool-0.2.24.tar.gz
Algorithm Hash digest
SHA256 ba312f8fc9243ce0d0c68c985974d5dd56594b3f743bf5873fb54b52010468f9
MD5 5e630c36e8609ecb06436b69ed544ee8
BLAKE2b-256 335f6661cce96089d0afa24c9f15fc995737dffc5e456b516e110cab3197813d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_miniesptool-0.2.24-py3-none-any.whl
Algorithm Hash digest
SHA256 cdee71069bdb26fad782b6d4f2506a63715951344f72768746c2095b646ac9d3
MD5 49ae6cd6caf5dc979dc69673b1dfc4bc
BLAKE2b-256 47932e340da3b7c3031c862f521701eb01df78d0471a39c388944cdcbccd1b47

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