Skip to main content

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

Project description

Introduction

Documentation Status Discord Build Status

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 .env
source .env/bin/activate
pip3 install adafruit-circuitpython-miniesptool

Usage Example

Check the examples folder for demo sketches to upload firmware to ESP8266 and ESP32

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Documentation

For information on building library documentation, please check out this guide.

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

File details

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

File metadata

  • Download URL: adafruit-circuitpython-miniesptool-0.2.0.tar.gz
  • Upload date:
  • Size: 24.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.2

File hashes

Hashes for adafruit-circuitpython-miniesptool-0.2.0.tar.gz
Algorithm Hash digest
SHA256 451cefaa70cce6415ee9ee550f52734651168b9482670a7668c70d5c1b96165c
MD5 2cc23d5e84afce12a47d4b71aff610e8
BLAKE2b-256 65b3ee873e57ffa451bac6ebe3c0793459d40df476f18628c169c68a06fffc01

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