Convert usermods to static libraries

.github/workflows/build.yml

@@ -57,6 +57,7 @@ jobs:
           cache: 'pip'
     - name: Install PlatformIO
       run: pip install -r requirements.txt
+
     - name: Build firmware
       run: pio run -e ${{ matrix.environment }}
     - uses: actions/upload-artifact@v4

pio-scripts/load_usermods.py

@@ -0,0 +1,61 @@
+Import('env')
+from pathlib import Path   # For OS-agnostic path manipulation
+
+usermod_dir = Path(env["PROJECT_DIR"]) / "usermods"
+all_usermods = [f for f in usermod_dir.iterdir() if f.is_dir() and f.joinpath('library.json').exists()]
+
+if env['PIOENV'] == "usermods":
+   # Add all usermods
+   env.GetProjectConfig().set(f"env:usermods", 'custom_usermods', " ".join([f.name for f in all_usermods]))
+
+def find_usermod(mod: str):
+  """Locate this library in the usermods folder.
+     We do this to avoid needing to rename a bunch of folders;
+     this could be removed later
+  """
+  # Check name match
+  mp = usermod_dir / mod
+  if mp.exists():
+    return mp
+  mp = usermod_dir / f"usermod_v2_{mod}"
+  if mp.exists():
+    return mp
+  raise RuntimeError(f"Couldn't locate module {mod} in usermods directory!")
+
+usermods = env.GetProjectOption("custom_usermods","")
+if usermods:
+  proj = env.GetProjectConfig()
+  deps = env.GetProjectOption('lib_deps')  
+  src_dir = proj.get("platformio", "src_dir")
+  src_dir = src_dir.replace('\\','/')
+  mod_paths = {mod: find_usermod(mod) for mod in usermods.split(" ")}
+  usermods = [f"{mod} = symlink://{path}" for mod, path in mod_paths.items()]
+  proj.set("env:" + env['PIOENV'], 'lib_deps', deps + usermods)  
+
+
+# Monkey-patch ConfigureProjectLibBuilder to mark up the dependencies
+# Save the old value
+cpl = env.ConfigureProjectLibBuilder
+# Our new wrapper
+def cpl_wrapper(env):
+  # Update usermod properties
+  lib_builders = env.GetLibBuilders()  
+  um_deps = [dep for dep in lib_builders if usermod_dir in Path(dep.src_dir).parents]
+  other_deps = [dep for dep in lib_builders if usermod_dir not in Path(dep.src_dir).parents]
+  for um in um_deps:
+    # Add include paths for all non-usermod dependencies
+    for dep in other_deps:
+        for dir in dep.get_include_dirs():
+            um.env.PrependUnique(CPPPATH=dir)
+    # Add the wled folder to the include path    
+    um.env.PrependUnique(CPPPATH=env["PROJECT_SRC_DIR"])
+    # Make sure we link directly, not through an archive
+    # Archives drop the .dtor table section we need
+    build = um._manifest.get("build", {})
+    build["libArchive"] = False
+    um._manifest["build"] = build
+  return cpl.clone(env)()
+
+
+# Replace the old one with ours
+env.AddMethod(cpl_wrapper, "ConfigureProjectLibBuilder")

platformio.ini

@@ -10,7 +10,7 @@
 # ------------------------------------------------------------------------------
 
 # CI/release binaries
-default_envs = nodemcuv2, esp8266_2m, esp01_1m_full, nodemcuv2_160, esp8266_2m_160, esp01_1m_full_160, nodemcuv2_compat, esp8266_2m_compat, esp01_1m_full_compat, esp32dev, esp32_eth, lolin_s2_mini, esp32c3dev, esp32s3dev_16MB_opi, esp32s3dev_8MB_opi, esp32s3_4M_qspi, esp32_wrover
+default_envs = nodemcuv2, esp8266_2m, esp01_1m_full, nodemcuv2_160, esp8266_2m_160, esp01_1m_full_160, nodemcuv2_compat, esp8266_2m_compat, esp01_1m_full_compat, esp32dev, esp32_eth, lolin_s2_mini, esp32c3dev, esp32s3dev_16MB_opi, esp32s3dev_8MB_opi, esp32s3_4M_qspi, esp32_wrover, usermods
 
 src_dir  = ./wled00
 data_dir = ./wled00/data
@@ -114,6 +114,7 @@ extra_scripts =
   post:pio-scripts/output_bins.py
   post:pio-scripts/strip-floats.py
   pre:pio-scripts/user_config_copy.py
+  pre:pio-scripts/load_usermods.py
   pre:pio-scripts/build_ui.py
   ; post:pio-scripts/obj-dump.py  ;; convenience script to create a disassembly dump of the firmware (hardcore debugging)
 
@@ -157,21 +158,13 @@ lib_deps =
     ;adafruit/Adafruit BMP280 Library @ 2.1.0
     ;adafruit/Adafruit CCS811 Library @ 1.0.4
     ;adafruit/Adafruit Si7021 Library @ 1.4.0
-  #For ADS1115 sensor uncomment following
-    ;adafruit/Adafruit BusIO @ 1.13.2
-    ;adafruit/Adafruit ADS1X15 @ 2.4.0
   #For MAX1704x Lipo Monitor / Fuel Gauge uncomment following
     ; https://github.com/adafruit/Adafruit_BusIO @ 1.14.5
     ; https://github.com/adafruit/Adafruit_MAX1704X @ 1.0.2
   #For MPU6050 IMU uncomment follwoing
     ;electroniccats/MPU6050 @1.0.1
-  # For -D USERMOD_ANIMARTRIX
-  # CC BY-NC 3.0 licensed effects by Stefan Petrick, include this usermod only if you accept the terms!
-    ;https://github.com/netmindz/animartrix.git#18bf17389e57c69f11bc8d04ebe1d215422c7fb7
   # SHT85
     ;robtillaart/SHT85@~0.3.3
-  # Audioreactive usermod
-    ;kosme/arduinoFFT @ 2.0.1
 
 extra_scripts = ${scripts_defaults.extra_scripts}
 
@@ -261,11 +254,11 @@ lib_deps =
   https://github.com/lorol/LITTLEFS.git
   https://github.com/pbolduc/AsyncTCP.git @ 1.2.0
   ${env.lib_deps}
-# additional build flags for audioreactive
-AR_build_flags = -D USERMOD_AUDIOREACTIVE 
-  -D sqrt_internal=sqrtf ;; -fsingle-precision-constant ;; forces ArduinoFFT to use float math (2x faster)
-AR_lib_deps = kosme/arduinoFFT @ 2.0.1
 board_build.partitions = ${esp32.default_partitions}   ;; default partioning for 4MB Flash - can be overridden in build envs
+# additional build flags for audioreactive - must be applied globally
+AR_build_flags = ;; -fsingle-precision-constant ;; forces ArduinoFFT to use float math (2x faster)
+AR_lib_deps =  ;; for pre-usermod-library platformio_override compatibility
+
 
 [esp32_idf_V4]
 ;; experimental build environment for ESP32 using ESP-IDF 4.4.x / arduino-esp32 v2.0.5
@@ -424,23 +417,21 @@ build_flags = ${common.build_flags} ${esp8266.build_flags} -D WLED_RELEASE_NAME=
 board = esp32dev
 platform = ${esp32.platform}
 platform_packages = ${esp32.platform_packages}
+custom_usermods = audioreactive auto_save animartrix
 build_unflags = ${common.build_unflags}
 build_flags = ${common.build_flags} ${esp32.build_flags} -D WLED_RELEASE_NAME=\"ESP32\" #-D WLED_DISABLE_BROWNOUT_DET
-  ${esp32.AR_build_flags}
 lib_deps = ${esp32.lib_deps}
-  ${esp32.AR_lib_deps}
 monitor_filters = esp32_exception_decoder
 board_build.partitions = ${esp32.default_partitions}
 
 [env:esp32dev_8M]
 board = esp32dev
 platform = ${esp32_idf_V4.platform}
 platform_packages = ${esp32_idf_V4.platform_packages}
+custom_usermods = audioreactive
 build_unflags = ${common.build_unflags}
 build_flags = ${common.build_flags} ${esp32_idf_V4.build_flags} -D WLED_RELEASE_NAME=\"ESP32_8M\" #-D WLED_DISABLE_BROWNOUT_DET
-  ${esp32.AR_build_flags}
 lib_deps = ${esp32_idf_V4.lib_deps}
-  ${esp32.AR_lib_deps}
 monitor_filters = esp32_exception_decoder
 board_build.partitions = ${esp32.large_partitions}
 board_upload.flash_size = 8MB
@@ -452,11 +443,10 @@ board_upload.maximum_size = 8388608
 board = esp32dev
 platform = ${esp32_idf_V4.platform}
 platform_packages = ${esp32_idf_V4.platform_packages}
+custom_usermods = audioreactive
 build_unflags = ${common.build_unflags}
 build_flags = ${common.build_flags} ${esp32_idf_V4.build_flags} -D WLED_RELEASE_NAME=\"ESP32_16M\" #-D WLED_DISABLE_BROWNOUT_DET
-  ${esp32.AR_build_flags}
 lib_deps = ${esp32_idf_V4.lib_deps}
-  ${esp32.AR_lib_deps}
 monitor_filters = esp32_exception_decoder
 board_build.partitions = ${esp32.extreme_partitions}
 board_upload.flash_size = 16MB
@@ -468,11 +458,10 @@ board_build.flash_mode = dio
 ;board = esp32dev
 ;platform = ${esp32.platform}
 ;platform_packages = ${esp32.platform_packages}
+;custom_usermods = audioreactive
 ;build_unflags = ${common.build_unflags}
 ;build_flags = ${common.build_flags} ${esp32.build_flags} -D WLED_RELEASE_NAME=\"ESP32_audioreactive\" #-D WLED_DISABLE_BROWNOUT_DET
-;  ${esp32.AR_build_flags}
 ;lib_deps = ${esp32.lib_deps}
-;  ${esp32.AR_lib_deps}
 ;monitor_filters = esp32_exception_decoder
 ;board_build.partitions = ${esp32.default_partitions}
 ;; board_build.f_flash = 80000000L
@@ -483,12 +472,11 @@ board = esp32-poe
 platform = ${esp32.platform}
 platform_packages = ${esp32.platform_packages}
 upload_speed = 921600
+custom_usermods = audioreactive
 build_unflags = ${common.build_unflags}
 build_flags = ${common.build_flags} ${esp32.build_flags} -D WLED_RELEASE_NAME=\"ESP32_Ethernet\" -D RLYPIN=-1 -D WLED_USE_ETHERNET -D BTNPIN=-1
 ;  -D WLED_DISABLE_ESPNOW ;; ESP-NOW requires wifi, may crash with ethernet only
-  ${esp32.AR_build_flags}
 lib_deps = ${esp32.lib_deps}
-  ${esp32.AR_lib_deps}
 board_build.partitions = ${esp32.default_partitions}
 
 [env:esp32_wrover]
@@ -499,14 +487,13 @@ board = ttgo-t7-v14-mini32
 board_build.f_flash = 80000000L
 board_build.flash_mode = qio
 board_build.partitions = ${esp32.extended_partitions}
+custom_usermods = audioreactive
 build_unflags = ${common.build_unflags}
 build_flags = ${common.build_flags} ${esp32_idf_V4.build_flags} -D WLED_RELEASE_NAME=\"ESP32_WROVER\"
   -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
   -D DATA_PINS=25
-  ${esp32.AR_build_flags}
 lib_deps = ${esp32_idf_V4.lib_deps}
-  ${esp32.AR_lib_deps}
-
+
 [env:esp32c3dev]
 extends = esp32c3
 platform = ${esp32c3.platform}
@@ -530,15 +517,14 @@ board_build.arduino.memory_type = qio_opi     ;; use with PSRAM: 8MB or 16MB
 platform = ${esp32s3.platform}
 platform_packages = ${esp32s3.platform_packages}
 upload_speed = 921600
+custom_usermods = audioreactive
 build_unflags = ${common.build_unflags}
 build_flags = ${common.build_flags} ${esp32s3.build_flags} -D WLED_RELEASE_NAME=\"ESP32-S3_16MB_opi\"
   -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=1      ;; for boards with USB-OTG connector only (USBCDC or "TinyUSB")
   -DBOARD_HAS_PSRAM
-  ${esp32.AR_build_flags}
 lib_deps = ${esp32s3.lib_deps}
-  ${esp32.AR_lib_deps}
 board_build.partitions = ${esp32.extreme_partitions}
 board_upload.flash_size = 16MB
 board_upload.maximum_size = 16777216
@@ -553,15 +539,14 @@ board_build.arduino.memory_type = qio_opi     ;; use with PSRAM: 8MB or 16MB
 platform = ${esp32s3.platform}
 platform_packages = ${esp32s3.platform_packages}
 upload_speed = 921600
+custom_usermods = audioreactive
 build_unflags = ${common.build_unflags}
 build_flags = ${common.build_flags} ${esp32s3.build_flags} -D WLED_RELEASE_NAME=\"ESP32-S3_8MB_opi\"
   -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=1      ;; for boards with USB-OTG connector only (USBCDC or "TinyUSB")
   -DBOARD_HAS_PSRAM
-  ${esp32.AR_build_flags}
 lib_deps = ${esp32s3.lib_deps}
-  ${esp32.AR_lib_deps}
 board_build.partitions = ${esp32.large_partitions}
 board_build.f_flash = 80000000L
 board_build.flash_mode = qio
@@ -575,6 +560,7 @@ platform_packages = ${esp32s3.platform_packages}
 board = esp32s3camlcd ;; this is the only standard board with "opi_opi"
 board_build.arduino.memory_type = opi_opi
 upload_speed = 921600
+custom_usermods = audioreactive
 build_unflags = ${common.build_unflags}
 build_flags = ${common.build_flags} ${esp32s3.build_flags} -D WLED_RELEASE_NAME=\"ESP32-S3_WROOM-2\"
   -D CONFIG_LITTLEFS_FOR_IDF_3_2 -D WLED_WATCHDOG_TIMEOUT=0
@@ -584,10 +570,8 @@ build_flags = ${common.build_flags} ${esp32s3.build_flags} -D WLED_RELEASE_NAME=
   -D LEDPIN=38 -D DATA_PINS=38 ;; buildin WS2812b LED
   -D BTNPIN=0 -D RLYPIN=16 -D IRPIN=17 -D AUDIOPIN=-1
   -D WLED_DEBUG
-  ${esp32.AR_build_flags}
   -D SR_DMTYPE=1 -D I2S_SDPIN=13 -D I2S_CKPIN=14 -D I2S_WSPIN=15 -D MCLK_PIN=4  ;; I2S mic
 lib_deps = ${esp32s3.lib_deps}
-  ${esp32.AR_lib_deps}
 
 board_build.partitions = ${esp32.extreme_partitions}
 board_upload.flash_size = 16MB
@@ -600,15 +584,14 @@ board = lolin_s3_mini ;; -S3 mini, 4MB flash 2MB PSRAM
 platform = ${esp32s3.platform}
 platform_packages = ${esp32s3.platform_packages}
 upload_speed = 921600
+custom_usermods = audioreactive
 build_unflags = ${common.build_unflags}
 build_flags = ${common.build_flags} ${esp32s3.build_flags} -D WLED_RELEASE_NAME=\"ESP32-S3_4M_qspi\"
   -DARDUINO_USB_CDC_ON_BOOT=1 -DARDUINO_USB_MODE=1      ;; for boards with USB-OTG connector only (USBCDC or "TinyUSB")
   -DBOARD_HAS_PSRAM
   -DLOLIN_WIFI_FIX ; seems to work much better with this
   -D WLED_WATCHDOG_TIMEOUT=0
-  ${esp32.AR_build_flags}
 lib_deps = ${esp32s3.lib_deps}
-  ${esp32.AR_lib_deps}
 board_build.partitions = ${esp32.default_partitions}
 board_build.f_flash = 80000000L
 board_build.flash_mode = qio
@@ -621,6 +604,7 @@ board = lolin_s2_mini
 board_build.partitions = ${esp32.default_partitions}
 board_build.flash_mode = qio
 board_build.f_flash = 80000000L
+custom_usermods = audioreactive
 build_unflags = ${common.build_unflags}
 build_flags = ${common.build_flags} ${esp32s2.build_flags} -D WLED_RELEASE_NAME=\"ESP32-S2\"
   -DARDUINO_USB_CDC_ON_BOOT=1
@@ -637,6 +621,15 @@ build_flags = ${common.build_flags} ${esp32s2.build_flags} -D WLED_RELEASE_NAME=
   -D HW_PIN_DATASPI=11
   -D HW_PIN_MISOSPI=9
 ;  -D STATUSLED=15
-  ${esp32.AR_build_flags}
 lib_deps = ${esp32s2.lib_deps}
-  ${esp32.AR_lib_deps}
+
+
+[env:usermods]
+board = esp32dev
+platform = ${esp32.platform}
+platform_packages = ${esp32.platform_packages}
+build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags} ${esp32.build_flags} -D WLED_RELEASE_NAME=\"USERMODS\"
+  ${esp32.AR_build_flags}
+lib_deps = ${esp32.lib_deps}
+board_build.partitions = ${esp32.big_partitions}

usermods/ADS1115_v2/usermod_ads1115.h → usermods/ADS1115_v2/ADS1115_v2.cpp

@@ -252,4 +252,7 @@ class ADS1115Usermod : public Usermod {
         int16_t results = ads.getLastConversionResults();
         readings[activeChannel] = ads.computeVolts(results);
     }
-};
+};
+
+static ADS1115Usermod ads1115_v2;
+REGISTER_USERMOD(ads1115_v2);

usermods/ADS1115_v2/library.json

@@ -0,0 +1,8 @@
+{
+  "name:": "ADS1115_v2",
+  "build": { "libArchive": false },
+  "dependencies": {
+    "Adafruit BusIO": "https://github.com/adafruit/Adafruit_BusIO#1.13.2",
+    "Adafruit ADS1X15": "https://github.com/adafruit/Adafruit_ADS1X15#2.4.0"
+  }
+}

usermods/AHT10_v2/usermod_aht10.h → usermods/AHT10_v2/AHT10_v2.cpp

@@ -324,4 +324,7 @@ class UsermodAHT10 : public Usermod
   }
 };
 
-const char UsermodAHT10::_name[] PROGMEM = "AHTxx";
+const char UsermodAHT10::_name[] PROGMEM = "AHTxx";
+
+static UsermodAHT10 aht10_v2;
+REGISTER_USERMOD(aht10_v2);

usermods/AHT10_v2/library.json

@@ -0,0 +1,7 @@
+{
+  "name:": "AHT10_v2",
+  "build": { "libArchive": false },  
+  "dependencies": {
+    "enjoyneering/AHT10":"~1.1.0"
+  }
+}

usermods/AHT10_v2/platformio_override.ini

@@ -2,8 +2,4 @@
 extends = env:esp32dev
 build_flags =
   ${common.build_flags} ${esp32.build_flags}
-  -D USERMOD_AHT10
   ; -D USERMOD_AHT10_DEBUG ; -- add a debug status to the info modal
-lib_deps = 
-  ${esp32.lib_deps}
-  enjoyneering/AHT10@~1.1.0

usermods/Analog_Clock/Analog_Clock.h → usermods/Analog_Clock/Analog_Clock.cpp

@@ -254,3 +254,7 @@ class AnalogClockUsermod : public Usermod {
         return USERMOD_ID_ANALOG_CLOCK;
     }
 };
+
+
+static AnalogClockUsermod analog_clock;
+REGISTER_USERMOD(analog_clock);

usermods/Analog_Clock/library.json

@@ -0,0 +1,4 @@
+{
+  "name:": "Analog_Clock",
+  "build": { "libArchive": false }
+}

usermods/Animated_Staircase/Animated_Staircase.h → usermods/Animated_Staircase/Animated_Staircase.cpp

@@ -562,3 +562,7 @@ const char Animated_Staircase::_bottomEcho_pin[]            PROGMEM = "bottomEch
 const char Animated_Staircase::_topEchoCm[]                 PROGMEM = "top-dist-cm";
 const char Animated_Staircase::_bottomEchoCm[]              PROGMEM = "bottom-dist-cm";
 const char Animated_Staircase::_togglePower[]               PROGMEM = "toggle-on-off";
+
+
+static Animated_Staircase animated_staircase;
+REGISTER_USERMOD(animated_staircase);

usermods/Animated_Staircase/library.json

@@ -0,0 +1,4 @@
+{
+  "name:": "Animated_Staircase",
+  "build": { "libArchive": false }
+}

usermods/BH1750_v2/usermod_bh1750.h → usermods/BH1750_v2/BH1750_v2.cpp

@@ -250,3 +250,7 @@ const char Usermod_BH1750::_maxReadInterval[] PROGMEM = "max-read-interval-ms";
 const char Usermod_BH1750::_minReadInterval[] PROGMEM = "min-read-interval-ms";
 const char Usermod_BH1750::_HomeAssistantDiscovery[] PROGMEM = "HomeAssistantDiscoveryLux";
 const char Usermod_BH1750::_offset[] PROGMEM = "offset-lx";
+
+
+static Usermod_BH1750 bh1750_v2;
+REGISTER_USERMOD(bh1750_v2);

usermods/BH1750_v2/library.json

@@ -0,0 +1,7 @@
+{
+  "name:": "BH1750_v2",
+  "build": { "libArchive": false },  
+  "dependencies": {
+    "claws/BH1750":"^1.2.0"
+  }
+}