mirror of https://github.com/esphome/esphome-flasher.git synced 2024-11-21 11:45:23 +01:00

Simple GUI tool to flash ESPs over USB

Go to file

Jesse Hills df4b36d80a Update README.md		2023-07-04 11:40:01 +12:00
.github	Bump actions/cache from 2 to 3.0.1 (#118 )	2022-04-04 19:37:50 +02:00
esphomeflasher	Bump version to 1.4.0	2021-10-29 12:50:12 +02:00
.gitignore	gitignore vscode	2021-10-29 12:49:46 +02:00
build-instructions.md	Add build instructions	2019-06-09 16:14:52 +02:00
icon.icns	Add build instructions	2019-06-09 16:14:52 +02:00
icon.ico	Add build instructions	2019-06-09 16:14:52 +02:00
LICENSE	Initial commit	2018-11-07 21:24:25 +01:00
MANIFEST.in	Update build system (#24 )	2020-07-30 13:26:27 +02:00
partitions.bin	Update partitions (#67 )	2021-10-29 10:54:14 +02:00
pyproject.toml	Add python linting (#80 )	2021-10-29 12:48:46 +02:00
README.md	Update README.md	2023-07-04 11:40:01 +12:00
requirements_build.txt	Bump pyinstaller from 3.6 to 4.5.1 (#72 )	2021-10-29 11:12:47 +02:00
requirements_test.txt	Bump pylint from 2.12.2 to 2.13.4 (#119 )	2022-04-04 19:28:25 +02:00
requirements.txt	Bump requests from 2.24.0 to 2.26.0 (#81 )	2021-10-29 12:43:49 +02:00
setup.cfg	Add python linting (#80 )	2021-10-29 12:48:46 +02:00
setup.py	Bump python for assets to 3.9 (#79 )	2021-10-29 12:39:15 +02:00

README.md

Deprecated

This project is deprecated in favour of browser based flashing with ESP Web Tools. For example: https://web.esphome.io

ESPHome-Flasher

ESPHome-Flasher is a utility app for the ESPHome framework and is designed to make flashing ESPs with ESPHome as simple as possible by:

Having pre-built binaries for most operating systems.
Hiding all non-essential options for flashing. All necessary options for flashing (bootloader, flash mode) are automatically extracted from the binary.

This project was originally intended to be a simple command-line tool, but then I decided that a GUI would be nice. As I don't like writing graphical front end code, the GUI largely is based on the NodeMCU PyFlasher project.

The flashing process is done using the esptool library by espressif.

Installation

It doesn't have to be installed, just double-click it and it'll start. Check the releases section for downloads for your platform.

Installation Using `pip`

If you want to install this application from pip:

Install Python 3.x
Install wxPython 4.x manually or run pip3 install wxpython (see also linux notes below)
Install this project using pip3 install esphomeflasher
Start the GUI using esphomeflasher. Alternatively, you can use the command line interface ( type esphomeflasher -h for info)

Build it yourself

If you want to build this application yourself you need to:

Install Python 3.x
Install wxPython 4.x manually or run pip3 install wxpython
Download this project and run pip3 install -e . in the project's root.
Start the GUI using esphomeflasher. Alternatively, you can use the command line interface ( type esphomeflasher -h for info)

Linux Notes

Installing wxpython for linux can be a bit challenging (especially when you don't want to install from source). You can use the following command to install a wxpython suitable with your OS:

# Go to https://extras.wxpython.org/wxPython4/extras/linux/gtk3/ and select the correct OS type
# here, we assume ubuntu 18.03 bionic
pip3 install -U \
    -f https://extras.wxpython.org/wxPython4/extras/linux/gtk3/ubuntu-18.04 \
    wxPython