Skip to content

Commit afdf80e

Browse files
committed
Bump version to v1.5, update docs
1 parent 82a258a commit afdf80e

File tree

3 files changed

+40
-33
lines changed

3 files changed

+40
-33
lines changed

README.md

Lines changed: 11 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,33 @@
1-
# esphomeflasher (for FujiNet)
1+
# FujiNet Flasher
22

3-
esphomeflasher is a utility app for the [esphomelib](https://esphomelib.com/esphomeyaml/index.html)
4-
framework and is designed to make flashing ESPs with esphomelib as simple as possible by:
3+
FujiNet Flasher is a utility app for [FujiNet Hardware](https://fujinet.online)
4+
and is designed to make flashing as simple as possible by:
55

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

1010
This project was originally intended to be a simple command-line tool,
11-
but then I decided that a GUI would be nice. As I don't like writing graphical
12-
front end code, the GUI largely is based on the
13-
[NodeMCU PyFlasher](https://github.com/marcelstoer/nodemcu-pyflasher)
14-
project.
11+
but then it was decided that a GUI would be nice. The GUI largely is based on the
12+
[NodeMCU PyFlasher](https://github.com/marcelstoer/nodemcu-pyflasher) and
13+
[esphomeflasher](https://github.com/esphome/esphome-flasher) projects.
1514

1615
The flashing process is done using the [esptool](https://github.com/espressif/esptool)
1716
library by espressif.
1817

1918
## Installation
2019

2120
It doesn't have to be installed, just double-click it and it'll start.
22-
Check the [releases section](https://github.com/OttoWinter/esphomeflasher/releases)
21+
Check the [releases section](https://github.com/FujiNetWiFi/fujinet-flasher/releases)
2322
for downloads for your platform.
2423

25-
## Installation Using `pip`
26-
27-
If you want to install this application from `pip`:
28-
29-
- Install Python 3.x
30-
- Install [wxPython 4.x](https://wxpython.org/) manually or run `pip3 install wxpython`
31-
- Install this project using `pip3 install esphomeflasher`
32-
- Start the GUI using `esphomeflasher`. Alternatively, you can use the command line interface (
33-
type `esphomeflasher -h` for info)
34-
3524
## Build it yourself
3625

37-
If you want to build this application yourself you need to:
26+
If you want to build this application yourself:
3827

3928
- Install Python 3.x
40-
- Install [wxPython 4.x](https://wxpython.org/) manually or run `pip3 install wxpython`
41-
- Download this project and run `pip3 install -e .` in the project's root.
42-
- Start the GUI using `esphomeflasher`. Alternatively, you can use the command line interface (
43-
type `esphomeflasher -h` for info)
29+
- See `build-instructions.md`
4430

4531
## License
4632

47-
[MIT](http://opensource.org/licenses/MIT) © Marcel Stör, Otto Winter
33+
[MIT](http://opensource.org/licenses/MIT) © Marcel Stör, Otto Winter, Joe Honold

build-instructions.md

Lines changed: 28 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,32 @@
1-
# Linux / macOS
1+
# Linux / MacOS
22

3-
* `pip install -r requirements_build.txt`
4-
* `pyinstaller -F -w -n FujiNet-Flasher -i icon.icns esphomeflasher/__main__.py`
3+
```
4+
python -m venv .venv
5+
source .venv/bin/activate
6+
python -m pip install --upgrade pip
7+
python -m pip uninstall -y esptool || true
8+
pip install -r requirements_build.txt
9+
export STUBS_DIR="$(pip show esptool | grep "Location: " | cut -c 11- | tr -d '\n')/esptool/targets/stub_flasher/"
10+
python -m PyInstaller.__main__ -F -w -n FujiNet-Flasher -i icon.icns \
11+
--add-data="${STUBS_DIR}/1/*.json:esptool/targets/stub_flasher/1/" \
12+
--add-data="${STUBS_DIR}/2/*.json:esptool/targets/stub_flasher/2/" \
13+
esphomeflasher/__main__.py
14+
```
515

616
# Windows
717

8-
* `pip install pyinstaller`
9-
* `pip install -r requirements_build.txt`
10-
* `pip install -e.`
11-
* `python -m PyInstaller.__main__ -F -w -n FujiNet-Flasher -i icon.ico esphomeflasher\__main__.py`
18+
```
19+
python -m venv .venv
20+
.\.venv\Scripts\Activate.ps1
21+
python -m pip uninstall -y esptool
22+
python -m pip install "esptool>=4.7"
23+
pip install -r requirements_build.txt
24+
pip install -e .
25+
pip install --force-reinstall -v pyinstaller==4.10
26+
pip install --force-reinstall -v pyinstaller-hooks-contrib==2023.2
27+
python -m PyInstaller.__main__ -F -w -n FujiNet-Flasher -i icon.ico `
28+
--add-data "./.venv/lib/site-packages/esptool/targets/stub_flasher/1/*.json;esptool/targets/stub_flasher/1" `
29+
--add-data "./.venv/lib/site-packages/esptool/targets/stub_flasher/2/*.json;esptool/targets/stub_flasher/2" `
30+
--collect-submodules esptool `
31+
esphomeflasher\__main__.py
32+
```

esphomeflasher/const.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import re
22

3-
__version__ = "1.4.3"
3+
__version__ = "1.5.0"
44

55
FUJINET_FLASHER_VERSION_URL = "https://fujinet.online/firmware/flasher-current-ver.txt"
66

0 commit comments

Comments
 (0)