https://github.com/esphome/esphome-flasher
Simple GUI tool to flash ESPs over USB
https://github.com/esphome/esphome-flasher
esp32 esp8266 python wxpython
Last synced: 5 months ago
JSON representation
Simple GUI tool to flash ESPs over USB
- Host: GitHub
- URL: https://github.com/esphome/esphome-flasher
- Owner: esphome
- License: mit
- Archived: true
- Fork: true (marcelstoer/nodemcu-pyflasher)
- Created: 2018-11-07T20:07:48.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2023-07-03T23:40:01.000Z (almost 2 years ago)
- Last Synced: 2024-12-14T15:48:24.150Z (6 months ago)
- Topics: esp32, esp8266, python, wxpython
- Language: Python
- Homepage: https://esphome.io/
- Size: 2.32 MB
- Stars: 858
- Watchers: 33
- Forks: 133
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Deprecated
This project is deprecated in favour of browser based flashing with [ESP Web Tools](https://github.com/esphome/esp-web-tools). For example: https://web.esphome.io
# ESPHome-Flasher
ESPHome-Flasher is a utility app for the [ESPHome](https://esphome.io/)
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](https://github.com/marcelstoer/nodemcu-pyflasher)
project.
The flashing process is done using the [esptool](https://github.com/espressif/esptool)
library by espressif.
## Installation
It doesn't have to be installed, just double-click it and it'll start.
Check the [releases section](https://github.com/esphome/esphome-flasher/releases)
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](https://wxpython.org/) 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](https://wxpython.org/) 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:
```bash
# 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
```
## License
[MIT](http://opensource.org/licenses/MIT) © Marcel Stör, Otto Winter