Changelog update and build bump.

Tetris AI usermod

.github/workflows/wled-ci.yml

@@ -1,4 +1,4 @@
-name: PlatformIO CI
+name: WLED CI
 
 on: [push, pull_request]
 
@@ -8,21 +8,17 @@ jobs:
     name: Gather Environments
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - name: Cache pip
-      uses: actions/cache@v2
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
       with:
-        path: ~/.cache/pip
-        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-        restore-keys: |
-          ${{ runner.os }}-pip-
-    - uses: actions/setup-python@v2
+        python-version: '3.12'
+        cache: 'pip'
     - name: Install PlatformIO
       run: pip install -r requirements.txt
     - name: Get default environments
       id: envs
       run: |
-        echo "::set-output name=environments::$(pio project config --json-output | jq -cr '.[0][1][0][1]')"
+        echo "environments=$(pio project config --json-output | jq -cr '.[0][1][0][1]')" >> $GITHUB_OUTPUT
     outputs:
       environments: ${{ steps.envs.outputs.environments }}
 
@@ -32,55 +28,67 @@ jobs:
     runs-on: ubuntu-latest
     needs: get_default_envs
     strategy:
+      fail-fast: false
       matrix:
         environment: ${{ fromJSON(needs.get_default_envs.outputs.environments) }}
     steps:
-    - uses: actions/checkout@v2
-    - name: Cache pip
-      uses: actions/cache@v2
+    - uses: actions/checkout@v4
+    - name: Set up Node.js
+      uses: actions/setup-node@v4
       with:
-        path: ~/.cache/pip
-        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-        restore-keys: |
-          ${{ runner.os }}-pip-
+        cache: 'npm'
+    - run: npm install
     - name: Cache PlatformIO
-      uses: actions/cache@v2
+      uses: actions/cache@v4
       with:
-        path: ~/.platformio
-        key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }}
+        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@v2
+      uses: actions/setup-python@v5
+      with:
+          python-version: '3.12'
+          cache: 'pip'
     - name: Install PlatformIO
       run: pip install -r requirements.txt
     - name: Build firmware
-      env:
-        WLED_RELEASE: True
       run: pio run -e ${{ matrix.environment }}
-    - uses: actions/upload-artifact@v2
+    - uses: actions/upload-artifact@v4
       with:
         name: firmware-${{ matrix.environment }}
         path: |
-          build_output/firmware/*.bin
-          build_output/firmware/*.gz
-    - uses: actions/upload-artifact@v2
-      if: startsWith(github.ref, 'refs/tags/')
-      with:
-        name: firmware-release
-        path: build_output/release/*.bin
+          build_output/release/*.bin
+          build_output/release/*_ESP02.bin.gz
   release:
     name: Create Release
     runs-on: ubuntu-latest
-    needs: [get_default_envs, build]
+    needs: build
     if: startsWith(github.ref, 'refs/tags/')
     steps:
-    - uses: actions/download-artifact@v2
+    - uses: actions/download-artifact@v4
       with:
-        name: firmware-release
+        merge-multiple: true
     - name: Create draft release
       uses: softprops/action-gh-release@v1
       with:
         draft: True
         files: |
           *.bin
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          *.bin.gz
+
+
+  testCdata:
+    name: Test cdata.js
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          cache: 'npm'
+      - run: npm ci
+      - run: npm test

.gitignore

@@ -1,20 +1,24 @@
-.pio
 .cache
+.clang-format
+.direnv
+.DS_Store
+.idea
+.pio
 .pioenvs
 .piolibdeps
 .vscode
-/wled00/Release
-/wled00/extLibs
-/platformio_override.ini
-/wled00/my_config.h
-/build_output
-.DS_Store
-.gitignore
-.clang-format
-node_modules
-.idea
-.direnv
-wled-update.sh
+
 esp01-update.sh
+platformio_override.ini
+replace_fs.py
+wled-update.sh
+
+/build_output/
+/node_modules/
+
+/wled00/extLibs
 /wled00/LittleFS
-replace_fs.py
+/wled00/my_config.h
+/wled00/Release
+/wled00/wled00.ino.cpp
+/wled00/html_*.h

.vscode/tasks.json

@@ -9,8 +9,8 @@
       ],
       "dependsOrder": "sequence",
       "problemMatcher": [
-        "$platformio",
-      ],
+        "$platformio"
+      ]
     },
     {
       "type": "PlatformIO",
@@ -18,7 +18,7 @@
       "task": "Build",
       "group": {
         "kind": "build",
-        "isDefault": true,
+        "isDefault": true
       },
       "problemMatcher": [
         "$platformio"

CHANGELOG.md

@@ -1,11 +1,400 @@
 ## WLED changelog
 
+#### Build 2403190
+-   limit max PWM frequency (fix incorrect PWM resolution)
+-   Segment UI bugfix
+-   Updated AsyncWebServer (by @wlillmmiles)
+-   Simpler boot preset (fix for #3806)
+-   Effect: Fix for 2D Drift animation (#3816 by @BaptisteHudyma)
+-   Effect: Add twin option to 2D Drift
+-   MQTT cleanup
+-   DDP: Support sources that don't push (#3833 by @willmmiles)
+-   Usermod: Tetris AI usermod (#3711 by @muebau)
+
+#### Build 2403171
+-   merge 0.14.2 changes into 0.15
+
+#### Build 2403070
+-   Add additional segment options when controlling over e1.31 (#3616 by @demophoon)
+-   LockedJsonResponse: Release early if possible (#3760 by @willmmiles)
+-   Update setup-node and cache usermods in wled-ci.yml (#3737 by @WoodyLetsCode)
+-   Fix preset sorting (#3790 by @WoodyLetsCode)
+-   compile time button configuration #3792
+-   remove IR config if not compiled
+-   additional string optimisations
+-   Better low brightness level PWM handling (fixes #2767, #2868)
+
+#### Build 2402290
+-   Multiple analog button fix for #3549
+-   Preset caching on chips with PSRAM (credit @akaricchi)
+-   Fixing stairway usermod and adding buildflags (by @lost-hope)
+-   ESP-NOW packet modification
+-   JSON buffer lock error messages / Reduce wait time for lock to 100ms
+-   Reduce string RAM usage for ESP8266
+-   Fixing a potential array bounds violation in ESPDMX
+-   Move timezone table to PROGMEM (#3766 by @willmmiles)
+-   Reposition upload warning message. (fixes #3778)
+-   ABL display fix & optimisation
+-   Add virtual Art-Net RGBW option (#3783 by @shammy642)
+
+#### Build 2402090
+-   Added new Ethernet controller RGB2Go Tetra (duplicate of ESP3DEUXQuattro)
+-   Usermod: httpPullLightControl (#3560 by @roelbroersma)
+-   DMX: S2 & C3 support via modified ESPDMX
+-   Bugfix: prevent cleaning of JSON buffer after a failed lock attempt (BufferGuard)
+-   Product/Brand override (API & AP SSID) (#3750 by @moustachauve)
+
+#### Build 2402060
+-   WLED version 0.15.0-b1
+-   Harmonic Random Cycle palette (#3729 by @dedehai)
+-   Multi PIR sensor usermod (added support for attaching multiple PIR sensors)
+-   Removed obsolete (and nonfunctional) usermods
+
+#### Build 2309120 till build 2402010
+-   WLED version 0.15.0-a0
+-   Multi-WiFi support. Add up to 3 (or more via cusom compile) WiFis to connect to
+-   Temporary AP. Use your WLED in public with temporary AP.
+-   Github CI build system enhancements (#3718 by @WoodyLetsCode)
+-   Accessibility: Node list ( #3715 by @WoodyLetsCode)
+-   Analog clock overlay enhancement (#3489 by @WoodyLetsCode)
+-   ESP32-POE-WROVER from Olimex ethernet support (#3625 by @m-wachter)
+-   APA106 support (#3580 by @itstefanjanos)
+-   BREAKING: Effect: updated Palette effect to support 2D (#3683 by @TripleWhy)
+-   "SuperSync" from WLED MM (by @MoonModules)
+-   Effect: DNA Spiral Effect Speed Fix (#3723 by @Derek4aty1)
+-   Fix for #3693
+-   Orange flash fix (#3196) for transitions
+-   Add own background image upload (#3596 by @WoodyLetsCode)
+-   WLED time overrides (`WLED_NTP_ENABLED`, `WLED_TIMEZONE`, `WLED_UTC_OFFSET`, `WLED_LAT` and `WLED_LON`)
+-   Better sorting and naming of static palettes (by @WoodyLetsCode)
+-   ANIMartRIX usermod and effects (#3673 by @netmindz)
+-   Use canvas instead of CSS gradient for liveview (#3621 by @zanhecht)
+-   Fix for #3672
+-   ColoOrderMap W channel swap (color order overrides now have W swap)
+-   En-/disable LED maps when receiving realtime data (#3554 by @ezcGman)
+-   Added PWM frequency selection to UI (Settings)
+-   Automatically build UI before compiling (#3598, #3666 by @WoodyLetsCode)
+-   Internal: Added *suspend* API to `strip` (`WS2812FX class`)
+-   Possible fix for #3589 & partial fix for #3605
+-   MPU6050 upgrade (#3654 by @willmmiles)
+-   UI internals (#3656 by @WoodyLetsCode)
+-   ColorPicker fix (#3658 by @WoodyLetsCode)
+-   Global JSON buffer guarding (#3648 by @willmmiles, resolves #3641, #3312, #3367, #3637, #3646, #3447)
+-   Effect: Fireworks 1D (fix for matrix trailing strip)
+-   BREAKING: Reduced number of segments (12) on ESP8266 due to less available RAM
+-   Increased available effect data buffer (increases more if board has PSRAM)
+-   Custom palette editor mobile UI enhancement (by @imeszaros)
+-   Per port Auto Brightness Limiter (ABL)
+-   Use PSRAM for JSON buffer (double size, larger ledmaps, up to 2k)
+-   Reduced heap fragmentation by allocating ledmap array only once and not deallocating effect buffer
+-   HTTP retries on failed UI load
+-   UI Search: scroll to top (#3587 by @WoodyLetsCode)
+-   Return to inline iro.js and rangetouch.js (#3597 by @WoodyLetsCode)
+-   Better caching (#3591 by @WoodyLetsCode)
+-   Do not send 404 for missing `skin.css` (#3590 by @WoodyLetsCode)
+-   Simplified UI rework (#3511 by @WoodyLetsCode)
+-   Domoticz device ID for PIR and Temperature usermods
+-   Bugfix for UCS8904 `hasWhite()`
+-   Better search in UI (#3540 by @WoodyLetsCode)
+-   Seeding FastLED PRNG (#3552 by @TripleWhy)
+-   WIZ Smart Button support (#3547 by @micw)
+-   New button type (button switch, fix for #3537)
+-   Pixel Magic Tool update (#3483 by @ajotanc)
+-   Effect: 2D Matrix fix for gaps
+-   Bugfix #3526, #3533, #3561
+-   Spookier Halloween Eyes (#3501)
+-   Compile time options for Multi Relay usermod (#3498)
+-   Effect: Fix for Dissolve (#3502)
+-   Better reverse proxy support (nested paths)
+-   Implement global JSON API boolean toggle (i.e. instead of "var":true or "var":false -> "var":"t").
+-   Sort presets by ID
+-   Fix for #3641, #3312, #3367, #3637, #3646, #3447, #3632, #3496, #2922, #3593, #3514, #3522, #3578 (partial), #3606 (@WoodyLetsCode)
+-   Improved random bg image and added random bg image options (@WoodyLetsCode, #3481)
+-   Audio palettes (Audioreactive usermod, credit @netmindz)
+-   Better UI tooltips (@ajotnac, #3464)
+-   Better effect filters (filter dropdown)
+-   UDP sync fix (for #3487)
+-   Power button override (solves #3431)
+-   Additional HTTP request throttling (ESP8266)
+-   Additional UI/UX improvements
+-   Segment class optimisations (internal)
+-   ESP-NOW sync
+-   ESP-NOW Wiz remote JSON overrides (similar to IR JSON) & bugfixes
+-   Gamma correction for custom palettes (#3399).
+-   Restore presets from browser local storage
+-   Optional effect blending
+-   Restructured UDP Sync (internal)
+    -   Remove sync receive
+    -   Sync clarification
+-   Disallow 2D effects on non-2D segments
+-   Return of 2 audio simulations
+-   Bugfix in sync #3344 (internal)
+    -   remove excessive segments
+    -   ignore inactive segments if not syncing bounds
+    -   send UDP/WS on segment change
+    -   pop_back() when removing last segment
+
+#### Build 2403170
+-   WLED 0.14.2 release
+
+#### Build 2403110
+-   Beta WLED 0.14.2-b2
+-   New AsyncWebServer (improved performance and reduced memory use)
+-   New builds for ESP8266 with 160MHz CPU clock
+-   Fixing stairway usermod and adding buildflags (#3758 by @lost-hope)
+-   Fixing a potential array bounds violation in ESPDMX
+-   Reduced RAM usage (moved strings and TZ data (by @willmmiles) to PROGMEM)
+-   LockedJsonResponse: Release early if possible (by @willmmiles)
+
+#### Build 2402120
+-   Beta WLED 0.14.2-b1
+-   Possible fix for #3589 & partial fix for #3605
+-   Prevent JSON buffer clear after failed lock attempt
+-   Multiple analog button fix for #3549
+-   UM Audioreactive: add two compiler options (#3732 by @wled-install)
+-   Fix for #3693
+
+#### Build 2401141
+-   Official release of WLED 0.14.1
+-   Fix for #3566, #3665, #3672
+-   Sorting of palettes in custom palette editor (#3674 by @WoodyLetsCode)
+
+#### Build 2401060
+-   Version bump: 0.14.1-b3
+-   Global JSON buffer guarding (#3648 by @willmmiles, resolves #3641, #3312, #3367, #3637, #3646, #3447)
+-   Fix for #3632
+-   Custom palette editor mobile UI enhancement (#3617 by @imeszaros)
+-   changelog update
+
+#### Build 2312290
+-   Fix for #3622, #3613, #3609
+-   Various tweaks and fixes
+-   changelog update
+
+#### Build 2312230
+-   Version bump: 0.14.1-b2
+-   Fix for Pixel Magic button
+-   Fix for #2922 (option to force WiFi PHY mode to G on ESP8266)
+-   Fix for #3601, #3400 (incorrect sunrise/sunset, #3612 by @softhack007)
+
+#### Build 2312180
+-   Bugfixes (#3593, #3490, #3573, #3517, #3561, #3555, #3541, #3536, #3515, #3522, #3533, #3508)
+-   Various other internal cleanups and optimisations
+
+#### Build 2311160
+-   Version bump: 0.14.1-b1
+-   Bugfixes (#3526, #3502, #3496, #3484, #3487, #3445, #3466, #3296, #3382, #3312)
+-   New feature: Sort presets by ID
+-   New usermod: LDR sensor (#3490 by @JeffWDH)
+-   Effect: Twinklefox & Tinklecat metadata fix
+-   Effect: separate #HH and #MM for Scrolling Text (#3480)
+-   SSDR usermod enhancements (#3368)
+-   PWM fan usermod enhancements (#3414)
+
+#### Build 2310010, build 2310130
+-   Release of WLED version 0.14.0 "Hoshi"
+-   Bugfixes for #3400, #3403, #3405
+-   minor HTML optimizations
+-   audioreactive: bugfix for UDP sound sync (partly initialized packets)
+
+#### Build 2309240
+-   Release of WLED beta version 0.14.0-b6 "Hoshi"
+-   Effect bugfixes and improvements (Meteor, Meteor Smooth, Scrolling Text)
+-   audioreactive: bugfixes for ES8388 and ES7243 init; minor improvements for analog inputs
+
+#### Build 2309100
+-   Release of WLED beta version 0.14.0-b5 "Hoshi"
+-   New standard esp32 build with audioreactive
+-   Effect blending bugfixes, and minor optimizations
+
+#### Build 2309050
+-   Effect blending (#3311) (finally effect transitions!)
+    *WARNING*: May not work well with ESP8266, with plenty of segments or usermods (low RAM condition)!!!
+-   Added receive and send sync groups to JSON API (#3317) (you can change sync groups using preset)
+-   Internal temperature usermod (#3246)
+-   MQTT server and topic length overrides (#3354) (new build flags)
+-   Animated Staircase usermod enhancement (#3348) (on/off toggle/relay control)
+-   Added local time info to Info page (#3351)
+-   New effect: Rolling Balls (a.k.a. linear bounce) (#1039)
+-   Various bug fixes and enhancements.
+
+#### Build 2308110
+-   Release of WLED beta version 0.14.0-b4 "Hoshi"
+-   Reset effect data immediately upon mode change
+
+#### Build 2308030
+-   Improved random palette handling and blending
+-   Soap bugfix
+-   Fix ESP-NOW crash with AP mode Always
+
+#### Build 2307180
+-   Bus-level global buffering (#3280)
+-   Removed per-segment LED buffer (SEGMENT.leds)
+-   various fixes and improvements (ESP variants platform 5.3.0, effect optimizations, /json/cfg pin allocation)
+
+#### Build 2307130
+-   larger `oappend()` stack buffer (3.5k) for ESP32
+-   Preset cycle bugfix (#3262)
+-   Rotary encoder ALT fix for large LED count (#3276)
+-   effect updates (2D Plasmaball), `blur()` speedup
+-   On/Off toggle from nodes view (may show unknown device type on older versions) (#3291)
+-   various fixes and improvements (ABL, crashes when changing presets with different segments)
+
+#### Build 2306270
+-   ESP-NOW remote support (#3237)
+-   Pixel Magic tool (display pixel art) (#3249)
+-   Websocket (peek) fallback when connection cannot be established, WS retries (#3267)
+-   Add WiFi network scan RPC command to Improv Serial (#3271)
+-   Longer (custom option available) segment name for ESP32
+-   various fixes and improvements
+
+#### Build 2306210
+-   0.14.0-b3 release
+-   respect global I2C in all usermods (no local initialization of I2C bus)
+-   Multi relay usermod compile-time enabled option (-D MULTI_RELAY_ENABLED=true|false)
+
+#### Build 2306180
+-   Added client-side option for applying effect defaults from metadata
+-   Improved ESP8266 stability by reducing WebSocket response resends
+-   Updated ESP8266 core to 3.1.2
+
+#### Build 2306141
+-   Lissajous improvements
+-   Scrolling Text improvements (leading 0)
+
+#### Build 2306140
+-   Add settings PIN (un)locking to JSON post API
+
+#### Build 2306130
+-   Bumped version to 0.14-b3 (beta 3)
+-   added pin dropdowns in LED preferences (not for LED pins) and usermods
+-   introduced (unused ATM) NeoGammaWLEDMethod class
+-   Reverse proxy support
+-   PCF8754 support for Rotary encoder (requires wiring INT pin to ESP GPIO)
+-   Rely on global I2C pins for usermods (breaking change)
+-   various fixes and enhancements
+
+#### Build 2306020
+-   Support for segment sets (PR #3171)
+-   Reduce sound simulation modes to 2 to facilitate segment sets
+-   Trigger button immediately on press if all configured presets are the same (PR #3226)
+-   Changes for allowing Alexa to change light color to White when auto-calculating from RGB (PR #3211)
+
+#### Build 2305280
+-   DDP protocol update (#3193)
+-   added PCF8574 I2C port expander support for Multi relay usermod
+-   MQTT multipacket (fragmented) message fix
+-   added option to retain MQTT brightness and color messages
+-   new ethernet board: @srg74 Ethernet Shield
+-   new 2D effects: Soap (#3184) & Octopus & Waving cell (credit @St3P40 https://github.com/80Stepko08)
+-   various fixes and enhancements
+
+#### Build 2305090
+-   new ethernet board: @Wladi ABC! WLED Eth
+-   Battery usermod voltage calculation (#3116)
+-   custom palette editor (#3164)
+-   improvements in Dancing Shadows and Tartan effects
+-   UCS389x support
+-   switched to NeoPixelBus 2.7.5 (replaced NeoPixelBrightnessBus with NeoPixelBusLg)
+-   SPI bus clock selection (for LEDs) (#3173)
+-   DMX mode preset fix (#3134)
+-   iOS fix for scroll (#3182)
+-   Wordclock "Norddeutsch" fix (#3161)
+-   various fixes and enhancements
+
+#### Build 2304090
+-   updated Arduino ESP8266 core to 4.1.0 (newer compiler)
+-   updated NeoPixelBus to 2.7.3 (with support for UCS890x chipset)
+-   better support for ESP32-C3, ESP32-S2 and ESP32-S3 (Arduino ESP32 core 5.2.0)
+-   iPad/tablet with 1024 pixels width in landscape orientation PC mode support (#3153)
+-   fix for Pixel Art Converter (#3155)
+
+#### Build 2303240
+-   Peek scaling of large 2D matrices
+-   Added 0D (1 pixel) metadata for effects & enhance 0D (analog strip) UI handling
+-   Added ability to disable ADAlight (-D WLED_DISABLE_ADALIGHT)
+-   Fixed APA102 output on Ethernet enabled controllers
+-   Added ArtNet virtual/network output (#3121)
+-   Klipper usermod (#3106)
+-   Remove DST from CST timezone
+-   various fixes and enhancements
+
+#### Build 2302180
+
+-   Removed Blynk support (servers shut down on 31st Dec 2022)
+-   Added `ledgap.json` to complement ledmaps for 2D matrices
+-   Added support for white addressable strips (#3073)
+-   Ability to use SHT temperature usermod with PWM fan usermod
+-   Added `onStateChange()` callback to usermods (#3081)
+-   Refactored `bus_manager` [internal]
+-   Dual 1D & 2D mode (add 1D strip after the matrix)
+-   Removed 1D -> 2D mapping for individual pixel control
+-   effect tweak: Fireworks 1D
+-   various bugfixes
+
+#### Build 2301240
+
+-   Version bump to v0.14.0-b2 "Hoshi"
+-   PixelArt converter (convert any image to pixel art and display it on a matrix) (PR #3042)
+-   various effect updates and optimisations
+    -   added Overlay option to some effects (allows overlapping segments)
+    -   added gradient text on Scrolling Text
+    -   added #DDMM, #MMDD & #HHMM date and time options for Scrolling Text effect (PR #2990)
+    -   deprecated: Dynamic Smooth, Dissolve Rnd, Solid Glitter
+    -   optimised & enhanced loading of default values
+    -   new effect: Distortion Waves (2D)
+    -   2D support for Ripple effect
+    -   slower minimum speed for Railway effect
+-   DMX effect mode & segment controls (PR #2891)
+-   Optimisations for conditional compiles (further reduction of code size)
+-   better UX with effect sliders (PR #3012)
+-   enhanced support for ESP32 variants: C3, S2 & S3
+-   usermod enhancements (PIR, Temperature, Battery (PR #2975), Analog Clock (PR #2993))
+-   new usermod SHT (PR #2963)
+-   2D matrix set up with gaps or irregular panels (breaking change!) (PR #2892)
+-   palette blending/transitions
+-   random palette smooth changes
+-   hex color notations in custom palettes
+-   allow more virtual buses
+-   plethora of bugfixes
+
 ### WLED release 0.14.0-b1
 
 #### Build 2212222
 
 -   Version bump to v0.14.0-b1 "Hoshi"
--   Full changelog TBD
+-   2D matrix support (including mapping 1D effects to 2D and 2D peek)
+-   [internal] completely rewritten Segment & WS2812FX handling code
+-   [internal] ability to add custom effects via usermods
+-   [internal] set of 2D drawing functions
+-   transitions on every segment (including ESP8266)
+-   enhanced old and new 2D effects (metadata: default values)
+-   custom palettes (up to 10; upload palette0.json, palette1.json, ...)
+-   custom effect sliders and options, quick filters
+-   global I2C and SPI GPIO allocation (for usermods)
+-   usermod settings page enhancements (dropdown & info)
+-   asynchronous preset loading (and added "pd" JSON API call for direct preset apply)
+-   new usermod Boblight (PR #2917)
+-   new usermod PWM Outputs (PR #2912)
+-   new usermod Audioreactive
+-   new usermod Word Clock Matrix (PR #2743)
+-   new usermod Ping Pong Clock (PR #2746)
+-   new usermod ADS1115 (PR #2752)
+-   new usermod Analog Clock (PR #2736)
+-   various usermod enhancements and updates
+-   allow disabling pull-up resistors on buttons
+-   SD card support (PR #2877)
+-   enhanced HTTP API to support custom effect sliders & options (X1, X2, X3, M1, M2, M3)
+-   multiple UDP sync message retries (PR #2830)
+-   network debug printer (PR #2870)
+-   automatic UI PC mode on large displays
+-   removed support for upgrading from pre-0.10 (EEPROM)
+-   support for setting GPIO level when LEDs are off (RMT idle level, ESP32 only) (PR #2478)
+-   Pakistan time-zone (PKT)
+-   ArtPoll support
+-   TM1829 LED support
+-   experimental support for ESP32 S2, S3 and C3
+-   general improvements and bugfixes
 
 ### WLED release 0.13.3
 
@@ -224,7 +613,7 @@
 
 -   Added application level pong websockets reply (#2139)
 -   Use AsyncTCP 1.0.3 as it mitigates the flickering issue from 0.13.0-b2
--   Fixed transition manually updated in preset overriden by field value
+-   Fixed transition manually updated in preset overridden by field value
 
 #### Build 2108050
 
@@ -753,7 +1142,7 @@
 
 #### Build 2011040
 
--   Inversed Rain direction (fixes #1147)
+-   Inverted Rain direction (fixes #1147)
 
 #### Build 2011010
 
@@ -964,7 +1353,7 @@
 
 -   Added module info page to web UI
 -   Added realtime override functionality to web UI
--   Added individial segment power and brightness to web UI
+-   Added individual segment power and brightness to web UI
 -   Added feature to one-click select single segment only by tapping segment name
 -   Removed palette jumping to default if color is changed
 

CONTRIBUTING.md

@@ -2,6 +2,20 @@
 
 Here are a few suggestions to make it easier for you to contribute!
 
+### Describe your PR
+
+Please add a description of your proposed code changes. It does not need to be an exhaustive essay, however a PR with no description or just a few words might not get accepted, simply because very basic information is missing.
+
+A good description helps us to review and understand your proposed changes. For example, you could say a few words about
+* what you try to achieve (new feature, fixing a bug, refactoring, security enhancements, etc.)
+* how your code works (short technical summary - focus on important aspects that might not be obvious when reading the code)
+* testing you performed, known limitations, open ends you possibly could not solve.
+* any areas where you like to get help from an experienced maintainer (yes WLED has become big 😉)
+
+### Target branch for pull requests
+
+Please make all PRs against the `0_15` branch.
+
 ### Code style
 
 When in doubt, it is easiest to replicate the code style you find in the files you want to edit :)
@@ -73,6 +87,6 @@ Good:
 <!-- This is an HTML comment -->
 ```
 
-There is no set character limit for a comment within a line,
-though as a rule of thumb you should wrap your comment if it exceeds the width of your editor window.  
+There is no hard character limit for a comment within a line,
+though as a rule of thumb consider wrapping after 120 characters.
 Inline comments are OK if they describe that line only and are not exceedingly wide.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "wled",
-  "version": "0.14.0-b1",
+  "version": "0.15.0-b1",
   "description": "Tools for WLED project",
   "main": "tools/cdata.js",
   "directories": {
@@ -9,6 +9,7 @@
   },
   "scripts": {
     "build": "node tools/cdata.js",
+    "test": "node --test",
     "dev": "nodemon -e js,html,htm,css,png,jpg,gif,ico,js -w tools/ -w wled00/data/ -x node tools/cdata.js"
   },
   "repository": {
@@ -22,10 +23,10 @@
   },
   "homepage": "https://github.com/Aircoookie/WLED#readme",
   "dependencies": {
-    "clean-css": "^4.2.3",
-    "html-minifier-terser": "^5.1.1",
+    "clean-css": "^5.3.3",
+    "html-minifier-terser": "^7.2.0",
     "inliner": "^1.13.1",
-    "nodemon": "^2.0.4",
+    "nodemon": "^3.0.2",
     "zlib": "^1.0.5"
   }
 }

pio-scripts/build_ui.py

@@ -0,0 +1,3 @@
+Import('env')
+
+env.Execute("npm run build")

pio-scripts/output_bins.py

@@ -22,6 +22,16 @@ def _create_dirs(dirs=["firmware", "map"]):
         if not os.path.isdir("{}{}".format(OUTPUT_DIR, d)):
             os.mkdir("{}{}".format(OUTPUT_DIR, d))
 
+def create_release(source):
+    release_name = _get_cpp_define_value(env, "WLED_RELEASE_NAME")
+    if release_name:
+        _create_dirs(["release"])
+        version = _get_cpp_define_value(env, "WLED_VERSION")
+        # get file extension of source file (.bin or .bin.gz)
+        ext = source.split(".", 1)[1]
+        release_file = "{}release{}WLED_{}_{}.{}".format(OUTPUT_DIR, os.path.sep, version, release_name, ext)
+        shutil.copy(source, release_file)
+
 def bin_rename_copy(source, target, env):
     _create_dirs()
     variant = env["PIOENV"]
@@ -30,14 +40,6 @@ def bin_rename_copy(source, target, env):
     map_file = "{}map{}{}.map".format(OUTPUT_DIR, os.path.sep, variant)
     bin_file = "{}firmware{}{}.bin".format(OUTPUT_DIR, os.path.sep, variant)
 
-    release_name = _get_cpp_define_value(env, "WLED_RELEASE_NAME")
-
-    if release_name:
-        _create_dirs(["release"])
-        version = _get_cpp_define_value(env, "WLED_VERSION")
-        release_file = "{}release{}WLED_{}_{}.bin".format(OUTPUT_DIR, os.path.sep, version, release_name)
-        shutil.copy(str(target[0]), release_file)
-
     # check if new target files exist and remove if necessary
     for f in [map_file, bin_file]:
         if os.path.isfile(f):
@@ -46,6 +48,8 @@ def bin_rename_copy(source, target, env):
     # copy firmware.bin to firmware/<variant>.bin
     shutil.copy(str(target[0]), bin_file)
 
+    create_release(bin_file)
+
     # copy firmware.map to map/<variant>.map
     if os.path.isfile("firmware.map"):
         shutil.move("firmware.map", map_file)
@@ -66,4 +70,6 @@ def bin_gzip(source, target, env):
         with gzip.open(gzip_file, "wb", compresslevel = 9) as f:
             shutil.copyfileobj(fp, f)
 
+    create_release(gzip_file)
+
 env.AddPostAction("$BUILD_DIR/${PROGNAME}.bin", [bin_rename_copy, bin_gzip])

platformio.ini

@@ -9,33 +9,8 @@
 # (use `platformio_override.ini` when building for your own board; see `platformio_override.ini.sample` for an example)
 # ------------------------------------------------------------------------------
 
-# Release / CI binaries
-default_envs = nodemcuv2, esp8266_2m, esp01_1m_full, esp32dev, esp32_eth, esp32s2_saola, esp32c3, esp32s3dev_8MB
-
-# Build everything
-; default_envs = esp32dev, esp8285_4CH_MagicHome, codm-controller-0.6-rev2, codm-controller-0.6, esp32s2_saola, d1_mini_5CH_Shojo_PCB, d1_mini, sp501e, nodemcuv2, esp32_eth, anavi_miracle_controller, esp07, esp01_1m_full, m5atom, h803wf, d1_mini_ota, heltec_wifi_kit_8, esp8285_H801, d1_mini_debug, wemos_shield_esp32, elekstube_ips
-
-# Single binaries (uncomment your board)
-; default_envs = elekstube_ips
-; default_envs = nodemcuv2
-; default_envs = esp8266_2m
-; default_envs = esp01_1m_full
-; default_envs = esp07
-; default_envs = d1_mini
-; default_envs = heltec_wifi_kit_8
-; default_envs = h803wf
-; default_envs = d1_mini_debug
-; default_envs = d1_mini_ota
-; default_envs = esp32dev
-; default_envs = esp8285_4CH_MagicHome
-; default_envs = esp8285_H801
-; default_envs = d1_mini_5CH_Shojo_PCB
-; default_envs = wemos_shield_esp32
-; default_envs = m5atom
-; default_envs = esp32_eth
-; default_envs = esp32dev_qio80
-; default_envs = esp32_eth_ota1mapp
-; default_envs = esp32s2_saola
+# CI/release binaries
+default_envs = nodemcuv2, esp8266_2m, esp01_1m_full, nodemcuv2_160, esp8266_2m_160, esp01_1m_full_160, esp32dev, esp32_eth, esp32dev_audioreactive, lolin_s2_mini, esp32c3dev, esp32s3dev_8MB, esp32s3dev_8MB_PSRAM_opi, esp32_wrover
 
 src_dir  = ./wled00
 data_dir = ./wled00/data
@@ -54,27 +29,40 @@ extra_configs =
 arduino_core_2_6_3 = espressif8266@2.3.3
 arduino_core_2_7_4 = espressif8266@2.6.2
 arduino_core_3_0_0 = espressif8266@3.0.0
-arduino_core_3_2_0 = espressif8266@3.2.0
+arduino_core_3_0_2 = espressif8266@3.2.0
+arduino_core_3_1_0 = espressif8266@4.1.0
+arduino_core_3_1_2 = espressif8266@4.2.1
 
 # Development platforms
 arduino_core_develop = https://github.com/platformio/platform-espressif8266#develop
 arduino_core_git = https://github.com/platformio/platform-espressif8266#feature/stage
 
 # Platform to use for ESP8266
-platform_wled_default = ${common.arduino_core_3_2_0}
+platform_wled_default = ${common.arduino_core_3_1_2}
 # We use 2.7.4.7 for all, includes PWM flicker fix and Wstring optimization
-platform_packages = tasmota/framework-arduinoespressif8266 @ 3.20704.7
-                    platformio/toolchain-xtensa @ ~2.40802.200502
-                    platformio/tool-esptool @ ~1.413.0
-                    platformio/tool-esptoolpy @ ~1.30000.0
+#platform_packages = tasmota/framework-arduinoespressif8266 @ 3.20704.7
+platform_packages = platformio/framework-arduinoespressif8266
+                    platformio/toolchain-xtensa @ ~2.100300.220621 #2.40802.200502
+                    platformio/tool-esptool #@ ~1.413.0
+                    platformio/tool-esptoolpy #@ ~1.30000.0
+
+## previous platform for 8266, in case of problems with the new one
+## you'll need  makuna/NeoPixelBus@ 2.6.9 for arduino_core_3_2_0, which does not support Ucs890x
+;; platform_wled_default = ${common.arduino_core_3_2_0}
+;; platform_packages = tasmota/framework-arduinoespressif8266 @ 3.20704.7
+;;                    platformio/toolchain-xtensa @ ~2.40802.200502
+;;                    platformio/tool-esptool @ ~1.413.0
+;;                    platformio/tool-esptoolpy @ ~1.30000.0
 
 # ------------------------------------------------------------------------------
 # FLAGS: DEBUG
-#
+# esp8266 : see https://docs.platformio.org/en/latest/platforms/espressif8266.html#debug-level
+# esp32   : see https://docs.platformio.org/en/latest/platforms/espressif32.html#debug-level
 # ------------------------------------------------------------------------------
-debug_flags = -D DEBUG=1 -D WLED_DEBUG -DDEBUG_ESP_WIFI -DDEBUG_ESP_HTTP_CLIENT -DDEBUG_ESP_HTTP_UPDATE -DDEBUG_ESP_HTTP_SERVER -DDEBUG_ESP_UPDATER -DDEBUG_ESP_OTA -DDEBUG_TLS_MEM
-#if needed (for memleaks etc) also add; -DDEBUG_ESP_OOM -include "umm_malloc/umm_malloc_cfg.h"
-#-DDEBUG_ESP_CORE is not working right now
+debug_flags = -D DEBUG=1 -D WLED_DEBUG
+  -DDEBUG_ESP_WIFI -DDEBUG_ESP_HTTP_CLIENT -DDEBUG_ESP_HTTP_UPDATE -DDEBUG_ESP_HTTP_SERVER -DDEBUG_ESP_UPDATER -DDEBUG_ESP_OTA -DDEBUG_TLS_MEM ;; for esp8266
+  # if needed (for memleaks etc) also add; -DDEBUG_ESP_OOM -include "umm_malloc/umm_malloc_cfg.h"
+  # -DDEBUG_ESP_CORE is not working right now
 
 # ------------------------------------------------------------------------------
 # FLAGS: ldscript (available ldscripts at https://github.com/esp8266/Arduino/tree/master/tools/sdk/ld)
@@ -99,11 +87,13 @@ debug_flags = -D DEBUG=1 -D WLED_DEBUG -DDEBUG_ESP_WIFI -DDEBUG_ESP_HTTP_CLIENT
 #  This reduces the OTA size with ~45KB, so it's especially useful on low memory boards (512k/1m).
 # ------------------------------------------------------------------------------
 build_flags =
+  -Wno-attributes
   -DMQTT_MAX_PACKET_SIZE=1024
   -DSECURE_CLIENT=SECURE_CLIENT_BEARSSL
   -DBEARSSL_SSL_BASIC
   -D CORE_DEBUG_LEVEL=0
   -D NDEBUG
+  -Wno-attributes ;; silence warnings about unknown attribute 'maybe_unused' in NeoPixelBus
   #build_flags for the IRremoteESP8266 library (enabled decoders have to appear here)
   -D _IR_ENABLE_DEFAULT_=false
   -D DECODE_HASH=true
@@ -111,16 +101,13 @@ build_flags =
   -D DECODE_SONY=true
   -D DECODE_SAMSUNG=true
   -D DECODE_LG=true
-  ; -Dregister= # remove warnings in C++17 due to use of deprecated register keyword by the FastLED library
   -DWLED_USE_MY_CONFIG
-  ; -D USERMOD_SENSORSTOMQTT
-  #For ADS1115 sensor uncomment following
-  ; -D USERMOD_ADS1115
 
 build_unflags =
 
 build_flags_esp8266 = ${common.build_flags}  ${esp8266.build_flags}
 build_flags_esp32   = ${common.build_flags}  ${esp32.build_flags}
+build_flags_esp32_V4= ${common.build_flags}  ${esp32_idf_V4.build_flags}
 
 ldscript_1m128k = eagle.flash.1m128.ld
 ldscript_2m512k = eagle.flash.2m512.ld
@@ -133,6 +120,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/build_ui.py
 
 # ------------------------------------------------------------------------------
 # COMMON SETTINGS:
@@ -141,39 +129,50 @@ extra_scripts =
 framework = arduino
 board_build.flash_mode = dout
 monitor_speed = 115200
-# slow upload speed (comment this out with a ';' when building for development use)
+# slow upload speed but most compatible (use platformio_override.ini to use faster speed)
 upload_speed = 115200
-# fast upload speed (remove ';' when building for development use)
-; upload_speed = 921600
 
 # ------------------------------------------------------------------------------
 # LIBRARIES: required dependencies
 #   Please note that we don't always use the latest version of a library.
 #
-#   The following libraries have been included (and some of them changd) in the source:
-#     ArduinoJson@5.13.5, Blynk@0.5.4(changed), E131@1.0.0(changed), Time@1.5, Timezone@1.2.1
+#   The following libraries have been included (and some of them changed) in the source:
+#     ArduinoJson@5.13.5, E131@1.0.0(changed), Time@1.5, Timezone@1.2.1
 # ------------------------------------------------------------------------------
 lib_compat_mode = strict
 lib_deps =
-    fastled/FastLED @ 3.5.0
+    fastled/FastLED @ 3.6.0
     IRremoteESP8266 @ 2.8.2
-    https://github.com/Aircoookie/ESPAsyncWebServer.git @ ~2.0.7
+    makuna/NeoPixelBus @ 2.7.5
+    https://github.com/Aircoookie/ESPAsyncWebServer.git @ ^2.1.0
+  # for I2C interface
+    ;Wire
+  # ESP-NOW library
+    ;gmag11/QuickESPNow @ ~0.7.0
+    https://github.com/blazoncek/QuickESPNow.git#optional-debug
   #For use of the TTGO T-Display ESP32 Module with integrated TFT display uncomment the following line
     #TFT_eSPI
-  #For use SSD1306 OLED display uncomment following
-    #U8g2@~2.28.8
-    #U8g2@~2.32.10
-  #For Dallas sensor uncomment following 2 lines
-    #OneWire@~2.3.5
-    #milesburton/DallasTemperature@^3.9.0
+  #For compatible OLED display uncomment following
+    #olikraus/U8g2 #@ ~2.33.15
+  #For Dallas sensor uncomment following
+    #paulstoffregen/OneWire @ ~2.3.8
   #For BME280 sensor uncomment following
-    #BME280@~3.0.0
-    ; adafruit/Adafruit BMP280 Library @ 2.1.0
-    ; adafruit/Adafruit CCS811 Library @ 1.0.4
-    ; adafruit/Adafruit Si7021 Library @ 1.4.0
+    #BME280 @ ~3.0.0
+    ;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
+    ;adafruit/Adafruit BusIO @ 1.13.2
+    ;adafruit/Adafruit ADS1X15 @ 2.4.0
+  #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.0
 
 extra_scripts = ${scripts_defaults.extra_scripts}
 
@@ -182,97 +181,123 @@ build_flags =
   -DESP8266
   -DFP_IN_IROM
   ;-Wno-deprecated-declarations
-  ;-Wno-register
-	;-Wno-misleading-indentation
-; NONOSDK22x_190703 = 2.2.2-dev(38a443e)
+  ;-Wno-register  ;; leaves some warnings when compiling C files: command-line option '-Wno-register' is valid for C++/ObjC++ but not for C
+  ;-Dregister= # remove warnings in C++17 due to use of deprecated register keyword by the FastLED library ;; warning: this can be dangerous
+  -Wno-misleading-indentation
+  ; NONOSDK22x_190703 = 2.2.2-dev(38a443e)
   -DPIO_FRAMEWORK_ARDUINO_ESPRESSIF_SDK22x_190703
-; lwIP 2 - Higher Bandwidth no Features
-;  -DPIO_FRAMEWORK_ARDUINO_LWIP2_HIGHER_BANDWIDTH_LOW_FLASH
-; lwIP 1.4 - Higher Bandwidth (Aircoookie has)
-   -DPIO_FRAMEWORK_ARDUINO_LWIP_HIGHER_BANDWIDTH
-; VTABLES in Flash
+  ; lwIP 2 - Higher Bandwidth no Features
+  ;  -DPIO_FRAMEWORK_ARDUINO_LWIP2_HIGHER_BANDWIDTH_LOW_FLASH
+  ; lwIP 1.4 - Higher Bandwidth (Aircoookie has)
+  -DPIO_FRAMEWORK_ARDUINO_LWIP_HIGHER_BANDWIDTH
+  ; VTABLES in Flash
   -DVTABLES_IN_FLASH
-; restrict to minimal mime-types
+  ; restrict to minimal mime-types
   -DMIMETYPE_MINIMAL
+  ; other special-purpose framework flags (see https://docs.platformio.org/en/latest/platforms/espressif8266.html)
+  ; decrease code cache size and increase IRAM to fit all pixel functions
+  -D PIO_FRAMEWORK_ARDUINO_MMU_CACHE16_IRAM48 ;; in case of linker errors like "section `.text1' will not fit in region `iram1_0_seg'"
+  ; -D PIO_FRAMEWORK_ARDUINO_MMU_CACHE16_IRAM48_SECHEAP_SHARED ;; (experimental) adds some extra heap, but may cause slowdown
 
-lib_deps = 
-  ${env.lib_deps}
+lib_deps =
   #https://github.com/lorol/LITTLEFS.git
   ESPAsyncTCP @ 1.2.2
   ESPAsyncUDP
-  makuna/NeoPixelBus @ 2.6.9
+  ${env.lib_deps}
 
 [esp32]
 #platform = https://github.com/tasmota/platform-espressif32/releases/download/v2.0.2.3/platform-espressif32-2.0.2.3.zip
 platform = espressif32@3.5.0
-
 platform_packages = framework-arduinoespressif32 @ https://github.com/Aircoookie/arduino-esp32.git#1.0.6.4
-
 build_flags = -g
   -DARDUINO_ARCH_ESP32
   #-DCONFIG_LITTLEFS_FOR_IDF_3_2
   -D CONFIG_ASYNC_TCP_USE_WDT=0
-#use LITTLEFS library by lorol in ESP32 core 1.x.x instead of built-in in 2.x.x
+  #use LITTLEFS library by lorol in ESP32 core 1.x.x instead of built-in in 2.x.x
   -D LOROL_LITTLEFS
-  ; -DARDUINO_USB_CDC_ON_BOOT=0 ;; this flag is mandatory for "classic ESP32" when builing with arduino-esp32 >=2.0.3
-
+  ; -DARDUINO_USB_CDC_ON_BOOT=0 ;; this flag is mandatory for "classic ESP32" when building with arduino-esp32 >=2.0.3
 default_partitions = tools/WLED_ESP32_4MB_1MB_FS.csv
-
 lib_deps =
-  ${env.lib_deps}
   https://github.com/lorol/LITTLEFS.git
-  makuna/NeoPixelBus @ 2.6.9
   https://github.com/pbolduc/AsyncTCP.git @ 1.2.0
+  ${env.lib_deps}
+# additional build flags for audioreactive
+AR_build_flags = -D USERMOD_AUDIOREACTIVE
+AR_lib_deps = kosme/arduinoFFT @ 2.0.0
+
+[esp32_idf_V4]
+;; experimental build environment for ESP32 using ESP-IDF 4.4.x / arduino-esp32 v2.0.5
+;; very similar to the normal ESP32 flags, but omitting Lorol LittleFS, as littlefs is included in the new framework already.
+;;
+;; please note that you can NOT update existing ESP32 installs with a "V4" build. Also updating by OTA will not work properly.
+;; You need to completely erase your device (esptool erase_flash) first, then install the "V4" build from VSCode+platformio.
+platform = espressif32@5.3.0
+platform_packages =
+build_flags = -g
+  -Wshadow=compatible-local ;; emit warning in case a local variable "shadows" another local one
+  -DARDUINO_ARCH_ESP32 -DESP32
+  #-DCONFIG_LITTLEFS_FOR_IDF_3_2
+  -D CONFIG_ASYNC_TCP_USE_WDT=0
+  -DARDUINO_USB_CDC_ON_BOOT=0 ;; this flag is mandatory for "classic ESP32" when building with arduino-esp32 >=2.0.3
+default_partitions = tools/WLED_ESP32_4MB_1MB_FS.csv
+lib_deps =
+  https://github.com/pbolduc/AsyncTCP.git @ 1.2.0
+  ${env.lib_deps}
 
 [esp32s2]
+;; generic definitions for all ESP32-S2 boards
+platform = espressif32@5.3.0
+platform_packages =
+default_partitions = tools/WLED_ESP32_4MB_1MB_FS.csv
 build_flags = -g
   -DARDUINO_ARCH_ESP32
   -DARDUINO_ARCH_ESP32S2
-  -DCONFIG_IDF_TARGET_ESP32S2
+  -DCONFIG_IDF_TARGET_ESP32S2=1
   -D CONFIG_ASYNC_TCP_USE_WDT=0
+  -DARDUINO_USB_MSC_ON_BOOT=0 -DARDUINO_USB_DFU_ON_BOOT=0
   -DCO
   -DARDUINO_USB_MODE=0 ;; this flag is mandatory for ESP32-S2 !
   ;; please make sure that the following flags are properly set (to 0 or 1) by your board.json, or included in your custom platformio_override.ini entry:
-  ;; ARDUINO_USB_CDC_ON_BOOT, ARDUINO_USB_MSC_ON_BOOT, ARDUINO_USB_DFU_ON_BOOT
-
+  ;; ARDUINO_USB_CDC_ON_BOOT
 lib_deps =
-  ${env.lib_deps}
-  makuna/NeoPixelBus @ 2.6.9
   https://github.com/pbolduc/AsyncTCP.git @ 1.2.0
+  ${env.lib_deps}
 
 [esp32c3]
+;; generic definitions for all ESP32-C3 boards
+platform = espressif32@5.3.0
+platform_packages =
 build_flags = -g
   -DARDUINO_ARCH_ESP32
   -DARDUINO_ARCH_ESP32C3
-  -DCONFIG_IDF_TARGET_ESP32C3
+  -DCONFIG_IDF_TARGET_ESP32C3=1
   -D CONFIG_ASYNC_TCP_USE_WDT=0
   -DCO
   -DARDUINO_USB_MODE=1 ;; this flag is mandatory for ESP32-C3
   ;; please make sure that the following flags are properly set (to 0 or 1) by your board.json, or included in your custom platformio_override.ini entry:
   ;; ARDUINO_USB_CDC_ON_BOOT
-
 lib_deps =
-  ${env.lib_deps}
-  makuna/NeoPixelBus @ 2.6.9
   https://github.com/pbolduc/AsyncTCP.git @ 1.2.0
+  ${env.lib_deps}
 
 [esp32s3]
 ;; generic definitions for all ESP32-S3 boards
+platform = espressif32@5.3.0
+platform_packages =
 build_flags = -g
   -DESP32
   -DARDUINO_ARCH_ESP32
   -DARDUINO_ARCH_ESP32S3
-  -DCONFIG_IDF_TARGET_ESP32S3
+  -DCONFIG_IDF_TARGET_ESP32S3=1
   -D CONFIG_ASYNC_TCP_USE_WDT=0
+  -DARDUINO_USB_MSC_ON_BOOT=0 -DARDUINO_DFU_ON_BOOT=0
   -DCO
   ;; please make sure that the following flags are properly set (to 0 or 1) by your board.json, or included in your custom platformio_override.ini entry:
-  ;; ARDUINO_USB_MODE, ARDUINO_USB_CDC_ON_BOOT, ARDUINO_USB_MSC_ON_BOOT, ARDUINO_USB_DFU_ON_BOOT
+  ;; ARDUINO_USB_MODE, ARDUINO_USB_CDC_ON_BOOT
 
 lib_deps =
-  ${env.lib_deps}
-  ;; NeoPixelBus 2.7.1 is the first that has official support for ESP32-S3
-  makuna/NeoPixelBus @ ~2.7.1
   https://github.com/pbolduc/AsyncTCP.git @ 1.2.0
+  ${env.lib_deps}
 
 
 # ------------------------------------------------------------------------------
@@ -285,87 +310,68 @@ platform = ${common.platform_wled_default}
 platform_packages = ${common.platform_packages}
 board_build.ldscript = ${common.ldscript_4m1m}
 build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp8266} -D WLED_RELEASE_NAME=ESP8266 -D WLED_DISABLE_BLYNK #-DWLED_DISABLE_2D
+build_flags = ${common.build_flags_esp8266} -D WLED_RELEASE_NAME=ESP8266 #-DWLED_DISABLE_2D
 lib_deps = ${esp8266.lib_deps}
 monitor_filters = esp8266_exception_decoder
 
+[env:nodemcuv2_160]
+extends = env:nodemcuv2
+board_build.f_cpu = 160000000L
+build_flags = ${common.build_flags_esp8266} -D WLED_RELEASE_NAME=ESP8266_160 #-DWLED_DISABLE_2D
+
 [env:esp8266_2m]
 board = esp_wroom_02
 platform = ${common.platform_wled_default}
 platform_packages = ${common.platform_packages}
 board_build.ldscript = ${common.ldscript_2m512k}
 build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp8266} -D WLED_RELEASE_NAME=ESP02 -D WLED_DISABLE_BLYNK
+build_flags = ${common.build_flags_esp8266} -D WLED_RELEASE_NAME=ESP02
 lib_deps = ${esp8266.lib_deps}
 
+[env:esp8266_2m_160]
+extends = env:esp8266_2m
+board_build.f_cpu = 160000000L
+build_flags = ${common.build_flags_esp8266} -D WLED_RELEASE_NAME=ESP02_160
+
 [env:esp01_1m_full]
 board = esp01_1m
 platform = ${common.platform_wled_default}
 platform_packages = ${common.platform_packages}
 board_build.ldscript = ${common.ldscript_1m128k}
 build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp8266} -D WLED_RELEASE_NAME=ESP01 -D WLED_DISABLE_OTA -D WLED_DISABLE_BLYNK
+build_flags = ${common.build_flags_esp8266} -D WLED_RELEASE_NAME=ESP01 -D WLED_DISABLE_OTA
+  ; -D WLED_USE_UNREAL_MATH ;; may cause wrong sunset/sunrise times, but saves 7064 bytes FLASH and 975 bytes RAM
 lib_deps = ${esp8266.lib_deps}
 
-[env:esp07]
-board = esp07
-platform = ${common.platform_wled_default}
-platform_packages = ${common.platform_packages}
-board_build.ldscript = ${common.ldscript_4m1m}
-build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp8266}
-lib_deps = ${esp8266.lib_deps}
-
-[env:d1_mini]
-board = d1_mini
-platform = ${common.platform_wled_default}
-platform_packages = ${common.platform_packages}
-upload_speed = 921600
-board_build.ldscript = ${common.ldscript_4m1m}
-build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp8266}
-lib_deps = ${esp8266.lib_deps}
-monitor_filters = esp8266_exception_decoder
-
-[env:heltec_wifi_kit_8]
-board = d1_mini
-platform = ${common.platform_wled_default}
-platform_packages = ${common.platform_packages}
-board_build.ldscript = ${common.ldscript_4m1m}
-build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp8266}
-lib_deps = ${esp8266.lib_deps}
-
-[env:h803wf]
-board = d1_mini
-platform = ${common.platform_wled_default}
-platform_packages = ${common.platform_packages}
-board_build.ldscript = ${common.ldscript_4m1m}
-build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp8266} -D LEDPIN=1 -D WLED_DISABLE_INFRARED
-lib_deps = ${esp8266.lib_deps}
+[env:esp01_1m_full_160]
+extends = env:esp01_1m_full
+board_build.f_cpu = 160000000L
+build_flags = ${common.build_flags_esp8266} -D WLED_RELEASE_NAME=ESP01_160 -D WLED_DISABLE_OTA
+  ; -D WLED_USE_UNREAL_MATH ;; may cause wrong sunset/sunrise times, but saves 7064 bytes FLASH and 975 bytes RAM
 
 [env:esp32dev]
 board = esp32dev
 platform = ${esp32.platform}
 platform_packages = ${esp32.platform_packages}
 build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp32} -D WLED_RELEASE_NAME=ESP32 -D WLED_DISABLE_BLYNK #-D WLED_DISABLE_BROWNOUT_DET
+build_flags = ${common.build_flags_esp32} -D WLED_RELEASE_NAME=ESP32 #-D WLED_DISABLE_BROWNOUT_DET
 lib_deps = ${esp32.lib_deps}
 monitor_filters = esp32_exception_decoder
 board_build.partitions = ${esp32.default_partitions}
 
-[env:esp32dev_qio80]
+[env:esp32dev_audioreactive]
 board = esp32dev
 platform = ${esp32.platform}
 platform_packages = ${esp32.platform_packages}
 build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp32} -D WLED_RELEASE_NAME=ESP32_qio80 -D WLED_DISABLE_BLYNK #-D WLED_DISABLE_BROWNOUT_DET
+build_flags = ${common.build_flags_esp32} -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
-board_build.flash_mode = qio
+; board_build.f_flash = 80000000L
+; board_build.flash_mode = dio
 
 [env:esp32_eth]
 board = esp32-poe
@@ -373,30 +379,36 @@ platform = ${esp32.platform}
 platform_packages = ${esp32.platform_packages}
 upload_speed = 921600
 build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp32} -D WLED_RELEASE_NAME=ESP32_Ethernet -D RLYPIN=-1 -D WLED_USE_ETHERNET -D BTNPIN=-1 -D WLED_DISABLE_BLYNK
+build_flags = ${common.build_flags_esp32} -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
 lib_deps = ${esp32.lib_deps}
 board_build.partitions = ${esp32.default_partitions}
 
-[env:esp32s2_saola]
-board = esp32-s2-saola-1
-platform = https://github.com/tasmota/platform-espressif32/releases/download/v2.0.2.2/platform-tasmota-espressif32-2.0.2.zip
-platform_packages =
-framework = arduino
-board_build.partitions = tools/WLED_ESP32_4MB_1MB_FS.csv
+[env:esp32_wrover]
+platform = ${esp32.platform}
+board = ttgo-t7-v14-mini32
+board_build.f_flash = 80000000L
 board_build.flash_mode = qio
-upload_speed = 460800
+board_build.partitions = ${esp32.default_partitions}
 build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags} ${esp32s2.build_flags} #-D WLED_RELEASE_NAME=S2_saola
-lib_deps = ${esp32s2.lib_deps}
+build_flags = ${common.build_flags_esp32} -D WLED_RELEASE_NAME=ESP32_WROVER
+  -DBOARD_HAS_PSRAM -mfix-esp32-psram-cache-issue
+  -D WLED_USE_PSRAM
+  -D LEDPIN=25
+lib_deps = ${esp32.lib_deps}
 
-[env:esp32c3]
-platform = espressif32@5.1.1
+[env:esp32c3dev]
+extends = esp32c3
+platform = ${esp32c3.platform}
+platform_packages = ${esp32c3.platform_packages}
 framework = arduino
 board = esp32-c3-devkitm-1
 board_build.partitions = tools/WLED_ESP32_4MB_1MB_FS.csv
-build_flags = ${common.build_flags} ${esp32c3.build_flags} #-D WLED_RELEASE_NAME=ESP32-C3
+build_flags = ${common.build_flags} ${esp32c3.build_flags} -D WLED_RELEASE_NAME=ESP32-C3
   -D WLED_WATCHDOG_TIMEOUT=0
-  ; -DARDUINO_USB_CDC_ON_BOOT=1 ;; for virtual USB
+  -DLOLIN_WIFI_FIX ; seems to work much better with this
+  -DARDUINO_USB_CDC_ON_BOOT=1 ;; for virtual CDC USB
+  ;-DARDUINO_USB_CDC_ON_BOOT=0   ;; for serial-to-USB chip
 upload_speed = 460800
 build_unflags = ${common.build_unflags}
 lib_deps = ${esp32c3.lib_deps}
@@ -404,14 +416,14 @@ lib_deps = ${esp32c3.lib_deps}
 [env:esp32s3dev_8MB]
 ;; ESP32-S3-DevKitC-1 development board, with 8MB FLASH, no PSRAM (flash_mode: qio)
 board = esp32-s3-devkitc-1
-platform = espressif32@5.1.1
-platform_packages =
+platform = ${esp32s3.platform}
+platform_packages = ${esp32s3.platform_packages}
 upload_speed = 921600 ; or  460800
 build_unflags = ${common.build_unflags}
-build_flags =  ${common.build_flags} ${esp32s3.build_flags} 
+build_flags = ${common.build_flags} ${esp32s3.build_flags} -D WLED_RELEASE_NAME=ESP32-S3_8MB
   -D CONFIG_LITTLEFS_FOR_IDF_3_2 -D WLED_WATCHDOG_TIMEOUT=0
-  -D ARDUINO_USB_CDC_ON_BOOT=0 -D ARDUINO_USB_MSC_ON_BOOT=0 -D ARDUINO_DFU_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_MSC_ON_BOOT=0 -D ARDUINO_DFU_ON_BOOT=0 ; -D ARDUINO_USB_MODE=0 ;; for boards with USB-OTG connector only (USBCDC or "TinyUSB")
+  -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")
   ;-D WLED_DEBUG
 lib_deps = ${esp32s3.lib_deps}
 board_build.partitions = tools/WLED_ESP32_8MB.csv
@@ -420,18 +432,18 @@ board_build.flash_mode = qio
 ; board_build.flash_mode = dio   ;; try this if you have problems at startup
 monitor_filters = esp32_exception_decoder
 
-[env:esp32s3dev_8MB_PSRAM]
-;; ESP32-TinyS3 development board, with 8MB FLASH and 8MB PSRAM (memory_type: qio_opi, qio_qspi, or opi_opi)
-;board = um_tinys3 ;    -> needs workaround from https://github.com/Aircoookie/WLED/pull/2905#issuecomment-1328049860
-;board = esp32s3box   ; -> error: 'esp32_adc2gpio' was not declared in this scope
-board = esp32-s3-devkitc-1 ; -> compiles, but does not support PSRAM
-platform = espressif32 @ ~5.2.0
-platform_packages = 
+[env:esp32s3dev_8MB_PSRAM_opi]
+;; ESP32-S3 development board, with 8MB FLASH and >= 8MB PSRAM (memory_type: qio_opi)
+board = esp32-s3-devkitc-1 ;; generic dev board; the next line adds PSRAM support
+board_build.arduino.memory_type = qio_opi     ;; use with PSRAM: 8MB or 16MB
+platform = ${esp32s3.platform}
+platform_packages = ${esp32s3.platform_packages}
 upload_speed = 921600
 build_unflags = ${common.build_unflags}
-build_flags =  ${common.build_flags} ${esp32s3.build_flags} 
+build_flags = ${common.build_flags} ${esp32s3.build_flags} -D WLED_RELEASE_NAME=ESP32-S3_8MB_PSRAM_opi
   -D CONFIG_LITTLEFS_FOR_IDF_3_2 -D WLED_WATCHDOG_TIMEOUT=0
-  -D ARDUINO_USB_MODE=1 -D ARDUINO_USB_MSC_ON_BOOT=0 ; -D ARDUINO_USB_CDC_ON_BOOT=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")
   ; -D WLED_RELEASE_NAME=ESP32-S3_PSRAM
   -D WLED_USE_PSRAM -DBOARD_HAS_PSRAM ; tells WLED that PSRAM shall be used
 lib_deps = ${esp32s3.lib_deps}
@@ -440,83 +452,24 @@ board_build.f_flash = 80000000L
 board_build.flash_mode = qio
 monitor_filters = esp32_exception_decoder
 
-[env:esp8285_4CH_MagicHome]
-board = esp8285
-platform = ${common.platform_wled_default}
-platform_packages = ${common.platform_packages}
-board_build.ldscript = ${common.ldscript_1m128k}
-build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp8266} -D WLED_DISABLE_OTA
-lib_deps = ${esp8266.lib_deps}
-
-[env:esp8285_H801]
-board = esp8285
-platform = ${common.platform_wled_default}
-platform_packages = ${common.platform_packages}
-board_build.ldscript = ${common.ldscript_1m128k}
-build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp8266} -D WLED_DISABLE_OTA
-lib_deps = ${esp8266.lib_deps}
-
-[env:d1_mini_5CH_Shojo_PCB]
-board = d1_mini
-platform = ${common.platform_wled_default}
-platform_packages = ${common.platform_packages}
-board_build.ldscript = ${common.ldscript_4m1m}
-build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp8266} -D WLED_USE_SHOJO_PCB
-lib_deps = ${esp8266.lib_deps}
-
-# ------------------------------------------------------------------------------
-# DEVELOPMENT BOARDS
-# ------------------------------------------------------------------------------
-
-[env:d1_mini_debug]
-board = d1_mini
-build_type = debug
-platform = ${common.platform_wled_default}
-platform_packages = ${common.platform_packages}
-board_build.ldscript = ${common.ldscript_4m1m}
-build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp8266} ${common.debug_flags}
-lib_deps = ${esp8266.lib_deps}
-
-[env:d1_mini_ota]
-board = d1_mini
-upload_protocol = espota
-# exchange for your WLED IP
-upload_port = "10.10.1.27"
-platform = ${common.platform_wled_default}
-platform_packages = ${common.platform_packages}
-board_build.ldscript = ${common.ldscript_4m1m}
-build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp8266}
-lib_deps = ${esp8266.lib_deps}
-
-[env:anavi_miracle_controller]
-board = d1_mini
-platform = ${common.platform_wled_default}
-platform_packages = ${common.platform_packages}
-board_build.ldscript = ${common.ldscript_4m1m}
-build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp8266} -D LEDPIN=12 -D IRPIN=-1 -D RLYPIN=2
-lib_deps = ${esp8266.lib_deps}
-
 [env:lolin_s2_mini]
-platform = espressif32@5.1.1
+platform = ${esp32s2.platform}
+platform_packages = ${esp32s2.platform_packages}
 board = lolin_s2_mini
 board_build.partitions = tools/WLED_ESP32_4MB_1MB_FS.csv
+;board_build.flash_mode = qio
+;board_build.f_flash = 80000000L
 build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags} ${esp32s2.build_flags} #-D WLED_RELEASE_NAME=LolinS2
+build_flags = ${common.build_flags} ${esp32s2.build_flags} -D WLED_RELEASE_NAME=ESP32-S2
   -DBOARD_HAS_PSRAM
-  -D ARDUINO_USB_CDC_ON_BOOT
+  -DARDUINO_USB_CDC_ON_BOOT=1
+  -DARDUINO_USB_MSC_ON_BOOT=0
+  -DARDUINO_USB_DFU_ON_BOOT=0
+  -DLOLIN_WIFI_FIX ; seems to work much better with this
   -D WLED_USE_PSRAM
   -D WLED_WATCHDOG_TIMEOUT=0
   -D CONFIG_ASYNC_TCP_USE_WDT=0
   -D LEDPIN=16
-  -D BTNPIN=18
-  -D RLYPIN=9
-  -D IRPIN=7
   -D HW_PIN_SCL=35
   -D HW_PIN_SDA=33
   -D HW_PIN_CLOCKSPI=7
@@ -524,130 +477,3 @@ build_flags = ${common.build_flags} ${esp32s2.build_flags} #-D WLED_RELEASE_NAME
   -D HW_PIN_MISOSPI=9
 ;  -D STATUSLED=15
 lib_deps = ${esp32s2.lib_deps}
-
-# ------------------------------------------------------------------------------
-# custom board configurations
-# ------------------------------------------------------------------------------
-
-[env:wemos_shield_esp32]
-board = esp32dev
-platform = espressif32@3.2
-upload_speed = 460800
-build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp32}
-  -D LEDPIN=16
-  -D RLYPIN=19
-  -D BTNPIN=17
-  -D IRPIN=18
-  -D UWLED_USE_MY_CONFIG
-  -D USERMOD_DALLASTEMPERATURE
-  -D USERMOD_FOUR_LINE_DISPLAY
-  -D TEMPERATURE_PIN=23
-  -D USE_ALT_DISPlAY ; new versions of USERMOD_FOUR_LINE_DISPLAY and USERMOD_ROTARY_ENCODER_UI
-  -D USERMOD_AUDIOREACTIVE
-lib_deps = ${esp32.lib_deps}
-  OneWire@~2.3.5
-  olikraus/U8g2 @ ^2.28.8
-  https://github.com/blazoncek/arduinoFFT.git
-board_build.partitions = ${esp32.default_partitions}
-
-[env:m5atom]
-board = esp32dev
-build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp32} -D LEDPIN=27 -D BTNPIN=39
-lib_deps = ${esp32.lib_deps}
-platform = espressif32@3.2
-board_build.partitions = ${esp32.default_partitions}
-
-[env:sp501e]
-board = esp_wroom_02
-platform = ${common.platform_wled_default}
-board_build.ldscript = ${common.ldscript_2m512k}
-build_flags = ${common.build_flags_esp8266} -D LEDPIN=3 -D BTNPIN=1
-lib_deps = ${esp8266.lib_deps}
-
-[env:sp511e]
-board = esp_wroom_02
-platform = ${common.platform_wled_default}
-board_build.ldscript = ${common.ldscript_2m512k}
-build_flags = ${common.build_flags_esp8266} -D LEDPIN=3 -D BTNPIN=2 -D IRPIN=5 -D WLED_MAX_BUTTONS=3
-lib_deps = ${esp8266.lib_deps}
-
-[env:athom7w]
-board = esp_wroom_02
-platform = ${common.platform_wled_default}
-board_build.ldscript = ${common.ldscript_2m512k}
-build_flags = ${common.build_flags_esp8266} -D WLED_MAX_CCT_BLEND=0 -D BTNPIN=-1 -D IRPIN=-1 -D WLED_DISABLE_INFRARED
-lib_deps = ${esp8266.lib_deps}
-
-[env:athom15w]
-board = esp_wroom_02
-platform = ${common.platform_wled_default}
-board_build.ldscript = ${common.ldscript_2m512k}
-build_flags = ${common.build_flags_esp8266} -D WLED_USE_IC_CCT -D BTNPIN=-1 -D IRPIN=-1 -D WLED_DISABLE_INFRARED
-lib_deps = ${esp8266.lib_deps}
-
-[env:MY9291]
-board = esp01_1m
-platform = ${common.platform_wled_default}
-platform_packages = ${common.platform_packages}
-board_build.ldscript = ${common.ldscript_1m128k}
-build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp8266} -D WLED_RELEASE_NAME=ESP01 -D WLED_DISABLE_OTA -D USERMOD_MY9291
-lib_deps = ${esp8266.lib_deps}
-
-# ------------------------------------------------------------------------------
-# codm pixel controller board configurations
-# codm-controller-0.6 can also be used for the TYWE3S controller
-# ------------------------------------------------------------------------------
-
-[env:codm-controller-0.6]
-board = esp_wroom_02
-platform = ${common.platform_wled_default}
-platform_packages = ${common.platform_packages}
-board_build.ldscript = ${common.ldscript_2m512k}
-build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp8266}
-lib_deps = ${esp8266.lib_deps}
-
-[env:codm-controller-0.6-rev2]
-board = esp_wroom_02
-platform = ${common.platform_wled_default}
-platform_packages = ${common.platform_packages}
-board_build.ldscript = ${common.ldscript_4m1m}
-build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp8266}
-lib_deps = ${esp8266.lib_deps}
-
-# ------------------------------------------------------------------------------
-# EleksTube-IPS
-# ------------------------------------------------------------------------------
-[env:elekstube_ips]
-board = esp32dev
-platform = espressif32@3.2
-upload_speed = 921600
-build_flags = ${common.build_flags_esp32} -D WLED_DISABLE_BROWNOUT_DET -D WLED_DISABLE_INFRARED
-  -D USERMOD_RTC
-  -D USERMOD_ELEKSTUBE_IPS
-  -D LEDPIN=12
-  -D RLYPIN=27
-  -D BTNPIN=34
-  -D WLED_DISABLE_BLYNK
-  -D DEFAULT_LED_COUNT=6
-  # Display config
-  -D ST7789_DRIVER
-  -D TFT_WIDTH=135
-  -D TFT_HEIGHT=240
-  -D CGRAM_OFFSET
-  -D TFT_SDA_READ
-  -D TFT_MOSI=23
-  -D TFT_SCLK=18
-  -D TFT_DC=25
-  -D TFT_RST=26
-  -D SPI_FREQUENCY=40000000
-  -D USER_SETUP_LOADED
-monitor_filters = esp32_exception_decoder
-lib_deps =
-  ${esp32.lib_deps}
-  TFT_eSPI @ ^2.3.70
-board_build.partitions = ${esp32.default_partitions}

platformio_override.ini.sample

@@ -1,66 +0,0 @@
-# Example PlatformIO Project Configuration Override
-# ------------------------------------------------------------------------------
-# Copy to platformio_override.ini to activate overrides
-# ------------------------------------------------------------------------------
-# Please visit documentation: https://docs.platformio.org/page/projectconf.html
-
-[platformio]
-default_envs = WLED_tasmota_1M
-
-[env:WLED_tasmota_1M]
-board = esp01_1m
-platform = ${common.platform_wled_default}
-platform_packages = ${common.platform_packages}
-board_build.ldscript = ${common.ldscript_1m128k}
-lib_deps = ${esp8266.lib_deps}
-build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp8266}
-; *********************************************************************
-; *** Use custom settings from file my_config.h
-   -DWLED_USE_MY_CONFIG
-; *********************************************************************
-;
-;
-; *** To use the below defines/overrides, copy and paste each onto it's own line just below build_flags in the section above.
-; 
-; disable specific features
-;  -D WLED_DISABLE_OTA
-;  -D WLED_DISABLE_ALEXA
-;  -D WLED_DISABLE_BLYNK
-;  -D WLED_DISABLE_HUESYNC
-;  -D WLED_DISABLE_INFRARED
-;  -D WLED_DISABLE_WEBSOCKETS
-; PIN defines - uncomment and change, if needed:
-;   -D LEDPIN=2
-;   -D BTNPIN=0
-;   -D TOUCHPIN=T0
-;   -D IRPIN=4
-;   -D RLYPIN=12
-;   -D RLYMDE=1
-; digital LED strip types - uncomment only one ! - this will disable WS281x / SK681x support
-;   -D USE_APA102
-;   -D USE_WS2801
-;   -D USE_LPD8806
-; PIN defines for 2 wire LEDs
-   -D CLKPIN=0
-   -D DATAPIN=2
-; to drive analog LED strips (aka 5050) hardware configuration is no longer necessary
-; configure the settings in the UI as follows (hard):
-;   for the Magic Home LED Controller use PWM pins 5,12,13,15
-;   for the H801 controller use PINs 15,13,12,14 (W2 = 04)
-;   for the BW-LT11 controller use PINs 12,4,14,5
-;   
-; set the name of the module - make sure there is a quote-backslash-quote before the name and a backslash-quote-quote after the name
-;   -D SERVERNAME="\"WLED\""
-;   
-; set the number of LEDs
-;   -D DEFAULT_LED_COUNT=30
-;   
-; set milliampere limit when using ESP pin to power leds
-;   -D ABL_MILLIAMPS_DEFAULT=850
-;
-; enable IR by setting remote type
-;   -D IRTYPE=0 ;0 Remote disabled | 1 24-key RGB | 2 24-key with CT | 3 40-key blue | 4 40-key RGB | 5 21-key RGB | 6 6-key black | 7 9-key red | 8 JSON remote
-;   
-; set default color order of your led strip
-;   -D DEFAULT_LED_COLOR_ORDER=COL_ORDER_GRB

platformio_override.sample.ini

@@ -0,0 +1,495 @@
+# Example PlatformIO Project Configuration Override
+# ------------------------------------------------------------------------------
+# Copy to platformio_override.ini to activate overrides
+# ------------------------------------------------------------------------------
+# Please visit documentation: https://docs.platformio.org/page/projectconf.html
+
+[platformio]
+default_envs = WLED_tasmota_1M  # define as many as you need
+
+#----------
+# SAMPLE
+#----------
+[env:WLED_tasmota_1M]
+extends = env:esp01_1m_full  # when you want to extend the existing environment (define only updated options)
+; board = esp01_1m  # uncomment when ou need different board
+; platform = ${common.platform_wled_default}  # uncomment and change when you want particular platform
+; platform_packages = ${common.platform_packages}
+; board_build.ldscript = ${common.ldscript_1m128k}
+; upload_speed = 921600 # fast upload speed (remove ';' if your board supports fast upload speed)
+# Sample libraries used for various usermods. Uncomment when using particular usermod.
+lib_deps = ${esp8266.lib_deps}
+;  olikraus/U8g2 # @~2.33.15
+;  paulstoffregen/OneWire@~2.3.8
+;  adafruit/Adafruit Unified Sensor@^1.1.4
+;  adafruit/DHT sensor library@^1.4.1
+;  adafruit/Adafruit BME280 Library@^2.2.2
+;  Wire
+;  robtillaart/SHT85@~0.3.3
+;  gmag11/QuickESPNow ;@ 0.6.2
+;  https://github.com/blazoncek/QuickESPNow.git#optional-debug  ;; exludes debug library
+;  https://github.com/kosme/arduinoFFT#develop @ 1.9.2+sha.419d7b0 ;; used for USERMOD_AUDIOREACTIVE - using "known working" hash
+; build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags_esp8266}
+;
+; *** To use the below defines/overrides, copy and paste each onto it's own line just below build_flags in the section above.
+; 
+; disable specific features
+;   -D WLED_DISABLE_OTA
+;   -D WLED_DISABLE_ALEXA
+;   -D WLED_DISABLE_HUESYNC
+;   -D WLED_DISABLE_LOXONE
+;   -D WLED_DISABLE_INFRARED
+;   -D WLED_DISABLE_WEBSOCKETS
+;   -D WLED_DISABLE_MQTT
+;   -D WLED_DISABLE_ADALIGHT
+;   -D WLED_DISABLE_2D
+;   -D WLED_DISABLE_PXMAGIC
+;   -D WLED_DISABLE_ESPNOW
+;   -D WLED_DISABLE_BROWNOUT_DET
+;
+; PIN defines - uncomment and change, if needed:
+;   -D LEDPIN=2
+; or use this for multiple outputs
+;   -D DATA_PINS=1,3
+;   -D BTNPIN=0
+;   -D IRPIN=4
+;   -D RLYPIN=12
+;   -D RLYMDE=1
+;   -D LED_BUILTIN=2 # GPIO of built-in LED
+;
+; Limit max buses
+;   -D WLED_MAX_BUSSES=2
+;
+; Configure default WiFi
+;   -D CLIENT_SSID='"MyNetwork"'
+;   -D CLIENT_PASS='"Netw0rkPassw0rd"'
+;
+; Configure and use Ethernet
+;   -D WLED_USE_ETHERNET
+;   -D WLED_ETH_DEFAULT=5
+; do not use pins 5, (16,) 17, 18, 19, 21, 22, 23, 25, 26, 27 for anything but ethernet
+;   -D PHY_ADDR=0 -D ETH_PHY_POWER=5 -D ETH_PHY_MDC=23 -D ETH_PHY_MDIO=18
+;   -D ETH_CLK_MODE=ETH_CLOCK_GPIO17_OUT
+;
+; NTP time configuration
+;   -D WLED_NTP_ENABLED=true
+;   -D WLED_TIMEZONE=2
+;   -D WLED_LAT=48.86
+;   -D WLED_LON=2.33
+;
+; Use Watchdog timer with 10s guard
+;   -D WLED_WATCHDOG_TIMEOUT=10
+;
+; Create debug build (with remote debug)
+;   -D WLED_DEBUG
+;   -D WLED_DEBUG_HOST='"192.168.0.100"'
+;   -D WLED_DEBUG_PORT=7868
+;
+; Use Autosave usermod and set it to do save after 90s
+;   -D USERMOD_AUTO_SAVE
+;   -D AUTOSAVE_AFTER_SEC=90
+;
+; Use 4 Line Display usermod with SPI display
+;   -D USERMOD_FOUR_LINE_DISPLAY
+;   -D USE_ALT_DISPlAY # mandatory
+;   -DFLD_SPI_DEFAULT
+;   -D FLD_TYPE=SSD1306_SPI64
+;   -D FLD_PIN_CLOCKSPI=14
+;   -D FLD_PIN_DATASPI=13
+;   -D FLD_PIN_DC=26
+;   -D FLD_PIN_CS=15
+;   -D FLD_PIN_RESET=27
+;
+; Use Rotary encoder usermod (in conjunction with 4LD)
+;   -D USERMOD_ROTARY_ENCODER_UI
+;   -D ENCODER_DT_PIN=5
+;   -D ENCODER_CLK_PIN=18
+;   -D ENCODER_SW_PIN=19
+;
+; Use Dallas DS18B20 temperature sensor usermod and configure it to use GPIO13
+;   -D USERMOD_DALLASTEMPERATURE
+;   -D TEMPERATURE_PIN=13
+;
+; Use Multi Relay usermod and configure it to use 6 relays and appropriate GPIO
+;   -D USERMOD_MULTI_RELAY
+;   -D MULTI_RELAY_MAX_RELAYS=6
+;   -D MULTI_RELAY_PINS=12,23,22,21,24,25
+;
+; Use PIR sensor usermod and configure it to use GPIO4 and timer of 60s
+;   -D USERMOD_PIRSWITCH
+;   -D PIR_SENSOR_PIN=4
+;   -D PIR_SENSOR_OFF_SEC=60
+;
+; Use Audioreactive usermod and configure I2S microphone
+;   -D USERMOD_AUDIOREACTIVE
+;   -D UM_AUDIOREACTIVE_USE_NEW_FFT
+;   -D AUDIOPIN=-1
+;   -D DMTYPE=1     # 0-analog/disabled, 1-I2S generic, 2-ES7243, 3-SPH0645, 4-I2S+mclk, 5-I2S PDM
+;   -D I2S_SDPIN=36
+;   -D I2S_WSPIN=23
+;   -D I2S_CKPIN=19
+;
+; Use PWM fan usermod
+;   -D USERMOD_PWM_FAN
+;   -D TACHO_PIN=33
+;   -D PWM_PIN=32
+;
+; Use built-in or custom LED as a status indicator (assumes LED is connected to GPIO16)
+;   -D STATUSLED=16
+;   
+; set the name of the module - make sure there is a quote-backslash-quote before the name and a backslash-quote-quote after the name
+;   -D SERVERNAME="\"WLED\""
+;   
+; set the number of LEDs
+;   -D DEFAULT_LED_COUNT=30
+; or this for multiple outputs
+;   -D PIXEL_COUNTS=30,30
+;   
+; set milliampere limit when using ESP pin to power leds
+;   -D ABL_MILLIAMPS_DEFAULT=850
+;
+; enable IR by setting remote type
+;   -D IRTYPE=0 ;0 Remote disabled | 1 24-key RGB | 2 24-key with CT | 3 40-key blue | 4 40-key RGB | 5 21-key RGB | 6 6-key black | 7 9-key red | 8 JSON remote
+;   
+; set default color order of your led strip
+;   -D DEFAULT_LED_COLOR_ORDER=COL_ORDER_GRB
+;
+; use PSRAM if a device (ESP) has one
+;   -DBOARD_HAS_PSRAM
+;   -D WLED_USE_PSRAM
+;
+; configure I2C and SPI interface (for various hardware)
+;   -D I2CSDAPIN=33 # initialise interface
+;   -D I2CSCLPIN=35 # initialise interface
+;   -D HW_PIN_SCL=35
+;   -D HW_PIN_SDA=33
+;   -D HW_PIN_CLOCKSPI=7
+;   -D HW_PIN_DATASPI=11
+;   -D HW_PIN_MISOSPI=9
+
+
+
+# ------------------------------------------------------------------------------
+# PRE-CONFIGURED DEVELOPMENT BOARDS AND CONTROLLERS
+# ------------------------------------------------------------------------------
+
+[env:esp07]
+board = esp07
+platform = ${common.platform_wled_default}
+platform_packages = ${common.platform_packages}
+board_build.ldscript = ${common.ldscript_4m1m}
+build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags_esp8266}
+lib_deps = ${esp8266.lib_deps}
+
+[env:d1_mini]
+board = d1_mini
+platform = ${common.platform_wled_default}
+platform_packages = ${common.platform_packages}
+upload_speed = 921600
+board_build.ldscript = ${common.ldscript_4m1m}
+build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags_esp8266}
+lib_deps = ${esp8266.lib_deps}
+monitor_filters = esp8266_exception_decoder
+
+[env:heltec_wifi_kit_8]
+board = d1_mini
+platform = ${common.platform_wled_default}
+platform_packages = ${common.platform_packages}
+board_build.ldscript = ${common.ldscript_4m1m}
+build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags_esp8266}
+lib_deps = ${esp8266.lib_deps}
+
+[env:h803wf]
+board = d1_mini
+platform = ${common.platform_wled_default}
+platform_packages = ${common.platform_packages}
+board_build.ldscript = ${common.ldscript_4m1m}
+build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags_esp8266} -D LEDPIN=1 -D WLED_DISABLE_INFRARED
+lib_deps = ${esp8266.lib_deps}
+
+[env:esp32dev_qio80]
+board = esp32dev
+platform = ${esp32.platform}
+platform_packages = ${esp32.platform_packages}
+build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags_esp32} -D WLED_RELEASE_NAME=ESP32_qio80 #-D WLED_DISABLE_BROWNOUT_DET
+lib_deps = ${esp32.lib_deps}
+monitor_filters = esp32_exception_decoder
+board_build.partitions = ${esp32.default_partitions}
+board_build.f_flash = 80000000L
+board_build.flash_mode = qio
+
+[env:esp32dev_V4_dio80]
+;; experimental ESP32 env using ESP-IDF V4.4.x
+;; Warning: this build environment is not stable!!
+;; please erase your device before installing.
+board = esp32dev
+platform = ${esp32_idf_V4.platform}
+platform_packages = ${esp32_idf_V4.platform_packages}
+build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags}  ${esp32_idf_V4.build_flags} -D WLED_RELEASE_NAME=ESP32_V4_qio80 #-D WLED_DISABLE_BROWNOUT_DET
+lib_deps = ${esp32_idf_V4.lib_deps}
+monitor_filters = esp32_exception_decoder
+board_build.partitions = ${esp32_idf_V4.default_partitions}
+board_build.f_flash = 80000000L
+board_build.flash_mode = dio
+
+[env:esp32s2_saola]
+board = esp32-s2-saola-1
+platform = https://github.com/tasmota/platform-espressif32/releases/download/v2.0.2.2/platform-tasmota-espressif32-2.0.2.zip
+platform_packages =
+framework = arduino
+board_build.partitions = tools/WLED_ESP32_4MB_1MB_FS.csv
+board_build.flash_mode = qio
+upload_speed = 460800
+build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags} ${esp32s2.build_flags} #-D WLED_RELEASE_NAME=S2_saola
+  ;-DLOLIN_WIFI_FIX ;; try this in case Wifi does not work
+  -DARDUINO_USB_CDC_ON_BOOT=1
+lib_deps = ${esp32s2.lib_deps}
+
+[env:esp32s3dev_8MB_PSRAM_qspi]
+;; ESP32-TinyS3 development board, with 8MB FLASH and PSRAM (memory_type: qio_qspi)
+extends = env:esp32s3dev_8MB_PSRAM_opi
+;board = um_tinys3 ;    -> needs workaround from https://github.com/Aircoookie/WLED/pull/2905#issuecomment-1328049860
+board = esp32-s3-devkitc-1 ;; generic dev board; the next line adds PSRAM support
+board_build.arduino.memory_type = qio_qspi ;; use with PSRAM: 2MB or  4MB
+
+[env:esp8285_4CH_MagicHome]
+board = esp8285
+platform = ${common.platform_wled_default}
+platform_packages = ${common.platform_packages}
+board_build.ldscript = ${common.ldscript_1m128k}
+build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags_esp8266} -D WLED_DISABLE_OTA
+lib_deps = ${esp8266.lib_deps}
+
+[env:esp8285_H801]
+board = esp8285
+platform = ${common.platform_wled_default}
+platform_packages = ${common.platform_packages}
+board_build.ldscript = ${common.ldscript_1m128k}
+build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags_esp8266} -D WLED_DISABLE_OTA
+lib_deps = ${esp8266.lib_deps}
+
+[env:d1_mini_5CH_Shojo_PCB]
+board = d1_mini
+platform = ${common.platform_wled_default}
+platform_packages = ${common.platform_packages}
+board_build.ldscript = ${common.ldscript_4m1m}
+build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags_esp8266} -D WLED_USE_SHOJO_PCB
+lib_deps = ${esp8266.lib_deps}
+
+[env:d1_mini_debug]
+board = d1_mini
+build_type = debug
+platform = ${common.platform_wled_default}
+platform_packages = ${common.platform_packages}
+board_build.ldscript = ${common.ldscript_4m1m}
+build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags_esp8266} ${common.debug_flags}
+lib_deps = ${esp8266.lib_deps}
+
+[env:d1_mini_ota]
+board = d1_mini
+upload_protocol = espota
+# exchange for your WLED IP
+upload_port = "10.10.1.27"
+platform = ${common.platform_wled_default}
+platform_packages = ${common.platform_packages}
+board_build.ldscript = ${common.ldscript_4m1m}
+build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags_esp8266}
+lib_deps = ${esp8266.lib_deps}
+
+[env:anavi_miracle_controller]
+board = d1_mini
+platform = ${common.platform_wled_default}
+platform_packages = ${common.platform_packages}
+board_build.ldscript = ${common.ldscript_4m1m}
+build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags_esp8266} -D LEDPIN=12 -D IRPIN=-1 -D RLYPIN=2
+lib_deps = ${esp8266.lib_deps}
+
+[env:esp32c3dev_2MB]
+;; for ESP32-C3 boards with 2MB flash (instead of 4MB).
+;; this board need a specific partition file. OTA not possible.
+extends = esp32c3
+platform = ${esp32c3.platform}
+platform_packages = ${esp32c3.platform_packages}
+board = esp32-c3-devkitm-1
+build_flags = ${common.build_flags} ${esp32c3.build_flags} #-D WLED_RELEASE_NAME=ESP32-C3
+  -D WLED_WATCHDOG_TIMEOUT=0
+  -D WLED_DISABLE_OTA
+  ; -DARDUINO_USB_CDC_ON_BOOT=1 ;; for virtual CDC USB
+  -DARDUINO_USB_CDC_ON_BOOT=0   ;; for serial-to-USB chip
+build_unflags = ${common.build_unflags}
+upload_speed = 115200
+lib_deps = ${esp32c3.lib_deps}
+board_build.partitions = tools/WLED_ESP32_2MB_noOTA.csv
+board_build.flash_mode = dio
+
+[env:wemos_shield_esp32]
+board = esp32dev
+platform = ${esp32.platform}
+platform_packages = ${esp32.platform_packages}
+upload_speed = 460800
+build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags_esp32}
+  -D LEDPIN=16
+  -D RLYPIN=19
+  -D BTNPIN=17
+  -D IRPIN=18
+  -D UWLED_USE_MY_CONFIG
+  -D USERMOD_DALLASTEMPERATURE
+  -D USERMOD_FOUR_LINE_DISPLAY
+  -D TEMPERATURE_PIN=23
+  -D USE_ALT_DISPlAY ; new versions of USERMOD_FOUR_LINE_DISPLAY and USERMOD_ROTARY_ENCODER_UI
+  -D USERMOD_AUDIOREACTIVE
+lib_deps = ${esp32.lib_deps}
+  OneWire@~2.3.5
+  olikraus/U8g2 @ ^2.28.8
+  https://github.com/blazoncek/arduinoFFT.git
+board_build.partitions = ${esp32.default_partitions}
+
+[env:m5atom]
+board = esp32dev
+build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags_esp32} -D LEDPIN=27 -D BTNPIN=39
+lib_deps = ${esp32.lib_deps}
+platform = ${esp32.platform}
+platform_packages = ${esp32.platform_packages}
+board_build.partitions = ${esp32.default_partitions}
+
+[env:sp501e]
+board = esp_wroom_02
+platform = ${common.platform_wled_default}
+board_build.ldscript = ${common.ldscript_2m512k}
+build_flags = ${common.build_flags_esp8266} -D LEDPIN=3 -D BTNPIN=1
+lib_deps = ${esp8266.lib_deps}
+
+[env:sp511e]
+board = esp_wroom_02
+platform = ${common.platform_wled_default}
+board_build.ldscript = ${common.ldscript_2m512k}
+build_flags = ${common.build_flags_esp8266} -D LEDPIN=3 -D BTNPIN=2 -D IRPIN=5 -D WLED_MAX_BUTTONS=3
+lib_deps = ${esp8266.lib_deps}
+
+[env:Athom_RGBCW]        ;7w and 5w(GU10) bulbs
+board = esp8285
+platform = ${common.platform_wled_default}
+platform_packages = ${common.platform_packages}
+board_build.ldscript = ${common.ldscript_2m512k}
+build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags_esp8266} -D WLED_RELEASE_NAME=ESP8266 -D BTNPIN=-1 -D RLYPIN=-1 -D DATA_PINS=4,12,14,13,5
+                                            -D DEFAULT_LED_TYPE=TYPE_ANALOG_5CH -D WLED_DISABLE_INFRARED -D WLED_MAX_CCT_BLEND=0
+lib_deps = ${esp8266.lib_deps}
+
+[env:Athom_15w_RGBCW]        ;15w bulb
+board = esp8285
+platform = ${common.platform_wled_default}
+platform_packages = ${common.platform_packages}
+board_build.ldscript = ${common.ldscript_2m512k}
+build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags_esp8266} -D WLED_RELEASE_NAME=ESP8266 -D BTNPIN=-1 -D RLYPIN=-1 -D DATA_PINS=4,12,14,5,13
+                                            -D DEFAULT_LED_TYPE=TYPE_ANALOG_5CH -D WLED_DISABLE_INFRARED -D WLED_MAX_CCT_BLEND=0 -D WLED_USE_IC_CCT
+lib_deps = ${esp8266.lib_deps}
+
+[env:Athom_3Pin_Controller]        ;small controller with only data
+board = esp8285
+platform = ${common.platform_wled_default}
+platform_packages = ${common.platform_packages}
+board_build.ldscript = ${common.ldscript_2m512k}
+build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags_esp8266} -D WLED_RELEASE_NAME=ESP8266 -D BTNPIN=0 -D RLYPIN=-1 -D LEDPIN=1 -D WLED_DISABLE_INFRARED
+lib_deps = ${esp8266.lib_deps}
+
+[env:Athom_4Pin_Controller]       ; With clock and data interface
+board = esp8285
+platform = ${common.platform_wled_default}
+platform_packages = ${common.platform_packages}
+board_build.ldscript = ${common.ldscript_2m512k}
+build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags_esp8266} -D WLED_RELEASE_NAME=ESP8266 -D BTNPIN=0 -D RLYPIN=12 -D LEDPIN=1 -D WLED_DISABLE_INFRARED
+lib_deps = ${esp8266.lib_deps}
+
+[env:Athom_5Pin_Controller]      ;Analog light strip controller
+board = esp8285
+platform = ${common.platform_wled_default}
+platform_packages = ${common.platform_packages}
+board_build.ldscript = ${common.ldscript_2m512k}
+build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags_esp8266} -D WLED_RELEASE_NAME=ESP8266 -D BTNPIN=0 -D RLYPIN=-1 DATA_PINS=4,12,14,13 -D WLED_DISABLE_INFRARED
+lib_deps = ${esp8266.lib_deps}
+
+[env:MY9291]
+board = esp01_1m
+platform = ${common.platform_wled_default}
+platform_packages = ${common.platform_packages}
+board_build.ldscript = ${common.ldscript_1m128k}
+build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags_esp8266} -D WLED_RELEASE_NAME=ESP01 -D WLED_DISABLE_OTA -D USERMOD_MY9291
+lib_deps = ${esp8266.lib_deps}
+
+# ------------------------------------------------------------------------------
+# codm pixel controller board configurations
+# codm-controller-0_6 can also be used for the TYWE3S controller
+# ------------------------------------------------------------------------------
+
+[env:codm-controller-0_6]
+board = esp_wroom_02
+platform = ${common.platform_wled_default}
+platform_packages = ${common.platform_packages}
+board_build.ldscript = ${common.ldscript_2m512k}
+build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags_esp8266}
+lib_deps = ${esp8266.lib_deps}
+
+[env:codm-controller-0_6-rev2]
+board = esp_wroom_02
+platform = ${common.platform_wled_default}
+platform_packages = ${common.platform_packages}
+board_build.ldscript = ${common.ldscript_4m1m}
+build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags_esp8266}
+lib_deps = ${esp8266.lib_deps}
+
+# ------------------------------------------------------------------------------
+# EleksTube-IPS
+# ------------------------------------------------------------------------------
+[env:elekstube_ips]
+board = esp32dev
+platform = ${esp32.platform}
+platform_packages = ${esp32.platform_packages}
+upload_speed = 921600
+build_flags = ${common.build_flags_esp32} -D WLED_DISABLE_BROWNOUT_DET -D WLED_DISABLE_INFRARED
+  -D USERMOD_RTC
+  -D USERMOD_ELEKSTUBE_IPS
+  -D LEDPIN=12
+  -D RLYPIN=27
+  -D BTNPIN=34
+  -D DEFAULT_LED_COUNT=6
+  # Display config
+  -D ST7789_DRIVER
+  -D TFT_WIDTH=135
+  -D TFT_HEIGHT=240
+  -D CGRAM_OFFSET
+  -D TFT_SDA_READ
+  -D TFT_MOSI=23
+  -D TFT_SCLK=18
+  -D TFT_DC=25
+  -D TFT_RST=26
+  -D SPI_FREQUENCY=40000000
+  -D USER_SETUP_LOADED
+monitor_filters = esp32_exception_decoder
+lib_deps =
+  ${esp32.lib_deps}
+  TFT_eSPI @ ^2.3.70
+board_build.partitions = ${esp32.default_partitions}

readme.md

@@ -3,7 +3,7 @@
   <a href="https://github.com/Aircoookie/WLED/releases"><img src="https://img.shields.io/github/release/Aircoookie/WLED.svg?style=flat-square"></a>
   <a href="https://raw.githubusercontent.com/Aircoookie/WLED/master/LICENSE"><img src="https://img.shields.io/github/license/Aircoookie/wled?color=blue&style=flat-square"></a>
   <a href="https://wled.discourse.group"><img src="https://img.shields.io/discourse/topics?colorB=blue&label=forum&server=https%3A%2F%2Fwled.discourse.group%2F&style=flat-square"></a>
-  <a href="https://discord.gg/KuqP7NE"><img src="https://img.shields.io/discord/473448917040758787.svg?colorB=blue&label=discord&style=flat-square"></a>
+  <a href="https://discord.gg/QAh7wJHrRM"><img src="https://img.shields.io/discord/473448917040758787.svg?colorB=blue&label=discord&style=flat-square"></a>
   <a href="https://kno.wled.ge"><img src="https://img.shields.io/badge/quick_start-wiki-blue.svg?style=flat-square"></a>
   <a href="https://github.com/Aircoookie/WLED-App"><img src="https://img.shields.io/badge/app-wled-blue.svg?style=flat-square"></a>
   <a href="https://gitpod.io/#https://github.com/Aircoookie/WLED"><img src="https://img.shields.io/badge/Gitpod-ready--to--code-blue?style=flat-square&logo=gitpod"></a>
@@ -26,7 +26,7 @@ A fast and feature-rich implementation of an ESP8266/ESP32 webserver to control
 - Up to 250 user presets to save and load colors/effects easily, supports cycling through them.  
 - Presets can be used to automatically execute API calls  
 - Nightlight function (gradually dims down)  
-- Full OTA software updatability (HTTP + ArduinoOTA), password protectable  
+- Full OTA software updateability (HTTP + ArduinoOTA), password protectable  
 - Configurable analog clock (Cronixie, 7-segment and EleksTube IPS clock support via usermods) 
 - Configurable Auto Brightness limit for safe operation  
 - Filesystem-based config for easier backup of presets and settings  
@@ -34,8 +34,7 @@ A fast and feature-rich implementation of an ESP8266/ESP32 webserver to control
 ## 💡 Supported light control interfaces
 - WLED app for [Android](https://play.google.com/store/apps/details?id=com.aircoookie.WLED) and [iOS](https://apps.apple.com/us/app/wled/id1475695033)
 - JSON and HTTP request APIs  
-- MQTT  
-- Blynk IoT  
+- MQTT   
 - E1.31, Art-Net, DDP and TPM2.net
 - [diyHue](https://github.com/diyhue/diyHue) (Wled is supported by diyHue, including Hue Sync Entertainment under udp. Thanks to [Gregory Mallios](https://github.com/gmallios))
 - [Hyperion](https://github.com/hyperion-project/hyperion.ng)
@@ -67,7 +66,7 @@ Credits [here](https://kno.wled.ge/about/contributors/)!
 
 Join the Discord server to discuss everything about WLED!
 
-<a href="https://discord.gg/KuqP7NE"><img src="https://discordapp.com/api/guilds/473448917040758787/widget.png?style=banner2" width="25%"></a>
+<a href="https://discord.gg/QAh7wJHrRM"><img src="https://discordapp.com/api/guilds/473448917040758787/widget.png?style=banner2" width="25%"></a>
 
 Check out the WLED [Discourse forum](https://wled.discourse.group)!  
 

requirements.txt

@@ -1,66 +1,60 @@
 #
-# This file is autogenerated by pip-compile with python 3.8
-# To update, run:
+# This file is autogenerated by pip-compile with Python 3.12
+# by the following command:
 #
 #    pip-compile
 #
-aiofiles==0.8.0
+aiofiles==22.1.0
     # via platformio
 ajsonrpc==1.2.0
     # via platformio
-anyio==3.6.1
+anyio==3.6.2
     # via starlette
-async-timeout==4.0.2
-    # via zeroconf
-bottle==0.12.23
+bottle==0.12.25
     # via platformio
-certifi==2022.12.7
+certifi==2023.7.22
     # via requests
-charset-normalizer==2.1.1
+charset-normalizer==3.1.0
     # via requests
 click==8.1.3
     # via
     #   platformio
     #   uvicorn
-colorama==0.4.5
-    # via platformio
-h11==0.13.0
+colorama==0.4.6
+    # via
+    #   click
+    #   platformio
+h11==0.14.0
     # via
     #   uvicorn
     #   wsproto
-idna==3.3
+idna==3.4
     # via
     #   anyio
     #   requests
-ifaddr==0.2.0
-    # via zeroconf
-marshmallow==3.17.0
+marshmallow==3.19.0
     # via platformio
-packaging==21.3
+packaging==23.1
     # via marshmallow
-platformio==6.1.4
+platformio==6.1.6
     # via -r requirements.in
 pyelftools==0.29
     # via platformio
-pyparsing==3.0.9
-    # via packaging
 pyserial==3.5
     # via platformio
-requests==2.28.1
+requests==2.31.0
     # via platformio
 semantic-version==2.10.0
     # via platformio
-sniffio==1.2.0
+sniffio==1.3.0
     # via anyio
-starlette==0.20.4
+starlette==0.23.1
     # via platformio
-tabulate==0.8.10
+tabulate==0.9.0
     # via platformio
-urllib3==1.26.11
+urllib3==1.26.18
     # via requests
-uvicorn==0.18.2
+uvicorn==0.20.0
     # via platformio
-wsproto==1.1.0
-    # via platformio
-zeroconf==0.39.0
+wsproto==1.2.0
     # via platformio

tools/WLED_ESP32_16MB_9MB_FS.csv

@@ -0,0 +1,8 @@
+# Name,   Type, SubType, Offset,  Size, Flags
+nvs,      data, nvs,     0x9000,  0x5000,
+otadata,  data, ota,     0xe000,  0x2000,
+app0,     app,  ota_0,   0x10000, 0x300000,
+app1,     app,  ota_1,   0x310000,0x300000,
+spiffs,   data, spiffs,  0x610000,0x9E0000,
+coredump, data, coredump,,64K
+# to create/use ffat, see https://github.com/marcmerlin/esp32_fatfsimage

tools/WLED_ESP32_2MB_noOTA.csv

@@ -0,0 +1,5 @@
+# Name,   Type, SubType, Offset,  Size, Flags
+nvs,      data, nvs,     0x9000,    20K,
+otadata,  data, ota,     0xe000,    8K,
+app0,     app,  ota_0,   0x10000,   1536K,
+spiffs,   data, spiffs,  0x190000,  384K,

tools/WLED_ESP32_8MB.csv

@@ -3,4 +3,5 @@ nvs,      data, nvs,     0x9000,  0x5000,
 otadata,  data, ota,     0xe000,  0x2000,
 app0,     app,  ota_0,   0x10000, 0x200000,
 app1,     app,  ota_1,   0x210000,0x200000,
-spiffs,   data, spiffs,  0x410000,0x3F0000,
+spiffs,   data, spiffs,  0x410000,0x3E0000,
+coredump, data, coredump,,64K

tools/cdata-test.js

@@ -0,0 +1,205 @@
+'use strict';
+
+const assert = require('node:assert');
+const { describe, it, before, after } = require('node:test');
+const fs = require('fs');
+const path = require('path');
+const child_process = require('child_process');
+const util = require('util');
+const execPromise = util.promisify(child_process.exec);
+
+process.env.NODE_ENV = 'test'; // Set the environment to testing
+const cdata = require('./cdata.js');
+
+describe('Function', () => {
+  const testFolderPath = path.join(__dirname, 'testFolder');
+  const oldFilePath = path.join(testFolderPath, 'oldFile.txt');
+  const newFilePath = path.join(testFolderPath, 'newFile.txt');
+
+  // Create a temporary file before the test
+  before(() => {
+    // Create test folder
+    if (!fs.existsSync(testFolderPath)) {
+      fs.mkdirSync(testFolderPath);
+    }
+
+    // Create an old file
+    fs.writeFileSync(oldFilePath, 'This is an old file.');
+    // Modify the 'mtime' to simulate an old file
+    const oldTime = new Date();
+    oldTime.setFullYear(oldTime.getFullYear() - 1);
+    fs.utimesSync(oldFilePath, oldTime, oldTime);
+
+    // Create a new file
+    fs.writeFileSync(newFilePath, 'This is a new file.');
+  });
+
+  // delete the temporary files after the test
+  after(() => {
+    fs.rmSync(testFolderPath, { recursive: true });
+  });
+
+  describe('isFileNewerThan', async () => {
+    it('should return true if the file is newer than the provided time', async () => {
+      const pastTime = Date.now() - 10000; // 10 seconds ago
+      assert.strictEqual(cdata.isFileNewerThan(newFilePath, pastTime), true);
+    });
+
+    it('should return false if the file is older than the provided time', async () => {
+      assert.strictEqual(cdata.isFileNewerThan(oldFilePath, Date.now()), false);
+    });
+
+    it('should throw an exception if the file does not exist', async () => {
+      assert.throws(() => {
+        cdata.isFileNewerThan('nonexistent.txt', Date.now());
+      });
+    });
+  });
+
+  describe('isAnyFileInFolderNewerThan', async () => {
+    it('should return true if a file in the folder is newer than the given time', async () => {
+      const time = fs.statSync(path.join(testFolderPath, 'oldFile.txt')).mtime;
+      assert.strictEqual(cdata.isAnyFileInFolderNewerThan(testFolderPath, time), true);
+    });
+
+    it('should return false if no files in the folder are newer than the given time', async () => {
+      assert.strictEqual(cdata.isAnyFileInFolderNewerThan(testFolderPath, new Date()), false);
+    });
+
+    it('should throw an exception if the folder does not exist', async () => {
+      assert.throws(() => {
+        cdata.isAnyFileInFolderNewerThan('nonexistent', new Date());
+      });
+    });
+  });
+});
+
+describe('Script', () => {
+  const folderPath = 'wled00';
+  const dataPath = path.join(folderPath, 'data');
+
+  before(() => {
+    process.env.NODE_ENV = 'production';
+    // Backup files
+    fs.cpSync("wled00/data", "wled00Backup", { recursive: true });
+    fs.cpSync("tools/cdata.js", "cdata.bak.js");
+  });
+  after(() => {
+    // Restore backup
+    fs.rmSync("wled00/data", { recursive: true });
+    fs.renameSync("wled00Backup", "wled00/data");
+    fs.rmSync("tools/cdata.js");
+    fs.renameSync("cdata.bak.js", "tools/cdata.js");
+  });
+
+  // delete all html_*.h files
+  async function deleteBuiltFiles() {
+    const files = await fs.promises.readdir(folderPath);
+    await Promise.all(files.map(file => {
+      if (file.startsWith('html_') && path.extname(file) === '.h') {
+        return fs.promises.unlink(path.join(folderPath, file));
+      }
+    }));
+  }
+
+  // check if html_*.h files were created
+  async function checkIfBuiltFilesExist() {
+    const files = await fs.promises.readdir(folderPath);
+    const htmlFiles = files.filter(file => file.startsWith('html_') && path.extname(file) === '.h');
+    assert(htmlFiles.length > 0, 'html_*.h files were not created');
+  }
+
+  async function runAndCheckIfBuiltFilesExist() {
+    await execPromise('node tools/cdata.js');
+    await checkIfBuiltFilesExist();
+  }
+
+  async function checkIfFileWasNewlyCreated(file) {
+    const modifiedTime = fs.statSync(file).mtimeMs;
+    assert(Date.now() - modifiedTime < 500, file + ' was not modified');
+  }
+
+  async function testFileModification(sourceFilePath, resultFile) {
+    // run cdata.js to ensure html_*.h files are created
+    await execPromise('node tools/cdata.js');
+
+    // modify file
+    fs.appendFileSync(sourceFilePath, ' ');
+    // delay for 1 second to ensure the modified time is different
+    await new Promise(resolve => setTimeout(resolve, 1000));
+
+    // run script cdata.js again and wait for it to finish
+    await execPromise('node tools/cdata.js');
+
+    checkIfFileWasNewlyCreated(path.join(folderPath, resultFile));
+  }
+
+  describe('should build if', () => {
+    it('html_*.h files are missing', async () => {
+      await deleteBuiltFiles();
+      await runAndCheckIfBuiltFilesExist();
+    });
+
+    it('only one html_*.h file is missing', async () => {
+      // run script cdata.js and wait for it to finish
+      await execPromise('node tools/cdata.js');
+
+      // delete a random html_*.h file
+      let files = await fs.promises.readdir(folderPath);
+      let htmlFiles = files.filter(file => file.startsWith('html_') && path.extname(file) === '.h');
+      const randomFile = htmlFiles[Math.floor(Math.random() * htmlFiles.length)];
+      await fs.promises.unlink(path.join(folderPath, randomFile));
+
+      await runAndCheckIfBuiltFilesExist();
+    });
+
+    it('script was executed with -f or --force', async () => {
+      await execPromise('node tools/cdata.js');
+      await new Promise(resolve => setTimeout(resolve, 1000));
+      await execPromise('node tools/cdata.js --force');
+      await checkIfFileWasNewlyCreated(path.join(folderPath, 'html_ui.h'));
+      await new Promise(resolve => setTimeout(resolve, 1000));
+      await execPromise('node tools/cdata.js -f');
+      await checkIfFileWasNewlyCreated(path.join(folderPath, 'html_ui.h'));
+    });
+
+    it('a file changes', async () => {
+      await testFileModification(path.join(dataPath, 'index.htm'), 'html_ui.h');
+    });
+
+    it('a inlined file changes', async () => {
+      await testFileModification(path.join(dataPath, 'index.js'), 'html_ui.h');
+    });
+
+    it('a settings file changes', async () => {
+      await testFileModification(path.join(dataPath, 'settings_leds.htm'), 'html_ui.h');
+    });
+
+    it('the favicon changes', async () => {
+      await testFileModification(path.join(dataPath, 'favicon.ico'), 'html_ui.h');
+    });
+
+    it('cdata.js changes', async () => {
+      await testFileModification('tools/cdata.js', 'html_ui.h');
+    });
+  });
+
+  describe('should not build if', () => {
+    it('the files are already built', async () => {
+      await deleteBuiltFiles();
+
+      // run script cdata.js and wait for it to finish
+      let startTime = Date.now();
+      await execPromise('node tools/cdata.js');
+      const firstRunTime = Date.now() - startTime;
+
+      // run script cdata.js and wait for it to finish
+      startTime = Date.now();
+      await execPromise('node tools/cdata.js');
+      const secondRunTime = Date.now() - startTime;
+
+      // check if second run was faster than the first (must be at least 2x faster)
+      assert(secondRunTime < firstRunTime / 2, 'html_*.h files were rebuilt');
+    });
+  });
+});

tools/cdata.js

@@ -16,25 +16,57 @@
  */
 
 const fs = require("fs");
+const path = require("path");
 const inliner = require("inliner");
 const zlib = require("zlib");
 const CleanCSS = require("clean-css");
-const MinifyHTML = require("html-minifier-terser").minify;
+const minifyHtml = require("html-minifier-terser").minify;
 const packageJson = require("../package.json");
 
-/**
- *
+// Export functions for testing
+module.exports = { isFileNewerThan, isAnyFileInFolderNewerThan };
+
+const output = ["wled00/html_ui.h", "wled00/html_pixart.h", "wled00/html_cpal.h", "wled00/html_pxmagic.h", "wled00/html_settings.h", "wled00/html_other.h"]
+
+// \x1b[34m is blue, \x1b[36m is cyan, \x1b[0m is reset
+const wledBanner = `
+\t\x1b[34m  ##  ##      ##        ######    ######
+\t\x1b[34m##      ##    ##      ##        ##  ##  ##
+\t\x1b[34m##  ##  ##  ##        ######        ##  ##
+\t\x1b[34m##  ##  ##  ##        ##            ##  ##
+\t\x1b[34m  ##  ##      ######    ######    ######
+\t\t\x1b[36m build script for web UI
+\x1b[0m`;
+
+const singleHeader = `/*
+ * Binary array for the Web UI.
+ * gzip is used for smaller size and improved speeds.
+ * 
+ * Please see https://kno.wled.ge/advanced/custom-features/#changing-web-ui
+ * to find out how to easily modify the web UI source!
  */
-function hexdump(buffer,isHex=false) {
+ 
+`;
+
+const multiHeader = `/*
+ * More web UI HTML source arrays.
+ * This file is auto generated, please don't make any changes manually.
+ *
+ * Instead, see https://kno.wled.ge/advanced/custom-features/#changing-web-ui
+ * to find out how to easily modify the web UI source!
+ */
+`;
+
+function hexdump(buffer, isHex = false) {
   let lines = [];
 
-  for (let i = 0; i < buffer.length; i +=(isHex?32:16)) {
+  for (let i = 0; i < buffer.length; i += (isHex ? 32 : 16)) {
     var block;
     let hexArray = [];
     if (isHex) {
       block = buffer.slice(i, i + 32)
-      for (let j = 0; j < block.length; j +=2 ) {
-        hexArray.push("0x" + block.slice(j,j+2))
+      for (let j = 0; j < block.length; j += 2) {
+        hexArray.push("0x" + block.slice(j, j + 2))
       }
     } else {
       block = buffer.slice(i, i + 16); // cut buffer into blocks of 16
@@ -51,201 +83,163 @@ function hexdump(buffer,isHex=false) {
   return lines.join(",\n");
 }
 
-function strReplace(str, search, replacement) {
-  return str.split(search).join(replacement);
-}
-
 function adoptVersionAndRepo(html) {
   let repoUrl = packageJson.repository ? packageJson.repository.url : undefined;
   if (repoUrl) {
     repoUrl = repoUrl.replace(/^git\+/, "");
     repoUrl = repoUrl.replace(/\.git$/, "");
-    // Replace we
-    html = strReplace(html, "https://github.com/atuline/WLED", repoUrl);
-    html = strReplace(html, "https://github.com/Aircoookie/WLED", repoUrl);
+    html = html.replaceAll("https://github.com/atuline/WLED", repoUrl);
+    html = html.replaceAll("https://github.com/Aircoookie/WLED", repoUrl);
   }
   let version = packageJson.version;
   if (version) {
-    html = strReplace(html, "##VERSION##", version);
+    html = html.replaceAll("##VERSION##", version);
   }
   return html;
 }
 
-function filter(str, type) {
-  str = adoptVersionAndRepo(str);
-  if (type === undefined) {
+async function minify(str, type = "plain") {
+  const options = {
+    collapseWhitespace: true,
+    collapseBooleanAttributes: true,
+    collapseInlineTagWhitespace: true,
+    minifyCSS: true,
+    minifyJS: true,
+    removeAttributeQuotes: true,
+    removeComments: true,
+    sortAttributes: true,
+    sortClassName: true,
+  };
+
+  if (type == "plain") {
     return str;
   } else if (type == "css-minify") {
     return new CleanCSS({}).minify(str).styles;
   } else if (type == "js-minify") {
-    return MinifyHTML('<script>' + str + '</script>', {
-      collapseWhitespace: true,
-      minifyJS: true, 
-      continueOnParseError: false,
-      removeComments: true,
-    }).replace(/<[\/]*script>/g,'');
+    return await minifyHtml('<script>' + str + '</script>', options).replace(/<[\/]*script>/g, '');
   } else if (type == "html-minify") {
-    return MinifyHTML(str, {
-      collapseWhitespace: true,
-      maxLineLength: 80,
-      minifyCSS: true,
-      minifyJS: true, 
-      continueOnParseError: false,
-      removeComments: true,
-    });
-  } else if (type == "html-minify-ui") {
-    return MinifyHTML(str, {
-      collapseWhitespace: true,
-      conservativeCollapse: true,
-      maxLineLength: 80,
-      minifyCSS: true,
-      minifyJS: true, 
-      continueOnParseError: false,
-      removeComments: true,
-    });
-  } else {
-    console.warn("Unknown filter: " + type);
-    return str;
+    return await minifyHtml(str, options);
   }
+
+  throw new Error("Unknown filter: " + type);
 }
 
-function writeHtmlGzipped(sourceFile, resultFile, page) {
+async function writeHtmlGzipped(sourceFile, resultFile, page) {
   console.info("Reading " + sourceFile);
-  new inliner(sourceFile, function (error, html) {
-    console.info("Inlined " + html.length + " characters");
-    html = filter(html, "html-minify-ui");
-    console.info("Minified to " + html.length + " characters");
-
-    if (error) {
-      console.warn(error);
-      throw error;
-    }
+  new inliner(sourceFile, async function (error, html) {
+    if (error) throw error;
 
     html = adoptVersionAndRepo(html);
-    zlib.gzip(html, { level: zlib.constants.Z_BEST_COMPRESSION }, function (error, result) {
-      if (error) {
-        console.warn(error);
-        throw error;
-      }
-
-      console.info("Compressed " + result.length + " bytes");
-      const array = hexdump(result);
-      const src = `/*
- * Binary array for the Web UI.
- * gzip is used for smaller size and improved speeds.
- * 
- * Please see https://kno.wled.ge/advanced/custom-features/#changing-web-ui
- * to find out how to easily modify the web UI source!
- */
- 
-// Autogenerated from ${sourceFile}, do not edit!!
-const uint16_t PAGE_${page}_L = ${result.length};
-const uint8_t PAGE_${page}[] PROGMEM = {
-${array}
-};
-`;
-      console.info("Writing " + resultFile);
-      fs.writeFileSync(resultFile, src);
-    });
+    const originalLength = html.length;
+    html = await minify(html, "html-minify");
+    const result = zlib.gzipSync(html, { level: zlib.constants.Z_BEST_COMPRESSION });
+    console.info("Minified and compressed " + sourceFile + " from " + originalLength + " to " + result.length + " bytes");
+    const array = hexdump(result);
+    let src = singleHeader;
+    src += `const uint16_t PAGE_${page}_L = ${result.length};\n`;
+    src += `const uint8_t PAGE_${page}[] PROGMEM = {\n${array}\n};\n\n`;
+    console.info("Writing " + resultFile);
+    fs.writeFileSync(resultFile, src);
   });
 }
 
-function specToChunk(srcDir, s) {
-  if (s.method == "plaintext") {
-    const buf = fs.readFileSync(srcDir + "/" + s.file);
-    const str = buf.toString("utf-8");
-    const chunk = `
-// Autogenerated from ${srcDir}/${s.file}, do not edit!!
-const char ${s.name}[] PROGMEM = R"${s.prepend || ""}${filter(str, s.filter)}${
-      s.append || ""
-    }";
+async function specToChunk(srcDir, s) {
+  const buf = fs.readFileSync(srcDir + "/" + s.file);
+  let chunk = `\n// Autogenerated from ${srcDir}/${s.file}, do not edit!!\n`
 
-`;
-    return s.mangle ? s.mangle(chunk) : chunk;
-  } else if (s.method == "gzip") {
-    const buf = fs.readFileSync(srcDir + "/" + s.file);
-    var str = buf.toString('utf-8');
-    if (s.mangle) str = s.mangle(str);
-    const zip = zlib.gzipSync(filter(str, s.filter), { level: zlib.constants.Z_BEST_COMPRESSION });
-    const result = hexdump(zip.toString('hex'), true);
-    const chunk = `
-// Autogenerated from ${srcDir}/${s.file}, do not edit!!
-const uint16_t ${s.name}_length = ${zip.length};
-const uint8_t ${s.name}[] PROGMEM = {
-${result}
-};
-
-`;
-    return chunk;
-  } else if (s.method == "binary") {
-    const buf = fs.readFileSync(srcDir + "/" + s.file);
-    const result = hexdump(buf);
-    const chunk = `
-// Autogenerated from ${srcDir}/${s.file}, do not edit!!
-const uint16_t ${s.name}_length = ${result.length};
-const uint8_t ${s.name}[] PROGMEM = {
-${result}
-};
-
-`;
-    return chunk;
-  } else {
-    console.warn("Unknown method: " + s.method);
-    return undefined;
-  }
-}
-
-function writeChunks(srcDir, specs, resultFile) {
-  let src = `/*
- * More web UI HTML source arrays.
- * This file is auto generated, please don't make any changes manually.
- * Instead, see https://kno.wled.ge/advanced/custom-features/#changing-web-ui
- * to find out how to easily modify the web UI source!
- */ 
-`;
-  specs.forEach((s) => {
-    try {
-      console.info("Reading " + srcDir + "/" + s.file + " as " + s.name);
-      src += specToChunk(srcDir, s);
-    } catch (e) {
-      console.warn(
-        "Failed " + s.name + " from " + srcDir + "/" + s.file,
-        e.message.length > 60 ? e.message.substring(0, 60) : e.message
-      );
+  if (s.method == "plaintext" || s.method == "gzip") {
+    let str = buf.toString("utf-8");
+    str = adoptVersionAndRepo(str);
+    const originalLength = str.length;
+    if (s.method == "gzip") {
+      if (s.mangle) str = s.mangle(str);
+      const zip = zlib.gzipSync(await minify(str, s.filter), { level: zlib.constants.Z_BEST_COMPRESSION });
+      console.info("Minified and compressed " + s.file + " from " + originalLength + " to " + zip.length + " bytes");
+      const result = hexdump(zip);
+      chunk += `const uint16_t ${s.name}_length = ${zip.length};\n`;
+      chunk += `const uint8_t ${s.name}[] PROGMEM = {\n${result}\n};\n\n`;
+      return chunk;
+    } else {
+      const minified = await minify(str, s.filter);
+      console.info("Minified " + s.file + " from " + originalLength + " to " + minified.length + " bytes");
+      chunk += `const char ${s.name}[] PROGMEM = R"${s.prepend || ""}${minified}${s.append || ""}";\n\n`;
+      return s.mangle ? s.mangle(chunk) : chunk;
     }
-  });
+  } else if (s.method == "binary") {
+    const result = hexdump(buf);
+    chunk += `const uint16_t ${s.name}_length = ${buf.length};\n`;
+    chunk += `const uint8_t ${s.name}[] PROGMEM = {\n${result}\n};\n\n`;
+    return chunk;
+  }
+
+  throw new Error("Unknown method: " + s.method);
+}
+
+async function writeChunks(srcDir, specs, resultFile) {
+  let src = multiHeader;
+  for (const s of specs) {
+    console.info("Reading " + srcDir + "/" + s.file + " as " + s.name);
+    src += await specToChunk(srcDir, s);
+  }
   console.info("Writing " + src.length + " characters into " + resultFile);
   fs.writeFileSync(resultFile, src);
 }
 
-writeHtmlGzipped("wled00/data/index.htm", "wled00/html_ui.h", 'index');
-writeHtmlGzipped("wled00/data/simple.htm", "wled00/html_simple.h", 'simple');
-/*
-writeChunks(
-  "wled00/data",
-  [
-    {
-      file: "simple.css",
-      name: "PAGE_simpleCss",
-      method: "gzip",
-      filter: "css-minify",
-    },
-    {
-      file: "simple.js",
-      name: "PAGE_simpleJs",
-      method: "gzip",
-      filter: "js-minify",
-    },
-    {
-      file: "simple.htm",
-      name: "PAGE_simple",
-      method: "gzip",
-      filter: "html-minify-ui",
+// Check if a file is newer than a given time
+function isFileNewerThan(filePath, time) {
+  const stats = fs.statSync(filePath);
+  return stats.mtimeMs > time;
+}
+
+// Check if any file in a folder (or its subfolders) is newer than a given time
+function isAnyFileInFolderNewerThan(folderPath, time) {
+  const files = fs.readdirSync(folderPath, { withFileTypes: true });
+  for (const file of files) {
+    const filePath = path.join(folderPath, file.name);
+    if (isFileNewerThan(filePath, time)) {
+      return true;
     }
-  ],
-  "wled00/html_simplex.h"
-);
-*/
+    if (file.isDirectory() && isAnyFileInFolderNewerThan(filePath, time)) {
+      return true;
+    }
+  }
+  return false;
+}
+
+// Check if the web UI is already built
+function isAlreadyBuilt(folderPath) {
+  let lastBuildTime = Infinity;
+
+  for (const file of output) {
+    try {
+      lastBuildTime = Math.min(lastBuildTime, fs.statSync(file).mtimeMs);
+    } catch (e) {
+      if (e.code !== 'ENOENT') throw e;
+      console.info("File " + file + " does not exist. Rebuilding...");
+      return false;
+    }
+  }
+
+  return !isAnyFileInFolderNewerThan(folderPath, lastBuildTime) && !isFileNewerThan("tools/cdata.js", lastBuildTime);
+}
+
+// Don't run this script if we're in a test environment
+if (process.env.NODE_ENV === 'test') {
+  return;
+}
+
+console.info(wledBanner);
+
+if (isAlreadyBuilt("wled00/data") && process.argv[2] !== '--force' && process.argv[2] !== '-f') {
+  console.info("Web UI is already built");
+  return;
+}
+
+writeHtmlGzipped("wled00/data/index.htm", "wled00/html_ui.h", 'index');
+writeHtmlGzipped("wled00/data/pixart/pixart.htm", "wled00/html_pixart.h", 'pixart');
+writeHtmlGzipped("wled00/data/cpal/cpal.htm", "wled00/html_cpal.h", 'cpal');
+writeHtmlGzipped("wled00/data/pxmagic/pxmagic.htm", "wled00/html_pxmagic.h", 'pxmagic');
+
 writeChunks(
   "wled00/data",
   [
@@ -256,7 +250,7 @@ writeChunks(
       filter: "css-minify",
       mangle: (str) =>
         str
-          .replace("%%","%")
+          .replace("%%", "%")
     },
     {
       file: "settings.htm",
@@ -387,12 +381,6 @@ const char PAGE_dmxmap[] PROGMEM = R"=====()=====";
       method: "gzip",
       filter: "html-minify",
     },
-    {
-      file: "liveviewws.htm",
-      name: "PAGE_liveviewws",
-      method: "gzip",
-      filter: "html-minify",
-    },
     {
       file: "liveviewws2D.htm",
       name: "PAGE_liveviewws2D",
@@ -409,16 +397,6 @@ const char PAGE_dmxmap[] PROGMEM = R"=====()=====";
       file: "favicon.ico",
       name: "favicon",
       method: "binary",
-    },
-    {
-      file: "iro.js",
-      name: "iroJs",
-      method: "gzip"
-    },
-    {
-      file: "rangetouch.js",
-      name: "rangetouchJs",
-      method: "gzip"
     }
   ],
   "wled00/html_other.h"

usermods/Analog_Clock/Analog_Clock.h

@@ -56,7 +56,7 @@ private:
 
     // runtime
     bool     initDone         = false;
-    uint32_t lastOverlayDraw  = 0; 
+    uint32_t lastOverlayDraw  = 0;
 
     void validateAndUpdate() {
         mainSegment.validateAndUpdate();
@@ -110,9 +110,9 @@ private:
 
     static inline uint32_t qadd32(uint32_t c1, uint32_t c2) {
         return RGBW32(
-            qadd8(R(c1), R(c2)), 
-            qadd8(G(c1), G(c2)), 
-            qadd8(B(c1), B(c2)), 
+            qadd8(R(c1), R(c2)),
+            qadd8(G(c1), G(c2)),
+            qadd8(B(c1), B(c2)),
             qadd8(W(c1), W(c2))
         );
     }
@@ -166,7 +166,7 @@ public:
         double secondP = second(localTime) / 60.0;
         double minuteP = minute(localTime) / 60.0;
         double hourP = (hour(localTime) % 12) / 12.0 + minuteP / 12.0;
-        
+
         if (hourMarksEnabled)         {
             for (int Led = 0; Led <= 55; Led = Led + 5)
             {
@@ -174,7 +174,7 @@ public:
                 setPixelColor(hourmarkled, hourMarkColor);
             }
         }
-        
+
         if (secondsEnabled) {
             int16_t secondLed = adjustToSegment(secondP, secondsSegment);
 
@@ -203,45 +203,45 @@ public:
     void addToConfig(JsonObject& root) override {
         validateAndUpdate();
 
-        JsonObject top = root.createNestedObject("Analog Clock");
-        top["Overlay Enabled"]               = enabled;
-        top["First LED (Main Ring)"]         = mainSegment.firstLed;
-        top["Last LED (Main Ring)"]          = mainSegment.lastLed;
-        top["Center/12h LED (Main Ring)"]    = mainSegment.centerLed;
-        top["Hour Marks Enabled"]            = hourMarksEnabled;
-        top["Hour Mark Color (RRGGBB)"]      = colorToHexString(hourMarkColor);
-        top["Hour Color (RRGGBB)"]           = colorToHexString(hourColor);
-        top["Minute Color (RRGGBB)"]         = colorToHexString(minuteColor);
-        top["Show Seconds"]                  = secondsEnabled;
-        top["First LED (Seconds Ring)"]      = secondsSegment.firstLed;
-        top["Last LED (Seconds Ring)"]       = secondsSegment.lastLed;
-        top["Center/12h LED (Seconds Ring)"] = secondsSegment.centerLed;
-        top["Second Color (RRGGBB)"]         = colorToHexString(secondColor);
-        top["Seconds Effect (0-1)"]          = secondsEffect;
-        top["Blend Colors"]                  = blendColors;
+        JsonObject top = root.createNestedObject(F("Analog Clock"));
+        top[F("Overlay Enabled")]               = enabled;
+        top[F("First LED (Main Ring)")]         = mainSegment.firstLed;
+        top[F("Last LED (Main Ring)")]          = mainSegment.lastLed;
+        top[F("Center/12h LED (Main Ring)")]    = mainSegment.centerLed;
+        top[F("Hour Marks Enabled")]            = hourMarksEnabled;
+        top[F("Hour Mark Color (RRGGBB)")]      = colorToHexString(hourMarkColor);
+        top[F("Hour Color (RRGGBB)")]           = colorToHexString(hourColor);
+        top[F("Minute Color (RRGGBB)")]         = colorToHexString(minuteColor);
+        top[F("Show Seconds")]                  = secondsEnabled;
+        top[F("First LED (Seconds Ring)")]      = secondsSegment.firstLed;
+        top[F("Last LED (Seconds Ring)")]       = secondsSegment.lastLed;
+        top[F("Center/12h LED (Seconds Ring)")] = secondsSegment.centerLed;
+        top[F("Second Color (RRGGBB)")]         = colorToHexString(secondColor);
+        top[F("Seconds Effect (0-1)")]          = secondsEffect;
+        top[F("Blend Colors")]                  = blendColors;
     }
 
     bool readFromConfig(JsonObject& root) override {
-        JsonObject top = root["Analog Clock"];
+        JsonObject top = root[F("Analog Clock")];
 
         bool configComplete = !top.isNull();
 
         String color;
-        configComplete &= getJsonValue(top["Overlay Enabled"], enabled, false);
-        configComplete &= getJsonValue(top["First LED (Main Ring)"], mainSegment.firstLed, 0);
-        configComplete &= getJsonValue(top["Last LED (Main Ring)"], mainSegment.lastLed, 59);
-        configComplete &= getJsonValue(top["Center/12h LED (Main Ring)"], mainSegment.centerLed, 0);
-        configComplete &= getJsonValue(top["Hour marks Enabled"], hourMarksEnabled, false);
-        configComplete &= getJsonValue(top["Hour mark Color (RRGGBB)"], color, "FF0000") && hexStringToColor(color, hourMarkColor, 0x0000FF);
-        configComplete &= getJsonValue(top["Hour Color (RRGGBB)"], color, "0000FF") && hexStringToColor(color, hourColor, 0x0000FF);
-        configComplete &= getJsonValue(top["Minute Color (RRGGBB)"], color, "00FF00") && hexStringToColor(color, minuteColor, 0x00FF00);
-        configComplete &= getJsonValue(top["Show Seconds"], secondsEnabled, true);
-        configComplete &= getJsonValue(top["First LED (Seconds Ring)"], secondsSegment.firstLed, 0);
-        configComplete &= getJsonValue(top["Last LED (Seconds Ring)"], secondsSegment.lastLed, 59);
-        configComplete &= getJsonValue(top["Center/12h LED (Seconds Ring)"], secondsSegment.centerLed, 0);
-        configComplete &= getJsonValue(top["Second Color (RRGGBB)"], color, "FF0000") && hexStringToColor(color, secondColor, 0xFF0000);
-        configComplete &= getJsonValue(top["Seconds Effect (0-1)"], secondsEffect, 0);
-        configComplete &= getJsonValue(top["Blend Colors"], blendColors, true);
+        configComplete &= getJsonValue(top[F("Overlay Enabled")], enabled, false);
+        configComplete &= getJsonValue(top[F("First LED (Main Ring)")], mainSegment.firstLed, 0);
+        configComplete &= getJsonValue(top[F("Last LED (Main Ring)")], mainSegment.lastLed, 59);
+        configComplete &= getJsonValue(top[F("Center/12h LED (Main Ring)")], mainSegment.centerLed, 0);
+        configComplete &= getJsonValue(top[F("Hour Marks Enabled")], hourMarksEnabled, false);
+        configComplete &= getJsonValue(top[F("Hour Mark Color (RRGGBB)")], color, F("161616")) && hexStringToColor(color, hourMarkColor, 0x161616);
+        configComplete &= getJsonValue(top[F("Hour Color (RRGGBB)")], color, F("0000FF")) && hexStringToColor(color, hourColor, 0x0000FF);
+        configComplete &= getJsonValue(top[F("Minute Color (RRGGBB)")], color, F("00FF00")) && hexStringToColor(color, minuteColor, 0x00FF00);
+        configComplete &= getJsonValue(top[F("Show Seconds")], secondsEnabled, true);
+        configComplete &= getJsonValue(top[F("First LED (Seconds Ring)")], secondsSegment.firstLed, 0);
+        configComplete &= getJsonValue(top[F("Last LED (Seconds Ring)")], secondsSegment.lastLed, 59);
+        configComplete &= getJsonValue(top[F("Center/12h LED (Seconds Ring)")], secondsSegment.centerLed, 0);
+        configComplete &= getJsonValue(top[F("Second Color (RRGGBB)")], color, F("FF0000")) && hexStringToColor(color, secondColor, 0xFF0000);
+        configComplete &= getJsonValue(top[F("Seconds Effect (0-1)")], secondsEffect, 0);
+        configComplete &= getJsonValue(top[F("Blend Colors")], blendColors, true);
 
         if (initDone) {
             validateAndUpdate();
@@ -253,4 +253,4 @@ public:
     uint16_t getId() override {
         return USERMOD_ID_ANALOG_CLOCK;
     }
-};
+};

usermods/Animated_Staircase/Animated_Staircase.h

@@ -25,6 +25,7 @@ class Animated_Staircase : public Usermod {
     bool useUSSensorBottom         = false; // using PIR or UltraSound sensor?
     unsigned int topMaxDist        = 50;    // default maximum measured distance in cm, top
     unsigned int bottomMaxDist     = 50;    // default maximum measured distance in cm, bottom
+    bool togglePower               = false; // toggle power on/off with staircase on/off
 
     /* runtime variables */
     bool initDone = false;
@@ -90,14 +91,17 @@ class Animated_Staircase : public Usermod {
     static const char _bottomEcho_pin[];
     static const char _topEchoCm[];
     static const char _bottomEchoCm[];
-    
+    static const char _togglePower[];
+
     void publishMqtt(bool bottom, const char* state) {
+#ifndef WLED_DISABLE_MQTT
       //Check if MQTT Connected, otherwise it will crash the 8266
       if (WLED_MQTT_CONNECTED){
         char subuf[64];
         sprintf_P(subuf, PSTR("%s/motion/%d"), mqttDeviceTopic, (int)bottom);
         mqtt->publish(subuf, 0, false, state);
       }
+#endif
     }
 
     void updateSegments() {
@@ -129,7 +133,7 @@ class Animated_Staircase : public Usermod {
     *            received within this time, an object is detected
     *            and the function will return true.
     *
-    * The speed of sound is 343 meters per second at 20 degress Celcius.
+    * The speed of sound is 343 meters per second at 20 degrees Celsius.
     * Since the sound has to travel back and forth, the detection
     * distance for the sensor in cm is (0.0343 * maxTimeUs) / 2.
     *
@@ -194,6 +198,7 @@ class Animated_Staircase : public Usermod {
           if (on) {
             lastSensor = topSensorRead;
           } else {
+            if (togglePower && onIndex == offIndex && offMode) toggleOnOff(); // toggle power on if off
             // If the bottom sensor triggered, we need to swipe up, ON
             swipe = bottomSensorRead;
 
@@ -247,11 +252,14 @@ class Animated_Staircase : public Usermod {
             offIndex = MAX(onIndex, offIndex - 1);
           }
         }
-        if (oldOn != onIndex || oldOff != offIndex) updateSegments(); // reduce the number of updates to necessary ones
+        if (oldOn != onIndex || oldOff != offIndex) {
+          updateSegments(); // reduce the number of updates to necessary ones
+          if (togglePower && onIndex == offIndex && !offMode && !on) toggleOnOff();  // toggle power off for all segments off
+        }
       }
     }
 
-    // send sesnor values to JSON API
+    // send sensor values to JSON API
     void writeSensorsToJson(JsonObject& staircase) {
       staircase[F("top-sensor")]    = topSensorRead;
       staircase[F("bottom-sensor")] = bottomSensorRead;
@@ -289,10 +297,11 @@ class Animated_Staircase : public Usermod {
         offIndex = maxSegmentId = strip.getLastActiveSegmentId() + 1;
 
         // shorten the strip transition time to be equal or shorter than segment delay
-        transitionDelayTemp = transitionDelay = segment_delay_ms;
-        strip.setTransition(segment_delay_ms/100);
+        transitionDelay = segment_delay_ms;
+        strip.setTransition(segment_delay_ms);
         strip.trigger();
       } else {
+        if (togglePower && !on && offMode) toggleOnOff(); // toggle power on if off
         // Restore segment options
         for (int i = 0; i <= strip.getLastActiveSegmentId(); i++) {
           Segment &seg = strip.getSegment(i);
@@ -300,7 +309,7 @@ class Animated_Staircase : public Usermod {
           seg.setOption(SEG_OPTION_ON, true);
         }
         strip.trigger();  // force strip update
-        stateChanged = true;  // inform external dvices/UI of change
+        stateChanged = true;  // inform external devices/UI of change
         colorUpdated(CALL_MODE_DIRECT_CHANGE);
         DEBUG_PRINTLN(F("Animated Staircase disabled."));
       }
@@ -345,6 +354,7 @@ class Animated_Staircase : public Usermod {
 
     uint16_t getId() { return USERMOD_ID_ANIMATED_STAIRCASE; }
 
+#ifndef WLED_DISABLE_MQTT
     /**
      * handling of MQTT message
      * topic only contains stripped topic (part after /wled/MAC)
@@ -382,6 +392,7 @@ class Animated_Staircase : public Usermod {
         mqtt->subscribe(subuf, 0);
       }
     }
+#endif
 
     void addToJsonState(JsonObject& root) {
       JsonObject staircase = root[FPSTR(_name)];
@@ -440,6 +451,7 @@ class Animated_Staircase : public Usermod {
       staircase[FPSTR(_bottomEcho_pin)]            = useUSSensorBottom ? bottomEchoPin : -1;
       staircase[FPSTR(_topEchoCm)]                 = topMaxDist;
       staircase[FPSTR(_bottomEchoCm)]              = bottomMaxDist;
+      staircase[FPSTR(_togglePower)]               = togglePower;
       DEBUG_PRINTLN(F("Staircase config saved."));
     }
 
@@ -480,10 +492,12 @@ class Animated_Staircase : public Usermod {
       bottomEchoPin         = top[FPSTR(_bottomEcho_pin)] | bottomEchoPin;
 
       topMaxDist    = top[FPSTR(_topEchoCm)] | topMaxDist;
-      topMaxDist    = min(150,max(30,(int)topMaxDist));     // max distnace ~1.5m (a lag of 9ms may be expected)
+      topMaxDist    = min(150,max(30,(int)topMaxDist));     // max distance ~1.5m (a lag of 9ms may be expected)
       bottomMaxDist = top[FPSTR(_bottomEchoCm)] | bottomMaxDist;
       bottomMaxDist = min(150,max(30,(int)bottomMaxDist));  // max distance ~1.5m (a lag of 9ms may be expected)
 
+      togglePower = top[FPSTR(_togglePower)] | togglePower;  // staircase toggles power on/off
+
       DEBUG_PRINT(FPSTR(_name));
       if (!initDone) {
         // first run: reading from cfg.json
@@ -507,7 +521,7 @@ class Animated_Staircase : public Usermod {
         if (changed) setup();
       }
       // use "return !top["newestParameter"].isNull();" when updating Usermod with new features
-      return true;
+      return !top[FPSTR(_togglePower)].isNull();
     }
 
     /*
@@ -547,3 +561,4 @@ const char Animated_Staircase::_bottomPIRorTrigger_pin[]    PROGMEM = "bottomPIR
 const char Animated_Staircase::_bottomEcho_pin[]            PROGMEM = "bottomEcho_pin";
 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";

usermods/Animated_Staircase/README.md

@@ -11,7 +11,7 @@ The Animated Staircase can be controlled by the WLED API. Change settings such a
 speed, on/off time and distance by sending an HTTP request, see below.
 
 ## WLED integration
-To include this usermod in your WLED setup, you have to be able to [compile WLED from source](https://github.com/Aircoookie/WLED/wiki/Compiling-WLED).
+To include this usermod in your WLED setup, you have to be able to [compile WLED from source](https://kno.wled.ge/advanced/compiling-wled/).
 
 Before compiling, you have to make the following modifications:
 
@@ -38,7 +38,7 @@ Maximum distance for ultrasonic sensor can be configured as the time needed for
 You _may_ need to use 10k pull-down resistors on the selected PIR pins, depending on the sensor.
 
 ## WLED configuration
-1. In the WLED UI, confgure a segment for each step. The lowest step of the stairs is the 
+1. In the WLED UI, configure a segment for each step. The lowest step of the stairs is the 
    lowest segment id. 
 2. Save your segments into a preset. 
 3. Ideally, add the preset in the config > LED setup menu to the "apply 
@@ -91,7 +91,7 @@ To enable the usermod again, use `"enabled":true`.
 Alternatively you can use _Usermod_ Settings page where you can change other parameters as well.
 
 ### Changing animation parameters and detection range of the ultrasonic HC-SR04 sensor
-Using _Usermod_ Settings page you can define different usermod parameters, includng sensor pins, delay between segment activation etc.
+Using _Usermod_ Settings page you can define different usermod parameters, including sensor pins, delay between segment activation etc.
 
 When an ultrasonic sensor is enabled you can enter maximum detection distance in centimeters separately for top and bottom sensors.
 

usermods/BH1750_v2/readme.md

@@ -9,7 +9,7 @@ The luminance is displayed in both the Info section of the web UI, as well as pu
   - This must be added under `lib_deps` in your `platformio.ini` (or `platformio_override.ini`).
 - Data is published over MQTT - make sure you've enabled the MQTT sync interface.
 
-## Compiliation
+## Compilation
 
 To enable, compile with `USERMOD_BH1750` defined  (e.g. in `platformio_override.ini`)
 ```ini

usermods/BH1750_v2/usermod_bh1750.h

@@ -1,10 +1,13 @@
 // force the compiler to show a warning to confirm that this file is included
 #warning **** Included USERMOD_BH1750 ****
 
+#ifndef WLED_ENABLE_MQTT
+#error "This user mod requires MQTT to be enabled."
+#endif
+
 #pragma once
 
 #include "wled.h"
-#include <Wire.h>
 #include <BH1750.h>
 
 // the max frequency to check photoresistor, 10 seconds
@@ -22,7 +25,7 @@
 #define USERMOD_BH1750_FIRST_MEASUREMENT_AT 10000
 #endif
 
-// only report if differance grater than offset value
+// only report if difference grater than offset value
 #ifndef USERMOD_BH1750_OFFSET_VALUE
 #define USERMOD_BH1750_OFFSET_VALUE 1
 #endif
@@ -52,15 +55,6 @@ private:
   static const char _offset[];
   static const char _HomeAssistantDiscovery[];
 
-  // set the default pins based on the architecture, these get overridden by Usermod menu settings
-  #ifdef ARDUINO_ARCH_ESP32 // ESP32 boards
-    #define HW_PIN_SCL 22
-    #define HW_PIN_SDA 21
-  #else // ESP8266 boards
-    #define HW_PIN_SCL 5
-    #define HW_PIN_SDA 4
-  #endif
-  int8_t ioPin[2] = {HW_PIN_SCL, HW_PIN_SDA};        // I2C pins: SCL, SDA...defaults to Arch hardware pins but overridden at setup()
   bool initDone = false;
   bool sensorFound = false;
 
@@ -92,7 +86,7 @@ private:
     
     StaticJsonDocument<600> doc;
     
-    doc[F("name")] = String(serverDescription) + F(" ") + name;
+    doc[F("name")] = String(serverDescription) + " " + name;
     doc[F("state_topic")] = topic;
     doc[F("unique_id")] = String(mqttClientID) + name;
     if (unitOfMeasurement != "")
@@ -104,8 +98,8 @@ private:
     JsonObject device = doc.createNestedObject(F("device")); // attach the sensor to the same device
     device[F("name")] = serverDescription;
     device[F("identifiers")] = "wled-sensor-" + String(mqttClientID);
-    device[F("manufacturer")] = F("WLED");
-    device[F("model")] = F("FOSS");
+    device[F("manufacturer")] = F(WLED_BRAND);
+    device[F("model")] = F(WLED_PRODUCT_NAME);
     device[F("sw_version")] = versionString;
 
     String temp;
@@ -119,14 +113,7 @@ private:
 public:
   void setup()
   {
-    bool HW_Pins_Used = (ioPin[0]==HW_PIN_SCL && ioPin[1]==HW_PIN_SDA); // note whether architecture-based hardware SCL/SDA pins used
-    PinOwner po = PinOwner::UM_BH1750; // defaults to being pinowner for SCL/SDA pins
-    PinManagerPinType pins[2] = { { ioPin[0], true }, { ioPin[1], true } };  // allocate pins
-    if (HW_Pins_Used) po = PinOwner::HW_I2C; // allow multiple allocations of HW I2C bus pins
-    if (!pinManager.allocateMultiplePins(pins, 2, po)) return;
-    
-    Wire.begin(ioPin[1], ioPin[0]);
-
+    if (i2c_scl<0 || i2c_sda<0) { enabled = false; return; }
     sensorFound = lightMeter.begin();
     initDone = true;
   }
@@ -156,6 +143,7 @@ public:
     {
       lastLux = lux;
       lastSend = millis();
+#ifndef WLED_DISABLE_MQTT
       if (WLED_MQTT_CONNECTED)
       {
         if (!mqttInitialized)
@@ -170,6 +158,7 @@ public:
       {
         DEBUG_PRINTLN(F("Missing MQTT connection. Not publishing data"));
       }
+#endif
     }
   }
 
@@ -184,7 +173,9 @@ public:
       user = root.createNestedObject(F("u"));
 
     JsonArray lux_json = user.createNestedArray(F("Luminance"));
-    if (!sensorFound) {
+    if (!enabled) {
+      lux_json.add(F("disabled"));
+    } else if (!sensorFound) {
         // if no sensor 
         lux_json.add(F("BH1750 "));
         lux_json.add(F("Not Found"));
@@ -210,9 +201,6 @@ public:
     top[FPSTR(_minReadInterval)] = minReadingInterval;
     top[FPSTR(_HomeAssistantDiscovery)] = HomeAssistantDiscovery;
     top[FPSTR(_offset)] = offset;
-    JsonArray io_pin = top.createNestedArray(F("pin"));
-    for (byte i=0; i<2; i++) io_pin.add(ioPin[i]);
-    top[F("help4Pins")] = F("SCL,SDA"); // help for Settings page
 
     DEBUG_PRINTLN(F("BH1750 config saved."));
   }
@@ -220,8 +208,6 @@ public:
   // called before setup() to populate properties from values stored in cfg.json
   bool readFromConfig(JsonObject &root)
   {
-    int8_t newPin[2]; for (byte i=0; i<2; i++) newPin[i] = ioPin[i]; // prepare to note changed pins
-
     // we look for JSON object.
     JsonObject top = root[FPSTR(_name)];
     if (top.isNull())
@@ -238,27 +224,12 @@ public:
     configComplete &= getJsonValue(top[FPSTR(_minReadInterval)], minReadingInterval, 500); //ms
     configComplete &= getJsonValue(top[FPSTR(_HomeAssistantDiscovery)], HomeAssistantDiscovery, false);
     configComplete &= getJsonValue(top[FPSTR(_offset)], offset, 1);
-    for (byte i=0; i<2; i++) configComplete &= getJsonValue(top[F("pin")][i], newPin[i], ioPin[i]);
 
     DEBUG_PRINT(FPSTR(_name));
     if (!initDone) {
-      // first run: reading from cfg.json
-      for (byte i=0; i<2; i++) ioPin[i] = newPin[i];
       DEBUG_PRINTLN(F(" config loaded."));
     } else {
       DEBUG_PRINTLN(F(" config (re)loaded."));
-      // changing parameters from settings page
-      bool pinsChanged = false;
-      for (byte i=0; i<2; i++) if (ioPin[i] != newPin[i]) { pinsChanged = true; break; } // check if any pins changed
-      if (pinsChanged) { //if pins changed, deallocate old pins and allocate new ones
-        PinOwner po = PinOwner::UM_BH1750;
-        if (ioPin[0]==HW_PIN_SCL && ioPin[1]==HW_PIN_SDA) po = PinOwner::HW_I2C;  // allow multiple allocations of HW I2C bus pins
-        pinManager.deallocateMultiplePins((const uint8_t *)ioPin, 2, po);  // deallocate pins
-        for (byte i=0; i<2; i++) ioPin[i] = newPin[i];
-        setup();
-      }
-      // use "return !top["newestParameter"].isNull();" when updating Usermod with new features
-      return !top[F("pin")].isNull();
     }
 
     return configComplete;

usermods/BME280_v2/usermod_bme280.h

@@ -1,11 +1,14 @@
 // force the compiler to show a warning to confirm that this file is included
 #warning **** Included USERMOD_BME280 version 2.0 ****
 
+#ifndef WLED_ENABLE_MQTT
+#error "This user mod requires MQTT to be enabled."
+#endif
+
 #pragma once
 
 #include "wled.h"
 #include <Arduino.h>
-#include <Wire.h>
 #include <BME280I2C.h>               // BME280 sensor
 #include <EnvironmentCalculations.h> // BME280 extended measurements
 
@@ -28,9 +31,8 @@ private:
 
   // set the default pins based on the architecture, these get overridden by Usermod menu settings
   #ifdef ESP8266
-    //uint8_t RST_PIN = 16; // Uncoment for Heltec WiFi-Kit-8
+    //uint8_t RST_PIN = 16; // Un-comment for Heltec WiFi-Kit-8
   #endif
-  int8_t ioPin[2] = {i2c_scl, i2c_sda};   // I2C pins: SCL, SDA...defaults to Arch hardware pins but overridden at setup()
   bool initDone = false;
 
   // BME280 sensor settings
@@ -76,7 +78,7 @@ private:
   static const char _name[];
   static const char _enabled[];
 
-  // Read the BME280/BMP280 Sensor (which one runs depends on whether Celsius or Farenheit being set in Usermod Menu)
+  // Read the BME280/BMP280 Sensor (which one runs depends on whether Celsius or Fahrenheit being set in Usermod Menu)
   void UpdateBME280Data(int SensorType)
   {
     float _temperature, _humidity, _pressure;
@@ -158,8 +160,8 @@ private:
     JsonObject device = doc.createNestedObject(F("device")); // attach the sensor to the same device
     device[F("name")] = serverDescription;
     device[F("identifiers")] = "wled-sensor-" + String(mqttClientID);
-    device[F("manufacturer")] = F("WLED");
-    device[F("model")] = F("FOSS");
+    device[F("manufacturer")] = F(WLED_BRAND);
+    device[F("model")] = F(WLED_PRODUCT_NAME);
     device[F("sw_version")] = versionString;
 
     String temp;
@@ -182,14 +184,8 @@ private:
 public:
   void setup()
   {
-    bool HW_Pins_Used = (ioPin[0]==i2c_scl && ioPin[1]==i2c_sda); // note whether architecture-based hardware SCL/SDA pins used
-    PinOwner po = PinOwner::UM_BME280; // defaults to being pinowner for SCL/SDA pins
-    PinManagerPinType pins[2] = { { ioPin[0], true }, { ioPin[1], true } };  // allocate pins
-    if (HW_Pins_Used) po = PinOwner::HW_I2C; // allow multiple allocations of HW I2C bus pins
-    if (!pinManager.allocateMultiplePins(pins, 2, po)) { sensorType=0; return; }
+    if (i2c_scl<0 || i2c_sda<0) { enabled = false; sensorType = 0; return; }
     
-    Wire.begin(ioPin[1], ioPin[0]);
-
     if (!bme.begin())
     {
       sensorType = 0;
@@ -411,9 +407,6 @@ public:
     top[F("PublishAlways")] = PublishAlways;
     top[F("UseCelsius")] = UseCelsius;
     top[F("HomeAssistantDiscovery")] = HomeAssistantDiscovery;
-    JsonArray io_pin = top.createNestedArray(F("pin"));
-    for (byte i=0; i<2; i++) io_pin.add(ioPin[i]);
-    top[F("help4Pins")] = F("SCL,SDA"); // help for Settings page
     DEBUG_PRINTLN(F("BME280 config saved."));
   }
 
@@ -423,8 +416,6 @@ public:
     // default settings values could be set here (or below using the 3-argument getJsonValue()) instead of in the class definition or constructor
     // setting them inside readFromConfig() is slightly more robust, handling the rare but plausible use case of single value being missing after boot (e.g. if the cfg.json was manually edited and a value was removed)
 
-    int8_t newPin[2]; for (byte i=0; i<2; i++) newPin[i] = ioPin[i]; // prepare to note changed pins
-
     JsonObject top = root[FPSTR(_name)];
     if (top.isNull()) {
       DEBUG_PRINT(F(_name));
@@ -443,27 +434,14 @@ public:
     configComplete &= getJsonValue(top[F("PublishAlways")], PublishAlways, false);
     configComplete &= getJsonValue(top[F("UseCelsius")], UseCelsius, true);
     configComplete &= getJsonValue(top[F("HomeAssistantDiscovery")], HomeAssistantDiscovery, false);
-    for (byte i=0; i<2; i++) configComplete &= getJsonValue(top[F("pin")][i], newPin[i], ioPin[i]);
 
     DEBUG_PRINT(FPSTR(_name));
     if (!initDone) {
       // first run: reading from cfg.json
-      for (byte i=0; i<2; i++) ioPin[i] = newPin[i];
       DEBUG_PRINTLN(F(" config loaded."));
     } else {
       DEBUG_PRINTLN(F(" config (re)loaded."));
       // changing parameters from settings page
-      bool pinsChanged = false;
-      for (byte i=0; i<2; i++) if (ioPin[i] != newPin[i]) { pinsChanged = true; break; } // check if any pins changed
-      if (pinsChanged) { //if pins changed, deallocate old pins and allocate new ones
-        PinOwner po = PinOwner::UM_BME280;
-        if (ioPin[0]==i2c_scl && ioPin[1]==i2c_sda) po = PinOwner::HW_I2C;  // allow multiple allocations of HW I2C bus pins
-        pinManager.deallocateMultiplePins((const uint8_t *)ioPin, 2, po);  // deallocate pins
-        for (byte i=0; i<2; i++) ioPin[i] = newPin[i];
-        setup();
-      }
-      // use "return !top["newestParameter"].isNull();" when updating Usermod with new features
-      return !top[F("pin")].isNull();
     }
 
     return configComplete;

usermods/Battery/battery_defaults.h

@@ -0,0 +1,81 @@
+// pin defaults
+// for the esp32 it is best to use the ADC1: GPIO32 - GPIO39
+// https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/peripherals/adc.html
+#ifndef USERMOD_BATTERY_MEASUREMENT_PIN
+  #ifdef ARDUINO_ARCH_ESP32
+    #define USERMOD_BATTERY_MEASUREMENT_PIN 35
+  #else //ESP8266 boards
+    #define USERMOD_BATTERY_MEASUREMENT_PIN A0
+  #endif
+#endif
+
+// the frequency to check the battery, 30 sec
+#ifndef USERMOD_BATTERY_MEASUREMENT_INTERVAL
+  #define USERMOD_BATTERY_MEASUREMENT_INTERVAL 30000
+#endif
+
+// default for 18650 battery
+// https://batterybro.com/blogs/18650-wholesale-battery-reviews/18852515-when-to-recycle-18650-batteries-and-how-to-start-a-collection-center-in-your-vape-shop
+// Discharge voltage: 2.5 volt + .1 for personal safety
+#ifndef USERMOD_BATTERY_MIN_VOLTAGE
+  #ifdef USERMOD_BATTERY_USE_LIPO
+    // LiPo "1S" Batteries should not be dischared below 3V !!
+    #define USERMOD_BATTERY_MIN_VOLTAGE 3.2f
+  #else
+    #define USERMOD_BATTERY_MIN_VOLTAGE 2.6f
+  #endif
+#endif
+
+//the default ratio for the voltage divider
+#ifndef USERMOD_BATTERY_VOLTAGE_MULTIPLIER
+  #ifdef ARDUINO_ARCH_ESP32
+    #define USERMOD_BATTERY_VOLTAGE_MULTIPLIER 2.0f
+  #else //ESP8266 boards
+    #define USERMOD_BATTERY_VOLTAGE_MULTIPLIER 4.2f
+  #endif
+#endif
+
+#ifndef USERMOD_BATTERY_MAX_VOLTAGE
+  #define USERMOD_BATTERY_MAX_VOLTAGE 4.2f
+#endif
+
+// a common capacity for single 18650 battery cells is between 2500 and 3600 mAh
+#ifndef USERMOD_BATTERY_TOTAL_CAPACITY
+  #define USERMOD_BATTERY_TOTAL_CAPACITY 3100
+#endif
+
+// offset or calibration value to fine tune the calculated voltage
+#ifndef USERMOD_BATTERY_CALIBRATION
+  #define USERMOD_BATTERY_CALIBRATION 0
+#endif
+
+// calculate remaining time / the time that is left before the battery runs out of power
+// #ifndef USERMOD_BATTERY_CALCULATE_TIME_LEFT_ENABLED
+//   #define USERMOD_BATTERY_CALCULATE_TIME_LEFT_ENABLED false
+// #endif
+
+// auto-off feature
+#ifndef USERMOD_BATTERY_AUTO_OFF_ENABLED
+  #define USERMOD_BATTERY_AUTO_OFF_ENABLED true
+#endif
+
+#ifndef USERMOD_BATTERY_AUTO_OFF_THRESHOLD
+  #define USERMOD_BATTERY_AUTO_OFF_THRESHOLD 10
+#endif
+
+// low power indication feature
+#ifndef USERMOD_BATTERY_LOW_POWER_INDICATOR_ENABLED
+  #define USERMOD_BATTERY_LOW_POWER_INDICATOR_ENABLED true
+#endif
+
+#ifndef USERMOD_BATTERY_LOW_POWER_INDICATOR_PRESET
+  #define USERMOD_BATTERY_LOW_POWER_INDICATOR_PRESET 0
+#endif
+
+#ifndef USERMOD_BATTERY_LOW_POWER_INDICATOR_THRESHOLD
+  #define USERMOD_BATTERY_LOW_POWER_INDICATOR_THRESHOLD 20
+#endif
+
+#ifndef USERMOD_BATTERY_LOW_POWER_INDICATOR_DURATION
+  #define USERMOD_BATTERY_LOW_POWER_INDICATOR_DURATION 5
+#endif

usermods/Battery/readme.md

@@ -0,0 +1,112 @@
+<p align="center">
+  <img width="700" src="assets/battery_usermod_logo.png">
+</p>
+
+# Welcome to the battery usermod! 🔋
+
+Enables battery level monitoring of your project.
+
+For this to work, the positive side of the (18650) battery must be connected to pin `A0` of the d1 mini/esp8266 with a 100k Ohm resistor (see [Useful Links](#useful-links)).
+
+If you have an ESP32 board, connect the positive side of the battery to ADC1 (GPIO32 - GPIO39)
+
+<p align="center">
+  <img width="500" src="assets/battery_info_screen.png">
+</p>
+
+## ⚙️ Features
+
+- 💯 Displays current battery voltage 
+- 🚥 Displays battery level
+- 🚫 Auto-off with configurable Threshold
+- 🚨 Low power indicator with many configuration possibilities
+
+## 🎈 Installation
+
+define `USERMOD_BATTERY` in `wled00/my_config.h`
+
+### Example wiring
+
+<p align="center">
+  <img width="300" src="assets/battery_connection_schematic_01.png">
+</p>
+
+### Define Your Options
+
+| Name                                            | Unit        | Description                                                                           |
+| ----------------------------------------------- | ----------- |-------------------------------------------------------------------------------------- |
+| `USERMOD_BATTERY`                               |             | define this (in `my_config.h`) to have this usermod included wled00\usermods_list.cpp |
+| `USERMOD_BATTERY_USE_LIPO`                      |             | define this (in `my_config.h`) if you use LiPo rechargeables (1S)                     |
+| `USERMOD_BATTERY_MEASUREMENT_PIN`               |             | defaults to A0 on ESP8266 and GPIO35 on ESP32                                         |
+| `USERMOD_BATTERY_MEASUREMENT_INTERVAL`          | ms          | battery check interval. defaults to 30 seconds                                        |
+| `USERMOD_BATTERY_MIN_VOLTAGE`                   | v           | minimum battery voltage. default is 2.6 (18650 battery standard)                      |
+| `USERMOD_BATTERY_MAX_VOLTAGE`                   | v           | maximum battery voltage. default is 4.2 (18650 battery standard)                      |
+| `USERMOD_BATTERY_TOTAL_CAPACITY`                | mAh         | the capacity of all cells in parallel summed up                                       |
+| `USERMOD_BATTERY_CALIBRATION`                   |             | offset / calibration number, fine tune the measured voltage by the microcontroller    |
+| Auto-Off                                        | ---         | ---                                                                                   |
+| `USERMOD_BATTERY_AUTO_OFF_ENABLED`              | true/false  | enables auto-off                                                                      |
+| `USERMOD_BATTERY_AUTO_OFF_THRESHOLD`            | % (0-100)   | when this threshold is reached master power turns off                                 |
+| Low-Power-Indicator                             | ---         | ---                                                                                   |
+| `USERMOD_BATTERY_LOW_POWER_INDICATOR_ENABLED`   | true/false  | enables low power indication                                                          |
+| `USERMOD_BATTERY_LOW_POWER_INDICATOR_PRESET`    | preset id   | when low power is detected then use this preset to indicate low power                 |
+| `USERMOD_BATTERY_LOW_POWER_INDICATOR_THRESHOLD` | % (0-100)   | when this threshold is reached low power gets indicated                               |
+| `USERMOD_BATTERY_LOW_POWER_INDICATOR_DURATION`  | seconds     | for this long the configured preset is played                                         |
+
+All parameters can be configured at runtime via the Usermods settings page.
+
+## ⚠️ Important
+
+- Make sure you know your battery specifications! All batteries are **NOT** the same!
+- Example:
+
+| Your battery specification table  |                 | Options you can define        | 
+| :-------------------------------- |:--------------- | :---------------------------- |
+| Capacity                          | 3500mAh 12,5 Wh |                               |
+| Minimum capacity                  | 3350mAh 11,9 Wh |                               |
+| Rated voltage                     | 3.6V - 3.7V     |                               |
+| **Charging end voltage**          | **4,2V ± 0,05** | `USERMOD_BATTERY_MAX_VOLTAGE` |
+| **Discharge voltage**             | **2,5V**        | `USERMOD_BATTERY_MIN_VOLTAGE` |
+| Max. discharge current (constant) | 10A (10000mA)   |                               |
+| max. charging current             | 1.7A (1700mA)   |                               |
+| ...                               | ...             | ...                           |
+| ..                                | ..              | ..                            |
+
+Specification from:  [Molicel INR18650-M35A, 3500mAh 10A Lithium-ion battery, 3.6V - 3.7V](https://www.akkuteile.de/lithium-ionen-akkus/18650/molicel/molicel-inr18650-m35a-3500mah-10a-lithium-ionen-akku-3-6v-3-7v_100833)
+
+## 🌐 Useful Links
+
+- https://lazyzero.de/elektronik/esp8266/wemos_d1_mini_a0/start
+- https://arduinodiy.wordpress.com/2016/12/25/monitoring-lipo-battery-voltage-with-wemos-d1-minibattery-shield-and-thingspeak/
+
+## 📝 Change Log
+
+2023-01-04
+
+- basic support for LiPo rechargeable batteries ( `-D USERMOD_BATTERY_USE_LIPO`)
+- improved support for esp32 (read calibrated voltage)
+- corrected config saving (measurement pin, and battery min/max were lost)
+- various bugfixes
+
+2022-12-25
+
+- added "auto-off" feature
+- added "low-power-indication" feature
+- added "calibration/offset" field to configuration page
+- added getter and setter, so that user usermods could interact with this one
+- update readme (added new options, made it markdownlint compliant)
+
+2021-09-02
+
+- added "Battery voltage" to info
+- added circuit diagram to readme
+- added MQTT support, sending battery voltage
+- minor fixes
+
+2021-08-15
+
+- changed `USERMOD_BATTERY_MIN_VOLTAGE` to 2.6 volt as default for 18650 batteries
+- Updated readme, added specification table
+
+2021-08-10
+
+- Created

usermods/Battery/usermod_v2_Battery.h

@@ -0,0 +1,787 @@
+#pragma once
+
+#include "wled.h"
+#include "battery_defaults.h"
+
+/*
+ * Usermod by Maximilian Mewes
+ * Mail: mewes.maximilian@gmx.de
+ * GitHub: itCarl
+ * Date: 25.12.2022
+ * If you have any questions, please feel free to contact me.
+ */
+class UsermodBattery : public Usermod 
+{
+  private:
+    // battery pin can be defined in my_config.h
+    int8_t batteryPin = USERMOD_BATTERY_MEASUREMENT_PIN;
+    // how often to read the battery voltage
+    unsigned long readingInterval = USERMOD_BATTERY_MEASUREMENT_INTERVAL;
+    unsigned long nextReadTime = 0;
+    unsigned long lastReadTime = 0;
+    // battery min. voltage
+    float minBatteryVoltage = USERMOD_BATTERY_MIN_VOLTAGE;
+    // battery max. voltage
+    float maxBatteryVoltage = USERMOD_BATTERY_MAX_VOLTAGE;
+    // all battery cells summed up
+    unsigned int totalBatteryCapacity = USERMOD_BATTERY_TOTAL_CAPACITY;
+    // raw analog reading 
+    float rawValue = 0.0f;
+    // calculated voltage            
+    float voltage = maxBatteryVoltage;
+    // between 0 and 1, to control strength of voltage smoothing filter
+    float alpha = 0.05f;
+    // multiplier for the voltage divider that is in place between ADC pin and battery, default will be 2 but might be adapted to readout voltages over ~5v ESP32 or ~6.6v ESP8266
+    float voltageMultiplier = USERMOD_BATTERY_VOLTAGE_MULTIPLIER;
+    // mapped battery level based on voltage
+    int8_t batteryLevel = 100;
+    // offset or calibration value to fine tune the calculated voltage
+    float calibration = USERMOD_BATTERY_CALIBRATION;
+    
+    // time left estimation feature
+    // bool calculateTimeLeftEnabled = USERMOD_BATTERY_CALCULATE_TIME_LEFT_ENABLED;
+    // float estimatedTimeLeft = 0.0;
+
+    // auto shutdown/shutoff/master off feature
+    bool autoOffEnabled = USERMOD_BATTERY_AUTO_OFF_ENABLED;
+    int8_t autoOffThreshold = USERMOD_BATTERY_AUTO_OFF_THRESHOLD;
+
+    // low power indicator feature
+    bool lowPowerIndicatorEnabled = USERMOD_BATTERY_LOW_POWER_INDICATOR_ENABLED;
+    int8_t lowPowerIndicatorPreset = USERMOD_BATTERY_LOW_POWER_INDICATOR_PRESET;
+    int8_t lowPowerIndicatorThreshold = USERMOD_BATTERY_LOW_POWER_INDICATOR_THRESHOLD;
+    int8_t lowPowerIndicatorReactivationThreshold = lowPowerIndicatorThreshold+10;
+    int8_t lowPowerIndicatorDuration = USERMOD_BATTERY_LOW_POWER_INDICATOR_DURATION;
+    bool lowPowerIndicationDone = false;
+    unsigned long lowPowerActivationTime = 0; // used temporary during active time
+    int8_t lastPreset = 0;
+
+    bool initDone = false;
+    bool initializing = true;
+
+    // strings to reduce flash memory usage (used more than twice)
+    static const char _name[];
+    static const char _readInterval[];
+    static const char _enabled[];
+    static const char _threshold[];
+    static const char _preset[];
+    static const char _duration[];
+    static const char _init[];
+    
+
+    // custom map function
+    // https://forum.arduino.cc/t/floating-point-using-map-function/348113/2
+    double mapf(double x, double in_min, double in_max, double out_min, double out_max) 
+    {
+      return (x - in_min) * (out_max - out_min) / (in_max - in_min) + out_min;
+    }
+
+    float dot2round(float x) 
+    {
+      float nx = (int)(x * 100 + .5);
+      return (float)(nx / 100);
+    }
+
+    /*
+     * Turn off all leds
+     */
+    void turnOff()
+    {
+      bri = 0;
+      stateUpdated(CALL_MODE_DIRECT_CHANGE);
+    }
+
+    /*
+     * Indicate low power by activating a configured preset for a given time and then switching back to the preset that was selected previously
+     */
+    void lowPowerIndicator()
+    {
+      if (!lowPowerIndicatorEnabled) return;
+      if (batteryPin < 0) return;  // no measurement
+      if (lowPowerIndicationDone && lowPowerIndicatorReactivationThreshold <= batteryLevel) lowPowerIndicationDone = false;
+      if (lowPowerIndicatorThreshold <= batteryLevel) return;
+      if (lowPowerIndicationDone) return;
+      if (lowPowerActivationTime <= 1) {
+        lowPowerActivationTime = millis();
+        lastPreset = currentPreset;
+        applyPreset(lowPowerIndicatorPreset);
+      }
+
+      if (lowPowerActivationTime+(lowPowerIndicatorDuration*1000) <= millis()) {
+        lowPowerIndicationDone = true;
+        lowPowerActivationTime = 0;
+        applyPreset(lastPreset);
+      }      
+    }
+
+    float readVoltage()
+    {
+      #ifdef ARDUINO_ARCH_ESP32
+        // use calibrated millivolts analogread on esp32 (150 mV ~ 2450 mV default attentuation) and divide by 1000 to get from milivolts to volts and multiply by voltage multiplier and apply calibration value
+        return (analogReadMilliVolts(batteryPin) / 1000.0f) * voltageMultiplier  + calibration;
+      #else
+        // use analog read on esp8266 ( 0V ~ 1V no attenuation options) and divide by ADC precision 1023 and multiply by voltage multiplier and apply calibration value
+        return (analogRead(batteryPin) / 1023.0f) * voltageMultiplier + calibration;
+      #endif
+    }
+
+  public:
+    //Functions called by WLED
+
+    /*
+     * setup() is called once at boot. WiFi is not yet connected at this point.
+     * You can use it to initialize variables, sensors or similar.
+     */
+    void setup() 
+    {
+      #ifdef ARDUINO_ARCH_ESP32
+        bool success = false;
+        DEBUG_PRINTLN(F("Allocating battery pin..."));
+        if (batteryPin >= 0 && digitalPinToAnalogChannel(batteryPin) >= 0) 
+          if (pinManager.allocatePin(batteryPin, false, PinOwner::UM_Battery)) {
+            DEBUG_PRINTLN(F("Battery pin allocation succeeded."));
+            success = true;
+            voltage = readVoltage();
+          }
+
+        if (!success) {
+          DEBUG_PRINTLN(F("Battery pin allocation failed."));
+          batteryPin = -1;  // allocation failed
+        } else {
+          pinMode(batteryPin, INPUT);
+        }
+      #else //ESP8266 boards have only one analog input pin A0
+        pinMode(batteryPin, INPUT);
+        voltage = readVoltage();
+      #endif
+
+      nextReadTime = millis() + readingInterval;
+      lastReadTime = millis();
+
+      initDone = true;
+    }
+
+
+    /*
+     * connected() is called every time the WiFi is (re)connected
+     * Use it to initialize network interfaces
+     */
+    void connected() 
+    {
+      //Serial.println("Connected to WiFi!");
+    }
+
+
+    /*
+     * loop() is called continuously. Here you can check for events, read sensors, etc.
+     * 
+     */
+    void loop() 
+    {
+      if(strip.isUpdating()) return;
+
+      lowPowerIndicator();
+
+      // check the battery level every USERMOD_BATTERY_MEASUREMENT_INTERVAL (ms)
+      if (millis() < nextReadTime) return;
+
+      nextReadTime = millis() + readingInterval;
+      lastReadTime = millis();
+
+      if (batteryPin < 0) return;  // nothing to read
+
+      initializing = false;
+
+      rawValue = readVoltage();
+      // filter with exponential smoothing because ADC in esp32 is fluctuating too much for a good single readout
+      voltage = voltage + alpha * (rawValue - voltage);
+
+      // check if voltage is within specified voltage range, allow 10% over/under voltage - removed cause this just makes it hard for people to troubleshoot as the voltage in the web gui will say invalid instead of displaying a voltage
+      //voltage = ((voltage < minBatteryVoltage * 0.85f) || (voltage > maxBatteryVoltage * 1.1f)) ? -1.0f : voltage;
+
+      // translate battery voltage into percentage
+      /*
+        the standard "map" function doesn't work
+        https://www.arduino.cc/reference/en/language/functions/math/map/  notes and warnings at the bottom
+      */
+      #ifdef USERMOD_BATTERY_USE_LIPO
+        batteryLevel = mapf(voltage, minBatteryVoltage, maxBatteryVoltage, 0, 100); // basic mapping
+        // LiPo batteries have a differnt dischargin curve, see 
+        //  https://blog.ampow.com/lipo-voltage-chart/
+        if (batteryLevel < 40.0f) 
+          batteryLevel = mapf(batteryLevel, 0, 40, 0, 12);       // last 45% -> drops very quickly
+        else {
+          if (batteryLevel < 90.0f)
+            batteryLevel = mapf(batteryLevel, 40, 90, 12, 95);   // 90% ... 40% -> almost linear drop
+          else // level >  90%
+            batteryLevel = mapf(batteryLevel, 90, 105, 95, 100); // highest 15% -> drop slowly
+        }
+      #else
+        batteryLevel = mapf(voltage, minBatteryVoltage, maxBatteryVoltage, 0, 100);
+      #endif
+      if (voltage > -1.0f) batteryLevel = constrain(batteryLevel, 0.0f, 110.0f);
+
+      // if (calculateTimeLeftEnabled) {
+      //   float currentBatteryCapacity = totalBatteryCapacity;
+      //   estimatedTimeLeft = (currentBatteryCapacity/strip.currentMilliamps)*60;
+      // }
+
+      // Auto off -- Master power off
+      if (autoOffEnabled && (autoOffThreshold >= batteryLevel))
+        turnOff();
+
+#ifndef WLED_DISABLE_MQTT
+      // SmartHome stuff
+      // still don't know much about MQTT and/or HA
+      if (WLED_MQTT_CONNECTED) {
+        char buf[64]; // buffer for snprintf()
+        snprintf_P(buf, 63, PSTR("%s/voltage"), mqttDeviceTopic);
+        mqtt->publish(buf, 0, false, String(voltage).c_str());
+      }
+#endif
+
+    }
+
+    /*
+     * addToJsonInfo() can be used to add custom entries to the /json/info part of the JSON API.
+     * Creating an "u" object allows you to add custom key/value pairs to the Info section of the WLED web UI.
+     * Below it is shown how this could be used for e.g. a light sensor
+     */
+    void addToJsonInfo(JsonObject& root)
+    {
+      JsonObject user = root["u"];
+      if (user.isNull()) user = root.createNestedObject("u");
+
+      if (batteryPin < 0) {
+        JsonArray infoVoltage = user.createNestedArray(F("Battery voltage"));
+        infoVoltage.add(F("n/a"));
+        infoVoltage.add(F(" invalid GPIO"));
+        return;  // no GPIO - nothing to report
+      }
+
+      // info modal display names
+      JsonArray infoPercentage = user.createNestedArray(F("Battery level"));
+      JsonArray infoVoltage = user.createNestedArray(F("Battery voltage"));
+      // if (calculateTimeLeftEnabled)
+      // {
+      //   JsonArray infoEstimatedTimeLeft = user.createNestedArray(F("Estimated time left"));
+      //   if (initializing) {
+      //     infoEstimatedTimeLeft.add(FPSTR(_init));
+      //   } else {
+      //     infoEstimatedTimeLeft.add(estimatedTimeLeft);
+      //     infoEstimatedTimeLeft.add(F(" min"));
+      //   }
+      // }
+      JsonArray infoNextUpdate = user.createNestedArray(F("Next update"));
+
+      infoNextUpdate.add((nextReadTime - millis()) / 1000);
+      infoNextUpdate.add(F(" sec"));
+      
+      if (initializing) {
+        infoPercentage.add(FPSTR(_init));
+        infoVoltage.add(FPSTR(_init));
+        return;
+      }
+
+      if (batteryLevel < 0) {
+        infoPercentage.add(F("invalid"));
+      } else {
+        infoPercentage.add(batteryLevel);
+      }
+      infoPercentage.add(F(" %"));
+
+      if (voltage < 0) {
+        infoVoltage.add(F("invalid"));
+      } else {
+        infoVoltage.add(dot2round(voltage));
+      }
+      infoVoltage.add(F(" V"));
+    }
+
+
+    /*
+     * addToJsonState() can be used to add custom entries to the /json/state part of the JSON API (state object).
+     * Values in the state object may be modified by connected clients
+     */
+    /*
+    void addToJsonState(JsonObject& root)
+    {
+
+    }
+    */
+
+
+    /*
+     * readFromJsonState() can be used to receive data clients send to the /json/state part of the JSON API (state object).
+     * Values in the state object may be modified by connected clients
+     */
+    /*
+    void readFromJsonState(JsonObject& root)
+    {
+    }
+    */
+
+
+    /*
+     * addToConfig() can be used to add custom persistent settings to the cfg.json file in the "um" (usermod) object.
+     * It will be called by WLED when settings are actually saved (for example, LED settings are saved)
+     * If you want to force saving the current state, use serializeConfig() in your loop().
+     * 
+     * CAUTION: serializeConfig() will initiate a filesystem write operation.
+     * It might cause the LEDs to stutter and will cause flash wear if called too often.
+     * Use it sparingly and always in the loop, never in network callbacks!
+     * 
+     * addToConfig() will make your settings editable through the Usermod Settings page automatically.
+     *
+     * Usermod Settings Overview:
+     * - Numeric values are treated as floats in the browser.
+     *   - If the numeric value entered into the browser contains a decimal point, it will be parsed as a C float
+     *     before being returned to the Usermod.  The float data type has only 6-7 decimal digits of precision, and
+     *     doubles are not supported, numbers will be rounded to the nearest float value when being parsed.
+     *     The range accepted by the input field is +/- 1.175494351e-38 to +/- 3.402823466e+38.
+     *   - If the numeric value entered into the browser doesn't contain a decimal point, it will be parsed as a
+     *     C int32_t (range: -2147483648 to 2147483647) before being returned to the usermod.
+     *     Overflows or underflows are truncated to the max/min value for an int32_t, and again truncated to the type
+     *     used in the Usermod when reading the value from ArduinoJson.
+     * - Pin values can be treated differently from an integer value by using the key name "pin"
+     *   - "pin" can contain a single or array of integer values
+     *   - On the Usermod Settings page there is simple checking for pin conflicts and warnings for special pins
+     *     - Red color indicates a conflict.  Yellow color indicates a pin with a warning (e.g. an input-only pin)
+     *   - Tip: use int8_t to store the pin value in the Usermod, so a -1 value (pin not set) can be used
+     *
+     * See usermod_v2_auto_save.h for an example that saves Flash space by reusing ArduinoJson key name strings
+     * 
+     * If you need a dedicated settings page with custom layout for your Usermod, that takes a lot more work.  
+     * You will have to add the setting to the HTML, xml.cpp and set.cpp manually.
+     * See the WLED Soundreactive fork (code and wiki) for reference.  https://github.com/atuline/WLED
+     * 
+     * I highly recommend checking out the basics of ArduinoJson serialization and deserialization in order to use custom settings!
+     */
+    void addToConfig(JsonObject& root)
+    {
+      JsonObject battery = root.createNestedObject(FPSTR(_name));           // usermodname
+      #ifdef ARDUINO_ARCH_ESP32
+        battery[F("pin")] = batteryPin;
+      #endif
+
+      // battery[F("time-left")] = calculateTimeLeftEnabled;
+      battery[F("min-voltage")] = minBatteryVoltage;
+      battery[F("max-voltage")] = maxBatteryVoltage;
+      battery[F("capacity")] = totalBatteryCapacity;
+      battery[F("calibration")] = calibration;
+      battery[F("voltage-multiplier")] = voltageMultiplier;
+      battery[FPSTR(_readInterval)] = readingInterval;
+      
+      JsonObject ao = battery.createNestedObject(F("auto-off"));               // auto off section
+      ao[FPSTR(_enabled)] = autoOffEnabled;
+      ao[FPSTR(_threshold)] = autoOffThreshold;
+
+      JsonObject lp = battery.createNestedObject(F("indicator"));    // low power section
+      lp[FPSTR(_enabled)] = lowPowerIndicatorEnabled;
+      lp[FPSTR(_preset)] = lowPowerIndicatorPreset; // dropdown trickery (String)lowPowerIndicatorPreset; 
+      lp[FPSTR(_threshold)] = lowPowerIndicatorThreshold;
+      lp[FPSTR(_duration)] = lowPowerIndicatorDuration;
+
+      // read voltage in case calibration or voltage multiplier changed to see immediate effect
+      voltage = readVoltage();
+
+      DEBUG_PRINTLN(F("Battery config saved."));
+    }
+
+    void appendConfigData()
+    {
+      oappend(SET_F("addInfo('Battery:min-voltage', 1, 'v');"));
+      oappend(SET_F("addInfo('Battery:max-voltage', 1, 'v');"));
+      oappend(SET_F("addInfo('Battery:capacity', 1, 'mAh');"));
+      oappend(SET_F("addInfo('Battery:interval', 1, 'ms');"));
+      oappend(SET_F("addInfo('Battery:auto-off:threshold', 1, '%');"));
+      oappend(SET_F("addInfo('Battery:indicator:threshold', 1, '%');"));
+      oappend(SET_F("addInfo('Battery:indicator:duration', 1, 's');"));
+      
+      // cannot quite get this mf to work. its exeeding some buffer limit i think
+      // what i wanted is a list of all presets to select one from
+      // oappend(SET_F("bd=addDropdown('Battery:low-power-indicator', 'preset');"));
+      // the loop generates: oappend(SET_F("addOption(bd, 'preset name', preset id);"));
+      // for(int8_t i=1; i < 42; i++) {
+      //   oappend(SET_F("addOption(bd, 'Preset#"));
+      //   oappendi(i);
+      //   oappend(SET_F("',"));
+      //   oappendi(i);
+      //   oappend(SET_F(");"));
+      // }
+    }
+
+
+    /*
+     * readFromConfig() can be used to read back the custom settings you added with addToConfig().
+     * This is called by WLED when settings are loaded (currently this only happens immediately after boot, or after saving on the Usermod Settings page)
+     * 
+     * readFromConfig() is called BEFORE setup(). This means you can use your persistent values in setup() (e.g. pin assignments, buffer sizes),
+     * but also that if you want to write persistent values to a dynamic buffer, you'd need to allocate it here instead of in setup.
+     * If you don't know what that is, don't fret. It most likely doesn't affect your use case :)
+     * 
+     * Return true in case the config values returned from Usermod Settings were complete, or false if you'd like WLED to save your defaults to disk (so any missing values are editable in Usermod Settings)
+     * 
+     * getJsonValue() returns false if the value is missing, or copies the value into the variable provided and returns true if the value is present
+     * The configComplete variable is true only if the "exampleUsermod" object and all values are present.  If any values are missing, WLED will know to call addToConfig() to save them
+     * 
+     * This function is guaranteed to be called on boot, but could also be called every time settings are updated
+     */
+    bool readFromConfig(JsonObject& root)
+    {
+      #ifdef ARDUINO_ARCH_ESP32
+        int8_t newBatteryPin = batteryPin;
+      #endif
+      
+      JsonObject battery = root[FPSTR(_name)];
+      if (battery.isNull()) 
+      {
+        DEBUG_PRINT(FPSTR(_name));
+        DEBUG_PRINTLN(F(": No config found. (Using defaults.)"));
+        return false;
+      }
+
+      #ifdef ARDUINO_ARCH_ESP32
+        newBatteryPin     = battery[F("pin")] | newBatteryPin;
+      #endif
+      // calculateTimeLeftEnabled = battery[F("time-left")] | calculateTimeLeftEnabled;
+      setMinBatteryVoltage(battery[F("min-voltage")] | minBatteryVoltage);
+      setMaxBatteryVoltage(battery[F("max-voltage")] | maxBatteryVoltage);
+      setTotalBatteryCapacity(battery[F("capacity")] | totalBatteryCapacity);
+      setCalibration(battery[F("calibration")] | calibration);
+      setVoltageMultiplier(battery[F("voltage-multiplier")] | voltageMultiplier);
+      setReadingInterval(battery[FPSTR(_readInterval)] | readingInterval);
+
+      JsonObject ao = battery[F("auto-off")];
+      setAutoOffEnabled(ao[FPSTR(_enabled)] | autoOffEnabled);
+      setAutoOffThreshold(ao[FPSTR(_threshold)] | autoOffThreshold);
+
+      JsonObject lp = battery[F("indicator")];
+      setLowPowerIndicatorEnabled(lp[FPSTR(_enabled)] | lowPowerIndicatorEnabled);
+      setLowPowerIndicatorPreset(lp[FPSTR(_preset)] | lowPowerIndicatorPreset); // dropdown trickery (int)lp["preset"]
+      setLowPowerIndicatorThreshold(lp[FPSTR(_threshold)] | lowPowerIndicatorThreshold);
+      lowPowerIndicatorReactivationThreshold = lowPowerIndicatorThreshold+10;
+      setLowPowerIndicatorDuration(lp[FPSTR(_duration)] | lowPowerIndicatorDuration);
+
+      DEBUG_PRINT(FPSTR(_name));
+
+      #ifdef ARDUINO_ARCH_ESP32
+        if (!initDone) 
+        {
+          // first run: reading from cfg.json
+          batteryPin = newBatteryPin;
+          DEBUG_PRINTLN(F(" config loaded."));
+        } 
+        else 
+        {
+          DEBUG_PRINTLN(F(" config (re)loaded."));
+
+          // changing parameters from settings page
+          if (newBatteryPin != batteryPin) 
+          {
+            // deallocate pin
+            pinManager.deallocatePin(batteryPin, PinOwner::UM_Battery);
+            batteryPin = newBatteryPin;
+            // initialise
+            setup();
+          }
+        }
+      #endif
+
+      return !battery[FPSTR(_readInterval)].isNull();
+    }
+
+    /*
+     * Generate a preset sample for low power indication 
+     */
+    void generateExamplePreset()
+    {
+      // StaticJsonDocument<300> j;
+      // JsonObject preset = j.createNestedObject();
+      // preset["mainseg"] = 0;
+      // JsonArray seg = preset.createNestedArray("seg");
+      // JsonObject seg0 = seg.createNestedObject();
+      // seg0["id"] = 0;
+      // seg0["start"] = 0;
+      // seg0["stop"] = 60;
+      // seg0["grp"] = 0;
+      // seg0["spc"] = 0;
+      // seg0["on"] = true;
+      // seg0["bri"] = 255;
+
+      // JsonArray col0 = seg0.createNestedArray("col");
+      // JsonArray col00 = col0.createNestedArray();
+      // col00.add(255);
+      // col00.add(0);
+      // col00.add(0);
+
+      // seg0["fx"] = 1;
+      // seg0["sx"] = 128;
+      // seg0["ix"] = 128;
+
+      // savePreset(199, "Low power Indicator", preset);
+    }
+   
+
+    /*
+     *
+     * Getter and Setter. Just in case some other usermod wants to interact with this in the future
+     *
+     */
+
+    /*
+     * getId() allows you to optionally give your V2 usermod an unique ID (please define it in const.h!).
+     * This could be used in the future for the system to determine whether your usermod is installed.
+     */
+    uint16_t getId()
+    {
+      return USERMOD_ID_BATTERY;
+    }
+
+
+    unsigned long getReadingInterval()
+    {
+      return readingInterval;
+    }
+
+    /*
+     * minimum repetition is 3000ms (3s) 
+     */
+    void setReadingInterval(unsigned long newReadingInterval)
+    {
+      readingInterval = max((unsigned long)3000, newReadingInterval);
+    }
+
+
+    /*
+     * Get lowest configured battery voltage
+     */
+    float getMinBatteryVoltage()
+    {
+      return minBatteryVoltage;
+    }
+
+    /*
+     * Set lowest battery voltage
+     * can't be below 0 volt
+     */
+    void setMinBatteryVoltage(float voltage)
+    {
+      minBatteryVoltage = max(0.0f, voltage);
+    }
+
+    /*
+     * Get highest configured battery voltage
+     */
+    float getMaxBatteryVoltage()
+    {
+      return maxBatteryVoltage;
+    }
+    
+    /*
+     * Set highest battery voltage
+     * can't be below minBatteryVoltage
+     */
+    void setMaxBatteryVoltage(float voltage)
+    {
+      #ifdef USERMOD_BATTERY_USE_LIPO
+        maxBatteryVoltage = max(getMinBatteryVoltage()+0.7f, voltage);
+      #else
+        maxBatteryVoltage = max(getMinBatteryVoltage()+1.0f, voltage);
+      #endif
+    }
+
+
+    /*
+     * Get the capacity of all cells in parralel sumed up
+     * unit: mAh
+     */
+    unsigned int getTotalBatteryCapacity()
+    {
+      return totalBatteryCapacity;
+    }
+
+    void setTotalBatteryCapacity(unsigned int capacity)
+    {
+      totalBatteryCapacity = capacity;
+    }
+
+
+
+    /*
+     * Get the calculated voltage
+     * formula: (adc pin value / adc precision * max voltage) + calibration
+     */
+    float getVoltage()
+    {
+      return voltage;
+    }
+
+    /*
+     * Get the mapped battery level (0 - 100) based on voltage
+     * important: voltage can drop when a load is applied, so its only an estimate
+     */
+    int8_t getBatteryLevel()
+    {
+      return batteryLevel;
+    }
+
+    /*
+     * Get the configured calibration value
+     * a offset value to fine-tune the calculated voltage.
+     */
+    float getCalibration()
+    {
+      return calibration;
+    }
+
+    /*
+     * Set the voltage calibration offset value
+     * a offset value to fine-tune the calculated voltage.
+     */
+    void setCalibration(float offset)
+    {
+      calibration = offset;
+    }
+
+    /*
+     * Set the voltage multiplier value
+     * A multiplier that may need adjusting for different voltage divider setups
+     */
+    void setVoltageMultiplier(float multiplier)
+    {
+      voltageMultiplier = multiplier;
+    }
+
+    /*
+     * Get the voltage multiplier value
+     * A multiplier that may need adjusting for different voltage divider setups
+     */
+    float getVoltageMultiplier()
+    {
+      return voltageMultiplier;
+    }
+
+    /*
+     * Get auto-off feature enabled status
+     * is auto-off enabled, true/false
+     */
+    bool getAutoOffEnabled()
+    {
+      return autoOffEnabled;
+    }
+
+    /*
+     * Set auto-off feature status 
+     */
+    void setAutoOffEnabled(bool enabled)
+    {
+      autoOffEnabled = enabled;
+    }
+    
+    /*
+     * Get auto-off threshold in percent (0-100)
+     */
+    int8_t getAutoOffThreshold()
+    {
+      return autoOffThreshold;
+    }
+
+    /*
+     * Set auto-off threshold in percent (0-100) 
+     */
+    void setAutoOffThreshold(int8_t threshold)
+    {
+      autoOffThreshold = min((int8_t)100, max((int8_t)0, threshold));
+      // when low power indicator is enabled the auto-off threshold cannot be above indicator threshold
+      autoOffThreshold  = lowPowerIndicatorEnabled /*&& autoOffEnabled*/ ? min(lowPowerIndicatorThreshold-1, (int)autoOffThreshold) : autoOffThreshold;
+    }
+
+
+    /*
+     * Get low-power-indicator feature enabled status
+     * is the low-power-indicator enabled, true/false
+     */
+    bool getLowPowerIndicatorEnabled()
+    {
+      return lowPowerIndicatorEnabled;
+    }
+
+    /*
+     * Set low-power-indicator feature status 
+     */
+    void setLowPowerIndicatorEnabled(bool enabled)
+    {
+      lowPowerIndicatorEnabled = enabled;
+    }
+
+    /*
+     * Get low-power-indicator preset to activate when low power is detected
+     */
+    int8_t getLowPowerIndicatorPreset()
+    {
+      return lowPowerIndicatorPreset;
+    }
+
+    /* 
+     * Set low-power-indicator preset to activate when low power is detected
+     */
+    void setLowPowerIndicatorPreset(int8_t presetId)
+    {
+      // String tmp = ""; For what ever reason this doesn't work :(
+      // lowPowerIndicatorPreset = getPresetName(presetId, tmp) ? presetId : lowPowerIndicatorPreset;
+      lowPowerIndicatorPreset = presetId;
+    }
+
+    /*
+     * Get low-power-indicator threshold in percent (0-100)
+     */
+    int8_t getLowPowerIndicatorThreshold()
+    {
+      return lowPowerIndicatorThreshold;
+    }
+
+    /*
+     * Set low-power-indicator threshold in percent (0-100)
+     */
+    void setLowPowerIndicatorThreshold(int8_t threshold)
+    {
+      lowPowerIndicatorThreshold = threshold;
+      // when auto-off is enabled the indicator threshold cannot be below auto-off threshold
+      lowPowerIndicatorThreshold  = autoOffEnabled /*&& lowPowerIndicatorEnabled*/ ? max(autoOffThreshold+1, (int)lowPowerIndicatorThreshold) : max(5, (int)lowPowerIndicatorThreshold);
+    }
+
+    /*
+     * Get low-power-indicator duration in seconds
+     */
+    int8_t getLowPowerIndicatorDuration()
+    {
+      return lowPowerIndicatorDuration;
+    }
+
+    /*
+     * Set low-power-indicator duration in seconds
+     */
+    void setLowPowerIndicatorDuration(int8_t duration)
+    {
+      lowPowerIndicatorDuration = duration;
+    }
+
+
+    /*
+     * Get low-power-indicator status when the indication is done thsi returns true
+     */
+    bool getLowPowerIndicatorDone()
+    {
+      return lowPowerIndicationDone;
+    }
+};
+
+// strings to reduce flash memory usage (used more than twice)
+const char UsermodBattery::_name[]          PROGMEM = "Battery";
+const char UsermodBattery::_readInterval[]  PROGMEM = "interval";
+const char UsermodBattery::_enabled[]       PROGMEM = "enabled";
+const char UsermodBattery::_threshold[]     PROGMEM = "threshold";
+const char UsermodBattery::_preset[]        PROGMEM = "preset";
+const char UsermodBattery::_duration[]      PROGMEM = "duration";
+const char UsermodBattery::_init[]          PROGMEM = "init";

usermods/Cronixie/usermod_cronixie.h

@@ -114,7 +114,7 @@ class UsermodCronixie : public Usermod {
       //W Week of Month | WW Week of Year
       //D Day of Week | DD Day Of Month | DDD Day Of Year
 
-      DEBUG_PRINT("cset ");
+      DEBUG_PRINT(F("cset "));
       DEBUG_PRINTLN(cronixieDisplay);
       
       for (int i = 0; i < 6; i++)
@@ -160,7 +160,7 @@ class UsermodCronixie : public Usermod {
           //case 'v': break; //user var1
         }
       }
-      DEBUG_PRINT("result ");
+      DEBUG_PRINT(F("result "));
       for (int i = 0; i < 5; i++)
       {
         DEBUG_PRINT((int)dP[i]);
@@ -271,6 +271,7 @@ class UsermodCronixie : public Usermod {
     {
       if (root["nx"].is<const char*>()) {
         strncpy(cronixieDisplay, root["nx"], 6);
+        setCronixie();
       }
     }
 

usermods/DHT/usermod_dht.h

@@ -1,6 +1,10 @@
 #pragma once
 
 #include "wled.h"
+#ifndef WLED_ENABLE_MQTT
+#error "This user mod requires MQTT to be enabled."
+#endif
+
 
 #include <dht_nonblocking.h>
 
@@ -45,7 +49,7 @@
 #endif
 
 // how many seconds after boot to take first measurement, 90 seconds
-// 90 gives enough time to OTA update firmware if this crashses
+// 90 gives enough time to OTA update firmware if this crashes
 #ifndef USERMOD_DHT_FIRST_MEASUREMENT_AT
 #define USERMOD_DHT_FIRST_MEASUREMENT_AT 90000
 #endif

usermods/EXAMPLE_v2/usermod_v2_example.h

@@ -22,8 +22,12 @@
 
 //class name. Use something descriptive and leave the ": public Usermod" part :)
 class MyExampleUsermod : public Usermod {
+
   private:
-    //Private class members. You can declare variables and functions only accessible to your usermod here
+
+    // Private class members. You can declare variables and functions only accessible to your usermod here
+    bool enabled = false;
+    bool initDone = false;
     unsigned long lastTime = 0;
 
     // set your config variables to their boot default value (this can also be done in readFromConfig() or a constructor if you prefer)
@@ -37,15 +41,56 @@ class MyExampleUsermod : public Usermod {
     long testLong;
     int8_t testPins[2];
 
+    // string that are used multiple time (this will save some flash memory)
+    static const char _name[];
+    static const char _enabled[];
+
+
+    // any private methods should go here (non-inline method should be defined out of class)
+    void publishMqtt(const char* state, bool retain = false); // example for publishing MQTT message
+
+
   public:
-    //Functions called by WLED
+
+    // non WLED related methods, may be used for data exchange between usermods (non-inline methods should be defined out of class)
+
+    /**
+     * Enable/Disable the usermod
+     */
+    inline void enable(bool enable) { enabled = enable; }
+
+    /**
+     * Get usermod enabled/disabled state
+     */
+    inline bool isEnabled() { return enabled; }
+
+    // in such case add the following to another usermod:
+    //  in private vars:
+    //   #ifdef USERMOD_EXAMPLE
+    //   MyExampleUsermod* UM;
+    //   #endif
+    //  in setup()
+    //   #ifdef USERMOD_EXAMPLE
+    //   UM = (MyExampleUsermod*) usermods.lookup(USERMOD_ID_EXAMPLE);
+    //   #endif
+    //  somewhere in loop() or other member method
+    //   #ifdef USERMOD_EXAMPLE
+    //   if (UM != nullptr) isExampleEnabled = UM->isEnabled();
+    //   if (!isExampleEnabled) UM->enable(true);
+    //   #endif
+
+
+    // methods called by WLED (can be inlined as they are called only once but if you call them explicitly define them out of class)
 
     /*
      * setup() is called once at boot. WiFi is not yet connected at this point.
+     * readFromConfig() is called prior to setup()
      * You can use it to initialize variables, sensors or similar.
      */
-    void setup() {
+    void setup() override {
+      // do your set-up here
       //Serial.println("Hello from my usermod!");
+      initDone = true;
     }
 
 
@@ -53,7 +98,7 @@ class MyExampleUsermod : public Usermod {
      * connected() is called every time the WiFi is (re)connected
      * Use it to initialize network interfaces
      */
-    void connected() {
+    void connected() override {
       //Serial.println("Connected to WiFi!");
     }
 
@@ -68,7 +113,12 @@ class MyExampleUsermod : public Usermod {
      * 2. Try to avoid using the delay() function. NEVER use delays longer than 10 milliseconds.
      *    Instead, use a timer check as shown here.
      */
-    void loop() {
+    void loop() override {
+      // if usermod is disabled or called during strip updating just exit
+      // NOTE: on very long strips strip.isUpdating() may always return true so update accordingly
+      if (!enabled || strip.isUpdating()) return;
+
+      // do your magic here
       if (millis() - lastTime > 1000) {
         //Serial.println("I'm alive!");
         lastTime = millis();
@@ -81,28 +131,39 @@ class MyExampleUsermod : public Usermod {
      * Creating an "u" object allows you to add custom key/value pairs to the Info section of the WLED web UI.
      * Below it is shown how this could be used for e.g. a light sensor
      */
-    /*
-    void addToJsonInfo(JsonObject& root)
+    void addToJsonInfo(JsonObject& root) override
     {
-      int reading = 20;
-      //this code adds "u":{"Light":[20," lux"]} to the info object
+      // if "u" object does not exist yet wee need to create it
       JsonObject user = root["u"];
       if (user.isNull()) user = root.createNestedObject("u");
 
-      JsonArray lightArr = user.createNestedArray("Light"); //name
-      lightArr.add(reading); //value
-      lightArr.add(" lux"); //unit
+      //this code adds "u":{"ExampleUsermod":[20," lux"]} to the info object
+      //int reading = 20;
+      //JsonArray lightArr = user.createNestedArray(FPSTR(_name))); //name
+      //lightArr.add(reading); //value
+      //lightArr.add(F(" lux")); //unit
+
+      // if you are implementing a sensor usermod, you may publish sensor data
+      //JsonObject sensor = root[F("sensor")];
+      //if (sensor.isNull()) sensor = root.createNestedObject(F("sensor"));
+      //temp = sensor.createNestedArray(F("light"));
+      //temp.add(reading);
+      //temp.add(F("lux"));
     }
-    */
 
 
     /*
      * addToJsonState() can be used to add custom entries to the /json/state part of the JSON API (state object).
      * Values in the state object may be modified by connected clients
      */
-    void addToJsonState(JsonObject& root)
+    void addToJsonState(JsonObject& root) override
     {
-      //root["user0"] = userVar0;
+      if (!initDone || !enabled) return;  // prevent crash on boot applyPreset()
+
+      JsonObject usermod = root[FPSTR(_name)];
+      if (usermod.isNull()) usermod = root.createNestedObject(FPSTR(_name));
+
+      //usermod["user0"] = userVar0;
     }
 
 
@@ -110,9 +171,16 @@ class MyExampleUsermod : public Usermod {
      * readFromJsonState() can be used to receive data clients send to the /json/state part of the JSON API (state object).
      * Values in the state object may be modified by connected clients
      */
-    void readFromJsonState(JsonObject& root)
+    void readFromJsonState(JsonObject& root) override
     {
-      userVar0 = root["user0"] | userVar0; //if "user0" key exists in JSON, update, else keep old value
+      if (!initDone) return;  // prevent crash on boot applyPreset()
+
+      JsonObject usermod = root[FPSTR(_name)];
+      if (!usermod.isNull()) {
+        // expect JSON usermod data in usermod name object: {"ExampleUsermod:{"user0":10}"}
+        userVar0 = usermod["user0"] | userVar0; //if "user0" key exists in JSON, update, else keep old value
+      }
+      // you can as well check WLED state JSON keys
       //if (root["bri"] == 255) Serial.println(F("Don't burn down your garage!"));
     }
 
@@ -152,10 +220,12 @@ class MyExampleUsermod : public Usermod {
      * 
      * I highly recommend checking out the basics of ArduinoJson serialization and deserialization in order to use custom settings!
      */
-    void addToConfig(JsonObject& root)
+    void addToConfig(JsonObject& root) override
     {
-      JsonObject top = root.createNestedObject("exampleUsermod");
-      top["great"] = userVar0; //save these vars persistently whenever settings are saved
+      JsonObject top = root.createNestedObject(FPSTR(_name));
+      top[FPSTR(_enabled)] = enabled;
+      //save these vars persistently whenever settings are saved
+      top["great"] = userVar0;
       top["testBool"] = testBool;
       top["testInt"] = testInt;
       top["testLong"] = testLong;
@@ -183,12 +253,12 @@ class MyExampleUsermod : public Usermod {
      * 
      * This function is guaranteed to be called on boot, but could also be called every time settings are updated
      */
-    bool readFromConfig(JsonObject& root)
+    bool readFromConfig(JsonObject& root) override
     {
       // default settings values could be set here (or below using the 3-argument getJsonValue()) instead of in the class definition or constructor
       // setting them inside readFromConfig() is slightly more robust, handling the rare but plausible use case of single value being missing after boot (e.g. if the cfg.json was manually edited and a value was removed)
 
-      JsonObject top = root["exampleUsermod"];
+      JsonObject top = root[FPSTR(_name)];
 
       bool configComplete = !top.isNull();
 
@@ -201,6 +271,8 @@ class MyExampleUsermod : public Usermod {
       // A 3-argument getJsonValue() assigns the 3rd argument as a default value if the Json value is missing
       configComplete &= getJsonValue(top["testInt"], testInt, 42);  
       configComplete &= getJsonValue(top["testLong"], testLong, -42424242);
+
+      // "pin" fields have special handling in settings page (or some_pin as well)
       configComplete &= getJsonValue(top["pin"][0], testPins[0], -1);
       configComplete &= getJsonValue(top["pin"][1], testPins[1], -1);
 
@@ -208,26 +280,127 @@ class MyExampleUsermod : public Usermod {
     }
 
 
+    /*
+     * appendConfigData() is called when user enters usermod settings page
+     * it may add additional metadata for certain entry fields (adding drop down is possible)
+     * be careful not to add too much as oappend() buffer is limited to 3k
+     */
+    void appendConfigData() override
+    {
+      oappend(SET_F("addInfo('")); oappend(String(FPSTR(_name)).c_str()); oappend(SET_F(":great")); oappend(SET_F("',1,'<i>(this is a great config value)</i>');"));
+      oappend(SET_F("addInfo('")); oappend(String(FPSTR(_name)).c_str()); oappend(SET_F(":testString")); oappend(SET_F("',1,'enter any string you want');"));
+      oappend(SET_F("dd=addDropdown('")); oappend(String(FPSTR(_name)).c_str()); oappend(SET_F("','testInt');"));
+      oappend(SET_F("addOption(dd,'Nothing',0);"));
+      oappend(SET_F("addOption(dd,'Everything',42);"));
+    }
+
+
     /*
      * handleOverlayDraw() is called just before every show() (LED strip update frame) after effects have set the colors.
      * Use this to blank out some LEDs or set them to a different color regardless of the set effect mode.
      * Commonly used for custom clocks (Cronixie, 7 segment)
      */
-    void handleOverlayDraw()
+    void handleOverlayDraw() override
     {
       //strip.setPixelColor(0, RGBW32(0,0,0,0)) // set the first pixel to black
     }
 
-   
+
+    /**
+     * handleButton() can be used to override default button behaviour. Returning true
+     * will prevent button working in a default way.
+     * Replicating button.cpp
+     */
+    bool handleButton(uint8_t b) override {
+      yield();
+      // ignore certain button types as they may have other consequences
+      if (!enabled
+       || buttonType[b] == BTN_TYPE_NONE
+       || buttonType[b] == BTN_TYPE_RESERVED
+       || buttonType[b] == BTN_TYPE_PIR_SENSOR
+       || buttonType[b] == BTN_TYPE_ANALOG
+       || buttonType[b] == BTN_TYPE_ANALOG_INVERTED) {
+        return false;
+      }
+
+      bool handled = false;
+      // do your button handling here
+      return handled;
+    }
+  
+
+#ifndef WLED_DISABLE_MQTT
+    /**
+     * handling of MQTT message
+     * topic only contains stripped topic (part after /wled/MAC)
+     */
+    bool onMqttMessage(char* topic, char* payload) override {
+      // check if we received a command
+      //if (strlen(topic) == 8 && strncmp_P(topic, PSTR("/command"), 8) == 0) {
+      //  String action = payload;
+      //  if (action == "on") {
+      //    enabled = true;
+      //    return true;
+      //  } else if (action == "off") {
+      //    enabled = false;
+      //    return true;
+      //  } else if (action == "toggle") {
+      //    enabled = !enabled;
+      //    return true;
+      //  }
+      //}
+      return false;
+    }
+
+    /**
+     * onMqttConnect() is called when MQTT connection is established
+     */
+    void onMqttConnect(bool sessionPresent) override {
+      // do any MQTT related initialisation here
+      //publishMqtt("I am alive!");
+    }
+#endif
+
+
+    /**
+     * onStateChanged() is used to detect WLED state change
+     * @mode parameter is CALL_MODE_... parameter used for notifications
+     */
+    void onStateChange(uint8_t mode) override {
+      // do something if WLED state changed (color, brightness, effect, preset, etc)
+    }
+
+
     /*
      * getId() allows you to optionally give your V2 usermod an unique ID (please define it in const.h!).
      * This could be used in the future for the system to determine whether your usermod is installed.
      */
-    uint16_t getId()
+    uint16_t getId() override
     {
       return USERMOD_ID_EXAMPLE;
     }
 
    //More methods can be added in the future, this example will then be extended.
    //Your usermod will remain compatible as it does not need to implement all methods from the Usermod base class!
-};
+};
+
+
+// add more strings here to reduce flash memory usage
+const char MyExampleUsermod::_name[]    PROGMEM = "ExampleUsermod";
+const char MyExampleUsermod::_enabled[] PROGMEM = "enabled";
+
+
+// implementation of non-inline member methods
+
+void MyExampleUsermod::publishMqtt(const char* state, bool retain)
+{
+#ifndef WLED_DISABLE_MQTT
+  //Check if MQTT Connected, otherwise it will crash the 8266
+  if (WLED_MQTT_CONNECTED) {
+    char subuf[64];
+    strcpy(subuf, mqttDeviceTopic);
+    strcat_P(subuf, PSTR("/example"));
+    mqtt->publish(subuf, 0, retain, state);
+  }
+#endif
+}

usermods/EleksTube_IPS/TFTs.h

@@ -133,13 +133,13 @@ private:
       return false;
     }
 
-    read32(bmpFS); // filesize in bytes
-    read32(bmpFS); // reserved
+    (void) read32(bmpFS); // filesize in bytes
+    (void) read32(bmpFS); // reserved
     seekOffset = read32(bmpFS); // start of bitmap
     headerSize = read32(bmpFS); // header size
     w = read32(bmpFS); // width
     h = read32(bmpFS); // height
-    read16(bmpFS); // color planes (must be 1)
+    (void) read16(bmpFS); // color planes (must be 1)
     bitDepth = read16(bmpFS);
 
     if (read32(bmpFS) != 0 || (bitDepth != 24 && bitDepth != 1 && bitDepth != 4 && bitDepth != 8)) {
@@ -151,9 +151,9 @@ private:
     uint32_t palette[256];
     if (bitDepth <= 8) // 1,4,8 bit bitmap: read color palette
     {
-      read32(bmpFS); read32(bmpFS); read32(bmpFS); // size, w resolution, h resolution
+      (void) read32(bmpFS); (void) read32(bmpFS); (void) read32(bmpFS); // size, w resolution, h resolution
       paletteSize = read32(bmpFS);
-      if (paletteSize == 0) paletteSize = bitDepth * bitDepth; //if 0, size is 2^bitDepth
+      if (paletteSize == 0) paletteSize = 1 << bitDepth; //if 0, size is 2^bitDepth
       bmpFS.seek(14 + headerSize); // start of color palette
       for (uint16_t i = 0; i < paletteSize; i++) {
         palette[i] = read32(bmpFS);
@@ -198,7 +198,7 @@ private:
           }
           b = c; g = c >> 8; r = c >> 16;
         }
-        if (dimming != 255) { // only dimm when needed
+        if (dimming != 255) { // only dim when needed
           r *= dimming; g *= dimming; b *= dimming;
           r  = r  >> 8; g  = g  >> 8; b  = b  >> 8;
         }

usermods/Enclosure_with_OLED_temp_ESP07/usermod.cpp

@@ -1,3 +1,7 @@
+#ifndef WLED_ENABLE_MQTT
+#error "This user mod requires MQTT to be enabled."
+#endif
+
 #include "wled.h"
 #include <Arduino.h>
 #include <U8x8lib.h> // from https://github.com/olikraus/u8g2/
@@ -11,23 +15,23 @@ OneWire oneWire(13);
 DallasTemperature sensor(&oneWire);
 long temptimer = millis();
 long lastMeasure = 0;
-#define Celsius // Show temperature mesaurement in Celcius otherwise is in Fahrenheit 
+#define Celsius // Show temperature measurement in Celsius otherwise is in Fahrenheit 
 
 // If display does not work or looks corrupted check the
 // constructor reference:
 // https://github.com/olikraus/u8g2/wiki/u8x8setupcpp
 // or check the gallery:
 // https://github.com/olikraus/u8g2/wiki/gallery
-// --> First choise of cheap I2C OLED 128X32 0.91"
+// --> First choice of cheap I2C OLED 128X32 0.91"
 U8X8_SSD1306_128X32_UNIVISION_HW_I2C u8x8(U8X8_PIN_NONE, U8X8_PIN_SCL, U8X8_PIN_SDA); // Pins are Reset, SCL, SDA
-// --> Second choise of cheap I2C OLED 128X64 0.96" or 1.3"
+// --> Second choice of cheap I2C OLED 128X64 0.96" or 1.3"
 //U8X8_SSD1306_128X64_NONAME_HW_I2C u8x8(U8X8_PIN_NONE, U8X8_PIN_SCL, U8X8_PIN_SDA); // Pins are Reset, SCL, SDA
 // gets called once at boot. Do all initialization that doesn't depend on
 // network here
 void userSetup() {
   sensor.begin(); //Start Dallas temperature sensor
   u8x8.begin();
-  //u8x8.setFlipMode(1); //Uncoment if using WLED Wemos shield 
+  //u8x8.setFlipMode(1); //Un-comment if using WLED Wemos shield 
   u8x8.setPowerSave(0);
   u8x8.setContrast(10); //Contrast setup will help to preserve OLED lifetime. In case OLED need to be brighter increase number up to 255
   u8x8.setFont(u8x8_font_chroma48medium8_r);
@@ -67,7 +71,7 @@ void userLoop() {
     if (mqtt != nullptr)
     {
       sensor.requestTemperatures();
-//Gets prefered temperature scale based on selection in definitions section
+//Gets preferred temperature scale based on selection in definitions section
       #ifdef Celsius
       float board_temperature = sensor.getTempCByIndex(0);
       #else
@@ -134,11 +138,11 @@ void userLoop() {
   // First row with Wifi name
   u8x8.setCursor(1, 0);
   u8x8.print(knownSsid.substring(0, u8x8.getCols() > 1 ? u8x8.getCols() - 2 : 0));
-  // Print `~` char to indicate that SSID is longer, than owr dicplay
+  // Print `~` char to indicate that SSID is longer than our display
   if (knownSsid.length() > u8x8.getCols())
     u8x8.print("~");
 
-  // Second row with IP or Psssword
+  // Second row with IP or Password
   u8x8.setCursor(1, 1);
   // Print password in AP mode and if led is OFF.
   if (apActive && bri == 0)

usermods/Enclosure_with_OLED_temp_ESP07/usermod_bme280.cpp

@@ -1,3 +1,7 @@
+#ifndef WLED_ENABLE_MQTT
+#error "This user mod requires MQTT to be enabled."
+#endif
+
 #include "wled.h"
 #include <Arduino.h>
 #include <U8x8lib.h> // from https://github.com/olikraus/u8g2/
@@ -6,7 +10,7 @@
 
 void UpdateBME280Data();
 
-#define Celsius // Show temperature mesaurement in Celcius otherwise is in Fahrenheit 
+#define Celsius // Show temperature measurement in Celsius otherwise is in Fahrenheit 
 BME280I2C bme;    // Default : forced mode, standby time = 1000 ms
                   // Oversampling = pressure ×1, temperature ×1, humidity ×1, filter off,
 
@@ -16,14 +20,14 @@ uint8_t SDA_PIN = 21;
 #else //ESP8266 boards
 uint8_t SCL_PIN = 5;
 uint8_t SDA_PIN = 4;
-// uint8_t RST_PIN = 16; // Uncoment for Heltec WiFi-Kit-8
+// uint8_t RST_PIN = 16; // Un-comment for Heltec WiFi-Kit-8
 #endif
 
 //The SCL and SDA pins are defined here.
 //ESP8266 Wemos D1 mini board use SCL=5 SDA=4 while ESP32 Wemos32 mini board use SCL=22 SDA=21
 #define U8X8_PIN_SCL SCL_PIN
 #define U8X8_PIN_SDA SDA_PIN
-//#define U8X8_PIN_RESET RST_PIN // Uncoment for Heltec WiFi-Kit-8
+//#define U8X8_PIN_RESET RST_PIN // Un-comment for Heltec WiFi-Kit-8
 
 // If display does not work or looks corrupted check the
 // constructor reference:
@@ -32,9 +36,9 @@ uint8_t SDA_PIN = 4;
 // https://github.com/olikraus/u8g2/wiki/gallery
 // --> First choise of cheap I2C OLED 128X32 0.91"
 U8X8_SSD1306_128X32_UNIVISION_HW_I2C u8x8(U8X8_PIN_NONE, U8X8_PIN_SCL, U8X8_PIN_SDA); // Pins are Reset, SCL, SDA
-// --> Second choise of cheap I2C OLED 128X64 0.96" or 1.3"
+// --> Second choice of cheap I2C OLED 128X64 0.96" or 1.3"
 //U8X8_SSD1306_128X64_NONAME_HW_I2C u8x8(U8X8_PIN_NONE, U8X8_PIN_SCL, U8X8_PIN_SDA); // Pins are Reset, SCL, SDA
-// --> Third choise of Heltec WiFi-Kit-8 OLED 128X32 0.91"
+// --> Third choice of Heltec WiFi-Kit-8 OLED 128X32 0.91"
 //U8X8_SSD1306_128X32_UNIVISION_HW_I2C u8x8(U8X8_PIN_RESET, U8X8_PIN_SCL, U8X8_PIN_SDA); // Constructor for Heltec WiFi-Kit-8
 // gets called once at boot. Do all initialization that doesn't depend on network here
 
@@ -177,11 +181,11 @@ void userLoop() {
   // First row with Wifi name
   u8x8.setCursor(1, 0);
   u8x8.print(knownSsid.substring(0, u8x8.getCols() > 1 ? u8x8.getCols() - 2 : 0));
-  // Print `~` char to indicate that SSID is longer, than owr dicplay
+  // Print `~` char to indicate that SSID is longer than our display
   if (knownSsid.length() > u8x8.getCols())
     u8x8.print("~");
 
-  // Second row with IP or Psssword
+  // Second row with IP or Password
   u8x8.setCursor(1, 1);
   // Print password in AP mode and if led is OFF.
   if (apActive && bri == 0)

usermods/Fix_unreachable_netservices_v2/readme.md

@@ -2,7 +2,7 @@
 
 **Attention: This usermod compiles only for ESP8266**
 
-This usermod-v2 modification performs a ping request to a local IP address every 60 seconds. This ensures WLED net services remain accessible in some problematic WLAN environments.
+This usermod-v2 modification performs a ping request to a local IP address every 60 seconds. This ensures WLED net services remain accessible in some problematic WiFi environments.
 
 The modification works with static or DHCP IP address configuration.
 
@@ -24,7 +24,7 @@ The usermod supports the following state changes:
 
 | JSON key    | Value range      | Description                     |
 |-------------|------------------|---------------------------------|
-| PingDelayMs | 5000 to 18000000 | Deactivdate/activate the sensor |
+| PingDelayMs | 5000 to 18000000 | Deactivate/activate the sensor  |
 
  Changes also persist after a reboot.
 

usermods/Internal_Temperature_v2/readme.md

@@ -0,0 +1,17 @@
+# Internal Temperature Usermod
+This usermod adds the temperature readout to the Info tab and also publishes that over the topic `mcutemp` topic.
+
+## Important
+A shown temp of 53,33°C might indicate that the internal temp is not supported.
+
+ESP8266 does not have a internal temp sensor
+
+ESP32S2 seems to crash on reading the sensor -> disabled
+
+## Installation
+Add a build flag `-D USERMOD_INTERNAL_TEMPERATURE` to your `platformio.ini` (or `platformio_override.ini`).
+
+## Authors
+Soeren Willrodt [@lost-hope](https://github.com/lost-hope)
+
+Dimitry Zhemkov [@dima-zhemkov](https://github.com/dima-zhemkov)

usermods/Internal_Temperature_v2/usermod_internal_temperature.h

@@ -0,0 +1,117 @@
+#pragma once
+
+#include "wled.h"
+
+class InternalTemperatureUsermod : public Usermod
+{
+
+private:
+  unsigned long loopInterval = 10000;
+  unsigned long lastTime = 0;
+  bool isEnabled = false;
+  float temperature = 0;
+
+  static const char _name[];
+  static const char _enabled[];
+  static const char _loopInterval[];
+
+  // any private methods should go here (non-inline method should be defined out of class)
+  void publishMqtt(const char *state, bool retain = false); // example for publishing MQTT message
+
+public:
+  void setup()
+  {
+  }
+
+  void loop()
+  {
+    // if usermod is disabled or called during strip updating just exit
+    // NOTE: on very long strips strip.isUpdating() may always return true so update accordingly
+    if (!isEnabled || strip.isUpdating() || millis() - lastTime <= loopInterval)
+      return;
+
+    lastTime = millis();
+
+#ifdef ESP8266 // ESP8266
+    // does not seem possible
+    temperature = -1;
+#elif defined(CONFIG_IDF_TARGET_ESP32S2) // ESP32S2
+    temperature = -1;
+#else                                    // ESP32 ESP32S3 and ESP32C3
+    temperature = roundf(temperatureRead() * 10) / 10;
+#endif
+
+#ifndef WLED_DISABLE_MQTT
+    if (WLED_MQTT_CONNECTED)
+    {
+      char array[10];
+      snprintf(array, sizeof(array), "%f", temperature);
+      publishMqtt(array);
+    }
+#endif
+  }
+
+  void addToJsonInfo(JsonObject &root)
+  {
+    if (!isEnabled)
+      return;
+
+    // if "u" object does not exist yet wee need to create it
+    JsonObject user = root["u"];
+    if (user.isNull())
+      user = root.createNestedObject("u");
+
+    JsonArray userTempArr = user.createNestedArray(FPSTR(_name));
+    userTempArr.add(temperature);
+    userTempArr.add(F(" °C"));
+
+    // if "sensor" object does not exist yet wee need to create it
+    JsonObject sensor = root[F("sensor")];
+    if (sensor.isNull())
+      sensor = root.createNestedObject(F("sensor"));
+
+    JsonArray sensorTempArr = sensor.createNestedArray(FPSTR(_name));
+    sensorTempArr.add(temperature);
+    sensorTempArr.add(F("°C"));
+  }
+
+  void addToConfig(JsonObject &root)
+  {
+    JsonObject top = root.createNestedObject(FPSTR(_name));
+    top[FPSTR(_enabled)] = isEnabled;
+    top[FPSTR(_loopInterval)] = loopInterval;
+  }
+
+  bool readFromConfig(JsonObject &root)
+  {
+    JsonObject top = root[FPSTR(_name)];
+    bool configComplete = !top.isNull();
+    configComplete &= getJsonValue(top[FPSTR(_enabled)], isEnabled);
+    configComplete &= getJsonValue(top[FPSTR(_loopInterval)], loopInterval);
+
+    return configComplete;
+  }
+
+  uint16_t getId()
+  {
+    return USERMOD_ID_INTERNAL_TEMPERATURE;
+  }
+};
+
+const char InternalTemperatureUsermod::_name[] PROGMEM = "Internal Temperature";
+const char InternalTemperatureUsermod::_enabled[] PROGMEM = "Enabled";
+const char InternalTemperatureUsermod::_loopInterval[] PROGMEM = "Loop Interval";
+
+void InternalTemperatureUsermod::publishMqtt(const char *state, bool retain)
+{
+#ifndef WLED_DISABLE_MQTT
+  // Check if MQTT Connected, otherwise it will crash the 8266
+  if (WLED_MQTT_CONNECTED)
+  {
+    char subuf[64];
+    strcpy(subuf, mqttDeviceTopic);
+    strcat_P(subuf, PSTR("/mcutemp"));
+    mqtt->publish(subuf, 0, retain, state);
+  }
+#endif
+}

usermods/LDR_Dusk_Dawn_v2/README.md

@@ -0,0 +1,26 @@
+# LDR_Dusk_Dawn_v2
+This usermod will obtain readings from a Light Dependent Resistor (LDR) and will turn on/off specific presets based on those readings. This is useful for exterior lighting situations where you want the lights to only be on when it is dark out.
+
+# Installation
+Add "-D USERMOD_LDR_DUSK_DAWN" to your platformio.ini [common] build_flags and build.
+
+Example:
+```
+[common]
+build_flags =
+  -D USERMOD_LDR_DUSK_DAWN   # Enable LDR Dusk Dawn Usermod
+```
+
+# Usermod Settings
+Setting | Description | Default
+--- | --- | ---
+Enabled | Enable/Disable the LDR functionality. | Disabled
+LDR Pin | The analog capable pin your LDR is connected to. | 34
+Threshold Minutes | The number of minutes of consistent readings above/below the on/off threshold before the LED state will change. | 5
+Threshold | The analog read value threshold from the LDR. Readings lower than this number will count towards changing the LED state to off. You can see the current LDR reading by going into the info section when LDR functionality is enabled. | 1000
+On Preset | The WLED preset to be used for the LED on state. | 1
+Off Preset | The WLED preset to be used for the LED off state. | 2
+
+## Author
+[@jeffwdh](https://github.com/jeffwdh)  
+jeffwdh@tarball.ca

usermods/LDR_Dusk_Dawn_v2/usermod_LDR_Dusk_Dawn_v2.h

@@ -0,0 +1,153 @@
+#pragma once
+#include "wled.h"
+
+#ifndef ARDUINO_ARCH_ESP32
+  // 8266 does not support analogRead on user selectable pins 
+  #error only ESP32 is supported by usermod LDR_DUSK_DAWN
+#endif
+
+class LDR_Dusk_Dawn_v2 : public Usermod {
+  private:
+    // Defaults
+    bool ldrEnabled = false;
+    int ldrPin = 34; //A2 on Adafruit Huzzah32
+    int ldrThresholdMinutes = 5; // How many minutes of readings above/below threshold until it switches LED state
+    int ldrThreshold = 1000; // Readings higher than this number will turn off LED. 
+    int ldrOnPreset = 1; // Default "On" Preset
+    int ldrOffPreset = 2; // Default "Off" Preset
+
+    // Variables
+    bool initDone = false;
+    bool ldrEnabledPreviously = false; // Was LDR enabled for the previous check? First check is always no.
+    int ldrOffCount; // Number of readings above the threshold
+    int ldrOnCount; // Number of readings below the threshold
+    int ldrReading = 0; // Last LDR reading
+    int ldrLEDState; // Current LED on/off state
+    unsigned long lastMillis = 0;
+    static const char _name[];
+
+  public:
+    void setup() {
+      // register ldrPin
+      if ((ldrPin >= 0) && (digitalPinToAnalogChannel(ldrPin) >= 0)) {
+        if(!pinManager.allocatePin(ldrPin, false, PinOwner::UM_LDR_DUSK_DAWN)) ldrEnabled = false; // pin already in use -> disable usermod
+        else pinMode(ldrPin, INPUT);                                                               // alloc success -> configure pin for input
+      } else ldrEnabled = false;                                                                   // invalid pin -> disable usermod
+      initDone = true;
+    }
+
+    void loop() {
+      // Only update every 10 seconds
+      if (millis() - lastMillis > 10000) {      
+        if (  (ldrEnabled == true)
+           && (ldrPin >= 0) && (digitalPinToAnalogChannel(ldrPin) >= 0) ) { // make sure that pin is valid for analogread()
+          // Default state is off
+          if (ldrEnabledPreviously == false) {
+              applyPreset(ldrOffPreset);
+              ldrEnabledPreviously = true;
+              ldrLEDState = 0;
+          }
+
+          // Get LDR reading and increment counter by number of seconds since last read
+          ldrReading = analogRead(ldrPin);
+          if (ldrReading <= ldrThreshold) {
+            ldrOnCount = ldrOnCount + 10;
+            ldrOffCount = 0;
+          } else {
+            ldrOffCount = ldrOffCount + 10;
+            ldrOnCount = 0;
+          }
+
+          if (ldrOnCount >= (ldrThresholdMinutes * 60)) {
+            ldrOnCount = 0;
+            // If LEDs were previously off, turn on
+            if (ldrLEDState == 0) {
+              applyPreset(ldrOnPreset);
+              ldrLEDState = 1;
+            }
+          }
+
+          if (ldrOffCount >= (ldrThresholdMinutes * 60)) {
+            ldrOffCount = 0;
+            // If LEDs were previously on, turn off
+            if (ldrLEDState == 1) {
+              applyPreset(ldrOffPreset);
+              ldrLEDState = 0;
+            }
+          }
+        } else {
+          // LDR is disabled, reset variables to default
+          ldrReading = 0;
+          ldrOnCount = 0;
+          ldrOffCount = 0;
+          ldrLEDState = 0;
+          ldrEnabledPreviously = false;
+        }
+        lastMillis = millis();
+      }
+    }
+
+  void addToConfig(JsonObject& root) {
+      JsonObject top = root.createNestedObject(FPSTR(_name));
+      top["Enabled"] = ldrEnabled;
+      top["LDR Pin"] = ldrPin;
+      top["Threshold Minutes"] = ldrThresholdMinutes;
+      top["Threshold"] = ldrThreshold;
+      top["On Preset"] = ldrOnPreset;
+      top["Off Preset"] = ldrOffPreset;
+  }
+
+  bool readFromConfig(JsonObject& root) {
+      int8_t oldLdrPin = ldrPin;
+      JsonObject top = root[FPSTR(_name)];
+      bool configComplete = !top.isNull();
+      configComplete &= getJsonValue(top["Enabled"], ldrEnabled);
+      configComplete &= getJsonValue(top["LDR Pin"], ldrPin);
+      configComplete &= getJsonValue(top["Threshold Minutes"], ldrThresholdMinutes);
+      configComplete &= getJsonValue(top["Threshold"], ldrThreshold);
+      configComplete &= getJsonValue(top["On Preset"], ldrOnPreset);
+      configComplete &= getJsonValue(top["Off Preset"], ldrOffPreset);
+
+      if (initDone && (ldrPin != oldLdrPin)) {
+         // pin changed - un-register previous pin, register new pin
+        if (oldLdrPin >= 0) pinManager.deallocatePin(oldLdrPin, PinOwner::UM_LDR_DUSK_DAWN);
+        setup();             // setup new pin
+      }
+      return configComplete;
+  }
+
+  void addToJsonInfo(JsonObject& root) {
+      // If "u" object does not exist yet we need to create it
+      JsonObject user = root["u"];
+      if (user.isNull()) user = root.createNestedObject("u");
+
+      JsonArray LDR_Enabled = user.createNestedArray("LDR dusk/dawn enabled");
+      LDR_Enabled.add(ldrEnabled);
+      if (!ldrEnabled) return; // do not add more if usermod is disabled
+
+      JsonArray LDR_Reading = user.createNestedArray("LDR reading");
+      LDR_Reading.add(ldrReading);
+
+      JsonArray LDR_State = user.createNestedArray("LDR turned LEDs on");
+      LDR_State.add(bool(ldrLEDState));
+
+      // Optional debug information:
+      //JsonArray LDR_On_Count = user.createNestedArray("LDR on count");
+      //LDR_On_Count.add(ldrOnCount);
+
+      //JsonArray LDR_Off_Count = user.createNestedArray("LDR off count");
+      //LDR_Off_Count.add(ldrOffCount);
+
+      //bool pinValid = ((ldrPin >= 0) && (digitalPinToAnalogChannel(ldrPin) >= 0));
+      //if (pinManager.getPinOwner(ldrPin) != PinOwner::UM_LDR_DUSK_DAWN) pinValid = false;
+      //JsonArray LDR_valid = user.createNestedArray(F("LDR pin"));
+      //LDR_valid.add(ldrPin);
+      //LDR_valid.add(pinValid ? F(" OK"): F(" invalid"));
+  }
+
+  uint16_t getId() {
+    return USERMOD_ID_LDR_DUSK_DAWN;
+  }
+};
+
+const char LDR_Dusk_Dawn_v2::_name[]    PROGMEM = "LDR_Dusk_Dawn_v2";

usermods/PIR_sensor_switch/readme.md

@@ -23,7 +23,7 @@ You can also use usermod's off timer instead of sensor's. In such case rotate th
 
 ## Usermod installation
 
-**NOTE:** Usermod has been included in master branch of WLED so it can be compiled in directly just by defining `-D USERMOD_PIRSWITCH` and optionaly `-D PIR_SENSOR_PIN=16` to override default pin. You can also change the default off time by adding `-D PIR_SENSOR_OFF_SEC=30`.
+**NOTE:** Usermod has been included in master branch of WLED so it can be compiled in directly just by defining `-D USERMOD_PIRSWITCH` and optionally `-D PIR_SENSOR_PIN=16` to override default pin. You can also change the default off time by adding `-D PIR_SENSOR_OFF_SEC=30`.
 
 ## API to enable/disable the PIR sensor from outside. For example from another usermod:
 
@@ -31,7 +31,7 @@ To query or change the PIR sensor state the methods `bool PIRsensorEnabled()` an
 
 When the PIR sensor state changes an MQTT message is broadcasted with topic `wled/deviceMAC/motion` and message `on` or `off`.
 Usermod can also be configured to send just the MQTT message but not change WLED state using settings page as well as responding to motion only at night
-(assuming NTP and lattitude/longitude are set to determine sunrise/sunset times).
+(assuming NTP and latitude/longitude are set to determine sunrise/sunset times).
 
 ### There are two options to get access to the usermod instance:
 
@@ -75,6 +75,9 @@ Usermod can be configured via the Usermods settings page.
 * `mqtt-only` - send only MQTT messages, do not interact with WLED
 * `off-only` - only trigger presets or turn WLED on/off if WLED is not already on (displaying effect)
 * `notifications` - enable or disable sending notifications to other WLED instances using Sync button
+* `HA-discovery` - enable automatic discovery in Home Assistant
+* `override` - override PIR input when WLED state is changed using UI
+* `domoticz-idx` - Domoticz virtual switch ID (used with MQTT `domoticz/in`)
 
 
 Have fun - @gegu & @blazoncek
@@ -85,9 +88,16 @@ Have fun - @gegu & @blazoncek
 
 2021-11
 * Added information about dynamic configuration options
-* Added option to temporary enable/disble usermod from WLED UI (Info dialog)
+* Added option to temporary enable/disable usermod from WLED UI (Info dialog)
 
 2022-11
 * Added compile time option for off timer.
 * Added Home Assistant autodiscovery MQTT broadcast.
 * Updated info on compiling.
+
+2023-??
+* Override option
+* Domoticz virtual switch ID (used with MQTT `domoticz/in`)
+
+2024-02
+* Added compile time option to expand number of PIR sensors (they are logically ORed) `-D PIR_SENSOR_MAX_SENSORS=3`

usermods/PIR_sensor_switch/usermod_PIR_sensor_switch.h

@@ -15,12 +15,15 @@
   #define PIR_SENSOR_OFF_SEC 600
 #endif
 
+#ifndef PIR_SENSOR_MAX_SENSORS
+  #define PIR_SENSOR_MAX_SENSORS 1
+#endif
 
 /*
  * This usermod handles PIR sensor states.
  * The strip will be switched on and the off timer will be resetted when the sensor goes HIGH. 
  * When the sensor state goes LOW, the off timer is started and when it expires, the strip is switched off. 
- * 
+ * Maintained by: @blazoncek
  * 
  * Usermods allow you to add own functionality to WLED more easily
  * See: https://github.com/Aircoookie/WLED/wiki/Add-own-functionality
@@ -38,26 +41,25 @@ public:
   ~PIRsensorSwitch() {}
 
   //Enable/Disable the PIR sensor
-  void EnablePIRsensor(bool en) { enabled = en; }
+  inline void EnablePIRsensor(bool en) { enabled = en; }
   
   // Get PIR sensor enabled/disabled state
-  bool PIRsensorEnabled() { return enabled; }
+  inline bool PIRsensorEnabled() { return enabled; }
 
 private:
 
   byte prevPreset   = 0;
   byte prevPlaylist = 0;
 
-  uint32_t offTimerStart = 0;                   // off timer start time
-  byte NotifyUpdateMode  = CALL_MODE_NO_NOTIFY; // notification mode for stateUpdated(): CALL_MODE_NO_NOTIFY or CALL_MODE_DIRECT_CHANGE
-  byte sensorPinState    = LOW;                 // current PIR sensor pin state
-  bool initDone          = false;               // status of initialization
-  bool PIRtriggered      = false;
-  unsigned long lastLoop = 0;
+  volatile unsigned long offTimerStart = 0;     // off timer start time
+  volatile bool PIRtriggered           = false; // did PIR trigger?
+  bool          initDone               = false; // status of initialization
+  unsigned long lastLoop               = 0;
+  bool sensorPinState[PIR_SENSOR_MAX_SENSORS] = {LOW}; // current PIR sensor pin state
 
   // configurable parameters
   bool enabled              = true;           // PIR sensor enabled
-  int8_t PIRsensorPin       = PIR_SENSOR_PIN; // PIR sensor pin
+  int8_t PIRsensorPin[PIR_SENSOR_MAX_SENSORS] = {PIR_SENSOR_PIN}; // PIR sensor pin
   uint32_t m_switchOffDelay = PIR_SENSOR_OFF_SEC*1000;  // delay before switch off after the sensor state goes LOW (10min)
   uint8_t m_onPreset        = 0;              // on preset
   uint8_t m_offPreset       = 0;              // off preset
@@ -66,9 +68,11 @@ private:
   // flag to enable triggering only if WLED is initially off (LEDs are not on, preventing running effect being overwritten by PIR)
   bool m_offOnly            = false;
   bool m_offMode            = offMode;
+  bool m_override           = false;
 
   // Home Assistant
   bool HomeAssistantDiscovery = false;        // is HA discovery turned on
+  int16_t idx = -1; // Domoticz virtual switch idx
 
   // strings to reduce flash memory usage (used more than twice)
   static const char _name[];
@@ -80,169 +84,34 @@ private:
   static const char _mqttOnly[];
   static const char _offOnly[];
   static const char _haDiscovery[];
-  static const char _notify[];
+  static const char _override[];
+  static const char _domoticzIDX[];
 
   /**
    * check if it is daytime
    * if sunrise/sunset is not defined (no NTP or lat/lon) default to nighttime
    */
-  bool isDayTime() {
-    updateLocalTime();
-    uint8_t hr = hour(localTime);
-    uint8_t mi = minute(localTime);
-
-    if (sunrise && sunset) {
-      if (hour(sunrise)<hr && hour(sunset)>hr) {
-        return true;
-      } else {
-        if (hour(sunrise)==hr && minute(sunrise)<mi) {
-          return true;
-        }
-        if (hour(sunset)==hr && minute(sunset)>mi) {
-          return true;
-        }
-      }
-    }
-    return false;
-  }
+  static bool isDayTime();
 
   /**
    * switch strip on/off
    */
-  void switchStrip(bool switchOn)
-  {
-    if (m_offOnly && bri && (switchOn || (!PIRtriggered && !switchOn))) return; //if lights on and off only, do nothing
-    if (PIRtriggered && switchOn) return; //if already on and triggered before, do nothing
-    PIRtriggered = switchOn;
-    if (switchOn) {
-      if (m_onPreset) {
-        if (currentPlaylist>0 && !offMode) {
-          prevPlaylist = currentPlaylist;
-          unloadPlaylist();
-        } else if (currentPreset>0 && !offMode) {
-          prevPreset   = currentPreset;
-        } else {
-          saveTemporaryPreset();
-          prevPlaylist = 0;
-          prevPreset   = 255;
-        }
-        applyPreset(m_onPreset, NotifyUpdateMode);
-        return;
-      }
-      // preset not assigned
-      if (bri == 0) {
-        bri = briLast;
-        stateUpdated(NotifyUpdateMode);
-      }
-    } else {
-      if (m_offPreset) {
-        if (currentPreset==m_onPreset || currentPlaylist==m_onPreset) applyPreset(m_offPreset, NotifyUpdateMode);
-        return;
-      } else if (prevPlaylist) {
-        if (currentPreset==m_onPreset || currentPlaylist==m_onPreset) applyPreset(prevPlaylist, NotifyUpdateMode);
-        prevPlaylist = 0;
-        return;
-      } else if (prevPreset) {
-        if (prevPreset<255) { if (currentPreset==m_onPreset || currentPlaylist==m_onPreset) applyPreset(prevPreset, NotifyUpdateMode); }
-        else                { if (currentPreset==m_onPreset || currentPlaylist==m_onPreset) applyTemporaryPreset(); }
-        prevPreset = 0;
-        return;
-      }
-      // preset not assigned
-      if (bri != 0) {
-        briLast = bri;
-        bri = 0;
-        stateUpdated(NotifyUpdateMode);
-      }
-    }
-  }
-
-  void publishMqtt(const char* state)
-  {
-    //Check if MQTT Connected, otherwise it will crash the 8266
-    if (WLED_MQTT_CONNECTED) {
-      char subuf[64];
-      strcpy(subuf, mqttDeviceTopic);
-      strcat_P(subuf, PSTR("/motion"));
-      mqtt->publish(subuf, 0, false, state);
-    }
-  }
+  void switchStrip(bool switchOn);
+  void publishMqtt(bool switchOn);
 
   // Create an MQTT Binary Sensor for Home Assistant Discovery purposes, this includes a pointer to the topic that is published to in the Loop.
-  void publishHomeAssistantAutodiscovery()
-  {
-    if (WLED_MQTT_CONNECTED) {
-      StaticJsonDocument<600> doc;
-      char uid[24], json_str[1024], buf[128];
-
-      sprintf_P(buf, PSTR("%s Motion"), serverDescription); //max length: 33 + 7 = 40
-      doc[F("name")] = buf;
-      sprintf_P(buf, PSTR("%s/motion"), mqttDeviceTopic);   //max length: 33 + 7 = 40
-      doc[F("stat_t")] = buf;
-      doc[F("pl_on")]  = "on";
-      doc[F("pl_off")] = "off";
-      sprintf_P(uid, PSTR("%s_motion"), escapedMac.c_str());
-      doc[F("uniq_id")] = uid;
-      doc[F("dev_cla")] = F("motion");
-      doc[F("exp_aft")] = 1800;
-
-      JsonObject device = doc.createNestedObject(F("device")); // attach the sensor to the same device
-      device[F("name")] = serverDescription;
-      device[F("ids")]  = String(F("wled-sensor-")) + mqttClientID;
-      device[F("mf")]   = "WLED";
-      device[F("mdl")]  = F("FOSS");
-      device[F("sw")]   = versionString;
-      
-      sprintf_P(buf, PSTR("homeassistant/binary_sensor/%s/config"), uid);
-      DEBUG_PRINTLN(buf);
-      size_t payload_size = serializeJson(doc, json_str);
-      DEBUG_PRINTLN(json_str);
-
-      mqtt->publish(buf, 0, true, json_str, payload_size); // do we really need to retain?
-    }
-  }
+  void publishHomeAssistantAutodiscovery();
 
   /**
    * Read and update PIR sensor state.
-   * Initilize/reset switch off timer
+   * Initialize/reset switch off timer
    */
-  bool updatePIRsensorState()
-  {
-    bool pinState = digitalRead(PIRsensorPin);
-    if (pinState != sensorPinState) {
-      sensorPinState = pinState; // change previous state
-
-      if (sensorPinState == HIGH) {
-        offTimerStart = 0;
-        if (!m_mqttOnly && (!m_nightTimeOnly || (m_nightTimeOnly && !isDayTime()))) switchStrip(true);
-        else if (NotifyUpdateMode != CALL_MODE_NO_NOTIFY) updateInterfaces(CALL_MODE_WS_SEND);
-        publishMqtt("on");
-      } else {
-        // start switch off timer
-        offTimerStart = millis();
-        if (NotifyUpdateMode != CALL_MODE_NO_NOTIFY) updateInterfaces(CALL_MODE_WS_SEND);
-      }
-      return true;
-    }
-    return false;
-  }
+  bool updatePIRsensorState();
 
   /**
    * switch off the strip if the delay has elapsed 
    */
-  bool handleOffTimer()
-  {
-    if (offTimerStart > 0 && millis() - offTimerStart > m_switchOffDelay) {
-      offTimerStart = 0;
-      if (enabled == true) {
-        if (!m_mqttOnly && (!m_nightTimeOnly || (m_nightTimeOnly && !isDayTime()) || PIRtriggered)) switchStrip(false);
-        else if (NotifyUpdateMode != CALL_MODE_NO_NOTIFY) updateInterfaces(CALL_MODE_WS_SEND);
-        publishMqtt("off");
-      }
-      return true;
-    }
-    return false;
-  }
+  bool handleOffTimer();
 
 public:
   //Functions called by WLED
@@ -251,172 +120,57 @@ public:
    * setup() is called once at boot. WiFi is not yet connected at this point.
    * You can use it to initialize variables, sensors or similar.
    */
-  void setup()
-  {
-    if (enabled) {
-      // pin retrieved from cfg.json (readFromConfig()) prior to running setup()
-      if (PIRsensorPin >= 0 && pinManager.allocatePin(PIRsensorPin, false, PinOwner::UM_PIR)) {
-        // PIR Sensor mode INPUT_PULLUP
-        pinMode(PIRsensorPin, INPUT_PULLUP);
-        sensorPinState = digitalRead(PIRsensorPin);
-      } else {
-        if (PIRsensorPin >= 0) {
-          DEBUG_PRINTLN(F("PIRSensorSwitch pin allocation failed."));
-        }
-        PIRsensorPin = -1;  // allocation failed
-        enabled = false;
-      }
-    }
-    initDone = true;
-  }
+  void setup() override;
 
   /**
    * connected() is called every time the WiFi is (re)connected
    * Use it to initialize network interfaces
    */
-  void connected()
-  {
-  }
+  //void connected();
 
   /**
    * onMqttConnect() is called when MQTT connection is established
    */
-  void onMqttConnect(bool sessionPresent) {
-    if (HomeAssistantDiscovery) {
-      publishHomeAssistantAutodiscovery();
-    }
-  }
+  void onMqttConnect(bool sessionPresent) override;
 
   /**
    * loop() is called continuously. Here you can check for events, read sensors, etc.
    */
-  void loop()
-  {
-    // only check sensors 4x/s
-    if (!enabled || millis() - lastLoop < 250 || strip.isUpdating()) return;
-    lastLoop = millis();
-
-    if (!updatePIRsensorState()) {
-      handleOffTimer();
-    }
-  }
+  void loop() override;
 
   /**
    * addToJsonInfo() can be used to add custom entries to the /json/info part of the JSON API.
    * 
    * Add PIR sensor state and switch off timer duration to jsoninfo
    */
-  void addToJsonInfo(JsonObject &root)
-  {
-    JsonObject user = root["u"];
-    if (user.isNull()) user = root.createNestedObject("u");
+  void addToJsonInfo(JsonObject &root) override;
 
-    JsonArray infoArr = user.createNestedArray(FPSTR(_name));
-
-    String uiDomString;
-    if (enabled) {
-      if (offTimerStart > 0)
-      {
-        uiDomString = "";
-        unsigned int offSeconds = (m_switchOffDelay - (millis() - offTimerStart)) / 1000;
-        if (offSeconds >= 3600)
-        {
-          uiDomString += (offSeconds / 3600);
-          uiDomString += F("h ");
-          offSeconds %= 3600;
-        }
-        if (offSeconds >= 60)
-        {
-          uiDomString += (offSeconds / 60);
-          offSeconds %= 60;
-        }
-        else if (uiDomString.length() > 0)
-        {
-          uiDomString += 0;
-        }
-        if (uiDomString.length() > 0)
-        {
-          uiDomString += F("min ");
-        }
-        uiDomString += (offSeconds);
-        infoArr.add(uiDomString + F("s"));
-      } else {
-        infoArr.add(sensorPinState ? F("sensor on") : F("inactive"));
-      }
-    } else {
-      infoArr.add(F("disabled"));
-    }
-
-    uiDomString  = F(" <button class=\"btn btn-xs\" onclick=\"requestJson({");
-    uiDomString += FPSTR(_name);
-    uiDomString += F(":{");
-    uiDomString += FPSTR(_enabled);
-    if (enabled) {
-      uiDomString += F(":false}});\">");
-      uiDomString += F("<i class=\"icons on\">&#xe325;</i>");
-    } else {
-      uiDomString += F(":true}});\">");
-      uiDomString += F("<i class=\"icons off\">&#xe08f;</i>");
-    }
-    uiDomString += F("</button>");
-    infoArr.add(uiDomString);
-
-    JsonObject sensor = root[F("sensor")];
-    if (sensor.isNull()) sensor = root.createNestedObject(F("sensor"));
-    sensor[F("motion")] = sensorPinState || offTimerStart>0 ? true : false;
-  }
+  /**
+   * onStateChanged() is used to detect WLED state change
+   */
+  void onStateChange(uint8_t mode) override;
 
   /**
    * addToJsonState() can be used to add custom entries to the /json/state part of the JSON API (state object).
    * Values in the state object may be modified by connected clients
    */
-/*
-  void addToJsonState(JsonObject &root)
-  {
-  }
-*/
+  //void addToJsonState(JsonObject &root);
 
   /**
    * readFromJsonState() can be used to receive data clients send to the /json/state part of the JSON API (state object).
    * Values in the state object may be modified by connected clients
    */
-
-  void readFromJsonState(JsonObject &root)
-  {
-    if (!initDone) return;  // prevent crash on boot applyPreset()
-    JsonObject usermod = root[FPSTR(_name)];
-    if (!usermod.isNull()) {
-      if (usermod[FPSTR(_enabled)].is<bool>()) {
-        enabled = usermod[FPSTR(_enabled)].as<bool>();
-      }
-    }
-  }
-
+  void readFromJsonState(JsonObject &root) override;
 
   /**
    * provide the changeable values
    */
-  void addToConfig(JsonObject &root)
-  {
-    JsonObject top = root.createNestedObject(FPSTR(_name));
-    top[FPSTR(_enabled)]        = enabled;
-    top[FPSTR(_switchOffDelay)] = m_switchOffDelay / 1000;
-    top["pin"]                  = PIRsensorPin;
-    top[FPSTR(_onPreset)]       = m_onPreset;
-    top[FPSTR(_offPreset)]      = m_offPreset;
-    top[FPSTR(_nightTime)]      = m_nightTimeOnly;
-    top[FPSTR(_mqttOnly)]       = m_mqttOnly;
-    top[FPSTR(_offOnly)]        = m_offOnly;
-    top[FPSTR(_haDiscovery)]    = HomeAssistantDiscovery;
-    top[FPSTR(_notify)]         = (NotifyUpdateMode != CALL_MODE_NO_NOTIFY);
-    DEBUG_PRINTLN(F("PIR config saved."));
-  }
+  void addToConfig(JsonObject &root) override;
 
-  void appendConfigData()
-  {
-    oappend(SET_F("addInfo('PIRsensorSwitch:HA-discovery',1,'HA=Home Assistant');"));     // 0 is field type, 1 is actual field
-    oappend(SET_F("addInfo('PIRsensorSwitch:notifications',1,'Periodic WS updates');"));  // 0 is field type, 1 is actual field
-  }
+  /**
+   * provide UI information and allow extending UI options
+   */
+  void appendConfigData() override;
 
   /**
    * restore the changeable values
@@ -424,72 +178,13 @@ public:
    *
    * The function should return true if configuration was successfully loaded or false if there was no configuration.
    */
-  bool readFromConfig(JsonObject &root)
-  {
-    bool oldEnabled = enabled;
-    int8_t oldPin = PIRsensorPin;
-
-    DEBUG_PRINT(FPSTR(_name));
-    JsonObject top = root[FPSTR(_name)];
-    if (top.isNull()) {
-      DEBUG_PRINTLN(F(": No config found. (Using defaults.)"));
-      return false;
-    }
-
-    PIRsensorPin = top["pin"] | PIRsensorPin;
-
-    enabled = top[FPSTR(_enabled)] | enabled;
-
-    m_switchOffDelay = (top[FPSTR(_switchOffDelay)] | m_switchOffDelay/1000) * 1000;
-
-    m_onPreset = top[FPSTR(_onPreset)] | m_onPreset;
-    m_onPreset = max(0,min(250,(int)m_onPreset));
-    m_offPreset = top[FPSTR(_offPreset)] | m_offPreset;
-    m_offPreset = max(0,min(250,(int)m_offPreset));
-
-    m_nightTimeOnly = top[FPSTR(_nightTime)] | m_nightTimeOnly;
-    m_mqttOnly      = top[FPSTR(_mqttOnly)] | m_mqttOnly;
-    m_offOnly       = top[FPSTR(_offOnly)] | m_offOnly;
-    HomeAssistantDiscovery = top[FPSTR(_haDiscovery)] | HomeAssistantDiscovery;
-
-    NotifyUpdateMode = top[FPSTR(_notify)] ? CALL_MODE_DIRECT_CHANGE : CALL_MODE_NO_NOTIFY;
-
-    if (!initDone) {
-      // reading config prior to setup()
-      DEBUG_PRINTLN(F(" config loaded."));
-    } else {
-      if (oldPin != PIRsensorPin || oldEnabled != enabled) {
-        // check if pin is OK
-        if (oldPin != PIRsensorPin && oldPin >= 0) {
-          // if we are changing pin in settings page
-          // deallocate old pin
-          pinManager.deallocatePin(oldPin, PinOwner::UM_PIR);
-          if (pinManager.allocatePin(PIRsensorPin, false, PinOwner::UM_PIR)) {
-            pinMode(PIRsensorPin, INPUT_PULLUP);
-          } else {
-            // allocation failed
-            PIRsensorPin = -1;
-            enabled = false;
-          }
-        }
-        if (enabled) {
-          sensorPinState = digitalRead(PIRsensorPin);
-        }
-      }
-      DEBUG_PRINTLN(F(" config (re)loaded."));
-    }
-    // use "return !top["newestParameter"].isNull();" when updating Usermod with new features
-    return !top[FPSTR(_haDiscovery)].isNull();
-  }
+  bool readFromConfig(JsonObject &root) override;
 
   /**
    * getId() allows you to optionally give your V2 usermod an unique ID (please define it in const.h!).
    * This could be used in the future for the system to determine whether your usermod is installed.
    */
-  uint16_t getId()
-  {
-    return USERMOD_ID_PIRSWITCH;
-  }
+  uint16_t getId() override { return USERMOD_ID_PIRSWITCH; }
 };
 
 // strings to reduce flash memory usage (used more than twice)
@@ -502,4 +197,373 @@ const char PIRsensorSwitch::_nightTime[]      PROGMEM = "nighttime-only";
 const char PIRsensorSwitch::_mqttOnly[]       PROGMEM = "mqtt-only";
 const char PIRsensorSwitch::_offOnly[]        PROGMEM = "off-only";
 const char PIRsensorSwitch::_haDiscovery[]    PROGMEM = "HA-discovery";
-const char PIRsensorSwitch::_notify[]         PROGMEM = "notifications";
+const char PIRsensorSwitch::_override[]       PROGMEM = "override";
+const char PIRsensorSwitch::_domoticzIDX[]    PROGMEM = "domoticz-idx";
+
+bool PIRsensorSwitch::isDayTime() {
+  updateLocalTime();
+  uint8_t hr = hour(localTime);
+  uint8_t mi = minute(localTime);
+
+  if (sunrise && sunset) {
+    if (hour(sunrise)<hr && hour(sunset)>hr) {
+      return true;
+    } else {
+      if (hour(sunrise)==hr && minute(sunrise)<mi) {
+        return true;
+      }
+      if (hour(sunset)==hr && minute(sunset)>mi) {
+        return true;
+      }
+    }
+  }
+  return false;
+}
+
+void PIRsensorSwitch::switchStrip(bool switchOn)
+{
+  if (m_offOnly && bri && (switchOn || (!PIRtriggered && !switchOn))) return; //if lights on and off only, do nothing
+  if (PIRtriggered && switchOn) return; //if already on and triggered before, do nothing
+  PIRtriggered = switchOn;
+  DEBUG_PRINT(F("PIR: strip=")); DEBUG_PRINTLN(switchOn?"on":"off");
+  if (switchOn) {
+    if (m_onPreset) {
+      if (currentPlaylist>0 && !offMode) {
+        prevPlaylist = currentPlaylist;
+        unloadPlaylist();
+      } else if (currentPreset>0 && !offMode) {
+        prevPreset   = currentPreset;
+      } else {
+        saveTemporaryPreset();
+        prevPlaylist = 0;
+        prevPreset   = 255;
+      }
+      applyPreset(m_onPreset, CALL_MODE_BUTTON_PRESET);
+      return;
+    }
+    // preset not assigned
+    if (bri == 0) {
+      bri = briLast;
+      stateUpdated(CALL_MODE_BUTTON);
+    }
+  } else {
+    if (m_offPreset) {
+      applyPreset(m_offPreset, CALL_MODE_BUTTON_PRESET);
+      return;
+    } else if (prevPlaylist) {
+      if (currentPreset==m_onPreset || currentPlaylist==m_onPreset) applyPreset(prevPlaylist, CALL_MODE_BUTTON_PRESET);
+      prevPlaylist = 0;
+      return;
+    } else if (prevPreset) {
+      if (prevPreset<255) { if (currentPreset==m_onPreset || currentPlaylist==m_onPreset) applyPreset(prevPreset, CALL_MODE_BUTTON_PRESET); }
+      else                { if (currentPreset==m_onPreset || currentPlaylist==m_onPreset) applyTemporaryPreset(); }
+      prevPreset = 0;
+      return;
+    }
+    // preset not assigned
+    if (bri != 0) {
+      briLast = bri;
+      bri = 0;
+      stateUpdated(CALL_MODE_BUTTON);
+    }
+  }
+}
+
+void PIRsensorSwitch::publishMqtt(bool switchOn)
+{
+#ifndef WLED_DISABLE_MQTT
+  //Check if MQTT Connected, otherwise it will crash the 8266
+  if (WLED_MQTT_CONNECTED) {
+    char buf[128];
+    sprintf_P(buf, PSTR("%s/motion"), mqttDeviceTopic);   //max length: 33 + 7 = 40
+    mqtt->publish(buf, 0, false, switchOn?"on":"off");
+    // Domoticz formatted message
+    if (idx > 0) {
+      StaticJsonDocument <128> msg;
+      msg[F("idx")]       = idx;
+      msg[F("RSSI")]      = WiFi.RSSI();
+      msg[F("command")]   = F("switchlight");
+      msg[F("switchcmd")] = switchOn ? F("On") : F("Off");
+      serializeJson(msg, buf, 128);
+      mqtt->publish("domoticz/in", 0, false, buf);
+    }
+  }
+#endif
+}
+
+void PIRsensorSwitch::publishHomeAssistantAutodiscovery()
+{
+#ifndef WLED_DISABLE_MQTT
+  if (WLED_MQTT_CONNECTED) {
+    StaticJsonDocument<600> doc;
+    char uid[24], json_str[1024], buf[128];
+
+    sprintf_P(buf, PSTR("%s Motion"), serverDescription); //max length: 33 + 7 = 40
+    doc[F("name")] = buf;
+    sprintf_P(buf, PSTR("%s/motion"), mqttDeviceTopic);   //max length: 33 + 7 = 40
+    doc[F("stat_t")] = buf;
+    doc[F("pl_on")]  = "on";
+    doc[F("pl_off")] = "off";
+    sprintf_P(uid, PSTR("%s_motion"), escapedMac.c_str());
+    doc[F("uniq_id")] = uid;
+    doc[F("dev_cla")] = F("motion");
+    doc[F("exp_aft")] = 1800;
+
+    JsonObject device = doc.createNestedObject(F("device")); // attach the sensor to the same device
+    device[F("name")] = serverDescription;
+    device[F("ids")]  = String(F("wled-sensor-")) + mqttClientID;
+    device[F("mf")]   = F(WLED_BRAND);
+    device[F("mdl")]  = F(WLED_PRODUCT_NAME);
+    device[F("sw")]   = versionString;
+    
+    sprintf_P(buf, PSTR("homeassistant/binary_sensor/%s/config"), uid);
+    DEBUG_PRINTLN(buf);
+    size_t payload_size = serializeJson(doc, json_str);
+    DEBUG_PRINTLN(json_str);
+
+    mqtt->publish(buf, 0, true, json_str, payload_size); // do we really need to retain?
+  }
+#endif
+}
+
+bool PIRsensorSwitch::updatePIRsensorState()
+{
+  bool stateChanged = false;
+  bool allOff = true;
+  for (int i = 0; i < PIR_SENSOR_MAX_SENSORS; i++) {
+    if (PIRsensorPin[i] < 0) continue;
+
+    bool pinState = digitalRead(PIRsensorPin[i]);
+    if (pinState != sensorPinState[i]) {
+      sensorPinState[i] = pinState; // change previous state
+      stateChanged = true;
+
+      if (sensorPinState[i] == HIGH) {
+        offTimerStart = 0;
+        allOff = false;
+        if (!m_mqttOnly && (!m_nightTimeOnly || (m_nightTimeOnly && !isDayTime()))) switchStrip(true);
+      }
+    }
+  }
+  if (stateChanged) {
+    publishMqtt(!allOff);
+    // start switch off timer
+    if (allOff) offTimerStart = millis();
+  }
+  return stateChanged;
+}
+
+bool PIRsensorSwitch::handleOffTimer()
+{
+  if (offTimerStart > 0 && millis() - offTimerStart > m_switchOffDelay) {
+    offTimerStart = 0;
+    if (!m_mqttOnly && (!m_nightTimeOnly || (m_nightTimeOnly && !isDayTime()) || PIRtriggered)) switchStrip(false);
+    return true;
+  }
+  return false;
+}
+
+//Functions called by WLED
+
+void PIRsensorSwitch::setup()
+{
+  for (int i = 0; i < PIR_SENSOR_MAX_SENSORS; i++) {
+    sensorPinState[i] = LOW;
+    if (PIRsensorPin[i] < 0) continue;
+    // pin retrieved from cfg.json (readFromConfig()) prior to running setup()
+    if (pinManager.allocatePin(PIRsensorPin[i], false, PinOwner::UM_PIR)) {
+      // PIR Sensor mode INPUT_PULLDOWN
+      #ifdef ESP8266
+      pinMode(PIRsensorPin[i], PIRsensorPin[i]==16 ? INPUT_PULLDOWN_16 : INPUT_PULLUP); // ESP8266 has INPUT_PULLDOWN on GPIO16 only
+      #else
+      pinMode(PIRsensorPin[i], INPUT_PULLDOWN);
+      #endif
+      sensorPinState[i] = digitalRead(PIRsensorPin[i]);
+    } else {
+      DEBUG_PRINT(F("PIRSensorSwitch pin ")); DEBUG_PRINTLN(i); DEBUG_PRINTLN(F(" allocation failed."));
+      PIRsensorPin[i] = -1;  // allocation failed
+    }
+  }
+  initDone = true;
+}
+
+void PIRsensorSwitch::onMqttConnect(bool sessionPresent)
+{
+  if (HomeAssistantDiscovery) {
+    publishHomeAssistantAutodiscovery();
+  }
+}
+
+void PIRsensorSwitch::loop()
+{
+  // only check sensors 5x/s
+  if (!enabled || millis() - lastLoop < 200) return;
+  lastLoop = millis();
+
+  if (!updatePIRsensorState()) {
+    handleOffTimer();
+  }
+}
+
+void PIRsensorSwitch::addToJsonInfo(JsonObject &root)
+{
+  JsonObject user = root["u"];
+  if (user.isNull()) user = root.createNestedObject("u");
+
+  bool state = LOW;
+  for (int i = 0; i < PIR_SENSOR_MAX_SENSORS; i++)
+    if (PIRsensorPin[i] >= 0) state |= sensorPinState[i];
+
+  JsonArray infoArr = user.createNestedArray(FPSTR(_name));
+
+  String uiDomString;
+  if (enabled) {
+    if (offTimerStart > 0) {
+      uiDomString = "";
+      unsigned int offSeconds = (m_switchOffDelay - (millis() - offTimerStart)) / 1000;
+      if (offSeconds >= 3600) {
+        uiDomString += (offSeconds / 3600);
+        uiDomString += F("h ");
+        offSeconds %= 3600;
+      }
+      if (offSeconds >= 60) {
+        uiDomString += (offSeconds / 60);
+        offSeconds %= 60;
+      } else if (uiDomString.length() > 0) {
+        uiDomString += 0;
+      }
+      if (uiDomString.length() > 0) {
+        uiDomString += F("min ");
+      }
+      uiDomString += (offSeconds);
+      infoArr.add(uiDomString + F("s"));
+    } else {
+      infoArr.add(state ? F("sensor on") : F("inactive"));
+    }
+  } else {
+    infoArr.add(F("disabled"));
+  }
+
+  uiDomString  = F(" <button class=\"btn btn-xs\" onclick=\"requestJson({");
+  uiDomString += FPSTR(_name);
+  uiDomString += F(":{");
+  uiDomString += FPSTR(_enabled);
+  if (enabled) {
+    uiDomString += F(":false}});\">");
+    uiDomString += F("<i class=\"icons on\">&#xe325;</i>");
+  } else {
+    uiDomString += F(":true}});\">");
+    uiDomString += F("<i class=\"icons off\">&#xe08f;</i>");
+  }
+  uiDomString += F("</button>");
+  infoArr.add(uiDomString);
+
+  if (enabled) {
+    JsonObject sensor = root[F("sensor")];
+    if (sensor.isNull()) sensor = root.createNestedObject(F("sensor"));
+    sensor[F("motion")] = state || offTimerStart>0 ? true : false;
+  }
+}
+
+void PIRsensorSwitch::onStateChange(uint8_t mode) {
+  if (!initDone) return;
+  DEBUG_PRINT(F("PIR: offTimerStart=")); DEBUG_PRINTLN(offTimerStart);
+  if (m_override && PIRtriggered && offTimerStart) { // debounce
+    // checking PIRtriggered and offTimerStart will prevent cancellation upon On trigger
+    DEBUG_PRINTLN(F("PIR: Canceled."));
+    offTimerStart = 0;
+    PIRtriggered = false;
+  }
+}
+
+void PIRsensorSwitch::readFromJsonState(JsonObject &root)
+{
+  if (!initDone) return;  // prevent crash on boot applyPreset()
+  JsonObject usermod = root[FPSTR(_name)];
+  if (!usermod.isNull()) {
+    if (usermod[FPSTR(_enabled)].is<bool>()) {
+      enabled = usermod[FPSTR(_enabled)].as<bool>();
+    }
+  }
+}
+
+void PIRsensorSwitch::addToConfig(JsonObject &root)
+{
+  JsonObject top = root.createNestedObject(FPSTR(_name));
+  top[FPSTR(_enabled)]        = enabled;
+  top[FPSTR(_switchOffDelay)] = m_switchOffDelay / 1000;
+  JsonArray pinArray          = top.createNestedArray("pin");
+  for (int i = 0; i < PIR_SENSOR_MAX_SENSORS; i++) pinArray.add(PIRsensorPin[i]);
+  top[FPSTR(_onPreset)]       = m_onPreset;
+  top[FPSTR(_offPreset)]      = m_offPreset;
+  top[FPSTR(_nightTime)]      = m_nightTimeOnly;
+  top[FPSTR(_mqttOnly)]       = m_mqttOnly;
+  top[FPSTR(_offOnly)]        = m_offOnly;
+  top[FPSTR(_override)]       = m_override;
+  top[FPSTR(_haDiscovery)]    = HomeAssistantDiscovery;
+  top[FPSTR(_domoticzIDX)]    = idx;
+  DEBUG_PRINTLN(F("PIR config saved."));
+}
+
+void PIRsensorSwitch::appendConfigData()
+{
+  oappend(SET_F("addInfo('PIRsensorSwitch:HA-discovery',1,'HA=Home Assistant');"));     // 0 is field type, 1 is actual field
+  oappend(SET_F("addInfo('PIRsensorSwitch:override',1,'Cancel timer on change');"));    // 0 is field type, 1 is actual field
+  for (int i = 0; i < PIR_SENSOR_MAX_SENSORS; i++) {
+    char str[128];
+    sprintf_P(str, PSTR("addInfo('PIRsensorSwitch:pin[]',%d,'','#%d');"), i, i);
+    oappend(str);
+  }
+}
+
+bool PIRsensorSwitch::readFromConfig(JsonObject &root)
+{
+  int8_t oldPin[PIR_SENSOR_MAX_SENSORS];
+  for (int i = 0; i < PIR_SENSOR_MAX_SENSORS; i++) {
+    oldPin[i] = PIRsensorPin[i];
+    PIRsensorPin[i] = -1;
+  }
+
+  DEBUG_PRINT(FPSTR(_name));
+  JsonObject top = root[FPSTR(_name)];
+  if (top.isNull()) {
+    DEBUG_PRINTLN(F(": No config found. (Using defaults.)"));
+    return false;
+  }
+
+  JsonArray pins = top["pin"];
+  if (!pins.isNull()) {
+    for (size_t i = 0; i < PIR_SENSOR_MAX_SENSORS; i++)
+      if (i < pins.size()) PIRsensorPin[i] = pins[i] | PIRsensorPin[i];
+  } else {
+    PIRsensorPin[0] = top["pin"] | oldPin[0];
+  }
+
+  enabled = top[FPSTR(_enabled)] | enabled;
+
+  m_switchOffDelay = (top[FPSTR(_switchOffDelay)] | m_switchOffDelay/1000) * 1000;
+
+  m_onPreset = top[FPSTR(_onPreset)] | m_onPreset;
+  m_onPreset = max(0,min(250,(int)m_onPreset));
+  m_offPreset = top[FPSTR(_offPreset)] | m_offPreset;
+  m_offPreset = max(0,min(250,(int)m_offPreset));
+
+  m_nightTimeOnly = top[FPSTR(_nightTime)] | m_nightTimeOnly;
+  m_mqttOnly      = top[FPSTR(_mqttOnly)] | m_mqttOnly;
+  m_offOnly       = top[FPSTR(_offOnly)] | m_offOnly;
+  m_override      = top[FPSTR(_override)] | m_override;
+  HomeAssistantDiscovery = top[FPSTR(_haDiscovery)] | HomeAssistantDiscovery;
+  idx             = top[FPSTR(_domoticzIDX)] | idx;
+
+  if (!initDone) {
+    // reading config prior to setup()
+    DEBUG_PRINTLN(F(" config loaded."));
+  } else {
+    for (int i = 0; i < PIR_SENSOR_MAX_SENSORS; i++)
+      if (oldPin[i] >= 0) pinManager.deallocatePin(oldPin[i], PinOwner::UM_PIR);
+    setup();
+    DEBUG_PRINTLN(F(" config (re)loaded."));
+  }
+  // use "return !top["newestParameter"].isNull();" when updating Usermod with new features
+  return !(pins.isNull() || pins.size() != PIR_SENSOR_MAX_SENSORS);
+}

usermods/PWM_fan/readme.md

@@ -5,7 +5,7 @@ v2 Usermod to to control PWM fan with RPM feedback and temperature control
 This usermod requires the Dallas Temperature usermod to obtain temperature information. If it's not available, the fan will run at 100% speed.
 If the fan does not have _tachometer_ (RPM) output you can set the _tachometer-pin_ to -1 to disable that feature.
 
-You can also set the thershold temperature at which fan runs at lowest speed. If the measured temperature is 3°C greater than the threshold temperature, the fan will run at 100%.
+You can also set the threshold temperature at which fan runs at lowest speed. If the measured temperature is 3°C greater than the threshold temperature, the fan will run at 100%.
 
 If the _tachometer_ is supported, the current speed (in RPM) will be displayed on the WLED Info page.
 
@@ -22,7 +22,7 @@ This includes:
 * PWM output pin (can be configured at compile time `-D PWM_PIN=xx`)
 * tachometer input pin (can be configured at compile time `-D TACHO_PIN=xx`)
 * sampling frequency in seconds
-* threshold temperature in degees C
+* threshold temperature in degrees Celsius
 
 _NOTE:_ You may also need to tweak Dallas Temperature usermod sampling frequency to match PWM fan sampling frequency.
 

usermods/PWM_fan/usermod_PWM_fan.h

@@ -1,7 +1,7 @@
 #pragma once
 
-#ifndef USERMOD_DALLASTEMPERATURE
-#error The "PWM fan" usermod requires "Dallas Temeprature" usermod to function properly.
+#if !defined(USERMOD_DALLASTEMPERATURE) && !defined(USERMOD_SHT)
+#error The "PWM fan" usermod requires "Dallas Temeprature" or "SHT" usermod to function properly.
 #endif
 
 #include "wled.h"
@@ -42,6 +42,8 @@ class PWMFanUsermod : public Usermod {
 
     #ifdef USERMOD_DALLASTEMPERATURE
     UsermodTemperature* tempUM;
+    #elif defined(USERMOD_SHT)
+    ShtUsermod* tempUM;
     #endif
 
     // configurable parameters
@@ -50,9 +52,15 @@ class PWMFanUsermod : public Usermod {
     uint8_t tachoUpdateSec    = 30;
     float   targetTemperature = 35.0;
     uint8_t minPWMValuePct    = 0;
+    uint8_t maxPWMValuePct    = 100;
     uint8_t numberOfInterrupsInOneSingleRotation = 2;     // Number of interrupts ESP32 sees on tacho signal on a single fan rotation. All the fans I've seen trigger two interrups.
     uint8_t pwmValuePct       = 0;
 
+    // constant values
+    static const uint8_t _pwmMaxValue     = 255;
+    static const uint8_t _pwmMaxStepCount = 7;
+    float _pwmTempStepSize = 0.5f;
+
     // strings to reduce flash memory usage (used more than twice)
     static const char _name[];
     static const char _enabled[];
@@ -61,6 +69,7 @@ class PWMFanUsermod : public Usermod {
     static const char _temperature[];
     static const char _tachoUpdateSec[];
     static const char _minPWMValuePct[];
+    static const char _maxPWMValuePct[];
     static const char _IRQperRotation[];
     static const char _speed[];
     static const char _lock[];
@@ -145,7 +154,7 @@ class PWMFanUsermod : public Usermod {
     }
 
     float getActualTemperature(void) {
-      #ifdef USERMOD_DALLASTEMPERATURE
+      #if defined(USERMOD_DALLASTEMPERATURE) || defined(USERMOD_SHT)
       if (tempUM != nullptr)
         return tempUM->getTemperatureC();
       #endif
@@ -154,41 +163,37 @@ class PWMFanUsermod : public Usermod {
 
     void setFanPWMbasedOnTemperature(void) {
       float temp = getActualTemperature();
-      float difftemp = temp - targetTemperature;
-      // Default to run fan at full speed.
-      int newPWMvalue = 255;
-      int pwmStep = ((100 - minPWMValuePct) * newPWMvalue) / (7*100);
-      int pwmMinimumValue = (minPWMValuePct * newPWMvalue) / 100;
+      // dividing minPercent and maxPercent into equal pwmvalue sizes
+      int pwmStepSize = ((maxPWMValuePct - minPWMValuePct) * _pwmMaxValue) / (_pwmMaxStepCount*100);
+      int pwmStep = calculatePwmStep(temp - targetTemperature);
+      // minimum based on full speed - not entered MaxPercent 
+      int pwmMinimumValue = (minPWMValuePct * _pwmMaxValue) / 100;
+      updateFanSpeed(pwmMinimumValue + pwmStep*pwmStepSize);
+    }
 
-      if ((temp == NAN) || (temp <= -100.0)) {
+    uint8_t calculatePwmStep(float diffTemp){
+      if ((diffTemp == NAN) || (diffTemp <= -100.0)) {
         DEBUG_PRINTLN(F("WARNING: no temperature value available. Cannot do temperature control. Will set PWM fan to 255."));
-      } else if (difftemp <= 0.0) {
-        // Temperature is below target temperature. Run fan at minimum speed.
-        newPWMvalue = pwmMinimumValue;
-      } else if (difftemp <= 0.5) {
-        newPWMvalue = pwmMinimumValue + pwmStep;
-      } else if (difftemp <= 1.0) {
-        newPWMvalue = pwmMinimumValue + 2*pwmStep;
-      } else if (difftemp <= 1.5) {
-        newPWMvalue = pwmMinimumValue + 3*pwmStep;
-      } else if (difftemp <= 2.0) {
-        newPWMvalue = pwmMinimumValue + 4*pwmStep;
-      } else if (difftemp <= 2.5) {
-        newPWMvalue = pwmMinimumValue + 5*pwmStep;
-      } else if (difftemp <= 3.0) {
-        newPWMvalue = pwmMinimumValue + 6*pwmStep;
+        return _pwmMaxStepCount;
       }
-      updateFanSpeed(newPWMvalue);
+      if(diffTemp <=0){
+        return 0;
+      }
+      int calculatedStep = (diffTemp / _pwmTempStepSize)+1;
+      // anything greater than max stepcount gets max 
+      return (uint8_t)min((int)_pwmMaxStepCount,calculatedStep);      
     }
 
   public:
 
     // gets called once at boot. Do all initialization that doesn't depend on
     // network here
-    void setup() {
+    void setup() override {
       #ifdef USERMOD_DALLASTEMPERATURE   
       // This Usermod requires Temperature usermod
       tempUM = (UsermodTemperature*) usermods.lookup(USERMOD_ID_TEMPERATURE);
+      #elif defined(USERMOD_SHT)
+      tempUM = (ShtUsermod*) usermods.lookup(USERMOD_ID_SHT);
       #endif
       initTacho();
       initPWMfan();
@@ -198,12 +203,12 @@ class PWMFanUsermod : public Usermod {
 
     // gets called every time WiFi is (re-)connected. Initialize own network
     // interfaces here
-    void connected() {}
+    void connected() override {}
 
     /*
      * Da loop.
      */
-    void loop() {
+    void loop() override {
       if (!enabled || strip.isUpdating()) return;
 
       unsigned long now = millis();
@@ -218,7 +223,7 @@ class PWMFanUsermod : public Usermod {
      * Creating an "u" object allows you to add custom key/value pairs to the Info section of the WLED web UI.
      * Below it is shown how this could be used for e.g. a light sensor
      */
-    void addToJsonInfo(JsonObject& root) {
+    void addToJsonInfo(JsonObject& root) override {
       JsonObject user = root["u"];
       if (user.isNull()) user = root.createNestedObject("u");
 
@@ -267,7 +272,7 @@ class PWMFanUsermod : public Usermod {
      * readFromJsonState() can be used to receive data clients send to the /json/state part of the JSON API (state object).
      * Values in the state object may be modified by connected clients
      */
-    void readFromJsonState(JsonObject& root) {
+    void readFromJsonState(JsonObject& root) override {
       if (!initDone) return;  // prevent crash on boot applyPreset()
       JsonObject usermod = root[FPSTR(_name)];
       if (!usermod.isNull()) {
@@ -300,7 +305,7 @@ class PWMFanUsermod : public Usermod {
      * 
      * I highly recommend checking out the basics of ArduinoJson serialization and deserialization in order to use custom settings!
      */
-    void addToConfig(JsonObject& root) {
+    void addToConfig(JsonObject& root) override {
       JsonObject top = root.createNestedObject(FPSTR(_name)); // usermodname
       top[FPSTR(_enabled)]        = enabled;
       top[FPSTR(_pwmPin)]         = pwmPin;
@@ -308,6 +313,7 @@ class PWMFanUsermod : public Usermod {
       top[FPSTR(_tachoUpdateSec)] = tachoUpdateSec;
       top[FPSTR(_temperature)]    = targetTemperature;
       top[FPSTR(_minPWMValuePct)] = minPWMValuePct;
+      top[FPSTR(_maxPWMValuePct)] = maxPWMValuePct;
       top[FPSTR(_IRQperRotation)] = numberOfInterrupsInOneSingleRotation;
       DEBUG_PRINTLN(F("Autosave config saved."));
     }
@@ -322,7 +328,7 @@ class PWMFanUsermod : public Usermod {
      * 
      * The function should return true if configuration was successfully loaded or false if there was no configuration.
      */
-    bool readFromConfig(JsonObject& root) {
+    bool readFromConfig(JsonObject& root) override {
       int8_t newTachoPin = tachoPin;
       int8_t newPwmPin   = pwmPin;
 
@@ -341,6 +347,8 @@ class PWMFanUsermod : public Usermod {
       targetTemperature = top[FPSTR(_temperature)] | targetTemperature;
       minPWMValuePct    = top[FPSTR(_minPWMValuePct)] | minPWMValuePct;
       minPWMValuePct    = (uint8_t) min(100,max(0,(int)minPWMValuePct)); // bounds checking
+      maxPWMValuePct    = top[FPSTR(_maxPWMValuePct)] | maxPWMValuePct;
+      maxPWMValuePct    = (uint8_t) min(100,max((int)minPWMValuePct,(int)maxPWMValuePct)); // bounds checking
       numberOfInterrupsInOneSingleRotation = top[FPSTR(_IRQperRotation)] | numberOfInterrupsInOneSingleRotation;
       numberOfInterrupsInOneSingleRotation = (uint8_t) max(1,(int)numberOfInterrupsInOneSingleRotation); // bounds checking
 
@@ -372,7 +380,7 @@ class PWMFanUsermod : public Usermod {
      * getId() allows you to optionally give your V2 usermod an unique ID (please define it in const.h!).
      * This could be used in the future for the system to determine whether your usermod is installed.
      */
-    uint16_t getId() {
+    uint16_t getId() override {
         return USERMOD_ID_PWM_FAN;
     }
 };
@@ -385,6 +393,7 @@ const char PWMFanUsermod::_pwmPin[]         PROGMEM = "PWM-pin";
 const char PWMFanUsermod::_temperature[]    PROGMEM = "target-temp-C";
 const char PWMFanUsermod::_tachoUpdateSec[] PROGMEM = "tacho-update-s";
 const char PWMFanUsermod::_minPWMValuePct[] PROGMEM = "min-PWM-percent";
+const char PWMFanUsermod::_maxPWMValuePct[] PROGMEM = "max-PWM-percent";
 const char PWMFanUsermod::_IRQperRotation[] PROGMEM = "IRQs-per-rotation";
 const char PWMFanUsermod::_speed[]          PROGMEM = "speed";
 const char PWMFanUsermod::_lock[]           PROGMEM = "lock";

usermods/RTC/usermod_rtc.h

@@ -12,8 +12,7 @@ class RTCUsermod : public Usermod {
   public:
 
     void setup() {
-      PinManagerPinType pins[2] = { { i2c_scl, true }, { i2c_sda, true } };
-      if (!pinManager.allocateMultiplePins(pins, 2, PinOwner::HW_I2C)) { disabled = true; return; }
+      if (i2c_scl<0 || i2c_sda<0) { disabled = true; return; }
       RTC.begin();
       time_t rtcTime = RTC.get();
       if (rtcTime) {
@@ -25,8 +24,8 @@ class RTCUsermod : public Usermod {
     }
 
     void loop() {
-      if (strip.isUpdating()) return;
-      if (!disabled && toki.isTick()) {
+      if (disabled || strip.isUpdating()) return;
+      if (toki.isTick()) {
         time_t t = toki.second();
         if (t != RTC.get()) RTC.set(t); //set RTC to NTP/UI-provided value
       }

usermods/RelayBlinds/usermod.cpp

@@ -43,12 +43,12 @@ void handleRelay()
       digitalWrite(PIN_UP_RELAY, LOW);
       upActiveBefore = true;
       upStartTime = millis();
-      DEBUG_PRINTLN("UPA");
+      DEBUG_PRINTLN(F("UPA"));
     }
     if (millis()- upStartTime > PIN_ON_TIME)
     {
       upActive = false;
-      DEBUG_PRINTLN("UPN");
+      DEBUG_PRINTLN(F("UPN"));
     }
   } else if (upActiveBefore)
   {

usermods/SN_Photoresistor/usermod_sn_photoresistor.h

@@ -30,7 +30,7 @@
 #define USERMOD_SN_PHOTORESISTOR_RESISTOR_VALUE 10000.0f
 #endif
 
-// only report if differance grater than offset value
+// only report if difference grater than offset value
 #ifndef USERMOD_SN_PHOTORESISTOR_OFFSET_VALUE
 #define USERMOD_SN_PHOTORESISTOR_OFFSET_VALUE 5
 #endif
@@ -109,6 +109,7 @@ public:
     {
       lastLDRValue = currentLDRValue;
 
+#ifndef WLED_DISABLE_MQTT
       if (WLED_MQTT_CONNECTED)
       {
         char subuf[45];
@@ -118,9 +119,10 @@ public:
       }
       else
       {
-        DEBUG_PRINTLN("Missing MQTT connection. Not publishing data");
+        DEBUG_PRINTLN(F("Missing MQTT connection. Not publishing data"));
       }
     }
+#endif
   }
 
   uint16_t getLastLDRValue()

usermods/ST7789_display/ST7789_display.h

@@ -17,12 +17,6 @@
     #ifndef TFT_HEIGHT
         #error Please define TFT_HEIGHT
     #endif
-    #ifndef TFT_MOSI
-        #error Please define TFT_MOSI
-    #endif
-    #ifndef TFT_SCLK
-        #error Please define TFT_SCLK
-    #endif
     #ifndef TFT_DC
         #error Please define TFT_DC
     #endif
@@ -138,10 +132,16 @@ class St7789DisplayUsermod : public Usermod {
      * setup() is called once at boot. WiFi is not yet connected at this point.
      * You can use it to initialize variables, sensors or similar.
      */
-    void setup()
+    void setup() override
     {
-        PinManagerPinType pins[] = { { TFT_MOSI, true }, { TFT_MISO, false}, { TFT_SCLK, true }, { TFT_CS, true}, { TFT_DC, true}, { TFT_RST, true }, { TFT_BL, true } };
-        if (!pinManager.allocateMultiplePins(pins, 7, PinOwner::UM_FourLineDisplay)) { enabled = false; return; }
+        PinManagerPinType spiPins[] = { { spi_mosi, true }, { spi_miso, false}, { spi_sclk, true } };
+        if (!pinManager.allocateMultiplePins(spiPins, 3, PinOwner::HW_SPI)) { enabled = false; return; }
+        PinManagerPinType displayPins[] = { { TFT_CS, true}, { TFT_DC, true}, { TFT_RST, true }, { TFT_BL, true } };
+        if (!pinManager.allocateMultiplePins(displayPins, sizeof(displayPins)/sizeof(PinManagerPinType), PinOwner::UM_FourLineDisplay)) {
+            pinManager.deallocateMultiplePins(spiPins, 3, PinOwner::HW_SPI);
+            enabled = false;
+            return;
+        }
 
         tft.init();
         tft.setRotation(0);  //Rotation here is set up for the text to be readable with the port on the left. Use 1 to flip.
@@ -162,7 +162,7 @@ class St7789DisplayUsermod : public Usermod {
      * connected() is called every time the WiFi is (re)connected
      * Use it to initialize network interfaces
      */
-    void connected() {
+    void connected() override {
       //Serial.println("Connected to WiFi!");
     }
 
@@ -176,7 +176,7 @@ class St7789DisplayUsermod : public Usermod {
      * 2. Try to avoid using the delay() function. NEVER use delays longer than 10 milliseconds.
      *    Instead, use a timer check as shown here.
      */
-    void loop() {
+    void loop() override {
         char buff[LINE_BUFFER_SIZE];
 
         // Check if we time interval for redrawing passes.
@@ -307,7 +307,7 @@ class St7789DisplayUsermod : public Usermod {
         // Print estimated milliamp usage (must specify the LED type in LED prefs for this to be a reasonable estimate).
         tft.print("Current: ");
         tft.setTextColor(TFT_ORANGE);
-        tft.print(strip.currentMilliamps);
+        tft.print(BusManager::currentMilliamps());
         tft.print("mA");
     }
 
@@ -316,7 +316,7 @@ class St7789DisplayUsermod : public Usermod {
      * Creating an "u" object allows you to add custom key/value pairs to the Info section of the WLED web UI.
      * Below it is shown how this could be used for e.g. a light sensor
      */
-    void addToJsonInfo(JsonObject& root)
+    void addToJsonInfo(JsonObject& root) override
     {
       JsonObject user = root["u"];
       if (user.isNull()) user = root.createNestedObject("u");
@@ -330,7 +330,7 @@ class St7789DisplayUsermod : public Usermod {
      * addToJsonState() can be used to add custom entries to the /json/state part of the JSON API (state object).
      * Values in the state object may be modified by connected clients
      */
-    void addToJsonState(JsonObject& root)
+    void addToJsonState(JsonObject& root) override
     {
       //root["user0"] = userVar0;
     }
@@ -340,7 +340,7 @@ class St7789DisplayUsermod : public Usermod {
      * readFromJsonState() can be used to receive data clients send to the /json/state part of the JSON API (state object).
      * Values in the state object may be modified by connected clients
      */
-    void readFromJsonState(JsonObject& root)
+    void readFromJsonState(JsonObject& root) override
     {
       //userVar0 = root["user0"] | userVar0; //if "user0" key exists in JSON, update, else keep old value
       //if (root["bri"] == 255) Serial.println(F("Don't burn down your garage!"));
@@ -361,13 +361,10 @@ class St7789DisplayUsermod : public Usermod {
      *
      * I highly recommend checking out the basics of ArduinoJson serialization and deserialization in order to use custom settings!
      */
-    void addToConfig(JsonObject& root)
+    void addToConfig(JsonObject& root) override
     {
       JsonObject top = root.createNestedObject("ST7789");
       JsonArray pins = top.createNestedArray("pin");
-      pins.add(TFT_MOSI);
-      pins.add(TFT_MISO);
-      pins.add(TFT_SCLK);
       pins.add(TFT_CS);
       pins.add(TFT_DC);
       pins.add(TFT_RST);
@@ -376,6 +373,13 @@ class St7789DisplayUsermod : public Usermod {
     }
 
 
+    void appendConfigData() override {
+      oappend(SET_F("addInfo('ST7789:pin[]',0,'','SPI CS');"));
+      oappend(SET_F("addInfo('ST7789:pin[]',1,'','SPI DC');"));
+      oappend(SET_F("addInfo('ST7789:pin[]',2,'','SPI RST');"));
+      oappend(SET_F("addInfo('ST7789:pin[]',2,'','SPI BL');"));
+    }
+
     /*
      * readFromConfig() can be used to read back the custom settings you added with addToConfig().
      * This is called by WLED when settings are loaded (currently this only happens once immediately after boot)
@@ -384,7 +388,7 @@ class St7789DisplayUsermod : public Usermod {
      * but also that if you want to write persistent values to a dynamic buffer, you'd need to allocate it here instead of in setup.
      * If you don't know what that is, don't fret. It most likely doesn't affect your use case :)
      */
-    bool readFromConfig(JsonObject& root)
+    bool readFromConfig(JsonObject& root) override
     {
       //JsonObject top = root["top"];
       //userVar0 = top["great"] | 42; //The value right of the pipe "|" is the default value in case your setting was not present in cfg.json (e.g. first boot)
@@ -396,7 +400,7 @@ class St7789DisplayUsermod : public Usermod {
      * getId() allows you to optionally give your V2 usermod an unique ID (please define it in const.h!).
      * This could be used in the future for the system to determine whether your usermod is installed.
      */
-    uint16_t getId()
+    uint16_t getId() override
     {
       return USERMOD_ID_ST7789_DISPLAY;
     }

usermods/Si7021_MQTT_HA/usermod_si7021_mqtt_ha.h

@@ -1,3 +1,7 @@
+#ifndef WLED_ENABLE_MQTT
+#error "This user mod requires MQTT to be enabled."
+#endif
+
 #pragma once
 
 // this is remixed from usermod_v2_SensorsToMqtt.h (sensors_to_mqtt usermod)
@@ -9,14 +13,6 @@
 
 Adafruit_Si7021 si7021;
 
-#ifdef ARDUINO_ARCH_ESP32 //ESP32 boards
-uint8_t SCL_PIN = 22;
-uint8_t SDA_PIN = 21;
-#else //ESP8266 boards
-uint8_t SCL_PIN = 5;
-uint8_t SDA_PIN = 4;
-#endif
-
 class Si7021_MQTT_HA : public Usermod
 {
   private:
@@ -97,8 +93,8 @@ class Si7021_MQTT_HA : public Usermod
 
         JsonObject device = doc.createNestedObject("device"); // attach the sensor to the same device
         device["name"] = String(serverDescription);
-        device["model"] = "WLED";
-        device["manufacturer"] = "Aircoookie";
+        device["model"] = F(WLED_PRODUCT_NAME);
+        device["manufacturer"] = F(WLED_BRAND);
         device["identifiers"] = String("wled-") + String(serverDescription);
         device["sw_version"] = VERSION;
 
@@ -180,7 +176,6 @@ class Si7021_MQTT_HA : public Usermod
     {
       if (enabled) {
         Serial.println("Si7021_MQTT_HA: Starting!");
-        Wire.begin(SDA_PIN, SCL_PIN);
         Serial.println("Si7021_MQTT_HA: Initializing sensors.. ");
         _initializeSensor();
       }

usermods/TTGO-T-Display/usermod.cpp

@@ -3,7 +3,7 @@
  * This file allows you to add own functionality to WLED more easily
  * See: https://github.com/Aircoookie/WLED/wiki/Add-own-functionality
  * EEPROM bytes 2750+ are reserved for your custom use case. (if you extend #define EEPSIZE in const.h)
- * bytes 2400+ are currently ununsed, but might be used for future wled features
+ * bytes 2400+ are currently unused, but might be used for future wled features
  */
 
 /*
@@ -144,7 +144,7 @@ void userLoop() {
   // First row with Wifi name
   tft.setCursor(1, 1);
   tft.print(knownSsid.substring(0, tftcharwidth > 1 ? tftcharwidth - 1 : 0));
-  // Print `~` char to indicate that SSID is longer, than our dicplay
+  // Print `~` char to indicate that SSID is longer than our display
   if (knownSsid.length() > tftcharwidth)
     tft.print("~");
 

usermods/Temperature/platformio_override.ini

@@ -1,13 +1,12 @@
 ; Options
 ; -------
 ; USERMOD_DALLASTEMPERATURE                      - define this to have this user mod included wled00\usermods_list.cpp
-; USERMOD_DALLASTEMPERATURE_CELSIUS              - define this to report temperatures in degrees celsius, otherwise fahrenheit will be reported
 ; USERMOD_DALLASTEMPERATURE_MEASUREMENT_INTERVAL - the number of milliseconds between measurements, defaults to 60 seconds
-; USERMOD_DALLASTEMPERATURE_FIRST_MEASUREMENT_AT - the number of milliseconds after boot to take first measurement, defaults to 20 seconds
 ;
 [env:d1_mini_usermod_dallas_temperature_C]
 extends = env:d1_mini
-build_flags = ${common.build_flags_esp8266} -D USERMOD_DALLASTEMPERATURE -D USERMOD_DALLASTEMPERATURE_CELSIUS
+build_flags = ${common.build_flags_esp8266} -D USERMOD_DALLASTEMPERATURE
 lib_deps = ${env.lib_deps}
-    milesburton/DallasTemperature@^3.9.0
-    OneWire@~2.3.5
+  paulstoffregen/OneWire@~2.3.7
+# you may want to use following with ESP32
+;  https://github.com/blazoncek/OneWire.git # fixes Sensor error on ESP32

usermods/Temperature/readme.md

@@ -7,6 +7,8 @@ May be expanded with support for different sensor types in the future.
 
 If temperature sensor is not detected during boot, this usermod will be disabled.
 
+Maintained by @blazoncek
+
 ## Installation
 
 Copy the example `platformio_override.ini` to the root directory.  This file should be placed in the same directory as `platformio.ini`.
@@ -14,9 +16,9 @@ Copy the example `platformio_override.ini` to the root directory.  This file sho
 ### Define Your Options
 
 * `USERMOD_DALLASTEMPERATURE`                      - enables this user mod wled00/usermods_list.cpp
-* `USERMOD_DALLASTEMPERATURE_FIRST_MEASUREMENT_AT` - umber of milliseconds after boot to take first measurement, defaults to 20000 ms
+* `USERMOD_DALLASTEMPERATURE_MEASUREMENT_INTERVAL` - number of milliseconds between measurements, defaults to 60000 ms (60s)
 
-All parameters can be configured at runtime via the Usermods settings page, including pin, temperature in degrees Celsius or Farenheit and measurement interval.
+All parameters can be configured at runtime via the Usermods settings page, including pin, temperature in degrees Celsius or Fahrenheit and measurement interval.
 
 ## Project link
 
@@ -27,7 +29,6 @@ All parameters can be configured at runtime via the Usermods settings page, incl
 
 If you are using `platformio_override.ini`, you should be able to refresh the task list and see your custom task, for example `env:d1_mini_usermod_dallas_temperature_C`.
 
-
 If you are not using `platformio_override.ini`, you might have to uncomment `OneWire@~2.3.5 under` `[common]` section in `platformio.ini`:
 
 ```ini
@@ -43,8 +44,9 @@ default_envs = d1_mini
 lib_deps =
   ...
   #For Dallas sensor uncomment following line
-  OneWire@~2.3.5
-...
+  OneWire@~2.3.7
+  # ... or you may want to use following with ESP32
+;  https://github.com/blazoncek/OneWire.git # fixes Sensor error on ESP32...
 ```
 
 ## Change Log
@@ -56,3 +58,6 @@ lib_deps =
 * Report the number of seconds until the first read in the info screen instead of sensor error
 2021-04
 * Adaptation for runtime configuration.
+2023-05
+* Rewrite to conform to newer recommendations.
+* Recommended @blazoncek fork of OneWire for ESP32 to avoid Sensor error

usermods/Temperature/usermod_temperature.h

@@ -29,6 +29,7 @@ class UsermodTemperature : public Usermod {
     bool degC = true;
     // using parasite power on the sensor
     bool parasite = false;
+    int8_t parasitePin = -1;
     // how often do we read from sensor?
     unsigned long readingInterval = USERMOD_DALLASTEMPERATURE_MEASUREMENT_INTERVAL;
     // set last reading as "40 sec before boot", so first reading is taken after 20 sec
@@ -47,329 +48,405 @@ class UsermodTemperature : public Usermod {
     bool enabled = true;
 
     bool HApublished = false;
+    int16_t idx = -1;   // Domoticz virtual sensor idx
 
     // strings to reduce flash memory usage (used more than twice)
     static const char _name[];
     static const char _enabled[];
     static const char _readInterval[];
     static const char _parasite[];
-
+    static const char _parasitePin[];
+    static const char _domoticzIDX[];
+    static const char _sensor[];
+    static const char _temperature[];
+    static const char _Temperature[];
+    
     //Dallas sensor quick (& dirty) reading. Credit to - Author: Peter Scargill, August 17th, 2013
-    float readDallas() {
-      byte data[9];
-      int16_t result;                         // raw data from sensor
-      float retVal = -127.0f;
-      if (oneWire->reset()) {                 // if reset() fails there are no OneWire devices
-        oneWire->skip();                      // skip ROM
-        oneWire->write(0xBE);                 // read (temperature) from EEPROM
-        oneWire->read_bytes(data, 9);         // first 2 bytes contain temperature
-        #ifdef WLED_DEBUG
-        if (OneWire::crc8(data,8) != data[8]) {
-          DEBUG_PRINTLN(F("CRC error reading temperature."));
-          for (byte i=0; i < 9; i++) DEBUG_PRINTF("0x%02X ", data[i]);
-          DEBUG_PRINT(F(" => "));
-          DEBUG_PRINTF("0x%02X\n", OneWire::crc8(data,8));
-        }
-        #endif
-        switch(sensorFound) {
-          case 0x10:  // DS18S20 has 9-bit precision
-            result = (data[1] << 8) | data[0];
-            retVal = float(result) * 0.5f;
-            break;
-          case 0x22:  // DS18B20
-          case 0x28:  // DS1822
-          case 0x3B:  // DS1825
-          case 0x42:  // DS28EA00
-            result = (data[1]<<4) | (data[0]>>4);   // we only need whole part, we will add fraction when returning
-            if (data[1] & 0x80) result |= 0xF000;   // fix negative value
-            retVal = float(result) + ((data[0] & 0x08) ? 0.5f : 0.0f);
-            break;
-        }
-      }
-      for (byte i=1; i<9; i++) data[0] &= data[i];
-      return data[0]==0xFF ? -127.0f : retVal;
-    }
-
-    void requestTemperatures() {
-      DEBUG_PRINTLN(F("Requesting temperature."));
-      oneWire->reset();
-      oneWire->skip();                        // skip ROM
-      oneWire->write(0x44,parasite);          // request new temperature reading (TODO: parasite would need special handling)
-      lastTemperaturesRequest = millis();
-      waitingForConversion = true;
-    }
-
-    void readTemperature() {
-      temperature = readDallas();
-      lastMeasurement = millis();
-      waitingForConversion = false;
-      //DEBUG_PRINTF("Read temperature %2.1f.\n", temperature); // does not work properly on 8266
-      DEBUG_PRINT(F("Read temperature "));
-      DEBUG_PRINTLN(temperature);
-    }
-
-    bool findSensor() {
-      DEBUG_PRINTLN(F("Searching for sensor..."));
-      uint8_t deviceAddress[8] = {0,0,0,0,0,0,0,0};
-      // find out if we have DS18xxx sensor attached
-      oneWire->reset_search();
-      delay(10);
-      while (oneWire->search(deviceAddress)) {
-        DEBUG_PRINTLN(F("Found something..."));
-        if (oneWire->crc8(deviceAddress, 7) == deviceAddress[7]) {
-          switch (deviceAddress[0]) {
-            case 0x10:  // DS18S20
-            case 0x22:  // DS18B20
-            case 0x28:  // DS1822
-            case 0x3B:  // DS1825
-            case 0x42:  // DS28EA00
-              DEBUG_PRINTLN(F("Sensor found."));
-              sensorFound = deviceAddress[0];
-              DEBUG_PRINTF("0x%02X\n", sensorFound);
-              return true;
-          }
-        }
-      }
-      DEBUG_PRINTLN(F("Sensor NOT found."));
-      return false;
-    }
-
-    void publishHomeAssistantAutodiscovery() {
-      if (!WLED_MQTT_CONNECTED) return;
-
-      char json_str[1024], buf[128];
-      size_t payload_size;
-      StaticJsonDocument<1024> json;
-
-      sprintf_P(buf, PSTR("%s Temperature"), serverDescription);
-      json[F("name")] = buf;
-      strcpy(buf, mqttDeviceTopic);
-      strcat_P(buf, PSTR("/temperature"));
-      json[F("state_topic")] = buf;
-      json[F("device_class")] = F("temperature");
-      json[F("unique_id")] = escapedMac.c_str();
-      json[F("unit_of_measurement")] = F("°C");
-      payload_size = serializeJson(json, json_str);
-
-      sprintf_P(buf, PSTR("homeassistant/sensor/%s/config"), escapedMac.c_str());
-      mqtt->publish(buf, 0, true, json_str, payload_size);
-      HApublished = true;
-    }
+    float readDallas();
+    void requestTemperatures();
+    void readTemperature();
+    bool findSensor();
+#ifndef WLED_DISABLE_MQTT
+    void publishHomeAssistantAutodiscovery();
+#endif
 
   public:
 
-    void setup() {
-      int retries = 10;
-      sensorFound = 0;
-      temperature = -127.0f; // default to -127, DS18B20 only goes down to -50C
-      if (enabled) {
-        // config says we are enabled
-        DEBUG_PRINTLN(F("Allocating temperature pin..."));
-        // pin retrieved from cfg.json (readFromConfig()) prior to running setup()
-        if (temperaturePin >= 0 && pinManager.allocatePin(temperaturePin, true, PinOwner::UM_Temperature)) {
-          oneWire = new OneWire(temperaturePin);
-          if (oneWire->reset()) {
-            while (!findSensor() && retries--) {
-              delay(25); // try to find sensor
-            }
-          }
-        } else {
-          if (temperaturePin >= 0) {
-            DEBUG_PRINTLN(F("Temperature pin allocation failed."));
-          }
-          temperaturePin = -1;  // allocation failed
-        }
-      }
-      lastMeasurement = millis() - readingInterval + 10000;
-      initDone = true;
-    }
-
-    void loop() {
-      if (!enabled || !sensorFound || strip.isUpdating()) return;
-
-      static uint8_t errorCount = 0;
-      unsigned long now = millis();
-
-      // check to see if we are due for taking a measurement
-      // lastMeasurement will not be updated until the conversion
-      // is complete the the reading is finished
-      if (now - lastMeasurement < readingInterval) return;
-
-      // we are due for a measurement, if we are not already waiting
-      // for a conversion to complete, then make a new request for temps
-      if (!waitingForConversion) {
-        requestTemperatures();
-        return;
-      }
-
-      // we were waiting for a conversion to complete, have we waited log enough?
-      if (now - lastTemperaturesRequest >= 750 /* 93.75ms per the datasheet but can be up to 750ms */) {
-        readTemperature();
-        if (getTemperatureC() < -100.0f) {
-          if (++errorCount > 10) sensorFound = 0;
-          lastMeasurement = now - readingInterval + 300; // force new measurement in 300ms
-          return;
-        }
-        errorCount = 0;
-
-        if (WLED_MQTT_CONNECTED) {
-          char subuf[64];
-          strcpy(subuf, mqttDeviceTopic);
-          if (temperature > -100.0f) {
-            // dont publish super low temperature as the graph will get messed up
-            // the DallasTemperature library returns -127C or -196.6F when problem
-            // reading the sensor
-            strcat_P(subuf, PSTR("/temperature"));
-            mqtt->publish(subuf, 0, false, String(getTemperatureC()).c_str());
-            strcat_P(subuf, PSTR("_f"));
-            mqtt->publish(subuf, 0, false, String(getTemperatureF()).c_str());
-          } else {
-            // publish something else to indicate status?
-          }
-        }
-      }
-    }
-
-    /**
-     * connected() is called every time the WiFi is (re)connected
-     * Use it to initialize network interfaces
-     */
-    //void connected() {}
-
-    /**
-     * subscribe to MQTT topic if needed
-     */
-    void onMqttConnect(bool sessionPresent) {
-      //(re)subscribe to required topics
-      //char subuf[64];
-      if (mqttDeviceTopic[0] != 0) {
-        publishHomeAssistantAutodiscovery();
-      }
-    }
-
     /*
      * API calls te enable data exchange between WLED modules
      */
-    inline float getTemperatureC() {
-      return (float)temperature;
+    inline float getTemperatureC() { return temperature; }
+    inline float getTemperatureF() { return temperature * 1.8f + 32.0f; }
+    float getTemperature();
+    const char *getTemperatureUnit();
+    uint16_t getId() override { return USERMOD_ID_TEMPERATURE; }
+
+    void setup() override;
+    void loop() override;
+    //void connected() override;
+#ifndef WLED_DISABLE_MQTT
+    void onMqttConnect(bool sessionPresent) override;
+#endif
+    //void onUpdateBegin(bool init) override;
+
+    //bool handleButton(uint8_t b) override;
+    //void handleOverlayDraw() override;
+
+    void addToJsonInfo(JsonObject& root) override;
+    //void addToJsonState(JsonObject &root) override;
+    //void readFromJsonState(JsonObject &root) override;
+    void addToConfig(JsonObject &root) override;
+    bool readFromConfig(JsonObject &root) override;
+
+    void appendConfigData() override;
+};
+
+//Dallas sensor quick (& dirty) reading. Credit to - Author: Peter Scargill, August 17th, 2013
+float UsermodTemperature::readDallas() {
+  byte data[9];
+  int16_t result;                         // raw data from sensor
+  float retVal = -127.0f;
+  if (oneWire->reset()) {                 // if reset() fails there are no OneWire devices
+    oneWire->skip();                      // skip ROM
+    oneWire->write(0xBE);                 // read (temperature) from EEPROM
+    oneWire->read_bytes(data, 9);         // first 2 bytes contain temperature
+    #ifdef WLED_DEBUG
+    if (OneWire::crc8(data,8) != data[8]) {
+      DEBUG_PRINTLN(F("CRC error reading temperature."));
+      for (byte i=0; i < 9; i++) DEBUG_PRINTF_P(PSTR("0x%02X "), data[i]);
+      DEBUG_PRINT(F(" => "));
+      DEBUG_PRINTF_P(PSTR("0x%02X\n"), OneWire::crc8(data,8));
     }
-    inline float getTemperatureF() {
-      return (float)temperature * 1.8f + 32;
+    #endif
+    switch(sensorFound) {
+      case 0x10:  // DS18S20 has 9-bit precision
+        result = (data[1] << 8) | data[0];
+        retVal = float(result) * 0.5f;
+        break;
+      case 0x22:  // DS18B20
+      case 0x28:  // DS1822
+      case 0x3B:  // DS1825
+      case 0x42:  // DS28EA00
+        result = (data[1]<<4) | (data[0]>>4);   // we only need whole part, we will add fraction when returning
+        if (data[1] & 0x80) result |= 0xF000;   // fix negative value
+        retVal = float(result) + ((data[0] & 0x08) ? 0.5f : 0.0f);
+        break;
     }
+  }
+  for (byte i=1; i<9; i++) data[0] &= data[i];
+  return data[0]==0xFF ? -127.0f : retVal;
+}
 
-    /*
-     * addToJsonInfo() can be used to add custom entries to the /json/info part of the JSON API.
-     * Creating an "u" object allows you to add custom key/value pairs to the Info section of the WLED web UI.
-     * Below it is shown how this could be used for e.g. a light sensor
-     */
-    void addToJsonInfo(JsonObject& root) {
-      // dont add temperature to info if we are disabled
-      if (!enabled) return;
+void UsermodTemperature::requestTemperatures() {
+  DEBUG_PRINTLN(F("Requesting temperature."));
+  oneWire->reset();
+  oneWire->skip();                        // skip ROM
+  oneWire->write(0x44,parasite);          // request new temperature reading
+  if (parasite && parasitePin >=0 ) digitalWrite(parasitePin, HIGH); // has to happen within 10us (open MOSFET)
+  lastTemperaturesRequest = millis();
+  waitingForConversion = true;
+}
 
-      JsonObject user = root["u"];
-      if (user.isNull()) user = root.createNestedObject("u");
+void UsermodTemperature::readTemperature() {
+  if (parasite && parasitePin >=0 ) digitalWrite(parasitePin, LOW); // deactivate power (close MOSFET)
+  temperature = readDallas();
+  lastMeasurement = millis();
+  waitingForConversion = false;
+  //DEBUG_PRINTF_P(PSTR("Read temperature %2.1f.\n"), temperature); // does not work properly on 8266
+  DEBUG_PRINT(F("Read temperature "));
+  DEBUG_PRINTLN(temperature);
+}
 
-      JsonArray temp = user.createNestedArray(FPSTR(_name));
-
-      if (temperature <= -100.0f) {
-        temp.add(0);
-        temp.add(F(" Sensor Error!"));
-        return;
+bool UsermodTemperature::findSensor() {
+  DEBUG_PRINTLN(F("Searching for sensor..."));
+  uint8_t deviceAddress[8] = {0,0,0,0,0,0,0,0};
+  // find out if we have DS18xxx sensor attached
+  oneWire->reset_search();
+  delay(10);
+  while (oneWire->search(deviceAddress)) {
+    DEBUG_PRINTLN(F("Found something..."));
+    if (oneWire->crc8(deviceAddress, 7) == deviceAddress[7]) {
+      switch (deviceAddress[0]) {
+        case 0x10:  // DS18S20
+        case 0x22:  // DS18B20
+        case 0x28:  // DS1822
+        case 0x3B:  // DS1825
+        case 0x42:  // DS28EA00
+          DEBUG_PRINTLN(F("Sensor found."));
+          sensorFound = deviceAddress[0];
+          DEBUG_PRINTF_P(PSTR("0x%02X\n"), sensorFound);
+          return true;
       }
-
-      temp.add(degC ? getTemperatureC() : getTemperatureF());
-      temp.add(degC ? F("°C") : F("°F"));
-
-      JsonObject sensor = root[F("sensor")];
-      if (sensor.isNull()) sensor = root.createNestedObject(F("sensor"));
-      temp = sensor.createNestedArray(F("temp"));
-      temp.add(degC ? temperature : (float)temperature * 1.8f + 32);
-      temp.add(degC ? F("°C") : F("°F"));
     }
+  }
+  DEBUG_PRINTLN(F("Sensor NOT found."));
+  return false;
+}
 
-    /**
-     * addToJsonState() can be used to add custom entries to the /json/state part of the JSON API (state object).
-     * Values in the state object may be modified by connected clients
-     */
-    //void addToJsonState(JsonObject &root)
-    //{
-    //}
+#ifndef WLED_DISABLE_MQTT
+void UsermodTemperature::publishHomeAssistantAutodiscovery() {
+  if (!WLED_MQTT_CONNECTED) return;
 
-    /**
-     * readFromJsonState() can be used to receive data clients send to the /json/state part of the JSON API (state object).
-     * Values in the state object may be modified by connected clients
-     * Read "<usermodname>_<usermodparam>" from json state and and change settings (i.e. GPIO pin) used.
-     */
-    //void readFromJsonState(JsonObject &root) {
-    //  if (!initDone) return;  // prevent crash on boot applyPreset()
-    //}
+  char json_str[1024], buf[128];
+  size_t payload_size;
+  StaticJsonDocument<1024> json;
 
-    /**
-     * addToConfig() (called from set.cpp) stores persistent properties to cfg.json
-     */
-    void addToConfig(JsonObject &root) {
-      // we add JSON object: {"Temperature": {"pin": 0, "degC": true}}
-      JsonObject top = root.createNestedObject(FPSTR(_name)); // usermodname
-      top[FPSTR(_enabled)] = enabled;
-      top["pin"]  = temperaturePin;     // usermodparam
-      top["degC"] = degC;  // usermodparam
-      top[FPSTR(_readInterval)] = readingInterval / 1000;
-      top[FPSTR(_parasite)] = parasite;
-      DEBUG_PRINTLN(F("Temperature config saved."));
-    }
+  sprintf_P(buf, PSTR("%s Temperature"), serverDescription);
+  json[F("name")] = buf;
+  strcpy(buf, mqttDeviceTopic);
+  strcat_P(buf, _Temperature);
+  json[F("state_topic")] = buf;
+  json[F("device_class")] = FPSTR(_temperature);
+  json[F("unique_id")] = escapedMac.c_str();
+  json[F("unit_of_measurement")] = F("°C");
+  payload_size = serializeJson(json, json_str);
 
-    /**
-     * readFromConfig() is called before setup() to populate properties from values stored in cfg.json
-     *
-     * The function should return true if configuration was successfully loaded or false if there was no configuration.
-     */
-    bool readFromConfig(JsonObject &root) {
-      // we look for JSON object: {"Temperature": {"pin": 0, "degC": true}}
-      int8_t newTemperaturePin = temperaturePin;
-      DEBUG_PRINT(FPSTR(_name));
+  sprintf_P(buf, PSTR("homeassistant/sensor/%s/config"), escapedMac.c_str());
+  mqtt->publish(buf, 0, true, json_str, payload_size);
+  HApublished = true;
+}
+#endif
 
-      JsonObject top = root[FPSTR(_name)];
-      if (top.isNull()) {
-        DEBUG_PRINTLN(F(": No config found. (Using defaults.)"));
-        return false;
-      }
-
-      enabled           = top[FPSTR(_enabled)] | enabled;
-      newTemperaturePin = top["pin"] | newTemperaturePin;
-      degC              = top["degC"] | degC;
-      readingInterval   = top[FPSTR(_readInterval)] | readingInterval/1000;
-      readingInterval   = min(120,max(10,(int)readingInterval)) * 1000;  // convert to ms
-      parasite          = top[FPSTR(_parasite)] | parasite;
-
-      if (!initDone) {
-        // first run: reading from cfg.json
-        temperaturePin = newTemperaturePin;
-        DEBUG_PRINTLN(F(" config loaded."));
-      } else {
-        DEBUG_PRINTLN(F(" config (re)loaded."));
-        // changing paramters from settings page
-        if (newTemperaturePin != temperaturePin) {
-          DEBUG_PRINTLN(F("Re-init temperature."));
-          // deallocate pin and release memory
-          delete oneWire;
-          pinManager.deallocatePin(temperaturePin, PinOwner::UM_Temperature);
-          temperaturePin = newTemperaturePin;
-          // initialise
-          setup();
+void UsermodTemperature::setup() {
+  int retries = 10;
+  sensorFound = 0;
+  temperature = -127.0f; // default to -127, DS18B20 only goes down to -50C
+  if (enabled) {
+    // config says we are enabled
+    DEBUG_PRINTLN(F("Allocating temperature pin..."));
+    // pin retrieved from cfg.json (readFromConfig()) prior to running setup()
+    if (temperaturePin >= 0 && pinManager.allocatePin(temperaturePin, true, PinOwner::UM_Temperature)) {
+      oneWire = new OneWire(temperaturePin);
+      if (oneWire->reset()) {
+        while (!findSensor() && retries--) {
+          delay(25); // try to find sensor
         }
       }
-      // use "return !top["newestParameter"].isNull();" when updating Usermod with new features
-      return !top[FPSTR(_parasite)].isNull();
+      if (parasite && pinManager.allocatePin(parasitePin, true, PinOwner::UM_Temperature)) {
+        pinMode(parasitePin, OUTPUT);
+        digitalWrite(parasitePin, LOW); // deactivate power (close MOSFET)
+      } else {
+        parasitePin = -1;
+      }
+    } else {
+      if (temperaturePin >= 0) {
+        DEBUG_PRINTLN(F("Temperature pin allocation failed."));
+      }
+      temperaturePin = -1;  // allocation failed
     }
+  }
+  lastMeasurement = millis() - readingInterval + 10000;
+  initDone = true;
+}
 
-    uint16_t getId()
-    {
-      return USERMOD_ID_TEMPERATURE;
+void UsermodTemperature::loop() {
+  if (!enabled || !sensorFound || strip.isUpdating()) return;
+
+  static uint8_t errorCount = 0;
+  unsigned long now = millis();
+
+  // check to see if we are due for taking a measurement
+  // lastMeasurement will not be updated until the conversion
+  // is complete the the reading is finished
+  if (now - lastMeasurement < readingInterval) return;
+
+  // we are due for a measurement, if we are not already waiting
+  // for a conversion to complete, then make a new request for temps
+  if (!waitingForConversion) {
+    requestTemperatures();
+    return;
+  }
+
+  // we were waiting for a conversion to complete, have we waited log enough?
+  if (now - lastTemperaturesRequest >= 750 /* 93.75ms per the datasheet but can be up to 750ms */) {
+    readTemperature();
+    if (getTemperatureC() < -100.0f) {
+      if (++errorCount > 10) sensorFound = 0;
+      lastMeasurement = now - readingInterval + 300; // force new measurement in 300ms
+      return;
     }
-};
+    errorCount = 0;
+
+#ifndef WLED_DISABLE_MQTT
+    if (WLED_MQTT_CONNECTED) {
+      char subuf[128];
+      strcpy(subuf, mqttDeviceTopic);
+      if (temperature > -100.0f) {
+        // dont publish super low temperature as the graph will get messed up
+        // the DallasTemperature library returns -127C or -196.6F when problem
+        // reading the sensor
+        strcat_P(subuf, _Temperature);
+        mqtt->publish(subuf, 0, false, String(getTemperatureC()).c_str());
+        strcat_P(subuf, PSTR("_f"));
+        mqtt->publish(subuf, 0, false, String(getTemperatureF()).c_str());
+        if (idx > 0) {
+          StaticJsonDocument <128> msg;
+          msg[F("idx")]    = idx;
+          msg[F("RSSI")]   = WiFi.RSSI();
+          msg[F("nvalue")] = 0;
+          msg[F("svalue")] = String(getTemperatureC());
+          serializeJson(msg, subuf, 127);
+          mqtt->publish("domoticz/in", 0, false, subuf);
+        }
+      } else {
+        // publish something else to indicate status?
+      }
+    }
+#endif
+  }
+}
+
+/**
+ * connected() is called every time the WiFi is (re)connected
+ * Use it to initialize network interfaces
+ */
+//void UsermodTemperature::connected() {}
+
+#ifndef WLED_DISABLE_MQTT
+/**
+ * subscribe to MQTT topic if needed
+ */
+void UsermodTemperature::onMqttConnect(bool sessionPresent) {
+  //(re)subscribe to required topics
+  //char subuf[64];
+  if (mqttDeviceTopic[0] != 0) {
+    publishHomeAssistantAutodiscovery();
+  }
+}
+#endif
+
+/*
+  * addToJsonInfo() can be used to add custom entries to the /json/info part of the JSON API.
+  * Creating an "u" object allows you to add custom key/value pairs to the Info section of the WLED web UI.
+  * Below it is shown how this could be used for e.g. a light sensor
+  */
+void UsermodTemperature::addToJsonInfo(JsonObject& root) {
+  // dont add temperature to info if we are disabled
+  if (!enabled) return;
+
+  JsonObject user = root["u"];
+  if (user.isNull()) user = root.createNestedObject("u");
+
+  JsonArray temp = user.createNestedArray(FPSTR(_name));
+
+  if (temperature <= -100.0f) {
+    temp.add(0);
+    temp.add(F(" Sensor Error!"));
+    return;
+  }
+
+  temp.add(getTemperature());
+  temp.add(getTemperatureUnit());
+
+  JsonObject sensor = root[FPSTR(_sensor)];
+  if (sensor.isNull()) sensor = root.createNestedObject(FPSTR(_sensor));
+  temp = sensor.createNestedArray(FPSTR(_temperature));
+  temp.add(getTemperature());
+  temp.add(getTemperatureUnit());
+}
+
+/**
+ * addToJsonState() can be used to add custom entries to the /json/state part of the JSON API (state object).
+ * Values in the state object may be modified by connected clients
+ */
+//void UsermodTemperature::addToJsonState(JsonObject &root)
+//{
+//}
+
+/**
+ * readFromJsonState() can be used to receive data clients send to the /json/state part of the JSON API (state object).
+ * Values in the state object may be modified by connected clients
+ * Read "<usermodname>_<usermodparam>" from json state and and change settings (i.e. GPIO pin) used.
+ */
+//void UsermodTemperature::readFromJsonState(JsonObject &root) {
+//  if (!initDone) return;  // prevent crash on boot applyPreset()
+//}
+
+/**
+ * addToConfig() (called from set.cpp) stores persistent properties to cfg.json
+ */
+void UsermodTemperature::addToConfig(JsonObject &root) {
+  // we add JSON object: {"Temperature": {"pin": 0, "degC": true}}
+  JsonObject top = root.createNestedObject(FPSTR(_name)); // usermodname
+  top[FPSTR(_enabled)] = enabled;
+  top["pin"]  = temperaturePin;     // usermodparam
+  top[F("degC")] = degC;  // usermodparam
+  top[FPSTR(_readInterval)] = readingInterval / 1000;
+  top[FPSTR(_parasite)] = parasite;
+  top[FPSTR(_parasitePin)] = parasitePin;
+  top[FPSTR(_domoticzIDX)] = idx;
+  DEBUG_PRINTLN(F("Temperature config saved."));
+}
+
+/**
+ * readFromConfig() is called before setup() to populate properties from values stored in cfg.json
+ *
+ * The function should return true if configuration was successfully loaded or false if there was no configuration.
+ */
+bool UsermodTemperature::readFromConfig(JsonObject &root) {
+  // we look for JSON object: {"Temperature": {"pin": 0, "degC": true}}
+  int8_t newTemperaturePin = temperaturePin;
+  DEBUG_PRINT(FPSTR(_name));
+
+  JsonObject top = root[FPSTR(_name)];
+  if (top.isNull()) {
+    DEBUG_PRINTLN(F(": No config found. (Using defaults.)"));
+    return false;
+  }
+
+  enabled           = top[FPSTR(_enabled)] | enabled;
+  newTemperaturePin = top["pin"] | newTemperaturePin;
+  degC              = top[F("degC")] | degC;
+  readingInterval   = top[FPSTR(_readInterval)] | readingInterval/1000;
+  readingInterval   = min(120,max(10,(int)readingInterval)) * 1000;  // convert to ms
+  parasite          = top[FPSTR(_parasite)] | parasite;
+  parasitePin       = top[FPSTR(_parasitePin)] | parasitePin;
+  idx               = top[FPSTR(_domoticzIDX)] | idx;
+
+  if (!initDone) {
+    // first run: reading from cfg.json
+    temperaturePin = newTemperaturePin;
+    DEBUG_PRINTLN(F(" config loaded."));
+  } else {
+    DEBUG_PRINTLN(F(" config (re)loaded."));
+    // changing paramters from settings page
+    if (newTemperaturePin != temperaturePin) {
+      DEBUG_PRINTLN(F("Re-init temperature."));
+      // deallocate pin and release memory
+      delete oneWire;
+      pinManager.deallocatePin(temperaturePin, PinOwner::UM_Temperature);
+      temperaturePin = newTemperaturePin;
+      pinManager.deallocatePin(parasitePin, PinOwner::UM_Temperature);
+      // initialise
+      setup();
+    }
+  }
+  // use "return !top["newestParameter"].isNull();" when updating Usermod with new features
+  return !top[FPSTR(_domoticzIDX)].isNull();
+}
+
+void UsermodTemperature::appendConfigData() {
+  oappend(SET_F("addInfo('")); oappend(String(FPSTR(_name)).c_str()); oappend(SET_F(":")); oappend(String(FPSTR(_parasite)).c_str());
+  oappend(SET_F("',1,'<i>(if no Vcc connected)</i>');"));  // 0 is field type, 1 is actual field
+  oappend(SET_F("addInfo('")); oappend(String(FPSTR(_name)).c_str()); oappend(SET_F(":")); oappend(String(FPSTR(_parasitePin)).c_str());
+  oappend(SET_F("',1,'<i>(for external MOSFET)</i>');"));  // 0 is field type, 1 is actual field
+}
+
+float UsermodTemperature::getTemperature() {
+  return degC ? getTemperatureC() : getTemperatureF();
+}
+
+const char *UsermodTemperature::getTemperatureUnit() {
+  return degC ? "°C" : "°F";
+}
 
 // strings to reduce flash memory usage (used more than twice)
 const char UsermodTemperature::_name[]         PROGMEM = "Temperature";
 const char UsermodTemperature::_enabled[]      PROGMEM = "enabled";
 const char UsermodTemperature::_readInterval[] PROGMEM = "read-interval-s";
 const char UsermodTemperature::_parasite[]     PROGMEM = "parasite-pwr";
+const char UsermodTemperature::_parasitePin[]  PROGMEM = "parasite-pwr-pin";
+const char UsermodTemperature::_domoticzIDX[]  PROGMEM = "domoticz-idx";
+const char UsermodTemperature::_sensor[]       PROGMEM = "sensor";
+const char UsermodTemperature::_temperature[]  PROGMEM = "temperature";
+const char UsermodTemperature::_Temperature[]  PROGMEM = "/temperature";

usermods/Temperature/usermods_list.cpp

@@ -1,31 +0,0 @@
-#include "wled.h"
-/*
- * Register your v2 usermods here!
- */
-
-/*
- * Add/uncomment your usermod filename here (and once more below)
- * || || ||
- * \/ \/ \/
- */
-//#include "usermod_v2_example.h"
-#ifdef USERMOD_DALLASTEMPERATURE
-#include "../usermods/Temperature/usermod_temperature.h"
-#endif
-
-//#include "usermod_v2_empty.h"
-
-void registerUsermods()
-{
-  /*
-   * Add your usermod class name here
-   * || || ||
-   * \/ \/ \/
-   */
-  //usermods.add(new MyExampleUsermod());
-#ifdef USERMOD_DALLASTEMPERATURE
-  usermods.add(new UsermodTemperature());
-#endif
-
-  //usermods.add(new UsermodRenameMe());
-}

usermods/TetrisAI_v2/gridbw.h

@@ -0,0 +1,117 @@
+/******************************************************************************
+  * @file           : gridbw.h
+  * @brief          : contains the tetris grid as binary so black and white version
+  ******************************************************************************
+  * @attention
+  *
+  * Copyright (c) muebau 2023
+  * All rights reserved.</center></h2>
+  *
+  ******************************************************************************
+*/
+
+#ifndef __GRIDBW_H__
+#define __GRIDBW_H__
+
+#include <iterator>
+#include <vector>
+#include "pieces.h"
+
+using namespace std;
+
+class GridBW
+{
+private:
+public:
+    uint8_t width;
+    uint8_t height;
+    std::vector<uint32_t> pixels;
+
+    GridBW(uint8_t width, uint8_t height):
+        width(width),
+        height(height),
+        pixels(height)
+    {
+        if (width > 32)
+        {
+            throw std::invalid_argument("maximal width is 32");
+        }
+    }
+
+    void placePiece(Piece* piece, uint8_t x, uint8_t y)
+    {
+        for (uint8_t row = 4 - piece->getRotation().height; row < 4; row++)
+        {
+            pixels[y + (row - (4 - piece->getRotation().height))] |= piece->getGridRow(x, row, width);
+        }
+    }
+
+    void erasePiece(Piece* piece, uint8_t x, uint8_t y)
+    {
+        for (uint8_t row = 4 - piece->getRotation().height; row < 4; row++)
+        {
+            pixels[y + (row - (4 - piece->getRotation().height))] &= ~piece->getGridRow(x, row, width);
+        }
+    }
+
+    bool noCollision(Piece* piece, uint8_t x, uint8_t y)
+    {
+        //if it touches a wall it is a collision
+        if (x > (this->width - piece->getRotation().width) || y > this->height - piece->getRotation().height)
+        {
+            return false;
+        }
+
+        for (uint8_t row = 4 - piece->getRotation().height; row < 4; row++)
+        {
+            if (piece->getGridRow(x, row, width) & pixels[y + (row - (4 - piece->getRotation().height))])
+            {
+                return false;
+            }
+        }
+        return true;
+    }
+
+    void findLandingPosition(Piece* piece)
+    {
+        // move down until the piece bumps into some occupied pixels or the 'wall'
+        while (noCollision(piece, piece->x, piece->landingY))
+        {
+            piece->landingY++;
+        }
+
+        //at this point the positon is 'in the wall' or 'over some occupied pixel'
+        //so the previous position was the last correct one (clamped to 0 as minimum).
+        piece->landingY = piece->landingY > 0 ? piece->landingY - 1 : 0;
+    }
+
+    void cleanupFullLines()
+    {
+        uint8_t offset = 0;
+
+        //from "height - 1" to "0", so from bottom row to top
+        for (uint8_t row = height; row-- > 0; )
+        {
+            //full line?
+            if (isLineFull(row))
+            {
+                offset++;
+                pixels[row] = 0x0;
+                continue;
+            }
+
+            if (offset > 0)
+            {
+                pixels[row + offset] = pixels[row];
+                pixels[row] = 0x0;
+            }
+        }
+    }
+
+    bool isLineFull(uint8_t y)
+    {
+        return pixels[y] == (uint32_t)((1 << width) - 1);
+    }
+};
+
+#endif /* __GRIDBW_H__ */

usermods/TetrisAI_v2/gridcolor.h

@@ -0,0 +1,132 @@
+/******************************************************************************
+  * @file           : gridcolor.h
+  * @brief          : contains the tetris grid as 8bit indexed color version
+  ******************************************************************************
+  * @attention
+  *
+  * Copyright (c) muebau 2023
+  * All rights reserved.</center></h2>
+  *
+  ******************************************************************************
+*/
+
+#ifndef __GRIDCOLOR_H__
+#define __GRIDCOLOR_H__
+#include <stdint.h>
+#include <stdbool.h>
+#include <vector>
+#include "gridbw.h"
+#include "gridcolor.h"
+
+using namespace std;
+
+class GridColor
+{
+private:
+public:
+    uint8_t width;
+    uint8_t height;
+    GridBW gridBW;
+    std::vector<uint8_t> pixels;
+
+    GridColor(uint8_t width, uint8_t height):
+        width(width),
+        height(height),
+        gridBW(width, height),
+        pixels(width* height)
+    {}
+
+    void clear()
+    {
+        for (uint8_t y = 0; y < height; y++)
+        {
+            gridBW.pixels[y] = 0x0;
+            for (int8_t x = 0; x < width; x++)
+            {
+                *getPixel(x, y) = 0;
+            }
+        }
+    }
+
+    void placePiece(Piece* piece, uint8_t x, uint8_t y)
+    {
+        for (uint8_t pieceY = 0; pieceY < piece->getRotation().height; pieceY++)
+        {
+            for (uint8_t pieceX = 0; pieceX < piece->getRotation().width; pieceX++)
+            {
+                if (piece->getPixel(pieceX, pieceY))
+                {
+                    *getPixel(x + pieceX, y + pieceY) = piece->pieceData->colorIndex;
+                }
+            }
+        }
+    }
+
+    void erasePiece(Piece* piece, uint8_t x, uint8_t y)
+    {
+        for (uint8_t pieceY = 0; pieceY < piece->getRotation().height; pieceY++)
+        {
+            for (uint8_t pieceX = 0; pieceX < piece->getRotation().width; pieceX++)
+            {
+                if (piece->getPixel(pieceX, pieceY))
+                {
+                    *getPixel(x + pieceX, y + pieceY) = 0;
+                }
+            }
+        }
+    }
+
+    void cleanupFullLines()
+    {
+        uint8_t offset = 0;
+        //from "height - 1" to "0", so from bottom row to top
+        for (uint8_t y = height; y-- > 0; )
+        {
+            if (gridBW.isLineFull(y))
+            {
+                offset++;
+                for (uint8_t x = 0; x < width; x++)
+                {
+                    pixels[y * width + x] = 0;
+                }
+                continue;
+            }
+
+            if (offset > 0)
+            {
+                if (gridBW.pixels[y])
+                {
+                    for (uint8_t x = 0; x < width; x++)
+                    {
+                        pixels[(y + offset) * width + x] = pixels[y * width + x];
+                        pixels[y * width + x] = 0;
+                    }
+                }
+            }
+        }
+        gridBW.cleanupFullLines();
+    }
+
+    uint8_t* getPixel(uint8_t x, uint8_t y)
+    {
+        return &pixels[y * width + x];
+    }
+
+    void sync()
+    {
+        for (uint8_t y = 0; y < height; y++)
+        {
+            gridBW.pixels[y] = 0x0;
+            for (int8_t x = 0; x < width; x++)
+            {
+                gridBW.pixels[y] <<= 1;
+                if (*getPixel(x, y) != 0)
+                {
+                    gridBW.pixels[y] |= 0x1;
+                }
+            }
+        }
+    }
+};
+
+#endif /* __GRIDCOLOR_H__ */

usermods/TetrisAI_v2/pieces.h

@@ -0,0 +1,184 @@
+/******************************************************************************
+  * @file           : pieces.h
+  * @brief          : contains the tetris pieces with their colors indecies
+  ******************************************************************************
+  * @attention
+  *
+  * Copyright (c) muebau 2022
+  * All rights reserved.</center></h2>
+  *
+  ******************************************************************************
+*/
+
+#ifndef __PIECES_H__
+#define __PIECES_H__
+
+#include <stdint.h>
+#include <stdbool.h>
+
+#include <bitset>
+#include <cstddef>
+#include <cassert>
+#include <iostream>
+
+#define numPieces 7
+
+struct PieceRotation
+{
+    uint8_t width;
+    uint8_t height;
+    uint16_t rows;
+};
+
+struct PieceData
+{
+    uint8_t rotCount;
+    uint8_t colorIndex;
+    PieceRotation rotations[4];
+};
+
+PieceData piecesData[numPieces] = {
+    // I
+    {
+            2,
+            1,
+            {
+                { 1, 4, 0b0001000100010001},
+                { 4, 1, 0b0000000000001111}
+            }
+    },
+    // O
+    {
+            1,
+            2,
+            {
+                { 2, 2, 0b0000000000110011}
+            }
+    },
+    // Z
+    {
+            2,
+            3,
+            {
+                { 3, 2, 0b0000000001100011},
+                { 2, 3, 0b0000000100110010}
+            }
+    },
+    // S
+    {
+            2,
+            4,
+            {
+                { 3, 2, 0b0000000000110110},
+                { 2, 3, 0b0000001000110001}
+            }
+    },
+    // L
+    {
+            4,
+            5,
+            {
+                { 2, 3, 0b0000001000100011},
+                { 3, 2, 0b0000000001110100},
+                { 2, 3, 0b0000001100010001},
+                { 3, 2, 0b0000000000010111}
+            }
+    },
+    // J
+    {
+            4,
+            6,
+            {
+                { 2, 3, 0b0000000100010011},
+                { 3, 2, 0b0000000001000111},
+                { 2, 3, 0b0000001100100010},
+                { 3, 2, 0b0000000001110001}
+            }
+    },
+    // T
+    {
+            4,
+            7,
+            {
+                { 3, 2, 0b0000000001110010},
+                { 2, 3, 0b0000000100110001},
+                { 3, 2, 0b0000000000100111},
+                { 2, 3, 0b0000001000110010}
+            }
+    },
+};
+
+class Piece
+{
+private:
+public:
+    uint8_t x;
+    uint8_t y;
+    PieceData* pieceData;
+    uint8_t rotation;
+    uint8_t landingY;
+
+    Piece(uint8_t pieceIndex = 0):
+        x(0),
+        y(0),
+        rotation(0),
+        landingY(0)
+    {
+        this->pieceData = &piecesData[pieceIndex];
+    }
+
+    void reset()
+    {
+        this->rotation = 0;
+        this->x = 0;
+        this->y = 0;
+        this->landingY = 0;
+    }
+
+    uint32_t getGridRow(uint8_t x, uint8_t y, uint8_t width)
+    {
+        if (x < width)
+        {
+            //shift the row with the "top-left" position to the "x" position
+            auto shiftx = (width - 1) - x;
+            auto topleftx = (getRotation().width - 1);
+
+            auto finalShift = shiftx - topleftx;
+            auto row = getRow(y);
+            auto finalResult = row << finalShift;
+
+            return finalResult;
+        }
+        return 0xffffffff;
+    }
+
+    uint8_t getRow(uint8_t y)
+    {
+        if (y < 4)
+        {
+            return (getRotation().rows >> (12 - (4 * y))) & 0xf;
+        }
+        return 0xf;
+    }
+
+    bool getPixel(uint8_t x, uint8_t y)
+    {
+        if(x > getRotation().width - 1 || y > getRotation().height - 1 )
+        {
+            return false;
+        }
+        
+        if (x < 4 && y < 4)
+        {
+            return (getRow((4 - getRotation().height) + y) >> (3 - ((4 - getRotation().width) + x))) & 0x1;
+        }
+        return false;
+    }
+
+    PieceRotation getRotation()
+    {
+        return this->pieceData->rotations[rotation];
+    }
+};
+
+#endif /* __PIECES_H__ */

usermods/TetrisAI_v2/rating.h

@@ -0,0 +1,64 @@
+/******************************************************************************
+  * @file           : rating.h
+  * @brief          : contains the tetris rating of a grid
+  ******************************************************************************
+  * @attention
+  *
+  * Copyright (c) muebau 2022
+  * All rights reserved.</center></h2>
+  *
+  ******************************************************************************
+*/
+
+#ifndef __RATING_H__
+#define __RATING_H__
+
+#include <stdint.h>
+#include <float.h>
+#include <stdbool.h>
+#include <math.h>
+#include <vector>
+#include "rating.h"
+
+using namespace std;
+
+class Rating
+{
+private:
+public:
+    uint8_t minHeight;
+    uint8_t maxHeight;
+    uint16_t holes;
+    uint8_t fullLines;
+    uint16_t bumpiness;
+    uint16_t aggregatedHeight;
+    double score;
+    uint8_t width;
+    std::vector<uint8_t> lineHights;
+
+    Rating(uint8_t width):
+        width(width),
+        lineHights(width)
+    {
+        reset();
+    }
+
+    void reset()
+    {
+        this->minHeight = 0;
+        this->maxHeight = 0;
+
+        for (uint8_t line = 0; line < this->width; line++)
+        {
+            this->lineHights[line] = 0;
+        }
+
+        this->holes = 0;
+        this->fullLines = 0;
+        this->bumpiness = 0;
+        this->aggregatedHeight = 0;
+        this->score = -DBL_MAX;
+    }
+};
+
+#endif /* __RATING_H__ */

usermods/TetrisAI_v2/readme.md

@@ -0,0 +1,33 @@
+# Tetris AI effect usermod
+
+This usermod brings you a effect brings a self playing Tetris game. The mod needs version 0.14 or above as it is based on matrix support. The effect was tested on an ESP32 with a WS2812B 16x16 matrix.
+
+Version 1.0
+
+## Installation 
+
+Just activate the usermod with `-D USERMOD_TETRISAI` and the effect will become available under the name 'Tetris AI'.
+
+## Usage
+
+It is best to set the background color to black, the border color to light grey and the game over color (foreground) to dark grey.
+
+### Sliders and boxes
+
+#### Sliders
+
+* speed: speed the game plays
+* look ahead: how many pieces is the AI allowed to know the next pieces (0 - 2)
+* intelligence: how good the AI will play
+* Rotate color: make the colors shift (rotate) every few cicles
+* Mistakes free: how many good moves between mistakes (if activated)
+
+#### Checkboxes
+
+* show next: if true a space of 5 pixels from the right is used to show the next pieces. The whole segment is used for the grid otherwise.
+* show border: if true an additional column of 1 pixel is used to draw a border between the grid and the next pieces
+* mistakes: if true the worst instead of the best move is choosen every few moves (read above)
+
+## Best results
+
+ If the speed is set to be a little bit faster than a good human could play with maximal intelligence and very few mistakes it makes people furious/happy at a party.

usermods/TetrisAI_v2/tetrisai.h

@@ -0,0 +1,302 @@
+/******************************************************************************
+  * @file           : ai.h
+  * @brief          : contains the heuristic
+  ******************************************************************************
+  * @attention
+  *
+  * Copyright (c) muebau 2023
+  * All rights reserved.</center></h2>
+  *
+  ******************************************************************************
+*/
+
+#ifndef __AI_H__
+#define __AI_H__
+
+#include "gridbw.h"
+#include "rating.h"
+
+using namespace std;
+
+class TetrisAI
+{
+private:
+public:
+    double aHeight;
+    double fullLines;
+    double holes;
+    double bumpiness;
+    bool findWorstMove = false;
+
+    uint8_t countOnes(uint32_t vector)
+    {
+        uint8_t count = 0;
+        while (vector)
+        {
+            vector &= (vector - 1);
+            count++;
+        }
+        return count;
+    }
+
+    void updateRating(GridBW grid, Rating* rating)
+    {
+        rating->minHeight = 0;
+        rating->maxHeight = 0;
+        rating->holes = 0;
+        rating->fullLines = 0;
+        rating->bumpiness = 0;
+        rating->aggregatedHeight = 0;
+        fill(rating->lineHights.begin(), rating->lineHights.end(), 0);
+
+        uint32_t columnvector = 0x0;
+        uint32_t lastcolumnvector = 0x0;
+        for (uint8_t row = 0; row < grid.height; row++)
+        {
+            columnvector |= grid.pixels[row];
+
+            //first (highest) column makes it
+            if (rating->maxHeight == 0 && columnvector)
+            {
+                rating->maxHeight = grid.height - row;
+            }
+
+            //if column vector is full we found the minimal height (or it stays zero)
+            if (rating->minHeight == 0 && (columnvector == (uint32_t)((1 << grid.width) - 1)))
+            {
+                rating->minHeight = grid.height - row;
+            }
+
+            //line full if all ones in mask :-)
+            if (grid.isLineFull(row))
+            {
+                rating->fullLines++;
+            }
+
+            //holes are basically a XOR with the "full" columns
+            rating->holes += countOnes(columnvector ^ grid.pixels[row]);
+
+            //calculate the difference (XOR) between the current column vector and the last one
+            uint32_t columnDelta = columnvector ^ lastcolumnvector;
+
+            //process every new column
+            uint8_t index = 0;
+            while (columnDelta)
+            {
+                //if this is a new column
+                if (columnDelta & 0x1)
+                {
+                    //update hight of this column
+                    rating->lineHights[(grid.width - 1) - index] = grid.height - row;
+
+                    // update aggregatedHeight
+                    rating->aggregatedHeight += grid.height - row;
+                }
+                index++;
+                columnDelta >>= 1;
+            }
+            lastcolumnvector = columnvector;
+        }
+
+        //compare every two columns to get the difference and add them up
+        for (uint8_t column = 1; column < grid.width; column++)
+        {
+            rating->bumpiness += abs(rating->lineHights[column - 1] - rating->lineHights[column]);
+        }
+
+        rating->score = (aHeight * (rating->aggregatedHeight)) + (fullLines * (rating->fullLines)) + (holes * (rating->holes)) + (bumpiness * (rating->bumpiness));
+    }
+
+    TetrisAI(): TetrisAI(-0.510066, 0.760666, -0.35663, -0.184483)
+    {}
+
+    TetrisAI(double aHeight, double fullLines, double holes, double bumpiness):
+        aHeight(aHeight),
+        fullLines(fullLines),
+        holes(holes),
+        bumpiness(bumpiness)
+    {}
+
+    void findBestMove(GridBW grid, Piece *piece)
+    {
+        vector<Piece> pieces = {*piece};
+        findBestMove(grid, &pieces);
+        *piece = pieces[0];
+    }
+
+    void findBestMove(GridBW grid, std::vector<Piece> *pieces)
+    {
+        findBestMove(grid, pieces->begin(), pieces->end());
+    }
+
+    void findBestMove(GridBW grid, std::vector<Piece>::iterator start, std::vector<Piece>::iterator end)
+    {
+        Rating bestRating(grid.width);
+        findBestMove(grid, start, end, &bestRating);
+    }
+
+    void findBestMove(GridBW grid, std::vector<Piece>::iterator start, std::vector<Piece>::iterator end, Rating* bestRating)
+    {
+        grid.cleanupFullLines();
+        Rating curRating(grid.width);
+        Rating deeperRating(grid.width);
+        Piece piece = *start;
+
+        // for every rotation of the piece
+        for (piece.rotation = 0; piece.rotation < piece.pieceData->rotCount; piece.rotation++)
+        {
+            // put piece to top left corner
+            piece.x = 0;
+            piece.y = 0;
+
+            //test for every column
+            for (piece.x = 0; piece.x <= grid.width - piece.getRotation().width; piece.x++)
+            {
+                //todo optimise by the use of the previous grids height
+                piece.landingY = 0;
+                //will set landingY to final position
+                grid.findLandingPosition(&piece);
+
+                // draw piece
+                grid.placePiece(&piece, piece.x, piece.landingY);
+
+                if(start == end - 1)
+                {
+                    //at the deepest level
+                    updateRating(grid, &curRating);
+                }
+                else
+                {
+                    //go deeper to take another piece into account
+                    findBestMove(grid, start + 1, end, &deeperRating);
+                    curRating = deeperRating;
+                }
+
+                // eraese piece
+                grid.erasePiece(&piece, piece.x, piece.landingY);
+
+                if(findWorstMove)
+                {
+                    //init rating for worst
+                    if(bestRating->score == -DBL_MAX)
+                    {
+                        bestRating->score = DBL_MAX;
+                    }
+
+                    // update if we found a worse one
+                    if (bestRating->score > curRating.score)
+                    {
+                        *bestRating = curRating;
+                        (*start) = piece;
+                    }
+                }
+                else
+                {
+                    // update if we found a better one
+                    if (bestRating->score < curRating.score)
+                    {
+                        *bestRating = curRating;
+                        (*start) = piece;
+                    }
+                }
+            }
+        }
+    }
+
+    bool findBestMoveNonBlocking(GridBW grid, std::vector<Piece>::iterator start, std::vector<Piece>::iterator end, Rating* bestRating)
+    {
+        //vector with pieces
+        //for every piece
+            //for every 
+        switch (expression)
+        {
+            case INIT:
+                break;
+
+            default:
+                break;
+        }
+    }
+
+    bool findBestMoveNonBlocking(GridBW grid, std::vector<Piece>::iterator start, std::vector<Piece>::iterator end, Rating* bestRating)
+    {
+        //INIT
+        grid.cleanupFullLines();
+        Rating curRating(grid.width);
+        Rating deeperRating(grid.width);
+        Piece piece = *start;
+
+        // for every rotation of the piece
+        piece.rotation = 0;
+
+        //HANDLE
+        while (piece.rotation < piece.pieceData->rotCount)
+        {
+            // put piece to top left corner
+            piece.x = 0;
+            piece.y = 0;
+
+            //test for every column
+            piece.x = 0;
+            while (piece.x <= grid.width - piece.getRotation().width)
+            {
+
+                //todo optimise by the use of the previous grids height
+                piece.landingY = 0;
+                //will set landingY to final position
+                grid.findLandingPosition(&piece);
+
+                // draw piece
+                grid.placePiece(&piece, piece.x, piece.landingY);
+
+                if(start == end - 1)
+                {
+                    //at the deepest level
+                    updateRating(grid, &curRating);
+                }
+                else
+                {
+                    //go deeper to take another piece into account
+                    findBestMove(grid, start + 1, end, &deeperRating);
+                    curRating = deeperRating;
+                }
+
+                // eraese piece
+                grid.erasePiece(&piece, piece.x, piece.landingY);
+
+                if(findWorstMove)
+                {
+                    //init rating for worst
+                    if(bestRating->score == -DBL_MAX)
+                    {
+                        bestRating->score = DBL_MAX;
+                    }
+
+                    // update if we found a worse one
+                    if (bestRating->score > curRating.score)
+                    {
+                        *bestRating = curRating;
+                        (*start) = piece;
+                    }
+                }
+                else
+                {
+                    // update if we found a better one
+                    if (bestRating->score < curRating.score)
+                    {
+                        *bestRating = curRating;
+                        (*start) = piece;
+                    }
+                }
+                piece.x++;
+            }
+            piece.rotation++;
+        }
+
+        //EXIT
+
+        return true;
+    }
+};
+
+#endif /* __AI_H__ */

usermods/TetrisAI_v2/tetrisaigame.h

@@ -0,0 +1,150 @@
+/******************************************************************************
+  * @file           : tetrisaigame.h
+  * @brief          : main tetris functions
+  ******************************************************************************
+  * @attention
+  *
+  * Copyright (c) muebau 2022
+  * All rights reserved.</center></h2>
+  *
+  ******************************************************************************
+*/
+
+#ifndef __TETRISAIGAME_H__
+#define __TETRISAIGAME_H__
+
+#include <stdint.h>
+#include <stdbool.h>
+#include <vector>
+#include "pieces.h"
+#include "gridcolor.h"
+#include "tetrisbag.h"
+#include "tetrisai.h"
+
+using namespace std;
+
+class TetrisAIGame
+{
+private:
+    bool animateFallOfPiece(Piece* piece, bool skip)
+    {
+        if (skip || piece->y >= piece->landingY)
+        {
+            piece->y = piece->landingY;
+            grid.gridBW.placePiece(piece, piece->x, piece->landingY);
+            grid.placePiece(piece, piece->x, piece->y);
+            return false;
+        }
+        else
+        {
+            // eraese last drawing
+            grid.erasePiece(piece, piece->x, piece->y);
+
+            //move piece down
+            piece->y++;
+
+            // draw piece
+            grid.placePiece(piece, piece->x, piece->y);
+
+            return true;
+        }
+    }
+
+public:
+    uint8_t width;
+    uint8_t height;
+    uint8_t nLookAhead;
+    TetrisBag bag;
+    GridColor grid;
+    TetrisAI ai;
+    Piece curPiece;
+    PieceData* piecesData;
+    enum States { INIT, TEST_GAME_OVER, GET_NEXT_PIECE, FIND_BEST_MOVE, ANIMATE_MOVE, ANIMATE_GAME_OVER } state = INIT;
+
+    TetrisAIGame(uint8_t width, uint8_t height, uint8_t nLookAhead, PieceData* piecesData, uint8_t nPieces):
+        width(width),
+        height(height),
+        nLookAhead(nLookAhead),
+        bag(nPieces, 1, nLookAhead),
+        grid(width, height + 4),
+        ai(),
+        piecesData(piecesData)
+    {
+    }
+
+    void nextPiece()
+    {
+        grid.cleanupFullLines();
+        bag.queuePiece();
+    }
+
+    void findBestMove()
+    {
+        ai.findBestMove(grid.gridBW, &bag.piecesQueue);
+    }
+
+    bool animateFall(bool skip)
+    {
+        return animateFallOfPiece(&(bag.piecesQueue[0]), skip);
+    }
+
+    bool isGameOver()
+    {
+        //if there is something in the 4 lines of the hidden area the game is over
+        return grid.gridBW.pixels[0] || grid.gridBW.pixels[1] || grid.gridBW.pixels[2] || grid.gridBW.pixels[3];
+    }
+
+    void poll()
+    {
+        switch (state)
+        {
+            case INIT:
+                reset();
+                state = TEST_GAME_OVER;
+                break;
+            case TEST_GAME_OVER:
+                if (isGameOver())
+                {
+                    state = ANIMATE_GAME_OVER;
+                }
+                else
+                {
+                    state = GET_NEXT_PIECE;
+                }
+                break;
+            case GET_NEXT_PIECE:
+                nextPiece();
+                state = FIND_BEST_MOVE;
+                break;
+            case FIND_BEST_MOVE:
+                findBestMove();
+                state = ANIMATE_MOVE;
+                break;
+            case ANIMATE_MOVE:
+                if (!animateFall(false))
+                {
+                    state = TEST_GAME_OVER;
+                }
+                break;
+            case ANIMATE_GAME_OVER:
+                static auto curPixel = grid.pixels.size();
+                grid.pixels[curPixel] = 254;
+
+                if (curPixel == 0)
+                {
+                    state = INIT;
+                    curPixel = grid.pixels.size();
+                }
+                curPixel--;
+                break;
+        }
+    }
+
+    void reset()
+    {
+        grid.clear();
+        bag.init();
+    }
+};
+
+#endif /* __TETRISAIGAME_H__ */

usermods/TetrisAI_v2/tetrisbag.h

@@ -0,0 +1,100 @@
+/******************************************************************************
+  * @file           : tetrisbag.h
+  * @brief          : the tetris implementation of a random piece generator
+  ******************************************************************************
+  * @attention
+  *
+  * Copyright (c) muebau 2022
+  * All rights reserved.</center></h2>
+  *
+  ******************************************************************************
+*/
+
+#ifndef __TETRISBAG_H__
+#define __TETRISBAG_H__
+
+#include <stdint.h>
+#include <vector>
+#include <algorithm>
+
+#include "tetrisbag.h"
+
+class TetrisBag
+{
+private:
+public:
+    uint8_t nPieces;
+    uint8_t nBagLength;
+    uint8_t bagIdx;
+    std::vector<uint8_t> bag;
+    std::vector<Piece> piecesQueue;
+
+    TetrisBag(uint8_t nPieces, uint8_t nBagLength, uint8_t queueLength):
+        nPieces(nPieces),
+        nBagLength(nBagLength),
+        bag(nPieces * nBagLength),
+        piecesQueue(queueLength)
+    {
+        init();
+    }
+
+    void init()
+    {
+        //will shuffle the bag at first use
+        bagIdx = nPieces - 1;
+
+        for (uint8_t bagIndex = 0; bagIndex < nPieces * nBagLength; bagIndex++)
+        {
+            bag[bagIndex] = bagIndex % nPieces;
+        }
+
+        //will init the queue
+        for (uint8_t index = 0; index < piecesQueue.size(); index++)
+        {
+            queuePiece();
+        }
+    }
+
+    void shuffleBag()
+    {
+        uint8_t temp;
+        uint8_t swapIdx;
+        for (int index = nPieces - 1; index > 0; index--)
+        {
+            //get candidate to swap
+            swapIdx = rand() % index;
+
+            //swap it!
+            temp = bag[swapIdx];
+            bag[swapIdx] = bag[index];
+            bag[index] = temp;
+        }
+    }
+
+    Piece getNextPiece()
+    {
+        bagIdx++;
+        if (bagIdx >= nPieces)
+        {
+            shuffleBag();
+            bagIdx = 0;
+        }
+        return Piece(bag[bagIdx]);
+    }
+
+    void queuePiece()
+    {
+        //move vector to left
+        std::rotate(piecesQueue.begin(), piecesQueue.begin() + 1, piecesQueue.end());
+        piecesQueue[piecesQueue.size() - 1] = getNextPiece();
+    }
+
+    void queuePiece(uint8_t idx)
+    {
+        //move vector to left
+        std::rotate(piecesQueue.begin(), piecesQueue.begin() + 1, piecesQueue.end());
+        piecesQueue[piecesQueue.size() - 1] = Piece(idx % nPieces);
+    }
+};
+
+#endif /* __TETRISBAG_H__ */

usermods/TetrisAI_v2/usermod_v2_tetrisai.h

@@ -0,0 +1,222 @@
+#pragma once
+
+#include "wled.h"
+#include "FX.h"
+#include "fcn_declare.h"
+
+#include "tetrisaigame.h"
+// By: muebau
+
+typedef struct TetrisAI_data
+{
+  unsigned long lastTime = 0;
+  TetrisAIGame tetris;
+  uint8_t   intelligence;
+  uint8_t   rotate;
+  bool      showNext;
+  bool      showBorder;
+  uint8_t   colorOffset;
+  uint8_t   colorInc;
+  uint8_t   mistaceCountdown;
+} tetrisai_data;
+
+void drawGrid(TetrisAIGame* tetris, TetrisAI_data* tetrisai_data)
+{
+  SEGMENT.fill(SEGCOLOR(1));
+
+  //GRID
+  for (auto index_y = 4; index_y < tetris->grid.height; index_y++)
+  {
+    for (auto index_x = 0; index_x < tetris->grid.width; index_x++)
+    {
+      CRGB color;
+      if (*tetris->grid.getPixel(index_x, index_y) == 0)
+      {
+        //BG color
+        color = SEGCOLOR(1);
+      }
+      //game over animation
+      else if(*tetris->grid.getPixel(index_x, index_y) == 254)
+      {
+        //use fg
+        color = SEGCOLOR(0);
+      }
+      else
+      {
+        //spread the color over the whole palette
+        uint8_t colorIndex = *tetris->grid.getPixel(index_x, index_y) * 32;
+        colorIndex += tetrisai_data->colorOffset;
+        color = ColorFromPalette(SEGPALETTE, colorIndex, 255, NOBLEND);
+      }
+
+      SEGMENT.setPixelColorXY(index_x, index_y - 4, color);
+    }
+  }
+  tetrisai_data->colorOffset += tetrisai_data->colorInc;
+
+  //NEXT PIECE AREA
+  if (tetrisai_data->showNext)
+  {
+    //BORDER
+    if (tetrisai_data->showBorder)
+    {
+      //draw a line 6 pixels from right with the border color
+      for (auto index_y = 0; index_y < SEGMENT.virtualHeight(); index_y++)
+      {
+        SEGMENT.setPixelColorXY(SEGMENT.virtualWidth() - 6, index_y, SEGCOLOR(2));
+      }
+    }
+
+    //NEXT PIECE
+    int piecesOffsetX = SEGMENT.virtualWidth() - 4;
+    int piecesOffsetY = 1;
+    for (uint8_t nextPieceIdx = 1; nextPieceIdx < tetris->nLookAhead; nextPieceIdx++)
+    {
+      uint8_t pieceNbrOffsetY = (nextPieceIdx - 1) * 5;
+
+      Piece piece(tetris->bag.piecesQueue[nextPieceIdx]);
+
+      for (uint8_t pieceY = 0; pieceY < piece.getRotation().height; pieceY++)
+      {
+        for (uint8_t pieceX = 0; pieceX < piece.getRotation().width; pieceX++)
+        {
+          if (piece.getPixel(pieceX, pieceY))
+          {
+            uint8_t colIdx = ((piece.pieceData->colorIndex * 32) + tetrisai_data->colorOffset);
+            SEGMENT.setPixelColorXY(piecesOffsetX + pieceX, piecesOffsetY + pieceNbrOffsetY + pieceY, ColorFromPalette(SEGPALETTE, colIdx, 255, NOBLEND));
+          }
+        }
+      }
+    }
+  }
+}
+
+////////////////////////////
+//     2D Tetris AI       //
+////////////////////////////
+uint16_t mode_2DTetrisAI()
+{
+  if (!strip.isMatrix || !SEGENV.allocateData(sizeof(tetrisai_data)))
+  {
+    // not a 2D set-up
+    SEGMENT.fill(SEGCOLOR(0));
+    return 350;
+  }
+  TetrisAI_data* tetrisai_data = reinterpret_cast<TetrisAI_data*>(SEGENV.data);
+
+  const uint16_t cols = SEGMENT.virtualWidth();
+  const uint16_t rows = SEGMENT.virtualHeight();
+
+  //range 0 - 1024ms => 1024/255 ~ 4
+  uint16_t msDelayMove = 1024 - (4 * SEGMENT.speed);
+  int16_t msDelayGameOver = msDelayMove / 4;
+
+  //range 0 - 2 (not including current)
+  uint8_t nLookAhead = SEGMENT.intensity ? (SEGMENT.intensity >> 7) + 2 : 1;
+  //range 0 - 16
+  tetrisai_data->colorInc = SEGMENT.custom2 >> 4;
+
+  if (!tetrisai_data->tetris || (tetrisai_data->tetris.nLookAhead != nLookAhead
+    || tetrisai_data->showNext != SEGMENT.check1
+    || tetrisai_data->showBorder != SEGMENT.check2
+      )
+    )
+  {
+    tetrisai_data->showNext = SEGMENT.check1;
+    tetrisai_data->showBorder = SEGMENT.check2;
+
+    //not more than 32 as this is the limit of this implementation
+    uint8_t gridWidth = cols < 32 ? cols : 32;
+    uint8_t gridHeight = rows;
+
+    // do we need space for the 'next' section?
+    if (tetrisai_data->showNext)
+    {
+      // make space for the piece and one pixel of space
+      gridWidth = gridWidth - 5;
+
+      // do we need space for a border?
+      if (tetrisai_data->showBorder)
+      {
+        gridWidth = gridWidth - 1;
+      }
+    }
+
+    tetrisai_data->tetris = TetrisAIGame(gridWidth, gridHeight, nLookAhead, piecesData, numPieces);
+    SEGMENT.fill(SEGCOLOR(1));
+  }
+
+  if (tetrisai_data->intelligence != SEGMENT.custom1)
+  {
+    tetrisai_data->intelligence = SEGMENT.custom1;
+    double dui = 0.2 - (0.2 * (tetrisai_data->intelligence / 255.0));
+
+    tetrisai_data->tetris.ai.aHeight = -0.510066 + dui;
+    tetrisai_data->tetris.ai.fullLines = 0.760666 - dui;
+    tetrisai_data->tetris.ai.holes = -0.35663 + dui;
+    tetrisai_data->tetris.ai.bumpiness = -0.184483 + dui;
+  }
+
+  if (tetrisai_data->tetris.state == TetrisAIGame::ANIMATE_MOVE)
+  {
+    if (millis() - tetrisai_data->lastTime > msDelayMove)
+    {
+      drawGrid(&tetrisai_data->tetris, tetrisai_data);
+      tetrisai_data->lastTime = millis();
+      tetrisai_data->tetris.poll();
+    }
+  }
+  else if (tetrisai_data->tetris.state == TetrisAIGame::ANIMATE_GAME_OVER)
+  {
+    if (millis() - tetrisai_data->lastTime > msDelayGameOver)
+    {
+      drawGrid(&tetrisai_data->tetris, tetrisai_data);
+      tetrisai_data->lastTime = millis();
+      tetrisai_data->tetris.poll();
+    }
+  }
+  else if (tetrisai_data->tetris.state == TetrisAIGame::FIND_BEST_MOVE)
+  {
+    if (SEGMENT.check3)
+    {
+      if(tetrisai_data->mistaceCountdown == 0)
+      {
+        tetrisai_data->tetris.ai.findWorstMove = true;
+        tetrisai_data->tetris.poll();
+        tetrisai_data->tetris.ai.findWorstMove = false;
+        tetrisai_data->mistaceCountdown = SEGMENT.custom3;
+      }
+      tetrisai_data->mistaceCountdown--;      
+    }
+    tetrisai_data->tetris.poll();
+  }
+  else
+  {
+    tetrisai_data->tetris.poll();
+  }
+
+  return FRAMETIME;
+} // mode_2DTetrisAI()
+static const char _data_FX_MODE_2DTETRISAI[] PROGMEM = "Tetris AI@!,Look ahead,Intelligence,Rotate color,Mistake free,Show next,Border,Mistakes;Game Over,!,Border;!;2;sx=127,ix=64,c1=255,c2=0,c3=31,o1=1,o2=1,o3=0,pal=11";
+
+class TetrisAIUsermod : public Usermod
+{
+
+private:
+
+public:
+  void setup()
+  {
+    strip.addEffect(255, &mode_2DTetrisAI, _data_FX_MODE_2DTETRISAI);
+  }
+
+  void loop()
+  {
+
+  }
+
+  uint16_t getId()
+  {
+    return USERMOD_ID_TETRISAI;
+  }
+};

usermods/VL53L0X_gestures/usermod_vl53l0x_gestures.h

@@ -50,9 +50,7 @@ class UsermodVL53L0XGestures : public Usermod {
   public:
 
     void setup() {
-      PinManagerPinType pins[2] = { { i2c_scl, true }, { i2c_sda, true } };
-      if (!pinManager.allocateMultiplePins(pins, 2, PinOwner::HW_I2C)) { enabled = false; return; }
-      Wire.begin();
+      if (i2c_scl<0 || i2c_sda<0) { enabled = false; return; }
 
       sensor.setTimeout(150);
       if (!sensor.init())

usermods/Wemos_D1_mini+Wemos32_mini_shield/usermod.cpp

@@ -34,30 +34,30 @@ uint8_t DALLAS_PIN =23;
 uint8_t SCL_PIN = 5;
 uint8_t SDA_PIN = 4;
 uint8_t DALLAS_PIN =13;
-// uint8_t RST_PIN = 16; // Uncoment for Heltec WiFi-Kit-8
+// uint8_t RST_PIN = 16; // Un-comment for Heltec WiFi-Kit-8
 #endif
 
 //The SCL and SDA pins are defined here.
 //ESP8266 Wemos D1 mini board use SCL=5 SDA=4 while ESP32 Wemos32 mini board use SCL=22 SDA=21
 #define U8X8_PIN_SCL SCL_PIN
 #define U8X8_PIN_SDA SDA_PIN
-//#define U8X8_PIN_RESET RST_PIN // Uncoment for Heltec WiFi-Kit-8
+//#define U8X8_PIN_RESET RST_PIN // Un-comment for Heltec WiFi-Kit-8
 
 // Dallas sensor reading timer
 long temptimer = millis();
 long lastMeasure = 0;
-#define Celsius // Show temperature mesaurement in Celcius otherwise is in Fahrenheit 
+#define Celsius // Show temperature measurement in Celsius otherwise is in Fahrenheit 
 
 // If display does not work or looks corrupted check the
 // constructor reference:
 // https://github.com/olikraus/u8g2/wiki/u8x8setupcpp
 // or check the gallery:
 // https://github.com/olikraus/u8g2/wiki/gallery
-// --> First choise of cheap I2C OLED 128X32 0.91"
+// --> First choice of cheap I2C OLED 128X32 0.91"
 U8X8_SSD1306_128X32_UNIVISION_HW_I2C u8x8(U8X8_PIN_NONE, U8X8_PIN_SCL, U8X8_PIN_SDA); // Pins are Reset, SCL, SDA
-// --> Second choise of cheap I2C OLED 128X64 0.96" or 1.3"
+// --> Second choice of cheap I2C OLED 128X64 0.96" or 1.3"
 //U8X8_SSD1306_128X64_NONAME_HW_I2C u8x8(U8X8_PIN_NONE, U8X8_PIN_SCL, U8X8_PIN_SDA); // Pins are Reset, SCL, SDA
-// --> Third choise of Heltec WiFi-Kit-8 OLED 128X32 0.91"
+// --> Third choice of Heltec WiFi-Kit-8 OLED 128X32 0.91"
 //U8X8_SSD1306_128X32_UNIVISION_HW_I2C u8x8(U8X8_PIN_RESET, U8X8_PIN_SCL, U8X8_PIN_SDA); // Constructor for Heltec WiFi-Kit-8
 // gets called once at boot. Do all initialization that doesn't depend on network here
 void userSetup() {
@@ -97,15 +97,16 @@ void userLoop() {
 
 //----> Dallas temperature sensor MQTT publishing
   temptimer = millis();  
-// Timer to publishe new temperature every 60 seconds
+// Timer to publish new temperature every 60 seconds
   if (temptimer - lastMeasure > 60000) 
   {
     lastMeasure = temptimer;    
+#ifndef WLED_DISABLE_MQTT
 //Check if MQTT Connected, otherwise it will crash the 8266
     if (mqtt != nullptr)
     {
 //      Serial.println(Dallas(DALLAS_PIN,0));
-//Gets prefered temperature scale based on selection in definitions section
+//Gets preferred temperature scale based on selection in definitions section
         #ifdef Celsius
         int16_t board_temperature = Dallas(DALLAS_PIN,0);
         #else
@@ -116,6 +117,7 @@ void userLoop() {
         t += "/temperature";
         mqtt->publish(t.c_str(), 0, true, String(board_temperature).c_str());
     }
+  #endif
   }
 
   // Check if we time interval for redrawing passes.
@@ -171,11 +173,11 @@ void userLoop() {
   // First row with Wifi name
   u8x8.setCursor(1, 0);
   u8x8.print(knownSsid.substring(0, u8x8.getCols() > 1 ? u8x8.getCols() - 2 : 0));
-  // Print `~` char to indicate that SSID is longer, than owr dicplay
+  // Print `~` char to indicate that SSID is longer than our display
   if (knownSsid.length() > u8x8.getCols())
     u8x8.print("~");
 
-  // Second row with IP or Psssword
+  // Second row with IP or Password
   u8x8.setCursor(1, 1);
   // Print password in AP mode and if led is OFF.
   if (apActive && bri == 0)

usermods/Wemos_D1_mini+Wemos32_mini_shield/usermod_bme280.cpp

@@ -6,7 +6,7 @@
 
 void UpdateBME280Data();
 
-#define Celsius // Show temperature mesaurement in Celcius otherwise is in Fahrenheit 
+#define Celsius // Show temperature measurement in Celsius otherwise is in Fahrenheit 
 BME280I2C bme;    // Default : forced mode, standby time = 1000 ms
                   // Oversampling = pressure ×1, temperature ×1, humidity ×1, filter off,
 
@@ -16,25 +16,25 @@ uint8_t SDA_PIN = 21;
 #else //ESP8266 boards
 uint8_t SCL_PIN = 5;
 uint8_t SDA_PIN = 4;
-// uint8_t RST_PIN = 16; // Uncoment for Heltec WiFi-Kit-8
+// uint8_t RST_PIN = 16; // Un-comment for Heltec WiFi-Kit-8
 #endif
 
 //The SCL and SDA pins are defined here.
 //ESP8266 Wemos D1 mini board use SCL=5 SDA=4 while ESP32 Wemos32 mini board use SCL=22 SDA=21
 #define U8X8_PIN_SCL SCL_PIN
 #define U8X8_PIN_SDA SDA_PIN
-//#define U8X8_PIN_RESET RST_PIN // Uncoment for Heltec WiFi-Kit-8
+//#define U8X8_PIN_RESET RST_PIN // Un-comment for Heltec WiFi-Kit-8
 
 // If display does not work or looks corrupted check the
 // constructor reference:
 // https://github.com/olikraus/u8g2/wiki/u8x8setupcpp
 // or check the gallery:
 // https://github.com/olikraus/u8g2/wiki/gallery
-// --> First choise of cheap I2C OLED 128X32 0.91"
+// --> First choice of cheap I2C OLED 128X32 0.91"
 U8X8_SSD1306_128X32_UNIVISION_HW_I2C u8x8(U8X8_PIN_NONE, U8X8_PIN_SCL, U8X8_PIN_SDA); // Pins are Reset, SCL, SDA
-// --> Second choise of cheap I2C OLED 128X64 0.96" or 1.3"
+// --> Second choice of cheap I2C OLED 128X64 0.96" or 1.3"
 //U8X8_SSD1306_128X64_NONAME_HW_I2C u8x8(U8X8_PIN_NONE, U8X8_PIN_SCL, U8X8_PIN_SDA); // Pins are Reset, SCL, SDA
-// --> Third choise of Heltec WiFi-Kit-8 OLED 128X32 0.91"
+// --> Third choice of Heltec WiFi-Kit-8 OLED 128X32 0.91"
 //U8X8_SSD1306_128X32_UNIVISION_HW_I2C u8x8(U8X8_PIN_RESET, U8X8_PIN_SCL, U8X8_PIN_SDA); // Constructor for Heltec WiFi-Kit-8
 // gets called once at boot. Do all initialization that doesn't depend on network here
 
@@ -103,6 +103,7 @@ void userLoop() {
   {
     lastMeasure = tempTimer;    
 
+#ifndef WLED_DISABLE_MQTT
 // Check if MQTT Connected, otherwise it will crash the 8266
     if (mqtt != nullptr)
     {
@@ -122,6 +123,7 @@ void userLoop() {
       h += "/humidity";
       mqtt->publish(h.c_str(), 0, true, String(board_humidity).c_str());
     }
+  #endif
   }
 
   // Check if we time interval for redrawing passes.
@@ -177,11 +179,11 @@ void userLoop() {
   // First row with Wifi name
   u8x8.setCursor(1, 0);
   u8x8.print(knownSsid.substring(0, u8x8.getCols() > 1 ? u8x8.getCols() - 2 : 0));
-  // Print `~` char to indicate that SSID is longer, than owr dicplay
+  // Print `~` char to indicate that SSID is longer, than our display
   if (knownSsid.length() > u8x8.getCols())
     u8x8.print("~");
 
-  // Second row with IP or Psssword
+  // Second row with IP or Password
   u8x8.setCursor(1, 1);
   // Print password in AP mode and if led is OFF.
   if (apActive && bri == 0)

usermods/audioreactive/audio_reactive.h

@@ -4,6 +4,10 @@
 #include <driver/i2s.h>
 #include <driver/adc.h>
 
+#ifdef WLED_ENABLE_DMX
+  #error This audio reactive usermod is not compatible with DMX Out.
+#endif
+
 #ifndef ARDUINO_ARCH_ESP32
   #error This audio reactive usermod does not support the ESP8266.
 #endif
@@ -20,6 +24,12 @@
  * ....
  */
 
+#if !defined(FFTTASK_PRIORITY)
+#define FFTTASK_PRIORITY 1 // standard: looptask prio
+//#define FFTTASK_PRIORITY 2 // above looptask, below asyc_tcp
+//#define FFTTASK_PRIORITY 4 // above asyc_tcp
+#endif
+
 // Comment/Uncomment to toggle usb serial debugging
 // #define MIC_LOGGER                   // MIC sampling & sound input debugging (serial plotter)
 // #define FFT_SAMPLING_LOG             // FFT result debugging
@@ -45,6 +55,8 @@
   #define PLOT_PRINTF(x...)
 #endif
 
+#define MAX_PALETTES 3
+
 // use audio source class (ESP32 specific)
 #include "audio_source.h"
 constexpr i2s_port_t I2S_PORT = I2S_NUM_0;       // I2S port to use (do not change !)
@@ -67,11 +79,15 @@ static uint8_t audioSyncEnabled = 0;          // bit field: bit 0 - send, bit 1
 static bool udpSyncConnected = false;         // UDP connection status -> true if connected to multicast group
 
 // user settable parameters for limitSoundDynamics()
-static bool limiterOn = true;                 // bool: enable / disable dynamics limiter
+#ifdef UM_AUDIOREACTIVE_DYNAMICS_LIMITER_OFF
+static bool limiterOn = false;                 // bool: enable / disable dynamics limiter
+#else
+static bool limiterOn = true;
+#endif
 static uint16_t attackTime =  80;             // int: attack time in milliseconds. Default 0.08sec
 static uint16_t decayTime = 1400;             // int: decay time in milliseconds.  Default 1.40sec
 // user settable options for FFTResult scaling
-static uint8_t FFTScalingMode = 3;            // 0 none; 1 optimized logarithmic; 2 optimized linear; 3 optimized sqare root
+static uint8_t FFTScalingMode = 3;            // 0 none; 1 optimized logarithmic; 2 optimized linear; 3 optimized square root
 
 // 
 // AGC presets
@@ -104,11 +120,11 @@ static float    sampleAgc = 0.0f;               // Smoothed AGC sample
 
 // peak detection
 static bool samplePeak = false;      // Boolean flag for peak - used in effects. Responding routine may reset this flag. Auto-reset after strip.getMinShowDelay()
-static uint8_t maxVol = 10;          // Reasonable value for constant volume for 'peak detector', as it won't always trigger (deprecated)
+static uint8_t maxVol = 31;          // Reasonable value for constant volume for 'peak detector', as it won't always trigger (deprecated)
 static uint8_t binNum = 8;           // Used to select the bin for FFT based beat detection  (deprecated)
-static bool udpSamplePeak = false;   // Boolean flag for peak. Set at the same tiem as samplePeak, but reset by transmitAudioData
+static bool udpSamplePeak = false;   // Boolean flag for peak. Set at the same time as samplePeak, but reset by transmitAudioData
 static unsigned long timeOfPeak = 0; // time of last sample peak detection.
-static void detectSamplePeak(void);  // peak detection function (needs scaled FFT reasults in vReal[])
+static void detectSamplePeak(void);  // peak detection function (needs scaled FFT results in vReal[])
 static void autoResetPeak(void);     // peak auto-reset function
 
 
@@ -167,26 +183,20 @@ constexpr uint16_t samplesFFT_2 = 256;          // meaningfull part of FFT resul
 // These are the input and output vectors.  Input vectors receive computed results from FFT.
 static float vReal[samplesFFT] = {0.0f};       // FFT sample inputs / freq output -  these are our raw result bins
 static float vImag[samplesFFT] = {0.0f};       // imaginary parts
-#ifdef UM_AUDIOREACTIVE_USE_NEW_FFT
 static float windowWeighingFactors[samplesFFT] = {0.0f};
-#endif
 
 // Create FFT object
-#ifdef UM_AUDIOREACTIVE_USE_NEW_FFT
 // lib_deps += https://github.com/kosme/arduinoFFT#develop @ 1.9.2
-#define FFT_SPEED_OVER_PRECISION     // enables use of reciprocals (1/x etc), and an a few other speedups
-#define FFT_SQRT_APPROXIMATION       // enables "quake3" style inverse sqrt
-#define sqrt(x) sqrtf(x)             // little hack that reduces FFT time by 50% on ESP32 (as alternative to FFT_SQRT_APPROXIMATION)
-#else
-// lib_deps += https://github.com/blazoncek/arduinoFFT.git
-#endif
+// these options actually cause slow-downs on all esp32 processors, don't use them.
+// #define FFT_SPEED_OVER_PRECISION     // enables use of reciprocals (1/x etc) - not faster on ESP32
+// #define FFT_SQRT_APPROXIMATION       // enables "quake3" style inverse sqrt  - slower on ESP32
+// Below options are forcing ArduinoFFT to use sqrtf() instead of sqrt()
+#define sqrt(x) sqrtf(x)             // little hack that reduces FFT time by 10-50% on ESP32
+#define sqrt_internal sqrtf          // see https://github.com/kosme/arduinoFFT/pull/83
+
 #include <arduinoFFT.h>
 
-#ifdef UM_AUDIOREACTIVE_USE_NEW_FFT
 static ArduinoFFT<float> FFT = ArduinoFFT<float>( vReal, vImag, samplesFFT, SAMPLE_RATE, windowWeighingFactors);
-#else
-static arduinoFFT FFT = arduinoFFT(vReal, vImag, samplesFFT, SAMPLE_RATE);
-#endif
 
 // Helper functions
 
@@ -195,7 +205,7 @@ static float mapf(float x, float in_min, float in_max, float out_min, float out_
   return (x - in_min) * (out_max - out_min) / (in_max - in_min) + out_min;
 }
 
-// compute average of several FFT resut bins
+// compute average of several FFT result bins
 static float fftAddAvg(int from, int to) {
   float result = 0.0f;
   for (int i = from; i <= to; i++) {
@@ -267,28 +277,13 @@ void FFTcode(void * parameter)
 #endif
 
       // run FFT (takes 3-5ms on ESP32, ~12ms on ESP32-S2)
-#ifdef UM_AUDIOREACTIVE_USE_NEW_FFT
       FFT.dcRemoval();                                            // remove DC offset
       FFT.windowing( FFTWindow::Flat_top, FFTDirection::Forward); // Weigh data using "Flat Top" function - better amplitude accuracy
       //FFT.windowing(FFTWindow::Blackman_Harris, FFTDirection::Forward);  // Weigh data using "Blackman- Harris" window - sharp peaks due to excellent sideband rejection
       FFT.compute( FFTDirection::Forward );                       // Compute FFT
       FFT.complexToMagnitude();                                   // Compute magnitudes
-#else
-      FFT.DCRemoval(); // let FFT lib remove DC component, so we don't need to care about this in getSamples()
 
-      //FFT.Windowing( FFT_WIN_TYP_HAMMING, FFT_FORWARD );        // Weigh data - standard Hamming window
-      //FFT.Windowing( FFT_WIN_TYP_BLACKMAN, FFT_FORWARD );       // Blackman window - better side freq rejection
-      //FFT.Windowing( FFT_WIN_TYP_BLACKMAN_HARRIS, FFT_FORWARD );// Blackman-Harris - excellent sideband rejection
-      FFT.Windowing( FFT_WIN_TYP_FLT_TOP, FFT_FORWARD );          // Flat Top Window - better amplitude accuracy
-      FFT.Compute( FFT_FORWARD );                             // Compute FFT
-      FFT.ComplexToMagnitude();                               // Compute magnitudes
-#endif
-
-#ifdef UM_AUDIOREACTIVE_USE_NEW_FFT
-      FFT.majorPeak(FFT_MajorPeak, FFT_Magnitude);                // let the effects know which freq was most dominant
-#else
-      FFT.MajorPeak(&FFT_MajorPeak, &FFT_Magnitude);              // let the effects know which freq was most dominant
-#endif
+      FFT.majorPeak(&FFT_MajorPeak, &FFT_Magnitude);                // let the effects know which freq was most dominant
       FFT_MajorPeak = constrain(FFT_MajorPeak, 1.0f, 11025.0f);   // restrict value to range expected by effects
 
 #if defined(WLED_DEBUG) || defined(SR_DEBUG)
@@ -313,7 +308,7 @@ void FFTcode(void * parameter)
     *
     * Andrew's updated mapping of 256 bins down to the 16 result bins with Sample Freq = 10240, samplesFFT = 512 and some overlap.
     * Based on testing, the lowest/Start frequency is 60 Hz (with bin 3) and a highest/End frequency of 5120 Hz in bin 255.
-    * Now, Take the 60Hz and multiply by 1.320367784 to get the next frequency and so on until the end. Then detetermine the bins.
+    * Now, Take the 60Hz and multiply by 1.320367784 to get the next frequency and so on until the end. Then determine the bins.
     * End frequency = Start frequency * multiplier ^ 16
     * Multiplier = (End frequency/ Start frequency) ^ 1/16
     * Multiplier = 1.320367784
@@ -372,7 +367,7 @@ void FFTcode(void * parameter)
       }
     }
 
-    // post-processing of frequency channels (pink noise adjustment, AGC, smooting, scaling)
+    // post-processing of frequency channels (pink noise adjustment, AGC, smoothing, scaling)
     postProcessFFTResults((fabsf(sampleAvg) > 0.25f)? true : false , NUM_GEQ_CHANNELS);
 
 #if defined(WLED_DEBUG) || defined(SR_DEBUG)
@@ -411,7 +406,7 @@ static void runMicFilter(uint16_t numSamples, float *sampleBuffer)          // p
   //constexpr float beta1 = 0.8285f; // 18Khz
   constexpr float beta1 = 0.85f;  // 20Khz
 
-  constexpr float beta2 = (1.0f - beta1) / 2.0;
+  constexpr float beta2 = (1.0f - beta1) / 2.0f;
   static float last_vals[2] = { 0.0f }; // FIR high freq cutoff filter
   static float lowfilt = 0.0f;          // IIR low frequency cutoff filter
 
@@ -419,7 +414,7 @@ static void runMicFilter(uint16_t numSamples, float *sampleBuffer)          // p
         // FIR lowpass, to remove high frequency noise
         float highFilteredSample;
         if (i < (numSamples-1)) highFilteredSample = beta1*sampleBuffer[i] + beta2*last_vals[0] + beta2*sampleBuffer[i+1];  // smooth out spikes
-        else highFilteredSample = beta1*sampleBuffer[i] + beta2*last_vals[0]  + beta2*last_vals[1];                  // spcial handling for last sample in array
+        else highFilteredSample = beta1*sampleBuffer[i] + beta2*last_vals[0]  + beta2*last_vals[1];                  // special handling for last sample in array
         last_vals[1] = last_vals[0];
         last_vals[0] = sampleBuffer[i];
         sampleBuffer[i] = highFilteredSample;
@@ -464,17 +459,17 @@ static void postProcessFFTResults(bool noiseGateOpen, int numberOfChannels) // p
       switch (FFTScalingMode) {
         case 1:
             // Logarithmic scaling
-            currentResult *= 0.42;                      // 42 is the answer ;-)
-            currentResult -= 8.0;                       // this skips the lowest row, giving some room for peaks
-            if (currentResult > 1.0) currentResult = logf(currentResult); // log to base "e", which is the fastest log() function
-            else currentResult = 0.0;                   // special handling, because log(1) = 0; log(0) = undefined
+            currentResult *= 0.42f;                      // 42 is the answer ;-)
+            currentResult -= 8.0f;                       // this skips the lowest row, giving some room for peaks
+            if (currentResult > 1.0f) currentResult = logf(currentResult); // log to base "e", which is the fastest log() function
+            else currentResult = 0.0f;                   // special handling, because log(1) = 0; log(0) = undefined
             currentResult *= 0.85f + (float(i)/18.0f);  // extra up-scaling for high frequencies
             currentResult = mapf(currentResult, 0, LOG_256, 0, 255); // map [log(1) ... log(255)] to [0 ... 255]
         break;
         case 2:
             // Linear scaling
             currentResult *= 0.30f;                     // needs a bit more damping, get stay below 255
-            currentResult -= 4.0;                       // giving a bit more room for peaks
+            currentResult -= 4.0f;                       // giving a bit more room for peaks
             if (currentResult < 1.0f) currentResult = 0.0f;
             currentResult *= 0.85f + (float(i)/1.8f);   // extra up-scaling for high frequencies
         break;
@@ -482,8 +477,8 @@ static void postProcessFFTResults(bool noiseGateOpen, int numberOfChannels) // p
             // square root scaling
             currentResult *= 0.38f;
             currentResult -= 6.0f;
-            if (currentResult > 1.0) currentResult = sqrtf(currentResult);
-            else currentResult = 0.0;                   // special handling, because sqrt(0) = undefined
+            if (currentResult > 1.0f) currentResult = sqrtf(currentResult);
+            else currentResult = 0.0f;                   // special handling, because sqrt(0) = undefined
             currentResult *= 0.85f + (float(i)/4.5f);   // extra up-scaling for high frequencies
             currentResult = mapf(currentResult, 0.0, 16.0, 0.0, 255.0); // map [sqrt(1) ... sqrt(256)] to [0 ... 255]
         break;
@@ -511,11 +506,11 @@ static void postProcessFFTResults(bool noiseGateOpen, int numberOfChannels) // p
 // peak detection is called from FFT task when vReal[] contains valid FFT results
 static void detectSamplePeak(void) {
   bool havePeak = false;
-
+  // softhack007: this code continuously triggers while amplitude in the selected bin is above a certain threshold. So it does not detect peaks - it detects high activity in a frequency bin.
   // Poor man's beat detection by seeing if sample > Average + some value.
   // This goes through ALL of the 255 bins - but ignores stupid settings
   // Then we got a peak, else we don't. The peak has to time out on its own in order to support UDP sound sync.
-  if ((sampleAvg > 1) && (maxVol > 0) && (binNum > 1) && (vReal[binNum] > maxVol) && ((millis() - timeOfPeak) > 100)) {
+  if ((sampleAvg > 1) && (maxVol > 0) && (binNum > 4) && (vReal[binNum] > maxVol) && ((millis() - timeOfPeak) > 100)) {
     havePeak = true;
   }
 
@@ -569,16 +564,6 @@ class AudioReactive : public Usermod {
     #else
     int8_t i2sckPin = I2S_CKPIN;
     #endif
-    #ifndef ES7243_SDAPIN
-    int8_t sdaPin = -1;
-    #else
-    int8_t sdaPin = ES7243_SDAPIN;
-    #endif
-    #ifndef ES7243_SCLPIN
-    int8_t sclPin = -1;
-    #else
-    int8_t sclPin = ES7243_SCLPIN;
-    #endif
     #ifndef MCLK_PIN
     int8_t mclkPin = I2S_PIN_NO_CHANGE;  /* ESP32: only -1, 0, 1, 3 allowed*/
     #else
@@ -611,8 +596,15 @@ class AudioReactive : public Usermod {
     };
 
     // set your config variables to their boot default value (this can also be done in readFromConfig() or a constructor if you prefer)
+    #ifdef UM_AUDIOREACTIVE_ENABLE
+    bool     enabled = true;
+    #else
     bool     enabled = false;
+    #endif
+
     bool     initDone = false;
+    bool     addPalettes = false;
+    int8_t   palettes = 0;
 
     // variables  for UDP sound sync
     WiFiUDP fftUdp;               // UDP object for sound sync (from WiFi UDP, not Async UDP!) 
@@ -626,7 +618,7 @@ class AudioReactive : public Usermod {
 
     // variables used by getSample() and agcAvg()
     int16_t  micIn = 0;           // Current sample starts with negative values and large values, which is why it's 16 bit signed
-    double   sampleMax = 0.0;     // Max sample over a few seconds. Needed for AGC controler.
+    double   sampleMax = 0.0;     // Max sample over a few seconds. Needed for AGC controller.
     double   micLev = 0.0;        // Used to convert returned value to have '0' as minimum. A leveller
     float    expAdjF = 0.0f;      // Used for exponential filter.
     float    sampleReal = 0.0f;	  // "sampleRaw" as float, to provide bits that are lost otherwise (before amplification by sampleGain or inputLevel). Needed for AGC.
@@ -648,13 +640,21 @@ class AudioReactive : public Usermod {
     // strings to reduce flash memory usage (used more than twice)
     static const char _name[];
     static const char _enabled[];
+    static const char _config[];
+    static const char _dynamics[];
+    static const char _frequency[];
     static const char _inputLvl[];
     static const char _analogmic[];
     static const char _digitalmic[];
+    static const char _addPalettes[];
     static const char UDP_SYNC_HEADER[];
     static const char UDP_SYNC_HEADER_v1[];
 
     // private methods
+    void removeAudioPalettes(void);
+    void createAudioPalettes(void);
+    CRGB getCRGBForBand(int x, int pal);
+    void fillAudioPalettes(void);
 
     ////////////////////
     // Debug support  //
@@ -744,13 +744,13 @@ class AudioReactive : public Usermod {
     * 2. we use two setpoints, one at ~60%, and one at ~80% of the maximum signal
     * 3. the amplification depends on signal level:
     *    a) normal zone - very slow adjustment
-    *    b) emergency zome (<10% or >90%) - very fast adjustment
+    *    b) emergency zone (<10% or >90%) - very fast adjustment
     */
     void agcAvg(unsigned long the_time)
     {
       const int AGC_preset = (soundAgc > 0)? (soundAgc-1): 0; // make sure the _compiler_ knows this value will not change while we are inside the function
 
-      float lastMultAgc = multAgc;      // last muliplier used
+      float lastMultAgc = multAgc;      // last multiplier used
       float multAgcTemp = multAgc;      // new multiplier
       float tmpAgc = sampleReal * multAgc;        // what-if amplified signal
 
@@ -768,7 +768,7 @@ class AudioReactive : public Usermod {
       if (time_now - last_time > 2)  {
         last_time = time_now;
 
-        if((fabsf(sampleReal) < 2.0f) || (sampleMax < 1.0f)) {
+        if((fabsf(sampleReal) < 2.0f) || (sampleMax < 1.0)) {
           // MIC signal is "squelched" - deliver silence
           tmpAgc = 0;
           // we need to "spin down" the intgrated error buffer
@@ -790,13 +790,13 @@ class AudioReactive : public Usermod {
         
         if (((multAgcTemp > 0.085f) && (multAgcTemp < 6.5f))    //integrator anti-windup by clamping
             && (multAgc*sampleMax < agcZoneStop[AGC_preset]))   //integrator ceiling (>140% of max)
-          control_integrated += control_error * 0.002 * 0.25;   // 2ms = intgration time; 0.25 for damping
+          control_integrated += control_error * 0.002 * 0.25;   // 2ms = integration time; 0.25 for damping
         else
           control_integrated *= 0.9;                            // spin down that beasty integrator
 
         // apply PI Control 
         tmpAgc = sampleReal * lastMultAgc;                      // check "zone" of the signal using previous gain
-        if ((tmpAgc > agcZoneHigh[AGC_preset]) || (tmpAgc < soundSquelch + agcZoneLow[AGC_preset])) {  // upper/lower emergy zone
+        if ((tmpAgc > agcZoneHigh[AGC_preset]) || (tmpAgc < soundSquelch + agcZoneLow[AGC_preset])) {  // upper/lower energy zone
           multAgcTemp = lastMultAgc + agcFollowFast[AGC_preset] * agcControlKp[AGC_preset] * control_error;
           multAgcTemp += agcFollowFast[AGC_preset] * agcControlKi[AGC_preset] * control_integrated;
         } else {                                                                         // "normal zone"
@@ -804,7 +804,7 @@ class AudioReactive : public Usermod {
           multAgcTemp += agcFollowSlow[AGC_preset] * agcControlKi[AGC_preset] * control_integrated;
         }
 
-        // limit amplification again - PI controler sometimes "overshoots"
+        // limit amplification again - PI controller sometimes "overshoots"
         //multAgcTemp = constrain(multAgcTemp, 0.015625f, 32.0f); // 1/64 < multAgcTemp < 32
         if (multAgcTemp > 32.0f)      multAgcTemp = 32.0f;
         if (multAgcTemp < 1.0f/64.0f) multAgcTemp = 1.0f/64.0f;
@@ -834,7 +834,7 @@ class AudioReactive : public Usermod {
     void getSample()
     {
       float    sampleAdj;           // Gain adjusted sample value
-      float    tmpSample;           // An interim sample variable used for calculatioins.
+      float    tmpSample;           // An interim sample variable used for calculations.
       const float weighting = 0.2f; // Exponential filter weighting. Will be adjustable in a future release.
       const int   AGC_preset = (soundAgc > 0)? (soundAgc-1): 0; // make sure the _compiler_ knows this value will not change while we are inside the function
 
@@ -883,8 +883,8 @@ class AudioReactive : public Usermod {
       // keep "peak" sample, but decay value if current sample is below peak
       if ((sampleMax < sampleReal) && (sampleReal > 0.5f)) {
         sampleMax = sampleMax + 0.5f * (sampleReal - sampleMax);  // new peak - with some filtering
-        // another simple way to detect samplePeak
-        if ((binNum < 10) && (millis() - timeOfPeak > 80) && (sampleAvg > 1)) {
+        // another simple way to detect samplePeak - cannot detect beats, but reacts on peak volume
+        if (((binNum < 12) || ((maxVol < 1))) && (millis() - timeOfPeak > 80) && (sampleAvg > 1)) {
           samplePeak    = true;
           timeOfPeak    = millis();
           udpSamplePeak = true;
@@ -959,6 +959,8 @@ class AudioReactive : public Usermod {
       //DEBUGSR_PRINTLN("Transmitting UDP Mic Packet");
 
       audioSyncPacket transmitData;
+      memset(reinterpret_cast<void *>(&transmitData), 0, sizeof(transmitData)); // make sure that the packet - including "invisible" padding bytes added by the compiler - is fully initialized
+
       strncpy_P(transmitData.header, PSTR(UDP_SYNC_HEADER), 6);
       // transmit samples that were not modified by limitSampleDynamics()
       transmitData.sampleRaw   = (soundAgc) ? rawSampleAgc: sampleRaw;
@@ -974,9 +976,10 @@ class AudioReactive : public Usermod {
       transmitData.FFT_Magnitude = my_magnitude;
       transmitData.FFT_MajorPeak = FFT_MajorPeak;
 
-      fftUdp.beginMulticastPacket();
-      fftUdp.write(reinterpret_cast<uint8_t *>(&transmitData), sizeof(transmitData));
-      fftUdp.endPacket();
+      if (fftUdp.beginMulticastPacket() != 0) { // beginMulticastPacket returns 0 in case of error
+        fftUdp.write(reinterpret_cast<uint8_t *>(&transmitData), sizeof(transmitData));
+        fftUdp.endPacket();
+      }
       return;
     } // transmitAudioData()
 
@@ -1081,7 +1084,7 @@ class AudioReactive : public Usermod {
      * You can use it to initialize variables, sensors or similar.
      * It is called *AFTER* readFromConfig()
      */
-    void setup()
+    void setup() override
     {
       disableSoundProcessing = true; // just to be sure
       if (!initDone) {
@@ -1136,7 +1139,7 @@ class AudioReactive : public Usermod {
           DEBUGSR_PRINTLN(F("AR: ES7243 Microphone (right channel only)."));
           audioSource = new ES7243(SAMPLE_RATE, BLOCK_SIZE);
           delay(100);
-          if (audioSource) audioSource->initialize(sdaPin, sclPin, i2swsPin, i2ssdPin, i2sckPin, mclkPin);
+          if (audioSource) audioSource->initialize(i2swsPin, i2ssdPin, i2sckPin, mclkPin);
           break;
         case 3:
           DEBUGSR_PRINT(F("AR: SPH0645 Microphone - ")); DEBUGSR_PRINTLN(F(I2S_MIC_CHANNEL_TEXT));
@@ -1159,6 +1162,13 @@ class AudioReactive : public Usermod {
           if (audioSource) audioSource->initialize(i2swsPin, i2ssdPin);
           break;
         #endif
+        case 6:
+          DEBUGSR_PRINTLN(F("AR: ES8388 Source"));
+          audioSource = new ES8388Source(SAMPLE_RATE, BLOCK_SIZE);
+          delay(100);
+          if (audioSource) audioSource->initialize(i2swsPin, i2ssdPin, i2sckPin, mclkPin);
+          break;
+
         #if  !defined(CONFIG_IDF_TARGET_ESP32S2) && !defined(CONFIG_IDF_TARGET_ESP32C3) && !defined(CONFIG_IDF_TARGET_ESP32S3)
         // ADC over I2S is only possible on "classic" ESP32
         case 0:
@@ -1166,6 +1176,7 @@ class AudioReactive : public Usermod {
           DEBUGSR_PRINTLN(F("AR: Analog Microphone (left channel only)."));
           audioSource = new I2SAdcSource(SAMPLE_RATE, BLOCK_SIZE);
           delay(100);
+          useBandPassFilter = true;  // PDM bandpass filter seems to help for bad quality analog
           if (audioSource) audioSource->initialize(audioPin);
           break;
         #endif
@@ -1187,6 +1198,7 @@ class AudioReactive : public Usermod {
       }
 
       if (enabled) connectUDPSoundSync();
+      if (enabled && addPalettes) createAudioPalettes();
       initDone = true;
     }
 
@@ -1195,7 +1207,7 @@ class AudioReactive : public Usermod {
      * connected() is called every time the WiFi is (re)connected
      * Use it to initialize network interfaces
      */
-    void connected()
+    void connected() override
     {
       if (udpSyncConnected) {   // clean-up: if open, close old UDP sync connection
         udpSyncConnected = false;
@@ -1222,7 +1234,7 @@ class AudioReactive : public Usermod {
      * 2. Try to avoid using the delay() function. NEVER use delays longer than 10 milliseconds.
      *    Instead, use a timer check as shown here.
      */
-    void loop()
+    void loop() override
     {
       static unsigned long lastUMRun = millis();
 
@@ -1244,16 +1256,16 @@ class AudioReactive : public Usermod {
       {
         #ifdef WLED_DEBUG
         if ((disableSoundProcessing == false) && (audioSyncEnabled == 0)) {  // we just switched to "disabled"
-          DEBUG_PRINTLN("[AR userLoop]  realtime mode active - audio processing suspended.");
-          DEBUG_PRINTF( "               RealtimeMode = %d; RealtimeOverride = %d\n", int(realtimeMode), int(realtimeOverride));
+          DEBUG_PRINTLN(F("[AR userLoop]  realtime mode active - audio processing suspended."));
+          DEBUG_PRINTF_P(PSTR("               RealtimeMode = %d; RealtimeOverride = %d\n"), int(realtimeMode), int(realtimeOverride));
         }
         #endif
         disableSoundProcessing = true;
       } else {
         #ifdef WLED_DEBUG
         if ((disableSoundProcessing == true) && (audioSyncEnabled == 0) && audioSource->isInitialized()) {    // we just switched to "enabled"
-          DEBUG_PRINTLN("[AR userLoop]  realtime mode ended - audio processing resumed.");
-          DEBUG_PRINTF( "               RealtimeMode = %d; RealtimeOverride = %d\n", int(realtimeMode), int(realtimeOverride));
+          DEBUG_PRINTLN(F("[AR userLoop]  realtime mode ended - audio processing resumed."));
+          DEBUG_PRINTF_P(PSTR("               RealtimeMode = %d; RealtimeOverride = %d\n"), int(realtimeMode), int(realtimeOverride));
         }
         #endif
         if ((disableSoundProcessing == true) && (audioSyncEnabled == 0)) lastUMRun = millis();  // just left "realtime mode" - update timekeeping
@@ -1275,9 +1287,10 @@ class AudioReactive : public Usermod {
 
         #ifdef WLED_DEBUG
           // complain when audio userloop has been delayed for long time. Currently we need userloop running between 500 and 1500 times per second. 
-          if ((userloopDelay > 23) && !disableSoundProcessing && (audioSyncEnabled == 0)) {
-            DEBUG_PRINTF("[AR userLoop] hickup detected -> was inactive for last %d millis!\n", userloopDelay);
-          }
+          // softhack007 disabled temporarily - avoid serial console spam with MANY leds and low FPS
+          //if ((userloopDelay > 65) && !disableSoundProcessing && (audioSyncEnabled == 0)) {
+          //  DEBUG_PRINTF_P(PSTR("[AR userLoop] hiccup detected -> was inactive for last %d millis!\n"), userloopDelay);
+          //}
         #endif
 
         // run filters, and repeat in case of loop delays (hick-up compensation)
@@ -1314,6 +1327,9 @@ class AudioReactive : public Usermod {
           if (millis() - lastTime > delayMs) {
             have_new_sample = receiveAudioData();
             if (have_new_sample) last_UDPTime = millis();
+#ifdef ARDUINO_ARCH_ESP32
+            else fftUdp.flush(); // Flush udp input buffers if we haven't read it - avoids hickups in receive mode. Does not work on 8266.
+#endif
             lastTime = millis();
           }
           if (have_new_sample) syncVolumeSmth = volumeSmth;   // remember received sample
@@ -1332,7 +1348,7 @@ class AudioReactive : public Usermod {
       // Info Page: keep max sample from last 5 seconds
       if ((millis() -  sampleMaxTimer) > CYCLE_SAMPLEMAX) {
         sampleMaxTimer = millis();
-        maxSample5sec = (0.15 * maxSample5sec) + 0.85 *((soundAgc) ? sampleAgc : sampleAvg); // reset, and start with some smoothing
+        maxSample5sec = (0.15f * maxSample5sec) + 0.85f *((soundAgc) ? sampleAgc : sampleAvg); // reset, and start with some smoothing
         if (sampleAvg < 1) maxSample5sec = 0; // noise gate 
       } else {
          if ((sampleAvg >= 1)) maxSample5sec = fmaxf(maxSample5sec, (soundAgc) ? rawSampleAgc : sampleRaw); // follow maximum volume
@@ -1345,10 +1361,11 @@ class AudioReactive : public Usermod {
         lastTime = millis();
       }
 
+      fillAudioPalettes();
     }
 
 
-    bool getUMData(um_data_t **data)
+    bool getUMData(um_data_t **data) override
     {
       if (!data || !enabled) return false; // no pointer provided by caller or not enabled -> exit
       *data = um_data;
@@ -1356,7 +1373,7 @@ class AudioReactive : public Usermod {
     }
 
 
-    void onUpdateBegin(bool init)
+    void onUpdateBegin(bool init) override
     {
 #ifdef WLED_DEBUG
       fftTime = sampleTime = 0;
@@ -1376,10 +1393,11 @@ class AudioReactive : public Usermod {
       memset(fftAvg, 0, sizeof(fftAvg)); 
       memset(fftResult, 0, sizeof(fftResult)); 
       for(int i=(init?0:1); i<NUM_GEQ_CHANNELS; i+=2) fftResult[i] = 16; // make a tiny pattern
-      inputLevel = 128;                                    // resset level slider to default
+      inputLevel = 128;                                    // reset level slider to default
       autoResetPeak();
 
       if (init && FFT_Task) {
+        delay(25);                // give some time for I2S driver to finish sampling before we suspend it
         vTaskSuspend(FFT_Task);   // update is about to begin, disable task to prevent crash
         if (udpSyncConnected) {   // close UDP sync connection (if open)
           udpSyncConnected = false;
@@ -1391,15 +1409,14 @@ class AudioReactive : public Usermod {
           vTaskResume(FFT_Task);
           connected(); // resume UDP
         } else
-//          xTaskCreatePinnedToCore(
-          xTaskCreate(                        // no need to "pin" this task to core #0
+          xTaskCreateUniversal(               // xTaskCreateUniversal also works on -S2 and -C3 with single core
             FFTcode,                          // Function to implement the task
             "FFT",                            // Name of the task
-            5000,                             // Stack size in words
+            3592,                             // Stack size in words // 3592 leaves 800-1024 bytes of task stack free
             NULL,                             // Task input parameter
-            1,                                // Priority of the task
+            FFTTASK_PRIORITY,                 // Priority of the task
             &FFT_Task                         // Task handle
-//            , 0                                 // Core where the task should run
+            , 0                               // Core where the task should run
           );
       }
       micDataReal = 0.0f;                     // just to be sure
@@ -1411,7 +1428,7 @@ class AudioReactive : public Usermod {
      * handleButton() can be used to override default button behaviour. Returning true
      * will prevent button working in a default way.
      */
-    bool handleButton(uint8_t b) {
+    bool handleButton(uint8_t b) override {
       yield();
       // crude way of determining if audio input is analog
       // better would be for AudioSource to implement getType()
@@ -1434,7 +1451,7 @@ class AudioReactive : public Usermod {
      * Creating an "u" object allows you to add custom key/value pairs to the Info section of the WLED web UI.
      * Below it is shown how this could be used for e.g. a light sensor
      */
-    void addToJsonInfo(JsonObject& root)
+    void addToJsonInfo(JsonObject& root) override
     {
       char myStringBuffer[16]; // buffer for snprintf()
       JsonObject user = root["u"];
@@ -1489,14 +1506,14 @@ class AudioReactive : public Usermod {
         } else {
           // Analog or I2S digital input
           if (audioSource && (audioSource->isInitialized())) {
-            // audio source sucessfully configured
+            // audio source successfully configured
             if (audioSource->getType() == AudioSource::Type_I2SAdc) {
               infoArr.add(F("ADC analog"));
             } else {
               infoArr.add(F("I2S digital"));
             }
             // input level or "silence"
-            if (maxSample5sec > 1.0) {
+            if (maxSample5sec > 1.0f) {
               float my_usage = 100.0f * (maxSample5sec / 255.0f);
               snprintf_P(myStringBuffer, 15, PSTR(" - peak %3d%%"), int(my_usage));
               infoArr.add(myStringBuffer);
@@ -1506,7 +1523,7 @@ class AudioReactive : public Usermod {
           } else {
             // error during audio source setup
             infoArr.add(F("not initialized"));
-            infoArr.add(F(" - check GPIO config"));
+            infoArr.add(F(" - check pin settings"));
           }
         }
 
@@ -1573,7 +1590,7 @@ class AudioReactive : public Usermod {
      * addToJsonState() can be used to add custom entries to the /json/state part of the JSON API (state object).
      * Values in the state object may be modified by connected clients
      */
-    void addToJsonState(JsonObject& root)
+    void addToJsonState(JsonObject& root) override
     {
       if (!initDone) return;  // prevent crash on boot applyPreset()
       JsonObject usermod = root[FPSTR(_name)];
@@ -1588,7 +1605,7 @@ class AudioReactive : public Usermod {
      * readFromJsonState() can be used to receive data clients send to the /json/state part of the JSON API (state object).
      * Values in the state object may be modified by connected clients
      */
-    void readFromJsonState(JsonObject& root)
+    void readFromJsonState(JsonObject& root) override
     {
       if (!initDone) return;  // prevent crash on boot applyPreset()
       bool prevEnabled = enabled;
@@ -1597,13 +1614,28 @@ class AudioReactive : public Usermod {
         if (usermod[FPSTR(_enabled)].is<bool>()) {
           enabled = usermod[FPSTR(_enabled)].as<bool>();
           if (prevEnabled != enabled) onUpdateBegin(!enabled);
+          if (addPalettes) {
+            // add/remove custom/audioreactive palettes
+            if (prevEnabled && !enabled) removeAudioPalettes();
+            if (!prevEnabled && enabled) createAudioPalettes();
+          }
         }
         if (usermod[FPSTR(_inputLvl)].is<int>()) {
           inputLevel = min(255,max(0,usermod[FPSTR(_inputLvl)].as<int>()));
         }
       }
+      if (root.containsKey(F("rmcpal")) && root[F("rmcpal")].as<bool>()) {
+        // handle removal of custom palettes from JSON call so we don't break things
+        removeAudioPalettes();
+      }
     }
 
+    void onStateChange(uint8_t callMode) override {
+      if (initDone && enabled && addPalettes && palettes==0 && strip.customPalettes.size()<10) {
+        // if palettes were removed during JSON call re-add them
+        createAudioPalettes();
+      }
+    }
 
     /*
      * addToConfig() can be used to add custom persistent settings to the cfg.json file in the "um" (usermod) object.
@@ -1640,10 +1672,11 @@ class AudioReactive : public Usermod {
      * 
      * I highly recommend checking out the basics of ArduinoJson serialization and deserialization in order to use custom settings!
      */
-    void addToConfig(JsonObject& root)
+    void addToConfig(JsonObject& root) override
     {
       JsonObject top = root.createNestedObject(FPSTR(_name));
       top[FPSTR(_enabled)] = enabled;
+      top[FPSTR(_addPalettes)] = addPalettes;
 
     #if !defined(CONFIG_IDF_TARGET_ESP32S2) && !defined(CONFIG_IDF_TARGET_ESP32C3) && !defined(CONFIG_IDF_TARGET_ESP32S3)
       JsonObject amic = top.createNestedObject(FPSTR(_analogmic));
@@ -1651,31 +1684,29 @@ class AudioReactive : public Usermod {
     #endif
 
       JsonObject dmic = top.createNestedObject(FPSTR(_digitalmic));
-      dmic[F("type")] = dmType;
+      dmic["type"] = dmType;
       JsonArray pinArray = dmic.createNestedArray("pin");
       pinArray.add(i2ssdPin);
       pinArray.add(i2swsPin);
       pinArray.add(i2sckPin);
       pinArray.add(mclkPin);
-      pinArray.add(sdaPin);
-      pinArray.add(sclPin);
 
-      JsonObject cfg = top.createNestedObject("config");
+      JsonObject cfg = top.createNestedObject(FPSTR(_config));
       cfg[F("squelch")] = soundSquelch;
       cfg[F("gain")] = sampleGain;
       cfg[F("AGC")] = soundAgc;
 
-      JsonObject dynLim = top.createNestedObject("dynamics");
+      JsonObject dynLim = top.createNestedObject(FPSTR(_dynamics));
       dynLim[F("limiter")] = limiterOn;
       dynLim[F("rise")] = attackTime;
       dynLim[F("fall")] = decayTime;
 
-      JsonObject freqScale = top.createNestedObject("frequency");
+      JsonObject freqScale = top.createNestedObject(FPSTR(_frequency));
       freqScale[F("scale")] = FFTScalingMode;
 
       JsonObject sync = top.createNestedObject("sync");
-      sync[F("port")] = audioSyncPort;
-      sync[F("mode")] = audioSyncEnabled;
+      sync["port"] = audioSyncPort;
+      sync["mode"] = audioSyncEnabled;
     }
 
 
@@ -1694,12 +1725,15 @@ class AudioReactive : public Usermod {
      * 
      * This function is guaranteed to be called on boot, but could also be called every time settings are updated
      */
-    bool readFromConfig(JsonObject& root)
+    bool readFromConfig(JsonObject& root) override
     {
       JsonObject top = root[FPSTR(_name)];
       bool configComplete = !top.isNull();
+      bool oldEnabled = enabled;
+      bool oldAddPalettes = addPalettes;
 
       configComplete &= getJsonValue(top[FPSTR(_enabled)], enabled);
+      configComplete &= getJsonValue(top[FPSTR(_addPalettes)], addPalettes);
 
     #if !defined(CONFIG_IDF_TARGET_ESP32S2) && !defined(CONFIG_IDF_TARGET_ESP32C3) && !defined(CONFIG_IDF_TARGET_ESP32S3)
       configComplete &= getJsonValue(top[FPSTR(_analogmic)]["pin"], audioPin);
@@ -1719,27 +1753,30 @@ class AudioReactive : public Usermod {
       configComplete &= getJsonValue(top[FPSTR(_digitalmic)]["pin"][1], i2swsPin);
       configComplete &= getJsonValue(top[FPSTR(_digitalmic)]["pin"][2], i2sckPin);
       configComplete &= getJsonValue(top[FPSTR(_digitalmic)]["pin"][3], mclkPin);
-      configComplete &= getJsonValue(top[FPSTR(_digitalmic)]["pin"][4], sdaPin);
-      configComplete &= getJsonValue(top[FPSTR(_digitalmic)]["pin"][5], sclPin);
 
-      configComplete &= getJsonValue(top["config"][F("squelch")], soundSquelch);
-      configComplete &= getJsonValue(top["config"][F("gain")],    sampleGain);
-      configComplete &= getJsonValue(top["config"][F("AGC")],     soundAgc);
+      configComplete &= getJsonValue(top[FPSTR(_config)][F("squelch")], soundSquelch);
+      configComplete &= getJsonValue(top[FPSTR(_config)][F("gain")],    sampleGain);
+      configComplete &= getJsonValue(top[FPSTR(_config)][F("AGC")],     soundAgc);
 
-      configComplete &= getJsonValue(top["dynamics"][F("limiter")], limiterOn);
-      configComplete &= getJsonValue(top["dynamics"][F("rise")],  attackTime);
-      configComplete &= getJsonValue(top["dynamics"][F("fall")],  decayTime);
+      configComplete &= getJsonValue(top[FPSTR(_dynamics)][F("limiter")], limiterOn);
+      configComplete &= getJsonValue(top[FPSTR(_dynamics)][F("rise")],  attackTime);
+      configComplete &= getJsonValue(top[FPSTR(_dynamics)][F("fall")],  decayTime);
 
-      configComplete &= getJsonValue(top["frequency"][F("scale")], FFTScalingMode);
+      configComplete &= getJsonValue(top[FPSTR(_frequency)][F("scale")], FFTScalingMode);
 
-      configComplete &= getJsonValue(top["sync"][F("port")], audioSyncPort);
-      configComplete &= getJsonValue(top["sync"][F("mode")], audioSyncEnabled);
+      configComplete &= getJsonValue(top["sync"]["port"], audioSyncPort);
+      configComplete &= getJsonValue(top["sync"]["mode"], audioSyncEnabled);
 
+      if (initDone) {
+        // add/remove custom/audioreactive palettes
+        if ((oldAddPalettes && !addPalettes) || (oldAddPalettes && !enabled)) removeAudioPalettes();
+        if ((addPalettes && !oldAddPalettes && enabled) || (addPalettes && !oldEnabled && enabled)) createAudioPalettes();
+      } // else setup() will create palettes
       return configComplete;
     }
 
 
-    void appendConfigData()
+    void appendConfigData() override
     {
       oappend(SET_F("dd=addDropdown('AudioReactive','digitalmic:type');"));
     #if  !defined(CONFIG_IDF_TARGET_ESP32S2) && !defined(CONFIG_IDF_TARGET_ESP32C3) && !defined(CONFIG_IDF_TARGET_ESP32S3)
@@ -1752,6 +1789,8 @@ class AudioReactive : public Usermod {
     #if  !defined(CONFIG_IDF_TARGET_ESP32S2) && !defined(CONFIG_IDF_TARGET_ESP32C3)
       oappend(SET_F("addOption(dd,'Generic I2S PDM',5);"));
     #endif
+    oappend(SET_F("addOption(dd,'ES8388',6);"));
+    
       oappend(SET_F("dd=addDropdown('AudioReactive','config:AGC');"));
       oappend(SET_F("addOption(dd,'Off',0);"));
       oappend(SET_F("addOption(dd,'Normal',1);"));
@@ -1784,8 +1823,6 @@ class AudioReactive : public Usermod {
       #else
         oappend(SET_F("addInfo('AudioReactive:digitalmic:pin[]',3,'<i>master clock</i>','I2S MCLK');"));
       #endif
-      oappend(SET_F("addInfo('AudioReactive:digitalmic:pin[]',4,'','I2C SDA');"));
-      oappend(SET_F("addInfo('AudioReactive:digitalmic:pin[]',5,'','I2C SCL');"));
     }
 
 
@@ -1794,7 +1831,7 @@ class AudioReactive : public Usermod {
      * Use this to blank out some LEDs or set them to a different color regardless of the set effect mode.
      * Commonly used for custom clocks (Cronixie, 7 segment)
      */
-    //void handleOverlayDraw()
+    //void handleOverlayDraw() override
     //{
       //strip.setPixelColor(0, RGBW32(0,0,0,0)) // set the first pixel to black
     //}
@@ -1804,17 +1841,109 @@ class AudioReactive : public Usermod {
      * getId() allows you to optionally give your V2 usermod an unique ID (please define it in const.h!).
      * This could be used in the future for the system to determine whether your usermod is installed.
      */
-    uint16_t getId()
+    uint16_t getId() override
     {
       return USERMOD_ID_AUDIOREACTIVE;
     }
 };
 
+void AudioReactive::removeAudioPalettes(void) {
+  DEBUG_PRINTLN(F("Removing audio palettes."));
+  while (palettes>0) {
+    strip.customPalettes.pop_back();
+    DEBUG_PRINTLN(palettes);
+    palettes--;
+  }
+  DEBUG_PRINT(F("Total # of palettes: ")); DEBUG_PRINTLN(strip.customPalettes.size());
+}
+
+void AudioReactive::createAudioPalettes(void) {
+  DEBUG_PRINT(F("Total # of palettes: ")); DEBUG_PRINTLN(strip.customPalettes.size());
+  if (palettes) return;
+  DEBUG_PRINTLN(F("Adding audio palettes."));
+  for (int i=0; i<MAX_PALETTES; i++)
+    if (strip.customPalettes.size() < 10) {
+      strip.customPalettes.push_back(CRGBPalette16(CRGB(BLACK)));
+      palettes++;
+      DEBUG_PRINTLN(palettes);
+    } else break;
+}
+
+// credit @netmindz ar palette, adapted for usermod @blazoncek
+CRGB AudioReactive::getCRGBForBand(int x, int pal) {
+  CRGB value;
+  CHSV hsv;
+  int b;
+  switch (pal) {
+    case 2:
+      b = map(x, 0, 255, 0, NUM_GEQ_CHANNELS/2); // convert palette position to lower half of freq band
+      hsv = CHSV(fftResult[b], 255, x);
+      hsv2rgb_rainbow(hsv, value);  // convert to R,G,B
+      break;
+    case 1:
+      b = map(x, 1, 255, 0, 10); // convert palette position to lower half of freq band
+      hsv = CHSV(fftResult[b], 255, map(fftResult[b], 0, 255, 30, 255));  // pick hue
+      hsv2rgb_rainbow(hsv, value);  // convert to R,G,B
+      break;
+    default:
+      if (x == 1) {
+        value = CRGB(fftResult[10]/2, fftResult[4]/2, fftResult[0]/2);
+      } else if(x == 255) {
+        value = CRGB(fftResult[10]/2, fftResult[0]/2, fftResult[4]/2);
+      } else {
+        value = CRGB(fftResult[0]/2, fftResult[4]/2, fftResult[10]/2);
+      }
+      break;
+  }
+  return value;
+}
+
+void AudioReactive::fillAudioPalettes() {
+  if (!palettes) return;
+  size_t lastCustPalette = strip.customPalettes.size();
+  if (lastCustPalette >= palettes) lastCustPalette -= palettes;
+  for (size_t pal=0; pal<palettes; pal++) {
+    uint8_t tcp[16];  // Needs to be 4 times however many colors are being used.
+                      // 3 colors = 12, 4 colors = 16, etc.
+
+    tcp[0] = 0;  // anchor of first color - must be zero
+    tcp[1] = 0;
+    tcp[2] = 0;
+    tcp[3] = 0;
+    
+    CRGB rgb = getCRGBForBand(1, pal);
+    tcp[4] = 1;  // anchor of first color
+    tcp[5] = rgb.r;
+    tcp[6] = rgb.g;
+    tcp[7] = rgb.b;
+    
+    rgb = getCRGBForBand(128, pal);
+    tcp[8] = 128;
+    tcp[9] = rgb.r;
+    tcp[10] = rgb.g;
+    tcp[11] = rgb.b;
+    
+    rgb = getCRGBForBand(255, pal);
+    tcp[12] = 255;  // anchor of last color - must be 255
+    tcp[13] = rgb.r;
+    tcp[14] = rgb.g;
+    tcp[15] = rgb.b;
+
+    strip.customPalettes[lastCustPalette+pal].loadDynamicGradientPalette(tcp);
+  }
+}
+
 // strings to reduce flash memory usage (used more than twice)
 const char AudioReactive::_name[]       PROGMEM = "AudioReactive";
 const char AudioReactive::_enabled[]    PROGMEM = "enabled";
+const char AudioReactive::_config[]     PROGMEM = "config";
+const char AudioReactive::_dynamics[]   PROGMEM = "dynamics";
+const char AudioReactive::_frequency[]  PROGMEM = "frequency";
 const char AudioReactive::_inputLvl[]   PROGMEM = "inputLevel";
+#if defined(ARDUINO_ARCH_ESP32) && !defined(CONFIG_IDF_TARGET_ESP32S2) && !defined(CONFIG_IDF_TARGET_ESP32C3) && !defined(CONFIG_IDF_TARGET_ESP32S3)
 const char AudioReactive::_analogmic[]  PROGMEM = "analogmic";
+#endif
 const char AudioReactive::_digitalmic[] PROGMEM = "digitalmic";
+const char AudioReactive::_addPalettes[]       PROGMEM = "add-palettes";
 const char AudioReactive::UDP_SYNC_HEADER[]    PROGMEM = "00002"; // new sync header version, as format no longer compatible with previous structure
 const char AudioReactive::UDP_SYNC_HEADER_v1[] PROGMEM = "00001"; // old sync header version - need to add backwards-compatibility feature

usermods/audioreactive/audio_source.h

@@ -1,6 +1,5 @@
 #pragma once
-
-#include <Wire.h>
+#ifdef ARDUINO_ARCH_ESP32
 #include "wled.h"
 #include <driver/i2s.h>
 #include <driver/adc.h>
@@ -23,14 +22,14 @@
 
 // see https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/hw-reference/chip-series-comparison.html#related-documents
 // and https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/api-reference/peripherals/i2s.html#overview-of-all-modes
-#if defined(CONFIG_IDF_TARGET_ESP32C2) || defined(CONFIG_IDF_TARGET_ESP32C3) || defined(CONFIG_IDF_TARGET_ESP32S2) || defined(CONFIG_IDF_TARGET_ESP32C5) || defined(CONFIG_IDF_TARGET_ESP32C6) || defined(CONFIG_IDF_TARGET_ESP32H2) || defined(ESP8266) || defined(ESP8265)
+#if defined(CONFIG_IDF_TARGET_ESP32C2) || defined(CONFIG_IDF_TARGET_ESP32C3) || defined(CONFIG_IDF_TARGET_ESP32C5) || defined(CONFIG_IDF_TARGET_ESP32C6) || defined(CONFIG_IDF_TARGET_ESP32H2) || defined(ESP8266) || defined(ESP8265)
   // there are two things in these MCUs that could lead to problems with audio processing:
   // * no floating point hardware (FPU) support - FFT uses float calculations. If done in software, a strong slow-down can be expected (between 8x and 20x)
   // * single core, so FFT task might slow down other things like LED updates
   #if !defined(SOC_I2S_NUM) || (SOC_I2S_NUM < 1)
-  #error This audio reactive usermod does not support ESP32-C2, ESP32-C3 or ESP32-S2.
+  #error This audio reactive usermod does not support ESP32-C2 or ESP32-C3.
   #else
-  #warning This audio reactive usermod does not support ESP32-C2, ESP32-C3 or ESP32-S2.
+  #warning This audio reactive usermod does not support ESP32-C2 and ESP32-C3.
   #endif
 #endif
 
@@ -45,7 +44,7 @@
 // benefit: analog mic inputs will be sampled contiously -> better response times and less "glitches"
 // WARNING: this option WILL lock-up your device in case that any other analogRead() operation is performed; 
 //          for example if you want to read "analog buttons"
-//#define I2S_GRAB_ADC1_COMPLETELY // (experimental) continously sample analog ADC microphone. WARNING will cause analogRead() lock-up
+//#define I2S_GRAB_ADC1_COMPLETELY // (experimental) continuously sample analog ADC microphone. WARNING will cause analogRead() lock-up
 
 // data type requested from the I2S driver - currently we always use 32bit
 //#define I2S_USE_16BIT_SAMPLES   // (experimental) define this to request 16bit - more efficient but possibly less compatible
@@ -72,7 +71,7 @@
  * if you want to receive two channels, one is the actual data from microphone and another channel is suppose to receive 0, it's different data in two channels, you need to choose I2S_CHANNEL_FMT_RIGHT_LEFT in this case.
 */
 
-#if (ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 4, 0)) && (ESP_IDF_VERSION <= ESP_IDF_VERSION_VAL(4, 4, 3))
+#if (ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 4, 0)) && (ESP_IDF_VERSION <= ESP_IDF_VERSION_VAL(4, 4, 4))
 // espressif bug: only_left has no sound, left and right are swapped 
 // https://github.com/espressif/esp-idf/issues/9635  I2S mic not working since 4.4 (IDFGH-8138)
 // https://github.com/espressif/esp-idf/issues/8538  I2S channel selection issue? (IDFGH-6918)
@@ -123,7 +122,7 @@ class AudioSource {
        This function needs to take care of anything that needs to be done
        before samples can be obtained from the microphone.
     */
-    virtual void initialize(int8_t = I2S_PIN_NO_CHANGE, int8_t = I2S_PIN_NO_CHANGE, int8_t = I2S_PIN_NO_CHANGE, int8_t = I2S_PIN_NO_CHANGE, int8_t = I2S_PIN_NO_CHANGE, int8_t = I2S_PIN_NO_CHANGE) = 0;
+    virtual void initialize(int8_t = I2S_PIN_NO_CHANGE, int8_t = I2S_PIN_NO_CHANGE, int8_t = I2S_PIN_NO_CHANGE, int8_t = I2S_PIN_NO_CHANGE) = 0;
 
     /* Deinitialize
        Release all resources and deactivate any functionality that is used
@@ -192,7 +191,8 @@ class I2SSource : public AudioSource {
       };
     }
 
-    virtual void initialize(int8_t i2swsPin = I2S_PIN_NO_CHANGE, int8_t i2ssdPin = I2S_PIN_NO_CHANGE, int8_t i2sckPin = I2S_PIN_NO_CHANGE, int8_t mclkPin = I2S_PIN_NO_CHANGE, int8_t = I2S_PIN_NO_CHANGE, int8_t = I2S_PIN_NO_CHANGE) {
+    virtual void initialize(int8_t i2swsPin = I2S_PIN_NO_CHANGE, int8_t i2ssdPin = I2S_PIN_NO_CHANGE, int8_t i2sckPin = I2S_PIN_NO_CHANGE, int8_t mclkPin = I2S_PIN_NO_CHANGE) {
+      DEBUGSR_PRINTLN(F("I2SSource:: initialize()."));
       if (i2swsPin != I2S_PIN_NO_CHANGE && i2ssdPin != I2S_PIN_NO_CHANGE) {
         if (!pinManager.allocatePin(i2swsPin, true, PinOwner::UM_Audioreactive) ||
             !pinManager.allocatePin(i2ssdPin, false, PinOwner::UM_Audioreactive)) { // #206
@@ -378,26 +378,17 @@ class I2SSource : public AudioSource {
 };
 
 /* ES7243 Microphone
-   This is an I2S microphone that requires ininitialization over
+   This is an I2S microphone that requires initialization over
    I2C before I2S data can be received
 */
 class ES7243 : public I2SSource {
   private:
-    // I2C initialization functions for ES7243
-    void _es7243I2cBegin() {
-      bool i2c_initialized = Wire.begin(pin_ES7243_SDA, pin_ES7243_SCL, 100000U);
-      if (i2c_initialized == false) {
-        DEBUGSR_PRINTLN(F("AR: ES7243 failed to initialize I2C bus driver."));
-      }
-    }
 
     void _es7243I2cWrite(uint8_t reg, uint8_t val) {
-#ifndef ES7243_ADDR
-      Wire.beginTransmission(0x13);
-      #define ES7243_ADDR 0x13   // default address
-#else
+      #ifndef ES7243_ADDR
+        #define ES7243_ADDR 0x13   // default address
+      #endif
       Wire.beginTransmission(ES7243_ADDR);
-#endif
       Wire.write((uint8_t)reg);
       Wire.write((uint8_t)val);
       uint8_t i2cErr = Wire.endTransmission();  // i2cErr == 0 means OK
@@ -407,7 +398,6 @@ class ES7243 : public I2SSource {
     }
 
     void _es7243InitAdc() {
-      _es7243I2cBegin();
       _es7243I2cWrite(0x00, 0x01);
       _es7243I2cWrite(0x06, 0x00);
       _es7243I2cWrite(0x05, 0x1B);
@@ -422,47 +412,140 @@ public:
       _config.channel_format = I2S_CHANNEL_FMT_ONLY_RIGHT;
     };
 
-    void initialize(int8_t sdaPin, int8_t sclPin, int8_t i2swsPin, int8_t i2ssdPin, int8_t i2sckPin, int8_t mclkPin) {
-      // check that pins are valid
-      if ((sdaPin < 0) || (sclPin < 0)) {
-        DEBUGSR_PRINTF("\nAR: invalid ES7243 I2C pins: SDA=%d, SCL=%d\n", sdaPin, sclPin); 
-        return;
-      }
-
+    void initialize(int8_t i2swsPin, int8_t i2ssdPin, int8_t i2sckPin, int8_t mclkPin) {
+      DEBUGSR_PRINTLN(F("ES7243:: initialize();"));
       if ((i2sckPin < 0) || (mclkPin < 0)) {
         DEBUGSR_PRINTF("\nAR: invalid I2S pin: SCK=%d, MCLK=%d\n", i2sckPin, mclkPin); 
         return;
       }
 
-      // Reserve SDA and SCL pins of the I2C interface
-      PinManagerPinType es7243Pins[2] = { { sdaPin, true }, { sclPin, true } };
-      if (!pinManager.allocateMultiplePins(es7243Pins, 2, PinOwner::HW_I2C)) {
-        pinManager.deallocateMultiplePins(es7243Pins, 2, PinOwner::HW_I2C);
-        DEBUGSR_PRINTF("\nAR: Failed to allocate ES7243 I2C pins: SDA=%d, SCL=%d\n", sdaPin, sclPin); 
-        return;
-      }
-
-      pin_ES7243_SDA = sdaPin;
-      pin_ES7243_SCL = sclPin;
-
       // First route mclk, then configure ADC over I2C, then configure I2S
       _es7243InitAdc();
       I2SSource::initialize(i2swsPin, i2ssdPin, i2sckPin, mclkPin);
     }
 
     void deinitialize() {
-      // Release SDA and SCL pins of the I2C interface
-      PinManagerPinType es7243Pins[2] = { { pin_ES7243_SDA, true }, { pin_ES7243_SCL, true } };
-      pinManager.deallocateMultiplePins(es7243Pins, 2, PinOwner::HW_I2C);
+      I2SSource::deinitialize();
+    }
+};
+
+/* ES8388 Sound Module
+   This is an I2S sound processing unit that requires initialization over
+   I2C before I2S data can be received. 
+*/
+class ES8388Source : public I2SSource {
+  private:
+
+    void _es8388I2cWrite(uint8_t reg, uint8_t val) {
+#ifndef ES8388_ADDR
+      Wire.beginTransmission(0x10);
+      #define ES8388_ADDR 0x10   // default address
+#else
+      Wire.beginTransmission(ES8388_ADDR);
+#endif
+      Wire.write((uint8_t)reg);
+      Wire.write((uint8_t)val);
+      uint8_t i2cErr = Wire.endTransmission();  // i2cErr == 0 means OK
+      if (i2cErr != 0) {
+        DEBUGSR_PRINTF("AR: ES8388 I2C write failed with error=%d  (addr=0x%X, reg 0x%X, val 0x%X).\n", i2cErr, ES8388_ADDR, reg, val);
+      }
+    }
+
+    void _es8388InitAdc() {
+      // https://dl.radxa.com/rock2/docs/hw/ds/ES8388%20user%20Guide.pdf Section 10.1
+      // http://www.everest-semi.com/pdf/ES8388%20DS.pdf Better spec sheet, more clear. 
+      // https://docs.google.com/spreadsheets/d/1CN3MvhkcPVESuxKyx1xRYqfUit5hOdsG45St9BCUm-g/edit#gid=0 generally
+      // Sets ADC to around what AudioReactive expects, and loops line-in to line-out/headphone for monitoring.
+      // Registries are decimal, settings are binary as that's how everything is listed in the docs
+      // ...which makes it easier to reference the docs.
+      //
+      _es8388I2cWrite( 8,0b00000000); // I2S to slave
+      _es8388I2cWrite( 2,0b11110011); // Power down DEM and STM
+      _es8388I2cWrite(43,0b10000000); // Set same LRCK
+      _es8388I2cWrite( 0,0b00000101); // Set chip to Play & Record Mode
+      _es8388I2cWrite(13,0b00000010); // Set MCLK/LRCK ratio to 256
+      _es8388I2cWrite( 1,0b01000000); // Power up analog and lbias
+      _es8388I2cWrite( 3,0b00000000); // Power up ADC, Analog Input, and Mic Bias
+      _es8388I2cWrite( 4,0b11111100); // Power down DAC, Turn on LOUT1 and ROUT1 and LOUT2 and ROUT2 power
+      _es8388I2cWrite( 2,0b01000000); // Power up DEM and STM and undocumented bit for "turn on line-out amp"
+
+      // #define use_es8388_mic
+
+    #ifdef use_es8388_mic
+      // The mics *and* line-in are BOTH connected to LIN2/RIN2 on the AudioKit
+      // so there's no way to completely eliminate the mics. It's also hella noisy. 
+      // Line-in works OK on the AudioKit, generally speaking, as the mics really need
+      // amplification to be noticeable in a quiet room. If you're in a very loud room, 
+      // the mics on the AudioKit WILL pick up sound even in line-in mode. 
+      // TL;DR: Don't use the AudioKit for anything, use the LyraT. 
+      //
+      // The LyraT does a reasonable job with mic input as configured below.
+
+      // Pick one of these. If you have to use the mics, use a LyraT over an AudioKit if you can:
+      _es8388I2cWrite(10,0b00000000); // Use Lin1/Rin1 for ADC input (mic on LyraT)
+      //_es8388I2cWrite(10,0b01010000); // Use Lin2/Rin2 for ADC input (mic *and* line-in on AudioKit)
+      
+      _es8388I2cWrite( 9,0b10001000); // Select Analog Input PGA Gain for ADC to +24dB (L+R)
+      _es8388I2cWrite(16,0b00000000); // Set ADC digital volume attenuation to 0dB (left)
+      _es8388I2cWrite(17,0b00000000); // Set ADC digital volume attenuation to 0dB (right)
+      _es8388I2cWrite(38,0b00011011); // Mixer - route LIN1/RIN1 to output after mic gain
+
+      _es8388I2cWrite(39,0b01000000); // Mixer - route LIN to mixL, +6dB gain
+      _es8388I2cWrite(42,0b01000000); // Mixer - route RIN to mixR, +6dB gain
+      _es8388I2cWrite(46,0b00100001); // LOUT1VOL - 0b00100001 = +4.5dB
+      _es8388I2cWrite(47,0b00100001); // ROUT1VOL - 0b00100001 = +4.5dB
+      _es8388I2cWrite(48,0b00100001); // LOUT2VOL - 0b00100001 = +4.5dB
+      _es8388I2cWrite(49,0b00100001); // ROUT2VOL - 0b00100001 = +4.5dB
+
+      // Music ALC - the mics like Auto Level Control
+      // You can also use this for line-in, but it's not really needed.
+      //
+      _es8388I2cWrite(18,0b11111000); // ALC: stereo, max gain +35.5dB, min gain -12dB 
+      _es8388I2cWrite(19,0b00110000); // ALC: target -1.5dB, 0ms hold time
+      _es8388I2cWrite(20,0b10100110); // ALC: gain ramp up = 420ms/93ms, gain ramp down = check manual for calc
+      _es8388I2cWrite(21,0b00000110); // ALC: use "ALC" mode, no zero-cross, window 96 samples
+      _es8388I2cWrite(22,0b01011001); // ALC: noise gate threshold, PGA gain constant, noise gate enabled 
+    #else
+      _es8388I2cWrite(10,0b01010000); // Use Lin2/Rin2 for ADC input ("line-in")
+      _es8388I2cWrite( 9,0b00000000); // Select Analog Input PGA Gain for ADC to 0dB (L+R)
+      _es8388I2cWrite(16,0b01000000); // Set ADC digital volume attenuation to -32dB (left)
+      _es8388I2cWrite(17,0b01000000); // Set ADC digital volume attenuation to -32dB (right)
+      _es8388I2cWrite(38,0b00001001); // Mixer - route LIN2/RIN2 to output
+
+      _es8388I2cWrite(39,0b01010000); // Mixer - route LIN to mixL, 0dB gain
+      _es8388I2cWrite(42,0b01010000); // Mixer - route RIN to mixR, 0dB gain
+      _es8388I2cWrite(46,0b00011011); // LOUT1VOL - 0b00011110 = +0dB, 0b00011011 = LyraT balance fix
+      _es8388I2cWrite(47,0b00011110); // ROUT1VOL - 0b00011110 = +0dB
+      _es8388I2cWrite(48,0b00011110); // LOUT2VOL - 0b00011110 = +0dB
+      _es8388I2cWrite(49,0b00011110); // ROUT2VOL - 0b00011110 = +0dB
+    #endif
+
+    }
+
+  public:
+    ES8388Source(SRate_t sampleRate, int blockSize, float sampleScale = 1.0f, bool i2sMaster=true) :
+      I2SSource(sampleRate, blockSize, sampleScale) {
+      _config.channel_format = I2S_CHANNEL_FMT_ONLY_LEFT;
+    };
+
+    void initialize(int8_t i2swsPin, int8_t i2ssdPin, int8_t i2sckPin, int8_t mclkPin) {
+      DEBUGSR_PRINTLN(F("ES8388Source:: initialize();"));
+      if ((i2sckPin < 0) || (mclkPin < 0)) {
+        DEBUGSR_PRINTF("\nAR: invalid I2S pin: SCK=%d, MCLK=%d\n", i2sckPin, mclkPin); 
+        return;
+      }
+
+      // First route mclk, then configure ADC over I2C, then configure I2S
+      _es8388InitAdc();
+      I2SSource::initialize(i2swsPin, i2ssdPin, i2sckPin, mclkPin);
+    }
+
+    void deinitialize() {
       I2SSource::deinitialize();
     }
 
-  private:
-    int8_t pin_ES7243_SDA;
-    int8_t pin_ES7243_SCL;
 };
 
-
 #if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(4, 2, 0)
 #if !defined(SOC_I2S_SUPPORTS_ADC) && !defined(SOC_I2S_SUPPORTS_ADC_DAC)
   #warning this MCU does not support analog sound input
@@ -503,7 +586,8 @@ class I2SAdcSource : public I2SSource {
     /* identify Audiosource type - I2S-ADC*/
     AudioSourceType getType(void) {return(Type_I2SAdc);}
 
-    void initialize(int8_t audioPin, int8_t = I2S_PIN_NO_CHANGE, int8_t = I2S_PIN_NO_CHANGE, int8_t = I2S_PIN_NO_CHANGE, int8_t = I2S_PIN_NO_CHANGE, int8_t = I2S_PIN_NO_CHANGE) {
+    void initialize(int8_t audioPin, int8_t = I2S_PIN_NO_CHANGE, int8_t = I2S_PIN_NO_CHANGE, int8_t = I2S_PIN_NO_CHANGE) {
+      DEBUGSR_PRINTLN(F("I2SAdcSource:: initialize()."));
       _myADCchannel = 0x0F;
       if(!pinManager.allocatePin(audioPin, false, PinOwner::UM_Audioreactive)) {
          DEBUGSR_PRINTF("failed to allocate GPIO for audio analog input: %d\n", audioPin);
@@ -674,7 +758,8 @@ class SPH0654 : public I2SSource {
       I2SSource(sampleRate, blockSize, sampleScale)
     {}
 
-    void initialize(uint8_t i2swsPin, uint8_t i2ssdPin, uint8_t i2sckPin, int8_t = I2S_PIN_NO_CHANGE, int8_t = I2S_PIN_NO_CHANGE, int8_t = I2S_PIN_NO_CHANGE) {
+    void initialize(int8_t i2swsPin, int8_t i2ssdPin, int8_t i2sckPin, int8_t = I2S_PIN_NO_CHANGE) {
+      DEBUGSR_PRINTLN(F("SPH0654:: initialize();"));
       I2SSource::initialize(i2swsPin, i2ssdPin, i2sckPin);
 #if !defined(CONFIG_IDF_TARGET_ESP32S2) && !defined(CONFIG_IDF_TARGET_ESP32C3) && !defined(CONFIG_IDF_TARGET_ESP32S3)
 // these registers are only existing in "classic" ESP32
@@ -685,3 +770,4 @@ class SPH0654 : public I2SSource {
 #endif
     }
 };
+#endif

usermods/audioreactive/readme.md

@@ -1,6 +1,6 @@
 # Audioreactive usermod
 
-Enabless controlling LEDs via audio input. Audio source can be a microphone or analog-in (AUX) using an appropriate adapter.
+Enables controlling LEDs via audio input. Audio source can be a microphone or analog-in (AUX) using an appropriate adapter.
 Supported microphones range from analog (MAX4466, MAX9814, ...) to digital (INMP441, ICS-43434, ...).
 
 Does audio processing and provides data structure that specially written effects can use.
@@ -19,7 +19,7 @@ This usermod is an evolution of [SR-WLED](https://github.com/atuline/WLED), and
 ## Supported MCUs
 This audioreactive usermod works best on "classic ESP32" (dual core), and on ESP32-S3 which also has dual core and hardware floating point support. 
 
-It will compile succesfully for ESP32-S2 and ESP32-C3, however might not work well, as other WLED functions will become slow. Audio processing requires a lot of computing power, which can be problematic on smaller MCUs like -S2 and -C3. 
+It will compile successfully for ESP32-S2 and ESP32-C3, however might not work well, as other WLED functions will become slow. Audio processing requires a lot of computing power, which can be problematic on smaller MCUs like -S2 and -C3. 
 
 Analog audio is only possible on "classic" ESP32, but not on other MCUs like ESP32-S3.
 
@@ -35,7 +35,7 @@ Customised _arduinoFFT_ library for use with this usermod can be found at https:
 
 ### using latest (develop) _arduinoFFT_ library
 Alternatively, you can use the latest arduinoFFT development version.
-ArduinoFFT `develop` library is slightly more accurate, and slighly faster than our customised library, however also needs additional 2kB RAM.
+ArduinoFFT `develop` library is slightly more accurate, and slightly faster than our customised library, however also needs additional 2kB RAM.
 
 * `build_flags` = `-D USERMOD_AUDIOREACTIVE` `-D UM_AUDIOREACTIVE_USE_NEW_FFT`
 * `lib_deps`= `https://github.com/kosme/arduinoFFT#develop @ 1.9.2`
@@ -55,6 +55,11 @@ If you want to define default GPIOs during compile time, use the following (defa
 - `-D ES7243_SDAPIN` : GPIO for I2C SDA pin on ES7243 microphone (-1)
 - `-D ES7243_SCLPIN` : GPIO for I2C SCL pin on ES7243 microphone (-1)
 
+Other options:
+
+- `-D UM_AUDIOREACTIVE_ENABLE` : makes usermod default enabled (not the same as include into build option!)
+- `-D UM_AUDIOREACTIVE_DYNAMICS_LIMITER_OFF` : disables rise/fall limiter default
+
 **NOTE** I2S is used for analog audio sampling. Hence, the analog *buttons* (i.e. potentiometers) are disabled when running this usermod with an analog microphone.
 
 ### Advanced Compile-Time Options
@@ -63,7 +68,7 @@ You can use the following additional flags in your `build_flags`
 * `-D SR_GAIN=x`     : Default "gain" setting (60)
 * `-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_GRAB_ADC1_COMPLETELY`: Experimental: continously sample analog ADC microphone. Only effective on ESP32. WARNING this _will_ cause conflicts(lock-up) with any analogRead() call.
+* `-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/battery_status_basic/readme.md

@@ -1,68 +0,0 @@
-# :battery: Battery status/level Usermod :battery:
-Enables battery level monitoring of your project.
-
-You can see the battery level and voltage in the `info modal`. 
-
-For this to work, the positive side of the (18650) battery must be connected to pin `A0` of the d1 mini/esp8266 with a 100k Ohm resistor (see [Useful Links](#useful-links)).
-
-If you have an ESP32 board, connect the positive side of the battery to ADC1 (GPIO32 - GPIO39)
-
-<p align="center">
-  <img width="300" src="assets/battery_info_screen.png">
-</p>
-
-## Installation
-
-define `USERMOD_BATTERY_STATUS_BASIC` in `my_config.h`
-
-### Basic wiring diagram
-<p align="center">
-  <img width="300" src="assets/battery_connection_schematic_01.png">
-</p>
-
-### Define Your Options
-
-* `USERMOD_BATTERY_STATUS_BASIC`                   - define this (in `my_config.h`) to have this usermod included wled00\usermods_list.cpp
-* `USERMOD_BATTERY_MEASUREMENT_PIN`                - defaults to A0 on ESP8266 and GPIO32 on ESP32
-* `USERMOD_BATTERY_MEASUREMENT_INTERVAL`           - battery check interval. defaults to 30 seconds
-* `USERMOD_BATTERY_MIN_VOLTAGE`                    - minimum battery voltage. default is 2.6 (18650 battery standard)
-* `USERMOD_BATTERY_MAX_VOLTAGE`                    - maximum battery voltage. default is 4.2 (18650 battery standard)
-
-All parameters can be configured at runtime via the Usermods settings page.
-
-## Important :warning:
-* Make sure you know your battery specifications! All batteries are **NOT** the same!
-* Example:
-
-| Your battery specification table  |                 | Options you can define        | 
-| :-------------------------------- |:--------------- | :---------------------------- |
-| Capacity                          | 3500mAh 12,5 Wh |                               |
-| Minimum capacity                  | 3350mAh 11,9 Wh |                               |
-| Rated voltage                     | 3.6V - 3.7V     |                               |
-| **Charging end voltage**          | **4,2V ± 0,05** | `USERMOD_BATTERY_MAX_VOLTAGE` |
-| **Discharge voltage**             | **2,5V**        | `USERMOD_BATTERY_MIN_VOLTAGE` |
-| Max. discharge current (constant) | 10A (10000mA)   |                               |
-| max. charging current             | 1.7A (1700mA)   |                               |
-| ...                               | ...             | ...                           |
-| ..                                | ..              | ..                            |
-
-Specification from:  [Molicel INR18650-M35A, 3500mAh 10A Lithium-ion battery, 3.6V - 3.7V](https://www.akkuteile.de/lithium-ionen-akkus/18650/molicel/molicel-inr18650-m35a-3500mah-10a-lithium-ionen-akku-3-6v-3-7v_100833)
-
-## Useful Links
-* https://lazyzero.de/elektronik/esp8266/wemos_d1_mini_a0/start
-* https://arduinodiy.wordpress.com/2016/12/25/monitoring-lipo-battery-voltage-with-wemos-d1-minibattery-shield-and-thingspeak/
-
-## Change Log
-2021-09-02
-* added "Battery voltage" to info
-* added circuit diagram to readme
-* added MQTT support, sending battery voltage
-* minor fixes
-
-2021-08-15
-* changed `USERMOD_BATTERY_MIN_VOLTAGE` to 2.6 volt as default for 18650 batteries
-* Updated readme, added specification table
-
-2021-08-10
-* Created
-

usermods/battery_status_basic/usermod_v2_battery_status_basic.h

@@ -1,398 +0,0 @@
-#pragma once
-
-#include "wled.h"
-
-
-
-
-// pin defaults
-// for the esp32 it is best to use the ADC1: GPIO32 - GPIO39
-// https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/peripherals/adc.html
-#ifndef USERMOD_BATTERY_MEASUREMENT_PIN
-  #ifdef ARDUINO_ARCH_ESP32
-    #define USERMOD_BATTERY_MEASUREMENT_PIN 32
-  #else //ESP8266 boards
-    #define USERMOD_BATTERY_MEASUREMENT_PIN A0
-  #endif
-#endif
-
-// esp32 has a 12bit adc resolution
-// esp8266 only 10bit
-#ifndef USERMOD_BATTERY_ADC_PRECISION
-  #ifdef ARDUINO_ARCH_ESP32
-    // 12 bits
-    #define USERMOD_BATTERY_ADC_PRECISION 4095.0f
-  #else
-    // 10 bits
-    #define USERMOD_BATTERY_ADC_PRECISION 1024.0f
-  #endif
-#endif
-
-
-// the frequency to check the battery, 30 sec
-#ifndef USERMOD_BATTERY_MEASUREMENT_INTERVAL
-  #define USERMOD_BATTERY_MEASUREMENT_INTERVAL 30000
-#endif
-
-
-// default for 18650 battery
-// https://batterybro.com/blogs/18650-wholesale-battery-reviews/18852515-when-to-recycle-18650-batteries-and-how-to-start-a-collection-center-in-your-vape-shop
-// Discharge voltage: 2.5 volt + .1 for personal safety
-#ifndef USERMOD_BATTERY_MIN_VOLTAGE
-  #define USERMOD_BATTERY_MIN_VOLTAGE 2.6f
-#endif
-
-#ifndef USERMOD_BATTERY_MAX_VOLTAGE
-  #define USERMOD_BATTERY_MAX_VOLTAGE 4.2f
-#endif
-
-class UsermodBatteryBasic : public Usermod 
-{
-  private:
-    // battery pin can be defined in my_config.h
-    int8_t batteryPin = USERMOD_BATTERY_MEASUREMENT_PIN;
-    // how often to read the battery voltage
-    unsigned long readingInterval = USERMOD_BATTERY_MEASUREMENT_INTERVAL;
-    unsigned long nextReadTime = 0;
-    unsigned long lastReadTime = 0;
-    // battery min. voltage
-    float minBatteryVoltage = USERMOD_BATTERY_MIN_VOLTAGE;
-    // battery max. voltage
-    float maxBatteryVoltage = USERMOD_BATTERY_MAX_VOLTAGE;
-    // 0 - 1024 for esp8266 (10-bit resolution)
-    // 0 - 4095 for esp32 (Default is 12-bit resolution)
-    float adcPrecision = USERMOD_BATTERY_ADC_PRECISION;
-    // raw analog reading 
-    float rawValue = 0.0;
-    // calculated voltage            
-    float voltage = 0.0;
-    // mapped battery level based on voltage
-    long batteryLevel = 0;
-    bool initDone = false;
-    bool initializing = true;
-
-
-    // strings to reduce flash memory usage (used more than twice)
-    static const char _name[];
-    static const char _readInterval[];
-    
-
-    // custom map function
-    // https://forum.arduino.cc/t/floating-point-using-map-function/348113/2
-    double mapf(double x, double in_min, double in_max, double out_min, double out_max) 
-    {
-      return (x - in_min) * (out_max - out_min) / (in_max - in_min) + out_min;
-    }
-
-    float truncate(float val, byte dec) 
-    {
-      float x = val * pow(10, dec);
-      float y = round(x);
-      float z = x - y;
-      if ((int)z == 5)
-      {
-          y++;
-      }
-      x = y / pow(10, dec);
-      return x;
-    }
-
-
-
-  public:
-    //Functions called by WLED
-
-    /*
-     * setup() is called once at boot. WiFi is not yet connected at this point.
-     * You can use it to initialize variables, sensors or similar.
-     */
-    void setup() 
-    {
-      #ifdef ARDUINO_ARCH_ESP32
-        DEBUG_PRINTLN(F("Allocating battery pin..."));
-        if (batteryPin >= 0 && pinManager.allocatePin(batteryPin, false)) 
-        {
-          DEBUG_PRINTLN(F("Battery pin allocation succeeded."));
-        } else {
-          if (batteryPin >= 0) DEBUG_PRINTLN(F("Battery pin allocation failed."));
-          batteryPin = -1;  // allocation failed
-        }
-      #else //ESP8266 boards have only one analog input pin A0
-
-        pinMode(batteryPin, INPUT);
-      #endif
-
-      nextReadTime = millis() + readingInterval;
-      lastReadTime = millis();
-
-      initDone = true;
-    }
-
-
-    /*
-     * connected() is called every time the WiFi is (re)connected
-     * Use it to initialize network interfaces
-     */
-    void connected() 
-    {
-      //Serial.println("Connected to WiFi!");
-    }
-
-
-    /*
-     * loop() is called continuously. Here you can check for events, read sensors, etc.
-     * 
-     */
-    void loop() 
-    {
-      if(strip.isUpdating()) return;
-
-      // check the battery level every USERMOD_BATTERY_MEASUREMENT_INTERVAL (ms)
-      if (millis() < nextReadTime) return;
-
-
-      nextReadTime = millis() + readingInterval;
-      lastReadTime = millis();
-      initializing = false;
-
-      // read battery raw input
-      rawValue = analogRead(batteryPin);
-
-      // calculate the voltage     
-      voltage = (rawValue / adcPrecision) * maxBatteryVoltage ;
-      // check if voltage is within specified voltage range
-      voltage = voltage<minBatteryVoltage||voltage>maxBatteryVoltage?-1.0f:voltage;
-
-      // translate battery voltage into percentage
-      /*
-        the standard "map" function doesn't work
-        https://www.arduino.cc/reference/en/language/functions/math/map/  notes and warnings at the bottom
-      */
-      batteryLevel = mapf(voltage, minBatteryVoltage, maxBatteryVoltage, 0, 100);
-
-
-      // SmartHome stuff
-      if (WLED_MQTT_CONNECTED) {
-        char subuf[64];
-        strcpy(subuf, mqttDeviceTopic);
-        strcat_P(subuf, PSTR("/voltage"));
-        mqtt->publish(subuf, 0, false, String(voltage).c_str());
-      }
-
-    }
-
-
-    /*
-     * addToJsonInfo() can be used to add custom entries to the /json/info part of the JSON API.
-     * Creating an "u" object allows you to add custom key/value pairs to the Info section of the WLED web UI.
-     * Below it is shown how this could be used for e.g. a light sensor
-     */
-    void addToJsonInfo(JsonObject& root)
-    {
-      
-      JsonObject user = root["u"];
-      if (user.isNull()) user = root.createNestedObject("u");
-
-      // info modal display names
-      JsonArray batteryPercentage = user.createNestedArray("Battery level");
-      JsonArray batteryVoltage = user.createNestedArray("Battery voltage");
-
-      if (initializing) {
-        batteryPercentage.add((nextReadTime - millis()) / 1000);
-        batteryPercentage.add(" sec");
-        batteryVoltage.add((nextReadTime - millis()) / 1000);
-        batteryVoltage.add(" sec");
-        return;
-      }
-
-      if(batteryLevel < 0) {
-        batteryPercentage.add(F("invalid"));
-      } else {
-        batteryPercentage.add(batteryLevel);
-      }
-      batteryPercentage.add(F(" %"));
-
-      if(voltage < 0) {
-        batteryVoltage.add(F("invalid"));
-      } else {
-        batteryVoltage.add(truncate(voltage, 2));
-      }
-      batteryVoltage.add(F(" V"));
-    }
-
-
-    /*
-     * addToJsonState() can be used to add custom entries to the /json/state part of the JSON API (state object).
-     * Values in the state object may be modified by connected clients
-     */
-    /*
-    void addToJsonState(JsonObject& root)
-    {
-
-    }
-    */
-
-
-    /*
-     * readFromJsonState() can be used to receive data clients send to the /json/state part of the JSON API (state object).
-     * Values in the state object may be modified by connected clients
-     */
-    /*
-    void readFromJsonState(JsonObject& root)
-    {
-    }
-    */
-
-
-    /*
-     * addToConfig() can be used to add custom persistent settings to the cfg.json file in the "um" (usermod) object.
-     * It will be called by WLED when settings are actually saved (for example, LED settings are saved)
-     * If you want to force saving the current state, use serializeConfig() in your loop().
-     * 
-     * CAUTION: serializeConfig() will initiate a filesystem write operation.
-     * It might cause the LEDs to stutter and will cause flash wear if called too often.
-     * Use it sparingly and always in the loop, never in network callbacks!
-     * 
-     * addToConfig() will make your settings editable through the Usermod Settings page automatically.
-     *
-     * Usermod Settings Overview:
-     * - Numeric values are treated as floats in the browser.
-     *   - If the numeric value entered into the browser contains a decimal point, it will be parsed as a C float
-     *     before being returned to the Usermod.  The float data type has only 6-7 decimal digits of precision, and
-     *     doubles are not supported, numbers will be rounded to the nearest float value when being parsed.
-     *     The range accepted by the input field is +/- 1.175494351e-38 to +/- 3.402823466e+38.
-     *   - If the numeric value entered into the browser doesn't contain a decimal point, it will be parsed as a
-     *     C int32_t (range: -2147483648 to 2147483647) before being returned to the usermod.
-     *     Overflows or underflows are truncated to the max/min value for an int32_t, and again truncated to the type
-     *     used in the Usermod when reading the value from ArduinoJson.
-     * - Pin values can be treated differently from an integer value by using the key name "pin"
-     *   - "pin" can contain a single or array of integer values
-     *   - On the Usermod Settings page there is simple checking for pin conflicts and warnings for special pins
-     *     - Red color indicates a conflict.  Yellow color indicates a pin with a warning (e.g. an input-only pin)
-     *   - Tip: use int8_t to store the pin value in the Usermod, so a -1 value (pin not set) can be used
-     *
-     * See usermod_v2_auto_save.h for an example that saves Flash space by reusing ArduinoJson key name strings
-     * 
-     * If you need a dedicated settings page with custom layout for your Usermod, that takes a lot more work.  
-     * You will have to add the setting to the HTML, xml.cpp and set.cpp manually.
-     * See the WLED Soundreactive fork (code and wiki) for reference.  https://github.com/atuline/WLED
-     * 
-     * I highly recommend checking out the basics of ArduinoJson serialization and deserialization in order to use custom settings!
-     */
-    void addToConfig(JsonObject& root)
-    {
-      // created JSON object: 
-      /*
-      {
-        "Battery-Level": {
-          "pin": "A0",              <--- only when using esp32 boards
-          "minBatteryVoltage": 2.6, 
-          "maxBatteryVoltage": 4.2,
-          "read-interval-ms": 30000  
-        }
-      }
-      */ 
-      JsonObject battery = root.createNestedObject(FPSTR(_name)); // usermodname
-      #ifdef ARDUINO_ARCH_ESP32
-        battery["pin"] = batteryPin;                              // usermodparam
-      #endif
-      battery["minBatteryVoltage"] = minBatteryVoltage;           // usermodparam
-      battery["maxBatteryVoltage"] = maxBatteryVoltage;           // usermodparam
-      battery[FPSTR(_readInterval)] = readingInterval;
-
-      DEBUG_PRINTLN(F("Battery config saved."));
-    }
-
-
-    /*
-     * readFromConfig() can be used to read back the custom settings you added with addToConfig().
-     * This is called by WLED when settings are loaded (currently this only happens immediately after boot, or after saving on the Usermod Settings page)
-     * 
-     * readFromConfig() is called BEFORE setup(). This means you can use your persistent values in setup() (e.g. pin assignments, buffer sizes),
-     * but also that if you want to write persistent values to a dynamic buffer, you'd need to allocate it here instead of in setup.
-     * If you don't know what that is, don't fret. It most likely doesn't affect your use case :)
-     * 
-     * Return true in case the config values returned from Usermod Settings were complete, or false if you'd like WLED to save your defaults to disk (so any missing values are editable in Usermod Settings)
-     * 
-     * getJsonValue() returns false if the value is missing, or copies the value into the variable provided and returns true if the value is present
-     * The configComplete variable is true only if the "exampleUsermod" object and all values are present.  If any values are missing, WLED will know to call addToConfig() to save them
-     * 
-     * This function is guaranteed to be called on boot, but could also be called every time settings are updated
-     */
-    bool readFromConfig(JsonObject& root)
-    {
-      // looking for JSON object: 
-      /*
-      {
-        "BatteryLevel": {
-          "pin": "A0",              <--- only when using esp32 boards
-          "minBatteryVoltage": 2.6, 
-          "maxBatteryVoltage": 4.2,
-          "read-interval-ms": 30000  
-        }
-      }
-      */
-      #ifdef ARDUINO_ARCH_ESP32
-        int8_t newBatteryPin = batteryPin;
-      #endif
-
-      JsonObject battery = root[FPSTR(_name)];
-      if (battery.isNull()) 
-      {
-        DEBUG_PRINT(FPSTR(_name));
-        DEBUG_PRINTLN(F(": No config found. (Using defaults.)"));
-        return false;
-      }
-
-      #ifdef ARDUINO_ARCH_ESP32
-        newBatteryPin     = battery["pin"] | newBatteryPin;
-      #endif
-      minBatteryVoltage   = battery["minBatteryVoltage"] | minBatteryVoltage;
-      //minBatteryVoltage = min(12.0f, (int)readingInterval);
-      maxBatteryVoltage   = battery["maxBatteryVoltage"] | maxBatteryVoltage;
-      //maxBatteryVoltage = min(14.4f, max(3.3f,(int)readingInterval));
-      readingInterval     = battery["read-interval-ms"] | readingInterval;
-      readingInterval     = max(3000, (int)readingInterval); // minimum repetition is >5000ms (5s)
-
-      DEBUG_PRINT(FPSTR(_name));
-
-      #ifdef ARDUINO_ARCH_ESP32
-        if (!initDone) 
-        {
-          // first run: reading from cfg.json
-          newBatteryPin = batteryPin;
-          DEBUG_PRINTLN(F(" config loaded."));
-        } 
-        else 
-        {
-          DEBUG_PRINTLN(F(" config (re)loaded."));
-
-          // changing paramters from settings page
-          if (newBatteryPin != batteryPin) 
-          {
-            // deallocate pin
-            pinManager.deallocatePin(batteryPin);
-            batteryPin = newBatteryPin;
-            // initialise
-            setup();
-          }
-        }
-      #endif
-
-      return !battery[FPSTR(_readInterval)].isNull();
-    }
-
-   
-    /*
-     * getId() allows you to optionally give your V2 usermod an unique ID (please define it in const.h!).
-     * This could be used in the future for the system to determine whether your usermod is installed.
-     */
-    uint16_t getId()
-    {
-      return USERMOD_ID_BATTERY_STATUS_BASIC;
-    }
-};
-
-// strings to reduce flash memory usage (used more than twice)
-const char UsermodBatteryBasic::_name[]         PROGMEM = "Battery-level";
-const char UsermodBatteryBasic::_readInterval[] PROGMEM = "read-interval-ms";

usermods/blynk_relay_control/README.md

@@ -1,28 +0,0 @@
-# Blynk controllable relay
-Enables controlling a relay state via user variables. Allows the user variables to be set via Blynk.
-
-Optionally, the servo can have a reset timer to return to its default state after a user definable interval. The interval is set via userVar1.
-
-## Instalation
-
-Replace the WLED06_usermod.ino file in Aircoookies WLED folder, with the one here.
-
-## Customizations
-
-Update the following parameters in WLED06_usermod.ino to configure the mod's behavior:
-
-```cpp
-//Which pin is the relay connected to
-#define RELAY_PIN 5
-//Which pin state should the relay default to
-#define RELAY_PIN_DEFAULT LOW
-//If >0 The controller returns to RELAY_PIN_DEFAULT after this time, in milliseconds
-#define RELAY_PIN_TIMER_DEFAULT 3000
-
-//Blynk virtual pin for controlling relay
-#define BLYNK_USER_VAR0_PIN V9
-//Blynk virtual pin for controlling relay timer
-#define BLYNK_USER_VAR1_PIN V10
-//Number of milliseconds between Blynk updates
-#define BLYNK_RELAY_UPDATE_INTERVAL 5000
-```

usermods/blynk_relay_control/wled06_usermod.ino

@@ -1,96 +0,0 @@
-/*
- * This file allows you to add own functionality to WLED more easily
- * See: https://github.com/Aircoookie/WLED/wiki/Add-own-functionality
- * EEPROM bytes 2750+ are reserved for your custom use case. (if you extend #define EEPSIZE in wled_eeprom.h)
- * bytes 2400+ are currently ununsed, but might be used for future wled features
- */
-
-//Use userVar0 (API calls &U0=, uint16_t) to set relay state
-#define relayPinState userVar0
-//Use userVar1 (API calls &U1=, uint16_t) to set relay timer duration
-//Ignored if 0, otherwise number of milliseconds to allow relay to stay in
-//non default state.
-#define relayTimerInterval userVar1
-
-//Which pin is the relay connected to
-#define RELAY_PIN 5
-//Which pin state should the relay default to
-#define RELAY_PIN_DEFAULT LOW
-//If >0 The controller returns to RELAY_PIN_DEFAULT after this time in milliseconds
-#define RELAY_PIN_TIMER_DEFAULT 3000
-
-//Blynk virtual pin for controlling relay
-#define BLYNK_USER_VAR0_PIN V9
-//Blynk virtual pin for controlling relay timer
-#define BLYNK_USER_VAR1_PIN V10
-//Number of milliseconds between updating blynk
-#define BLYNK_RELAY_UPDATE_INTERVAL 5000
-
-//Is the timer for resetting the relay active
-bool relayTimerStarted = false;
-//millis() time after which relay will be reset
-unsigned long relayTimeToDefault = 0;
-//millis() time after which relay vars in Blynk will be sent
-unsigned long relayBlynkUpdateTime = 0;
-
-//gets called once at boot. Do all initialization that doesn't depend on network here
-void userSetup()
-{
-  relayPinState = RELAY_PIN_DEFAULT;
-  relayTimerInterval = RELAY_PIN_TIMER_DEFAULT;
-  pinMode(RELAY_PIN, OUTPUT);
-  digitalWrite(RELAY_PIN, relayPinState);
-}
-
-//gets called every time WiFi is (re-)connected. Initialize own network interfaces here
-void userConnected()
-{
-}
-
-//loop. You can use "if (WLED_CONNECTED)" to check for successful connection
-void userLoop()
-{
-  //Normalize relayPinState to an accepted value
-  if (relayPinState != HIGH && relayPinState != LOW) {
-    relayPinState = RELAY_PIN_DEFAULT;
-  }
-  //If relay changes and relayTimerInterval is set, start a timer to change back
-  if (relayTimerInterval != 0 &&
-      relayPinState != RELAY_PIN_DEFAULT &&
-      !relayTimerStarted ) {
-    relayTimerStarted = true;
-    relayTimeToDefault = millis() + relayTimerInterval;
-  }
-  //If manually changed back to default, cancel timer
-  if (relayTimerStarted && relayPinState == RELAY_PIN_DEFAULT ) {
-    relayTimerStarted = false;
-  }
-  //If timer completes, set relay back to default
-  if (relayTimerStarted && millis() > relayTimeToDefault) {
-    relayPinState = RELAY_PIN_DEFAULT;
-    relayTimerStarted = false;
-  }
-  digitalWrite(RELAY_PIN, relayPinState);
-  updateRelayBlynk();
-}
-
-//Update Blynk with state of userVars at BLYNK_RELAY_UPDATE_INTERVAL
-void updateRelayBlynk()
-{
-  if (!WLED_CONNECTED) return;
-  if (relayBlynkUpdateTime > millis()) return;
-  Blynk.virtualWrite(BLYNK_USER_VAR0_PIN, userVar0);
-  Blynk.virtualWrite(BLYNK_USER_VAR1_PIN, userVar1);
-  relayBlynkUpdateTime = millis() + BLYNK_RELAY_UPDATE_INTERVAL;
-}
-
-//Add Blynk callback for setting userVar0
-BLYNK_WRITE(BLYNK_USER_VAR0_PIN)
-{
-  userVar0 = param.asInt();
-}
-//Add Blynk callback for setting userVar1
-BLYNK_WRITE(BLYNK_USER_VAR1_PIN)
-{
-  userVar1 = param.asInt();
-}

usermods/boblight/boblight.h

@@ -174,9 +174,9 @@ class BobLightUsermod : public Usermod {
 
       #if WLED_DEBUG
       DEBUG_PRINTLN(F("Fill light data: "));
-      DEBUG_PRINTF(" lights %d\n", numLights);
+      DEBUG_PRINTF_P(PSTR(" lights %d\n"), numLights);
       for (int i=0; i<numLights; i++) {
-        DEBUG_PRINTF(" light %s scan %2.1f %2.1f %2.1f %2.1f\n", lights[i].lightname, lights[i].vscan[0], lights[i].vscan[1], lights[i].hscan[0], lights[i].hscan[1]);
+        DEBUG_PRINTF_P(PSTR(" light %s scan %2.1f %2.1f %2.1f %2.1f\n"), lights[i].lightname, lights[i].vscan[0], lights[i].vscan[1], lights[i].hscan[0], lights[i].hscan[1]);
       }
       #endif
     }
@@ -187,11 +187,11 @@ class BobLightUsermod : public Usermod {
 
   public:
 
-    void setup() {
+    void setup() override {
       uint16_t totalLights = bottom + left + top + right;
       if ( totalLights > strip.getLengthTotal() ) {
         DEBUG_PRINTLN(F("BobLight: Too many lights."));
-        DEBUG_PRINTF("%d+%d+%d+%d>%d\n", bottom, left, top, right, strip.getLengthTotal());
+        DEBUG_PRINTF_P(PSTR("%d+%d+%d+%d>%d\n"), bottom, left, top, right, strip.getLengthTotal());
         totalLights = strip.getLengthTotal();
         top = bottom = (uint16_t) roundf((float)totalLights * 16.0f / 50.0f);
         left = right = (uint16_t) roundf((float)totalLights *  9.0f / 50.0f);
@@ -202,14 +202,14 @@ class BobLightUsermod : public Usermod {
       initDone = true;
     }
 
-    void connected() {
+    void connected() override {
       // we can only start server when WiFi is connected
       if (!bob) bob = new WiFiServer(bobPort, 1);
       bob->begin();
       bob->setNoDelay(true);
     }
 
-    void loop() {
+    void loop() override {
       if (!enabled || strip.isUpdating()) return;
       if (millis() - lastTime > 10) {
         lastTime = millis();
@@ -219,12 +219,13 @@ class BobLightUsermod : public Usermod {
 
     void enable(bool en) { enabled = en; }
     
+#ifndef WLED_DISABLE_MQTT
     /**
      * handling of MQTT message
      * topic only contains stripped topic (part after /wled/MAC)
      * topic should look like: /swipe with amessage of [up|down]
      */
-    bool onMqttMessage(char* topic, char* payload) {
+    bool onMqttMessage(char* topic, char* payload) override {
       //if (strlen(topic) == 6 && strncmp_P(topic, PSTR("/subtopic"), 6) == 0) {
       //  String action = payload;
       //  if (action == "on") {
@@ -241,7 +242,7 @@ class BobLightUsermod : public Usermod {
     /**
      * subscribe to MQTT topic for controlling usermod
      */
-    void onMqttConnect(bool sessionPresent) {
+    void onMqttConnect(bool sessionPresent) override {
       //char subuf[64];
       //if (mqttDeviceTopic[0] != 0) {
       //  strcpy(subuf, mqttDeviceTopic);
@@ -249,8 +250,9 @@ class BobLightUsermod : public Usermod {
       //  mqtt->subscribe(subuf, 0);
       //}
     }
+#endif
 
-    void addToJsonInfo(JsonObject& root)
+    void addToJsonInfo(JsonObject& root) override
     {
       JsonObject user = root["u"];
       if (user.isNull()) user = root.createNestedObject("u");
@@ -271,7 +273,7 @@ class BobLightUsermod : public Usermod {
      * addToJsonState() can be used to add custom entries to the /json/state part of the JSON API (state object).
      * Values in the state object may be modified by connected clients
      */
-    void addToJsonState(JsonObject& root)
+    void addToJsonState(JsonObject& root) override
     {
     }
 
@@ -279,7 +281,7 @@ class BobLightUsermod : public Usermod {
      * readFromJsonState() can be used to receive data clients send to the /json/state part of the JSON API (state object).
      * Values in the state object may be modified by connected clients
      */
-    void readFromJsonState(JsonObject& root) {
+    void readFromJsonState(JsonObject& root) override {
       if (!initDone) return;  // prevent crash on boot applyPreset()
       bool en = enabled;
       JsonObject um = root[FPSTR(_name)];
@@ -302,7 +304,7 @@ class BobLightUsermod : public Usermod {
       }
     }
 
-    void appendConfigData() {
+    void appendConfigData() override {
       //oappend(SET_F("dd=addDropdown('usermod','selectfield');"));
       //oappend(SET_F("addOption(dd,'1st value',0);"));
       //oappend(SET_F("addOption(dd,'2nd value',1);"));
@@ -313,10 +315,10 @@ class BobLightUsermod : public Usermod {
       oappend(SET_F("addInfo('BobLight:pct',1,'Depth of scan [%]');"));   // 0 is field type, 1 is actual field
     }
 
-    void addToConfig(JsonObject& root) {
+    void addToConfig(JsonObject& root) override {
       JsonObject umData = root.createNestedObject(FPSTR(_name));
       umData[FPSTR(_enabled)] = enabled;
-      umData[F("port")]       = bobPort;
+      umData[  "port" ]       = bobPort;
       umData[F("top")]        = top;
       umData[F("bottom")]     = bottom;
       umData[F("left")]       = left;
@@ -324,7 +326,7 @@ class BobLightUsermod : public Usermod {
       umData[F("pct")]        = pct;
     }
 
-    bool readFromConfig(JsonObject& root) {
+    bool readFromConfig(JsonObject& root) override {
       JsonObject umData = root[FPSTR(_name)];
       bool configComplete = !umData.isNull();
 
@@ -332,7 +334,7 @@ class BobLightUsermod : public Usermod {
       configComplete &= getJsonValue(umData[FPSTR(_enabled)], en);
       enable(en);
 
-      configComplete &= getJsonValue(umData[F("port")],   bobPort);
+      configComplete &= getJsonValue(umData[  "port" ],   bobPort);
       configComplete &= getJsonValue(umData[F("bottom")], bottom,    16);
       configComplete &= getJsonValue(umData[F("top")],    top,       16);
       configComplete &= getJsonValue(umData[F("left")],   left,       9);
@@ -353,11 +355,11 @@ class BobLightUsermod : public Usermod {
      * Use this to blank out some LEDs or set them to a different color regardless of the set effect mode.
      * Commonly used for custom clocks (Cronixie, 7 segment)
      */
-    void handleOverlayDraw() {
+    void handleOverlayDraw() override {
       //strip.setPixelColor(0, RGBW32(0,0,0,0)) // set the first pixel to black
     }
 
-    uint16_t getId() { return USERMOD_ID_BOBLIGHT; }
+    uint16_t getId() override { return USERMOD_ID_BOBLIGHT; }
 
 };
 
@@ -390,7 +392,7 @@ void BobLightUsermod::pollBob() {
     //get data from the client
     while (bobClient.available()) {
       String input = bobClient.readStringUntil('\n');
-      // DEBUG_PRINT("Client: "); DEBUG_PRINTLN(input); // may be to stressful on Serial
+      // DEBUG_PRINT(F("Client: ")); DEBUG_PRINTLN(input); // may be to stressful on Serial
       if (input.startsWith(F("hello"))) {
         DEBUG_PRINTLN(F("hello"));
         bobClient.print(F("hello\n"));
@@ -443,7 +445,7 @@ void BobLightUsermod::pollBob() {
           //strip.setPixelColor(light_id, RGBW32(red, green, blue, 0));
           setRealtimePixel(light_id, red, green, blue, 0);
         } // currently no support for interpolation or speed, we just ignore this
-      } else if (input.startsWith(F("sync"))) {
+      } else if (input.startsWith("sync")) {
         BobSync();
       } else {
         // Client sent gibberish

usermods/mpu6050_imu/readme.md

@@ -20,14 +20,11 @@ react to the globes orientation. See the blog post on building it <https://www.r
 
 I2Cdev and MPU6050 must be installed.
 
-To install them, add I2Cdevlib-MPU6050@fbde122cc5 to lib_deps in the platformio.ini file.
-
-You also need to change lib_compat_mode from strict to soft in platformio.ini (This ignores that I2Cdevlib-MPU6050 doesn't list platform compatibility)
+To install them, add electroniccats/MPU6050@1.0.1 to lib_deps in the platformio.ini file.
 
 For example:
 
 ```
-lib_compat_mode = soft
 lib_deps =
     FastLED@3.3.2
     NeoPixelBus@2.5.7
@@ -36,7 +33,7 @@ lib_deps =
     AsyncTCP@1.0.3
     Esp Async WebServer@1.2.0
     IRremoteESP8266@2.7.3
-    jrowberg/I2Cdevlib-MPU6050@^1.0.0
+    electroniccats/MPU6050@1.0.1
 ```
 
 ## Wiring

usermods/mpu6050_imu/usermod_gyro_surge.h

@@ -0,0 +1,219 @@
+#pragma once
+
+/* This usermod uses gyro data to provide a "surge" effect on movement
+
+Requires lib_deps = bolderflight/Bolder Flight Systems Eigen@^3.0.0
+
+*/
+
+#include "wled.h"
+
+// Eigen include block
+#ifdef A0
+namespace { constexpr size_t A0_temp {A0}; }
+#undef A0
+static constexpr size_t A0 {A0_temp};
+#endif
+
+#ifdef A1
+namespace { constexpr size_t A1_temp {A1}; }
+#undef A1
+static constexpr size_t A1 {A1_temp};
+#endif
+
+#ifdef B0
+namespace { constexpr size_t B0_temp {B0}; }
+#undef B0
+static constexpr size_t B0 {B0_temp};
+#endif
+
+#ifdef B1
+namespace { constexpr size_t B1_temp {B1}; }
+#undef B1
+static constexpr size_t B1 {B1_temp};
+#endif
+
+#ifdef D0
+namespace { constexpr size_t D0_temp {D0}; }
+#undef D0
+static constexpr size_t D0 {D0_temp};
+#endif
+
+#ifdef D1
+namespace { constexpr size_t D1_temp {D1}; }
+#undef D1
+static constexpr size_t D1 {D1_temp};
+#endif
+
+#ifdef D2
+namespace { constexpr size_t D2_temp {D2}; }
+#undef D2
+static constexpr size_t D2 {D2_temp};
+#endif
+
+#ifdef D3
+namespace { constexpr size_t D3_temp {D3}; }
+#undef D3
+static constexpr size_t D3 {D3_temp};
+#endif
+
+#include "eigen.h"
+#include <Eigen/Geometry>
+
+constexpr auto ESTIMATED_G = 9.801;  // m/s^2
+constexpr auto ESTIMATED_G_COUNTS = 8350.;
+constexpr auto ESTIMATED_ANGULAR_RATE = (M_PI * 2000) / (INT16_MAX * 180); // radians per second
+
+// Horribly lame digital filter code
+// Currently implements a static IIR filter.
+template<typename T, unsigned C>
+class xir_filter {
+    typedef Eigen::Array<T, C, 1> array_t;
+    const array_t a_coeff, b_coeff;
+    const T gain;
+    array_t x, y;
+
+    public:
+    xir_filter(T gain_, array_t a, array_t b) : a_coeff(std::move(a)), b_coeff(std::move(b)), gain(gain_), x(array_t::Zero()), y(array_t::Zero()) {};
+
+    T operator()(T input) {
+        x.head(C-1) = x.tail(C-1);  // shift by one
+        x(C-1) = input / gain;
+        y.head(C-1) = y.tail(C-1);  // shift by one
+        y(C-1) = (x * b_coeff).sum();
+        y(C-1) -= (y.head(C-1) * a_coeff.head(C-1)).sum();
+        return y(C-1);
+    }
+
+    T last() { return y(C-1); };
+};
+
+
+
+class GyroSurge : public Usermod {
+  private:
+    static const char _name[];
+    bool enabled = true;
+
+    // Params
+    uint8_t max = 0;
+    float sensitivity = 0;
+
+    // State
+    uint32_t last_sample;
+    // 100hz input
+    // butterworth low pass filter at 20hz
+    xir_filter<float, 3> filter = { 1., { -0.36952738, 0.19581571, 1.}, {0.20657208, 0.41314417, 0.20657208} };
+                                  // { 1., { 0., 0., 1.}, { 0., 0., 1. } }; // no filter
+
+
+  public:
+
+    /*
+     * setup() is called once at boot. WiFi is not yet connected at this point.
+     */
+    void setup() {};
+
+
+    /*
+     * addToConfig() can be used to add custom persistent settings to the cfg.json file in the "um" (usermod) object.
+     * It will be called by WLED when settings are actually saved (for example, LED settings are saved)
+     * I highly recommend checking out the basics of ArduinoJson serialization and deserialization in order to use custom settings!
+     */
+    void addToConfig(JsonObject& root)
+    {
+      JsonObject top = root.createNestedObject(FPSTR(_name));
+
+      //save these vars persistently whenever settings are saved
+      top["max"] = max;
+      top["sensitivity"] = sensitivity;
+    }
+
+
+    /*
+     * readFromConfig() can be used to read back the custom settings you added with addToConfig().
+     * This is called by WLED when settings are loaded (currently this only happens immediately after boot, or after saving on the Usermod Settings page)
+     * 
+     * readFromConfig() is called BEFORE setup(). This means you can use your persistent values in setup() (e.g. pin assignments, buffer sizes),
+     * but also that if you want to write persistent values to a dynamic buffer, you'd need to allocate it here instead of in setup.
+     * If you don't know what that is, don't fret. It most likely doesn't affect your use case :)
+     * 
+     * Return true in case the config values returned from Usermod Settings were complete, or false if you'd like WLED to save your defaults to disk (so any missing values are editable in Usermod Settings)
+     * 
+     * getJsonValue() returns false if the value is missing, or copies the value into the variable provided and returns true if the value is present
+     * The configComplete variable is true only if the "exampleUsermod" object and all values are present.  If any values are missing, WLED will know to call addToConfig() to save them
+     * 
+     * This function is guaranteed to be called on boot, but could also be called every time settings are updated
+     */
+    bool readFromConfig(JsonObject& root)
+    {
+      // default settings values could be set here (or below using the 3-argument getJsonValue()) instead of in the class definition or constructor
+      // setting them inside readFromConfig() is slightly more robust, handling the rare but plausible use case of single value being missing after boot (e.g. if the cfg.json was manually edited and a value was removed)
+
+      JsonObject top = root[FPSTR(_name)];
+
+      bool configComplete = !top.isNull();
+
+      configComplete &= getJsonValue(top["max"], max, 0);
+      configComplete &= getJsonValue(top["sensitivity"], sensitivity, 10);
+
+      return configComplete;
+    }
+
+    void loop() {
+      // get IMU data
+      um_data_t *um_data;
+      if (!usermods.getUMData(&um_data, USERMOD_ID_IMU)) {
+        // Apply max
+        strip.getSegment(0).fadeToBlackBy(max);
+        return;
+      }
+      uint32_t sample_count = *(uint32_t*)(um_data->u_data[8]);
+
+      if (sample_count != last_sample) {        
+        last_sample = sample_count;
+        // Calculate based on new data
+        // We use the raw gyro data (angular rate)        
+        auto gyros = (int16_t*)um_data->u_data[4];  // 16384 == 2000 deg/s
+
+        // Compute the overall rotation rate
+        // For my application (a plasma sword) we ignore X axis rotations (eg. around the long axis)
+        auto gyro_q = Eigen::AngleAxis<float> {
+                        //Eigen::AngleAxis<float>(ESTIMATED_ANGULAR_RATE * gyros[0], Eigen::Vector3f::UnitX()) *
+                        Eigen::AngleAxis<float>(ESTIMATED_ANGULAR_RATE * gyros[1], Eigen::Vector3f::UnitY()) *
+                        Eigen::AngleAxis<float>(ESTIMATED_ANGULAR_RATE * gyros[2], Eigen::Vector3f::UnitZ()) };
+        
+        // Filter the results
+        filter(std::min(sensitivity * gyro_q.angle(), 1.0f));   // radians per second
+/*
+        Serial.printf("[%lu] Gy: %d, %d, %d -- ", millis(), (int)gyros[0], (int)gyros[1], (int)gyros[2]);
+        Serial.print(gyro_q.angle());
+        Serial.print(", ");
+        Serial.print(sensitivity * gyro_q.angle());
+        Serial.print(" --> ");
+        Serial.println(filter.last());
+*/
+      }
+    }; // noop
+
+    /*
+     * handleOverlayDraw() is called just before every show() (LED strip update frame) after effects have set the colors.
+     * Use this to blank out some LEDs or set them to a different color regardless of the set effect mode.
+     * Commonly used for custom clocks (Cronixie, 7 segment)
+     */
+    void handleOverlayDraw()
+    {
+
+      // TODO: some kind of timing analysis for filtering ...
+
+      // Calculate brightness boost
+      auto r_float = std::max(std::min(filter.last(), 1.0f), 0.f);
+      auto result = (uint8_t) (r_float * max);
+      //Serial.printf("[%lu] %d -- ", millis(), result);
+      //Serial.println(r_float);
+      // TODO - multiple segment handling??
+      strip.getSegment(0).fadeToBlackBy(max - result);
+    }
+};
+
+const char GyroSurge::_name[] PROGMEM = "GyroSurge";

usermods/mpu6050_imu/usermod_mpu6050_imu.h

@@ -20,11 +20,11 @@
   XCL     not connected
   AD0     not connected
   INT     D8 (GPIO15)   Interrupt pin
-  
+
   Using 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
-  3. I2Cdev and MPU6050 must be installed as libraries, or else the .cpp/.h file 
+  3. I2Cdev and MPU6050 must be installed as libraries, or else the .cpp/.h file
      for both classes must be in the include path of your project. To install the
      libraries add I2Cdevlib-MPU6050@fbde122cc5 to lib_deps in the platformio.ini file.
   4. You also need to change lib_compat_mode from strict to soft in platformio.ini (This ignores that I2Cdevlib-MPU6050 doesn't list platform compatibility)
@@ -33,6 +33,9 @@
 
 #include "I2Cdev.h"
 
+#undef DEBUG_PRINT
+#undef DEBUG_PRINTLN
+#undef DEBUG_PRINTF
 #include "MPU6050_6Axis_MotionApps20.h"
 //#include "MPU6050.h" // not necessary if using MotionApps include file
 
@@ -42,6 +45,23 @@
     #include "Wire.h"
 #endif
 
+// Restore debug macros
+// MPU6050 unfortunately uses the same macro names as WLED :(
+#undef DEBUG_PRINT
+#undef DEBUG_PRINTLN
+#undef DEBUG_PRINTF
+#ifdef WLED_DEBUG
+  #define DEBUG_PRINT(x) DEBUGOUT.print(x)
+  #define DEBUG_PRINTLN(x) DEBUGOUT.println(x)
+  #define DEBUG_PRINTF(x...) DEBUGOUT.printf(x)
+#else
+  #define DEBUG_PRINT(x)
+  #define DEBUG_PRINTLN(x)
+  #define DEBUG_PRINTF(x...)
+#endif
+
+
+
 // ================================================================
 // ===               INTERRUPT DETECTION ROUTINE                ===
 // ================================================================
@@ -52,21 +72,31 @@ void IRAM_ATTR dmpDataReady() {
 }
 
 
+
 class MPU6050Driver : public Usermod {
   private:
     MPU6050 mpu;
-    bool enabled = true;
+
+    // configuration state
+    // default values are set in readFromConfig
+    // By making this a struct, we enable easy backup and comparison in the readFromConfig class
+    struct config_t {
+      bool enabled;
+      int8_t interruptPin;    
+      int16_t gyro_offset[3]; 
+      int16_t accel_offset[3];
+    };
+    config_t config;
 
     // MPU control/status vars
+    bool irqBound = false; // set true if we have bound the IRQ pin
     bool dmpReady = false;  // set true if DMP init was successful
-    uint8_t mpuIntStatus;   // holds actual interrupt status byte from MPU
     uint8_t devStatus;      // return status after each device operation (0 = success, !0 = error)
     uint16_t packetSize;    // expected DMP packet size (default is 42 bytes)
     uint16_t fifoCount;     // count of all bytes currently in FIFO
     uint8_t fifoBuffer[64]; // FIFO storage buffer
 
-    //NOTE: some of these can be removed to save memory, processing time
-    //      if the measurement isn't needed
+    // TODO: some of these can be removed to save memory, processing time if the measurement isn't needed
     Quaternion qat;         // [w, x, y, z]         quaternion container
     float euler[3];         // [psi, theta, phi]    Euler angle container
     float ypr[3];           // [yaw, pitch, roll]   yaw/pitch/roll container
@@ -75,22 +105,69 @@ class MPU6050Driver : public Usermod {
     VectorInt16 aaReal;     // [x, y, z]            gravity-free accel sensor measurements
     VectorInt16 aaWorld;    // [x, y, z]            world-frame accel sensor measurements
     VectorFloat gravity;    // [x, y, z]            gravity vector
+    uint32 sample_count;
 
-    static const int INTERRUPT_PIN = 15; // use pin 15 on ESP8266
+    // Usermod output
+    um_data_t um_data;
+
+    // config element names as progmem strs
+    static const char _name[];
+    static const char _enabled[];
+    static const char _interrupt_pin[];
+    static const char _x_acc_bias[];
+    static const char _y_acc_bias[];
+    static const char _z_acc_bias[];
+    static const char _x_gyro_bias[];
+    static const char _y_gyro_bias[];
+    static const char _z_gyro_bias[];
 
   public:
-    //Functions called by WLED
 
+    inline bool initDone() { return um_data.u_size != 0; };   // recycle this instead of storing an extra variable
+
+    //Functions called by WLED
     /*
      * setup() is called once at boot. WiFi is not yet connected at this point.
      */
     void setup() {
-      PinManagerPinType pins[2] = { { i2c_scl, true }, { i2c_sda, true } };
-      if (!pinManager.allocateMultiplePins(pins, 2, PinOwner::HW_I2C)) { enabled = false; return; }
-      // join I2C bus (I2Cdev library doesn't do this automatically)
+      dmpReady = false;   // Start clean
+
+      // one time init
+      if (!initDone()) {
+        um_data.u_size = 9;
+        um_data.u_type = new um_types_t[um_data.u_size];
+        um_data.u_data = new void*[um_data.u_size];
+        um_data.u_data[0] = &qat;
+        um_data.u_type[0] = UMT_FLOAT_ARR;
+        um_data.u_data[1] = &euler;
+        um_data.u_type[1] = UMT_FLOAT_ARR;
+        um_data.u_data[2] = &ypr;
+        um_data.u_type[2] = UMT_FLOAT_ARR;
+        um_data.u_data[3] = &aa;
+        um_data.u_type[3] = UMT_INT16_ARR;
+        um_data.u_data[4] = &gy;
+        um_data.u_type[4] = UMT_INT16_ARR;
+        um_data.u_data[5] = &aaReal;
+        um_data.u_type[5] = UMT_INT16_ARR;
+        um_data.u_data[6] = &aaWorld;
+        um_data.u_type[6] = UMT_INT16_ARR;
+        um_data.u_data[7] = &gravity;
+        um_data.u_type[7] = UMT_FLOAT_ARR;
+        um_data.u_data[8] = &sample_count;
+        um_data.u_type[8] = UMT_UINT32;
+      }
+
+      if (!config.enabled) return;
+      if (i2c_scl<0 || i2c_sda<0) { DEBUG_PRINTLN(F("MPU6050: I2C is no good."));  return; }
+      // Check the interrupt pin
+      if (config.interruptPin >= 0) {
+        irqBound = pinManager.allocatePin(config.interruptPin, false, PinOwner::UM_IMU);
+        if (!irqBound) { DEBUG_PRINTLN(F("MPU6050: IRQ pin already in use.")); return; }
+        pinMode(config.interruptPin, INPUT);
+      };
+
       #if I2CDEV_IMPLEMENTATION == I2CDEV_ARDUINO_WIRE
-        Wire.begin();
-        Wire.setClock(400000); // 400kHz I2C clock. Comment this line if having compilation difficulties
+        Wire.setClock(400000U); // 400kHz I2C clock. Comment this line if having compilation difficulties
       #elif I2CDEV_IMPLEMENTATION == I2CDEV_BUILTIN_FASTWIRE
         Fastwire::setup(400, true);
       #endif
@@ -98,7 +175,6 @@ class MPU6050Driver : public Usermod {
       // initialize device
       DEBUG_PRINTLN(F("Initializing I2C devices..."));
       mpu.initialize();
-      pinMode(INTERRUPT_PIN, INPUT);
 
       // verify connection
       DEBUG_PRINTLN(F("Testing device connections..."));
@@ -108,11 +184,16 @@ class MPU6050Driver : public Usermod {
       DEBUG_PRINTLN(F("Initializing DMP..."));
       devStatus = mpu.dmpInitialize();
 
-      // supply your own gyro offsets here, scaled for min sensitivity
-      mpu.setXGyroOffset(220);
-      mpu.setYGyroOffset(76);
-      mpu.setZGyroOffset(-85);
-      mpu.setZAccelOffset(1788); // 1688 factory default for my test chip
+      // set offsets (from config)
+      mpu.setXGyroOffset(config.gyro_offset[0]);
+      mpu.setYGyroOffset(config.gyro_offset[1]);
+      mpu.setZGyroOffset(config.gyro_offset[2]);
+      mpu.setXAccelOffset(config.accel_offset[0]);
+      mpu.setYAccelOffset(config.accel_offset[1]);
+      mpu.setZAccelOffset(config.accel_offset[2]);
+
+      // set sample rate
+      mpu.setRate(16);  // ~100Hz
 
       // make sure it worked (returns 0 if so)
       if (devStatus == 0) {
@@ -120,17 +201,19 @@ class MPU6050Driver : public Usermod {
         DEBUG_PRINTLN(F("Enabling DMP..."));
         mpu.setDMPEnabled(true);
 
-        // enable Arduino interrupt detection
-        DEBUG_PRINTLN(F("Enabling interrupt detection (Arduino external interrupt 0)..."));
-        attachInterrupt(digitalPinToInterrupt(INTERRUPT_PIN), dmpDataReady, RISING);
-        mpuIntStatus = mpu.getIntStatus();
-
-        // set our DMP Ready flag so the main loop() function knows it's okay to use it
-        DEBUG_PRINTLN(F("DMP ready! Waiting for first interrupt..."));
-        dmpReady = true;
+        mpuInterrupt = true;
+        if (irqBound) {
+          // enable Arduino interrupt detection
+          DEBUG_PRINTLN(F("Enabling interrupt detection (Arduino external interrupt 0)..."));          
+          attachInterrupt(digitalPinToInterrupt(config.interruptPin), dmpDataReady, RISING);
+        }
 
         // get expected DMP packet size for later comparison
         packetSize = mpu.dmpGetFIFOPacketSize();
+
+        // set our DMP Ready flag so the main loop() function knows it's okay to use it
+        DEBUG_PRINTLN(F("DMP ready!"));
+        dmpReady = true;
       } else {
         // ERROR!
         // 1 = initial memory load failed
@@ -138,8 +221,11 @@ class MPU6050Driver : public Usermod {
         // (if it's going to break, usually the code will be 1)
         DEBUG_PRINT(F("DMP Initialization failed (code "));
         DEBUG_PRINT(devStatus);
-        DEBUG_PRINTLN(F(")"));
+        DEBUG_PRINTLN(")");
       }
+
+      fifoCount = 0;
+      sample_count = 0;
     }
 
     /*
@@ -147,7 +233,7 @@ class MPU6050Driver : public Usermod {
      * Use it to initialize network interfaces
      */
     void connected() {
-      //DEBUG_PRINTLN("Connected to WiFi!");
+      //DEBUG_PRINTLN(F("Connected to WiFi!"));
     }
 
 
@@ -156,28 +242,31 @@ class MPU6050Driver : public Usermod {
      */
     void loop() {
       // if programming failed, don't try to do anything
-      if (!enabled || !dmpReady || strip.isUpdating()) return;
+      if (!config.enabled || !dmpReady || strip.isUpdating()) return;
 
       // wait for MPU interrupt or extra packet(s) available
+      // mpuInterrupt is fixed on if interrupt pin is disabled
       if (!mpuInterrupt && fifoCount < packetSize) return;
 
       // reset interrupt flag and get INT_STATUS byte
-      mpuInterrupt = false;
-      mpuIntStatus = mpu.getIntStatus();
-
-      // get current FIFO count
+      auto mpuIntStatus = mpu.getIntStatus();
+      // Update current FIFO count
       fifoCount = mpu.getFIFOCount();
 
       // check for overflow (this should never happen unless our code is too inefficient)
       if ((mpuIntStatus & 0x10) || fifoCount == 1024) {
         // reset so we can continue cleanly
         mpu.resetFIFO();
-        DEBUG_PRINTLN(F("FIFO overflow!"));
+        DEBUG_PRINTLN(F("MPU6050: FIFO overflow!"));
 
-        // otherwise, check for DMP data ready interrupt (this should happen frequently)
-      } else if (mpuIntStatus & 0x02) {
-        // wait for correct available data length, should be a VERY short wait
-        while (fifoCount < packetSize) fifoCount = mpu.getFIFOCount();
+        // otherwise, check for data ready
+      } else if (fifoCount >= packetSize) {
+        // clear local interrupt pending status, if not polling
+        mpuInterrupt = !irqBound;
+
+        // DEBUG_PRINT(F("MPU6050: Processing packet: "));
+        // DEBUG_PRINT(fifoCount);
+        // DEBUG_PRINTLN(F(" bytes in FIFO"));
 
         // read a packet from FIFO
         mpu.getFIFOBytes(fifoBuffer, packetSize);
@@ -186,7 +275,6 @@ class MPU6050Driver : public Usermod {
         // (this lets us immediately read more without waiting for an interrupt)
         fifoCount -= packetSize;
 
-
         //NOTE: some of these can be removed to save memory, processing time
         //      if the measurement isn't needed
         mpu.dmpGetQuaternion(&qat, fifoBuffer);
@@ -197,87 +285,141 @@ class MPU6050Driver : public Usermod {
         mpu.dmpGetLinearAccel(&aaReal, &aa, &gravity);
         mpu.dmpGetLinearAccelInWorld(&aaWorld, &aaReal, &qat);
         mpu.dmpGetYawPitchRoll(ypr, &qat, &gravity);
+        ++sample_count;
       }
     }
 
-
-
     void addToJsonInfo(JsonObject& root)
     {
-      int reading = 20;
-      //this code adds "u":{"Light":[20," lux"]} to the info object
       JsonObject user = root["u"];
       if (user.isNull()) user = root.createNestedObject("u");
 
-      JsonArray imu_meas = user.createNestedObject("IMU");
-      JsonArray quat_json = imu_meas.createNestedArray("Quat");
+      // Unfortunately the web UI doesn't know how to print sub-objects: you just see '[object Object]'
+      // For now, we just put everything in the root userdata object.
+      //auto imu_meas = user.createNestedObject("IMU");
+      auto& imu_meas = user;
+
+      // If an element is an array, the UI expects two elements in the form [value, unit]
+      // Since our /value/ is an array, wrap it, eg. [[a, b, c]]
+      JsonArray quat_json = imu_meas.createNestedArray("Quat").createNestedArray();
       quat_json.add(qat.w);
       quat_json.add(qat.x);
       quat_json.add(qat.y);
       quat_json.add(qat.z);
-      JsonArray euler_json = imu_meas.createNestedArray("Euler");
+      JsonArray euler_json = imu_meas.createNestedArray("Euler").createNestedArray();
       euler_json.add(euler[0]);
       euler_json.add(euler[1]);
       euler_json.add(euler[2]);
-      JsonArray accel_json = imu_meas.createNestedArray("Accel");
+      JsonArray accel_json = imu_meas.createNestedArray("Accel").createNestedArray();
       accel_json.add(aa.x);
       accel_json.add(aa.y);
       accel_json.add(aa.z);
-      JsonArray gyro_json = imu_meas.createNestedArray("Gyro");
+      JsonArray gyro_json = imu_meas.createNestedArray("Gyro").createNestedArray();
       gyro_json.add(gy.x);
       gyro_json.add(gy.y);
       gyro_json.add(gy.z);
-      JsonArray world_json = imu_meas.createNestedArray("WorldAccel");
+      JsonArray world_json = imu_meas.createNestedArray("WorldAccel").createNestedArray();
       world_json.add(aaWorld.x);
       world_json.add(aaWorld.y);
       world_json.add(aaWorld.z);
-      JsonArray real_json = imu_meas.createNestedArray("RealAccel");
+      JsonArray real_json = imu_meas.createNestedArray("RealAccel").createNestedArray();
       real_json.add(aaReal.x);
       real_json.add(aaReal.y);
       real_json.add(aaReal.z);
-      JsonArray grav_json = imu_meas.createNestedArray("Gravity");
+      JsonArray grav_json = imu_meas.createNestedArray("Gravity").createNestedArray();
       grav_json.add(gravity.x);
       grav_json.add(gravity.y);
       grav_json.add(gravity.z);
-      JsonArray orient_json = imu_meas.createNestedArray("Orientation");
+      JsonArray orient_json = imu_meas.createNestedArray("Orientation").createNestedArray();
       orient_json.add(ypr[0]);
       orient_json.add(ypr[1]);
       orient_json.add(ypr[2]);
     }
 
 
-    /*
-     * addToJsonState() can be used to add custom entries to the /json/state part of the JSON API (state object).
-     * Values in the state object may be modified by connected clients
-     */
-    //void addToJsonState(JsonObject& root)
-    //{
-      //root["user0"] = userVar0;
-    //}
-
-
-    /*
-     * readFromJsonState() can be used to receive data clients send to the /json/state part of the JSON API (state object).
-     * Values in the state object may be modified by connected clients
-     */
-    //void readFromJsonState(JsonObject& root)
-    //{
-      //if (root["bri"] == 255) DEBUG_PRINTLN(F("Don't burn down your garage!"));
-    //}
-
-
     /*
      * addToConfig() can be used to add custom persistent settings to the cfg.json file in the "um" (usermod) object.
      * It will be called by WLED when settings are actually saved (for example, LED settings are saved)
      * I highly recommend checking out the basics of ArduinoJson serialization and deserialization in order to use custom settings!
      */
-//    void addToConfig(JsonObject& root)
-//    {
-//      JsonObject top = root.createNestedObject("MPU6050_IMU");
-//      JsonArray pins = top.createNestedArray("pin");
-//      pins.add(HW_PIN_SCL);
-//      pins.add(HW_PIN_SDA);
-//    }
+    void addToConfig(JsonObject& root)
+    {
+      JsonObject top = root.createNestedObject(FPSTR(_name));
+
+      //save these vars persistently whenever settings are saved
+      top[FPSTR(_enabled)] = config.enabled;
+      top[FPSTR(_interrupt_pin)] = config.interruptPin;
+      top[FPSTR(_x_acc_bias)] = config.accel_offset[0];
+      top[FPSTR(_y_acc_bias)] = config.accel_offset[1];
+      top[FPSTR(_z_acc_bias)] = config.accel_offset[2];
+      top[FPSTR(_x_gyro_bias)] = config.gyro_offset[0];
+      top[FPSTR(_y_gyro_bias)] = config.gyro_offset[1];
+      top[FPSTR(_z_gyro_bias)] = config.gyro_offset[2];
+    }
+
+    /*
+     * readFromConfig() can be used to read back the custom settings you added with addToConfig().
+     * This is called by WLED when settings are loaded (currently this only happens immediately after boot, or after saving on the Usermod Settings page)
+     *
+     * readFromConfig() is called BEFORE setup(). This means you can use your persistent values in setup() (e.g. pin assignments, buffer sizes),
+     * but also that if you want to write persistent values to a dynamic buffer, you'd need to allocate it here instead of in setup.
+     * If you don't know what that is, don't fret. It most likely doesn't affect your use case :)
+     *
+     * Return true in case the config values returned from Usermod Settings were complete, or false if you'd like WLED to save your defaults to disk (so any missing values are editable in Usermod Settings)
+     *
+     * getJsonValue() returns false if the value is missing, or copies the value into the variable provided and returns true if the value is present
+     * The configComplete variable is true only if the "exampleUsermod" object and all values are present.  If any values are missing, WLED will know to call addToConfig() to save them
+     *
+     * This function is guaranteed to be called on boot, but could also be called every time settings are updated
+     */
+    bool readFromConfig(JsonObject& root)
+    {
+      // default settings values could be set here (or below using the 3-argument getJsonValue()) instead of in the class definition or constructor
+      // setting them inside readFromConfig() is slightly more robust, handling the rare but plausible use case of single value being missing after boot (e.g. if the cfg.json was manually edited and a value was removed)
+      auto old_cfg = config;
+
+      JsonObject top = root[FPSTR(_name)];
+
+      bool configComplete = top.isNull();
+      // Ensure default configuration is loaded
+      configComplete &= getJsonValue(top[FPSTR(_enabled)], config.enabled, true);
+      configComplete &= getJsonValue(top[FPSTR(_interrupt_pin)], config.interruptPin, -1);
+      configComplete &= getJsonValue(top[FPSTR(_x_acc_bias)], config.accel_offset[0], 0);
+      configComplete &= getJsonValue(top[FPSTR(_y_acc_bias)], config.accel_offset[1], 0);
+      configComplete &= getJsonValue(top[FPSTR(_z_acc_bias)], config.accel_offset[2], 0);
+      configComplete &= getJsonValue(top[FPSTR(_x_gyro_bias)], config.gyro_offset[0], 0);
+      configComplete &= getJsonValue(top[FPSTR(_y_gyro_bias)], config.gyro_offset[1], 0);
+      configComplete &= getJsonValue(top[FPSTR(_z_gyro_bias)], config.gyro_offset[2], 0);
+
+      DEBUG_PRINT(FPSTR(_name));
+      if (top.isNull()) {
+        DEBUG_PRINTLN(F(": No config found. (Using defaults.)"));
+      } else if (!initDone()) {
+        DEBUG_PRINTLN(F(": config loaded."));
+      } else if (memcmp(&config, &old_cfg, sizeof(config)) == 0) {
+        DEBUG_PRINTLN(F(": config unchanged."));
+      } else {
+        DEBUG_PRINTLN(F(": config updated."));
+        // Previously loaded and config changed
+        if (irqBound && ((old_cfg.interruptPin != config.interruptPin) || !config.enabled)) {
+          detachInterrupt(old_cfg.interruptPin);
+          pinManager.deallocatePin(old_cfg.interruptPin, PinOwner::UM_IMU);            
+          irqBound = false;
+        }
+
+        // Just re-init
+        setup();
+      }
+
+      return configComplete;
+    }
+
+    bool getUMData(um_data_t **data)
+    {
+      if (!data || !config.enabled || !dmpReady) return false; // no pointer provided by caller or not enabled -> exit
+      *data = &um_data;
+      return true;
+    }
 
     /*
      * getId() allows you to optionally give your V2 usermod an unique ID (please define it in const.h!).
@@ -287,4 +429,15 @@ class MPU6050Driver : public Usermod {
       return USERMOD_ID_IMU;
     }
 
-};
+};
+
+
+const char MPU6050Driver::_name[] PROGMEM = "MPU6050_IMU";
+const char MPU6050Driver::_enabled[] PROGMEM = "enabled";
+const char MPU6050Driver::_interrupt_pin[] PROGMEM = "interrupt_pin";
+const char MPU6050Driver::_x_acc_bias[] PROGMEM = "x_acc_bias";
+const char MPU6050Driver::_y_acc_bias[] PROGMEM = "y_acc_bias";
+const char MPU6050Driver::_z_acc_bias[] PROGMEM = "z_acc_bias";
+const char MPU6050Driver::_x_gyro_bias[] PROGMEM = "x_gyro_bias";
+const char MPU6050Driver::_y_gyro_bias[] PROGMEM = "y_gyro_bias";
+const char MPU6050Driver::_z_gyro_bias[] PROGMEM = "z_gyro_bias";

usermods/mqtt_switch_v2/README.md

@@ -50,5 +50,5 @@ This usermod listens on `[mqttDeviceTopic]/switch/0/set` (where 0 is replaced wi
 Feedback about the current state is provided at `[mqttDeviceTopic]/switch/0/state`.
 
 ### Home Assistant auto-discovery
-Auto-discovery information is automatically published and you shoudn't have to do anything to register the switches in Home Assistant.
+Auto-discovery information is automatically published and you shouldn't have to do anything to register the switches in Home Assistant.
  

usermods/multi_relay/readme.md

@@ -1,6 +1,9 @@
 # Multi Relay
 
 This usermod-v2 modification allows the connection of multiple relays, each with individual delay and on/off mode.
+Usermod supports PCF8574 I2C port expander to reduce GPIO use.
+PCF8574 supports 8 outputs and each output corresponds to a relay in WLED (relay 0 = port 0, etc). I you are using more than 8 relays with multiple PCF8574 make sure their addresses are set in sequence (e.g. 0x20 and 0x21). You can set address of first expander in settings.
+(**NOTE:** Will require Wire library and global I2C pins defined.)
 
 ## HTTP API
 All responses are returned in JSON format. 
@@ -44,6 +47,24 @@ or
 
 You can override the default maximum number of relays (which is 4) by defining MULTI_RELAY_MAX_RELAYS.
 
+Some settings can be defined (defaults) at compile time by setting the following defines:
+
+```cpp
+// enable or disable HA discovery for externally controlled relays
+#define MULTI_RELAY_HA_DISCOVERY true
+```
+
+The following definitions should be a list of values (maximum number of entries is MULTI_RELAY_MAX_RELAYS) that will be applied to the relays in order:
+(e.g. assuming MULTI_RELAY_MAX_RELAYS=2)
+
+```cpp
+#define MULTI_RELAY_PINS 12,18
+#define MULTI_RELAY_DELAYS 0,0
+#define MULTI_RELAY_EXTERNALS false,true
+#define MULTI_RELAY_INVERTS false,false
+```
+These can be set via your `platformio_override.ini` file or as `#define` in your `my_config.h` (remember to set `WLED_USE_MY_CONFIG` in your `platformio_override.ini`)
+
 Example **usermods_list.cpp**:
 
 ```cpp
@@ -81,13 +102,15 @@ void registerUsermods()
 Usermod can be configured via the Usermods settings page.
 
 * `enabled` - enable/disable usermod
+* `use-PCF8574` - use PCF8574 port expander instead of GPIO pins
+* `first-PCF8574` - I2C address of first expander (WARNING: enter *decimal* value)
+* `broadcast`- time in seconds between MQTT relay-state broadcasts
+* `HA-discovery`- enable Home Assistant auto discovery
 * `pin` - ESP GPIO pin the relay is connected to (can be configured at compile time `-D MULTI_RELAY_PINS=xx,xx,...`)
 * `delay-s` - delay in seconds after on/off command is received
 * `active-high` - assign high/low activation of relay (can be used to reverse relay states)
 * `external` - if enabled, WLED does not control relay, it can only be triggered by an external command (MQTT, HTTP, JSON or button)
 * `button` - button (from LED Settings) that controls this relay
-* `broadcast`- time in seconds between MQTT relay-state broadcasts
-* `HA-discovery`- enable Home Assistant auto discovery
 
 If there is no MultiRelay section, just save current configuration and re-open Usermods settings page. 
 
@@ -100,3 +123,9 @@ Have fun - @blazoncek
 2021-11
 * Added information about dynamic configuration options
 * Added button support.
+
+2023-05
+* Added support for PCF8574 I2C port expander (multiple)
+
+2023-11
+* @chrisburrows Added support for compile time defaults for setting DELAY, EXTERNAL, INVERTS and HA discovery

usermods/quinled-an-penta/quinled-an-penta.h

@@ -84,11 +84,11 @@ class QuinLEDAnPentaUsermod : public Usermod
     void getCurrentUsedLedPins()
     {
       for (int8_t lp = 0; lp <= 4; lp++) currentLedPins[lp] = 0;
-      byte numBusses = busses.getNumBusses();
+      byte numBusses = BusManager::getNumBusses();
       byte numUsedPins = 0;
 
       for (int8_t b = 0; b < numBusses; b++) {
-        Bus* curBus = busses.getBus(b);
+        Bus* curBus = BusManager::getBus(b);
         if (curBus != nullptr) {
           uint8_t pins[5] = {0, 0, 0, 0, 0};
           currentBussesNumPins[b] = curBus->getPins(pins);
@@ -104,11 +104,11 @@ class QuinLEDAnPentaUsermod : public Usermod
 
     void getCurrentLedcValues()
     {
-      byte numBusses = busses.getNumBusses();
+      byte numBusses = BusManager::getNumBusses();
       byte numLedc = 0;
 
       for (int8_t b = 0; b < numBusses; b++) {
-        Bus* curBus = busses.getBus(b);
+        Bus* curBus = BusManager::getBus(b);
         if (curBus != nullptr) {
           uint32_t curPixColor = curBus->getPixelColor(0);
           uint8_t _data[5] = {255, 255, 255, 255, 255};

usermods/quinled-an-penta/readme.md

@@ -2,7 +2,7 @@
 The (un)official usermod to get the best out of the QuinLED-An-Penta (https://quinled.info/quinled-an-penta/), e.g. using the OLED and the SHT30 temperature/humidity sensor.
 
 ## Requirements
-* "u8gs" by olikraus, v2.28 or higher: https://github.com/olikraus/u8g2
+* "u8g2" by olikraus, v2.28 or higher: https://github.com/olikraus/u8g2
 * "SHT85" by Rob Tillaart, v0.2 or higher: https://github.com/RobTillaart/SHT85
 
 ## Usermod installation

usermods/sd_card/readme.md

@@ -20,7 +20,7 @@
   | `pinSourceSelect` | GPIO that is connected to SD's `SS`(source select) / `CS`(chip select)                           | 16      |
   | `pinSourceClock`  | GPIO that is connected to SD's `SCLK` (source clock) / `CLK`(clock)                              | 14      |
   | `pinPoci`         | GPIO that is connected to SD's `POCI`<sup>☨</sup> (Peripheral-Out-Ctrl-In) / `MISO` (deprecated) | 36      |
-  | `pinPico`         | GPIO that is connected to SD's `PICO`<sup>☨</sup> (Peripheral-In-Ctrl-Out) / `MOSI` (deprecated) | 14      |
+  | `pinPico`         | GPIO that is connected to SD's `PICO`<sup>☨</sup> (Peripheral-In-Ctrl-Out) / `MOSI` (deprecated) | 15      |
   | `sdEnable`        | Enable to read data from the SD-card                                                             | true    |
 
   <sup>☨</sup><sub>Following new naming convention of [OSHWA](https://www.oshwa.org/a-resolution-to-redefine-spi-signal-names/)</sub>
@@ -31,4 +31,4 @@
 -  checks if the specified file is available on the SD card
    ```cpp
    bool file_onSD(const char *filepath) {...}
-   ```
+   ```

usermods/sensors_to_mqtt/usermod_v2_SensorsToMqtt.h

@@ -1,8 +1,11 @@
+#ifndef WLED_ENABLE_MQTT
+#error "This user mod requires MQTT to be enabled."
+#endif
+
 #pragma once
 
 #include "wled.h"
 #include <Arduino.h>
-#include <Wire.h>
 #include <Adafruit_Sensor.h>
 #include <Adafruit_BMP280.h>
 #include <Adafruit_CCS811.h>
@@ -12,14 +15,6 @@ Adafruit_BMP280 bmp;
 Adafruit_Si7021 si7021;
 Adafruit_CCS811 ccs811;
 
-#ifdef ARDUINO_ARCH_ESP32 //ESP32 boards
-uint8_t SCL_PIN = 22;
-uint8_t SDA_PIN = 21;
-#else //ESP8266 boards
-uint8_t SCL_PIN = 5;
-uint8_t SDA_PIN = 4;
-#endif
-
 class UserMod_SensorsToMQTT : public Usermod
 {
 private:
@@ -90,8 +85,8 @@ private:
 
     JsonObject device = doc.createNestedObject("device"); // attach the sensor to the same device
     device["identifiers"] = String("wled-sensor-") + mqttClientID;
-    device["manufacturer"] = "Aircoookie";
-    device["model"] = "WLED";
+    device["manufacturer"] = F(WLED_BRAND);
+    device["model"] = F(WLED_PRODUCT_NAME);
     device["sw_version"] = VERSION;
     device["name"] = mqttClientID;
 
@@ -227,7 +222,6 @@ public:
   void setup()
   {
     Serial.println("Starting!");
-    Wire.begin(SDA_PIN, SCL_PIN);
     Serial.println("Initializing sensors.. ");
     _initialize();
   }

usermods/seven_segment_display/readme.md

@@ -17,7 +17,7 @@ The number of individual LEDs per segment. 7 segments per digit.
 #### perPeriod -- ssLEDPerPeriod
 The number of individual LEDs per period. A ':' (colon) has two periods.
 #### startIdx -- ssStartLED
-Index of the LED the display starts at. Enabless a seven segment display to be in the middle of a string.
+Index of the LED the display starts at. Enables a seven segment display to be in the middle of a string.
 #### timeEnable -- ssTimeEnabled
 When true, when displayMask is configured for a time output and no message is set, the time will be displayed.
 #### scrollSpd -- ssScrollSpeed

usermods/seven_segment_display/usermod_v2_seven_segment_display.h

@@ -1,3 +1,7 @@
+#ifndef WLED_ENABLE_MQTT
+#error "This user mod requires MQTT to be enabled."
+#endif
+
 #pragma once
 
 #include "wled.h"
@@ -405,7 +409,7 @@ public:
 
     if (mqttGroupTopic[0] != 0)
     {
-      //subcribe for sevenseg messages on the group topic
+      //subscribe for sevenseg messages on the group topic
       sprintf_P(subBuffer, PSTR("%s/%S/+/set"), mqttGroupTopic, _str_sevenSeg);
       mqtt->subscribe(subBuffer, 2);
     }
@@ -413,7 +417,7 @@ public:
 
   bool onMqttMessage(char *topic, char *payload)
   {
-    //If topic beings iwth sevenSeg cut it off, otherwise not our message.
+    //If topic beings with sevenSeg cut it off, otherwise not our message.
     size_t topicPrefixLen = strlen_P(PSTR("/sevenSeg/"));
     if (strncmp_P(topic, PSTR("/sevenSeg/"), topicPrefixLen) == 0)
       topic += topicPrefixLen;

usermods/seven_segment_display_reloaded/readme.md

@@ -24,6 +24,9 @@ Enables the inverted mode in which the background should be enabled and the digi
 ### Colon-blinking
 Enables the blinking colon(s) if they are defined
 
+### Leading-Zero
+Shows the leading zero of the hour if it exists (i.e. shows `07` instead of `7`)
+
 ### enable-auto-brightness
 Enables the auto brightness feature. Can be used only when the usermod SN_Photoresistor is installed.
 

usermods/seven_segment_display_reloaded/usermod_seven_segment_reloaded.h

@@ -1,3 +1,7 @@
+#ifndef WLED_ENABLE_MQTT
+#error "This user mod requires MQTT to be enabled."
+#endif
+
 #pragma once
 
 #include "wled.h"
@@ -13,6 +17,7 @@ private:
   bool umSSDRDisplayTime = false;
   bool umSSDRInverted = false;
   bool umSSDRColonblink = true;
+  bool umSSDRLeadingZero = false;
   bool umSSDREnableLDR = false;
   String umSSDRHours = "";
   String umSSDRMinutes = "";
@@ -75,6 +80,7 @@ private:
   static const char _str_timeEnabled[];
   static const char _str_inverted[];
   static const char _str_colonblink[];
+  static const char _str_leadingZero[];
   static const char _str_displayMask[];
   static const char _str_hours[];
   static const char _str_minutes[];
@@ -101,15 +107,15 @@ private:
       switch (umSSDRDisplayMask[index]) {
         case 'h':
           timeVar = hourFormat12(localTime);
-          _showElements(&umSSDRHours, timeVar, 0, 1);
+          _showElements(&umSSDRHours, timeVar, 0, !umSSDRLeadingZero);
           break;
         case 'H':
           timeVar = hour(localTime);
-          _showElements(&umSSDRHours, timeVar, 0, 1);
+          _showElements(&umSSDRHours, timeVar, 0, !umSSDRLeadingZero);
           break;
         case 'k':
           timeVar = hour(localTime) + 1;
-          _showElements(&umSSDRHours, timeVar, 0, 0);
+          _showElements(&umSSDRHours, timeVar, 0, !umSSDRLeadingZero);
           break;
         case 'm':
           timeVar = minute(localTime);
@@ -305,6 +311,9 @@ private:
     if (_cmpIntSetting_P(topic, payload, _str_colonblink, &umSSDRColonblink)) {
       return true;
     }
+    if (_cmpIntSetting_P(topic, payload, _str_leadingZero, &umSSDRLeadingZero)) {
+      return true;
+    }
     if (strcmp_P(topic, _str_displayMask) == 0) {
       umSSDRDisplayMask = String(payload);
       _publishMQTTstr_P(_str_displayMask, umSSDRDisplayMask);
@@ -319,6 +328,7 @@ private:
     _publishMQTTint_P(_str_ldrEnabled, umSSDREnableLDR);
     _publishMQTTint_P(_str_inverted, umSSDRInverted);
     _publishMQTTint_P(_str_colonblink, umSSDRColonblink);
+    _publishMQTTint_P(_str_leadingZero, umSSDRLeadingZero);
 
     _publishMQTTstr_P(_str_hours, umSSDRHours);
     _publishMQTTstr_P(_str_minutes, umSSDRMinutes);
@@ -343,6 +353,7 @@ private:
     ssdrObj[FPSTR(_str_ldrEnabled)] = umSSDREnableLDR;
     ssdrObj[FPSTR(_str_inverted)] = umSSDRInverted;
     ssdrObj[FPSTR(_str_colonblink)] = umSSDRColonblink;
+    ssdrObj[FPSTR(_str_leadingZero)] = umSSDRLeadingZero;
     ssdrObj[FPSTR(_str_displayMask)] = umSSDRDisplayMask;
     ssdrObj[FPSTR(_str_hours)] = umSSDRHours;
     ssdrObj[FPSTR(_str_minutes)] = umSSDRMinutes;
@@ -421,6 +432,8 @@ public:
     invert.add(umSSDRInverted);
     JsonArray blink = user.createNestedArray("Blinking colon");
     blink.add(umSSDRColonblink);
+    JsonArray zero = user.createNestedArray("Show the hour leading zero");
+    zero.add(umSSDRLeadingZero);
     JsonArray ldrEnable = user.createNestedArray("Auto Brightness enabled");
     ldrEnable.add(umSSDREnableLDR);
 
@@ -450,6 +463,7 @@ public:
       umSSDREnableLDR = ssdrObj[FPSTR(_str_ldrEnabled)] | umSSDREnableLDR;
       umSSDRInverted = ssdrObj[FPSTR(_str_inverted)] | umSSDRInverted;
       umSSDRColonblink = ssdrObj[FPSTR(_str_colonblink)] | umSSDRColonblink;
+      umSSDRLeadingZero = ssdrObj[FPSTR(_str_leadingZero)] | umSSDRLeadingZero;
       umSSDRDisplayMask = ssdrObj[FPSTR(_str_displayMask)] | umSSDRDisplayMask;
     }
   }
@@ -466,14 +480,14 @@ public:
 
     if (mqttGroupTopic[0] != 0)
     {
-      //subcribe for sevenseg messages on the group topic
+      //subscribe for sevenseg messages on the group topic
       sprintf_P(subBuffer, PSTR("%s/%S/+/set"), mqttGroupTopic, _str_name);
       mqtt->subscribe(subBuffer, 2);
     }
   }
 
   bool onMqttMessage(char *topic, char *payload) {
-    //If topic beings iwth sevenSeg cut it off, otherwise not our message.
+    //If topic begins with sevenSeg cut it off, otherwise not our message.
     size_t topicPrefixLen = strlen_P(PSTR("/wledSS/"));
     if (strncmp_P(topic, PSTR("/wledSS/"), topicPrefixLen) == 0) {
       topic += topicPrefixLen;
@@ -512,6 +526,7 @@ public:
     umSSDREnableLDR        = (top[FPSTR(_str_ldrEnabled)] | umSSDREnableLDR);
     umSSDRInverted         = (top[FPSTR(_str_inverted)] | umSSDRInverted);
     umSSDRColonblink       = (top[FPSTR(_str_colonblink)] | umSSDRColonblink);
+    umSSDRLeadingZero      = (top[FPSTR(_str_leadingZero)] | umSSDRLeadingZero);
 
     umSSDRDisplayMask      = top[FPSTR(_str_displayMask)] | umSSDRDisplayMask;
     umSSDRHours            = top[FPSTR(_str_hours)] | umSSDRHours;
@@ -542,6 +557,7 @@ const char UsermodSSDR::_str_name[]        PROGMEM = "UsermodSSDR";
 const char UsermodSSDR::_str_timeEnabled[] PROGMEM = "enabled";
 const char UsermodSSDR::_str_inverted[]    PROGMEM = "inverted";
 const char UsermodSSDR::_str_colonblink[]  PROGMEM = "Colon-blinking";
+const char UsermodSSDR::_str_leadingZero[] PROGMEM = "Leading-Zero";
 const char UsermodSSDR::_str_displayMask[] PROGMEM = "Display-Mask";
 const char UsermodSSDR::_str_hours[]       PROGMEM = "LED-Numbers-Hours";
 const char UsermodSSDR::_str_minutes[]     PROGMEM = "LED-Numbers-Minutes";

usermods/sht/usermod_sht.h

@@ -1,3 +1,7 @@
+#ifndef WLED_ENABLE_MQTT
+#error "This user mod requires MQTT to be enabled."
+#endif
+
 #pragma once
 
 #include "SHT85.h"
@@ -12,13 +16,12 @@ class ShtUsermod : public Usermod
   private:
     bool enabled = false; // Is usermod enabled or not
     bool firstRunDone = false; // Remembers if the first config load run had been done
-    bool pinAllocDone = true; // Remembers if we have allocated pins
     bool initDone = false; // Remembers if the mod has been completely initialised
     bool haMqttDiscovery = false; // Is MQTT discovery enabled or not
     bool haMqttDiscoveryDone = false; // Remembers if we already published the HA discovery topics
 
     // SHT vars
-    SHT *shtTempHumidSensor; // Instance of SHT lib
+    SHT *shtTempHumidSensor = nullptr; // Instance of SHT lib
     byte shtType = 0; // SHT sensor type to be used. Default: SHT30
     byte unitOfTemp = 0; // Temperature unit to be used. Default: Celsius (0 = Celsius, 1 = Fahrenheit)
     bool shtInitDone = false; // Remembers if SHT sensor has been initialised
@@ -26,15 +29,14 @@ class ShtUsermod : public Usermod
     const byte shtI2cAddress = 0x44; // i2c address of the sensor. 0x44 is the default for all SHT sensors. Change this, if needed
     unsigned long shtLastTimeUpdated = 0; // Remembers when we read data the last time
     bool shtDataRequested = false; // Reading data is done async. This remembers if we asked the sensor to read data
-    float shtCurrentTempC = 0; // Last read temperature in Celsius
-    float shtCurrentTempF = 0; // Last read temperature in Fahrenheit
-    float shtCurrentHumidity = 0; // Last read humidity in RH%
+    float shtCurrentTempC = 0.0f; // Last read temperature in Celsius
+    float shtCurrentHumidity = 0.0f; // Last read humidity in RH%
 
 
     void initShtTempHumiditySensor();
     void cleanupShtTempHumiditySensor();
     void cleanup();
-    bool isShtReady();
+    inline bool isShtReady() { return shtInitDone; } // Checks if the SHT sensor has been initialised.
 
     void publishTemperatureAndHumidityViaMqtt();
     void publishHomeAssistantAutodiscovery();
@@ -56,18 +58,22 @@ class ShtUsermod : public Usermod
     bool readFromConfig(JsonObject &root);
     void addToJsonInfo(JsonObject& root);
 
-    float getTemperatureC();
-    float getTemperatureF();
-    float getHumidity();
+    bool isEnabled() { return enabled; }
+
+    float getTemperature();
+    float getTemperatureC() { return roundf(shtCurrentTempC * 10.0f) / 10.0f; }
+    float getTemperatureF() { return (getTemperatureC() * 1.8f) + 32.0f; }
+    float getHumidity() { return roundf(shtCurrentHumidity * 10.0f) / 10.0f; }
+    const char* getUnitString();
 
     uint16_t getId() { return USERMOD_ID_SHT; }
 };
 
 // Strings to reduce flash memory usage (used more than twice)
-const char ShtUsermod::_name[]    PROGMEM = "SHT-Sensor";
-const char ShtUsermod::_enabled[] PROGMEM = "Enabled";
-const char ShtUsermod::_shtType[] PROGMEM = "SHT-Type";
-const char ShtUsermod::_unitOfTemp[] PROGMEM = "Unit";
+const char ShtUsermod::_name[]            PROGMEM = "SHT-Sensor";
+const char ShtUsermod::_enabled[]         PROGMEM = "Enabled";
+const char ShtUsermod::_shtType[]         PROGMEM = "SHT-Type";
+const char ShtUsermod::_unitOfTemp[]      PROGMEM = "Unit";
 const char ShtUsermod::_haMqttDiscovery[] PROGMEM = "Add-To-HA-MQTT-Discovery";
 
 /**
@@ -87,10 +93,9 @@ void ShtUsermod::initShtTempHumiditySensor()
     case USERMOD_SHT_TYPE_SHT85: shtTempHumidSensor = (SHT *) new SHT85(); break;
   }
 
-  shtTempHumidSensor->begin(shtI2cAddress, i2c_sda, i2c_scl);
+  shtTempHumidSensor->begin(shtI2cAddress); // uses &Wire
   if (shtTempHumidSensor->readStatus() == 0xFFFF) {
     DEBUG_PRINTF("[%s] SHT init failed!\n", _name);
-    cleanupShtTempHumiditySensor();
     cleanup();
     return;
   }
@@ -109,10 +114,9 @@ void ShtUsermod::cleanupShtTempHumiditySensor()
 {
   if (isShtReady()) {
     shtTempHumidSensor->reset();
+    delete shtTempHumidSensor;
+    shtTempHumidSensor = nullptr;
   }
-
-  delete shtTempHumidSensor;
-
   shtInitDone = false;
 }
 
@@ -126,29 +130,10 @@ void ShtUsermod::cleanupShtTempHumiditySensor()
  */
 void ShtUsermod::cleanup()
 {
-  if (isShtReady()) {
-    cleanupShtTempHumiditySensor();
-  }
-
-  if (pinAllocDone) {
-    PinManagerPinType pins[2] = { { i2c_sda, true }, { i2c_scl, true } };
-    pinManager.deallocateMultiplePins(pins, 2, PinOwner::HW_I2C);
-    pinAllocDone = false;
-  }
-
+  cleanupShtTempHumiditySensor();
   enabled = false;
 }
 
-/**
- * Checks if the SHT sensor has been initialised.
-  *
- * @return bool
- */
-bool ShtUsermod::isShtReady()
-{
-  return shtInitDone;
-}
-
 /**
  * Publish temperature and humidity to WLED device topic.
  *
@@ -162,9 +147,9 @@ void ShtUsermod::publishTemperatureAndHumidityViaMqtt() {
   char buf[128];
 
   snprintf_P(buf, 127, PSTR("%s/temperature"), mqttDeviceTopic);
-  mqtt->publish(buf, 0, false, String((unitOfTemp ? getTemperatureF() : getTemperatureC())).c_str());
+  mqtt->publish(buf, 0, false, String(getTemperature()).c_str());
   snprintf_P(buf, 127, PSTR("%s/humidity"), mqttDeviceTopic);
-  mqtt->publish(buf, 0, false, String(shtCurrentHumidity).c_str());
+  mqtt->publish(buf, 0, false, String(getHumidity()).c_str());
 }
 
 /**
@@ -191,7 +176,7 @@ void ShtUsermod::publishHomeAssistantAutodiscovery() {
   json[F("stat_cla")] = F("measurement");
   snprintf_P(buf, 127, PSTR("%s-temperature"), escapedMac.c_str());
   json[F("uniq_id")] = buf;
-  json[F("unit_of_meas")] = F("°C");
+  json[F("unit_of_meas")] = unitOfTemp ? F("°F") : F("°C");
   appendDeviceToMqttDiscoveryMessage(json);
   payload_size = serializeJson(json, json_str);
   snprintf_P(buf, 127, PSTR("homeassistant/sensor/%s/%s-temperature/config"), escapedMac.c_str(), escapedMac.c_str());
@@ -222,7 +207,7 @@ void ShtUsermod::publishHomeAssistantAutodiscovery() {
  * @return void
  */
 void ShtUsermod::appendDeviceToMqttDiscoveryMessage(JsonDocument& root) {
-  JsonObject device = root.createNestedObject("dev");
+  JsonObject device = root.createNestedObject(F("dev"));
   device[F("ids")] = escapedMac.c_str();
   device[F("name")] = serverDescription;
   device[F("sw")] = versionString;
@@ -244,14 +229,12 @@ void ShtUsermod::appendDeviceToMqttDiscoveryMessage(JsonDocument& root) {
 void ShtUsermod::setup()
 {
   if (enabled) {
-    PinManagerPinType pins[2] = { { i2c_sda, true }, { i2c_scl, true } };
-    // GPIOs can be set to -1 and allocateMultiplePins() will return true, so check they're gt zero
-    if (i2c_sda < 0 || i2c_scl < 0 || !pinManager.allocateMultiplePins(pins, 2, PinOwner::HW_I2C)) {
-      DEBUG_PRINTF("[%s] SHT pin allocation failed!\n", _name);
+    // GPIOs can be set to -1 , so check they're gt zero
+    if (i2c_sda < 0 || i2c_scl < 0) {
+      DEBUG_PRINTF("[%s] I2C bus not initialised!\n", _name);
       cleanup();
       return;
     }
-    pinAllocDone = true;
 
     initShtTempHumiditySensor();
 
@@ -290,13 +273,11 @@ void ShtUsermod::loop()
       if (shtTempHumidSensor->dataReady()) {
         if (shtTempHumidSensor->readData(false)) {
           shtCurrentTempC = shtTempHumidSensor->getTemperature();
-          shtCurrentTempF = shtTempHumidSensor->getFahrenheit();
           shtCurrentHumidity = shtTempHumidSensor->getHumidity();
 
           publishTemperatureAndHumidityViaMqtt();
           shtReadDataSuccess = true;
-        }
-        else {
+        } else {
           shtReadDataSuccess = false;
         }
 
@@ -309,7 +290,7 @@ void ShtUsermod::loop()
 /**
  * Whenever MQTT is connected, publish HA autodiscovery topics.
  *
- * Is only donce once.
+ * Is only done once.
  *
  * @see Usermod::onMqttConnect()
  * @see UsermodManager::onMqttConnect()
@@ -387,6 +368,7 @@ bool ShtUsermod::readFromConfig(JsonObject &root)
 
   bool oldEnabled = enabled;
   byte oldShtType = shtType;
+  byte oldUnitOfTemp = unitOfTemp;
   bool oldHaMqttDiscovery = haMqttDiscovery;
 
   getJsonValue(top[FPSTR(_enabled)], enabled);
@@ -410,6 +392,11 @@ bool ShtUsermod::readFromConfig(JsonObject &root)
       initShtTempHumiditySensor();
     }
 
+    if (oldUnitOfTemp != unitOfTemp) {
+      publishTemperatureAndHumidityViaMqtt();
+      publishHomeAssistantAutodiscovery();
+    }
+
     if (oldHaMqttDiscovery != haMqttDiscovery && haMqttDiscovery) {
       publishHomeAssistantAutodiscovery();
     }
@@ -448,45 +435,46 @@ void ShtUsermod::addToJsonInfo(JsonObject& root)
     if (shtLastTimeUpdated == 0) {
       jsonTemp.add(F(" Not read yet"));
       jsonHumidity.add(F(" Not read yet"));
-    }
-    else {
+    } else {
       jsonTemp.add(F(" Error"));
       jsonHumidity.add(F(" Error"));
     }
-
     return;
   }
 
-  jsonHumidity.add(shtCurrentHumidity);
+  jsonHumidity.add(getHumidity());
   jsonHumidity.add(F(" RH"));
 
-  unitOfTemp ? jsonTemp.add(getTemperatureF()) : jsonTemp.add(getTemperatureC());
-  unitOfTemp ? jsonTemp.add(F(" °F")) : jsonTemp.add(F(" °C"));
+  jsonTemp.add(getTemperature());
+  jsonTemp.add(getUnitString());
+
+  // sensor object
+  JsonObject sensor = root[F("sensor")];
+  if (sensor.isNull()) sensor = root.createNestedObject(F("sensor"));
+
+  jsonTemp = sensor.createNestedArray(F("temp"));
+  jsonTemp.add(getTemperature());
+  jsonTemp.add(getUnitString());
+
+  jsonHumidity = sensor.createNestedArray(F("humidity"));
+  jsonHumidity.add(getHumidity());
+  jsonHumidity.add(F(" RH"));
 }
 
 /**
- * Getter for last read temperature in Celsius.
+ * Getter for last read temperature for configured unit.
  *
  * @return float
  */
-float ShtUsermod::getTemperatureC() {
-  return shtCurrentTempC;
+float ShtUsermod::getTemperature() {
+  return unitOfTemp ? getTemperatureF() : getTemperatureC();
 }
 
 /**
- * Getter for last read temperature in Fahrenheit.
+ * Returns the current configured unit as human readable string.
  *
- * @return float
+ * @return const char*
  */
-float ShtUsermod::getTemperatureF() {
-  return shtCurrentTempF;
-}
-
-/**
- * Getter for last read humidity in RH%.
- *
- * @return float
- */
-float ShtUsermod::getHumidity() {
-  return shtCurrentHumidity;
+const char* ShtUsermod::getUnitString() {
+  return unitOfTemp ? "°F" : "°C";
 }

usermods/smartnest/usermod_smartnest.h

@@ -1,3 +1,7 @@
+#ifndef WLED_ENABLE_MQTT
+#error "This user mod requires MQTT to be enabled."
+#endif
+
 #pragma once
 
 #include "wled.h"

usermods/stairway_wipe_basic/readme.md

@@ -1,5 +1,13 @@
-### Stairway lighting
+# Stairway lighting
 
+## Install
+Add the buildflag `-D USERMOD_STAIRCASE_WIPE` to your enviroment to activate it.
+
+### Configuration
+`-D STAIRCASE_WIPE_OFF` 
+<br>Have the LEDs wipe off instead of fading out
+
+## Description
 Quick usermod to accomplish something similar to [this video](https://www.youtube.com/watch?v=NHkju5ncC4A).
 
 This usermod enables you to add a lightstrip alongside or on the steps of a staircase.

usermods/stairway_wipe_basic/stairway-wipe-usermod-v2.h

@@ -19,10 +19,12 @@ class StairwayWipeUsermod : public Usermod {
     unsigned long timeStaticStart = 0;
     uint16_t previousUserVar0 = 0;
 
+//moved to buildflag
 //comment this out if you want the turn off effect to be just fading out instead of reverse wipe
-#define STAIRCASE_WIPE_OFF
+//#define STAIRCASE_WIPE_OFF
   public:
-
+void setup() {
+    }
     void loop() {
   //userVar0 (U0 in HTTP API):
   //has to be set to 1 if movement is detected on the PIR that is the same side of the staircase as the ESP8266
@@ -84,14 +86,15 @@ class StairwayWipeUsermod : public Usermod {
 
     uint16_t getId()
     {
-      return USERMOD_ID_EXAMPLE;
+      return USERMOD_ID_STAIRWAY_WIPE;
     }
 
 
     void startWipe()
     {
     bri = briLast; //turn on
-    transitionDelayTemp = 0; //no transition
+    jsonTransitionOnce = true;
+    strip.setTransition(0); //no transition
     effectCurrent = FX_MODE_COLOR_WIPE;
     resetTimebase(); //make sure wipe starts from beginning
 
@@ -105,10 +108,11 @@ class StairwayWipeUsermod : public Usermod {
 
     void turnOff()
     {
+    jsonTransitionOnce = true;
     #ifdef STAIRCASE_WIPE_OFF
-    transitionDelayTemp = 0; //turn off immediately after wipe completed
+    strip.setTransition(0); //turn off immediately after wipe completed
     #else
-    transitionDelayTemp = 4000; //fade out slowly
+    strip.setTransition(4000); //fade out slowly
     #endif
     bri = 0;
     stateUpdated(CALL_MODE_NOTIFICATION);

usermods/usermod_rotary_brightness_color/usermod_rotary_brightness_color.h

@@ -23,7 +23,7 @@ private:
   unsigned char Enc_B;
   unsigned char Enc_A_prev = 0;
 
-  // private class memebers configurable by Usermod Settings (defaults set inside readFromConfig())
+  // private class members configurable by Usermod Settings (defaults set inside readFromConfig())
   int8_t pins[3]; // pins[0] = DT from encoder, pins[1] = CLK from encoder, pins[2] = CLK from encoder (optional)
   int fadeAmount; // how many points to fade the Neopixel with each step
 
@@ -162,7 +162,7 @@ public:
    * - configComplete is used to return false if any value is missing, not just if the main object is missing
    * - The defaults are loaded every time readFromConfig() is run, not just once after boot
    * 
-   * This ensures that missing values are added to the config, with their default values, in the rare but plauible cases of:
+   * This ensures that missing values are added to the config, with their default values, in the rare but plausible cases of:
    * - a single value being missing at boot, e.g. if the Usermod was upgraded and a new setting was added
    * - a single value being missing after boot (e.g. if the cfg.json was manually edited and a value was removed)
    * 

usermods/usermod_v2_HttpPullLightControl/readme.md

@@ -0,0 +1,110 @@
+# usermod_v2_HttpPullLightControl
+
+The `usermod_v2_HttpPullLightControl` is a custom user module for WLED that enables remote control over the lighting state and color through HTTP requests. It periodically polls a specified URL to obtain a JSON response containing instructions for controlling individual lights.
+
+## Features
+
+* Configure the URL endpoint (only support HTTP for now, no HTTPS) and polling interval via the WLED user interface.
+* All options from the JSON API are supported (since v0.0.3). See: https://kno.wled.ge/interfaces/json-api/ 
+* The ability to control the brightness of all lights and the state (on/off) and color of individual lights remotely.
+* Start or stop an effect and when you run the same effect when its's already running, it won't restart.
+* The ability to control all these settings per segment.
+* Remotely turn on/off relays, change segments or presets.
+* Unique ID generation based on the device's MAC address and a configurable salt value, appended to the request URL for identification.
+
+## Configuration
+* Enable the `usermod_v2_HttpPullLightControl` via the WLED user interface.
+* Specify the URL endpoint and polling interval.
+
+## JSON Format and examples
+* The module sends a GET request to the configured URL, appending a unique identifier as a query parameter: `https://www.example.com/mycustompage.php?id=xxxxxxxx` where xxxxxxx is a 40 character long SHA1 hash of the MAC address combined with a given salt.
+
+* Response Format (since v0.0.3) it is eactly the same as the WLED JSON API, see: https://kno.wled.ge/interfaces/json-api/
+After getting the URL (it can be a static file like static.json or a mylogic.php which gives a dynamic response), the response is read and parsed to WLED.
+
+* An example of a response to set the individual lights: 0 to RED, 12 to Green and 14 to BLUE. Remember that is will SET lights, you might want to set all the others to black.
+`{
+  "seg":
+    {
+      "i": [
+        0, "FF0000",
+        12, "00FF00",
+        14, "0000FF"
+      ]
+    }
+}`
+
+* Another example setting the first 10 LEDs to RED, LED 40 to a PURPLE (using RGB values) and all LEDs in between OFF (black color)
+`{
+  "seg":
+    {
+      "i": [
+        0,10, "FF0000",
+        10,40, "00FF00",
+        40, [0,100,100]
+      ]
+    }
+}`
+
+* Or first set all lights to black (off), then the LED5 to color RED:
+`{
+  "seg":
+    {
+      "i": [
+        0,40, "000000",
+        5, "FF0000"
+      ]
+    }
+}`
+
+* Or use the following example to start an effect, but first we UNFREEZE (frz=false) the segment because it was frozen by individual light control in the previous examples (28=Chase effect, Speed=180m Intensity=128). The three color slots are the slots you see under the color wheel and used by the effect. RED, Black, White in this case.
+`{
+  "seg":
+    {
+	    "frz": false,
+      "fx": 28,
+      "sx": 200,
+      "ix": 128,
+	    "col": [
+		    "FF0000",
+			  "000000",
+			  "FFFFFF"
+	    ]
+	  }
+}`
+
+
+## Installation
+
+1. Add `usermod_v2_HttpPullLightControl` to your WLED project following the instructions provided in the WLED documentation.
+2. Compile by setting the build_flag: -D USERMOD_HTTP_PULL_LIGHT_CONTROL and upload to your ESP32/ESP8266!
+3. There are several compile options which you can put in your platformio.ini or platformio_override.ini:
+- -DUSERMOD_HTTP_PULL_LIGHT_CONTROL   ;To Enable the usermod
+- -DHTTP_PULL_LIGHT_CONTROL_URL="\"http://mydomain.com/json-response.php\""   ; The URL which will be requested all the time to set the lights/effects
+-  -DHTTP_PULL_LIGHT_CONTROL_SALT="\"my_very-S3cret_C0de\""  ; A secret SALT which will help by making the ID more safe
+-  -DHTTP_PULL_LIGHT_CONTROL_INTERVAL=30 ; The interval at which the URL is requested in seconds
+-  -DHTTP_PULL_LIGHT_CONTROL_HIDE_SALT ; Do you want to Hide the SALT in the User Interface? If yes, Set this flag. Note that the salt can now only be set via the above -DHTTP_PULL_LIGHT_CONTROL_SALT= setting
+
+-  -DWLED_AP_SSID="\"Christmas Card\"" ; These flags are not just for my Usermod but you probably want to set them
+-  -DWLED_AP_PASS="\"christmas\""
+-  -DWLED_OTA_PASS="\"otapw-secret\""
+-  -DMDNS_NAME="\"christmascard\""
+-  -DSERVERNAME="\"CHRISTMASCARD\""
+-  -D ABL_MILLIAMPS_DEFAULT=450
+-  -D DEFAULT_LED_COUNT=60 ; For a LED Ring of 60 LEDs
+-  -D BTNPIN=41  ; The M5Stack Atom S3 Lite has a button on GPIO41
+-  -D LEDPIN=2 ; The M5Stack Atom S3 Lite has a Grove connector on the front, we use this GPIO2
+-  -D STATUSLED=35 ; The M5Stack Atom S3 Lite has a Multi-Color LED on GPIO35, although I didnt managed to control it
+-  -D IRPIN=4  ; The M5Stack Atom S3 Lite has a IR LED on GPIO4
+
+-  -D DEBUG=1  ; Set these DEBUG flags ONLY if you want to debug and read out Serial (using Visual Studio Code - Serial Monitor)
+-  -DDEBUG_LEVEL=5
+-  -DWLED_DEBUG
+
+## Use Case: Interactive Christmas Cards
+
+Imagine distributing interactive Christmas cards embedded with a tiny ESP32 and a string of 20 LEDs to 20 friends. When a friend powers on their card, it connects to their Wi-Fi network and starts polling your server via the `usermod_v2_HttpPullLightControl`. (Tip: Let them scan a QR code to connect to the WLED WiFi, from there they configure their own WiFi).
+
+Your server keeps track of how many cards are active at any given time. If all 20 cards are active, your server instructs each card to light up all of its LEDs. However, if only 4 cards are active, your server instructs each card to light up only 4 LEDs. This creates a real-time interactive experience, symbolizing the collective spirit of the holiday season. Each lit LED represents a friend who's thinking about the others, and the visual feedback creates a sense of connection among the group, despite the physical distance.
+
+This setup demonstrates a unique way to blend traditional holiday sentiments with modern technology, offering an engaging and memorable experience.

usermods/usermod_v2_HttpPullLightControl/usermod_v2_HttpPullLightControl.cpp

@@ -0,0 +1,319 @@
+#include "usermod_v2_HttpPullLightControl.h"
+
+// add more strings here to reduce flash memory usage
+const char HttpPullLightControl::_name[]    PROGMEM = "HttpPullLightControl";
+const char HttpPullLightControl::_enabled[] PROGMEM = "Enable";
+
+void HttpPullLightControl::setup() {
+  //Serial.begin(115200);
+
+  // Print version number
+  DEBUG_PRINT(F("HttpPullLightControl version: "));
+  DEBUG_PRINTLN(HTTP_PULL_LIGHT_CONTROL_VERSION);
+
+  // Start a nice chase so we know its booting and searching for its first http pull.
+  DEBUG_PRINTLN(F("Starting a nice chase so we now it is booting."));
+  Segment& seg = strip.getMainSegment();
+  seg.setMode(28); // Set to chase
+  seg.speed = 200;
+  seg.intensity = 255;
+  seg.setPalette(128);
+  seg.setColor(0, 5263440);
+  seg.setColor(1, 0);
+  seg.setColor(2, 4605510);
+
+  // Go on with generating a unique ID and splitting the URL into parts
+  uniqueId = generateUniqueId();  // Cache the unique ID
+  DEBUG_PRINT(F("UniqueId calculated: "));
+  DEBUG_PRINTLN(uniqueId);
+  parseUrl();
+  DEBUG_PRINTLN(F("HttpPullLightControl successfully setup"));
+}
+
+// This is the main loop function, from here we check the URL and handle the response.
+// Effects or individual lights are set as a result from this.
+void HttpPullLightControl::loop() {
+  if (!enabled || offMode) return; // Do nothing when not enabled or powered off
+  if (millis() - lastCheck >= checkInterval * 1000) {
+    DEBUG_PRINTLN(F("Calling checkUrl function"));
+    checkUrl();
+    lastCheck = millis();
+  }
+
+}
+
+// Generate a unique ID based on the MAC address and a SALT
+String HttpPullLightControl::generateUniqueId() {
+  uint8_t mac[6];
+  WiFi.macAddress(mac);
+  char macStr[18];
+  sprintf(macStr, "%02x:%02x:%02x:%02x:%02x:%02x", mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
+  // Set the MAC Address to a string and make it UPPERcase
+  String macString = String(macStr);
+  macString.toUpperCase();
+  DEBUG_PRINT(F("WiFi MAC address is: "));
+  DEBUG_PRINTLN(macString);
+  DEBUG_PRINT(F("Salt is: "));
+  DEBUG_PRINTLN(salt);
+  String input = macString + salt;
+
+  #ifdef ESP8266
+    // For ESP8266 we use the Hash.h library which is built into the ESP8266 Core
+    return sha1(input);
+  #endif
+
+  #ifdef ESP32
+    // For ESP32 we use the mbedtls library which is built into the ESP32 core
+    int status = 0;
+    unsigned char shaResult[20]; // SHA1 produces a hash of 20 bytes  (which is 40 HEX characters)
+    mbedtls_sha1_context ctx;
+    mbedtls_sha1_init(&ctx);
+    status = mbedtls_sha1_starts_ret(&ctx);
+    if (status != 0) {
+      DEBUG_PRINTLN(F("Error starting SHA1 checksum calculation"));
+    }
+    status = mbedtls_sha1_update_ret(&ctx, reinterpret_cast<const unsigned char*>(input.c_str()), input.length());
+    if (status != 0) {
+      DEBUG_PRINTLN(F("Error feeding update buffer into ongoing SHA1 checksum calculation"));
+    }
+    status = mbedtls_sha1_finish_ret(&ctx, shaResult);
+    if (status != 0) {
+      DEBUG_PRINTLN(F("Error finishing SHA1 checksum calculation"));
+    }
+    mbedtls_sha1_free(&ctx);
+
+    // Convert the Hash to a hexadecimal string
+    char buf[41];
+    for (int i = 0; i < 20; i++) {
+      sprintf(&buf[i*2], "%02x", shaResult[i]);
+    }
+    return String(buf);
+  #endif
+}
+
+// This function is called when the user updates the Sald and so we need to re-calculate the unique ID
+void HttpPullLightControl::updateSalt(String newSalt) {
+  DEBUG_PRINTLN(F("Salt updated"));
+  this->salt = newSalt;
+  uniqueId = generateUniqueId();
+  DEBUG_PRINT(F("New UniqueId is: "));
+  DEBUG_PRINTLN(uniqueId);
+}
+
+// The function is used to separate the URL in a host part and a path part
+void HttpPullLightControl::parseUrl() {
+  int firstSlash = url.indexOf('/', 7);  // Skip http(s)://
+  host = url.substring(7, firstSlash);
+  path = url.substring(firstSlash);
+}
+
+// This function is called by WLED when the USERMOD config is read
+bool HttpPullLightControl::readFromConfig(JsonObject& root) {
+  // Attempt to retrieve the nested object for this usermod
+  JsonObject top = root[FPSTR(_name)];
+  bool configComplete = !top.isNull();  // check if the object exists
+
+  // Retrieve the values using the getJsonValue function for better error handling
+  configComplete &= getJsonValue(top[FPSTR(_enabled)], enabled, enabled);  // default value=enabled
+  configComplete &= getJsonValue(top["checkInterval"], checkInterval, checkInterval);  // default value=60
+  #ifndef HTTP_PULL_LIGHT_CONTROL_HIDE_URL
+    configComplete &= getJsonValue(top["url"], url, url);  // default value="http://example.com"
+  #endif
+  #ifndef HTTP_PULL_LIGHT_CONTROL_HIDE_SALT
+    configComplete &= getJsonValue(top["salt"], salt, salt);  // default value=your_salt_here
+  #endif
+
+  return configComplete;
+}
+
+// This function is called by WLED when the USERMOD config is saved in the frontend
+void HttpPullLightControl::addToConfig(JsonObject& root) {
+  // Create a nested object for this usermod
+  JsonObject top = root.createNestedObject(FPSTR(_name));
+
+  // Write the configuration parameters to the nested object
+  top[FPSTR(_enabled)] = enabled;
+  if (enabled==false)
+    // To make it a bit more user-friendly, we unfreeze the main segment after disabling the module. Because individual light control (like for a christmas card) might have been done.
+    strip.getMainSegment().freeze=false;
+  top["checkInterval"] = checkInterval;
+  #ifndef HTTP_PULL_LIGHT_CONTROL_HIDE_URL
+    top["url"] = url;
+  #endif
+  #ifndef HTTP_PULL_LIGHT_CONTROL_HIDE_SALT
+    top["salt"] = salt;
+    updateSalt(salt);  // Update the UniqueID
+  #endif
+  parseUrl();  // Re-parse the URL, maybe path and host is changed
+}
+
+// Do the http request here. Note that we can not do https requests with the AsyncTCP library
+// We do everything Asynchronous, so all callbacks are defined here
+void HttpPullLightControl::checkUrl() {
+  // Extra Inactivity check to see if AsyncCLient hangs
+  if (client != nullptr && ( millis() - lastActivityTime > inactivityTimeout ) ) {
+      DEBUG_PRINTLN(F("Inactivity detected, deleting client."));
+      delete client;
+      client = nullptr;
+  }
+  if (client != nullptr && client->connected()) {
+      DEBUG_PRINTLN(F("We are still connected, do nothing"));
+      // Do nothing, Client is still connected
+      return;
+  }
+
+  if (client != nullptr) {
+    // Delete previous client instance if exists, just to prevent any memory leaks
+    DEBUG_PRINTLN(F("Delete previous instances"));
+    delete client;
+    client = nullptr;
+  }
+
+  DEBUG_PRINTLN(F("Creating new AsyncClient instance."));
+  client = new AsyncClient();
+  if(client) {
+    client->onData([](void *arg, AsyncClient *c, void *data, size_t len) {
+      DEBUG_PRINTLN(F("Data received."));
+      // Cast arg back to the usermod class instance
+      HttpPullLightControl *instance = (HttpPullLightControl *)arg;
+      instance->lastActivityTime = millis(); // Update lastactivity time when data is received
+      // Convertert to Safe-String
+      char *strData = new char[len + 1];
+      strncpy(strData, (char*)data, len);
+      strData[len] = '\0';
+      String responseData = String(strData);
+      //String responseData = String((char *)data);
+      // Make sure its zero-terminated String
+      //responseData[len] = '\0';
+      delete[] strData; // Do not forget to remove this one
+      instance->handleResponse(responseData);
+    }, this);
+    client->onDisconnect([](void *arg, AsyncClient *c) {
+      DEBUG_PRINTLN(F("Disconnected."));
+      //Set the class-own client pointer to nullptr if its the current client
+      HttpPullLightControl *instance = static_cast<HttpPullLightControl*>(arg);
+      if (instance->client == c) {
+        delete instance->client; // Delete the client instance
+        instance->client = nullptr;
+      }
+    }, this);
+    client->onTimeout([](void *arg, AsyncClient *c, uint32_t time) {
+      DEBUG_PRINTLN(F("Timeout"));
+      //Set the class-own client pointer to nullptr if its the current client
+      HttpPullLightControl *instance = static_cast<HttpPullLightControl*>(arg);
+      if (instance->client == c) {
+        delete instance->client; // Delete the client instance
+        instance->client = nullptr;
+      }
+    }, this);
+    client->onError([](void *arg, AsyncClient *c, int8_t error) {
+      DEBUG_PRINTLN("Connection error occurred!");
+      DEBUG_PRINT("Error code: ");
+      DEBUG_PRINTLN(error);
+      //Set the class-own client pointer to nullptr if its the current client
+      HttpPullLightControl *instance = static_cast<HttpPullLightControl*>(arg);
+      if (instance->client == c) {
+        delete instance->client;
+        instance->client = nullptr;
+      }
+      // Do not remove client here, it is maintained by AsyncClient
+    }, this);
+    client->onConnect([](void *arg, AsyncClient *c) {
+      // Cast arg back to the usermod class instance
+      HttpPullLightControl *instance = (HttpPullLightControl *)arg;
+      instance->onClientConnect(c);  // Call a method on the instance when the client connects
+    }, this);
+    client->setAckTimeout(ackTimeout); // Just some safety measures because we do not want any memory fillup
+    client->setRxTimeout(rxTimeout);
+    DEBUG_PRINT(F("Connecting to: "));
+    DEBUG_PRINT(host);
+    DEBUG_PRINT(F(" via port "));
+    DEBUG_PRINTLN((url.startsWith("https")) ? 443 : 80);
+    // Update lastActivityTime just before sending the request
+    lastActivityTime = millis();
+    //Try to connect
+    if (!client->connect(host.c_str(), (url.startsWith("https")) ? 443 : 80)) {
+      DEBUG_PRINTLN(F("Failed to initiate connection."));
+      // Connection failed, so cleanup
+      delete client;
+      client = nullptr;
+    } else {
+      // Connection successfull, wait for callbacks to go on.
+      DEBUG_PRINTLN(F("Connection initiated, awaiting response..."));
+    }
+  } else {
+    DEBUG_PRINTLN(F("Failed to create AsyncClient instance."));
+  }
+}
+
+// This function is called from the checkUrl function when the connection is establised
+// We request the data here
+void HttpPullLightControl::onClientConnect(AsyncClient *c) {
+  DEBUG_PRINT(F("Client connected: "));
+  DEBUG_PRINTLN(c->connected() ? F("Yes") : F("No"));
+
+  if (c->connected()) {
+    String request = "GET " + path + (path.indexOf('?') > 0 ? "&id=" : "?id=") + uniqueId + " HTTP/1.1\r\n"
+                    "Host: " + host + "\r\n"
+                    "Connection: close\r\n"
+                    "Accept: application/json\r\n"
+                    "Accept-Encoding: identity\r\n" // No compression
+                    "User-Agent: ESP32 HTTP Client\r\n\r\n"; // Optional: User-Agent and end with a double rnrn !
+    DEBUG_PRINT(request.c_str());
+    auto bytesSent  = c->write(request.c_str());
+    if (bytesSent  == 0) {
+      // Connection could not be made
+      DEBUG_PRINT(F("Failed to send HTTP request."));
+    } else {
+      DEBUG_PRINT(F("Request sent successfully, bytes sent: "));
+      DEBUG_PRINTLN(bytesSent );
+    }
+  }
+}
+
+
+// This function is called when we receive data after connecting and doing our request
+// It parses the JSON data to WLED
+void HttpPullLightControl::handleResponse(String& responseStr) {
+  DEBUG_PRINTLN(F("Received response for handleResponse."));
+
+  // Get a Bufferlock, we can not use doc
+  if (!requestJSONBufferLock(myLockId)) {
+    DEBUG_PRINT(F("ERROR: Can not request JSON Buffer Lock, number: "));
+      DEBUG_PRINTLN(myLockId);
+      releaseJSONBufferLock(); // Just release in any case, maybe there was already a buffer lock
+    return;
+  }
+
+  // Search for two linebreaks between headers and content
+  int bodyPos = responseStr.indexOf("\r\n\r\n");
+  if (bodyPos > 0) {
+    String jsonStr = responseStr.substring(bodyPos + 4); // +4 Skip the two CRLFs
+    jsonStr.trim();
+
+    DEBUG_PRINTLN("Response: ");
+    DEBUG_PRINTLN(jsonStr);
+
+    // Check for valid JSON, otherwise we brick the program runtime
+    if (jsonStr[0] == '{' || jsonStr[0] == '[') {
+      // Attempt to deserialize the JSON response
+      DeserializationError error = deserializeJson(doc, jsonStr);
+      if (error == DeserializationError::Ok) {
+        // Get JSON object from th doc
+        JsonObject obj = doc.as<JsonObject>();
+        // Parse the object throuhg deserializeState  (use CALL_MODE_NO_NOTIFY or OR CALL_MODE_DIRECT_CHANGE)
+        deserializeState(obj, CALL_MODE_NO_NOTIFY);
+      } else {
+        // If there is an error in deserialization, exit the function
+        DEBUG_PRINT(F("DeserializationError: "));
+        DEBUG_PRINTLN(error.c_str());
+      }
+    } else {
+      DEBUG_PRINTLN(F("Invalid JSON response"));
+    }
+  } else {
+    DEBUG_PRINTLN(F("No body found in the response"));
+  }
+  // Release the BufferLock again
+  releaseJSONBufferLock();
+}

usermods/usermod_v2_HttpPullLightControl/usermod_v2_HttpPullLightControl.h

@@ -0,0 +1,104 @@
+#pragma once
+/*
+ * Usermod: HttpPullLightControl
+ * Versie: 0.0.4
+ * Repository: https://github.com/roelbroersma/WLED-usermodv2_HttpPullLightControl
+ * Author: Roel Broersma
+ * Website: https://www.roelbroersma.nl
+ * Github author: github.com/roelbroersma
+ * Description: This usermod for WLED will request a given URL to know which effects
+ *              or individual lights it should turn on/off. So you can remote control a WLED
+ *              installation without having access to it (if no port forward, vpn or public IP is available).
+ * Use Case: Create a WLED 'Ring of Thought' christmas card. Sent a LED ring with 60 LEDs to 60 friends.
+ *           When they turn it on and put it at their WiFi, it will contact your server. Now you can reply with a given
+ *           number of lights that should turn on. Each light is a friend who did contact your server in the past 5 minutes.
+ *           So on each of your friends LED rings, the number of lights will be the number of friends who have it turned on.
+ * Features: It sends a unique ID (has of MAC and salt) to the URL, so you can define each client without a need to map their IP address.
+ * Tested: Tested on WLED v0.14 with ESP32-S3 (M5Stack Atom S3 Lite), but should also workd for other ESPs and ESP8266.
+ */
+
+#include "wled.h"
+
+// Use the following for SHA1 computation of our HASH, unfortunatelly PlatformIO doesnt recognize Hash.h while its already in the Core.
+// We use Hash.h for ESP8266 (in the core) and mbedtls/sha256.h for ESP32 (in the core).
+#ifdef ESP8266
+  #include <Hash.h>
+#endif
+#ifdef ESP32
+  #include "mbedtls/sha1.h"
+#endif
+
+#define HTTP_PULL_LIGHT_CONTROL_VERSION "0.0.4"
+
+class HttpPullLightControl : public Usermod {
+private:
+  static const char _name[];
+  static const char _enabled[];
+  static const char _salt[];
+  static const char _url[];
+
+  bool enabled = true;
+
+  #ifdef HTTP_PULL_LIGHT_CONTROL_INTERVAL
+    uint16_t checkInterval = HTTP_PULL_LIGHT_CONTROL_INTERVAL;
+  #else
+    uint16_t checkInterval = 60;  // Default interval of 1 minute
+  #endif
+
+  #ifdef HTTP_PULL_LIGHT_CONTROL_URL
+    String url = HTTP_PULL_LIGHT_CONTROL_URL;
+  #else
+    String url = "http://example.org/example.php";  // Default-URL (http only!), can also be url with IP address in it. HttpS urls are not supported (yet) because of AsyncTCP library
+  #endif
+
+  #ifdef HTTP_PULL_LIGHT_CONTROL_SALT
+    String salt = HTTP_PULL_LIGHT_CONTROL_SALT;
+  #else
+    String salt = "1just_a_very-secret_salt2";  // Salt for generating a unique ID when requesting the URL (in this way you can give different answers based on the WLED device who does the request)
+  #endif
+  // NOTE THAT THERE IS ALSO A #ifdef HTTP_PULL_LIGHT_CONTROL_HIDE_URL and a HTTP_PULL_LIGHT_CONTROL_HIDE_SALT IF YOU DO NOT WANT TO SHOW THE OPTIONS IN THE USERMOD SETTINGS
+
+  // Define constants
+  static const uint8_t myLockId = USERMOD_ID_HTTP_PULL_LIGHT_CONTROL ; // Used for the requestJSONBufferLock(id) function
+  static const int16_t ackTimeout = 9000;  // ACK timeout in milliseconds when doing the URL request
+  static const uint16_t rxTimeout = 9000;  // RX timeout in milliseconds when doing the URL request
+  static const unsigned long FNV_offset_basis = 2166136261;
+  static const unsigned long FNV_prime = 16777619;
+  static const unsigned long inactivityTimeout = 30000; // When the AsyncClient is inactive (hanging) for this many milliseconds, we kill it
+
+  unsigned long lastCheck = 0;    // Timestamp of last check
+  unsigned long lastActivityTime = 0; // Time of last activity of AsyncClient
+  String host;                    // Host extracted from the URL
+  String path;                    // Path extracted from the URL
+  String uniqueId;                // Cached unique ID
+  AsyncClient *client = nullptr;  // Used very often, beware of closing and freeing
+  String generateUniqueId();
+
+  void parseUrl();
+  void updateSalt(String newSalt);  // Update the salt value and recalculate the unique ID
+  void checkUrl();                  // Check the specified URL for light control instructions
+  void handleResponse(String& response);
+  void onClientConnect(AsyncClient *c);
+
+public:
+  void setup();
+  void loop();
+  bool readFromConfig(JsonObject& root);
+  void addToConfig(JsonObject& root);
+  uint16_t getId() { return USERMOD_ID_HTTP_PULL_LIGHT_CONTROL; }
+  inline void enable(bool enable) { enabled = enable; }   // Enable or Disable the usermod
+  inline bool isEnabled() { return enabled; }             // Get usermod enabled or disabled state
+  virtual ~HttpPullLightControl() { 
+   // Remove the cached client if needed
+    if (client) {
+      client->onDisconnect(nullptr);
+      client->onError(nullptr);
+      client->onTimeout(nullptr);
+      client->onData(nullptr);
+      client->onConnect(nullptr);
+      // Now it is safe to delete the client.
+      delete client; // This is safe even if client is nullptr.
+      client = nullptr;
+    }
+  }
+};