Skip to content

Commit 2f6fa66

Browse files
committed
Merge pull request #4309 from netmindz/release-name-fix
Fix release name macro expansion
1 parent 8a18555 commit 2f6fa66

File tree

4 files changed

+27
-26
lines changed

4 files changed

+27
-26
lines changed

pio-scripts/output_bins.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,9 @@ def _create_dirs(dirs=["map", "release", "firmware"]):
1919
os.makedirs(os.path.join(OUTPUT_DIR, d), exist_ok=True)
2020

2121
def create_release(source):
22-
release_name = _get_cpp_define_value(env, "WLED_RELEASE_NAME")
23-
if release_name:
22+
release_name_def = _get_cpp_define_value(env, "WLED_RELEASE_NAME")
23+
if release_name_def:
24+
release_name = release_name_def.replace("\\\"", "")
2425
version = _get_cpp_define_value(env, "WLED_VERSION")
2526
release_file = os.path.join(OUTPUT_DIR, "release", f"WLED_{version}_{release_name}.bin")
2627
release_gz_file = release_file + ".gz"

platformio.ini

+21-21
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,7 @@ platform = ${common.platform_wled_default}
345345
platform_packages = ${common.platform_packages}
346346
board_build.ldscript = ${common.ldscript_4m1m}
347347
build_unflags = ${common.build_unflags}
348-
build_flags = ${common.build_flags} ${esp8266.build_flags} -D WLED_RELEASE_NAME=ESP8266 #-DWLED_DISABLE_2D
348+
build_flags = ${common.build_flags} ${esp8266.build_flags} -D WLED_RELEASE_NAME=\"ESP8266\" #-DWLED_DISABLE_2D
349349
lib_deps = ${esp8266.lib_deps}
350350
monitor_filters = esp8266_exception_decoder
351351

@@ -354,13 +354,13 @@ extends = env:nodemcuv2
354354
;; using platform version and build options from WLED 0.14.0
355355
platform = ${esp8266.platform_compat}
356356
platform_packages = ${esp8266.platform_packages_compat}
357-
build_flags = ${common.build_flags} ${esp8266.build_flags_compat} -D WLED_RELEASE_NAME=ESP8266_compat #-DWLED_DISABLE_2D
357+
build_flags = ${common.build_flags} ${esp8266.build_flags_compat} -D WLED_RELEASE_NAME=\"ESP8266_compat\" #-DWLED_DISABLE_2D
358358
;; lib_deps = ${esp8266.lib_deps_compat} ;; experimental - use older NeoPixelBus 2.7.9
359359

360360
[env:nodemcuv2_160]
361361
extends = env:nodemcuv2
362362
board_build.f_cpu = 160000000L
363-
build_flags = ${common.build_flags} ${esp8266.build_flags} -D WLED_RELEASE_NAME=ESP8266_160 #-DWLED_DISABLE_2D
363+
build_flags = ${common.build_flags} ${esp8266.build_flags} -D WLED_RELEASE_NAME=\"ESP8266_160\" #-DWLED_DISABLE_2D
364364
-D USERMOD_AUDIOREACTIVE
365365

366366
[env:esp8266_2m]
@@ -369,20 +369,20 @@ platform = ${common.platform_wled_default}
369369
platform_packages = ${common.platform_packages}
370370
board_build.ldscript = ${common.ldscript_2m512k}
371371
build_unflags = ${common.build_unflags}
372-
build_flags = ${common.build_flags} ${esp8266.build_flags} -D WLED_RELEASE_NAME=ESP02
372+
build_flags = ${common.build_flags} ${esp8266.build_flags} -D WLED_RELEASE_NAME=\"ESP02\"
373373
lib_deps = ${esp8266.lib_deps}
374374

375375
[env:esp8266_2m_compat]
376376
extends = env:esp8266_2m
377377
;; using platform version and build options from WLED 0.14.0
378378
platform = ${esp8266.platform_compat}
379379
platform_packages = ${esp8266.platform_packages_compat}
380-
build_flags = ${common.build_flags} ${esp8266.build_flags_compat} -D WLED_RELEASE_NAME=ESP02_compat #-DWLED_DISABLE_2D
380+
build_flags = ${common.build_flags} ${esp8266.build_flags_compat} -D WLED_RELEASE_NAME=\"ESP02_compat\" #-DWLED_DISABLE_2D
381381

382382
[env:esp8266_2m_160]
383383
extends = env:esp8266_2m
384384
board_build.f_cpu = 160000000L
385-
build_flags = ${common.build_flags} ${esp8266.build_flags} -D WLED_RELEASE_NAME=ESP02_160
385+
build_flags = ${common.build_flags} ${esp8266.build_flags} -D WLED_RELEASE_NAME=\"ESP02_160\"
386386
-D USERMOD_AUDIOREACTIVE
387387

388388
[env:esp01_1m_full]
@@ -391,7 +391,7 @@ platform = ${common.platform_wled_default}
391391
platform_packages = ${common.platform_packages}
392392
board_build.ldscript = ${common.ldscript_1m128k}
393393
build_unflags = ${common.build_unflags}
394-
build_flags = ${common.build_flags} ${esp8266.build_flags} -D WLED_RELEASE_NAME=ESP01 -D WLED_DISABLE_OTA
394+
build_flags = ${common.build_flags} ${esp8266.build_flags} -D WLED_RELEASE_NAME=\"ESP01\" -D WLED_DISABLE_OTA
395395
; -D WLED_USE_REAL_MATH ;; may fix wrong sunset/sunrise times, at the cost of 7064 bytes FLASH and 975 bytes RAM
396396
lib_deps = ${esp8266.lib_deps}
397397

@@ -400,12 +400,12 @@ extends = env:esp01_1m_full
400400
;; using platform version and build options from WLED 0.14.0
401401
platform = ${esp8266.platform_compat}
402402
platform_packages = ${esp8266.platform_packages_compat}
403-
build_flags = ${common.build_flags} ${esp8266.build_flags_compat} -D WLED_RELEASE_NAME=ESP01_compat -D WLED_DISABLE_OTA #-DWLED_DISABLE_2D
403+
build_flags = ${common.build_flags} ${esp8266.build_flags_compat} -D WLED_RELEASE_NAME=\"ESP01_compat\" -D WLED_DISABLE_OTA #-DWLED_DISABLE_2D
404404

405405
[env:esp01_1m_full_160]
406406
extends = env:esp01_1m_full
407407
board_build.f_cpu = 160000000L
408-
build_flags = ${common.build_flags} ${esp8266.build_flags} -D WLED_RELEASE_NAME=ESP01_160 -D WLED_DISABLE_OTA
408+
build_flags = ${common.build_flags} ${esp8266.build_flags} -D WLED_RELEASE_NAME=\"ESP01_160\" -D WLED_DISABLE_OTA
409409
-D USERMOD_AUDIOREACTIVE
410410
; -D WLED_USE_REAL_MATH ;; may fix wrong sunset/sunrise times, at the cost of 7064 bytes FLASH and 975 bytes RAM
411411

@@ -414,7 +414,7 @@ board = esp32dev
414414
platform = ${esp32.platform}
415415
platform_packages = ${esp32.platform_packages}
416416
build_unflags = ${common.build_unflags}
417-
build_flags = ${common.build_flags} ${esp32.build_flags} -D WLED_RELEASE_NAME=ESP32 #-D WLED_DISABLE_BROWNOUT_DET
417+
build_flags = ${common.build_flags} ${esp32.build_flags} -D WLED_RELEASE_NAME=\"ESP32\" #-D WLED_DISABLE_BROWNOUT_DET
418418
${esp32.AR_build_flags}
419419
lib_deps = ${esp32.lib_deps}
420420
${esp32.AR_lib_deps}
@@ -426,7 +426,7 @@ board = esp32dev
426426
platform = ${esp32_idf_V4.platform}
427427
platform_packages = ${esp32_idf_V4.platform_packages}
428428
build_unflags = ${common.build_unflags}
429-
build_flags = ${common.build_flags} ${esp32_idf_V4.build_flags} -D WLED_RELEASE_NAME=ESP32_8M #-D WLED_DISABLE_BROWNOUT_DET
429+
build_flags = ${common.build_flags} ${esp32_idf_V4.build_flags} -D WLED_RELEASE_NAME=\"ESP32_8M\" #-D WLED_DISABLE_BROWNOUT_DET
430430
${esp32.AR_build_flags}
431431
lib_deps = ${esp32_idf_V4.lib_deps}
432432
${esp32.AR_lib_deps}
@@ -442,7 +442,7 @@ board = esp32dev
442442
platform = ${esp32_idf_V4.platform}
443443
platform_packages = ${esp32_idf_V4.platform_packages}
444444
build_unflags = ${common.build_unflags}
445-
build_flags = ${common.build_flags} ${esp32_idf_V4.build_flags} -D WLED_RELEASE_NAME=ESP32_16M #-D WLED_DISABLE_BROWNOUT_DET
445+
build_flags = ${common.build_flags} ${esp32_idf_V4.build_flags} -D WLED_RELEASE_NAME=\"ESP32_16M\" #-D WLED_DISABLE_BROWNOUT_DET
446446
${esp32.AR_build_flags}
447447
lib_deps = ${esp32_idf_V4.lib_deps}
448448
${esp32.AR_lib_deps}
@@ -458,7 +458,7 @@ board_build.flash_mode = dio
458458
;platform = ${esp32.platform}
459459
;platform_packages = ${esp32.platform_packages}
460460
;build_unflags = ${common.build_unflags}
461-
;build_flags = ${common.build_flags} ${esp32.build_flags} -D WLED_RELEASE_NAME=ESP32_audioreactive #-D WLED_DISABLE_BROWNOUT_DET
461+
;build_flags = ${common.build_flags} ${esp32.build_flags} -D WLED_RELEASE_NAME=\"ESP32_audioreactive\" #-D WLED_DISABLE_BROWNOUT_DET
462462
; ${esp32.AR_build_flags}
463463
;lib_deps = ${esp32.lib_deps}
464464
; ${esp32.AR_lib_deps}
@@ -473,7 +473,7 @@ platform = ${esp32.platform}
473473
platform_packages = ${esp32.platform_packages}
474474
upload_speed = 921600
475475
build_unflags = ${common.build_unflags}
476-
build_flags = ${common.build_flags} ${esp32.build_flags} -D WLED_RELEASE_NAME=ESP32_Ethernet -D RLYPIN=-1 -D WLED_USE_ETHERNET -D BTNPIN=-1
476+
build_flags = ${common.build_flags} ${esp32.build_flags} -D WLED_RELEASE_NAME=\"ESP32_Ethernet\" -D RLYPIN=-1 -D WLED_USE_ETHERNET -D BTNPIN=-1
477477
; -D WLED_DISABLE_ESPNOW ;; ESP-NOW requires wifi, may crash with ethernet only
478478
${esp32.AR_build_flags}
479479
lib_deps = ${esp32.lib_deps}
@@ -489,7 +489,7 @@ board_build.f_flash = 80000000L
489489
board_build.flash_mode = qio
490490
board_build.partitions = ${esp32.extended_partitions}
491491
build_unflags = ${common.build_unflags}
492-
build_flags = ${common.build_flags} ${esp32_idf_V4.build_flags} -D WLED_RELEASE_NAME=ESP32_WROVER
492+
build_flags = ${common.build_flags} ${esp32_idf_V4.build_flags} -D WLED_RELEASE_NAME=\"ESP32_WROVER\"
493493
-DBOARD_HAS_PSRAM -mfix-esp32-psram-cache-issue ;; Older ESP32 (rev.<3) need a PSRAM fix (increases static RAM used) https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-guides/external-ram.html
494494
-D DATA_PINS=25
495495
${esp32.AR_build_flags}
@@ -503,7 +503,7 @@ platform_packages = ${esp32c3.platform_packages}
503503
framework = arduino
504504
board = esp32-c3-devkitm-1
505505
board_build.partitions = ${esp32.default_partitions}
506-
build_flags = ${common.build_flags} ${esp32c3.build_flags} -D WLED_RELEASE_NAME=ESP32-C3
506+
build_flags = ${common.build_flags} ${esp32c3.build_flags} -D WLED_RELEASE_NAME=\"ESP32-C3\"
507507
-D WLED_WATCHDOG_TIMEOUT=0
508508
-DLOLIN_WIFI_FIX ; seems to work much better with this
509509
-DARDUINO_USB_CDC_ON_BOOT=1 ;; for virtual CDC USB
@@ -520,7 +520,7 @@ platform = ${esp32s3.platform}
520520
platform_packages = ${esp32s3.platform_packages}
521521
upload_speed = 921600
522522
build_unflags = ${common.build_unflags}
523-
build_flags = ${common.build_flags} ${esp32s3.build_flags} -D WLED_RELEASE_NAME=ESP32-S3_16MB_opi
523+
build_flags = ${common.build_flags} ${esp32s3.build_flags} -D WLED_RELEASE_NAME=\"ESP32-S3_16MB_opi\"
524524
-D CONFIG_LITTLEFS_FOR_IDF_3_2 -D WLED_WATCHDOG_TIMEOUT=0
525525
;-D ARDUINO_USB_CDC_ON_BOOT=0 ;; -D ARDUINO_USB_MODE=1 ;; for boards with serial-to-USB chip
526526
-D ARDUINO_USB_CDC_ON_BOOT=1 -D ARDUINO_USB_MODE=1 ;; for boards with USB-OTG connector only (USBCDC or "TinyUSB")
@@ -543,7 +543,7 @@ platform = ${esp32s3.platform}
543543
platform_packages = ${esp32s3.platform_packages}
544544
upload_speed = 921600
545545
build_unflags = ${common.build_unflags}
546-
build_flags = ${common.build_flags} ${esp32s3.build_flags} -D WLED_RELEASE_NAME=ESP32-S3_8MB_opi
546+
build_flags = ${common.build_flags} ${esp32s3.build_flags} -D WLED_RELEASE_NAME=\"ESP32-S3_8MB_opi\"
547547
-D CONFIG_LITTLEFS_FOR_IDF_3_2 -D WLED_WATCHDOG_TIMEOUT=0
548548
;-D ARDUINO_USB_CDC_ON_BOOT=0 ;; -D ARDUINO_USB_MODE=1 ;; for boards with serial-to-USB chip
549549
-D ARDUINO_USB_CDC_ON_BOOT=1 -D ARDUINO_USB_MODE=1 ;; for boards with USB-OTG connector only (USBCDC or "TinyUSB")
@@ -565,7 +565,7 @@ board = esp32s3camlcd ;; this is the only standard board with "opi_opi"
565565
board_build.arduino.memory_type = opi_opi
566566
upload_speed = 921600
567567
build_unflags = ${common.build_unflags}
568-
build_flags = ${common.build_flags} ${esp32s3.build_flags} -D WLED_RELEASE_NAME=ESP32-S3_WROOM-2
568+
build_flags = ${common.build_flags} ${esp32s3.build_flags} -D WLED_RELEASE_NAME=\"ESP32-S3_WROOM-2\"
569569
-D CONFIG_LITTLEFS_FOR_IDF_3_2 -D WLED_WATCHDOG_TIMEOUT=0
570570
-D ARDUINO_USB_CDC_ON_BOOT=0 ;; -D ARDUINO_USB_MODE=1 ;; for boards with serial-to-USB chip
571571
;; -D ARDUINO_USB_CDC_ON_BOOT=1 -D ARDUINO_USB_MODE=1 ;; for boards with USB-OTG connector only (USBCDC or "TinyUSB")
@@ -590,7 +590,7 @@ platform = ${esp32s3.platform}
590590
platform_packages = ${esp32s3.platform_packages}
591591
upload_speed = 921600
592592
build_unflags = ${common.build_unflags}
593-
build_flags = ${common.build_flags} ${esp32s3.build_flags} -D WLED_RELEASE_NAME=ESP32-S3_4M_qspi
593+
build_flags = ${common.build_flags} ${esp32s3.build_flags} -D WLED_RELEASE_NAME=\"ESP32-S3_4M_qspi\"
594594
-DARDUINO_USB_CDC_ON_BOOT=1 -DARDUINO_USB_MODE=1 ;; for boards with USB-OTG connector only (USBCDC or "TinyUSB")
595595
-DBOARD_HAS_PSRAM
596596
-DLOLIN_WIFI_FIX ; seems to work much better with this
@@ -611,7 +611,7 @@ board_build.partitions = ${esp32.default_partitions}
611611
board_build.flash_mode = qio
612612
board_build.f_flash = 80000000L
613613
build_unflags = ${common.build_unflags}
614-
build_flags = ${common.build_flags} ${esp32s2.build_flags} -D WLED_RELEASE_NAME=ESP32-S2
614+
build_flags = ${common.build_flags} ${esp32s2.build_flags} -D WLED_RELEASE_NAME=\"ESP32-S2\"
615615
-DARDUINO_USB_CDC_ON_BOOT=1
616616
-DARDUINO_USB_MSC_ON_BOOT=0
617617
-DARDUINO_USB_DFU_ON_BOOT=0

platformio_override.sample.ini

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ build_flags = ${common.build_flags} ${esp8266.build_flags}
3737
; *** To use the below defines/overrides, copy and paste each onto it's own line just below build_flags in the section above.
3838
;
3939
; Set a release name that may be used to distinguish required binary for flashing
40-
; -D WLED_RELEASE_NAME=ESP32_MULTI_USREMODS
40+
; -D WLED_RELEASE_NAME=\"ESP32_MULTI_USREMODS\"
4141
;
4242
; disable specific features
4343
; -D WLED_DISABLE_OTA

wled00/wled.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -264,12 +264,12 @@ using PSRAMDynamicJsonDocument = BasicJsonDocument<PSRAM_Allocator>;
264264
#define WLED_VERSION dev
265265
#endif
266266
#ifndef WLED_RELEASE_NAME
267-
#define WLED_RELEASE_NAME dev_release
267+
#define WLED_RELEASE_NAME "Custom"
268268
#endif
269269

270270
// Global Variable definitions
271271
WLED_GLOBAL char versionString[] _INIT(TOSTRING(WLED_VERSION));
272-
WLED_GLOBAL char releaseString[] _INIT(TOSTRING(WLED_RELEASE_NAME)); // somehow this will not work if using "const char releaseString[]
272+
WLED_GLOBAL char releaseString[] _INIT(WLED_RELEASE_NAME); // must include the quotes when defining, e.g -D WLED_RELEASE_NAME=\"ESP32_MULTI_USREMODS\"
273273
#define WLED_CODENAME "Kōsen"
274274

275275
// AP and OTA default passwords (for maximum security change them!)

0 commit comments

Comments
 (0)