Skip to main content

Introduction

Documentation Status Discord Build Status Code Style: Ruff

ROM loader for ESP chips, works with ESP8266, ESP32, or ESP32-C6. 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, ESP32, and ESP32-C6.

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.

Metadata

Release files for adafruit-circuitpython-miniesptool 0.2.28

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for adafruit-circuitpython-miniesptool 0.2.28
File Size Uploaded
adafruit_circuitpython_miniesptool-0.2.28.tar.gz 28.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for adafruit-circuitpython-miniesptool 0.2.28
File Interpreter ABI Platform
adafruit_circuitpython_miniesptool-0.2.28-py3-none-any.whl Python 3 none any Details

Total release size: 37.7 kB

Release files / adafruit_circuitpython_miniesptool-0.2.28.tar.gz

Download URL adafruit_circuitpython_miniesptool-0.2.28.tar.gz
Size 28.5 kB
Tags Source
SHA-256 checksum
How to use checksums
de5ccffa092ed7ff59bc477c0d74974578e0eab374153083a40c530e7ee22a4e
BLAKE2b-256 checksum
How to use checksums
efddd2ec2f23ea5fa6630adaa0af41b4ef9d59a27efe9273c010fe30fb74a893
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Release files / adafruit_circuitpython_miniesptool-0.2.28-py3-none-any.whl

Download URL adafruit_circuitpython_miniesptool-0.2.28-py3-none-any.whl
Size 9.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cf239fadbf7dfd9ce2d09456cd8225e38deccec198efc8b489ef41c167cdd59c
BLAKE2b-256 checksum
How to use checksums
11f12c18bc06615dbe1aa5397f79fb11f6a44bbe90e13404739e25ddbd864d1e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Release history Release notifications | RSS feed

This release

0.2.28 This release

2 release files

0.2.27

2 release files

0.2.25

2 release files

0.2.24

2 release files

0.2.23

2 release files

0.2.22

2 release files

0.2.19

2 release files

0.2.18

2 release files

0.2.17

2 release files

0.2.16

2 release files

0.2.14

1 release file

0.2.13

1 release file

0.2.12

1 release file

0.2.11

1 release file

0.2.10

1 release file

0.2.9

1 release file

0.2.8

1 release file

0.2.7

1 release file

0.2.6

1 release file

0.2.5

1 release file

0.2.4

1 release file

0.2.3

1 release file

0.2.2

1 release file

0.2.1

1 release file

0.2.0

1 release file

0.1.6

1 release file

0.1.5

1 release file

0.1.3

1 release file

0.1.2

1 release file

0.1.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page