Merge pull request #11 from mozzwald/esp32s3

Add ESP32S3 support, Update build and bump version to 1.5

Author: mozzwald

.github/workflows/main.yml

@@ -17,15 +17,22 @@ jobs:
         run: |
           python --version
           pip --version
-      - name: Install requirements
+      - name: Update, Install & Build in virtual python environment
+        shell: pwsh
         run: |
+          python -m venv .venv
+          .\.venv\Scripts\Activate.ps1
+          python -m pip uninstall -y esptool
+          python -m pip install "esptool>=4.7"
           pip install -r requirements_build.txt
           pip install -e .
           pip install --force-reinstall -v pyinstaller==4.10
           pip install --force-reinstall -v pyinstaller-hooks-contrib==2023.2
-      - name: Run PyInstaller
-        run: |
-          python -m PyInstaller.__main__ -F -w -n FujiNet-Flasher -i icon.ico esphomeflasher\__main__.py
+          python -m PyInstaller.__main__ -F -w -n FujiNet-Flasher -i icon.ico `
+            --add-data "./.venv/lib/site-packages/esptool/targets/stub_flasher/1/*.json;esptool/targets/stub_flasher/1" `
+            --add-data "./.venv/lib/site-packages/esptool/targets/stub_flasher/2/*.json;esptool/targets/stub_flasher/2" `
+            --collect-submodules esptool `
+            esphomeflasher\__main__.py
       - uses: actions/upload-artifact@master
         with:
           name: FujiNet-Flasher_win-x64
@@ -45,15 +52,22 @@ jobs:
         run: |
           python --version
           pip --version
-      - name: Install requirements
+      - name: Update, Install & Build in virtual python environment
+        shell: pwsh
         run: |
+          python -m venv .venv
+          .\.venv\Scripts\Activate.ps1
+          python -m pip uninstall -y esptool
+          python -m pip install "esptool>=4.7"
           pip install -r requirements_build.txt
           pip install -e .
           pip install --force-reinstall -v pyinstaller==4.10
           pip install --force-reinstall -v pyinstaller-hooks-contrib==2023.2
-      - name: Run PyInstaller
-        run: |
-          python -m PyInstaller.__main__ -F -w -n FujiNet-Flasher -i icon.ico esphomeflasher\__main__.py
+          python -m PyInstaller.__main__ -F -w -n FujiNet-Flasher -i icon.ico `
+            --add-data "./.venv/lib/site-packages/esptool/targets/stub_flasher/1/*.json;esptool/targets/stub_flasher/1" `
+            --add-data "./.venv/lib/site-packages/esptool/targets/stub_flasher/2/*.json;esptool/targets/stub_flasher/2" `
+            --collect-submodules esptool `
+            esphomeflasher\__main__.py
       - name: See dist directory
         run: ls dist
       - name: Upload Artifact
@@ -82,7 +96,11 @@ jobs:
           pip install -e .
       - name: Run PyInstaller
         run: |
-          python -m PyInstaller.__main__ -F -w -n FujiNet-Flasher -i icon.ico esphomeflasher/__main__.py
+          export STUBS_DIR="$(pip show esptool | grep "Location: " | cut -c 11- | tr -d '\n')/esptool/targets/stub_flasher/"
+          python -m PyInstaller.__main__ -F -w -n FujiNet-Flasher -i icon.ico \
+            --add-data="${STUBS_DIR}/1/*.json:esptool/targets/stub_flasher/1/" \
+            --add-data="${STUBS_DIR}/2/*.json:esptool/targets/stub_flasher/2/" \
+            esphomeflasher/__main__.py
       - name: See dist directory
         run: ls dist
       - name: Upload Artifact
@@ -104,13 +122,21 @@ jobs:
         run: |
           python --version
           pip --version
-      - name: Install requirements
-        run: |
-          pip install -r requirements_build.txt
-          pip install -e .
-      - name: Run PyInstaller
-        run: |
-          python -m PyInstaller.__main__ -F -w -n FujiNet-Flasher -i icon.icns esphomeflasher/__main__.py
+      # Make sure we’re running in an isolated venv
+      - name: Update, Install & Build in virtual python environment
+        run: |
+          python -m venv .venv
+          source .venv/bin/activate
+          python -m pip install --upgrade pip
+          python -m pip uninstall -y esptool || true
+          python -m pip install "esptool>=4.7"
+          python -m pip install -r requirements_build.txt
+          export STUBS_DIR="$(pip show esptool | grep "Location: " | cut -c 11- | tr -d '\n')/esptool/targets/stub_flasher/"
+          ls -al ${STUBS_DIR}
+          python -m PyInstaller.__main__ -F -w -n FujiNet-Flasher -i icon.icns \
+            --add-data="${STUBS_DIR}/1/*.json:esptool/targets/stub_flasher/1/" \
+            --add-data="${STUBS_DIR}/2/*.json:esptool/targets/stub_flasher/2/" \
+            esphomeflasher/__main__.py
       - name: Remove Extra Binary
         run: rm dist/FujiNet-Flasher
       - name: Set binary permissions
@@ -149,13 +175,20 @@ jobs:
         run: |
           python3 --version
           pip3 --version
-      - name: Install requirements
+      - name: Update, Install & Build in virtual python environment
         run: |
+          python3 -m venv .venv
+          source .venv/bin/activate
+          pip3 install --upgrade pip
+          pip3 uninstall -y esptool || true
+          pip3 install "esptool>=4.7"
           pip3 install -r requirements_build.txt
-          pip3 install -e .
-      - name: Run PyInstaller
-        run: |
-          python3 -m PyInstaller.__main__ -F -w -n FujiNet-Flasher -i icon.icns esphomeflasher/__main__.py
+          export STUBS_DIR="$(pip3 show esptool | grep "Location: " | cut -c 11- | tr -d '\n')/esptool/targets/stub_flasher/"
+          ls -al ${STUBS_DIR}
+          python3 -m PyInstaller.__main__ -F -w -n FujiNet-Flasher -i icon.icns \
+            --add-data="${STUBS_DIR}/1/*.json:esptool/targets/stub_flasher/1/" \
+            --add-data="${STUBS_DIR}/2/*.json:esptool/targets/stub_flasher/2/" \
+            esphomeflasher/__main__.py
       - name: Remove Extra Binary
         run: rm dist/FujiNet-Flasher
       - name: Set binary permissions

README.md

@@ -1,47 +1,33 @@
-# esphomeflasher (for FujiNet)
+# FujiNet Flasher
 
-esphomeflasher is a utility app for the [esphomelib](https://esphomelib.com/esphomeyaml/index.html)
-framework and is designed to make flashing ESPs with esphomelib as simple as possible by:
+FujiNet Flasher is a utility app for [FujiNet Hardware](https://fujinet.online)
+and is designed to make flashing as simple as possible by:
 
- * Having pre-built binaries for most operating systems.
+ * Having pre-built binaries for most modern 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.
+but then it was decided that a GUI would be nice. The GUI largely is based on the 
+[NodeMCU PyFlasher](https://github.com/marcelstoer/nodemcu-pyflasher) and
+[esphomeflasher](https://github.com/esphome/esphome-flasher) projects.
 
 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/OttoWinter/esphomeflasher/releases)
+Check the [releases section](https://github.com/FujiNetWiFi/fujinet-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`
-- 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:
+If you want to build this application yourself:
 
 - 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)
+- See `build-instructions.md`
 
 ## License
 
-[MIT](http://opensource.org/licenses/MIT) © Marcel Stör, Otto Winter
+[MIT](http://opensource.org/licenses/MIT) © Marcel Stör, Otto Winter, Joe Honold

build-instructions.md

@@ -1,11 +1,32 @@
-# Linux / macOS
+# Linux / MacOS
 
- * `pip install -r requirements_build.txt`
- * `pyinstaller -F -w -n FujiNet-Flasher -i icon.icns esphomeflasher/__main__.py`
+```
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install --upgrade pip
+python -m pip uninstall -y esptool || true
+pip install -r requirements_build.txt
+export STUBS_DIR="$(pip show esptool | grep "Location: " | cut -c 11- | tr -d '\n')/esptool/targets/stub_flasher/"
+python -m PyInstaller.__main__ -F -w -n FujiNet-Flasher -i icon.icns \
+    --add-data="${STUBS_DIR}/1/*.json:esptool/targets/stub_flasher/1/" \
+    --add-data="${STUBS_DIR}/2/*.json:esptool/targets/stub_flasher/2/" \
+    esphomeflasher/__main__.py
+```
 
 # Windows
 
- * `pip install pyinstaller`
- * `pip install -r requirements_build.txt`
- * `pip install -e.`
- * `python -m PyInstaller.__main__ -F -w -n FujiNet-Flasher -i icon.ico esphomeflasher\__main__.py`
+```          
+python -m venv .venv
+.\.venv\Scripts\Activate.ps1
+python -m pip uninstall -y esptool
+python -m pip install "esptool>=4.7"
+pip install -r requirements_build.txt
+pip install -e .
+pip install --force-reinstall -v pyinstaller==4.10
+pip install --force-reinstall -v pyinstaller-hooks-contrib==2023.2
+python -m PyInstaller.__main__ -F -w -n FujiNet-Flasher -i icon.ico `
+    --add-data "./.venv/lib/site-packages/esptool/targets/stub_flasher/1/*.json;esptool/targets/stub_flasher/1" `
+    --add-data "./.venv/lib/site-packages/esptool/targets/stub_flasher/2/*.json;esptool/targets/stub_flasher/2" `
+    --collect-submodules esptool `
+    esphomeflasher\__main__.py
+```

esphomeflasher/__main__.py

@@ -12,18 +12,18 @@
 from esphomeflasher.common import fujinet_version_info, is_url
 
 import esptool
+from esptool.cmds import detect_chip
 import serial
 
 from esphomeflasher import const
 from esphomeflasher.common import ESP32ChipInfo, EsphomeflasherError, chip_run_stub, \
-    configure_write_flash_args, detect_chip, detect_flash_size, read_chip_info, \
+    configure_write_flash_args, detect_flash_size, read_chip_info, \
     read_firmware_info, check_flash_size, MockEsptoolArgs
 from esphomeflasher.const import ESP32_DEFAULT_BOOTLOADER_FORMAT, ESP32_DEFAULT_OTA_DATA, \
     ESP32_DEFAULT_PARTITIONS, ESP32_DEFAULT_FIRMWARE, ESP32_DEFAULT_SPIFFS, \
     FUJINET_VERSION_INFO, FUJINET_RELEASE_INFO
 from esphomeflasher.helpers import list_serial_ports
 
-
 # Set PYTHONUNBUFFERED environment variable to ensure unbuffered output
 os.environ["PYTHONUNBUFFERED"] = "1"
 
@@ -159,27 +159,37 @@ def run_esphomeflasher_args(args):
         else:
             raise EsphomeflasherError("Invalid release info. Missing firmware file!")
 
-        chip = detect_chip(port, force_esp32=True)
+        try:
+            chip = detect_chip(
+                port=port,
+                baud="115200",                  # Detect at slow baud
+                connect_mode="default-reset",
+                trace_enabled=False,
+                connect_attempts=7
+            )
+        except esptool.FatalError as err:
+            raise EsphomeflasherError(f"Error Detecting ESP: {err}") from err
+
+        try:
+            chip.connect('no_reset',7,False,False)
+        except esptool.FatalError as err:
+            raise EsphomeflasherError(f"Error connecting to ESP: {err}") from err
+
+        stub_chip = chip_run_stub(chip)
         info = read_chip_info(chip)
 
-        print()
-        print("Chip Info:")
-        print(" - Chip Family: {}".format(info.family))
-        print(" - Chip Model: {}".format(info.model))
         if isinstance(info, ESP32ChipInfo):
-            print(" - Number of Cores: {}".format(info.num_cores))
-            print(" - Max CPU Frequency: {}".format(info.cpu_frequency))
-            print(" - Has Bluetooth: {}".format('YES' if info.has_bluetooth else 'NO'))
-            print(" - Has Embedded Flash: {}".format('YES' if info.has_embedded_flash else 'NO'))
-            print(" - Has Factory-Calibrated ADC: {}".format(
-                'YES' if info.has_factory_calibrated_adc else 'NO'))
+            print("\nChip Info:")
+            for attr, val in vars(info).items():
+                # skip private/internal attrs
+                if attr.startswith('_'):
+                    continue
+                # pretty-up the field name
+                name = attr.replace('_', ' ').title()
+                print(f" - {name}: {val}")
         else:
             print(" - Chip ID: {:08X}".format(info.chip_id))
 
-        print(" - MAC Address: {}".format(info.mac))
-
-        stub_chip = chip_run_stub(chip)
-
         if args.upload_baud_rate != 115200:
             try:
                 stub_chip.change_baud(args.upload_baud_rate)
@@ -190,7 +200,7 @@ def run_esphomeflasher_args(args):
         if not flash_size:
             raise EsphomeflasherError("Firmware larger than chip flash, stopping!")
 
-        mock_args = MockEsptoolArgs(flash_size, addr_filename, flash_mode, flash_freq)
+        mock_args = MockEsptoolArgs(flash_size, addr_filename, flash_mode, flash_freq, chip)
 
         print(" - Flash Mode: {}".format(mock_args.flash_mode))
         print(" - Flash Frequency: {}Hz".format(mock_args.flash_freq.upper()))

esphomeflasher/common.py

@@ -18,7 +18,8 @@ class EsphomeflasherError(Exception):
 
 
 class MockEsptoolArgs(object):
-    def __init__(self, flash_size, addr_filename, flash_mode, flash_freq):
+    def __init__(self, flash_size, addr_filename, flash_mode, flash_freq, chip):
+        self.chip = chip
         self.compress = True
         self.no_compress = False
         self.flash_size = flash_size
@@ -29,7 +30,9 @@ def __init__(self, flash_size, addr_filename, flash_mode, flash_freq):
         self.verify = False
         self.erase_all = False
         self.encrypt = False
-
+        self.force = True
+        self.encrypt = False
+        self.encrypt_files = None
 
 class ChipInfo(object):
     def __init__(self, family, model, mac):
@@ -101,6 +104,16 @@ def read_chip_info(chip):
         has_factory_calibrated_adc = 'VRef calibration in efuse' in features
         return ESP32ChipInfo(model, mac, num_cores, frequency, has_bluetooth,
                              has_embedded_flash, has_factory_calibrated_adc)
+    elif isinstance(chip, esptool.ESP32S3ROM):
+        model = read_chip_property(chip.get_chip_description)
+        features = read_chip_property(chip.get_chip_features)
+        num_cores = 2 if 'Dual Core' in features else 1
+        frequency = next((x for x in ('160MHz', '240MHz') if x in features), '80MHz')
+        has_bluetooth = 'BT' in features
+        has_embedded_flash = 'Embedded Flash' in features
+        has_factory_calibrated_adc = 'VRef calibration in efuse' in features
+        return ESP32ChipInfo(model, mac, num_cores, frequency, has_bluetooth,
+                             has_embedded_flash, has_factory_calibrated_adc)
     elif isinstance(chip, esptool.ESP8266ROM):
         model = read_chip_property(chip.get_chip_description)
         chip_id = read_chip_property(chip.chip_id)
@@ -202,20 +215,3 @@ def configure_write_flash_args(info, firmware_path, flash_size,
                                bootloader_path, partitions_path,
                                otadata_path, spiffs_path):
     return 0
-
-def detect_chip(port, force_esp8266=False, force_esp32=False):
-    if force_esp8266 or force_esp32:
-        klass = esptool.ESP32ROM if force_esp32 else esptool.ESP8266ROM
-        chip = klass(port)
-    else:
-        try:
-            chip = esptool.ESPLoader.detect_chip(port)
-        except esptool.FatalError as err:
-            raise EsphomeflasherError("ESP Chip Auto-Detection failed: {}".format(err))
-
-    try:
-        chip.connect()
-    except esptool.FatalError as err:
-        raise EsphomeflasherError("Error connecting to ESP: {}".format(err))
-
-    return chip

esphomeflasher/const.py

@@ -1,6 +1,6 @@
 import re
 
-__version__ = "1.4.3"
+__version__ = "1.5.0"
 
 FUJINET_FLASHER_VERSION_URL = "https://fujinet.online/firmware/flasher-current-ver.txt"
 

requirements_build.txt

@@ -1,9 +1,9 @@
 attrdict3
 wheel
-wxpython==4.1.1
-esptool==3.0
+wxpython>=4.1.1
+esptool>=4.7
 requests>=2.24.0,<3
-pyinstaller==4.10
+pyinstaller>=4.10
 pyinstaller-hooks-contrib==2023.2
 certifi
 cryptography>=3.4.8

setup.py

@@ -23,7 +23,7 @@
 
 REQUIRES = [
     'wxpython>=4.0,<5.0',
-    'esptool==2.8',
+    'esptool>=4.7',
     'requests>=2.0,<3',
 ]