m5stack/StackChan
1
0
Fork 0
mirror of https://github.com/m5stack/StackChan.git synced 2026-06-14 18:20:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(firmware): auto-load sdkconfig.defaults.local overlay when present

Browse Source 
Detect firmware/sdkconfig.defaults.local at configure time and feed it
into ESP-IDF's SDKCONFIG_DEFAULTS list alongside sdkconfig.defaults.

This gives self-hosted and downstream builds a first-class way to pin
per-deployment values (CONFIG_STACKCHAN_SERVER_URL, CONFIG_OTA_URL,
CONFIG_USE_EZDATA, ...) without patching committed defaults and
without needing contributors to remember the
  SDKCONFIG_DEFAULTS="sdkconfig.defaults;sdkconfig.defaults.local"
invocation.

The file is ignored by the repo's .gitignore, so it never leaks
upstream. When it does not exist, behaviour is unchanged.

A status message ("StackChan: detected sdkconfig.defaults.local,
applying overlay") makes the override visible in the idf.py configure
output so it's obvious when a build is using custom defaults.
This commit is contained in:
Nourrisse Florian
2026-04-22 15:50:56 +02:00
parent 0cb413697b
commit 5bda3e436c
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
firmware/CMakeLists.txt
+11
View File
@@ -8,5 +8,16 @@ add_definitions(-DFIRMWARE_VERSION=\"${PROJECT_VER}\")
# Add this line to disable the specific warning
add_compile_options(-Wno-missing-field-initializers)
# Auto-load a local sdkconfig overlay (git-ignored) when present. Lets
# self-hosted / custom deployments pin CONFIG_STACKCHAN_SERVER_URL,
# CONFIG_OTA_URL, etc. without touching committed defaults.
# Manual equivalent: SDKCONFIG_DEFAULTS="sdkconfig.defaults;sdkconfig.defaults.local" idf.py build
if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/sdkconfig.defaults.local")
set(SDKCONFIG_DEFAULTS
"${CMAKE_CURRENT_SOURCE_DIR}/sdkconfig.defaults;${CMAKE_CURRENT_SOURCE_DIR}/sdkconfig.defaults.local"
CACHE STRING "ESP-IDF sdkconfig default files (auto-extended with local overlay)" FORCE)
message(STATUS "StackChan: detected sdkconfig.defaults.local, applying overlay")
endif()
include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(stack-chan)