Skip to main content

CircuitPython ROM loader for ESP chips, works with ESP8266 or ESP32.

Project description

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 details


Download files

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

Source Distribution

Built Distribution

File details

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

File metadata

File hashes

Hashes for adafruit-circuitpython-miniesptool-0.2.17.tar.gz
Algorithm Hash digest
SHA256 3a591368c269f57f0f09cbca40017c57f761e460122b2ca351cafe7c47484451
MD5 15e4475b518db247f2bea4003b18d6ec
BLAKE2b-256 b533a9ee47e2e033f77ef6fca3061e695fa35bdfeaceb6fb1b43d06c20d5ab76

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_miniesptool-0.2.17-py3-none-any.whl
Algorithm Hash digest
SHA256 5304760b70327fd6316c6f39c64d2f7644ada7f86a0d0b47de10f6113f0e4d95
MD5 fc602ee48c6a125d47ab3137726106a8
BLAKE2b-256 9dce5283add960e22b438b7dbdb772158c8a0727f7f97e755ccd5919aad0ef45

See more details on using hashes here.

Supported by

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