mirror of https://github.com/esphome/esphome-flasher.git synced 2024-11-16 10:55:31 +01:00

Simple GUI tool to flash ESPs over USB

Go to file

Marcel Stör 76814d7467 Add PayPal image to About dialog		2017-04-16 21:13:15 +02:00
images	Add PayPal image to About dialog	2017-04-16 21:13:15 +02:00
.gitignore	Allow .spec files in repo again	2017-01-07 22:46:27 +01:00
About.py	Add PayPal image to About dialog	2017-04-16 21:13:15 +02:00
build-on-mac.spec	Add support for self-contained bundle build for macOS and Windows	2017-01-07 22:49:32 +01:00
build-on-win.spec	Add support for self-contained bundle build for macOS and Windows	2017-01-07 22:49:32 +01:00
build.bat	Add support for self-contained bundle build for macOS and Windows	2017-01-07 22:49:32 +01:00
build.sh	Add support for self-contained bundle build for macOS and Windows	2017-01-07 22:49:32 +01:00
encode-bitmaps.py	Inception	2016-12-28 23:52:35 +01:00
esptool-py-why-here.txt	Change PyInstaller setup	2016-12-31 00:17:59 +01:00
esptool.py	Upgrade esptool.py to v1.3	2017-01-10 22:49:26 +01:00
images.py	Inception	2016-12-28 23:52:35 +01:00
LICENSE	Initial commit	2016-12-28 23:30:26 +01:00
Main.py	Add PayPal image to About dialog	2017-04-16 21:13:15 +02:00
nodemcu-pyflasher.py	Inception	2016-12-28 23:52:35 +01:00
README.md	Fix badge title	2017-04-16 20:53:00 +02:00

README.md

NodeMCU PyFlasher

Self-contained NodeMCU flasher with GUI based on esptool.py and wxPython.

Status

Check the releases section for progress and downloadable binaries for your platform. Scan the list of open issues for bugs and pending features.

Due to pyinstaller/pyinstaller#2355 I can't provide an app bundle for macOS yet. The PyInstaller .spec file and the build script are ready, though.

Note

This is my first Python project. If you have constructive feedback as for how to improve the code please do reach out to me.

Why this project exists

Motivation

This addresses an issue the NodeMCU community touched on several times in the past, most recently at #1500 (comment).

I stated that based on my experience doing NodeMCU user support it should be a lot simpler to flash NodeMCU for Windows users.

A number of flashing tools are available but only two are actively maintained: esptool-ck and esptool.py. Only one is endorsed by Espressif: esptool.py (they hired the developer(s)).
70% of the users of my nodemcu-build.com service are on Windows.
BUT Windows doesn't come with Python installed - which is required for esptool.py.
BUT Windows users in general are more reluctant to use the CLI than Linux/Mac users - which is required for esptool.py.

To conclude: this is not a comfortable situation for NodeMCU's largest user group.

The plan

For quite a while I planned to write a self-contained GUI tool which would use esptool.py in the background. It should primarily target Windows users but since I'm on Mac it should be cross-platform. Even though I had never used Python before I felt confident to pull this off.

Implementation

Uses the cross-platform wxPython GUI framework. I also tried PyForms/PyQt4 but settled for wxPython.
Requires absolutely minimal user input.
The esptool.py "console" output is redirected to text control on the GUI.
Uses PyInstaller to create self-contained executable for Windows and Mac. The packaged app can run standalone i.e. without installing itself, a Python interpreter or any modules.