Implement conditional ARDUINO_USB_MODE: dev=1, release=0

Co-authored-by: netmindz <442066+netmindz@users.noreply.github.com>

pio-scripts/conditional_usb_mode.py

@@ -0,0 +1,73 @@
+#!/usr/bin/env python3
+"""
+Conditional USB Mode Script for WLED-MM
+
+This script automatically sets ARDUINO_USB_MODE based on the build context:
+- For development builds: ARDUINO_USB_MODE=1 (allows USB debugging)  
+- For release builds (CI): ARDUINO_USB_MODE=0 (allows normal boot without USB debugger)
+
+The script detects release builds by checking for the WLED_RELEASE environment variable
+which is set to True in the GitHub Actions CI workflow.
+"""
+
+Import('env')
+import os
+
+def conditional_usb_mode(env):
+    """
+    Conditionally set ARDUINO_USB_MODE based on build context.
+    
+    For ESP32-C3, ESP32-S2, and ESP32-S3 variants:
+    - Development builds: ARDUINO_USB_MODE=1 (default, good for debugging)
+    - Release builds: ARDUINO_USB_MODE=0 (prevents hanging without USB debugger)
+    """
+    
+    # Check if this is a release build (CI sets WLED_RELEASE=True)
+    is_release_build = os.environ.get('WLED_RELEASE', '').lower() in ('true', '1', 'yes')
+    
+    if is_release_build:
+        print("WLED Release build detected - setting ARDUINO_USB_MODE=0 for production")
+        
+        # Find and modify ARDUINO_USB_MODE in build flags
+        build_flags = env.get('BUILD_FLAGS', [])
+        cpp_defines = env.get('CPPDEFINES', [])
+        
+        # Look through CPPDEFINES and modify ARDUINO_USB_MODE if found
+        modified = False
+        new_defines = []
+        
+        for define in cpp_defines:
+            if isinstance(define, (list, tuple)) and len(define) == 2:
+                if define[0] == 'ARDUINO_USB_MODE' and define[1] == '1':
+                    # Change ARDUINO_USB_MODE from 1 to 0 for release builds
+                    new_defines.append(('ARDUINO_USB_MODE', '0'))
+                    modified = True
+                    print(f"  Changed ARDUINO_USB_MODE from 1 to 0")
+                else:
+                    new_defines.append(define)
+            else:
+                new_defines.append(define)
+        
+        if modified:
+            env.Replace(CPPDEFINES=new_defines)
+        
+        # Also check raw build flags for -DARDUINO_USB_MODE=1
+        new_build_flags = []
+        for flag in build_flags:
+            if isinstance(flag, str) and 'ARDUINO_USB_MODE=1' in flag:
+                # Replace ARDUINO_USB_MODE=1 with ARDUINO_USB_MODE=0
+                new_flag = flag.replace('ARDUINO_USB_MODE=1', 'ARDUINO_USB_MODE=0')
+                new_build_flags.append(new_flag)
+                modified = True
+                print(f"  Modified build flag: {flag} -> {new_flag}")
+            else:
+                new_build_flags.append(flag)
+        
+        if modified:
+            env.Replace(BUILD_FLAGS=new_build_flags)
+            
+    else:
+        print("Development build detected - keeping ARDUINO_USB_MODE=1 for debugging")
+
+# Apply the conditional USB mode logic
+conditional_usb_mode(env)

platformio.ini

@@ -220,6 +220,7 @@ ldscript_16m14m = eagle.flash.16m14m.ld
 extra_scripts =
   pre:pio-scripts/set_version.py
   pre:pio-scripts/build-html.py
+  pre:pio-scripts/conditional_usb_mode.py
   post:pio-scripts/output_bins.py
   post:pio-scripts/strip-floats.py
   pre:pio-scripts/user_config_copy.py
@@ -455,7 +456,7 @@ build_flags = -g
   -D CONFIG_ASYNC_TCP_USE_WDT=0
   -D CONFIG_ASYNC_TCP_TASK_STACK_SIZE=9472         ;; WLEDMM increase stack by 1.25Kb, as audioreactive needs bigger SETTINGS_STACK_BUF_SIZE
   -DCO
-  -DARDUINO_USB_MODE=0 ;; changed from 1 to 0 to allow normal boot without USB debugger
+  -DARDUINO_USB_MODE=1 ;; this flag is mandatory for ESP32-C3
   ;; please make sure that the following flags are properly set (to 0 or 1) by your board.json, or included in your custom platformio_override.ini entry:
   ;; ARDUINO_USB_CDC_ON_BOOT
 
@@ -702,7 +703,7 @@ build_unflags = ${common.build_unflags}
 build_flags = ${common.build_flags} ${esp32s3.build_flags}
   -D CONFIG_LITTLEFS_FOR_IDF_3_2 -D WLED_WATCHDOG_TIMEOUT=0
   ;-D ARDUINO_USB_CDC_ON_BOOT=0 ;; -D ARDUINO_USB_MODE=1 ;; for boards with serial-to-USB chip
-  -D ARDUINO_USB_CDC_ON_BOOT=1 -D ARDUINO_USB_MODE=0      ;; changed from 1 to 0 to allow normal boot without USB debugger
+  -D ARDUINO_USB_CDC_ON_BOOT=1 -D ARDUINO_USB_MODE=1      ;; for boards with USB-OTG connector only (USBCDC or "TinyUSB")
   ; -D WLED_RELEASE_NAME=ESP32-S3_PSRAM
   -D WLED_USE_PSRAM -DBOARD_HAS_PSRAM ; tells WLED that PSRAM shall be used
   -D WLED_USE_PSRAM_JSON -DALL_JSON_TO_PSRAM ; WLEDMM --> force all JSON stuff into PSRAM; gives more free heap
@@ -1907,7 +1908,7 @@ build_flags = ${common.build_flags} ${esp32s3.build_flags} -Wno-misleading-inden
   ${common_mm.HUB75_build_flags}
   ${common_mm.animartrix_build_flags}
   -D WLED_RELEASE_NAME=esp32S3_4MB_S 
-  -DARDUINO_USB_MODE=0 -DARDUINO_USB_CDC_ON_BOOT=0 -DARDUINO_USB_MSC_ON_BOOT=0 -DARDUINO_USB_DFU_ON_BOOT=0   ;; changed from 1 to 0 to allow normal boot without USB debugger
+  -DARDUINO_USB_MODE=1 -DARDUINO_USB_CDC_ON_BOOT=0 -DARDUINO_USB_MSC_ON_BOOT=0 -DARDUINO_USB_DFU_ON_BOOT=0   ;; for Serial-to-USB chip
   ;;-DARDUINO_USB_MODE=1 -DARDUINO_USB_CDC_ON_BOOT=1 -DARDUINO_USB_MSC_ON_BOOT=0 -DARDUINO_USB_DFU_ON_BOOT=1 ;; for Hardware-CDC USB mode
   -D WLED_DISABLE_ADALIGHT     ;; disables serial protocols - recommended for Hardware-CDC USB (Serial RX will receive junk commands when RX pin is unconnected, unless its pulled down by resistor)
   -D WLED_WATCHDOG_TIMEOUT=0 -D CONFIG_ASYNC_TCP_USE_WDT=0
@@ -1938,7 +1939,7 @@ build_flags = ${common.build_flags} ${esp32s3.build_flags} -Wno-misleading-inden
   ; -DBOARD_HAS_PSRAM -D WLED_USE_PSRAM_JSON -D WLED_USE_PSRAM ;; un-comment in case your board supports PSRAM
   ;; -D WLED_USE_PSRAM_JSON -DALL_JSON_TO_PSRAM ; WLEDMM --> force all JSON stuff into PSRAM; gives more free heap
   -D WLED_RELEASE_NAME=esp32S3_8MB_M 
-  -DARDUINO_USB_MODE=0 -DARDUINO_USB_CDC_ON_BOOT=0 -DARDUINO_USB_MSC_ON_BOOT=0 -DARDUINO_USB_DFU_ON_BOOT=0   ;; changed from 1 to 0 to allow normal boot without USB debugger
+  -DARDUINO_USB_MODE=1 -DARDUINO_USB_CDC_ON_BOOT=0 -DARDUINO_USB_MSC_ON_BOOT=0 -DARDUINO_USB_DFU_ON_BOOT=0   ;; for Serial-to-USB chip
   ;;-DARDUINO_USB_MODE=1 -DARDUINO_USB_CDC_ON_BOOT=1 -DARDUINO_USB_MSC_ON_BOOT=0 -DARDUINO_USB_DFU_ON_BOOT=1 ;; for Hardware-CDC USB mode
   ;;-D WLED_DISABLE_ADALIGHT     ;; disables serial protocols - recommended for Hardware-CDC USB (Serial RX will receive junk commands when RX pin is unconnected, unless its pulled down by resistor)
   -D WLED_WATCHDOG_TIMEOUT=0 -D CONFIG_ASYNC_TCP_USE_WDT=0
@@ -1989,7 +1990,7 @@ build_flags = ${common.build_flags} ${esp32s3.build_flags} -Wno-misleading-inden
   -DBOARD_HAS_PSRAM ;; -D WLED_USE_PSRAM ;; your board supports PSRAM
   -D WLED_USE_PSRAM_JSON -DALL_JSON_TO_PSRAM ; WLEDMM --> force all JSON stuff into PSRAM; gives more free heap
   -D WLED_RELEASE_NAME=esp32S3_8MB_PSRAM_M
-  -DARDUINO_USB_MODE=0 -DARDUINO_USB_CDC_ON_BOOT=0 -DARDUINO_USB_MSC_ON_BOOT=0 -DARDUINO_USB_DFU_ON_BOOT=0     ;; changed from 1 to 0 to allow normal boot without USB debugger
+  -DARDUINO_USB_MODE=1 -DARDUINO_USB_CDC_ON_BOOT=0 -DARDUINO_USB_MSC_ON_BOOT=0 -DARDUINO_USB_DFU_ON_BOOT=0     ;; for Serial-to-USB chip
   ;;-DARDUINO_USB_MODE=1 -DARDUINO_USB_CDC_ON_BOOT=1 -DARDUINO_USB_MSC_ON_BOOT=0 -DARDUINO_USB_DFU_ON_BOOT=1   ;; for Hardware-CDC USB mode
   ;;-D WLED_DISABLE_ADALIGHT     ;; disables serial protocols - recommended for Hardware-CDC USB (Serial RX will receive junk commands when RX pin is unconnected, unless its pulled down by resistor)
   -D WLED_WATCHDOG_TIMEOUT=0 -D CONFIG_ASYNC_TCP_USE_WDT=0
@@ -2027,7 +2028,7 @@ build_unflags = ${env:esp32S3_8MB_M.build_unflags}   ;; use the same as "normal"
 build_flags = ${common.build_flags} ${esp32s3.build_flags} -Wno-misleading-indentation -Wno-format-truncation
   ${common_mm.build_flags_S}
   -D WLED_RELEASE_NAME=esp32S3_8MB_S
-  -DARDUINO_USB_MODE=0 -DARDUINO_USB_CDC_ON_BOOT=0 -DARDUINO_USB_MSC_ON_BOOT=0 -DARDUINO_USB_DFU_ON_BOOT=0   ;; changed from 1 to 0 to allow normal boot without USB debugger
+  -DARDUINO_USB_MODE=1 -DARDUINO_USB_CDC_ON_BOOT=0 -DARDUINO_USB_MSC_ON_BOOT=0 -DARDUINO_USB_DFU_ON_BOOT=0   ;; for Serial-to-USB chip
   ;;-DARDUINO_USB_MODE=1 -DARDUINO_USB_CDC_ON_BOOT=1 -DARDUINO_USB_MSC_ON_BOOT=0 -DARDUINO_USB_DFU_ON_BOOT=1 ;; for Hardware-CDC USB mode
   ;;-D WLED_DISABLE_ADALIGHT     ;; disables serial protocols - recommended for Hardware-CDC USB (Serial RX will receive junk commands when RX pin is unconnected, unless its pulled down by resistor)
   ${Speed_Flags.build_flags_V4}  ;; optimize for speed instead of size
@@ -2090,7 +2091,7 @@ build_flags = ${common.build_flags} ${esp32s3.build_flags} -Wno-misleading-inden
   -D MAX_SEGMENT_DATA=40960  ;; default 32767
   -DBOARD_HAS_PSRAM ;; -D WLED_USE_PSRAM ;; your board supports PSRAM
   -D WLED_USE_PSRAM_JSON -DALL_JSON_TO_PSRAM ; WLEDMM --> force all JSON stuff into PSRAM; gives more free heap
-  -DARDUINO_USB_MODE=0 -DARDUINO_USB_CDC_ON_BOOT=0 -DARDUINO_USB_MSC_ON_BOOT=0 -DARDUINO_USB_DFU_ON_BOOT=0     ;; changed from 1 to 0 to allow normal boot without USB debugger
+  -DARDUINO_USB_MODE=1 -DARDUINO_USB_CDC_ON_BOOT=0 -DARDUINO_USB_MSC_ON_BOOT=0 -DARDUINO_USB_DFU_ON_BOOT=0     ;; for Serial-to-USB chip
   ;; -DARDUINO_USB_MODE=1 -DARDUINO_USB_CDC_ON_BOOT=1 -DARDUINO_USB_MSC_ON_BOOT=0 -DARDUINO_USB_DFU_ON_BOOT=1   ;; for Hardware-CDC USB mode
   -D WLED_WATCHDOG_TIMEOUT=0 -D CONFIG_ASYNC_TCP_USE_WDT=0
   ;; -DUSERMOD_BATTERY_MEASUREMENT_PIN=2  ;; battery voltage pin
@@ -2134,7 +2135,7 @@ build_flags = ${common.build_flags} ${esp32s3.build_flags} -Wno-misleading-inden
   -D WLEDMM_FASTPATH
   -DBOARD_HAS_PSRAM ;; -D WLED_USE_PSRAM ;; your board supports PSRAM
   -D WLED_USE_PSRAM_JSON -DALL_JSON_TO_PSRAM ; WLEDMM --> force all JSON stuff into PSRAM; gives more free heap
-  -DARDUINO_USB_MODE=0 -DARDUINO_USB_CDC_ON_BOOT=0 -DARDUINO_USB_MSC_ON_BOOT=0 -DARDUINO_USB_DFU_ON_BOOT=0     ;; changed from 1 to 0 to allow normal boot without USB debugger
+  -DARDUINO_USB_MODE=1 -DARDUINO_USB_CDC_ON_BOOT=0 -DARDUINO_USB_MSC_ON_BOOT=0 -DARDUINO_USB_DFU_ON_BOOT=0     ;; for Serial-to-USB chip
   ;;-DARDUINO_USB_MODE=1 -DARDUINO_USB_CDC_ON_BOOT=1 -DARDUINO_USB_MSC_ON_BOOT=0 -DARDUINO_USB_DFU_ON_BOOT=1   ;; for Hardware-CDC USB mode
   -D WLED_WATCHDOG_TIMEOUT=0 -D CONFIG_ASYNC_TCP_USE_WDT=0
   ;; -D LEDPIN=38 ;; buildin LED
@@ -2160,7 +2161,7 @@ build_flags = ${common.build_flags} ${esp32s3.build_flags} -Wno-misleading-inden
   -D WLED_USE_PSRAM_JSON -DALL_JSON_TO_PSRAM ; WLEDMM --> force all JSON stuff into PSRAM; gives more free heap
   -DCONFIG_MBEDTLS_DYNAMIC_BUFFER=1 ;; optional - allows some buffers to use PSRAM
   -DLOLIN_WIFI_FIX -DWLEDMM_WIFI_POWERON_HACK ;; seems to work much better with this
-  -DARDUINO_USB_MODE=0 -DARDUINO_USB_CDC_ON_BOOT=0 -DARDUINO_USB_MSC_ON_BOOT=0 -DARDUINO_USB_DFU_ON_BOOT=1   ;; changed from 1 to 0 to allow normal boot without USB debugger
+  -DARDUINO_USB_MODE=1 -DARDUINO_USB_CDC_ON_BOOT=0 -DARDUINO_USB_MSC_ON_BOOT=0 -DARDUINO_USB_DFU_ON_BOOT=1   ;; for Serial-to-USB chip
   ;;-DARDUINO_USB_MODE=1 -DARDUINO_USB_CDC_ON_BOOT=1 -DARDUINO_USB_MSC_ON_BOOT=0 -DARDUINO_USB_DFU_ON_BOOT=1 ;; for Hardware-CDC USB mode
   -D WLED_DISABLE_ADALIGHT    ;; disables serial protocols - recommended for Hardware-CDC USB (Serial RX will receive junk commands when RX pin is unconnected, unless its pulled down by resistor)
   ${Speed_Flags.build_flags_V4}  ;; optimize for speed instead of size
@@ -2205,7 +2206,7 @@ build_flags = ${common.build_flags} ${esp32s3.build_flags} -Wno-misleading-inden
   -D WLED_USE_PSRAM_JSON -DALL_JSON_TO_PSRAM ; WLEDMM --> force all JSON stuff into PSRAM; gives more free heap
   -DCONFIG_MBEDTLS_DYNAMIC_BUFFER=1 ;; optional - allows some buffers to use PSRAM
   -DLOLIN_WIFI_FIX -DWLEDMM_WIFI_POWERON_HACK ;; seems to work much better with this
-  -DARDUINO_USB_MODE=0 -DARDUINO_USB_CDC_ON_BOOT=0 -DARDUINO_USB_MSC_ON_BOOT=0 -DARDUINO_USB_DFU_ON_BOOT=1   ;; changed from 1 to 0 to allow normal boot without USB debugger
+  -DARDUINO_USB_MODE=1 -DARDUINO_USB_CDC_ON_BOOT=0 -DARDUINO_USB_MSC_ON_BOOT=0 -DARDUINO_USB_DFU_ON_BOOT=1   ;; for Serial-to-USB chip
   ;;-DARDUINO_USB_MODE=1 -DARDUINO_USB_CDC_ON_BOOT=1 -DARDUINO_USB_MSC_ON_BOOT=0 -DARDUINO_USB_DFU_ON_BOOT=1 ;; for Hardware-CDC USB mode
   -D WLED_DISABLE_ADALIGHT    ;; disables serial protocols - recommended for Hardware-CDC USB (Serial RX will receive junk commands when RX pin is unconnected, unless its pulled down by resistor)
   ;; ${common_mm.animartrix_build_flags} ;; not enough flash