Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-miniesptool/badge/?version=latest
:target: https://docs.circuitpython.org/projects/miniesptool/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_miniesptool/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_miniesptool/actions/
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: 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:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
Installing from PyPI
--------------------
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-miniesptool/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-miniesptool
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-miniesptool
To install in a virtual environment in your current project:
.. code-block:: shell
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 <https://docs.circuitpython.org/projects/miniesptool/en/latest/>`_.
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_miniesptool/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-miniesptool",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, miniesptool, esp8266, esp32, esp, software, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/8d/9c/9b8adb9b0d5e86bfe3a33007ac7f92c87e9bb5ce9044a16b26353762a223/adafruit_circuitpython_miniesptool-0.2.21.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-miniesptool/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/miniesptool/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_miniesptool/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_miniesptool/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nROM loader for ESP chips, works with ESP8266 or ESP32.\nThis is a 'no-stub' loader, so you can't read MD5 or firmware back on ESP8266.\n\nSee this document for protocol we're implementing:\nhttps://github.com/espressif/esptool/wiki/Serial-Protocol\n\nSee this for the 'original' code we're miniaturizing:\nhttps://github.com/espressif/esptool/blob/master/esptool.py\n\nThere's a very basic Arduino ROM loader here for ESP32:\nhttps://github.com/arduino-libraries/WiFiNINA/tree/master/examples/Tools/FirmwareUpdater\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n--------------------\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-miniesptool/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-miniesptool\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-miniesptool\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-miniesptool\n\nUsage Example\n=============\n\nCheck the examples folder for demo sketches to upload firmware to ESP8266 and ESP32\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/miniesptool/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_miniesptool/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython ROM loader for ESP chips, works with ESP8266 or ESP32.",
"version": "0.2.21",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_miniesptool"
},
"split_keywords": [
"adafruit",
" miniesptool",
" esp8266",
" esp32",
" esp",
" software",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "903f8769e4649afd9dc52901f5ed706224706b4756423abfa91cedf409c7af55",
"md5": "4fe0b5773dd15e5f70278c12a6273e17",
"sha256": "2ea254edefabfd6844af66e643c2a598ff33daac7b403f52c26d2200aece1504"
},
"downloads": -1,
"filename": "adafruit_circuitpython_miniesptool-0.2.21-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4fe0b5773dd15e5f70278c12a6273e17",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8964,
"upload_time": "2024-10-07T22:31:49",
"upload_time_iso_8601": "2024-10-07T22:31:49.932491Z",
"url": "https://files.pythonhosted.org/packages/90/3f/8769e4649afd9dc52901f5ed706224706b4756423abfa91cedf409c7af55/adafruit_circuitpython_miniesptool-0.2.21-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8d9c9b8adb9b0d5e86bfe3a33007ac7f92c87e9bb5ce9044a16b26353762a223",
"md5": "aee482a94d021d43bccdd2c0e16c8669",
"sha256": "27f046d1c48b338ab3f69c6ed9f173090d3847347a7fe9a209c4e75ebda0675a"
},
"downloads": -1,
"filename": "adafruit_circuitpython_miniesptool-0.2.21.tar.gz",
"has_sig": false,
"md5_digest": "aee482a94d021d43bccdd2c0e16c8669",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 31185,
"upload_time": "2024-10-07T22:31:50",
"upload_time_iso_8601": "2024-10-07T22:31:50.837897Z",
"url": "https://files.pythonhosted.org/packages/8d/9c/9b8adb9b0d5e86bfe3a33007ac7f92c87e9bb5ce9044a16b26353762a223/adafruit_circuitpython_miniesptool-0.2.21.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:31:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_miniesptool",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-miniesptool"
}
JSON
