Merge branch 'wled:main' into main

robertvb83 · web-flow · commit fd4d75fa1c8e · 2025-07-02T16:34:02.000+02:00
diff --git a/.github/workflows/usermods.yml b/.github/workflows/usermods.yml
@@ -0,0 +1,71 @@
+name: Usermod CI
+
+on:
+  push:
+    paths:
+      - usermods/**
+      - .github/workflows/usermods.yml
+    
+jobs:
+
+  get_usermod_envs:
+    name: Gather Usermods
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
+        cache: 'pip'
+    - name: Install PlatformIO
+      run: pip install -r requirements.txt
+    - name: Get default environments
+      id: envs
+      run: |
+        echo "usermods=$(find usermods/ -name library.json | xargs dirname | xargs -n 1 basename | jq -R | grep -v PWM_fan | grep -v BME68X_v2| grep -v pixels_dice_tray | jq --slurp -c)" >> $GITHUB_OUTPUT
+    outputs:
+      usermods: ${{ steps.envs.outputs.usermods }}
+
+
+  build:
+    name: Build Enviornments
+    runs-on: ubuntu-latest
+    needs: get_usermod_envs
+    strategy:
+      fail-fast: false
+      matrix:
+        usermod: ${{ fromJSON(needs.get_usermod_envs.outputs.usermods) }}
+        environment: [usermods_esp32, usermods_esp32c3, usermods_esp32s2, usermods_esp32s3]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version-file: '.nvmrc'
+        cache: 'npm'
+    - run: npm ci
+    - name: Cache PlatformIO
+      uses: actions/cache@v4
+      with:
+        path: |
+              ~/.platformio/.cache
+              ~/.buildcache
+              build_output
+        key: pio-${{ runner.os }}-${{ matrix.environment }}-${{ hashFiles('platformio.ini', 'pio-scripts/output_bins.py') }}-${{ hashFiles('wled00/**', 'usermods/**') }}
+        restore-keys: pio-${{ runner.os }}-${{ matrix.environment }}-${{ hashFiles('platformio.ini', 'pio-scripts/output_bins.py') }}-
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+          python-version: '3.12'
+          cache: 'pip'
+    - name: Install PlatformIO
+      run: pip install -r requirements.txt
+    - name: Add usermods environment
+      run: |
+        cp -v usermods/platformio_override.usermods.ini platformio_override.ini
+        echo >> platformio_override.ini
+        echo  "custom_usermods = ${{ matrix.usermod }}" >> platformio_override.ini
+        cat platformio_override.ini
+
+    - name: Build firmware
+      run: pio run -e ${{ matrix.environment }}    
diff --git a/usermods/Si7021_MQTT_HA/library.json b/usermods/Si7021_MQTT_HA/library.json
@@ -3,6 +3,8 @@
   "build": { "libArchive": false },
   "dependencies": {
     "finitespace/BME280":"3.0.0",
-    "adafruit/Adafruit Si7021 Library" : "1.5.3"
+    "adafruit/Adafruit Si7021 Library" : "1.5.3",
+    "SPI":"*",
+    "adafruit/Adafruit BusIO": "1.17.1"
   }
 }
diff --git a/usermods/Si7021_MQTT_HA/readme.md b/usermods/Si7021_MQTT_HA/readme.md
@@ -49,18 +49,8 @@ SDA_PIN = 4;
 
 ## Software
 
-Add to `build_flags` in platformio.ini:
+Add `Si7021_MQTT_HA` to custom_usermods
 
-```
-   -D USERMOD_SI7021_MQTT_HA
-```
-
-Add to `lib_deps` in platformio.ini:
-
-```
-   adafruit/Adafruit Si7021 Library @ 1.4.0
-   BME280@~3.0.0
-```
 
 # Credits
 
diff --git a/usermods/buzzer/buzzer.cpp b/usermods/buzzer/buzzer.cpp
@@ -5,16 +5,17 @@
 
 #define USERMOD_ID_BUZZER 900
 #ifndef USERMOD_BUZZER_PIN
+#ifdef GPIO_NUM_32
 #define USERMOD_BUZZER_PIN GPIO_NUM_32
+#else
+#define USERMOD_BUZZER_PIN 21
+#endif
 #endif
 
 /*
  * Usermods allow you to add own functionality to WLED more easily
  * See: https://github.com/wled-dev/WLED/wiki/Add-own-functionality
  * 
- * Using a usermod:
- * 1. Copy the usermod into the sketch folder (same folder as wled00.ino)
- * 2. Register the usermod by adding #include "usermod_filename.h" in the top and registerUsermod(new MyUsermodClass()) in the bottom of usermods_list.cpp
  */
 
 class BuzzerUsermod : public Usermod {
diff --git a/usermods/platformio_override.usermods.ini b/usermods/platformio_override.usermods.ini
@@ -0,0 +1,31 @@
+[platformio]
+default_envs = usermods_esp32, usermods_esp32c3, usermods_esp32s2, usermods_esp32s3
+
+[env:usermods_esp32]
+extends = env:esp32dev_V4
+custom_usermods = ${usermods.custom_usermods}
+board_build.partitions = ${esp32.extreme_partitions}  ; We're gonna need a bigger boat
+
+
+[env:usermods_esp32c3]
+extends = env:esp32c3dev
+board = esp32-c3-devkitm-1
+custom_usermods = ${usermods.custom_usermods}
+board_build.partitions = ${esp32.extreme_partitions}  ; We're gonna need a bigger boat
+
+
+[env:usermods_esp32s2]
+extends = env:lolin_s2_mini
+custom_usermods = ${usermods.custom_usermods}
+board_build.partitions = ${esp32.extreme_partitions}  ; We're gonna need a bigger boat
+
+
+[env:usermods_esp32s3]
+extends = env:esp32s3dev_16MB_opi
+custom_usermods = ${usermods.custom_usermods}
+board_build.partitions = ${esp32.extreme_partitions}  ; We're gonna need a bigger boat
+
+
+
+[usermods]
+# Added in CI
diff --git a/wled00/FX.cpp b/wled00/FX.cpp
@@ -6091,9 +6091,7 @@ uint16_t mode_2Dscrollingtext(void) {
   }
 
   char text[WLED_MAX_SEGNAME_LEN+1] = {'\0'};
-  if (SEGMENT.name) for (size_t i=0,j=0; i<strlen(SEGMENT.name); i++) if (SEGMENT.name[i]>31 && SEGMENT.name[i]<128) text[j++] = SEGMENT.name[i];
-  const bool zero = strchr(text, '0') != nullptr;
-
+  size_t result_pos = 0;
   char sec[5];
   int  AmPmHour = hour(localTime);
   bool isitAM = true;
@@ -6105,27 +6103,62 @@ uint16_t mode_2Dscrollingtext(void) {
     sprintf_P(sec, PSTR(":%02d"), second(localTime));
   }
 
-  if (!strlen(text)) { // fallback if empty segment name: display date and time
+  size_t len = 0;
+  if (SEGMENT.name) len = strlen(SEGMENT.name); // note: SEGMENT.name is limited to WLED_MAX_SEGNAME_LEN
+  if (len == 0) { // fallback if empty segment name: display date and time
     sprintf_P(text, PSTR("%s %d, %d %d:%02d%s"), monthShortStr(month(localTime)), day(localTime), year(localTime), AmPmHour, minute(localTime), sec);
   } else {
-    if (text[0] == '#') for (auto &c : text) c = std::toupper(c);
-    if      (!strncmp_P(text,PSTR("#DATE"),5)) sprintf_P(text, zero?PSTR("%02d.%02d.%04d"):PSTR("%d.%d.%d"),   day(localTime),   month(localTime),  year(localTime));
-    else if (!strncmp_P(text,PSTR("#DDMM"),5)) sprintf_P(text, zero?PSTR("%02d.%02d")     :PSTR("%d.%d"),      day(localTime),   month(localTime));
-    else if (!strncmp_P(text,PSTR("#MMDD"),5)) sprintf_P(text, zero?PSTR("%02d/%02d")     :PSTR("%d/%d"),      month(localTime), day(localTime));
-    else if (!strncmp_P(text,PSTR("#TIME"),5)) sprintf_P(text, zero?PSTR("%02d:%02d%s")   :PSTR("%2d:%02d%s"), AmPmHour,         minute(localTime), sec);
-    else if (!strncmp_P(text,PSTR("#HHMM"),5)) sprintf_P(text, zero?PSTR("%02d:%02d")     :PSTR("%d:%02d"),    AmPmHour,         minute(localTime));
-    else if (!strncmp_P(text,PSTR("#HH"),3))   sprintf  (text, zero?    ("%02d")          :    ("%d"),         AmPmHour);
-    else if (!strncmp_P(text,PSTR("#MM"),3))   sprintf  (text, zero?    ("%02d")          :    ("%d"),         minute(localTime));
-    else if (!strncmp_P(text,PSTR("#SS"),3))   sprintf  (text,          ("%02d")                     ,         second(localTime));
-    else if (!strncmp_P(text,PSTR("#DD"),3))   sprintf  (text, zero?    ("%02d")          :    ("%d"),         day(localTime));
-    else if (!strncmp_P(text,PSTR("#DAY"),4))  sprintf  (text,          ("%s")                       ,         dayShortStr(day(localTime)));
-    else if (!strncmp_P(text,PSTR("#DDDD"),5)) sprintf  (text,          ("%s")                       ,         dayStr(day(localTime)));
-    else if (!strncmp_P(text,PSTR("#DAYL"),5)) sprintf  (text,          ("%s")                       ,         dayStr(day(localTime)));
-    else if (!strncmp_P(text,PSTR("#MO"),3))   sprintf  (text, zero?    ("%02d")          :    ("%d"),         month(localTime));
-    else if (!strncmp_P(text,PSTR("#MON"),4))  sprintf  (text,          ("%s")                       ,         monthShortStr(month(localTime)));
-    else if (!strncmp_P(text,PSTR("#MMMM"),5)) sprintf  (text,          ("%s")                       ,         monthStr(month(localTime)));
-    else if (!strncmp_P(text,PSTR("#YY"),3))   sprintf  (text,          ("%02d")                     ,         year(localTime)%100);
-    else if (!strncmp_P(text,PSTR("#YYYY"),5)) sprintf_P(text, zero?PSTR("%04d")          :    ("%d"),         year(localTime));
+    size_t i = 0;
+    while (i < len) {
+      if (SEGMENT.name[i] == '#') {
+        char token[7]; // copy up to 6 chars + null terminator
+        bool zero = false; // a 0 suffix means display leading zeros
+        size_t j = 0;
+        while (j < 6 && i + j < len) {
+          token[j] = std::toupper(SEGMENT.name[i + j]);
+          if(token[j] == '0')
+            zero = true; // 0 suffix found. Note: there is an edge case where a '0' could be part of a trailing text and not the token, handling it is not worth the effort
+          j++;
+        }
+        token[j] = '\0';
+        int advance = 5; // number of chars to advance in 'text' after processing the token
+
+        // Process token
+        char temp[32];
+        if      (!strncmp_P(token,PSTR("#DATE"),5))  sprintf_P(temp, zero?PSTR("%02d.%02d.%04d"):PSTR("%d.%d.%d"),   day(localTime),   month(localTime),  year(localTime));
+        else if (!strncmp_P(token,PSTR("#DDMM"),5))  sprintf_P(temp, zero?PSTR("%02d.%02d")     :PSTR("%d.%d"),      day(localTime),   month(localTime));
+        else if (!strncmp_P(token,PSTR("#MMDD"),5))  sprintf_P(temp, zero?PSTR("%02d/%02d")     :PSTR("%d/%d"),      month(localTime), day(localTime));
+        else if (!strncmp_P(token,PSTR("#TIME"),5))  sprintf_P(temp, zero?PSTR("%02d:%02d%s")   :PSTR("%2d:%02d%s"), AmPmHour,         minute(localTime), sec);
+        else if (!strncmp_P(token,PSTR("#HHMM"),5))  sprintf_P(temp, zero?PSTR("%02d:%02d")     :PSTR("%d:%02d"),    AmPmHour,         minute(localTime));
+        else if (!strncmp_P(token,PSTR("#YYYY"),5))  sprintf_P(temp,          PSTR("%04d")                 ,         year(localTime));
+        else if (!strncmp_P(token,PSTR("#MONL"),5))  sprintf  (temp,          ("%s")                       ,         monthStr(month(localTime)));
+        else if (!strncmp_P(token,PSTR("#DDDD"),5))  sprintf  (temp,          ("%s")                       ,         dayStr(weekday(localTime)));
+        else if (!strncmp_P(token,PSTR("#YY"),3))  { sprintf  (temp,          ("%02d")                     ,         year(localTime)%100); advance = 3; }
+        else if (!strncmp_P(token,PSTR("#HH"),3))  { sprintf  (temp, zero?    ("%02d")          :    ("%d"),         AmPmHour); advance = 3; }
+        else if (!strncmp_P(token,PSTR("#MM"),3))  { sprintf  (temp, zero?    ("%02d")          :    ("%d"),         minute(localTime)); advance = 3; }
+        else if (!strncmp_P(token,PSTR("#SS"),3))  { sprintf  (temp, zero?    ("%02d")          :    ("%d"),         second(localTime)); advance = 3; }
+        else if (!strncmp_P(token,PSTR("#MON"),4)) { sprintf  (temp,          ("%s")                       ,         monthShortStr(month(localTime))); advance = 4; }
+        else if (!strncmp_P(token,PSTR("#MO"),3))  { sprintf  (temp, zero?    ("%02d")          :    ("%d"),         month(localTime)); advance = 3; }
+        else if (!strncmp_P(token,PSTR("#DAY"),4)) { sprintf  (temp,          ("%s")                       ,         dayShortStr(weekday(localTime))); advance = 4; }
+        else if (!strncmp_P(token,PSTR("#DD"),3))  { sprintf  (temp, zero?    ("%02d")          :    ("%d"),         day(localTime)); advance = 3; }
+        else { temp[0] = '#'; temp[1] = '\0'; zero = false; advance = 1; } // Unknown token, just copy the #
+
+        if(zero) advance++; // skip the '0' suffix
+        size_t temp_len = strlen(temp);
+        if (result_pos + temp_len < WLED_MAX_SEGNAME_LEN) {
+          strcpy(text + result_pos, temp);
+          result_pos += temp_len;
+        }
+
+        i += advance;
+      }
+      else {
+        if (result_pos < WLED_MAX_SEGNAME_LEN) {
+          text[result_pos++] = SEGMENT.name[i++]; // no token, just copy char
+        } else
+          break; // buffer full
+      }
+    }
   }
 
   const int  numberOfLetters = strlen(text);
diff --git a/wled00/cfg.cpp b/wled00/cfg.cpp
@@ -775,15 +775,15 @@ bool deserializeConfig(JsonObject doc, bool fromFS) {
 
 static const char s_cfg_json[] PROGMEM = "/cfg.json";
 
-void deserializeConfigFromFS() {
+bool deserializeConfigFromFS() {
   [[maybe_unused]] bool success = deserializeConfigSec();
   #ifdef WLED_ADD_EEPROM_SUPPORT
   if (!success) { //if file does not exist, try reading from EEPROM
     deEEPSettings();
   }
   #endif
 
-  if (!requestJSONBufferLock(1)) return;
+  if (!requestJSONBufferLock(1)) return false;
 
   DEBUG_PRINTLN(F("Reading settings from /cfg.json..."));
 
@@ -795,7 +795,7 @@ void deserializeConfigFromFS() {
   bool needsSave = deserializeConfig(root, true);
   releaseJSONBufferLock();
 
-  if (needsSave) serializeConfigToFS(); // usermods required new parameters
+  return needsSave;
 }
 
 void serializeConfigToFS() {
diff --git a/wled00/fcn_declare.h b/wled00/fcn_declare.h
@@ -25,7 +25,7 @@ void IRAM_ATTR touchButtonISR();
 
 //cfg.cpp
 bool deserializeConfig(JsonObject doc, bool fromFS = false);
-void deserializeConfigFromFS();
+bool deserializeConfigFromFS();
 bool deserializeConfigSec();
 void serializeConfig(JsonObject doc);
 void serializeConfigToFS();
diff --git a/wled00/pin_manager.cpp b/wled00/pin_manager.cpp
@@ -100,7 +100,8 @@ bool PinManager::allocateMultiplePins(const managed_pin_type * mptArray, byte ar
       // as this can greatly simplify configuration arrays
       continue;
     }
-    if (!isPinOk(gpio, mptArray[i].isOutput)) {
+    // allow any GPIO for Ethernet (compile time assigned)
+    if (!(isPinOk(gpio, mptArray[i].isOutput) || tag==PinOwner::Ethernet)) {
       DEBUG_PRINTF_P(PSTR("PIN ALLOC: FAIL Invalid pin attempted to be allocated: GPIO %d as %s\n."), gpio, mptArray[i].isOutput ? PSTR("output"): PSTR("input"));
       shouldFail = true;
     }
@@ -228,19 +229,18 @@ bool PinManager::isPinOk(byte gpio, bool output)
   #else
 
     if ((strncmp_P(PSTR("ESP32-U4WDH"), ESP.getChipModel(), 11) == 0) ||    // this is the correct identifier, but....
-        (strncmp_P(PSTR("ESP32-PICO-D2"), ESP.getChipModel(), 13) == 0)) {  // https://github.com/espressif/arduino-esp32/issues/10683
+        (strncmp_P(PSTR("ESP32-PICO-D"), ESP.getChipModel(), 12) == 0)) {   // https://github.com/espressif/arduino-esp32/issues/10683
       // this chip has 4 MB of internal Flash and different packaging, so available pins are different!
-      if (((gpio > 5) && (gpio < 9)) || (gpio == 11))
-        return false;
+      if ((gpio > 5 && gpio < 9) || gpio == 11) return false;               // U4WDH/PICO-D2 & PICO-D4: GPIO 6, 7, 8, 11 are used for SPI flash; 9 & 10 are free
+      if (gpio == 16 || gpio == 17) return false;                           // U4WDH/PICO-D?: GPIO 16 and 17 are used for PSRAM
+    } else if (strncmp_P(PSTR("ESP32-PICO-V3"), ESP.getChipModel(), 13) == 0) {
+      if (gpio == 6 || gpio == 11) return false;                            // PICO-V3: uses GPIO 6 and 11 for flash
+      if (strstr_P(ESP.getChipModel(), PSTR("V3-02")) != nullptr && (gpio == 9 || gpio == 10)) return false; // PICO-V3-02: uses GPIO 9 and 10 for PSRAM; 7, 8 are free
     } else {
       // for classic ESP32 (non-mini) modules, these are the SPI flash pins
       if (gpio > 5 && gpio < 12) return false;      //SPI flash pins
     }
-
-    if (((strncmp_P(PSTR("ESP32-PICO"), ESP.getChipModel(), 10) == 0) ||
-         (strncmp_P(PSTR("ESP32-U4WDH"), ESP.getChipModel(), 11) == 0))
-        && (gpio == 16 || gpio == 17)) return false; // PICO-D4/U4WDH: gpio16+17 are in use for onboard SPI FLASH
-    if (gpio == 16 || gpio == 17) return !psramFound(); //PSRAM pins on ESP32 (these are IO)
+    if (gpio == 16 || gpio == 17) return !psramFound(); // PSRAM pins on ESP32-D0WDR2-V3 (these are IO)
   #endif
     if (output) return digitalPinCanOutput(gpio);
     else        return true;
diff --git a/wled00/wled.cpp b/wled00/wled.cpp
@@ -423,7 +423,7 @@ void WLED::setup()
   multiWiFi.push_back(WiFiConfig(CLIENT_SSID,CLIENT_PASS)); // initialise vector with default WiFi
 
   DEBUG_PRINTLN(F("Reading config"));
-  deserializeConfigFromFS();
+  bool needsCfgSave = deserializeConfigFromFS();
   DEBUG_PRINTF_P(PSTR("heap %u\n"), ESP.getFreeHeap());
 
 #if defined(STATUSLED) && STATUSLED>=0
@@ -443,6 +443,8 @@ void WLED::setup()
   UsermodManager::setup();
   DEBUG_PRINTF_P(PSTR("heap %u\n"), ESP.getFreeHeap());
 
+  if (needsCfgSave) serializeConfigToFS(); // usermods required new parameters; need to wait for strip to be initialised #4752
+
   if (strcmp(multiWiFi[0].clientSSID, DEFAULT_CLIENT_SSID) == 0)
     showWelcomePage = true;
   WiFi.persistent(false);

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,8 @@`
`3`	`3`	`"build": { "libArchive": false },`
`4`	`4`	`"dependencies": {`
`5`	`5`	`"finitespace/BME280":"3.0.0",`
`6`		`- "adafruit/Adafruit Si7021 Library" : "1.5.3"`
	`6`	`+ "adafruit/Adafruit Si7021 Library" : "1.5.3",`
	`7`	`+ "SPI":"*",`
	`8`	`+ "adafruit/Adafruit BusIO": "1.17.1"`
`7`	`9`	`}`
`8`	`10`	`}`