Skip to content

espressif/esptool-legacy-flasher-stub

Repository files navigation

esptool-legacy-flasher-stub

This project is based on the original flasher stub of esptool. It will be deprecated in the near future. It is not advised to base projects on it because it won't receive official support from Espressif Systems. The new and supported flasher stub will be the esp-flasher-stub project.

How To Use

  1. Install esptool in development mode.
  2. Obtain the flasher stub binaries as JSON files either from the releases page or from the artifacts of your pull request.
  3. Replace the esptool's JSONs files in the esptool/targets/stub_flasher directory with the obtained JSON files.

Issue Tracker

Please report issues in the esptool repository if you encounter any.

About

This flasher stub was initially part of the esptool project.

Contributing

Please install the pre-commit hooks to ensure that your commits are properly formatted:

pip install pre-commit
pre-commit install -t pre-commit -t commit-msg

How To Release (For Maintainers Only)

pip install commitizen
git fetch
git checkout -b update/release_v1.1.0
git reset --hard origin/master
cz bump
git push -u
git push --tags

Create a pull request and edit the automatically created draft release notes.

License

This document and the attached source code are released as Free Software under GNU General Public License Version 2 or later. See the accompanying LICENSE file for a copy.