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.18.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-miniesptool-0.2.18.tar.gz
Algorithm Hash digest
SHA256 4c7759eb3bfb58acdf91a99f7190490d07cdbdd4037ea304c55c7224fc1eb2ab
MD5 5da9268ff94f86c2ab52be0eb69afd3d
BLAKE2b-256 2fbb31a352152fae9fe8b2e7f71a25c00bfc1f6d75d9f61fff2ed406ccc2c4f6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_miniesptool-0.2.18-py3-none-any.whl
Algorithm Hash digest
SHA256 498dd1b3f6b72c730e14a4228ad3442826f5dd9b2e494f043cc612e5753e3f7c
MD5 3487e942b35559498889d742b1875403
BLAKE2b-256 6f33fc6ef639e713de90fbe8922f9492a4fa36641ba028c4e676f8f8da27c919

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