Merge branch 'wled:main' into main

Author: robertvb83

.github/workflows/pr-merge.yaml

@@ -1,16 +1,33 @@
     name: Notify Discord on PR Merge
     on:
+      workflow_dispatch:
       pull_request:
         types: [closed]
 
     jobs:
       notify:
         runs-on: ubuntu-latest
         steps:
-        - name: Send Discord notification
-          shell: bash
+        - name: Get User Permission
+          id: checkAccess
+          uses: actions-cool/check-user-permission@v2
+          with:
+            require: write
+            username: ${{ github.triggering_actor }}
           env:
-            DISCORD_WEBHOOK_BETA_TESTERS: ${{ secrets.DISCORD_WEBHOOK_BETA_TESTERS }}
-          if: github.event.pull_request.merged == true
+            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        - name: Check User Permission
+          if: steps.checkAccess.outputs.require-result == 'false'
+          run: |
+            echo "${{ github.triggering_actor }} does not have permissions on this repo."
+            echo "Current permission level is ${{ steps.checkAccess.outputs.user-permission }}"
+            echo "Job originally triggered by ${{ github.actor }}"
+            exit 1
+        - name: Checkout code
+          uses: actions/checkout@v3
+          with:
+            ref: ${{  github.event.pull_request.head.sha }} # This is dangerous without the first access check
+        - name: Send Discord notification
+          # if: github.event.pull_request.merged == true
           run: |
-            curl -H "Content-Type: application/json" -d '{"content": "Pull Request #{{ github.event.pull_request.number }} merged by {{ github.actor }}"}' $DISCORD_WEBHOOK_BETA_TESTERS
+            curl -H "Content-Type: application/json" -d '{"content": "Pull Request ${{ github.event.pull_request.number }} merged by ${{ github.actor }}"}' ${{ secrets.DISCORD_WEBHOOK_BETA_TESTERS }}

package-lock.json

@@ -77,17 +77,18 @@ def wrapped_ConfigureProjectLibBuilder(xenv):
   for dep in result.depbuilders:
      cached_add_includes(dep, processed_deps, extra_include_dirs)
 
+  wled_deps = [dep for dep in result.depbuilders if is_wled_module(dep)]
+
   broken_usermods = []
-  for dep in result.depbuilders:
-    if is_wled_module(dep):
-      # Add the wled folder to the include path
-      dep.env.PrependUnique(CPPPATH=str(wled_dir))
-      # Add WLED's own dependencies
-      for dir in extra_include_dirs:
-        dep.env.PrependUnique(CPPPATH=str(dir))
-      # Enforce that libArchive is not set; we must link them directly to the executable
-      if dep.lib_archive:
-        broken_usermods.append(dep)
+  for dep in wled_deps:
+    # Add the wled folder to the include path
+    dep.env.PrependUnique(CPPPATH=str(wled_dir))
+    # Add WLED's own dependencies
+    for dir in extra_include_dirs:
+      dep.env.PrependUnique(CPPPATH=str(dir))
+    # Enforce that libArchive is not set; we must link them directly to the executable
+    if dep.lib_archive:
+      broken_usermods.append(dep)
 
   if broken_usermods:
     broken_usermods = [usermod.name for usermod in broken_usermods]
@@ -97,6 +98,9 @@ def wrapped_ConfigureProjectLibBuilder(xenv):
       err=True)
     Exit(1)
 
+  # Save the depbuilders list for later validation
+  xenv.Replace(WLED_MODULES=wled_deps)
+
   return result
 
 # Apply the wrapper

pio-scripts/load_usermods.py

@@ -53,20 +53,8 @@ def validate_map_file(source, target, env):
         secho(f"ERROR: Map file not found: {map_file_path}", fg="red", err=True)
         Exit(1)
 
-    # Identify the WLED module source directories
-    module_lib_builders = [builder for builder in env.GetLibBuilders() if is_wled_module(env, builder)]
-
-    if env.GetProjectOption("custom_usermods","") == "*":
-        # All usermods build; filter non-platform-OK modules
-        module_lib_builders = [builder for builder in module_lib_builders if env.IsCompatibleLibBuilder(builder)]
-    else:
-        incompatible_builders = [builder for builder in module_lib_builders if not env.IsCompatibleLibBuilder(builder)]
-        if incompatible_builders:
-            secho(
-                f"ERROR: Modules {[b.name for b in incompatible_builders]} are not compatible with this platform!",
-                fg="red",
-                err=True)
-            Exit(1)
+    # Identify the WLED module builders, set by load_usermods.py
+    module_lib_builders = env['WLED_MODULES']
 
     # Extract the values we care about
     modules = {Path(builder.build_dir).name: builder.name for builder in module_lib_builders}

pio-scripts/validate_modules.py

@@ -38,7 +38,7 @@ pyelftools==0.32
     # via platformio
 pyserial==3.5
     # via platformio
-requests==2.32.3
+requests==2.32.4
     # via platformio
 semantic-version==2.10.0
     # via platformio
@@ -50,7 +50,7 @@ tabulate==0.9.0
     # via platformio
 typing-extensions==4.12.2
     # via anyio
-urllib3==2.3.0
+urllib3==2.5.0
     # via requests
 uvicorn==0.34.0
     # via platformio

requirements.txt

@@ -65,11 +65,14 @@ static bool udpSyncConnected = false;         // UDP connection status -> true i
 
 // audioreactive variables
 #ifdef ARDUINO_ARCH_ESP32
+    #ifndef SR_AGC // Automatic gain control mode
+    #define SR_AGC 0 // default mode = off
+    #endif
 static float    micDataReal = 0.0f;             // MicIn data with full 24bit resolution - lowest 8bit after decimal point
 static float    multAgc = 1.0f;                 // sample * multAgc = sampleAgc. Our AGC multiplier
 static float    sampleAvg = 0.0f;               // Smoothed Average sample - sampleAvg < 1 means "quiet" (simple noise gate)
 static float    sampleAgc = 0.0f;               // Smoothed AGC sample
-static uint8_t  soundAgc = 0;                   // Automagic gain control: 0 - none, 1 - normal, 2 - vivid, 3 - lazy (config value)
+static uint8_t  soundAgc = SR_AGC;              // Automatic gain control: 0 - off, 1 - normal, 2 - vivid, 3 - lazy (config value)
 #endif
 //static float    volumeSmth = 0.0f;              // either sampleAvg or sampleAgc depending on soundAgc; smoothed sample
 static float FFT_MajorPeak = 1.0f;              // FFT: strongest (peak) frequency

usermods/audioreactive/audio_reactive.cpp

@@ -60,8 +60,9 @@ You can use the following additional flags in your `build_flags`
 
 * `-D SR_SQUELCH=x`  : Default "squelch" setting (10)
 * `-D SR_GAIN=x`     : Default "gain" setting (60)
+* `-D SR_AGC=x`      : (Only ESP32) Default "AGC (Automatic Gain Control)" setting (0): 0=off, 1=normal, 2=vivid, 3=lazy
 * `-D I2S_USE_RIGHT_CHANNEL`: Use RIGHT instead of LEFT channel (not recommended unless you strictly need this).
-* `-D I2S_USE_16BIT_SAMPLES`: Use 16bit instead of 32bit for internal sample buffers. Reduces sampling quality, but frees some RAM ressources (not recommended unless you absolutely need this).
+* `-D I2S_USE_16BIT_SAMPLES`: Use 16bit instead of 32bit for internal sample buffers. Reduces sampling quality, but frees some RAM resources (not recommended unless you absolutely need this).
 * `-D I2S_GRAB_ADC1_COMPLETELY`: Experimental: continuously sample analog ADC microphone. Only effective on ESP32. WARNING this *will* cause conflicts(lock-up) with any analogRead() call.
 * `-D MIC_LOGGER`     : (debugging) Logs samples from the microphone to serial USB. Use with serial plotter (Arduino IDE)
 * `-D SR_DEBUG`       : (debugging) Additional error diagnostics and debug info on serial USB.

usermods/audioreactive/readme.md

@@ -0,0 +1,4 @@
+# Usermod user FX
+
+This Usermod is a common place to put various user's LED effects.
+

usermods/user_fx/README.md

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

usermods/user_fx/library.json

@@ -0,0 +1,116 @@
+#include "wled.h"
+
+// for information how FX metadata strings work see https://kno.wled.ge/interfaces/json-api/#effect-metadata
+
+// static effect, used if an effect fails to initialize
+static uint16_t mode_static(void) {
+  SEGMENT.fill(SEGCOLOR(0));
+  return strip.isOffRefreshRequired() ? FRAMETIME : 350;
+}
+
+/////////////////////////
+//  User FX functions  //
+/////////////////////////
+
+// Diffusion Fire: fire effect intended for 2D setups smaller than 16x16
+static uint16_t mode_diffusionfire(void) {
+  if (!strip.isMatrix || !SEGMENT.is2D())
+    return mode_static();  // not a 2D set-up
+
+  const int cols = SEG_W;
+  const int rows = SEG_H;
+  const auto XY = [&](int x, int y) { return x + y * cols; };
+
+  const uint8_t refresh_hz = map(SEGMENT.speed, 0, 255, 20, 80);
+  const unsigned refresh_ms = 1000 / refresh_hz;
+  const int16_t diffusion = map(SEGMENT.custom1, 0, 255, 0, 100);
+  const uint8_t spark_rate = SEGMENT.intensity;
+  const uint8_t turbulence = SEGMENT.custom2;
+
+  unsigned dataSize = SEGMENT.length(); // allocate persistent data for heat value for each pixel
+  if (!SEGENV.allocateData(dataSize))
+    return mode_static();  // allocation failed
+
+  if (SEGENV.call == 0) {
+    SEGMENT.fill(BLACK);
+    SEGENV.step = 0;
+  }
+
+  if ((strip.now - SEGENV.step) >= refresh_ms) {
+    uint8_t tmp_row[cols];
+    SEGENV.step = strip.now;
+    // scroll up
+    for (unsigned y = 1; y < rows; y++)
+      for (unsigned x = 0; x < cols; x++) {
+        unsigned src = XY(x, y);
+        unsigned dst = XY(x, y - 1);
+        SEGMENT.data[dst] = SEGMENT.data[src];
+      }
+
+    if (hw_random8() > turbulence) {
+      // create new sparks at bottom row
+      for (unsigned x = 0; x < cols; x++) {
+        uint8_t p = hw_random8();
+        if (p < spark_rate) {
+          unsigned dst = XY(x, rows - 1);
+          SEGMENT.data[dst] = 255;
+        }
+      }
+    }
+
+    // diffuse
+    for (unsigned y = 0; y < rows; y++) {
+      for (unsigned x = 0; x < cols; x++) {
+        unsigned v = SEGMENT.data[XY(x, y)];
+        if (x > 0) {
+          v += SEGMENT.data[XY(x - 1, y)];
+        }
+        if (x < (cols - 1)) {
+          v += SEGMENT.data[XY(x + 1, y)];
+        }
+        tmp_row[x] = min(255, (int)(v * 100 / (300 + diffusion)));
+      }
+
+      for (unsigned x = 0; x < cols; x++) {
+        SEGMENT.data[XY(x, y)] = tmp_row[x];
+        if (SEGMENT.check1) {
+          uint32_t color = ColorFromPalette(SEGPALETTE, tmp_row[x], 255, LINEARBLEND_NOWRAP);
+          SEGMENT.setPixelColorXY(x, y, color);
+        } else {
+          uint32_t color = SEGCOLOR(0);
+          SEGMENT.setPixelColorXY(x, y, color_fade(color, tmp_row[x]));
+        }
+      }
+    }
+  }
+  return FRAMETIME;
+}
+static const char _data_FX_MODE_DIFFUSIONFIRE[] PROGMEM = "Diffusion Fire@!,Spark rate,Diffusion Speed,Turbulence,,Use palette;;Color;;2;pal=35";
+
+
+/////////////////////
+//  UserMod Class  //
+/////////////////////
+
+class UserFxUsermod : public Usermod {
+ private:
+ public:
+  void setup() override {
+    strip.addEffect(255, &mode_diffusionfire, _data_FX_MODE_DIFFUSIONFIRE);
+
+    ////////////////////////////////////////
+    //  add your effect function(s) here  //
+    ////////////////////////////////////////
+
+    // use id=255 for all custom user FX (the final id is assigned when adding the effect)
+
+    // strip.addEffect(255, &mode_your_effect, _data_FX_MODE_YOUR_EFFECT);
+    // strip.addEffect(255, &mode_your_effect2, _data_FX_MODE_YOUR_EFFECT2);
+    // strip.addEffect(255, &mode_your_effect3, _data_FX_MODE_YOUR_EFFECT3);
+  }
+  void loop() override {} // nothing to do in the loop
+  uint16_t getId() override { return USERMOD_ID_USER_FX; }
+};
+
+static UserFxUsermod user_fx;
+REGISTER_USERMOD(user_fx);