Add --1200bps-reset param to device-install/update scripts (#6752)

* add change-mode support

* add change-mode support

* tab to space

* fix if check

* change param name to 1200bps-reset

* update help section

* missed one in help seciton

---------

Co-authored-by: Ben Meadors <[email protected]>

Author: ThatKalle

bin/device-install.bat

@@ -12,6 +12,7 @@ SET "BIGDB16=0"
 SET "ESPTOOL_BAUD=115200"
 SET "ESPTOOL_CMD="
 SET "LOGCOUNTER=0"
+SET "BPS_RESET=0"
 
 @REM FIXME: Determine mcu from PlatformIO variant, this is unmaintainable.
 SET "S3=s3 v3 t-deck wireless-paper wireless-tracker station-g2 unphone"
@@ -24,7 +25,7 @@ GOTO getopts
 :help
 ECHO Flash image file to device, but first erasing and writing system information.
 ECHO.
-ECHO Usage: %SCRIPT_NAME% -f filename [-p PORT] [-P python] (--web)
+ECHO Usage: %SCRIPT_NAME% -f filename [-p PORT] [-P python] (--web) [--1200bps-reset]
 ECHO.
 ECHO Options:
 ECHO     -f filename      The firmware .bin file to flash.  Custom to your device type and region. (required)
@@ -35,13 +36,16 @@ ECHO     -P python        Specify alternate python interpreter to use to invoke
 ECHO                      If supplied the script will use python.
 ECHO                      If not supplied the script will try to find esptool in Path.
 ECHO     --web            Enable WebUI. (default: false)
+ECHO     --1200bps-reset  Attempt to place the device in correct mode. (1200bps Reset)
+ECHO                      Some hardware requires this twice.
 ECHO.
+ECHO Example: %SCRIPT_NAME% -p COM17 --1200bps-reset
 ECHO Example: %SCRIPT_NAME% -f firmware-t-deck-tft-2.6.0.0b106d4.bin -p COM11
 ECHO Example: %SCRIPT_NAME% -f firmware-unphone-2.6.0.0b106d4.bin -p COM11 --web
 GOTO eof
 
 :version
-ECHO %SCRIPT_NAME% [Version 2.6.1]
+ECHO %SCRIPT_NAME% [Version 2.6.2]
 ECHO Meshtastic
 GOTO eof
 
@@ -58,10 +62,13 @@ IF "%~1"=="-p" SET "ESPTOOL_PORT=%~2" & SHIFT
 IF /I "%~1"=="--port" SET "ESPTOOL_PORT=%~2" & SHIFT
 IF "%~1"=="-P" SET "PYTHON=%~2" & SHIFT
 IF /I "%~1"=="--web" SET "WEB_APP=1"
+IF /I "%~1"=="--1200bps-reset" SET "BPS_RESET=1"
 SHIFT
 GOTO getopts
 :endopts
 
+IF %BPS_RESET% EQU 1 GOTO skip-filename
+
 CALL :LOG_MESSAGE DEBUG "Checking FILENAME parameter..."
 IF "__!FILENAME!__"=="____" (
     CALL :LOG_MESSAGE DEBUG "Missing -f filename input."
@@ -95,6 +102,9 @@ IF NOT "!FILENAME:update=!"=="!FILENAME!" (
     CALL :LOG_MESSAGE DEBUG "We are NOT working with a *update* file. !FILENAME!"
 )
 
+:skip-filename
+SET "ESPTOOL_BAUD=1200"
+
 CALL :LOG_MESSAGE DEBUG "Determine the correct esptool command to use..."
 IF NOT "__%PYTHON%__"=="____" (
     SET "ESPTOOL_CMD=!PYTHON! -m esptool"
@@ -133,6 +143,12 @@ IF "__!ESPTOOL_PORT!__" == "____" (
 )
 CALL :LOG_MESSAGE INFO "Using esptool baud: !ESPTOOL_BAUD!."
 
+IF %BPS_RESET% EQU 1 (
+    @REM Attempt to change mode via 1200bps Reset.
+    CALL :RUN_ESPTOOL !ESPTOOL_BAUD! --after no_reset read_flash_status
+    GOTO eof
+)
+
 @REM Check if FILENAME contains "-tft-" and set target partitionScheme accordingly.
 @REM https://github.com/meshtastic/web-flasher/blob/main/types/resources.ts#L3
 IF NOT "!FILENAME:-tft-=!"=="!FILENAME!" (
@@ -254,6 +270,7 @@ EXIT /B %ERRORLEVEL%
 IF %DEBUG% EQU 1 CALL :LOG_MESSAGE DEBUG "About to run command: !ESPTOOL_CMD! --baud %~1 %~2 %~3 %~4"
 CALL :RESET_ERROR
 !ESPTOOL_CMD! --baud %~1 %~2 %~3 %~4
+IF %BPS_RESET% EQU 1 GOTO :eof
 IF %ERRORLEVEL% NEQ 0 (
     CALL :LOG_MESSAGE ERROR "Error running command: !ESPTOOL_CMD! --baud %~1 %~2 %~3 %~4"
     EXIT /B %ERRORLEVEL%

bin/device-install.sh

@@ -2,6 +2,7 @@
 
 PYTHON=${PYTHON:-$(which python3 python | head -n 1)}
 WEB_APP=false
+BPS_RESET=false
 TFT_BUILD=false
 MCU=""
 
@@ -72,14 +73,15 @@ set -e
 # Usage info
 show_help() {
 	cat <<EOF
-Usage: $(basename $0) [-h] [-p ESPTOOL_PORT] [-P PYTHON] [-f FILENAME] [--web]
+Usage: $(basename $0) [-h] [-p ESPTOOL_PORT] [-P PYTHON] [-f FILENAME] [--web] [--1200bps-reset]
 Flash image file to device, but first erasing and writing system information.
 
     -h               Display this help and exit.
     -p ESPTOOL_PORT  Set the environment variable for ESPTOOL_PORT.  If not set, ESPTOOL iterates all ports (Dangerous).
     -P PYTHON        Specify alternate python interpreter to use to invoke esptool. (Default: "$PYTHON")
     -f FILENAME      The firmware .bin file to flash.  Custom to your device type and region.
     --web            Enable WebUI. (Default: false)
+    --1200bps-reset  Attempt to place the device in correct mode. Some hardware requires this twice. (1200bps Reset)
 
 EOF
 }
@@ -105,6 +107,9 @@ while [ $# -gt 0 ]; do
 	--web)
 		WEB_APP=true
 		;;
+	--1200bps-reset)
+		BPS_RESET=true
+		;;
 	--) # Stop parsing options
 		shift
 		break
@@ -117,6 +122,11 @@ while [ $# -gt 0 ]; do
 	shift # Move to the next argument
 done
 
+if [[ $BPS_RESET == true ]]; then
+	$ESPTOOL_CMD --baud 1200 --after no_reset read_flash_status
+	exit 0
+fi
+
 [ -z "$FILENAME" -a -n "$1" ] && {
 	FILENAME=$1
 	shift

bin/device-update.bat

@@ -8,12 +8,13 @@ SET "PYTHON="
 SET "ESPTOOL_BAUD=115200"
 SET "ESPTOOL_CMD="
 SET "LOGCOUNTER=0"
+SET "CHANGE_MODE=0"
 
 GOTO getopts
 :help
 ECHO Flash image file to device, but leave existing system intact.
 ECHO.
-ECHO Usage: %SCRIPT_NAME% -f filename [-p PORT] [-P python]
+ECHO Usage: %SCRIPT_NAME% -f filename [-p PORT] [-P python] [--change-mode]
 ECHO.
 ECHO Options:
 ECHO     -f filename      The update .bin file to flash.  Custom to your device type and region. (required)
@@ -23,12 +24,15 @@ ECHO                      If not set, ESPTOOL iterates all ports (Dangerous).
 ECHO     -P python        Specify alternate python interpreter to use to invoke esptool. (default: python)
 ECHO                      If supplied the script will use python.
 ECHO                      If not supplied the script will try to find esptool in Path.
+ECHO     --change-mode    Attempt to place the device in correct mode. (1200bps Reset)
+ECHO                      Some hardware requires this twice.
 ECHO.
+ECHO Example: %SCRIPT_NAME% -p COM17 --change-mode
 ECHO Example: %SCRIPT_NAME% -f firmware-t-deck-tft-2.6.0.0b106d4-update.bin -p COM11
 GOTO eof
 
 :version
-ECHO %SCRIPT_NAME% [Version 2.6.1]
+ECHO %SCRIPT_NAME% [Version 2.6.2]
 ECHO Meshtastic
 GOTO eof
 
@@ -44,10 +48,13 @@ IF /I "%~1"=="-f" SET "FILENAME=%~2" & SHIFT
 IF "%~1"=="-p" SET "ESPTOOL_PORT=%~2" & SHIFT
 IF /I "%~1"=="--port" SET "ESPTOOL_PORT=%~2" & SHIFT
 IF "%~1"=="-P" SET "PYTHON=%~2" & SHIFT
+IF /I "%~1"=="--change-mode" SET "CHANGE_MODE=1"
 SHIFT
 GOTO getopts
 :endopts
 
+IF %CHANGE_MODE% EQU 1 GOTO skip-filename
+
 CALL :LOG_MESSAGE DEBUG "Checking FILENAME parameter..."
 IF "__!FILENAME!__"=="____" (
     CALL :LOG_MESSAGE DEBUG "Missing -f filename input."
@@ -77,6 +84,9 @@ IF "!FILENAME:update=!"=="!FILENAME!" (
     CALL :LOG_MESSAGE DEBUG "We are working with a *update* file. !FILENAME!"
 )
 
+:skip-filename
+SET "ESPTOOL_BAUD=1200"
+
 CALL :LOG_MESSAGE DEBUG "Determine the correct esptool command to use..."
 IF NOT "__%PYTHON%__"=="____" (
     SET "ESPTOOL_CMD=!PYTHON! -m esptool"
@@ -115,6 +125,12 @@ IF "__!ESPTOOL_PORT!__" == "____" (
 )
 CALL :LOG_MESSAGE INFO "Using esptool baud: !ESPTOOL_BAUD!."
 
+IF %CHANGE_MODE% EQU 1 (
+    @REM Attempt to change mode via 1200bps Reset.
+    CALL :RUN_ESPTOOL !ESPTOOL_BAUD! --after no_reset read_flash_status
+    GOTO eof
+)
+
 @REM Flashing operations.
 CALL :LOG_MESSAGE INFO "Trying to flash update "!FILENAME!" at OFFSET 0x10000..."
 CALL :RUN_ESPTOOL !ESPTOOL_BAUD! write_flash 0x10000 "!FILENAME!" || GOTO eof
@@ -135,6 +151,7 @@ EXIT /B %ERRORLEVEL%
 IF %DEBUG% EQU 1 CALL :LOG_MESSAGE DEBUG "About to run command: !ESPTOOL_CMD! --baud %~1 %~2 %~3 %~4"
 CALL :RESET_ERROR
 !ESPTOOL_CMD! --baud %~1 %~2 %~3 %~4
+IF %CHANGE_MODE% EQU 1 GOTO :eof
 IF %ERRORLEVEL% NEQ 0 (
     CALL :LOG_MESSAGE ERROR "Error running command: !ESPTOOL_CMD! --baud %~1 %~2 %~3 %~4"
     EXIT /B %ERRORLEVEL%

bin/device-update.sh

@@ -1,6 +1,7 @@
 #!/bin/sh
 
 PYTHON=${PYTHON:-$(which python3 python|head -n 1)}
+CHANGE_MODE=false
 
 # Determine the correct esptool command to use
 if "$PYTHON" -m esptool version >/dev/null 2>&1; then
@@ -17,14 +18,15 @@ fi
 # Usage info
 show_help() {
 cat << EOF
-Usage: $(basename $0) [-h] [-p ESPTOOL_PORT] [-P PYTHON] [-f FILENAME|FILENAME]
-Flash image file to device, leave existing system intact."
+Usage: $(basename $0) [-h] [-p ESPTOOL_PORT] [-P PYTHON] [-f FILENAME|FILENAME] [--change-mode]
+Flash image file to device, leave existing system intact.
 
     -h               Display this help and exit
     -p ESPTOOL_PORT  Set the environment variable for ESPTOOL_PORT.  If not set, ESPTOOL iterates all ports (Dangerous).
     -P PYTHON        Specify alternate python interpreter to use to invoke esptool. (Default: "$PYTHON")
     -f FILENAME      The *update.bin file to flash.  Custom to your device type.
-    
+    --change-mode    Attempt to place the device in correct mode. Some hardware requires this twice. (1200bps Reset)
+
 EOF
 }
 
@@ -41,6 +43,9 @@ while getopts ":hp:P:f:" opt; do
             ;;
         f)  FILENAME=${OPTARG}
             ;;
+	    --change-mode)
+            CHANGE_MODE=true
+            ;;
         *)
  	        echo "Invalid flag."
             show_help >&2
@@ -50,6 +55,11 @@ while getopts ":hp:P:f:" opt; do
 done
 shift "$((OPTIND-1))"
 
+if [[ $CHANGE_MODE == true ]]; then
+	$ESPTOOL_CMD --baud 1200 --after no_reset read_flash_status
+    exit 0
+fi
+
 [ -z "$FILENAME" -a -n "$1" ] && {
     FILENAME=$1
     shift