Changes for 2.6 device_install (#6206)

* Changes for 2.6 device_install For #6186 Added 2 new arguments --tft and -tft-16mb Some checks are added. Before it would try to write all files to the device, if there was more than ONE littlefs-* or littlefswebui-* in the directory. Added OTA Offsets for 8 and 16mb (fix) Thanks to @caveman99 for spotting it. * The missing SET Added a missing SET. Thanks to @ThatKalle * Fix and more checks. Added Checks to make sure, that --tft and --tft-16mb can't be used with a non tft bin file. Added error messages on files not found. Removed a "ECHO" that shouldn't be there. * Fixes to device-install.sh Replace /bin/sh with /bin/bash for better string handling. Removed a SET that doesn't belong in the .sh file. Better checking for TFT and non TFT build, based on filename. Corrected a mix of TAB & SPACE indent. * Update device-install.bat Corrected a mix of TAB & SPACE indent. * Update device-install.bat Double ELSE block at the end of file, one removed. * Update device-install.bat Added more reliable method to display the scripts own name in help menu. Fixed case sensitive options -p and -P Added some VAR cleanup. Changed the detect method on BLEOTA. Changed some wording. --------- Co-authored-by: Ben Meadors <benmmeadors@gmail.com>
2025-03-05 13:07:26 -06:00
parent f0f2cd0e0e
commit ede3f7b702
2 changed files with 226 additions and 82 deletions
@@ -1,7 +1,12 @@
@ECHO OFF
-
-set PYTHON=python
-set WEB_APP=0
+SETLOCAL EnableDelayedExpansion
+set "SCRIPTNAME=%~nx0"
+set "PYTHON=python"
+set "WEB_APP=0"
+set "TFT8=0"
+set "TFT16=0"
+SET "TFT_BUILD=0"
+SET "DO_SPECIAL_OTA=0"

 :: Determine the correct esptool command to use
 where esptool >nul 2>&1
@@ -13,7 +18,7 @@ if %ERRORLEVEL% EQU 0 (

 goto GETOPTS
 :HELP
-echo Usage: %~nx0 [-h] [-p ESPTOOL_PORT] [-P PYTHON] [-f FILENAME^|FILENAME] [--web]
+echo Usage: %SCRIPTNAME% [-h] [-p ESPTOOL_PORT] [-P PYTHON] [-f FILENAME] [--web] [--tft] [--tft-16mb]
 echo Flash image file to device, but first erasing and writing system information
 echo.
 echo     -h               Display this help and exit
@@ -21,52 +26,124 @@ echo     -p ESPTOOL_PORT  Set the environment variable for ESPTOOL_PORT.  If not
 echo     -P PYTHON        Specify alternate python interpreter to use to invoke esptool. (Default: %PYTHON%)
 echo     -f FILENAME      The .bin file to flash.  Custom to your device type and region.
 echo     --web            Flash WEB APP.
+echo     --tft            Flash MUI 8mb
+echo     --tft-16mb       Flash MUI 16mb
 goto EOF

 :GETOPTS
-if /I "%1"=="-h" goto HELP
-if /I "%1"=="--help" goto HELP
-if /I "%1"=="-F" set "FILENAME=%2" & SHIFT
-if /I "%1"=="-p" set ESPTOOL_PORT=%2 & SHIFT
-if /I "%1"=="-P" set PYTHON=%2 & SHIFT
-if /I "%1"=="--web" set WEB_APP=1 & SHIFT
+if /I "%~1"=="-h" goto HELP & exit /b
+if /I "%~1"=="--help" goto HELP & exit /b
+if "%~1"=="-p" set "ESPTOOL_PORT=%~2" & SHIFT & SHIFT & goto GETOPTS
+if "%~1"=="-P" set "PYTHON=%~2" & SHIFT & SHIFT & goto GETOPTS
+if /I "%~1"=="-f" set "FILENAME=%~2" & SHIFT & SHIFT & goto GETOPTS
+if /I "%~1"=="--web" set "WEB_APP=1" & SHIFT & goto GETOPTS
+if /I "%~1"=="--tft" set "TFT8=1" & SHIFT & goto GETOPTS
+if /I "%~1"=="--tft-16mb" set "TFT16=1" & SHIFT & goto GETOPTS
 SHIFT
-IF NOT "__%1__"=="____" goto GETOPTS
+IF NOT "%~1"=="" goto GETOPTS

 IF "__%FILENAME%__" == "____" (
    echo "Missing FILENAME"
    goto HELP
 )
+
+:: Check if FILENAME contains "-tft-" and either TFT8 or TFT16 is 1 (--tft, -tft-16mb)
+IF NOT "%FILENAME:-tft-=%"=="%FILENAME%" (
+    SET "TFT_BUILD=1"
+    IF NOT "%TFT8%"=="1" IF NOT "%TFT16%"=="1" (
+        echo Error: Either --tft or --tft-16mb must be set to use a TFT build.
+        goto EOF
+    )
+    IF "%TFT8%"=="1" IF "%TFT16%"=="1" (
+        echo Error: Both --tft and --tft-16mb must NOT be set at the same time.
+        goto EOF
+    )
+)
+
+:: Extract BASENAME from %FILENAME% for later use.
+SET BASENAME=%FILENAME:firmware-=%
+
 IF EXIST %FILENAME% IF x%FILENAME:update=%==x%FILENAME% (
+    @REM Default littlefs* offset (--web).
+    SET "OFFSET=0x300000"
+
+    @REM Default OTA Offset
+    SET "OTA_OFFSET=0x260000"
+
+    @REM littlefs* offset for MUI 8mb (--tft) and OTA OFFSET.
+    IF "%TFT8%"=="1" IF "%TFT_BUILD%"=="1" (
+        SET "OFFSET=0x670000"
+        SET "OTA_OFFSET=0x340000"
+    ) else (
+        echo Ignoring --tft, not a TFT Build.
+    )
+
+    @REM littlefs* offset for MUI 16mb (--tft-16mb) and OTA OFFSET.
+    IF "%TFT16%"=="1" IF "%TFT_BUILD%"=="1" (
+        SET "OFFSET=0xc90000"
+        SET "OTA_OFFSET=0x650000"
+    ) else (
+        echo Ignoring --tft-16mb, not a TFT Build.
+    )
+
    echo Trying to flash update %FILENAME%, but first erasing and writing system information"
    %ESPTOOL_CMD% --baud 115200 erase_flash
-    %ESPTOOL_CMD% --baud 115200 write_flash 0x00 %FILENAME%
-    
+    %ESPTOOL_CMD% --baud 115200 write_flash 0x00 "%FILENAME%"
+
    @REM Account for S3 and C3 board's different OTA partition
-    IF x%FILENAME:s3=%==x%FILENAME% IF x%FILENAME:v3=%==x%FILENAME% IF x%FILENAME:t-deck=%==x%FILENAME% IF x%FILENAME:wireless-paper=%==x%FILENAME% IF x%FILENAME:wireless-tracker=%==x%FILENAME% IF x%FILENAME:station-g2=%==x%FILENAME% IF x%FILENAME:unphone=%==x%FILENAME% (
-        IF x%FILENAME:esp32c3=%==x%FILENAME% (
-            %ESPTOOL_CMD% --baud 115200 write_flash 0x260000 bleota.bin
+    IF NOT "%FILENAME%"=="%FILENAME:s3=%" SET "DO_SPECIAL_OTA=1"
+    IF NOT "%FILENAME%"=="%FILENAME:v3=%" SET "DO_SPECIAL_OTA=1"
+    IF NOT "%FILENAME%"=="%FILENAME:t-deck=%" SET "DO_SPECIAL_OTA=1"
+    IF NOT "%FILENAME%"=="%FILENAME:wireless-paper=%" SET "DO_SPECIAL_OTA=1"
+    IF NOT "%FILENAME%"=="%FILENAME:wireless-tracker=%" SET "DO_SPECIAL_OTA=1"
+    IF NOT "%FILENAME%"=="%FILENAME:station-g2=%" SET "DO_SPECIAL_OTA=1"
+    IF NOT "%FILENAME%"=="%FILENAME:unphone=%" SET "DO_SPECIAL_OTA=1"
+    IF NOT "%FILENAME%"=="%FILENAME:esp32c3=%" SET "DO_SPECIAL_OTA=1"
+
+    IF "!DO_SPECIAL_OTA!"=="1" (
+        IF NOT "%FILENAME%"=="%FILENAME:esp32c3=%" (
+            %ESPTOOL_CMD% --baud 115200 write_flash !OTA_OFFSET! bleota-c3.bin
+        ) ELSE (
+            %ESPTOOL_CMD% --baud 115200 write_flash !OTA_OFFSET! bleota-s3.bin
+        )
+    ) ELSE (
+        %ESPTOOL_CMD% --baud 115200 write_flash !OTA_OFFSET! bleota.bin
+    )
+
+    @REM Check if WEB_APP (--web) is enabled and add "littlefswebui-" to BASENAME else "littlefs-".
+    IF "%WEB_APP%"=="1" (
+        @REM Check it the file exist before trying to write it.
+        IF EXIST "littlefswebui-%BASENAME%" (
+            %ESPTOOL_CMD% --baud 115200 write_flash !OFFSET! "littlefswebui-%BASENAME%"
        ) else (
-            %ESPTOOL_CMD% --baud 115200 write_flash 0x260000 bleota-c3.bin
+            echo Error: file "littlefswebui-%BASENAME%" wasn't found, littlefswebui not written.
+            goto EOF
        )
    ) else (
-        %ESPTOOL_CMD% --baud 115200 write_flash 0x260000 bleota-s3.bin
-    )
-    IF %WEB_APP%==1 (
-        for %%f in (littlefswebui-*.bin) do (
-            %ESPTOOL_CMD% --baud 115200 write_flash 0x300000 %%f
-        )
-    ) else (
-        for %%f in (littlefs-*.bin) do (
-            %ESPTOOL_CMD% --baud 115200 write_flash 0x300000 %%f
+        @REM Check it the file exist before trying to write it.
+        IF EXIST "littlefs-%BASENAME%" (
+            %ESPTOOL_CMD% --baud 115200 write_flash !OFFSET! "littlefs-%BASENAME%"
+        ) else (
+            echo Error: file "littlefs-%BASENAME%" wasn't found, littlefs not written.
+            goto EOF
        )
    )
 ) else (
    echo "Invalid file: %FILENAME%"
    goto HELP
-) else (
-    echo "Invalid file: %FILENAME%"
-    goto HELP
 )

 :EOF
+@REM Cleanup vars.
+SET "SCRIPTNAME="
+SET "PYTHON="
+SET "WEB_APP="
+SET "TFT8="
+Set "TFT16="
+SET "OFFSET="
+SET "OTA_OFFSET="
+SET "DO_SPECIAL_OTA="
+SET "FILENAME="
+SET "BASENAME="
+endlocal
+exit /b 0