EMS-ESP-Flasher

Flash tool for uploading EMS-ESP firmware.

Based on https://github.com/Jason2866/ESP_Flasher/ version 3.0.4 with these modifications:

• uses EMS-ESP specific partitions
• added option to not erase flash and retain settings (--no-erase option)
• removed the safeboot and factory firmware options, we'll add the loader later
• removed show logs option
• update with EMS-ESP icons
• updated to from PyQt5 to PyQt6 and made the UI a little nicer
• auto CTRL-D to log into to EMS-ESP console
• update setuptools - moved to a .toml file. See https://setuptools.pypa.io/en/latest/userguide/
• note: GitHub Action build.yml uses jason2866/[email protected] instead of actions/upload-artifact@v4 because of the multi-artifact feature (actions/download-artifact#202)

Installation

If you plan to run Python in a virtual environment, either let VSC do this for you, or manually like:

python -m venv venv
source ./venv/bin/activate`

Install the library's:

pip install --upgrade build
pip install -e .

To build and test the a module for distribution (places in the dist folder):

python -m build

pip install --editable .

To run as a module, for building and testing locally:

python -m emsesp_flasher

To test the module build:

Building the platform executables

macOS

pyinstaller -F -w -n EMS-ESP-Flasher -i icon.icns emsesp_flasher/__main__.py

Will create a dist/EMS-ESP-Flasher file and *.app folder

Windows

python -m PyInstaller -F -w -n EMS-ESP-Flasher -i icon.ico emsesp_flasher\__main__.py

This will create the dist/EMS-ESP-Flasher.exe file.

If the Windows firewall blocks the .exe file, it's a false positive and you can accept/keep. See here.

Creating the installers in GitHub

The binary artifacts will only be created on a tag push. Use for example:

git tag -f v1.1.0 
git push --tags -f