2D compile fix

Effect: modified KITT (Scanner)

.github/FUNDING.yml

@@ -1,2 +1,2 @@
-github: [Aircoookie]
-custom: ['https://paypal.me/Aircoookie']
+github: [Aircoookie,blazoncek]
+custom: ['https://paypal.me/Aircoookie','https://paypal.me/blazoncek']

.github/ISSUE_TEMPLATE/bug.md

@@ -1,27 +0,0 @@
----
-name: Bug
-about: Noticed an issue with your lights?
-title: ''
-labels: bug
-assignees: ''
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is. Please quickly search existing issues first!
-
-**To Reproduce**
-Steps to reproduce the behavior, if consistently possible
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**WLED version**
- - Board: [e.g. Wemos D1, ESP32 dev]
- - Version [e.g. 0.10.0, dev200603]
- - Format [e.g. Binary, self-compiled]
-
-**Additional context**
-Anything else you'd like to say about the problem?
-
-Thank you for your help!

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,86 @@
+name: Bug Report
+description: File a bug report
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please quickly search existing issues first before submitting a bug.
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: A clear and concise description of what the bug is.
+      placeholder: Tell us what the problem is.
+    validations:
+      required: true
+  - type: textarea
+    id: how-to-reproduce
+    attributes:
+      label: To Reproduce Bug
+      description: Steps to reproduce the behavior, if consistently possible.
+      placeholder: Tell us how to make the bug appear.
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected Behavior
+      description: A clear and concise description of what you expected to happen.
+      placeholder: Tell us what you expected to happen.
+    validations:
+      required: true
+  - type: dropdown
+    id: install_format
+    attributes:
+      label: Install Method
+      description: How did you install WLED?
+      options:
+        - Binary from WLED.me
+        - Self-Compiled
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: What version of WLED?
+      description: You can find this in by going to Config -> Security & Updates -> Scroll to Bottom. Copy and paste the entire line after "Server message"
+      placeholder: "e.g. WLED 0.13.1 (build 2203150)"
+    validations:
+      required: true
+  - type: dropdown
+    id: Board
+    attributes:
+      label: Which microcontroller/board are you seeing the problem on?
+      multiple: true
+      options:
+        - ESP8266
+        - ESP32
+        - ESP32-S3
+        - ESP32-S2
+        - ESP32-C3
+        - Other
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log/trace output
+      description: Please copy and paste any relevant log output if you have it. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+  - type: textarea
+    attributes:
+      label: Anything else?
+      description: |
+        Links? References? Anything that will give us more context about the issue you are encountering!
+        Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
+    validations:
+      required: false
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/Aircoookie/WLED/blob/master/CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+  - name: WLED Discord community
+    url: https://discord.gg/KuqP7NE
+    about: Please ask and answer questions and discuss setup issues here!
+  - name: WLED community forum
+    url: https://wled.discourse.group/
+    about: For issues and ideas that might need longer discussion.
+  - name: kno.wled.ge base
+    url:  https://kno.wled.ge/basics/faq/
+    about: Take a look at the frequently asked questions and documentation, perhaps your question is already answered!

.github/ISSUE_TEMPLATE/question.md

@@ -1,19 +0,0 @@
----
-name: Question
-about: Have a question about using WLED?
-title: ''
-labels: question
-assignees: ''
-
----
-
-**Take a look at the wiki and FAQ, perhaps your question is already answered!**
-[FAQ](https://github.com/Aircoookie/WLED/wiki/FAQ)
-
-**Please consider asking your question on the WLED forum or Discord**
-[Forum](https://wled.discourse.group/)
-[Discord](https://discord.gg/KuqP7NE)
-[What to post where?](https://github.com/Aircoookie/WLED/issues/658)
-
-**If you do not like to use these platforms, delete this template and ask away!**
-Please keep in mind though that the issue section is generally not the preferred place for general questions.

.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 ci
     - 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,17 +1,24 @@
-.pio
 .cache
+.clang-format
+.direnv
+.DS_Store
+.idea
+.pio
 .pioenvs
 .piolibdeps
 .vscode
-!.vscode/extensions.json
-/wled00/Release
+
+esp01-update.sh
+platformio_override.ini
+replace_fs.py
+wled-update.sh
+
+/build_output/
+/node_modules/
+
 /wled00/extLibs
-/platformio_override.ini
+/wled00/LittleFS
 /wled00/my_config.h
-/build_output
-.DS_Store
-.gitignore
-.clang-format
-node_modules
-.idea
-.direnv
+/wled00/Release
+/wled00/wled00.ino.cpp
+/wled00/html_*.h

.gitpod.Dockerfile

@@ -1,5 +1,3 @@
 FROM gitpod/workspace-full
-                    
-USER gitpod
 
-RUN pip3 install -U platformio
+USER gitpod

.gitpod.yml

@@ -1,12 +1,11 @@
 tasks:
-  - command: platformio run
+  - command: pip3 install -U platformio && platformio run
 
 image:
   file: .gitpod.Dockerfile
 
 vscode:
   extensions:
-    - ms-vscode.cpptools@0.26.3:u3GsZ5PK12Ddr79vh4TWgQ==
-    - eamodio.gitlens@10.2.1:e0IYyp0efFqVsrZwsIe8CA==
-    - Atishay-Jain.All-Autocomplete@0.0.23:fbZNfSpnd8XkAHGfAPS2rA==
-    - 2gua.rainbow-brackets@0.0.6:Tbu8dTz0i+/bgcKQTQ5b8g==
+    - Atishay-Jain.All-Autocomplete
+    - esbenp.prettier-vscode
+    - shardulm94.trailing-spaces

.vscode/extensions.json

@@ -1,7 +1,10 @@
-{
-    // See http://go.microsoft.com/fwlink/?LinkId=827846
-    // for the documentation about the extensions.json format
-    "recommendations": [
-        "platformio.platformio-ide"
-    ]
-}
+{
+    // See http://go.microsoft.com/fwlink/?LinkId=827846
+    // for the documentation about the extensions.json format
+    "recommendations": [
+        "platformio.platformio-ide"
+    ],
+    "unwantedRecommendations": [
+        "ms-vscode.cpptools-extension-pack"
+    ]
+}

.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,6 +1,616 @@
 ## WLED changelog
 
-### Builds after release 0.12.0
+#### Build 2404100
+-   Internals: #3859, #3862, #3873, #3875
+-   Prefer I2S1 over RMT on ESP32
+-   usermod for Adafruit MAX17048 (#3667 by @ccruz09)
+-   Runtime detection of ESP32 PICO, general PSRAM support
+-   Extend JSON API "info" object
+    - add "clock" - CPU clock in MHz
+    - add "flash" - flash size in MB
+-   Fix for #3879
+-   Analog PWM fix for ESP8266 (#3887 by @gaaat98)
+-   Fix for #3870 (#3880 by @DedeHai)
+-   ESP32 S3/S2 touch fix (#3798 by @DedeHai)
+-   PIO env. PSRAM fix for S3 & S3 with 4M flash
+    - audioreactive always included for S3 & S2
+-   Fix for #3889
+-   BREAKING: Effect: modified KITT (Scanner) (#3763)
+
+#### Build 2403280
+-   Individual color channel control for JSON API (fixes #3860)
+    - "col":[int|string|object|array, int|string|object|array, int|string|object|array]
+        int = Kelvin temperature or 0 for black
+        string = hex representation of [WW]RRGGBB
+        object = individual channel control {"r":0,"g":127,"b":255,"w":255}, each being optional (valid to send {})
+        array = direct channel values [r,g,b,w] (w element being optional)
+-   runtime selection for CCT IC (Athom 15W bulb)
+-   #3850 (by @w00000dy)
+-   Rotary encoder palette count bugfix
+-   bugfixes and optimisations
+
+#### Build 2403240
+-   v0.15.0-b2
+-   WS2805 support (RGB + WW + CW, 600kbps)
+-   Unified PSRAM use
+-   NeoPixelBus v2.7.9
+-   Ubiquitous PSRAM mode for all variants of ESP32
+-   SSD1309_64 I2C Support for FLD Usermod (#3836 by @THATDONFC)
+-   Palette cycling fix (add support for `{"seg":[{"pal":"X~Y~"}]}` or `{"seg":[{"pal":"X~Yr"}]}`)
+-   FW1906 Support (#3810 by @deece and @Robert-github-com)
+-   ESPAsyncWebServer 2.2.0 (#3828 by @willmmiles)
+-   Bugfixes: #3843, #3844
+
+#### 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 (with help from @JPZV)
+-   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"
+-   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
+
+-   Version bump to v0.13.3 "Toki"
+-   Disable ESP watchdog by default (fixes flickering and boot issues on a fresh install)
+-   Added support for LPD6803
+
+### WLED release 0.13.2
+
+#### Build 2208140
+
+-   Version bump to v0.13.2 "Toki"
+-   Added option to receive live data on the main segment only (PR #2601)
+-   Enable ESP watchdog by default (PR #2657)
+-   Fixed race condition when saving bus config
+-   Better potentiometer filtering (PR #2693)
+-   More suitable DMX libraries (PR #2652)
+-   Fixed outgoing serial TPM2 message length (PR #2628)
+-   Fixed next universe overflow and Art-Net DMX start address (PR #2607)
+-   Fixed relative segment brightness (PR #2665)
+
+### Builds between releases 0.13.1 and 0.13.2
+
+#### Build 2203191
+
+-   Fixed sunrise/set calculation (once again)
+
+#### Build 2203190
+
+-   Fixed `/json/cfg` unable to set busses (#2589)
+-   Fixed Peek with odd LED counts > 255 (#2586)
+
+#### Build 2203160
+
+-   Version bump to v0.13.2-a0 "Toki"
+-   Add ability to skip up to 255 LEDs
+-   Dependency version bumps
+
+### WLED release 0.13.1
+
+#### Build 2203150
+
+-   Version bump to v0.13.1 "Toki"
+-   Fix persistent preset bug, preventing save of new presets
+
+### WLED release 0.13.0
+
+#### Build 2203142
+
+-   Release of WLED v0.13.0 "Toki"
+-   Reduce APA102 hardware SPI frequency to 5Mhz
+-   Remove `persistent` parameter in `savePreset()`
+
+### Builds between releases 0.12.0 and 0.13.0
+
+#### Build 2203140
+
+-   Added factory reset by pressing button 0 for >10 seconds
+-   Added ability to set presets from DMX Effect mode
+-   Simplified label hiding JS in user interface
+-   Fixed JSON `{"live":true}` indefinite realtime mode
+
+#### Build 2203080
+
+-   Disabled auto white mode in segments with no RGB bus
+-   Fixed hostname string not 0-terminated 
+-   Fixed Popcorn mode not lighting first LED on pop
+
+#### Build 2203060
+
+-   Dynamic hiding of unused color controls in UI (PR #2567)
+-   Removed native Cronixie support and added Cronixie usermod
+-   Fixed disabled timed preset expanding calendar
+-   Fixed Color Order setting shown for analog busses
+-   Fixed incorrect operator (#2566)
+
+#### Build 2203011
+
+-   IR rewrite (PR #2561), supports CCT
+-   Added locate button to Time settings
+-   CSS fixes and adjustments
+-   Consistent Tab indentation in index JS and CSS
+-   Added initial contribution style guideline
+
+#### Build 2202222
+
+-   Version bump to 0.13.0-b7 "Toki"
+-   Fixed HTTP API commands not applying to all selected segments in some conditions
+-   Blynk support is not compiled in by default on ESP32 builds
+
+#### Build 2202210
+
+-   Fixed HTTP API commands not applying to all selected segments if called from JSON
+-   Improved Stream effects, no longer rely on LED state and won't fade out at low brightness
+
+#### Build 2202200
+
+-   Added `info.leds.seglc` per-segment light capability info (PR #2552)
+-   Fixed `info.leds.rgbw` behavior
+-   Segment bounds sync (PR #2547)
+-   WebSockets auto reconnection and error handling
+-   Disable relay pin by default (PR #2531)
+-   Various fixes (ESP32 touch pin 33, floats, PR #2530, #2534, #2538)
+-   Deprecated `info.leds.cct`, `info.leds.wv` and `info.leds.rgbw`
+-   Deprecated `/url` endpoint
+
+#### Build 2202030
+
+-   Switched to binary format for WebSockets peek (PR #2516)
+-   Playlist bugfix
+-   Added `extractModeName()` utility function
+-   Added serial out (PR #2517)
+-   Added configurable baud rate
+
+#### Build 2201260
+
+-   Initial ESP32-C3 and ESP32-S2 support (PRs #2452, #2454, #2502)
+-   Full segment sync (PR #2427)
+-   Allow overriding of color order by ranges (PR #2463) 
+-   Added white channel to Peek
+
+#### Build 2112080
+
+-   Version bump to 0.13.0-b6 "Toki"
+-   Added "ESP02" (ESP8266 with 2M of flash) to PIO/release binaries
+
+#### Build 2112070
+
+-   Added new effect "Fairy", replacing "Police All"
+-   Added new effect "Fairytwinkle", replacing "Two Areas"
+-   Static single JSON buffer (performance and stability improvement) (PR #2336)
+
+#### Build 2112030
+
+-   Fixed ESP32 crash on Colortwinkles brightness change
+-   Fixed setting picker to black resetting hue and saturation
+-   Fixed auto white mode not saved to config
+
+#### Build 2111300
+
+-   Added CCT and white balance correction support (PR #2285)
+-   Unified UI slider style
+-   Added LED settings config template upload
+
+#### Build 2111220
+
+-   Fixed preset cycle not working from preset called by UI
+-   Reintroduced permanent min. and max. cycle bounds
+
+#### Build 2111190
+
+-   Changed default ESP32 LED pin from 16 to 2
+-   Renamed "Running 2" to "Chase 2"
+-   Renamed "Tri Chase" to "Chase 3"
+
+#### Build 2111170
+
+-   Version bump to 0.13.0-b5 "Toki"
+-   Improv Serial support (PR #2334)
+-   Button improvements (PR #2284)
+-   Added two time zones (PR #2264, 2311)
+-   JSON in/decrementing support for brightness and presets
+-   Fixed no gamma correction for JSON individual LED control
+-   Preset cycle bugfix
+-   Removed ledCount
+-   LED settings buffer bugfix
+-   Network pin conflict bugfix
+-   Changed default ESP32 partition layout to 4M, 1M FS
+
+#### Build 2110110
+
+-   Version bump to 0.13.0-b4 "Toki"
+-   Added option for bus refresh if off (PR #2259)
+-   New auto segment logic
+-   Fixed current calculations for virtual or non-linear configs (PR #2262)
 
 #### Build 2110060
 
@@ -44,7 +654,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
 
@@ -367,6 +977,7 @@
 -   Added support for WESP32 ethernet board (PR #1764)
 -   Added Caching for main UI (PR #1704)
 -   Added Tetrix mode (PR #1729)
+-   Removed Merry Christmas mode (use "Chase 2" - called Running 2 before 0.13.0)
 -   Added memory check on Bus creation
 
 #### Build 2102050
@@ -572,7 +1183,7 @@
 
 #### Build 2011040
 
--   Inversed Rain direction (fixes #1147)
+-   Inverted Rain direction (fixes #1147)
 
 #### Build 2011010
 
@@ -783,7 +1394,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

@@ -0,0 +1,92 @@
+## Thank you for making WLED better!
+
+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 :)
+Below are the guidelines we use in the WLED repository.
+
+#### Indentation
+
+We use tabs for Indentation in Web files (.html/.css/.js) and spaces (2 per indentation level) for all other files.  
+You are all set if you have enabled `Editor: Detect Indentation` in VS Code.
+
+#### Blocks
+
+Whether the opening bracket of e.g. an `if` block is in the same line as the condition or in a separate line is up to your discretion. If there is only one statement, leaving out block braches is acceptable.
+
+Good:  
+```cpp
+if (a == b) {
+  doStuff(a);
+}
+```
+
+```cpp
+if (a == b)
+{
+  doStuff(a);
+}
+```
+
+```cpp
+if (a == b) doStuff(a);
+```
+
+There should always be a space between a keyword and its condition and between the condition and brace.  
+Within the condition, no space should be between the paranthesis and variables.  
+Spaces between variables and operators are up to the authors discretion.
+There should be no space between function names and their argument parenthesis.
+
+Good:  
+```cpp
+if (a == b) {
+  doStuff(a);
+}
+```
+
+Not good:  
+```cpp
+if( a==b ){
+  doStuff ( a);
+}
+```
+
+#### Comments
+
+Comments should have a space between the delimiting characters (e.g. `//`) and the comment text.
+Note: This is a recent change, the majority of the codebase still has comments without spaces.
+
+Good:  
+```
+// This is a comment.
+
+/* This is a CSS inline comment */
+
+/* 
+ * This is a comment
+ * wrapping over multiple lines,
+ * used in WLED for file headers and function explanations
+ */
+
+<!-- This is an HTML comment -->
+```
+
+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.13.0-b3",
+  "version": "0.15.0-b2",
   "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,9 @@
   },
   "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",
-    "zlib": "^1.0.5"
+    "nodemon": "^3.0.2"
   }
 }

pio-scripts/build_ui.py

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

pio-scripts/output_bins.py

@@ -4,6 +4,7 @@ import shutil
 import gzip
 
 OUTPUT_DIR = "build_output{}".format(os.path.sep)
+#OUTPUT_DIR = os.path.join("build_output")
 
 def _get_cpp_define_value(env, define):
     define_list = [item[-1] for item in env["CPPDEFINES"] if item[0] == define]
@@ -13,14 +14,24 @@ def _get_cpp_define_value(env, define):
 
     return None
 
-def _create_dirs(dirs=["firmware", "map"]):
-    # check if output directories exist and create if necessary
-    if not os.path.isdir(OUTPUT_DIR):
-        os.mkdir(OUTPUT_DIR)
-
+def _create_dirs(dirs=["map", "release", "firmware"]):
     for d in dirs:
-        if not os.path.isdir("{}{}".format(OUTPUT_DIR, d)):
-            os.mkdir("{}{}".format(OUTPUT_DIR, d))
+        os.makedirs(os.path.join(OUTPUT_DIR, d), exist_ok=True)
+
+def create_release(source):
+    release_name = _get_cpp_define_value(env, "WLED_RELEASE_NAME")
+    if release_name:
+        version = _get_cpp_define_value(env, "WLED_VERSION")
+        release_file = os.path.join(OUTPUT_DIR, "release", f"WLED_{version}_{release_name}.bin")
+        release_gz_file = release_file + ".gz"
+        print(f"Copying {source} to {release_file}")
+        shutil.copy(source, release_file)
+        bin_gzip(release_file, release_gz_file)
+    else:
+        variant = env["PIOENV"]
+        bin_file = "{}firmware{}{}.bin".format(OUTPUT_DIR, os.path.sep, variant)
+        print(f"Copying {source} to {bin_file}")
+        shutil.copy(source, bin_file)
 
 def bin_rename_copy(source, target, env):
     _create_dirs()
@@ -28,42 +39,21 @@ def bin_rename_copy(source, target, env):
 
     # create string with location and file names based on variant
     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):
-            os.remove(f)
-
-    # copy firmware.bin to firmware/<variant>.bin
-    shutil.copy(str(target[0]), bin_file)
+    create_release(str(target[0]))
 
     # copy firmware.map to map/<variant>.map
     if os.path.isfile("firmware.map"):
         shutil.move("firmware.map", map_file)
 
-def bin_gzip(source, target, env):
-    _create_dirs()
-    variant = env["PIOENV"]
-
-    # create string with location and file names based on variant
-    bin_file = "{}firmware{}{}.bin".format(OUTPUT_DIR, os.path.sep, variant)
-    gzip_file = "{}firmware{}{}.bin.gz".format(OUTPUT_DIR, os.path.sep, variant)
-
-    # check if new target files exist and remove if necessary
-    if os.path.isfile(gzip_file): os.remove(gzip_file)
-
-    # write gzip firmware file
-    with open(bin_file,"rb") as fp:
-        with gzip.open(gzip_file, "wb", compresslevel = 9) as f:
+def bin_gzip(source, target):
+    # only create gzip for esp8266
+    if not env["PIOPLATFORM"] == "espressif8266":
+        return
+    
+    print(f"Creating gzip file {target} from {source}")
+    with open(source,"rb") as fp:
+        with gzip.open(target, "wb", compresslevel = 9) as f:
             shutil.copyfileobj(fp, f)
 
-env.AddPostAction("$BUILD_DIR/${PROGNAME}.bin", [bin_rename_copy, bin_gzip])
+env.AddPostAction("$BUILD_DIR/${PROGNAME}.bin", bin_rename_copy)

platformio.ini

@@ -6,35 +6,11 @@
 # ENVIRONMENTS
 #
 # Please uncomment one of the lines below to select your board(s)
+# (use `platformio_override.ini` when building for your own board; see `platformio_override.ini.sample` for an example)
 # ------------------------------------------------------------------------------
 
-# Travis CI binaries (use `platformio_override.ini` when building for your own board; see `platformio_override.ini.sample` for an example)
-; default_envs = travis_esp8266, travis_esp32
-
-# Release binaries
-default_envs = nodemcuv2, esp01_1m_full, esp32dev, esp32_eth
-
-# Build everything
-; default_envs = esp32dev, esp8285_4CH_MagicHome, esp8285_4CH_H801, codm-controller-0.6-rev2, codm-controller-0.6, esp32s2_saola, d1_mini_5CH_Shojo_PCB, d1_mini, sp501e, travis_esp8266, travis_esp32, nodemcuv2, esp32_eth, anavi_miracle_controller, esp07, esp01_1m_full, m5atom, h803wf, d1_mini_ota, heltec_wifi_kit_8, esp8285_5CH_H801, d1_mini_debug, wemos_shield_esp32, elekstube_ips
-
-# Single binaries (uncomment your board)
-; default_envs = elekstube_ips
-; default_envs = nodemcuv2
-; 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_4CH_H801
-; default_envs = esp8285_5CH_H801
-; default_envs = d1_mini_5CH_Shojo_PCB
-; default_envs = wemos_shield_esp32
-; default_envs = m5atom
-; default_envs = esp32_eth
+# 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, esp32s3_4M_PSRAM_qspi, esp32_wrover
 
 src_dir  = ./wled00
 data_dir = ./wled00/data
@@ -53,33 +29,44 @@ 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_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_2_7_4}
+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/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_0_2, which does not support Ucs890x
+;; platform_wled_default = ${common.arduino_core_3_0_2}
+;; 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)
-#    ldscript_1m0m (1024 KB) =  999 KB sketch, 4 KB eeprom,      no spiffs, 16 KB reserved
 #    ldscript_2m1m (2048 KB) = 1019 KB sketch, 4 KB eeprom, 1004 KB spiffs, 16 KB reserved
 #    ldscript_4m1m (4096 KB) = 1019 KB sketch, 4 KB eeprom, 1002 KB spiffs, 16 KB reserved, 2048 KB empty/ota?
-#    ldscript_4m3m (4096 KB) = 1019 KB sketch, 4 KB eeprom, 3040 KB spiffs, 16 KB reserved
 #
 # Available lwIP variants (macros):
 #    -DPIO_FRAMEWORK_ARDUINO_LWIP_HIGHER_BANDWIDTH  = v1.4 Higher Bandwidth (default)
@@ -99,11 +86,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
@@ -112,19 +101,12 @@ build_flags =
   -D DECODE_SAMSUNG=true
   -D DECODE_LG=true
   -DWLED_USE_MY_CONFIG
-  ; -D USERMOD_SENSORSTOMQTT
 
 build_unflags =
 
-# enables all features for travis CI
-build_flags_all_features =
-  -D WLED_ENABLE_ADALIGHT
-  -D WLED_ENABLE_DMX
-  -D WLED_ENABLE_MQTT
-  -D WLED_ENABLE_WEBSOCKETS
-
 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
@@ -137,6 +119,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:
@@ -145,86 +128,179 @@ 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.4.0
-    IRremoteESP8266 @ 2.7.18
-    https://github.com/lorol/LITTLEFS.git
-    https://github.com/Aircoookie/ESPAsyncWebServer.git @ ~2.0.2
+    fastled/FastLED @ 3.6.0
+    IRremoteESP8266 @ 2.8.2
+    makuna/NeoPixelBus @ 2.7.9
+    https://github.com/Aircoookie/ESPAsyncWebServer.git @ 2.2.1
+  # 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.27.2
-  #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
+  #For MAX1704x Lipo Monitor / Fuel Gauge uncomment following
+    ; https://github.com/adafruit/Adafruit_BusIO @ 1.14.5
+    ; https://github.com/adafruit/Adafruit_MAX1704X @ 1.0.2
+  #For MPU6050 IMU uncomment follwoing
+    ;electroniccats/MPU6050 @1.0.1
+  # For -D USERMOD_ANIMARTRIX
+  # CC BY-NC 3.0 licensed effects by Stefan Petrick, include this usermod only if you accept the terms!
+    ;https://github.com/netmindz/animartrix.git#18bf17389e57c69f11bc8d04ebe1d215422c7fb7
+  # SHT85
+    ;robtillaart/SHT85@~0.3.3
+  # Audioreactive usermod
+    ;kosme/arduinoFFT @ 2.0.0
 
-extra_scripts             = ${scripts_defaults.extra_scripts}
+extra_scripts = ${scripts_defaults.extra_scripts}
 
 [esp8266]
 build_flags =
   -DESP8266
   -DFP_IN_IROM
   ;-Wno-deprecated-declarations
-  ;-Wno-register
-; 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}
-  # ESPAsyncTCP @ 1.2.0
+lib_deps =
+  #https://github.com/lorol/LITTLEFS.git
+  ESPAsyncTCP @ 1.2.2
   ESPAsyncUDP
-  makuna/NeoPixelBus @ 2.6.7 # 2.6.5/2.6.6 and newer do not compile on ESP core < 3.0.0
+  ${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
+  #-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
+  -D LOROL_LITTLEFS
+  ; -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}
-  makuna/NeoPixelBus @ 2.6.7
+  https://github.com/lorol/LITTLEFS.git
   https://github.com/pbolduc/AsyncTCP.git @ 1.2.0
+  ${env.lib_deps}
+# additional build flags for audioreactive
+AR_build_flags = -D USERMOD_AUDIOREACTIVE
+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
-  -DCONFIG_LITTLEFS_FOR_IDF_3_2
   -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
+lib_deps =
+  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=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 =
+  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=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
 
 lib_deps =
-  ${env.lib_deps}
-  makuna/NeoPixelBus @ 2.6.7
   https://github.com/pbolduc/AsyncTCP.git @ 1.2.0
+  ${env.lib_deps}
+
 
 # ------------------------------------------------------------------------------
 # WLED BUILDS
@@ -236,8 +312,28 @@ 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
+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
+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
@@ -246,255 +342,162 @@ 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_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 = espressif32@2.0
+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_BROWNOUT_DET
 lib_deps = ${esp32.lib_deps}
+monitor_filters = esp32_exception_decoder
+board_build.partitions = ${esp32.default_partitions}
+
+[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_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 = dio
 
 [env:esp32_eth]
 board = esp32-poe
-platform = espressif32@2.0
+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_ESPNOW ;; ESP-NOW requires wifi, may crash with ethernet only
+lib_deps = ${esp32.lib_deps}
+board_build.partitions = ${esp32.default_partitions}
+
+[env:esp32_wrover]
+platform = ${esp32.platform}
+board = ttgo-t7-v14-mini32
+board_build.f_flash = 80000000L
+board_build.flash_mode = qio
+board_build.partitions = tools/WLED_ESP32-wrover_4MB.csv
+build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags_esp32} -D WLED_RELEASE_NAME=ESP32_WROVER
+  -DBOARD_HAS_PSRAM -mfix-esp32-psram-cache-issue ;; Older ESP32 (rev.<3) need a PSRAM fix (increases static RAM used) https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-guides/external-ram.html
+  -D LEDPIN=25
 lib_deps = ${esp32.lib_deps}
 
-[env:esp32s2_saola]
-board = esp32dev
-board_build.mcu = esp32s2
-platform = espressif32
-platform_packages =
-    toolchain-xtensa32s2
-    framework-arduinoespressif32 @ https://github.com/espressif/arduino-esp32.git#2.0.0-alpha1
+[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
+  -D WLED_WATCHDOG_TIMEOUT=0
+  -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 = ${esp32s2.lib_deps}
+lib_deps = ${esp32c3.lib_deps}
 
-[env:esp8285_4CH_MagicHome]
-board = esp8285
-platform = ${common.platform_wled_default}
-platform_packages = ${common.platform_packages}
-board_build.ldscript = ${common.ldscript_1m128k}
+[env:esp32s3dev_8MB]
+;; ESP32-S3-DevKitC-1 development board, with 8MB FLASH, no PSRAM (flash_mode: qio)
+board = esp32-s3-devkitc-1
+platform = ${esp32s3.platform}
+platform_packages = ${esp32s3.platform_packages}
+upload_speed = 921600 ; or  460800
 build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp8266} -D WLED_DISABLE_OTA
-lib_deps = ${esp8266.lib_deps}
-
-[env:esp8285_4CH_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:esp8285_5CH_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}
-
-# ------------------------------------------------------------------------------
-# 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
-lib_deps = ${esp32.lib_deps}
-  OneWire@~2.3.5
-  olikraus/U8g2 @ ^2.28.8
-
-[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
-
-[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}
-
-# ------------------------------------------------------------------------------
-# travis test board configurations
-# ------------------------------------------------------------------------------
-
-[env:travis_esp8266]
-extends = env:d1_mini
-build_type = debug
-build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp8266} ${common.debug_flags} ${common.build_flags_all_features}
-
-[env:travis_esp32]
-extends = env:esp32dev
-; build_type = debug
-build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp32} ${common.debug_flags} ${common.build_flags_all_features}
-
-# ------------------------------------------------------------------------------
-# 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_INFRARED
-  -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
+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_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")
+  ${esp32.AR_build_flags}
+lib_deps = ${esp32s3.lib_deps}
+  ${esp32.AR_lib_deps}
+board_build.partitions = tools/WLED_ESP32_8MB.csv
+board_build.f_flash = 80000000L
+board_build.flash_mode = qio
+; board_build.flash_mode = dio   ;; try this if you have problems at startup
 monitor_filters = esp32_exception_decoder
-lib_deps =
-  ${esp32.lib_deps}
-  TFT_eSPI @ ^2.3.70
+
+[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} -D WLED_RELEASE_NAME=ESP32-S3_8MB_PSRAM_opi
+  -D CONFIG_LITTLEFS_FOR_IDF_3_2 -D WLED_WATCHDOG_TIMEOUT=0
+  ;-D ARDUINO_USB_CDC_ON_BOOT=0  ;; -D ARDUINO_USB_MODE=1 ;; for boards with serial-to-USB chip
+  -D ARDUINO_USB_CDC_ON_BOOT=1 -D ARDUINO_USB_MODE=1      ;; for boards with USB-OTG connector only (USBCDC or "TinyUSB")
+  -DBOARD_HAS_PSRAM
+  ${esp32.AR_build_flags}
+lib_deps = ${esp32s3.lib_deps}
+  ${esp32.AR_lib_deps}
+board_build.partitions = tools/WLED_ESP32_8MB.csv
+board_build.f_flash = 80000000L
+board_build.flash_mode = qio
+monitor_filters = esp32_exception_decoder
+
+[env:esp32s3_4M_PSRAM_qspi]
+;; ESP32-S3, with 4MB FLASH and <= 4MB PSRAM (memory_type: qio_qspi)
+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
+platform = ${esp32s3.platform}
+platform_packages = ${esp32s3.platform_packages}
+upload_speed = 921600
+build_unflags = ${common.build_unflags}
+build_flags = ${common.build_flags} ${esp32s3.build_flags} -D WLED_RELEASE_NAME=ESP32-S3_4M_PSRAM_qspi
+  -DARDUINO_USB_CDC_ON_BOOT=1 -DARDUINO_USB_MODE=1      ;; for boards with USB-OTG connector only (USBCDC or "TinyUSB")
+  -DBOARD_HAS_PSRAM
+  -D WLED_WATCHDOG_TIMEOUT=0
+  ${esp32.AR_build_flags}
+lib_deps = ${esp32s3.lib_deps}
+  ${esp32.AR_lib_deps}
+board_build.partitions = tools/WLED_ESP32_4MB_1MB_FS.csv
+board_build.f_flash = 80000000L
+board_build.flash_mode = qio
+monitor_filters = esp32_exception_decoder
+
+[env:lolin_s2_mini]
+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=ESP32-S2
+  -DARDUINO_USB_CDC_ON_BOOT=1
+  -DARDUINO_USB_MSC_ON_BOOT=0
+  -DARDUINO_USB_DFU_ON_BOOT=0
+  -DBOARD_HAS_PSRAM
+  -DLOLIN_WIFI_FIX ; seems to work much better with this
+  -D WLED_WATCHDOG_TIMEOUT=0
+  -D CONFIG_ASYNC_TCP_USE_WDT=0
+  -D LEDPIN=16
+  -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
+;  -D STATUSLED=15
+  ${esp32.AR_build_flags}
+lib_deps = ${esp32s2.lib_deps}
+  ${esp32.AR_lib_deps}

platformio_override.ini.sample

@@ -1,47 +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
-; *********************************************************************
-;  -D WLED_DISABLE_OTA
-;  -D WLED_DISABLE_ALEXA
-;  -D WLED_DISABLE_BLYNK
-;  -D WLED_DISABLE_CRONIXIE
-;  -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

platformio_override.sample.ini

@@ -0,0 +1,494 @@
+# 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 on classic ESP32 rev.1 (rev.3 or above has no issues)
+;   -DBOARD_HAS_PSRAM -mfix-esp32-psram-cache-issue
+;
+; 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>
@@ -15,27 +15,26 @@
 A fast and feature-rich implementation of an ESP8266/ESP32 webserver to control NeoPixel (WS2812B, WS2811, SK6812) LEDs or also SPI based chipsets like the WS2801 and APA102!
 
 ## ⚙️ Features
-- WS2812FX library integrated for over 100 special effects  
+- WS2812FX library with more than 100 special effects  
 - FastLED noise effects and 50 palettes  
 - Modern UI with color, effect and segment controls  
-- Segments to set different effects and colors to parts of the LEDs  
-- Settings page - configuration over network  
+- Segments to set different effects and colors to user defined parts of the LED string  
+- Settings page - configuration via the network  
 - Access Point and station mode - automatic failsafe AP  
 - Up to 10 LED outputs per instance
 - Support for RGBW strips  
 - 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  
-- Configurable analog clock + support for the Cronixie kit by Diamex  
-- Configurable Auto Brightness limit for safer operation  
+- 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  
 
 ## 💡 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)
@@ -51,52 +50,35 @@ A fast and feature-rich implementation of an ESP8266/ESP32 webserver to control
 
 See the [documentation on our official site](https://kno.wled.ge)!
 
-[On this page](https://github.com/Aircoookie/WLED/wiki/Learning-the-ropes) you can find excellent tutorials made by the community and helpful tools to help you get your new lamp up and running!
+[On this page](https://kno.wled.ge/basics/tutorials/) you can find excellent tutorials and tools to help you get your new project up and running!
 
-## 🖼️ Images
+## 🖼️ User interface
 <img src="/images/macbook-pro-space-gray-on-the-wooden-table.jpg" width="50%"><img src="/images/walking-with-iphone-x.jpg" width="50%">
 
-## 💾 Compatible LED Strips
-Type | Voltage | Comments
-|---|---|---|
-WS2812B | 5v |
-WS2813 | 5v | 
-SK6812 | 5v | RGBW
-APA102 | 5v | C/D
-WS2801 | 5v | C/D
-LPD8806 | 5v | C/D
-TM1814 | 12v | RGBW
-WS2811 | 12v | 3-LED segments
-WS2815 | 12v | 
-GS8208 | 12v |
-Analog/non-addressable | any | Requires additional circuitry
-
-## 🧊 Compatible PC RGB Fans and ARGB accessories
-Brand | Model | Comments
-|---|---|---|
-Corsair | HD120 Fan | Uses WS2812B, data-in only
-PCCOOLER | Moonlight 5-pack Fans | Uses WS2812B, includes Data-out connector to keep each fan uniquely addressable if wired in series like traditional LED strips
-Any | 5v 3-pin ARGB for PC | Any PC RGB device that supports the 5v 3-pin ARGB motherboard header should work fine with WLED. All the major motherboard vendors support the Corsair HD120 and PCCOOLER fans listed, so we can safely assume any device that supports motherboard ARGB 5V 3-Pin standard will work with WLED.
+## 💾 Compatible hardware
 
+See [here](https://kno.wled.ge/basics/compatible-hardware)!
 
 ## ✌️ Other
 
 Licensed under the MIT license  
-Credits [here](https://github.com/Aircoookie/WLED/wiki/Contributors-&-About)!
-
-Uses Linearicons by Perxis!
+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)!  
-You can also send me mails to [dev.aircoookie@gmail.com](mailto:dev.aircoookie@gmail.com), but please only do so if you want to talk to me privately.  
-If WLED really brightens up your every day, you can [![](https://img.shields.io/badge/send%20me%20a%20small%20gift-paypal-blue.svg?style=flat-square)](https://paypal.me/aircoookie)
+
+You can also send me mails to [dev.aircoookie@gmail.com](mailto:dev.aircoookie@gmail.com), but please, only do so if you want to talk to me privately.  
+
+If WLED really brightens up your day, you can [![](https://img.shields.io/badge/send%20me%20a%20small%20gift-paypal-blue.svg?style=flat-square)](https://paypal.me/aircoookie)
 
 
 *Disclaimer:*   
-If you are sensitive to photosensitive epilepsy it is not recommended that you use this software.  
-In case you still want to try, don't use strobe, lighting or noise modes or high effect speed settings.
+
+If you are prone to photosensitive epilepsy, we recommended you do **not** use this software.  
+If you still want to try, don't use strobe, lighting or noise modes or high effect speed settings.
+
 As per the MIT license, I assume no liability for any damage to you or any other person or equipment.  
 

requirements.txt

@@ -1,54 +1,60 @@
 #
-# This file is autogenerated by pip-compile
-# To update, run:
+# This file is autogenerated by pip-compile with Python 3.12
+# by the following command:
 #
 #    pip-compile
 #
-aiofiles==0.6.0
+aiofiles==22.1.0
     # via platformio
-ajsonrpc==1.1.0
+ajsonrpc==1.2.0
     # via platformio
-bottle==0.12.19
+anyio==3.6.2
+    # via starlette
+bottle==0.12.25
     # via platformio
-certifi==2020.12.5
+certifi==2023.7.22
     # via requests
-chardet==4.0.0
+charset-normalizer==3.1.0
     # via requests
-click==7.1.2
+click==8.1.3
     # via
     #   platformio
     #   uvicorn
-colorama==0.4.4
-    # via platformio
-h11==0.12.0
+colorama==0.4.6
+    # via
+    #   click
+    #   platformio
+h11==0.14.0
     # via
     #   uvicorn
     #   wsproto
-idna==2.10
-    # via requests
-ifaddr==0.1.7
-    # via zeroconf
-marshmallow==3.11.1
+idna==3.4
+    # via
+    #   anyio
+    #   requests
+marshmallow==3.19.0
     # via platformio
-platformio==5.1.1
+packaging==23.1
+    # via marshmallow
+platformio==6.1.14
     # via -r requirements.in
-pyelftools==0.27
+pyelftools==0.29
     # via platformio
 pyserial==3.5
     # via platformio
-requests==2.25.1
+requests==2.31.0
     # via platformio
-semantic-version==2.8.5
+semantic-version==2.10.0
     # via platformio
-starlette==0.14.2
+sniffio==1.3.0
+    # via anyio
+starlette==0.23.1
     # via platformio
-tabulate==0.8.9
+tabulate==0.9.0
     # via platformio
-urllib3==1.26.5
+urllib3==1.26.18
     # via requests
-uvicorn==0.13.4
+uvicorn==0.20.0
     # via platformio
-wsproto==1.0.0
-    # via platformio
-zeroconf==0.28.8
+wsproto==1.2.0
     # via platformio

tools/WLED_ESP32-wrover_4MB.csv

@@ -0,0 +1,6 @@
+# Name,   Type, SubType, Offset,  Size, Flags
+nvs,      data, nvs,     0x9000,  0x5000,
+otadata,  data, ota,     0xe000,  0x2000,
+app0,     app,  ota_0,   0x10000, 0x1A0000,
+app1,     app,  ota_1,   0x1B0000,0x1A0000,
+spiffs,   data, spiffs,  0x350000,0xB0000,

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,212 @@
+'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");
+    fs.cpSync("package.json", "package.bak.json");
+  });
+  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");
+    fs.rmSync("package.json");
+    fs.renameSync("package.bak.json", "package.json");
+  });
+
+  // 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');
+
+    await 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');
+    });
+
+    it('package.json changes', async () => {
+      await testFileModification('package.json', '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

@@ -2,7 +2,7 @@
  * Writes compressed C arrays of data files (web interface)
  * How to use it?
  *
- * 1) Install Node 11+ and npm
+ * 1) Install Node 20+ and npm
  * 2) npm install
  * 3) npm run build
  *
@@ -15,21 +15,64 @@
  * It uses NodeJS packages to inline, minify and GZIP files. See writeHtmlGzipped and writeChunks invocations at the bottom of the page.
  */
 
-const fs = require("fs");
+const fs = require("node:fs");
+const path = require("path");
+const inliner = require("inliner");
+const zlib = require("node:zlib");
+const CleanCSS = require("clean-css");
+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) {
+ 
+`;
+
+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 += 16) {
-    let block = buffer.slice(i, i + 16); // cut buffer into blocks of 16
+  for (let i = 0; i < buffer.length; i += (isHex ? 32 : 16)) {
+    var block;
     let hexArray = [];
-
-    for (let value of block) {
-      hexArray.push("0x" + value.toString(16).padStart(2, "0"));
+    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))
+      }
+    } else {
+      block = buffer.slice(i, i + 16); // cut buffer into blocks of 16
+      for (let value of block) {
+        hexArray.push("0x" + value.toString(16).padStart(2, "0"));
+      }
     }
 
     let hexString = hexArray.join(", ");
@@ -40,161 +83,162 @@ function hexdump(buffer) {
   return lines.join(",\n");
 }
 
-const inliner = require("inliner");
-const zlib = require("zlib");
-
-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 writeHtmlGzipped(sourceFile, resultFile) {
-  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");
+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 (error) {
-      console.warn(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_index_L = ${result.length};
-const uint8_t PAGE_index[] PROGMEM = {
-${array}
-};
-`;
-      console.info("Writing " + resultFile);
-      fs.writeFileSync(resultFile, src);
-    });
-  });
-}
-
-const CleanCSS = require("clean-css");
-const MinifyHTML = require("html-minifier-terser").minify;
-
-function filter(str, type) {
-  str = adoptVersionAndRepo(str);
-
-  if (type === undefined) {
+  if (type == "plain") {
     return str;
   } else if (type == "css-minify") {
     return new CleanCSS({}).minify(str).styles;
+  } else if (type == "js-minify") {
+    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 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 writeHtmlGzipped(sourceFile, resultFile, page) {
+  console.info("Reading " + sourceFile);
+  new inliner(sourceFile, async function (error, html) {
+    if (error) throw error;
 
-`;
-    return s.mangle ? s.mangle(chunk) : 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 s.mangle ? s.mangle(chunk) : 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
-      );
-    }
+    html = adoptVersionAndRepo(html);
+    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);
   });
+}
+
+async function specToChunk(srcDir, s) {
+  const buf = fs.readFileSync(srcDir + "/" + s.file);
+  let chunk = `\n// Autogenerated from ${srcDir}/${s.file}, do not edit!!\n`
+
+  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");
+// 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;
+    }
+    if (file.isDirectory() && isAnyFileInFolderNewerThan(filePath, time)) {
+      return true;
+    }
+  }
+  return false;
+}
+
+// Check if the web UI is already built
+function isAlreadyBuilt(webUIPath, packageJsonPath = "package.json") {
+  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(webUIPath, lastBuildTime) && !isFileNewerThan(packageJsonPath, lastBuildTime) && !isFileNewerThan(__filename, 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",
@@ -202,152 +246,77 @@ writeChunks(
     {
       file: "style.css",
       name: "PAGE_settingsCss",
-      prepend: "=====(<style>",
-      append: "</style>)=====",
-      method: "plaintext",
+      method: "gzip",
       filter: "css-minify",
+      mangle: (str) =>
+        str
+          .replace("%%", "%")
     },
     {
       file: "settings.htm",
       name: "PAGE_settings",
-      prepend: "=====(",
-      append: ")=====",
-      method: "plaintext",
+      method: "gzip",
       filter: "html-minify",
-      mangle: (str) =>
-        str
-          .replace("%", "%%")
-          .replace(/User Interface\<\/button\>\<\/form\>/gms, "User Interface\<\/button\>\<\/form\>%DMXMENU%"),
     },
     {
       file: "settings_wifi.htm",
       name: "PAGE_settings_wifi",
-      prepend: "=====(",
-      append: ")=====",
-      method: "plaintext",
+      method: "gzip",
       filter: "html-minify",
-      mangle: (str) =>
-        str
-          .replace(/\<link rel="stylesheet".*\>/gms, "")
-          .replace(/\<style\>.*\<\/style\>/gms, "%CSS%%SCSS%")
-          .replace(
-            /function GetV().*\<\/script\>/gms,
-            "function GetV() {var d=document;\n"
-          ),
     },
     {
       file: "settings_leds.htm",
       name: "PAGE_settings_leds",
-      prepend: "=====(",
-      append: ")=====",
-      method: "plaintext",
+      method: "gzip",
       filter: "html-minify",
-      mangle: (str) =>
-        str
-          .replace(/\<link rel="stylesheet".*\>/gms, "")
-          .replace(/\<style\>.*\<\/style\>/gms, "%CSS%%SCSS%")
-          .replace(
-            /function GetV().*\<\/script\>/gms,
-            "function GetV() {var d=document;\n"
-          ),
     },
     {
       file: "settings_dmx.htm",
       name: "PAGE_settings_dmx",
-      prepend: "=====(",
-      append: ")=====",
-      method: "plaintext",
+      method: "gzip",
       filter: "html-minify",
-      mangle: (str) => {
-        const nocss = str
-          .replace(/\<link rel="stylesheet".*\>/gms, "")
-          .replace(/\<style\>.*\<\/style\>/gms, "%CSS%%SCSS%")
-          .replace(
-            /function GetV().*\<\/script\>/gms,
-            "function GetV() {var d=document;\n"
-          );
-        return `
-#ifdef WLED_ENABLE_DMX
-${nocss}
-#else
-const char PAGE_settings_dmx[] PROGMEM = R"=====()=====";
-#endif
-`;
-      },
     },
     {
       file: "settings_ui.htm",
       name: "PAGE_settings_ui",
-      prepend: "=====(",
-      append: ")=====",
-      method: "plaintext",
+      method: "gzip",
       filter: "html-minify",
-      mangle: (str) =>
-        str
-          .replace(/\<link rel="stylesheet".*\>/gms, "")
-          .replace(/\<style\>.*\<\/style\>/gms, "%CSS%%SCSS%")
-          .replace(
-            /function GetV().*\<\/script\>/gms,
-            "function GetV() {var d=document;\n"
-          ),
     },
     {
       file: "settings_sync.htm",
       name: "PAGE_settings_sync",
-      prepend: "=====(",
-      append: ")=====",
-      method: "plaintext",
+      method: "gzip",
       filter: "html-minify",
-      mangle: (str) =>
-        str
-          .replace(/\<link rel="stylesheet".*\>/gms, "")
-          .replace(/\<style\>.*\<\/style\>/gms, "%CSS%%SCSS%")
-          .replace(/function GetV().*\<\/script\>/gms, "function GetV() {\n"),
     },
     {
       file: "settings_time.htm",
       name: "PAGE_settings_time",
-      prepend: "=====(",
-      append: ")=====",
-      method: "plaintext",
+      method: "gzip",
       filter: "html-minify",
-      mangle: (str) =>
-        str
-          .replace(/\<link rel="stylesheet".*\>/gms, "")
-          .replace(/\<style\>.*\<\/style\>/gms, "%CSS%%SCSS%")
-          .replace(/function GetV().*\<\/script\>/gms, "function GetV() {\n"),
     },
     {
       file: "settings_sec.htm",
       name: "PAGE_settings_sec",
-      prepend: "=====(",
-      append: ")=====",
-      method: "plaintext",
+      method: "gzip",
       filter: "html-minify",
-      mangle: (str) =>
-        str
-          .replace(/\<link rel="stylesheet".*\>/gms, "")
-          .replace(/\<style\>.*\<\/style\>/gms, "%CSS%%SCSS%")
-          .replace(
-            /function GetV().*\<\/script\>/gms,
-            "function GetV() {var d=document;\n"
-          ),
     },
     {
       file: "settings_um.htm",
       name: "PAGE_settings_um",
-      prepend: "=====(",
-      append: ")=====",
-      method: "plaintext",
+      method: "gzip",
       filter: "html-minify",
-      mangle: (str) =>
-        str
-          .replace(/\<link rel="stylesheet".*\>/gms, "")
-          .replace(/\<style\>.*\<\/style\>/gms, "%CSS%%SCSS%")
-          .replace(
-            /function GetV().*\<\/script\>/gms,
-            "function GetV() {var d=document;\n"
-          ),
+    },
+    {
+      file: "settings_2D.htm",
+      name: "PAGE_settings_2D",
+      method: "gzip",
+      filter: "html-minify",
+    },
+    {
+      file: "settings_pin.htm",
+      name: "PAGE_settings_pin",
+      method: "gzip",
+      filter: "html-minify"
     }
   ],
   "wled00/html_settings.h"
@@ -359,9 +328,7 @@ writeChunks(
     {
       file: "usermod.htm",
       name: "PAGE_usermod",
-      prepend: "=====(",
-      append: ")=====",
-      method: "plaintext",
+      method: "gzip",
       filter: "html-minify",
       mangle: (str) =>
         str.replace(/fetch\("http\:\/\/.*\/win/gms, 'fetch("/win'),
@@ -393,48 +360,44 @@ const char PAGE_dmxmap[] PROGMEM = R"=====()=====";
     {
       file: "update.htm",
       name: "PAGE_update",
-      prepend: "=====(",
-      append: ")=====",
-      method: "plaintext",
+      method: "gzip",
       filter: "html-minify",
+      mangle: (str) =>
+        str
+          .replace(
+            /function GetV().*\<\/script\>/gms,
+            "</script><script src=\"/settings/s.js?p=9\"></script>"
+          )
     },
     {
       file: "welcome.htm",
       name: "PAGE_welcome",
-      prepend: "=====(",
-      append: ")=====",
-      method: "plaintext",
+      method: "gzip",
       filter: "html-minify",
     },
     {
       file: "liveview.htm",
       name: "PAGE_liveview",
-      prepend: "=====(",
-      append: ")=====",
-      method: "plaintext",
+      method: "gzip",
       filter: "html-minify",
     },
     {
-      file: "liveviewws.htm",
-      name: "PAGE_liveviewws",
-      prepend: "=====(",
-      append: ")=====",
-      method: "plaintext",
+      file: "liveviewws2D.htm",
+      name: "PAGE_liveviewws2D",
+      method: "gzip",
       filter: "html-minify",
     },
     {
       file: "404.htm",
       name: "PAGE_404",
-      prepend: "=====(",
-      append: ")=====",
-      method: "plaintext",
+      method: "gzip",
       filter: "html-minify",
     },
     {
       file: "favicon.ico",
       name: "favicon",
       method: "binary",
-    },
+    }
   ],
   "wled00/html_other.h"
 );

usermods/ADS1115_v2/ChannelSettings.h

@@ -0,0 +1,15 @@
+#include "wled.h"
+
+namespace ADS1115
+{
+  struct ChannelSettings {
+    const String settingName;
+    bool isEnabled;
+    String name;
+    String units;
+    const uint16_t mux;
+    float multiplier;
+    float offset;
+    uint8_t decimals;
+  };
+}

usermods/ADS1115_v2/readme.md

@@ -0,0 +1,10 @@
+# ADS1115 16-Bit ADC with four inputs
+
+This usermod will read from an ADS1115 ADC. The voltages are displayed in the Info section of the web UI.
+
+Configuration is performed via the Usermod menu. There are no parameters to set in code!
+
+## Installation 
+
+Add the build flag `-D USERMOD_ADS1115` to your platformio environment.
+Uncomment libraries with comment `#For ADS1115 sensor uncomment following`

usermods/ADS1115_v2/usermod_ads1115.h

@@ -0,0 +1,255 @@
+#pragma once
+
+#include "wled.h"
+#include <Adafruit_ADS1X15.h>
+#include <math.h>
+
+#include "ChannelSettings.h"
+
+using namespace ADS1115;
+
+class ADS1115Usermod : public Usermod {
+  public:
+    void setup() {
+      ads.setGain(GAIN_ONE);        // 1x gain   +/- 4.096V
+
+      if (!ads.begin()) {
+        Serial.println("Failed to initialize ADS");
+        return;
+      }
+
+      if (!initChannel()) {
+        isInitialized = true;
+        return;
+      }
+
+      startReading();
+
+      isEnabled = true;
+      isInitialized = true;
+    }
+
+    void loop() {
+      if (isEnabled && millis() - lastTime > loopInterval) {
+        lastTime = millis();
+
+        // If we don't have new data, skip this iteration.
+        if (!ads.conversionComplete()) {
+          return;
+        }
+
+        updateResult();
+        moveToNextChannel();
+        startReading();
+      }
+    }
+
+    void addToJsonInfo(JsonObject& root)
+    {
+      if (!isEnabled) {
+        return;
+      }
+
+      JsonObject user = root[F("u")];
+      if (user.isNull()) user = root.createNestedObject(F("u"));
+
+      for (uint8_t i = 0; i < channelsCount; i++) {
+        ChannelSettings* settingsPtr = &(channelSettings[i]);
+
+        if (!settingsPtr->isEnabled) {
+          continue;
+        }
+
+        JsonArray lightArr = user.createNestedArray(settingsPtr->name); //name
+        float value = round((readings[i] + settingsPtr->offset) * settingsPtr->multiplier, settingsPtr->decimals);
+        lightArr.add(value); //value
+        lightArr.add(" " + settingsPtr->units); //unit
+      }
+    }
+
+    void addToConfig(JsonObject& root)
+    {
+      JsonObject top = root.createNestedObject(F("ADC ADS1115"));
+      
+      for (uint8_t i = 0; i < channelsCount; i++) {
+        ChannelSettings* settingsPtr = &(channelSettings[i]);
+        JsonObject channel = top.createNestedObject(settingsPtr->settingName);
+        channel[F("Enabled")] = settingsPtr->isEnabled;
+        channel[F("Name")] = settingsPtr->name;
+        channel[F("Units")] = settingsPtr->units;
+        channel[F("Multiplier")] = settingsPtr->multiplier;
+        channel[F("Offset")] = settingsPtr->offset;
+        channel[F("Decimals")] = settingsPtr->decimals;
+      }
+
+      top[F("Loop Interval")] = loopInterval;
+    }
+
+    bool readFromConfig(JsonObject& root)
+    {
+      JsonObject top = root[F("ADC ADS1115")];
+
+      bool configComplete = !top.isNull();
+      bool hasEnabledChannels = false;
+
+      for (uint8_t i = 0; i < channelsCount && configComplete; i++) {
+        ChannelSettings* settingsPtr = &(channelSettings[i]);
+        JsonObject channel = top[settingsPtr->settingName];
+
+        configComplete &= !channel.isNull();
+
+        configComplete &= getJsonValue(channel[F("Enabled")], settingsPtr->isEnabled);
+        configComplete &= getJsonValue(channel[F("Name")], settingsPtr->name);
+        configComplete &= getJsonValue(channel[F("Units")], settingsPtr->units);
+        configComplete &= getJsonValue(channel[F("Multiplier")], settingsPtr->multiplier);
+        configComplete &= getJsonValue(channel[F("Offset")], settingsPtr->offset);
+        configComplete &= getJsonValue(channel[F("Decimals")], settingsPtr->decimals);
+
+        hasEnabledChannels |= settingsPtr->isEnabled;
+      }
+
+      configComplete &= getJsonValue(top[F("Loop Interval")], loopInterval);
+
+      isEnabled = isInitialized && configComplete && hasEnabledChannels;
+
+      return configComplete;
+    }
+
+    uint16_t getId()
+    {
+      return USERMOD_ID_ADS1115;
+    }
+
+  private:
+    static const uint8_t channelsCount = 8;
+
+    ChannelSettings channelSettings[channelsCount] = {
+      {
+        "Differential reading from AIN0 (P) and AIN1 (N)",
+        false,
+        "Differential AIN0 AIN1",
+        "V",
+        ADS1X15_REG_CONFIG_MUX_DIFF_0_1,
+        1,
+        0,
+        3
+      },
+      {
+        "Differential reading from AIN0 (P) and AIN3 (N)",
+        false,
+        "Differential AIN0 AIN3",
+        "V",
+        ADS1X15_REG_CONFIG_MUX_DIFF_0_3,
+        1,
+        0,
+        3
+      },
+      {
+        "Differential reading from AIN1 (P) and AIN3 (N)",
+        false,
+        "Differential AIN1 AIN3",
+        "V",
+        ADS1X15_REG_CONFIG_MUX_DIFF_1_3,
+        1,
+        0,
+        3
+      },
+      {
+        "Differential reading from AIN2 (P) and AIN3 (N)",
+        false,
+        "Differential AIN2 AIN3",
+        "V",
+        ADS1X15_REG_CONFIG_MUX_DIFF_2_3,
+        1,
+        0,
+        3
+      },
+      {
+        "Single-ended reading from AIN0",
+        false,
+        "Single-ended AIN0",
+        "V",
+        ADS1X15_REG_CONFIG_MUX_SINGLE_0,
+        1,
+        0,
+        3
+      },
+      {
+        "Single-ended reading from AIN1",
+        false,
+        "Single-ended AIN1",
+        "V",
+        ADS1X15_REG_CONFIG_MUX_SINGLE_1,
+        1,
+        0,
+        3
+      },
+      {
+        "Single-ended reading from AIN2",
+        false,
+        "Single-ended AIN2",
+        "V",
+        ADS1X15_REG_CONFIG_MUX_SINGLE_2,
+        1,
+        0,
+        3
+      },
+      {
+        "Single-ended reading from AIN3",
+        false,
+        "Single-ended AIN3",
+        "V",
+        ADS1X15_REG_CONFIG_MUX_SINGLE_3,
+        1,
+        0,
+        3
+      },
+    };
+    float readings[channelsCount] = {0, 0, 0, 0, 0, 0, 0, 0};
+
+    unsigned long loopInterval = 1000;
+    unsigned long lastTime = 0;
+
+    Adafruit_ADS1115 ads;
+    uint8_t activeChannel;
+
+    bool isEnabled = false;
+    bool isInitialized = false;
+
+    static float round(float value, uint8_t decimals) {
+      return roundf(value * powf(10, decimals)) / powf(10, decimals);
+    }
+
+    bool initChannel() {
+      for (uint8_t i = 0; i < channelsCount; i++) {
+        if (channelSettings[i].isEnabled) {
+          activeChannel = i;
+          return true;
+        }
+      }
+
+      activeChannel = 0;
+      return false;
+    }
+
+    void moveToNextChannel() {
+      uint8_t oldActiveChannel = activeChannel;
+
+      do
+      {
+        if (++activeChannel >= channelsCount){
+          activeChannel = 0;
+        }
+      }
+      while (!channelSettings[activeChannel].isEnabled && oldActiveChannel != activeChannel);
+    }
+
+    void startReading() {
+      ads.startADCReading(channelSettings[activeChannel].mux, /*continuous=*/false);
+    }
+
+    void updateResult() {
+        int16_t results = ads.getLastConversionResults();
+        readings[activeChannel] = ads.computeVolts(results);
+    }
+};

usermods/Analog_Clock/Analog_Clock.h

@@ -0,0 +1,256 @@
+#pragma once
+#include "wled.h"
+
+/*
+ * Usermod for analog clock
+ */
+extern Timezone* tz;
+
+class AnalogClockUsermod : public Usermod {
+private:
+    static constexpr uint32_t refreshRate = 50; // per second
+    static constexpr uint32_t refreshDelay = 1000 / refreshRate;
+
+    struct Segment {
+        // config
+        int16_t firstLed  = 0;
+        int16_t lastLed   = 59;
+        int16_t centerLed = 0;
+
+        // runtime
+        int16_t size;
+
+        Segment() {
+            update();
+        }
+
+        void validateAndUpdate() {
+            if (firstLed < 0 || firstLed >= strip.getLengthTotal() ||
+                    lastLed < firstLed || lastLed >= strip.getLengthTotal()) {
+                *this = {};
+                return;
+            }
+            if (centerLed < firstLed || centerLed > lastLed) {
+                centerLed = firstLed;
+            }
+            update();
+        }
+
+        void update() {
+            size = lastLed - firstLed + 1;
+        }
+    };
+
+    // configuration (available in API and stored in flash)
+    bool     enabled          = false;
+    Segment  mainSegment;
+    bool     hourMarksEnabled = true;
+    uint32_t hourMarkColor    = 0xFF0000;
+    uint32_t hourColor        = 0x0000FF;
+    uint32_t minuteColor      = 0x00FF00;
+    bool     secondsEnabled   = true;
+    Segment  secondsSegment;
+    uint32_t secondColor      = 0xFF0000;
+    bool     blendColors      = true;
+    uint16_t secondsEffect    = 0;
+
+    // runtime
+    bool     initDone         = false;
+    uint32_t lastOverlayDraw  = 0;
+
+    void validateAndUpdate() {
+        mainSegment.validateAndUpdate();
+        secondsSegment.validateAndUpdate();
+        if (secondsEffect < 0 || secondsEffect > 1) {
+            secondsEffect = 0;
+        }
+    }
+
+    int16_t adjustToSegment(double progress, Segment const& segment) {
+        int16_t led = segment.centerLed + progress * segment.size;
+        return led > segment.lastLed
+                ? segment.firstLed + led - segment.lastLed - 1
+                : led;
+    }
+
+    void setPixelColor(uint16_t n, uint32_t c) {
+        if (!blendColors) {
+            strip.setPixelColor(n, c);
+        } else {
+            uint32_t oldC = strip.getPixelColor(n);
+            strip.setPixelColor(n, qadd32(oldC, c));
+        }
+    }
+
+    String colorToHexString(uint32_t c) {
+        char buffer[9];
+        sprintf(buffer, "%06X", c);
+        return buffer;
+    }
+
+    bool hexStringToColor(String const& s, uint32_t& c, uint32_t def) {
+        char *ep;
+        unsigned long long r = strtoull(s.c_str(), &ep, 16);
+        if (*ep == 0) {
+            c = r;
+            return true;
+        } else {
+            c = def;
+            return false;
+        }
+    }
+
+    void secondsEffectSineFade(int16_t secondLed, Toki::Time const& time) {
+        uint32_t ms = time.ms % 1000;
+        uint8_t b0 = (cos8(ms * 64 / 1000) - 128) * 2;
+        setPixelColor(secondLed, gamma32(scale32(secondColor, b0)));
+        uint8_t b1 = (sin8(ms * 64 / 1000) - 128) * 2;
+        setPixelColor(inc(secondLed, 1, secondsSegment), gamma32(scale32(secondColor, b1)));
+    }
+
+    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(W(c1), W(c2))
+        );
+    }
+
+    static inline uint32_t scale32(uint32_t c, fract8 scale) {
+        return RGBW32(
+            scale8(R(c), scale),
+            scale8(G(c), scale),
+            scale8(B(c), scale),
+            scale8(W(c), scale)
+        );
+    }
+
+    static inline int16_t dec(int16_t n, int16_t i, Segment const& seg) {
+        return n - seg.firstLed >= i
+                ? n - i
+                : seg.lastLed - seg.firstLed - i + n + 1;
+    }
+
+    static inline int16_t inc(int16_t n, int16_t i, Segment const& seg) {
+        int16_t r = n + i;
+        if (r > seg.lastLed) {
+            return seg.firstLed + n - seg.lastLed;
+        }
+        return r;
+    }
+
+public:
+    AnalogClockUsermod() {
+    }
+
+    void setup() override {
+        initDone = true;
+        validateAndUpdate();
+    }
+
+    void loop() override {
+        if (millis() - lastOverlayDraw > refreshDelay) {
+            strip.trigger();
+        }
+    }
+
+    void handleOverlayDraw() override {
+        if (!enabled) {
+            return;
+        }
+
+        lastOverlayDraw = millis();
+
+        auto time = toki.getTime();
+        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)
+            {
+                int16_t hourmarkled = adjustToSegment(Led / 60.0, mainSegment);
+                setPixelColor(hourmarkled, hourMarkColor);
+            }
+        }
+
+        if (secondsEnabled) {
+            int16_t secondLed = adjustToSegment(secondP, secondsSegment);
+
+            switch (secondsEffect) {
+                case 0: // no effect
+                    setPixelColor(secondLed, secondColor);
+                    break;
+
+                case 1: // fading seconds
+                    secondsEffectSineFade(secondLed, time);
+                    break;
+            }
+
+            // TODO: move to secondsTrailEffect
+            // for (uint16_t i = 1; i < secondsTrail + 1; ++i) {
+            //     uint16_t trailLed = dec(secondLed, i, secondsSegment);
+            //     uint8_t trailBright = 255 / (secondsTrail + 1) * (secondsTrail - i + 1);
+            //     setPixelColor(trailLed, gamma32(scale32(secondColor, trailBright)));
+            // }
+        }
+
+        setPixelColor(adjustToSegment(minuteP, mainSegment), minuteColor);
+        setPixelColor(adjustToSegment(hourP, mainSegment), hourColor);
+    }
+
+    void addToConfig(JsonObject& root) override {
+        validateAndUpdate();
+
+        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[F("Analog Clock")];
+
+        bool configComplete = !top.isNull();
+
+        String color;
+        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();
+        }
+
+        return configComplete;
+    }
+
+    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;
@@ -65,7 +66,7 @@ class Animated_Staircase : public Usermod {
     // The maximum number of configured segments.
     // Dynamically updated based on user configuration.
     byte maxSegmentId = 1;
-    byte mainSegmentId = 0;
+    byte minSegmentId = 0;
 
     // These values are used by the API to read the
     // last sensor state, or trigger a sensor
@@ -90,39 +91,37 @@ class Animated_Staircase : public Usermod {
     static const char _bottomEcho_pin[];
     static const char _topEchoCm[];
     static const char _bottomEchoCm[];
-    
-    void publishMqtt(bool bottom, const char* state)
-    {
+    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() {
-      mainSegmentId = strip.getMainSegmentId();
-      WS2812FX::Segment* segments = strip.getSegments();
-      for (int i = 0; i < MAX_NUM_SEGMENTS; i++, segments++) {
-        if (!segments->isActive()) {
-          maxSegmentId = i - 1;
-          break;
-        }
-
+      for (int i = minSegmentId; i < maxSegmentId; i++) {
+        Segment &seg = strip.getSegment(i);
+        if (!seg.isActive()) continue; // skip gaps
         if (i >= onIndex && i < offIndex) {
-          segments->setOption(SEG_OPTION_ON, 1, 1);
-
+          seg.setOption(SEG_OPTION_ON, true);
           // We may need to copy mode and colors from segment 0 to make sure
           // changes are propagated even when the config is changed during a wipe
-          // segments->mode = mainsegment.mode;
-          // segments->colors[0] = mainsegment.colors[0];
+          // seg.setMode(mainsegment.mode);
+          // seg.setColor(0, mainsegment.colors[0]);
         } else {
-          segments->setOption(SEG_OPTION_ON, 0, 1);
+          seg.setOption(SEG_OPTION_ON, false);
         }
         // Always mark segments as "transitional", we are animating the staircase
-        segments->setOption(SEG_OPTION_TRANSITIONAL, 1, 1);
+        //seg.setOption(SEG_OPTION_TRANSITIONAL, true); // not needed anymore as setOption() does it
       }
+      strip.trigger();  // force strip refresh
+      stateChanged = true;  // inform external devices/UI of change
       colorUpdated(CALL_MODE_DIRECT_CHANGE);
     }
 
@@ -134,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.
     *
@@ -199,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;
 
@@ -208,9 +208,9 @@ class Animated_Staircase : public Usermod {
             if (onIndex == offIndex) {
               // Position the indices for a correct on-swipe
               if (swipe == SWIPE_UP) {
-                onIndex = mainSegmentId;
+                onIndex = minSegmentId;
               } else {
-                onIndex = maxSegmentId+1;
+                onIndex = maxSegmentId;
               }
               offIndex = onIndex;
             }
@@ -222,7 +222,7 @@ class Animated_Staircase : public Usermod {
     }
 
     void autoPowerOff() {
-      if (on && ((millis() - lastSwitchTime) > on_time_ms)) {
+      if ((millis() - lastSwitchTime) > on_time_ms) {
         // if sensors are still on, do nothing
         if (bottomSensorState || topSensorState) return;
 
@@ -239,10 +239,12 @@ class Animated_Staircase : public Usermod {
       if ((millis() - lastTime) > segment_delay_ms) {
         lastTime = millis();
 
+        byte oldOn  = onIndex;
+        byte oldOff = offIndex;
         if (on) {
           // Turn on all segments
-          onIndex = MAX(mainSegmentId, onIndex - 1);
-          offIndex = MIN(maxSegmentId + 1, offIndex + 1);
+          onIndex  = MAX(minSegmentId, onIndex - 1);
+          offIndex = MIN(maxSegmentId, offIndex + 1);
         } else {
           if (swipe == SWIPE_UP) {
             onIndex = MIN(offIndex, onIndex + 1);
@@ -250,11 +252,14 @@ class Animated_Staircase : public Usermod {
             offIndex = MAX(onIndex, offIndex - 1);
           }
         }
-        updateSegments();
+        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;
@@ -288,16 +293,23 @@ class Animated_Staircase : public Usermod {
           pinMode(topPIRorTriggerPin, OUTPUT);
           pinMode(topEchoPin, INPUT);
         }
+        onIndex  = minSegmentId = strip.getMainSegmentId(); // it may not be the best idea to start with main segment as it may not be the first one
+        offIndex = maxSegmentId = strip.getLastActiveSegmentId() + 1;
+
+        // shorten the strip transition time to be equal or shorter than segment delay
+        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
-        WS2812FX::Segment* segments = strip.getSegments();
-        for (int i = 0; i < MAX_NUM_SEGMENTS; i++, segments++) {
-          if (!segments->isActive()) {
-            maxSegmentId = i - 1;
-            break;
-          }
-          segments->setOption(SEG_OPTION_ON, 1, 1);
+        for (int i = 0; i <= strip.getLastActiveSegmentId(); i++) {
+          Segment &seg = strip.getSegment(i);
+          if (!seg.isActive()) continue; // skip vector gaps
+          seg.setOption(SEG_OPTION_ON, true);
         }
+        strip.trigger();  // force strip update
+        stateChanged = true;  // inform external devices/UI of change
         colorUpdated(CALL_MODE_DIRECT_CHANGE);
         DEBUG_PRINTLN(F("Animated Staircase disabled."));
       }
@@ -333,13 +345,16 @@ class Animated_Staircase : public Usermod {
 
     void loop() {
       if (!enabled || strip.isUpdating()) return;
+      minSegmentId = strip.getMainSegmentId();  // it may not be the best idea to start with main segment as it may not be the first one
+      maxSegmentId = strip.getLastActiveSegmentId() + 1;
       checkSensors();
-      autoPowerOff();
+      if (on) autoPowerOff();
       updateSwipe();
     }
 
     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)
@@ -377,6 +392,7 @@ class Animated_Staircase : public Usermod {
         mqtt->subscribe(subuf, 0);
       }
     }
+#endif
 
     void addToJsonState(JsonObject& root) {
       JsonObject staircase = root[FPSTR(_name)];
@@ -393,19 +409,29 @@ class Animated_Staircase : public Usermod {
     */
     void readFromJsonState(JsonObject& root) {
       if (!initDone) return;  // prevent crash on boot applyPreset()
+      bool en = enabled;
       JsonObject staircase = root[FPSTR(_name)];
       if (!staircase.isNull()) {
         if (staircase[FPSTR(_enabled)].is<bool>()) {
-          enabled   = staircase[FPSTR(_enabled)].as<bool>();
+          en = staircase[FPSTR(_enabled)].as<bool>();
         } else {
           String str = staircase[FPSTR(_enabled)]; // checkbox -> off or on
-          enabled = (bool)(str!="off"); // off is guaranteed to be present
+          en = (bool)(str!="off"); // off is guaranteed to be present
         }
+        if (en != enabled) enable(en);
         readSensorsFromJson(staircase);
         DEBUG_PRINTLN(F("Staircase sensor state read from API."));
       }
     }
 
+    void appendConfigData() {
+      //oappend(SET_F("dd=addDropdown('staircase','selectfield');"));
+      //oappend(SET_F("addOption(dd,'1st value',0);"));
+      //oappend(SET_F("addOption(dd,'2nd value',1);"));
+      //oappend(SET_F("addInfo('staircase:selectfield',1,'additional info');"));  // 0 is field type, 1 is actual field
+    }
+
+
     /*
     * Writes the configuration to internal flash memory.
     */
@@ -425,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."));
     }
 
@@ -465,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
@@ -492,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();
     }
 
     /*
@@ -500,22 +529,22 @@ class Animated_Staircase : public Usermod {
     * tab of the web-UI.
     */
     void addToJsonInfo(JsonObject& root) {
-      JsonObject staircase = root["u"];
-      if (staircase.isNull()) {
-        staircase = root.createNestedObject("u");
+      JsonObject user = root["u"];
+      if (user.isNull()) {
+        user = root.createNestedObject("u");
       }
 
-      JsonArray usermodEnabled = staircase.createNestedArray(F("Staircase"));  // name
-      String btn = F("<button class=\"btn infobtn\" onclick=\"requestJson({staircase:{enabled:");
-      if (enabled) {
-        btn += F("false}},false,false);loadInfo();\">");
-        btn += F("enabled");
-      } else {
-        btn += F("true}},false,false);loadInfo();\">");
-        btn += F("disabled");
-      }
-      btn += F("</button>");
-      usermodEnabled.add(btn);                             // value
+      JsonArray infoArr = user.createNestedArray(FPSTR(_name));  // name
+
+      String uiDomString = F("<button class=\"btn btn-xs\" onclick=\"requestJson({");
+      uiDomString += FPSTR(_name);
+      uiDomString += F(":{");
+      uiDomString += FPSTR(_enabled);
+      uiDomString += enabled ? F(":false}});\">") : F(":true}});\">");
+      uiDomString += F("<i class=\"icons ");
+      uiDomString += enabled ? "on" : "off";
+      uiDomString += F("\">&#xe08f;</i></button>");
+      infoArr.add(uiDomString);
     }
 };
 
@@ -532,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

@@ -1,17 +1,17 @@
 # Usermod Animated Staircase
-This usermod makes your staircase look cool by switching it on with an animation. It uses
+This usermod makes your staircase look cool by illuminating it with an animation. It uses
 PIR or ultrasonic sensors at the top and bottom of your stairs to:
 
-- Light up the steps in your walking direction, leading the way.
+- Light up the steps in the direction you're walking.
 - Switch off the steps after you, in the direction of the last detected movement.
 - Always switch on when one of the sensors detects movement, even if an effect
-  is still running. It can therewith handle multiple people on the stairs gracefully.
+  is still running. It can gracefully handle multiple people on the stairs.
 
 The Animated Staircase can be controlled by the WLED API. Change settings such as
-speed, on/off time and distance settings by sending an HTTP request, see below.
+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:
 
@@ -20,17 +20,16 @@ Edit `usermods_list.cpp`:
 2. add `#include "../usermods/Animated_Staircase/Animated_Staircase.h"` to the top of the file
 3. add `usermods.add(new Animated_Staircase());` to the end of the `void registerUsermods()` function.
 
-You can configure usermod using Usermods settings page.
-Please enter GPIO pins for PIR sensors or ultrasonic sensor (trigger and echo).
+You can configure usermod using the Usermods settings page.
+Please enter GPIO pins for PIR or ultrasonic sensors (trigger and echo).
 If you use PIR sensor enter -1 for echo pin.
-Maximum distance for ultrasonic sensor can be configured as a time needed for echo (see below).
+Maximum distance for ultrasonic sensor can be configured as the time needed for an echo (see below).
 
 ## Hardware installation
-1. Stick the LED strip under each step of the stairs.
-2. Connect the ESP8266 pin D4 or ESP32 pin D2 to the first LED data pin at the bottom step
-   of your stairs.
+1. Attach the LED strip to each step of the stairs.
+2. Connect the ESP8266 pin D4 or ESP32 pin D2 to the first LED data pin at the bottom step.
 3. Connect the data-out pin at the end of each strip per step to the data-in pin on the 
-   other end of the next step, creating one large virtual LED strip.
+   next step, creating one large virtual LED strip.
 4. Mount sensors of choice at the bottom and top of the stairs and connect them to the ESP.
 5. To make sure all LEDs get enough power and have your staircase lighted evenly, power each
    step from one side, using at least AWG14 or 2.5mm^2 cable. Don't connect them serial as you
@@ -39,7 +38,7 @@ Maximum distance for ultrasonic sensor can be configured as a time needed for ec
 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 
@@ -62,7 +61,7 @@ or remove them and put everything on one line.
 
 To read the current settings, open a browser to `http://xxx.xxx.xxx.xxx/json/state` (use your WLED 
 device IP address). The device will respond with a json object containing all WLED settings. 
-The staircase settings and sensor states are inside the WLED status element:
+The staircase settings and sensor states are inside the WLED "state" element:
 
 ```json
 {
@@ -70,14 +69,14 @@ The staircase settings and sensor states are inside the WLED status element:
         "staircase": {
             "enabled": true,
             "bottom-sensor": false,
-            "tops-ensor": false
+            "top-sensor": false
         },
 }
 ```
 
 ### Enable/disable the usermod
 By disabling the usermod you will be able to keep the LED's on, independent from the sensor
-activity. This enables to play with the lights without the usermod switching them on or off.
+activity. This enables you to play with the lights without the usermod switching them on or off.
 
 To disable the usermod:
 
@@ -92,17 +91,17 @@ 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 and so on.
+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.
 
-**Please note:** that using an HC-SR04 sensor, particularly when detecting echos at longer
-distances creates delays in the WLED software, and _might_ introduce timing hickups in your animations or
+**Please note:** using an HC-SR04 sensor, particularly when detecting echos at longer
+distances creates delays in the WLED software, _might_ introduce timing hiccups in your animation or
 a less responsive web interface. It is therefore advised to keep the detection distance as short as possible.
 
 ### Animation triggering through the API
-Instead of stairs activation by one of the sensors, you can also trigger the animation through
-the API. To simulate triggering the bottom sensor, use:
+In addition to activation by one of the stair sensors, you can also trigger the animation manually
+via the API. To simulate triggering the bottom sensor, use:
 
 ```bash
 curl -X POST -H "Content-Type: application/json" \
@@ -110,7 +109,7 @@ curl -X POST -H "Content-Type: application/json" \
      xxx.xxx.xxx.xxx/json/state
 ```
 
-Likewise, to trigger the top sensor, use:
+Likewise, to trigger the top sensor:
 
 ```bash
 curl -X POST -H "Content-Type: application/json" \
@@ -119,7 +118,7 @@ curl -X POST -H "Content-Type: application/json" \
 ```
 **MQTT**
 You can publish a message with either `up` or `down` on topic `/swipe` to trigger animation.
-You can also use `on` or `off` for enabling or disabling usermod.
+You can also use `on` or `off` for enabling or disabling the usermod.
 
 Have fun with this usermod.<br/>
 www.rolfje.com
@@ -128,4 +127,4 @@ Modifications @blazoncek
 
 ## Change log
 2021-04
-* Adaptation for runtime configuration.
+* Adaptation for runtime configuration.

usermods/Artemis_reciever/usermod.cpp

@@ -24,7 +24,7 @@ void RGBNET_readValues() {
     int channel = UDP.read();
 
     //channel data is not used we only supports one channel
-    int len = UDP.read(RGBNET_packet, ledCount*3);
+    int len = UDP.read(RGBNET_packet, strip.getLengthTotal()*3);
     if(len==0){
       return;
     }
@@ -50,7 +50,7 @@ void handleConfig(AsyncWebServerRequest *request)
   \"channels\": [\
     {\
       \"channel\": 1,\
-      \"leds\": " + ledCount + "\
+      \"leds\": " + strip.getLengthTotal() + "\
     },\
     {\
       \"channel\": 2,\

usermods/BH1750_v2/readme.md

@@ -0,0 +1,49 @@
+# BH1750 usermod
+
+This usermod will read from an ambient light sensor like the BH1750.
+The luminance is displayed in both the Info section of the web UI, as well as published to the `/luminance` MQTT topic if enabled.
+
+## Dependencies
+- Libraries
+  - `claws/BH1750 @^1.2.0`
+  - 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.
+
+## Compilation
+
+To enable, compile with `USERMOD_BH1750` defined  (e.g. in `platformio_override.ini`)
+```ini
+[env:usermod_BH1750_d1_mini]
+extends = env:d1_mini
+build_flags =
+    ${common.build_flags_esp8266}
+    -D USERMOD_BH1750
+lib_deps = 
+    ${esp8266.lib_deps}
+    claws/BH1750 @ ^1.2.0
+```
+
+### Configuration Options
+The following settings can be set at compile-time but are configurable on the usermod menu (except First Measurement time):
+*   `USERMOD_BH1750_MAX_MEASUREMENT_INTERVAL` - the max number of milliseconds between measurements, defaults to 10000ms
+*   `USERMOD_BH1750_MIN_MEASUREMENT_INTERVAL` - the min number of milliseconds between measurements, defaults to 500ms
+*   `USERMOD_BH1750_OFFSET_VALUE` - the offset value to report on, defaults to 1
+*   `USERMOD_BH1750_FIRST_MEASUREMENT_AT` - the number of milliseconds after boot to take first measurement, defaults to 10000 ms
+
+In addition, the Usermod screen allows you to:
+- enable/disable the usermod
+- Enable Home Assistant Discovery of usermod
+- Configure the SCL/SDA pins
+
+## API
+The following method is available to interact with the usermod from other code modules:
+- `getIlluminance` read the brightness from the sensor
+
+## Change Log
+Jul 2022
+- Added Home Assistant Discovery
+- Implemented PinManager to register pins
+- Made pins configurable in usermod menu
+- Added API call to read luminance from other modules
+- Enhanced info-screen outputs
+- Updated `readme.md`

usermods/BH1750_v2/usermod_bh1750.h

@@ -0,0 +1,252 @@
+// 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 <BH1750.h>
+
+// the max frequency to check photoresistor, 10 seconds
+#ifndef USERMOD_BH1750_MAX_MEASUREMENT_INTERVAL
+#define USERMOD_BH1750_MAX_MEASUREMENT_INTERVAL 10000
+#endif
+
+// the min frequency to check photoresistor, 500 ms
+#ifndef USERMOD_BH1750_MIN_MEASUREMENT_INTERVAL
+#define USERMOD_BH1750_MIN_MEASUREMENT_INTERVAL 500
+#endif
+
+// how many seconds after boot to take first measurement, 10 seconds
+#ifndef USERMOD_BH1750_FIRST_MEASUREMENT_AT
+#define USERMOD_BH1750_FIRST_MEASUREMENT_AT 10000
+#endif
+
+// only report if difference grater than offset value
+#ifndef USERMOD_BH1750_OFFSET_VALUE
+#define USERMOD_BH1750_OFFSET_VALUE 1
+#endif
+
+class Usermod_BH1750 : public Usermod
+{
+private:
+  int8_t offset = USERMOD_BH1750_OFFSET_VALUE;
+
+  unsigned long maxReadingInterval = USERMOD_BH1750_MAX_MEASUREMENT_INTERVAL;
+  unsigned long minReadingInterval = USERMOD_BH1750_MIN_MEASUREMENT_INTERVAL;
+  unsigned long lastMeasurement = UINT32_MAX - (USERMOD_BH1750_MAX_MEASUREMENT_INTERVAL - USERMOD_BH1750_FIRST_MEASUREMENT_AT);
+  unsigned long lastSend = UINT32_MAX - (USERMOD_BH1750_MAX_MEASUREMENT_INTERVAL - USERMOD_BH1750_FIRST_MEASUREMENT_AT);
+  // flag to indicate we have finished the first readLightLevel call
+  // allows this library to report to the user how long until the first
+  // measurement
+  bool getLuminanceComplete = false;
+
+  // flag set at startup
+  bool enabled = true;
+
+  // strings to reduce flash memory usage (used more than twice)
+  static const char _name[];
+  static const char _enabled[];
+  static const char _maxReadInterval[];
+  static const char _minReadInterval[];
+  static const char _offset[];
+  static const char _HomeAssistantDiscovery[];
+
+  bool initDone = false;
+  bool sensorFound = false;
+
+  // Home Assistant and MQTT  
+  String mqttLuminanceTopic = F("");
+  bool mqttInitialized = false;
+  bool HomeAssistantDiscovery = true; // Publish Home Assistant Discovery messages
+
+  BH1750 lightMeter;
+  float lastLux = -1000;
+
+  bool checkBoundSensor(float newValue, float prevValue, float maxDiff)
+  {
+    return isnan(prevValue) || newValue <= prevValue - maxDiff || newValue >= prevValue + maxDiff || (newValue == 0.0 && prevValue > 0.0);
+  }
+  
+  // set up Home Assistant discovery entries
+  void _mqttInitialize()
+  {
+    mqttLuminanceTopic = String(mqttDeviceTopic) + F("/brightness");
+
+    if (HomeAssistantDiscovery) _createMqttSensor(F("Brightness"), mqttLuminanceTopic, F("Illuminance"), F(" lx"));
+  }
+
+  // Create an MQTT Sensor for Home Assistant Discovery purposes, this includes a pointer to the topic that is published to in the Loop.
+  void _createMqttSensor(const String &name, const String &topic, const String &deviceClass, const String &unitOfMeasurement)
+  {
+    String t = String(F("homeassistant/sensor/")) + mqttClientID + F("/") + name + F("/config");
+    
+    StaticJsonDocument<600> doc;
+    
+    doc[F("name")] = String(serverDescription) + " " + name;
+    doc[F("state_topic")] = topic;
+    doc[F("unique_id")] = String(mqttClientID) + name;
+    if (unitOfMeasurement != "")
+      doc[F("unit_of_measurement")] = unitOfMeasurement;
+    if (deviceClass != "")
+      doc[F("device_class")] = deviceClass;
+    doc[F("expire_after")] = 1800;
+
+    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_BRAND);
+    device[F("model")] = F(WLED_PRODUCT_NAME);
+    device[F("sw_version")] = versionString;
+
+    String temp;
+    serializeJson(doc, temp);
+    DEBUG_PRINTLN(t);
+    DEBUG_PRINTLN(temp);
+
+    mqtt->publish(t.c_str(), 0, true, temp.c_str());
+  }
+
+public:
+  void setup()
+  {
+    if (i2c_scl<0 || i2c_sda<0) { enabled = false; return; }
+    sensorFound = lightMeter.begin();
+    initDone = true;
+  }
+
+  void loop()
+  {
+    if ((!enabled) || strip.isUpdating())
+      return;
+
+    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 < minReadingInterval)
+    {
+      return;
+    }
+
+    bool shouldUpdate = now - lastSend > maxReadingInterval;
+
+    float lux = lightMeter.readLightLevel();
+    lastMeasurement = millis();
+    getLuminanceComplete = true;
+
+    if (shouldUpdate || checkBoundSensor(lux, lastLux, offset))
+    {
+      lastLux = lux;
+      lastSend = millis();
+#ifndef WLED_DISABLE_MQTT
+      if (WLED_MQTT_CONNECTED)
+      {
+        if (!mqttInitialized)
+          {
+            _mqttInitialize();
+            mqttInitialized = true;
+          }
+        mqtt->publish(mqttLuminanceTopic.c_str(), 0, true, String(lux).c_str());
+        DEBUG_PRINTLN(F("Brightness: ") + String(lux) + F("lx"));
+      }
+      else
+      {
+        DEBUG_PRINTLN(F("Missing MQTT connection. Not publishing data"));
+      }
+#endif
+    }
+  }
+
+  inline float getIlluminance() {
+    return (float)lastLux;
+  }
+
+  void addToJsonInfo(JsonObject &root)
+  {
+    JsonObject user = root[F("u")];
+    if (user.isNull())
+      user = root.createNestedObject(F("u"));
+
+    JsonArray lux_json = user.createNestedArray(F("Luminance"));
+    if (!enabled) {
+      lux_json.add(F("disabled"));
+    } else if (!sensorFound) {
+        // if no sensor 
+        lux_json.add(F("BH1750 "));
+        lux_json.add(F("Not Found"));
+    } else if (!getLuminanceComplete) {
+      // if we haven't read the sensor yet, let the user know
+        // that we are still waiting for the first measurement
+        lux_json.add((USERMOD_BH1750_FIRST_MEASUREMENT_AT - millis()) / 1000);
+        lux_json.add(F(" sec until read"));
+        return;
+    } else {
+      lux_json.add(lastLux);
+      lux_json.add(F(" lx"));
+    }
+  }
+
+  // (called from set.cpp) stores persistent properties to cfg.json
+  void addToConfig(JsonObject &root)
+  {
+    // we add JSON object.
+    JsonObject top = root.createNestedObject(FPSTR(_name)); // usermodname
+    top[FPSTR(_enabled)] = enabled;
+    top[FPSTR(_maxReadInterval)] = maxReadingInterval;
+    top[FPSTR(_minReadInterval)] = minReadingInterval;
+    top[FPSTR(_HomeAssistantDiscovery)] = HomeAssistantDiscovery;
+    top[FPSTR(_offset)] = offset;
+
+    DEBUG_PRINTLN(F("BH1750 config saved."));
+  }
+
+  // called before setup() to populate properties from values stored in cfg.json
+  bool readFromConfig(JsonObject &root)
+  {
+    // we look for JSON object.
+    JsonObject top = root[FPSTR(_name)];
+    if (top.isNull())
+    {
+      DEBUG_PRINT(FPSTR(_name));
+      DEBUG_PRINT(F("BH1750"));
+      DEBUG_PRINTLN(F(": No config found. (Using defaults.)"));
+      return false;
+    }
+    bool configComplete = !top.isNull();
+
+    configComplete &= getJsonValue(top[FPSTR(_enabled)], enabled, false);
+    configComplete &= getJsonValue(top[FPSTR(_maxReadInterval)], maxReadingInterval, 10000); //ms
+    configComplete &= getJsonValue(top[FPSTR(_minReadInterval)], minReadingInterval, 500); //ms
+    configComplete &= getJsonValue(top[FPSTR(_HomeAssistantDiscovery)], HomeAssistantDiscovery, false);
+    configComplete &= getJsonValue(top[FPSTR(_offset)], offset, 1);
+
+    DEBUG_PRINT(FPSTR(_name));
+    if (!initDone) {
+      DEBUG_PRINTLN(F(" config loaded."));
+    } else {
+      DEBUG_PRINTLN(F(" config (re)loaded."));
+    }
+
+    return configComplete;
+    
+  }
+
+  uint16_t getId()
+  {
+    return USERMOD_ID_BH1750;
+  }
+
+};
+
+// strings to reduce flash memory usage (used more than twice)
+const char Usermod_BH1750::_name[] PROGMEM = "BH1750";
+const char Usermod_BH1750::_enabled[] PROGMEM = "enabled";
+const char Usermod_BH1750::_maxReadInterval[] PROGMEM = "max-read-interval-ms";
+const char Usermod_BH1750::_minReadInterval[] PROGMEM = "min-read-interval-ms";
+const char Usermod_BH1750::_HomeAssistantDiscovery[] PROGMEM = "HomeAssistantDiscoveryLux";
+const char Usermod_BH1750::_offset[] PROGMEM = "offset-lx";

usermods/BME280_v2/README.md

@@ -1,40 +1,90 @@
-Hello! I have written a v2 usermod for the BME280/BMP280 sensor based on the [existing v1 usermod](https://github.com/Aircoookie/WLED/blob/master/usermods/Wemos_D1_mini%2BWemos32_mini_shield/usermod_bme280.cpp). It is not just a refactor, there are many changes which I made to fit my use case, and I hope they will fit the use cases of others as well! Most notably, this usermod is *just* for the BME280 and does not control a display like in the v1 usermod designed for the WeMos shield. 
+# Usermod BME280
+This Usermod is designed to read a `BME280` or `BMP280` sensor and output the following:
+- Temperature
+- Humidity (`BME280` only)
+- Pressure
+- Heat Index (`BME280` only)
+- Dew Point (`BME280` only)
 
-- Requires libraries `BME280@~3.0.0` (by [finitespace](https://github.com/finitespace/BME280)) and `Wire`. Please add these under `lib_deps` in your `platform.ini` (or `platform_override.ini`).
-- Data is published over MQTT so make sure you've enabled the MQTT sync interface.
-- This usermod also writes to serial (GPIO1 on ESP8266). Please make sure nothing else listening on the serial TX pin of your board will get confused by log messages!
+Configuration is performed via the Usermod menu.  There are no parameters to set in code!  The following settings can be configured in the Usermod Menu:
+- Temperature Decimals (number of decimal places to output)
+- Humidity Decimals
+- Pressure Decimals
+- Temperature Interval (how many seconds between temperature and humidity measurements)
+- Pressure Interval
+- Publish Always (turn off to only publish changes, on to publish whether or not value changed)
+- Use Celsius (turn off to use Fahrenheit)
+- Home Assistant Discovery (turn on to sent MQTT Discovery entries for Home Assistant)
+- SCL/SDA GPIO Pins
 
-To enable, compile with `USERMOD_BME280` defined (i.e. `platformio_override.ini`)
+Dependencies
+- Libraries
+  - `BME280@~3.0.0` (by [finitespace](https://github.com/finitespace/BME280))
+  - `Wire`
+  - These must be added under `lib_deps` in your `platform.ini` (or `platform_override.ini`).
+- Data is published over MQTT - make sure you've enabled the MQTT sync interface.
+- This usermod also writes to serial (GPIO1 on ESP8266). Please make sure nothing else is listening to the serial TX pin or your board will get confused by log messages!
+
+In addition to outputting via MQTT, you can read the values from the Info Screen on the dashboard page of the device's web interface.
+
+Methods also exist to read the read/calculated values from other WLED modules through code.
+- `getTemperatureC()`
+- `getTemperatureF()`
+- `getHumidity()`
+- `getPressure()`
+- `getDewPointC()`
+- `getDewPointF()`
+- `getHeatIndexC()`
+- `getHeatIndexF()`
+
+# Compiling
+
+To enable, compile with `USERMOD_BME280` defined  (e.g. in `platformio_override.ini`)
 ```ini
+[env:usermod_bme280_d1_mini]
+extends = env:d1_mini
 build_flags =
   ${common.build_flags_esp8266}
   -D USERMOD_BME280
-```
-or define `USERMOD_BME280` in `my_config.h`
-```c++
-#define USERMOD_BME280
+lib_deps = 
+  ${esp8266.lib_deps}
+  BME280@~3.0.0
+  Wire
 ```
 
-Changes include:
-- Adjustable measure intervals
-  - Temperature and pressure have separate intervals due to pressure not frequently changing at any constant altitude
-- Adjustment of number of decimal places in published sensor values
-  - Separate adjustment for temperature, humidity and pressure values
-  - Values are rounded to the specified number of decimal places
-- Pressure measured in units of hPa instead of Pa
-- Calculation of heat index (apparent temperature) and dew point
-  - These, along with humidity measurements, are disabled if the sensor is a BMP280
-- 16x oversampling of sensor during measurement
-- Values are only published if they are different from the previous value
-- Values are published on startup (continually until the MQTT broker acknowledges a successful publication)
 
-Adjustments are made through preprocessor definitions at the start of the class definition.
-
-MQTT topics are as follows:
+# MQTT
+MQTT topics are as follows (`<deviceTopic>` is set in MQTT section of Sync Setup menu):
 Measurement type | MQTT topic
 --- | ---
 Temperature | `<deviceTopic>/temperature`
 Humidity | `<deviceTopic>/humidity`
 Pressure | `<deviceTopic>/pressure`
 Heat index | `<deviceTopic>/heat_index`
-Dew point | `<deviceTopic>/dew_point`
+Dew point | `<deviceTopic>/dew_point`
+
+If you are using Home Assistant, and `Home Assistant Discovery` is turned on, Home Assistant should automatically detect a new device, provided you have the MQTT integration installed.  The device is separate from the main WLED device and will contain sensors for Pressure, Humidity, Temperature, Dew Point and Heat Index.
+
+# Revision History
+Jul 2022
+- Added Home Assistant Discovery
+- Added API interface to output data
+- Removed compile-time variables
+- Added usermod menu interface
+- Added value outputs to info screen
+- Updated `readme.md`
+- Registered usermod
+- Implemented PinManager for usermod
+- Implemented reallocation of pins without reboot
+
+Apr 2021
+- Added `Publish Always` option
+
+Dec 2020
+- Ported to V2 Usermod format
+- Customizable `measure intervals`
+- Customizable number of `decimal places` in published sensor values
+- Pressure measured in units of hPa instead of Pa
+- Calculation of heat index (apparent temperature) and dew point
+- `16x oversampling` of sensor during measurement
+- Values only published if they are different from the previous value

usermods/BME280_v2/usermod_bme280.h

@@ -1,51 +1,39 @@
+// 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
 
 class UsermodBME280 : public Usermod
 {
 private:
-// User-defined configuration
-#define Celsius               // Show temperature mesaurement in Celcius. Comment out for Fahrenheit
-#define TemperatureDecimals 1 // Number of decimal places in published temperaure values
-#define HumidityDecimals 2    // Number of decimal places in published humidity values
-#define PressureDecimals 2    // Number of decimal places in published pressure values
-#define TemperatureInterval 5 // Interval to measure temperature (and humidity, dew point if available) in seconds
-#define PressureInterval 300  // Interval to measure pressure in seconds
-#define PublishAlways 0       // Publish values even when they have not changed
+  
+  // NOTE: Do not implement any compile-time variables, anything the user needs to configure
+  // should be configurable from the Usermod menu using the methods below
+  // key settings set via usermod menu
+  uint8_t  TemperatureDecimals = 0;  // Number of decimal places in published temperaure values
+  uint8_t  HumidityDecimals = 0;    // Number of decimal places in published humidity values
+  uint8_t  PressureDecimals = 0;    // Number of decimal places in published pressure values
+  uint16_t TemperatureInterval = 5; // Interval to measure temperature (and humidity, dew point if available) in seconds
+  uint16_t PressureInterval = 300;  // Interval to measure pressure in seconds
+  bool PublishAlways = false;             // Publish values even when they have not changed
+  bool UseCelsius = true;                 // Use Celsius for Reporting
+  bool HomeAssistantDiscovery = false;    // Publish Home Assistant Device Information
+  bool enabled = true;
 
-// Sanity checks
-#if !defined(TemperatureDecimals) || TemperatureDecimals < 0
-  #define TemperatureDecimals 0
-#endif
-#if !defined(HumidityDecimals) || HumidityDecimals < 0
-  #define HumidityDecimals 0
-#endif
-#if !defined(PressureDecimals) || PressureDecimals < 0
-  #define PressureDecimals 0
-#endif
-#if !defined(TemperatureInterval) || TemperatureInterval < 0
-  #define TemperatureInterval 1
-#endif
-#if !defined(PressureInterval) || PressureInterval < 0
-  #define PressureInterval TemperatureInterval
-#endif
-#if !defined(PublishAlways)
-  #define PublishAlways 0
-#endif
-
-#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;
-  //uint8_t RST_PIN = 16; // Uncoment for Heltec WiFi-Kit-8
-#endif
+  // set the default pins based on the architecture, these get overridden by Usermod menu settings
+  #ifdef ESP8266
+    //uint8_t RST_PIN = 16; // Un-comment for Heltec WiFi-Kit-8
+  #endif
+  bool initDone = false;
 
   // BME280 sensor settings
   BME280I2C::Settings settings{
@@ -75,6 +63,7 @@ private:
   float sensorHeatIndex;
   float sensorDewPoint;
   float sensorPressure;
+  String tempScale;
   // Track previous sensor values
   float lastTemperature;
   float lastHumidity;
@@ -82,43 +71,125 @@ private:
   float lastDewPoint;
   float lastPressure;
 
-  // Store packet IDs of MQTT publications
-  uint16_t mqttTemperaturePub = 0;
-  uint16_t mqttPressurePub = 0;
+  // MQTT topic strings for publishing Home Assistant discovery topics
+  bool mqttInitialized = false;
 
+  // strings to reduce flash memory usage (used more than twice)
+  static const char _name[];
+  static const char _enabled[];
+
+  // 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;
-    #ifdef Celsius
+
+    if (UseCelsius) {
       BME280::TempUnit tempUnit(BME280::TempUnit_Celsius);
       EnvironmentCalculations::TempUnit envTempUnit(EnvironmentCalculations::TempUnit_Celsius);
-    #else
+      BME280::PresUnit presUnit(BME280::PresUnit_hPa);
+
+      bme.read(_pressure, _temperature, _humidity, tempUnit, presUnit);
+
+      sensorTemperature = _temperature;
+      sensorHumidity = _humidity;
+      sensorPressure = _pressure;
+      tempScale = F("°C");
+      if (sensorType == 1)
+      {
+        sensorHeatIndex = EnvironmentCalculations::HeatIndex(_temperature, _humidity, envTempUnit);
+        sensorDewPoint = EnvironmentCalculations::DewPoint(_temperature, _humidity, envTempUnit);
+      }
+    } else {
       BME280::TempUnit tempUnit(BME280::TempUnit_Fahrenheit);
       EnvironmentCalculations::TempUnit envTempUnit(EnvironmentCalculations::TempUnit_Fahrenheit);
-    #endif
-    BME280::PresUnit presUnit(BME280::PresUnit_hPa);
+      BME280::PresUnit presUnit(BME280::PresUnit_hPa);
 
-    bme.read(_pressure, _temperature, _humidity, tempUnit, presUnit);
+      bme.read(_pressure, _temperature, _humidity, tempUnit, presUnit);
 
-    sensorTemperature = _temperature;
-    sensorHumidity = _humidity;
-    sensorPressure = _pressure;
-    if (sensorType == 1)
-    {
-      sensorHeatIndex = EnvironmentCalculations::HeatIndex(_temperature, _humidity, envTempUnit);
-      sensorDewPoint = EnvironmentCalculations::DewPoint(_temperature, _humidity, envTempUnit);
+      sensorTemperature = _temperature;
+      sensorHumidity = _humidity;
+      sensorPressure = _pressure;
+      tempScale = F("°F");
+      if (sensorType == 1)
+      {
+        sensorHeatIndex = EnvironmentCalculations::HeatIndex(_temperature, _humidity, envTempUnit);
+        sensorDewPoint = EnvironmentCalculations::DewPoint(_temperature, _humidity, envTempUnit);
+      }
     }
   }
 
+  // Procedure to define all MQTT discovery Topics 
+  void _mqttInitialize()
+  {
+    char mqttTemperatureTopic[128];
+    char mqttHumidityTopic[128];
+    char mqttPressureTopic[128];
+    char mqttHeatIndexTopic[128];
+    char mqttDewPointTopic[128];
+    snprintf_P(mqttTemperatureTopic, 127, PSTR("%s/temperature"), mqttDeviceTopic);
+    snprintf_P(mqttPressureTopic, 127, PSTR("%s/pressure"), mqttDeviceTopic);
+    snprintf_P(mqttHumidityTopic, 127, PSTR("%s/humidity"), mqttDeviceTopic);
+    snprintf_P(mqttHeatIndexTopic, 127, PSTR("%s/heat_index"), mqttDeviceTopic);
+    snprintf_P(mqttDewPointTopic, 127, PSTR("%s/dew_point"), mqttDeviceTopic);
+
+    if (HomeAssistantDiscovery) {
+      _createMqttSensor(F("Temperature"), mqttTemperatureTopic, "temperature", tempScale);
+      _createMqttSensor(F("Pressure"), mqttPressureTopic, "pressure", F("hPa"));
+      _createMqttSensor(F("Humidity"), mqttHumidityTopic, "humidity", F("%"));
+      _createMqttSensor(F("HeatIndex"), mqttHeatIndexTopic, "temperature", tempScale);
+      _createMqttSensor(F("DewPoint"), mqttDewPointTopic, "temperature", tempScale);
+    }
+  }
+
+  // Create an MQTT Sensor for Home Assistant Discovery purposes, this includes a pointer to the topic that is published to in the Loop.
+  void _createMqttSensor(const String &name, const String &topic, const String &deviceClass, const String &unitOfMeasurement)
+  {
+    String t = String(F("homeassistant/sensor/")) + mqttClientID + F("/") + name + F("/config");
+    
+    StaticJsonDocument<600> doc;
+    
+    doc[F("name")] = String(serverDescription) + " " + name;
+    doc[F("state_topic")] = topic;
+    doc[F("unique_id")] = String(mqttClientID) + name;
+    if (unitOfMeasurement != "")
+      doc[F("unit_of_measurement")] = unitOfMeasurement;
+    if (deviceClass != "")
+      doc[F("device_class")] = deviceClass;
+    doc[F("expire_after")] = 1800;
+
+    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_BRAND);
+    device[F("model")] = F(WLED_PRODUCT_NAME);
+    device[F("sw_version")] = versionString;
+
+    String temp;
+    serializeJson(doc, temp);
+    DEBUG_PRINTLN(t);
+    DEBUG_PRINTLN(temp);
+
+    mqtt->publish(t.c_str(), 0, true, temp.c_str());
+  }
+
+    void publishMqtt(const char *topic, const char* state) {
+      //Check if MQTT Connected, otherwise it will crash the 8266
+      if (WLED_MQTT_CONNECTED){
+        char subuf[128];
+        snprintf_P(subuf, 127, PSTR("%s/%s"), mqttDeviceTopic, topic);
+        mqtt->publish(subuf, 0, false, state);
+      }
+    }
+
 public:
   void setup()
   {
-    Wire.begin(SDA_PIN, SCL_PIN);
-
+    if (i2c_scl<0 || i2c_sda<0) { enabled = false; sensorType = 0; return; }
+    
     if (!bme.begin())
     {
       sensorType = 0;
-      Serial.println("Could not find BME280I2C sensor!");
+      DEBUG_PRINTLN(F("Could not find BME280 I2C sensor!"));
     }
     else
     {
@@ -126,69 +197,68 @@ public:
       {
       case BME280::ChipModel_BME280:
         sensorType = 1;
-        Serial.println("Found BME280 sensor! Success.");
+        DEBUG_PRINTLN(F("Found BME280 sensor! Success."));
         break;
       case BME280::ChipModel_BMP280:
         sensorType = 2;
-        Serial.println("Found BMP280 sensor! No Humidity available.");
+        DEBUG_PRINTLN(F("Found BMP280 sensor! No Humidity available."));
         break;
       default:
         sensorType = 0;
-        Serial.println("Found UNKNOWN sensor! Error!");
+        DEBUG_PRINTLN(F("Found UNKNOWN sensor! Error!"));
       }
     }
+    initDone=true;
   }
 
   void loop()
   {
+    if (!enabled || strip.isUpdating()) return;
+
     // BME280 sensor MQTT publishing
-    // Check if sensor present and MQTT Connected, otherwise it will crash the MCU
-    if (sensorType != 0 && mqtt != nullptr)
+    // Check if sensor present and Connected, otherwise it will crash the MCU
+    if (sensorType != 0)
     {
       // Timer to fetch new temperature, humidity and pressure data at intervals
       timer = millis();
 
-      if (timer - lastTemperatureMeasure >= TemperatureInterval * 1000 || mqttTemperaturePub == 0)
+      if (timer - lastTemperatureMeasure >= TemperatureInterval * 1000)
       {
         lastTemperatureMeasure = timer;
 
         UpdateBME280Data(sensorType);
 
-        float temperature = roundf(sensorTemperature * pow(10, TemperatureDecimals)) / pow(10, TemperatureDecimals);
+        float temperature = roundf(sensorTemperature * powf(10, TemperatureDecimals)) / powf(10, TemperatureDecimals);
         float humidity, heatIndex, dewPoint;
 
         // If temperature has changed since last measure, create string populated with device topic
         // from the UI and values read from sensor, then publish to broker
         if (temperature != lastTemperature || PublishAlways)
         {
-          String topic = String(mqttDeviceTopic) + "/temperature";
-          mqttTemperaturePub = mqtt->publish(topic.c_str(), 0, false, String(temperature, TemperatureDecimals).c_str());
+          publishMqtt("temperature", String(temperature, TemperatureDecimals).c_str());
         }
 
         lastTemperature = temperature; // Update last sensor temperature for next loop
 
         if (sensorType == 1) // Only if sensor is a BME280
         {
-          humidity = roundf(sensorHumidity * pow(10, HumidityDecimals)) / pow(10, HumidityDecimals);
-          heatIndex = roundf(sensorHeatIndex * pow(10, TemperatureDecimals)) / pow(10, TemperatureDecimals);
-          dewPoint = roundf(sensorDewPoint * pow(10, TemperatureDecimals)) / pow(10, TemperatureDecimals);
+          humidity = roundf(sensorHumidity * powf(10, HumidityDecimals)) / powf(10, HumidityDecimals);
+          heatIndex = roundf(sensorHeatIndex * powf(10, TemperatureDecimals)) / powf(10, TemperatureDecimals);
+          dewPoint = roundf(sensorDewPoint * powf(10, TemperatureDecimals)) / powf(10, TemperatureDecimals);
 
           if (humidity != lastHumidity || PublishAlways)
           {
-            String topic = String(mqttDeviceTopic) + "/humidity";
-            mqtt->publish(topic.c_str(), 0, false, String(humidity, HumidityDecimals).c_str());
+            publishMqtt("humidity", String(humidity, HumidityDecimals).c_str());
           }
 
           if (heatIndex != lastHeatIndex || PublishAlways)
           {
-            String topic = String(mqttDeviceTopic) + "/heat_index";
-            mqtt->publish(topic.c_str(), 0, false, String(heatIndex, TemperatureDecimals).c_str());
+            publishMqtt("heat_index", String(heatIndex, TemperatureDecimals).c_str());
           }
 
           if (dewPoint != lastDewPoint || PublishAlways)
           {
-            String topic = String(mqttDeviceTopic) + "/dew_point";
-            mqtt->publish(topic.c_str(), 0, false, String(dewPoint, TemperatureDecimals).c_str());
+            publishMqtt("dew_point", String(dewPoint, TemperatureDecimals).c_str());
           }
 
           lastHumidity = humidity;
@@ -197,20 +267,190 @@ public:
         }
       }
 
-      if (timer - lastPressureMeasure >= PressureInterval * 1000 || mqttPressurePub == 0)
+      if (timer - lastPressureMeasure >= PressureInterval * 1000)
       {
         lastPressureMeasure = timer;
 
-        float pressure = roundf(sensorPressure * pow(10, PressureDecimals)) / pow(10, PressureDecimals);
+        float pressure = roundf(sensorPressure * powf(10, PressureDecimals)) / powf(10, PressureDecimals);
 
         if (pressure != lastPressure || PublishAlways)
         {
-          String topic = String(mqttDeviceTopic) + "/pressure";
-          mqttPressurePub = mqtt->publish(topic.c_str(), 0, true, String(pressure, PressureDecimals).c_str());
+          publishMqtt("pressure", String(pressure, PressureDecimals).c_str());
         }
 
         lastPressure = pressure;
       }
     }
   }
-};
+
+  void onMqttConnect(bool sessionPresent)
+  {
+    if (WLED_MQTT_CONNECTED && !mqttInitialized)
+    {
+      _mqttInitialize();
+      mqttInitialized = true;
+    }
+  }
+
+    /*
+     * API calls te enable data exchange between WLED modules
+     */
+    inline float getTemperatureC() {
+      if (UseCelsius) {
+        return (float)roundf(sensorTemperature * powf(10, TemperatureDecimals)) / powf(10, TemperatureDecimals);
+      } else {
+        return (float)roundf(sensorTemperature * powf(10, TemperatureDecimals)) / powf(10, TemperatureDecimals) * 1.8f + 32;
+      }      
+    }
+
+    inline float getTemperatureF() {
+      if (UseCelsius) {
+        return ((float)roundf(sensorTemperature * powf(10, TemperatureDecimals)) / powf(10, TemperatureDecimals) -32) * 0.56f;
+      } else {
+        return (float)roundf(sensorTemperature * powf(10, TemperatureDecimals)) / powf(10, TemperatureDecimals);
+      }
+    }
+
+    inline float getHumidity() {
+      return (float)roundf(sensorHumidity * powf(10, HumidityDecimals));
+    }
+
+    inline float getPressure() {
+      return (float)roundf(sensorPressure * powf(10, PressureDecimals));
+    }
+
+    inline float getDewPointC() {
+      if (UseCelsius) {
+        return (float)roundf(sensorDewPoint * powf(10, TemperatureDecimals)) / powf(10, TemperatureDecimals);
+      } else {
+        return (float)roundf(sensorDewPoint * powf(10, TemperatureDecimals)) / powf(10, TemperatureDecimals) * 1.8f + 32;
+      }
+    }
+
+    inline float getDewPointF() {
+      if (UseCelsius) {
+        return ((float)roundf(sensorDewPoint * powf(10, TemperatureDecimals)) / powf(10, TemperatureDecimals) -32) * 0.56f;
+      } else {
+        return (float)roundf(sensorDewPoint * powf(10, TemperatureDecimals)) / powf(10, TemperatureDecimals);
+      }
+    }
+
+    inline float getHeatIndexC() {
+      if (UseCelsius) {
+        return (float)roundf(sensorHeatIndex * powf(10, TemperatureDecimals)) / powf(10, TemperatureDecimals);
+      } else {
+        return (float)roundf(sensorHeatIndex * powf(10, TemperatureDecimals)) / powf(10, TemperatureDecimals) * 1.8f + 32;
+      }
+    }
+
+    inline float getHeatIndexF() {
+      if (UseCelsius) {
+        return ((float)roundf(sensorHeatIndex * powf(10, TemperatureDecimals)) / powf(10, TemperatureDecimals) -32) * 0.56f;
+      } else {
+        return (float)roundf(sensorHeatIndex * powf(10, TemperatureDecimals)) / powf(10, TemperatureDecimals);
+      }
+    }
+
+  // Publish Sensor Information to Info Page
+  void addToJsonInfo(JsonObject &root)
+  {
+    JsonObject user = root[F("u")];
+    if (user.isNull()) user = root.createNestedObject(F("u"));
+    
+    if (sensorType==0) //No Sensor
+    {
+      // if we sensor not detected, let the user know
+      JsonArray temperature_json = user.createNestedArray(F("BME/BMP280 Sensor"));
+      temperature_json.add(F("Not Found"));
+    }
+    else if (sensorType==2) //BMP280
+    {
+      
+      JsonArray temperature_json = user.createNestedArray(F("Temperature"));
+      JsonArray pressure_json = user.createNestedArray(F("Pressure"));
+      temperature_json.add(roundf(sensorTemperature * powf(10, TemperatureDecimals)));
+      temperature_json.add(tempScale);
+      pressure_json.add(roundf(sensorPressure * powf(10, PressureDecimals)));
+      pressure_json.add(F("hPa"));
+    }
+    else if (sensorType==1) //BME280
+    {
+      JsonArray temperature_json = user.createNestedArray(F("Temperature"));
+      JsonArray humidity_json = user.createNestedArray(F("Humidity"));
+      JsonArray pressure_json = user.createNestedArray(F("Pressure"));
+      JsonArray heatindex_json = user.createNestedArray(F("Heat Index"));
+      JsonArray dewpoint_json = user.createNestedArray(F("Dew Point"));
+      temperature_json.add(roundf(sensorTemperature * powf(10, TemperatureDecimals)) / powf(10, TemperatureDecimals));
+      temperature_json.add(tempScale);
+      humidity_json.add(roundf(sensorHumidity * powf(10, HumidityDecimals)));
+      humidity_json.add(F("%"));
+      pressure_json.add(roundf(sensorPressure * powf(10, PressureDecimals)));
+      pressure_json.add(F("hPa"));
+      heatindex_json.add(roundf(sensorHeatIndex * powf(10, TemperatureDecimals)) / powf(10, TemperatureDecimals));
+      heatindex_json.add(tempScale);
+      dewpoint_json.add(roundf(sensorDewPoint * powf(10, TemperatureDecimals)) / powf(10, TemperatureDecimals));
+      dewpoint_json.add(tempScale);
+    }
+      return;
+  }
+
+  // Save Usermod Config Settings
+  void addToConfig(JsonObject& root)
+  {
+    JsonObject top = root.createNestedObject(FPSTR(_name));
+    top[FPSTR(_enabled)] = enabled;
+    top[F("TemperatureDecimals")] = TemperatureDecimals;
+    top[F("HumidityDecimals")] = HumidityDecimals;
+    top[F("PressureDecimals")] = PressureDecimals;
+    top[F("TemperatureInterval")] = TemperatureInterval;
+    top[F("PressureInterval")] = PressureInterval;
+    top[F("PublishAlways")] = PublishAlways;
+    top[F("UseCelsius")] = UseCelsius;
+    top[F("HomeAssistantDiscovery")] = HomeAssistantDiscovery;
+    DEBUG_PRINTLN(F("BME280 config saved."));
+  }
+
+  // Read Usermod Config Settings
+  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)];
+    if (top.isNull()) {
+      DEBUG_PRINT(F(_name));
+      DEBUG_PRINTLN(F(": No config found. (Using defaults.)"));
+      return false;
+    }
+    bool configComplete = !top.isNull();
+
+    configComplete &= getJsonValue(top[FPSTR(_enabled)], enabled);
+    // A 3-argument getJsonValue() assigns the 3rd argument as a default value if the Json value is missing
+    configComplete &= getJsonValue(top[F("TemperatureDecimals")], TemperatureDecimals, 1);
+    configComplete &= getJsonValue(top[F("HumidityDecimals")], HumidityDecimals, 0);
+    configComplete &= getJsonValue(top[F("PressureDecimals")], PressureDecimals, 0);
+    configComplete &= getJsonValue(top[F("TemperatureInterval")], TemperatureInterval, 30);
+    configComplete &= getJsonValue(top[F("PressureInterval")], PressureInterval, 30);
+    configComplete &= getJsonValue(top[F("PublishAlways")], PublishAlways, false);
+    configComplete &= getJsonValue(top[F("UseCelsius")], UseCelsius, true);
+    configComplete &= getJsonValue(top[F("HomeAssistantDiscovery")], HomeAssistantDiscovery, false);
+
+    DEBUG_PRINT(FPSTR(_name));
+    if (!initDone) {
+      // first run: reading from cfg.json
+      DEBUG_PRINTLN(F(" config loaded."));
+    } else {
+      DEBUG_PRINTLN(F(" config (re)loaded."));
+      // changing parameters from settings page
+    }
+
+    return configComplete;
+  }
+
+  uint16_t getId() {
+    return USERMOD_ID_BME280;
+  }
+};
+
+const char UsermodBME280::_name[]                      PROGMEM = "BME280/BMP280";
+const char UsermodBME280::_enabled[]                   PROGMEM = "enabled";

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/readme.md

@@ -0,0 +1,8 @@
+# Cronixie clock usermod
+
+This usermod supports driving the Cronixie M and L clock kits by Diamex.
+
+## Installation 
+
+Compile and upload after adding `-D USERMOD_CRONIXIE` to `build_flags` of your PlatformIO environment.  
+Make sure the Auto Brightness Limiter is enabled at 420mA (!) and configure 60 WS281x LEDs.

usermods/Cronixie/usermod_cronixie.h

@@ -0,0 +1,302 @@
+#pragma once
+
+#include "wled.h"
+
+class UsermodCronixie : public Usermod {
+  private:
+    unsigned long lastTime = 0;
+    char cronixieDisplay[7] = "HHMMSS";
+    byte _digitOut[6] = {10,10,10,10,10,10};
+    byte dP[6] = {255, 255, 255, 255, 255, 255};
+
+    // set your config variables to their boot default value (this can also be done in readFromConfig() or a constructor if you prefer)
+    bool backlight = true;
+
+  public:
+    void initCronixie()
+    {
+      if (dP[0] == 255) // if dP[0] is 255, cronixie is not yet init'ed
+      {
+        setCronixie();
+        strip.getSegment(0).grouping = 10; // 10 LEDs per digit
+      }
+    }
+
+    void setup() {
+
+    }
+
+    void loop() {
+      if (!toki.isTick()) return;
+      initCronixie();
+      _overlayCronixie();
+      strip.trigger();
+    }
+
+    byte getSameCodeLength(char code, int index, char const cronixieDisplay[])
+    {
+      byte counter = 0;
+      
+      for (int i = index+1; i < 6; i++)
+      {
+        if (cronixieDisplay[i] == code)
+        {
+          counter++;
+        } else {
+          return counter;
+        }
+      }
+      return counter;
+    }
+
+    void setCronixie()
+    {
+      /*
+      * digit purpose index
+      * 0-9 | 0-9 (incl. random)
+      * 10 | blank
+      * 11 | blank, bg off
+      * 12 | test upw.
+      * 13 | test dnw.
+      * 14 | binary AM/PM
+      * 15 | BB upper +50 for no trailing 0
+      * 16 | BBB
+      * 17 | BBBB
+      * 18 | BBBBB
+      * 19 | BBBBBB
+      * 20 | H
+      * 21 | HH
+      * 22 | HHH
+      * 23 | HHHH
+      * 24 | M
+      * 25 | MM
+      * 26 | MMM
+      * 27 | MMMM
+      * 28 | MMMMM
+      * 29 | MMMMMM
+      * 30 | S
+      * 31 | SS
+      * 32 | SSS
+      * 33 | SSSS
+      * 34 | SSSSS
+      * 35 | SSSSSS
+      * 36 | Y
+      * 37 | YY
+      * 38 | YYYY
+      * 39 | I
+      * 40 | II
+      * 41 | W
+      * 42 | WW
+      * 43 | D
+      * 44 | DD
+      * 45 | DDD
+      * 46 | V
+      * 47 | VV
+      * 48 | VVV
+      * 49 | VVVV
+      * 50 | VVVVV
+      * 51 | VVVVVV
+      * 52 | v
+      * 53 | vv
+      * 54 | vvv
+      * 55 | vvvv
+      * 56 | vvvvv
+      * 57 | vvvvvv
+      */
+
+      //H HourLower | HH - Hour 24. | AH - Hour 12. | HHH Hour of Month | HHHH Hour of Year
+      //M MinuteUpper | MM Minute of Hour | MMM Minute of 12h | MMMM Minute of Day | MMMMM Minute of Month | MMMMMM Minute of Year
+      //S SecondUpper | SS Second of Minute | SSS Second of 10 Minute | SSSS Second of Hour | SSSSS Second of Day | SSSSSS Second of Week
+      //B AM/PM | BB 0-6/6-12/12-18/18-24 | BBB 0-3... | BBBB 0-1.5... | BBBBB 0-1 | BBBBBB 0-0.5
+      
+      //Y YearLower | YY - Year LU | YYYY - Std.
+      //I MonthLower | II - Month of Year 
+      //W Week of Month | WW Week of Year
+      //D Day of Week | DD Day Of Month | DDD Day Of Year
+
+      DEBUG_PRINT(F("cset "));
+      DEBUG_PRINTLN(cronixieDisplay);
+      
+      for (int i = 0; i < 6; i++)
+      {
+        dP[i] = 10;
+        switch (cronixieDisplay[i])
+        {
+          case '_': dP[i] = 10; break; 
+          case '-': dP[i] = 11; break; 
+          case 'r': dP[i] = random(1,7); break; //random btw. 1-6
+          case 'R': dP[i] = random(0,10); break; //random btw. 0-9
+          //case 't': break; //Test upw.
+          //case 'T': break; //Test dnw.
+          case 'b': dP[i] = 14 + getSameCodeLength('b',i,cronixieDisplay); i = i+dP[i]-14; break; 
+          case 'B': dP[i] = 14 + getSameCodeLength('B',i,cronixieDisplay); i = i+dP[i]-14; break;
+          case 'h': dP[i] = 70 + getSameCodeLength('h',i,cronixieDisplay); i = i+dP[i]-70; break;
+          case 'H': dP[i] = 20 + getSameCodeLength('H',i,cronixieDisplay); i = i+dP[i]-20; break;
+          case 'A': dP[i] = 108; i++; break;
+          case 'a': dP[i] = 58; i++; break;
+          case 'm': dP[i] = 74 + getSameCodeLength('m',i,cronixieDisplay); i = i+dP[i]-74; break;
+          case 'M': dP[i] = 24 + getSameCodeLength('M',i,cronixieDisplay); i = i+dP[i]-24; break;
+          case 's': dP[i] = 80 + getSameCodeLength('s',i,cronixieDisplay); i = i+dP[i]-80; break; //refresh more often bc. of secs
+          case 'S': dP[i] = 30 + getSameCodeLength('S',i,cronixieDisplay); i = i+dP[i]-30; break;
+          case 'Y': dP[i] = 36 + getSameCodeLength('Y',i,cronixieDisplay); i = i+dP[i]-36; break; 
+          case 'y': dP[i] = 86 + getSameCodeLength('y',i,cronixieDisplay); i = i+dP[i]-86; break; 
+          case 'I': dP[i] = 39 + getSameCodeLength('I',i,cronixieDisplay); i = i+dP[i]-39; break;  //Month. Don't ask me why month and minute both start with M.
+          case 'i': dP[i] = 89 + getSameCodeLength('i',i,cronixieDisplay); i = i+dP[i]-89; break; 
+          //case 'W': break;
+          //case 'w': break;
+          case 'D': dP[i] = 43 + getSameCodeLength('D',i,cronixieDisplay); i = i+dP[i]-43; break;
+          case 'd': dP[i] = 93 + getSameCodeLength('d',i,cronixieDisplay); i = i+dP[i]-93; break;
+          case '0': dP[i] = 0; break;
+          case '1': dP[i] = 1; break;
+          case '2': dP[i] = 2; break;
+          case '3': dP[i] = 3; break;
+          case '4': dP[i] = 4; break;
+          case '5': dP[i] = 5; break;
+          case '6': dP[i] = 6; break;
+          case '7': dP[i] = 7; break;
+          case '8': dP[i] = 8; break;
+          case '9': dP[i] = 9; break;
+          //case 'V': break; //user var0
+          //case 'v': break; //user var1
+        }
+      }
+      DEBUG_PRINT(F("result "));
+      for (int i = 0; i < 5; i++)
+      {
+        DEBUG_PRINT((int)dP[i]);
+        DEBUG_PRINT(" ");
+      }
+      DEBUG_PRINTLN((int)dP[5]);
+
+      _overlayCronixie(); // refresh
+    }
+
+    void _overlayCronixie()
+    {
+      byte h = hour(localTime);
+      byte h0 = h;
+      byte m = minute(localTime);
+      byte s = second(localTime);
+      byte d = day(localTime);
+      byte mi = month(localTime);
+      int y = year(localTime);
+      //this has to be changed in time for 22nd century
+      y -= 2000; if (y<0) y += 30; //makes countdown work
+
+      if (useAMPM && !countdownMode)
+      {
+        if (h>12) h-=12;
+        else if (h==0) h+=12;
+      }
+      for (int i = 0; i < 6; i++)
+      {
+        if (dP[i] < 12) _digitOut[i] = dP[i];
+        else {
+          if (dP[i] < 65)
+          {
+            switch(dP[i])
+            {
+              case 21: _digitOut[i] = h/10; _digitOut[i+1] = h- _digitOut[i]*10; i++; break; //HH
+              case 25: _digitOut[i] = m/10; _digitOut[i+1] = m- _digitOut[i]*10; i++; break; //MM
+              case 31: _digitOut[i] = s/10; _digitOut[i+1] = s- _digitOut[i]*10; i++; break; //SS
+
+              case 20: _digitOut[i] = h- (h/10)*10; break; //H
+              case 24: _digitOut[i] = m/10; break; //M
+              case 30: _digitOut[i] = s/10; break; //S
+              
+              case 43: _digitOut[i] = weekday(localTime); _digitOut[i]--; if (_digitOut[i]<1) _digitOut[i]= 7; break; //D
+              case 44: _digitOut[i] = d/10; _digitOut[i+1] = d- _digitOut[i]*10; i++; break; //DD
+              case 40: _digitOut[i] = mi/10; _digitOut[i+1] = mi- _digitOut[i]*10; i++; break; //II
+              case 37: _digitOut[i] = y/10; _digitOut[i+1] = y- _digitOut[i]*10; i++; break; //YY
+              case 39: _digitOut[i] = 2; _digitOut[i+1] = 0; _digitOut[i+2] = y/10; _digitOut[i+3] = y- _digitOut[i+2]*10; i+=3; break; //YYYY
+              
+              //case 16: _digitOut[i+2] = ((h0/3)&1)?1:0; i++; //BBB (BBBB NI)
+              //case 15: _digitOut[i+1] = (h0>17 || (h0>5 && h0<12))?1:0; i++; //BB
+              case 14: _digitOut[i] = (h0>11)?1:0; break; //B
+            }
+          } else
+          {
+            switch(dP[i])
+            {
+              case 71: _digitOut[i] = h/10; _digitOut[i+1] = h- _digitOut[i]*10; if(_digitOut[i] == 0) _digitOut[i]=10; i++; break; //hh
+              case 75: _digitOut[i] = m/10; _digitOut[i+1] = m- _digitOut[i]*10; if(_digitOut[i] == 0) _digitOut[i]=10; i++; break; //mm
+              case 81: _digitOut[i] = s/10; _digitOut[i+1] = s- _digitOut[i]*10; if(_digitOut[i] == 0) _digitOut[i]=10; i++; break; //ss
+              //case 66: _digitOut[i+2] = ((h0/3)&1)?1:10; i++; //bbb (bbbb NI)
+              //case 65: _digitOut[i+1] = (h0>17 || (h0>5 && h0<12))?1:10; i++; //bb
+              case 64: _digitOut[i] = (h0>11)?1:10; break; //b
+
+              case 93: _digitOut[i] = weekday(localTime); _digitOut[i]--; if (_digitOut[i]<1) _digitOut[i]= 7; break; //d
+              case 94: _digitOut[i] = d/10; _digitOut[i+1] = d- _digitOut[i]*10; if(_digitOut[i] == 0) _digitOut[i]=10; i++; break; //dd
+              case 90: _digitOut[i] = mi/10; _digitOut[i+1] = mi- _digitOut[i]*10; if(_digitOut[i] == 0) _digitOut[i]=10; i++; break; //ii
+              case 87: _digitOut[i] = y/10; _digitOut[i+1] = y- _digitOut[i]*10; i++; break; //yy
+              case 89: _digitOut[i] = 2; _digitOut[i+1] = 0; _digitOut[i+2] = y/10; _digitOut[i+3] = y- _digitOut[i+2]*10; i+=3; break; //yyyy
+            }
+          }
+        }
+      }
+    }
+
+    void handleOverlayDraw()
+    {
+      byte offsets[] = {5, 0, 6, 1, 7, 2, 8, 3, 9, 4};
+      
+      for (uint16_t i = 0; i < 6; i++)
+      {
+        byte o = 10*i;
+        byte excl = 10;
+        if(_digitOut[i] < 10) excl = offsets[_digitOut[i]];
+        excl += o;
+        
+        if (backlight && _digitOut[i] <11)
+        {
+          uint32_t col = gamma32(strip.getSegment(0).colors[1]);
+          for (uint16_t j=o; j< o+10; j++) {
+            if (j != excl) strip.setPixelColor(j, col);
+          }
+        } else
+        {
+          for (uint16_t j=o; j< o+10; j++) {
+            if (j != excl) strip.setPixelColor(j, 0);
+          }
+        }
+      }
+    }
+
+    void addToJsonState(JsonObject& root)
+    {
+      root["nx"] = cronixieDisplay;
+    }
+
+    void readFromJsonState(JsonObject& root)
+    {
+      if (root["nx"].is<const char*>()) {
+        strncpy(cronixieDisplay, root["nx"], 6);
+        setCronixie();
+      }
+    }
+
+    void addToConfig(JsonObject& root)
+    {
+      JsonObject top = root.createNestedObject(F("Cronixie"));
+      top["backlight"] = backlight;
+    }
+
+    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[F("Cronixie")];
+
+      bool configComplete = !top.isNull();
+
+      configComplete &= getJsonValue(top["backlight"], backlight);
+
+      return configComplete;
+    }
+
+    uint16_t getId()
+    {
+      return USERMOD_ID_CRONIXIE;
+    }
+};

usermods/DHT/platformio_override.ini

@@ -6,12 +6,13 @@
 ; USERMOD_DHT_CELSIUS              - define this to report temperatures in degrees celsious, otherwise fahrenheit will be reported
 ; USERMOD_DHT_MEASUREMENT_INTERVAL - the number of milliseconds between measurements, defaults to 60 seconds
 ; USERMOD_DHT_FIRST_MEASUREMENT_AT - the number of milliseconds after boot to take first measurement, defaults to 90 seconds
+; USERMOD_DHT_MQTT                 - publish measurements to the MQTT broker
 ; USERMOD_DHT_STATS                - For debug, report delay stats
 
 [env:d1_mini_usermod_dht_C]
 extends = env:d1_mini
 build_flags = ${env:d1_mini.build_flags} -D USERMOD_DHT -D USERMOD_DHT_CELSIUS
-lib_deps = ${env.lib_deps}
+lib_deps = ${env:d1_mini.lib_deps}
     https://github.com/alwynallan/DHT_nonblocking
 
 [env:custom32_LEDPIN_16_usermod_dht_C]

usermods/DHT/readme.md

@@ -1,9 +1,13 @@
 # DHT Temperature/Humidity sensor usermod
 
 This usermod will read from an attached DHT22 or DHT11 humidity and temperature sensor.
-The sensor readings are displayed in the Info section of the web UI.
+The sensor readings are displayed in the Info section of the web UI (and optionally sent to an MQTT broker).
 
-If sensor is not detected after a while (10 update intervals), this usermod will be disabled.
+If sensor is not detected after 10 update intervals, the usermod will be disabled.
+
+If enabled, measured temperature and humidity will be published to the following MQTT topics
+* `{devceTopic}/dht/temperature`
+* `{devceTopic}/dht/humidity`
 
 ## Installation
 
@@ -11,12 +15,13 @@ Copy the example `platformio_override.ini` to the root directory.  This file sho
 
 ### Define Your Options
 
-* `USERMOD_DHT`                      - define this to have this user mod included wled00\usermods_list.cpp
+* `USERMOD_DHT`                      - define this to include this user mod wled00\usermods_list.cpp
 * `USERMOD_DHT_DHTTYPE`              - DHT model: 11, 21, 22 for DHT11, DHT21, or DHT22, defaults to 22/DHT22
 * `USERMOD_DHT_PIN`                  - pin to which DTH is connected, defaults to Q2 pin on QuinLed Dig-Uno's board
-* `USERMOD_DHT_CELSIUS`              - define this to report temperatures in degrees celsious, otherwise fahrenheit will be reported
-* `USERMOD_DHT_MEASUREMENT_INTERVAL` - the number of milliseconds between measurements, defaults to 60 seconds
-* `USERMOD_DHT_FIRST_MEASUREMENT_AT` - the number of milliseconds after boot to take first measurement, defaults to 90 seconds
+* `USERMOD_DHT_CELSIUS`              - define this to report temperatures in degrees Celsius, otherwise Fahrenheit will be reported
+* `USERMOD_DHT_MEASUREMENT_INTERVAL` - the number of milliseconds between measurements, defaults to 60000 ms
+* `USERMOD_DHT_FIRST_MEASUREMENT_AT` - the number of milliseconds after boot to take first measurement, defaults to 90000 ms
+* `USERMOD_DHT_MQTT`                 - publish measurements to an MQTT broker
 * `USERMOD_DHT_STATS`                - For debug, report delay stats
 
 ## Project link
@@ -29,13 +34,15 @@ If you are using `platformio_override.ini`, you should be able to refresh the ta
 
 
 ## Change Log
-
+2022-10-15
+* Add ability to publish sensor readings to an MQTT broker
+* fix compilation error for sample [env:d1_mini_usermod_dht_C] task
 2020-02-04
 * Change default QuinLed pin to Q2
-* Instead of trying to keep updates at constant cadence, space readings out by measurement interval; hope this helps to avoid occasional bursts of readings with errors
+* Instead of trying to keep updates at constant cadence, space out readings by measurement interval. Hopefully, this helps eliminate occasional bursts of readings with errors
 * Add some more (optional) stats
 2020-02-03
 * Due to poor readouts on ESP32 with previous DHT library, rewrote to use https://github.com/alwynallan/DHT_nonblocking
-* The new library serializes/delays up to 5ms for the sensor readout  
-2020-02-02 
+* The new library serializes/delays up to 5ms for the sensor readout
+2020-02-02
 * Created

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
@@ -62,6 +66,10 @@ class UsermodDHT : public Usermod {
     float humidity, temperature = 0;
     bool initializing = true;
     bool disabled = false;
+    #ifdef USERMOD_DHT_MQTT
+    char dhtMqttTopic[64];
+    size_t dhtMqttTopicLen;
+    #endif
     #ifdef USERMOD_DHT_STATS
     unsigned long nextResetStatsTime = 0;
     uint16_t updates = 0;
@@ -76,6 +84,10 @@ class UsermodDHT : public Usermod {
     void setup() {
       nextReadTime = millis() + USERMOD_DHT_FIRST_MEASUREMENT_AT;
       lastReadTime = millis();
+      #ifdef USERMOD_DHT_MQTT
+      sprintf(dhtMqttTopic, "%s/dht", mqttDeviceTopic);
+      dhtMqttTopicLen = strlen(dhtMqttTopic);
+      #endif
       #ifdef USERMOD_DHT_STATS
       nextResetStatsTime = millis() + 60*60*1000;
       #endif
@@ -110,10 +122,29 @@ class UsermodDHT : public Usermod {
         temperature = tempC * 9 / 5 + 32;
         #endif
 
+        #ifdef USERMOD_DHT_MQTT
+        // 10^n where n is number of decimal places to display in mqtt message. Please adjust buff size together with this constant
+        #define FLOAT_PREC 100
+        if (WLED_MQTT_CONNECTED) {
+          char buff[10];
+
+          strcpy(dhtMqttTopic + dhtMqttTopicLen, "/temperature");
+          sprintf(buff, "%d.%d", (int)temperature, ((int)(temperature * FLOAT_PREC)) % FLOAT_PREC);
+          mqtt->publish(dhtMqttTopic, 0, false, buff);
+
+          sprintf(buff, "%d.%d", (int)humidity, ((int)(humidity * FLOAT_PREC)) % FLOAT_PREC);
+          strcpy(dhtMqttTopic + dhtMqttTopicLen, "/humidity");
+          mqtt->publish(dhtMqttTopic, 0, false, buff);
+
+          dhtMqttTopic[dhtMqttTopicLen] = '\0';
+        }
+        #undef FLOAT_PREC
+        #endif
+
         nextReadTime = millis() + USERMOD_DHT_MEASUREMENT_INTERVAL;
         lastReadTime = millis();
         initializing = false;
-        
+
         #ifdef USERMOD_DHT_STATS
         unsigned long icalc = millis() - currentIteration;
         if (icalc > maxIteration) {
@@ -134,7 +165,7 @@ class UsermodDHT : public Usermod {
       dcalc = millis() - dcalc;
       if (dcalc > maxDelay) {
         maxDelay = dcalc;
-      } 
+      }
       #endif
 
       if (((millis() - lastReadTime) > 10*USERMOD_DHT_MEASUREMENT_INTERVAL)) {
@@ -207,7 +238,7 @@ class UsermodDHT : public Usermod {
       temp.add("°F");
       #endif
     }
-   
+
     uint16_t getId()
     {
       return USERMOD_ID_DHT;

usermods/ESP32_TouchBrightnessControl/readme.md

@@ -1,19 +0,0 @@
-# ESP32 Touch Brightness Control
-
-Toggle On/Off with a long press (800ms)
-Switch through 5 brightness levels (defined in usermod_touchbrightness.h, values 0-255) with a short (100ms) touch
-
-## Installation 
-
-Copy 'usermod_touchbrightness.h' to the wled00 directory.  
-in 'usermod_list.cpp' add this:
-
-> #include "usermod_touchbrightness.h"
-above "void registerUsermods()"
-
-and
-
-> usermods.add(new TouchBrightnessControl());
-inside the "registerUsermods()" function
-
-

usermods/ESP32_TouchBrightnessControl/usermod_touchbrightness.h

@@ -1,89 +0,0 @@
-//
-//  usermod_touchbrightness.h
-//  github.com/aircoookie/WLED
-//
-//  Created by Justin Kühner on 14.09.2020.
-//  Copyright © 2020 NeariX. All rights reserved.
-//  https://github.com/NeariX67/
-//  Discord: @NeariX#4799
-
-
-#pragma once
-
-#include "wled.h"
-
-#define threshold 40                    //Increase value if touches falsely accur. Decrease value if actual touches are not recognized
-#define touchPin T0                     //T0 = D4 / GPIO4
-
-//Define the 5 brightness levels
-//Long press to turn off / on
-#define brightness1 51
-#define brightness2 102
-#define brightness3 153
-#define brightness4 204
-#define brightness5 255
-
-
-#ifdef ESP32
-
-
-class TouchBrightnessControl : public Usermod {
-  private:
-    unsigned long lastTime = 0;         //Interval
-    unsigned long lastTouch = 0;        //Timestamp of last Touch
-    unsigned long lastRelease = 0;      //Timestamp of last Touch release
-    boolean released = true;            //current Touch state (touched/released)
-    uint16_t touchReading = 0;          //sensor reading, maybe use uint8_t???
-    uint16_t touchDuration = 0;         //duration of last touch
-  public:
-  
-    void setup() {
-      lastTouch = millis();
-      lastRelease = millis();
-      lastTime = millis();
-    }
-
-    void loop() {
-      if (millis() - lastTime >= 50) {                           //Check every 50ms if a touch occurs
-        lastTime = millis();
-        touchReading = touchRead(touchPin);                      //Read touch sensor on pin T0 (GPIO4 / D4)
-        
-        if(touchReading < threshold && released) {               //Touch started
-          released = false;
-          lastTouch = millis();
-        }
-        else if(touchReading >= threshold && !released) {        //Touch released
-          released = true;
-          lastRelease = millis();
-          touchDuration = lastRelease - lastTouch;               //Calculate duration
-        }
-        
-        //Serial.println(touchDuration);
-
-        if(touchDuration >= 800 && released) {                   //Toggle power if button press is longer than 800ms
-          touchDuration = 0;                                     //Reset touch duration to avoid multiple actions on same touch
-          toggleOnOff();
-          colorUpdated(2);                                       //Refresh values
-        }
-        else if(touchDuration >= 100 && released) {              //Switch to next brightness if touch is between 100 and 800ms
-          touchDuration = 0;                                     //Reset touch duration to avoid multiple actions on same touch
-          if(bri < brightness1) {
-            bri = brightness1;
-          } else if(bri >= brightness1 && bri < brightness2) {
-            bri = brightness2;
-          } else if(bri >= brightness2 && bri < brightness3) {
-            bri = brightness3;
-          } else if(bri >= brightness3 && bri < brightness4) {
-            bri = brightness4;
-          } else if(bri >= brightness4 && bri < brightness5) {
-            bri = brightness5;
-          } else if(bri >= brightness5) {
-            bri = brightness1;
-          }
-          colorUpdated(2);                                       //Refresh values
-        }
-        
-      }
-    }
-};
-#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,22 +271,136 @@ 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);
 
       return configComplete;
     }
 
-   
+
+    /*
+     * 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() 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

@@ -12,6 +12,7 @@ class TFTs : public TFT_eSPI {
 private:
   uint8_t digits[NUM_DIGITS];
 
+
   // These read 16- and 32-bit types from the SD card file.
   // BMP data is stored little-endian, Arduino is little-endian too.
   // May need to reverse subscript order if porting elsewhere.
@@ -33,7 +34,16 @@ private:
   }
 
   uint16_t output_buffer[TFT_HEIGHT][TFT_WIDTH];
-  
+  int16_t w = 135, h = 240, x = 0, y = 0, bufferedDigit = 255;
+  uint16_t digitR, digitG, digitB, dimming = 255;
+  uint32_t digitColor = 0;
+
+  void drawBuffer() {
+    bool oldSwapBytes = getSwapBytes();
+    setSwapBytes(true);
+    pushImage(x, y, w, h, (uint16_t *)output_buffer);
+    setSwapBytes(oldSwapBytes);
+  }
 
   // These BMP functions are stolen directly from the TFT_SPIFFS_BMP example in the TFT_eSPI library.
   // Unfortunately, they aren't part of the library itself, so I had to copy them.
@@ -41,44 +51,69 @@ private:
 
   //// BEGIN STOLEN CODE
 
-  // Draw directly from file stored in RGB565 format
+  // Draw directly from file stored in RGB565 format. Fastest
   bool drawBin(const char *filename) {
     fs::File bmpFS;
 
-
     // Open requested file on SD card
     bmpFS = WLED_FS.open(filename, "r");
 
-    if (!bmpFS)
-    {
-      Serial.print(F("File not found: "));
-      Serial.println(filename);
-      return(false);
-    }
-
     size_t sz = bmpFS.size();
-    if (sz <= 64800)
-    {
-      bool oldSwapBytes = getSwapBytes();
-      setSwapBytes(true);
-
-      int16_t h = sz / (135 * 2);
-
-      //draw img that is shorter than 240pix into the center
-      int16_t y = (height() - h) /2;
-
-      bmpFS.read((uint8_t *) output_buffer,sz);
-
-      if (!realtimeMode || realtimeOverride) strip.service();
-
-      pushImage(0, y, 135, h, (uint16_t *)output_buffer);
-
-      setSwapBytes(oldSwapBytes);
+    if (sz > 64800) {
+      bmpFS.close();
+      return false;
     }
 
+    uint16_t r, g, b, dimming = 255;
+    int16_t row, col;
+
+    //draw img that is shorter than 240pix into the center
+    w = 135;
+    h = sz / (w * 2);
+    x = 0;
+    y = (height() - h) /2;
+    
+    uint8_t lineBuffer[w * 2];
+
+    if (!realtimeMode || realtimeOverride || (realtimeMode && useMainSegmentOnly)) strip.service();
+
+    // 0,0 coordinates are top left
+    for (row = 0; row < h; row++) {
+
+      bmpFS.read(lineBuffer, sizeof(lineBuffer));
+      uint8_t PixM, PixL;
+      
+      // Colors are already in 16-bit R5, G6, B5 format
+      for (col = 0; col < w; col++)
+      {
+        if (dimming == 255 && !digitColor) { // not needed, copy directly
+          output_buffer[row][col] = (lineBuffer[col*2+1] << 8) | (lineBuffer[col*2]);
+        } else {
+          // 16 BPP pixel format: R5, G6, B5 ; bin: RRRR RGGG GGGB BBBB
+          PixM = lineBuffer[col*2+1];
+          PixL = lineBuffer[col*2];
+          // align to 8-bit value (MSB left aligned)
+          r = (PixM) & 0xF8;
+          g = ((PixM << 5) | (PixL >> 3)) & 0xFC;
+          b = (PixL << 3) & 0xF8;
+          r *= dimming; g *= dimming; b *= dimming;
+          r  = r  >> 8; g  = g  >> 8; b  = b  >> 8;
+          if (digitColor) { // grayscale pixel coloring
+            uint8_t l = (r > g) ? ((r > b) ? r:b) : ((g > b) ? g:b);
+            r = g = b = l;
+            r *= digitR; g *= digitG; b *= digitB;
+            r  = r >> 8; g  = g >> 8; b  = b >> 8;
+          }
+          output_buffer[row][col] = ((r & 0xF8) << 8) | ((g & 0xFC) << 3) | (b >> 3);
+        }
+      }
+    }
+
+    drawBuffer();
+
     bmpFS.close();
 
-    return(true);
+    return true;
   }
 
   bool drawBmp(const char *filename) {
@@ -87,78 +122,175 @@ private:
     // Open requested file on SD card
     bmpFS = WLED_FS.open(filename, "r");
 
-    if (!bmpFS)
-    {
-      Serial.print(F("File not found: "));
-      Serial.println(filename);
-      return(false);
-    }
-
-    uint32_t seekOffset;
-    int16_t w, h, row;
-    uint8_t  r, g, b;
+    uint32_t seekOffset, headerSize, paletteSize = 0;
+    int16_t row;
+    uint16_t r, g, b, dimming = 255, bitDepth;
 
     uint16_t magic = read16(bmpFS);
-    if (magic == 0xFFFF) {
+    if (magic != ('B' | ('M' << 8))) { // File not found or not a BMP
       Serial.println(F("BMP not found!"));
       bmpFS.close();
-      return(false);
-    }
-    
-    if (magic != 0x4D42) {
-      Serial.print(F("File not a BMP. Magic: "));
-      Serial.println(magic);
-      bmpFS.close();
-      return(false);
+      return false;
     }
 
-    read32(bmpFS);
-    read32(bmpFS);
-    seekOffset = read32(bmpFS);
-    read32(bmpFS);
-    w = read32(bmpFS);
-    h = read32(bmpFS);
+    (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
+    (void) read16(bmpFS); // color planes (must be 1)
+    bitDepth = read16(bmpFS);
 
-    if ((read16(bmpFS) != 1) || (read16(bmpFS) != 24) || (read32(bmpFS) != 0)) {
+    if (read32(bmpFS) != 0 || (bitDepth != 24 && bitDepth != 1 && bitDepth != 4 && bitDepth != 8)) {
       Serial.println(F("BMP format not recognized."));
       bmpFS.close();
-      return(false);
+      return false;
     }
 
-    //draw img that is shorter than 240pix into the center
-    int16_t y = (height() - h) /2;
+    uint32_t palette[256];
+    if (bitDepth <= 8) // 1,4,8 bit bitmap: read color palette
+    {
+      (void) read32(bmpFS); (void) read32(bmpFS); (void) read32(bmpFS); // size, w resolution, h resolution
+      paletteSize = read32(bmpFS);
+      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);
+      }
+    }
+
+    // draw img that is shorter than 240pix into the center
+    x = (width() - w) /2;
+    y = (height() - h) /2;
 
-    bool oldSwapBytes = getSwapBytes();
-    setSwapBytes(true);
     bmpFS.seek(seekOffset);
 
-    uint16_t padding = (4 - ((w * 3) & 3)) & 3;
-    uint8_t lineBuffer[w * 3 + padding];
+    uint32_t lineSize = ((bitDepth * w +31) >> 5) * 4;
+    uint8_t lineBuffer[lineSize];
     
-    uint8_t serviceStrip = (!realtimeMode || realtimeOverride) ? 7 : 0;
+    uint8_t serviceStrip = (!realtimeMode || realtimeOverride || (realtimeMode && useMainSegmentOnly)) ? 7 : 0;
     // row is decremented as the BMP image is drawn bottom up
     for (row = h-1; row >= 0; row--) {
       if ((row & 0b00000111) == serviceStrip) strip.service(); //still refresh backlight to mitigate stutter every few rows
       bmpFS.read(lineBuffer, sizeof(lineBuffer));
       uint8_t*  bptr = lineBuffer;
       
-      // Convert 24 to 16 bit colours while copying to output buffer.
+      // Convert 24 to 16 bit colors while copying to output buffer.
       for (uint16_t col = 0; col < w; col++)
       {
-        b = *bptr++;
-        g = *bptr++;
-        r = *bptr++;
-        output_buffer[row][col] = ((r & 0xF8) << 8) | ((g & 0xFC) << 3) | (b >> 3);
+        if (bitDepth == 24) {
+          b = *bptr++;
+          g = *bptr++;
+          r = *bptr++;
+        } else {
+          uint32_t c = 0;
+          if (bitDepth == 8) {
+            c = palette[*bptr++];
+          }
+          else if (bitDepth == 4) {
+            c = palette[(*bptr >> ((col & 0x01)?0:4)) & 0x0F];
+            if (col & 0x01) bptr++;
+          }
+          else { // bitDepth == 1
+            c = palette[(*bptr >> (7 - (col & 0x07))) & 0x01];
+            if ((col & 0x07) == 0x07) bptr++;
+          }
+          b = c; g = c >> 8; r = c >> 16;
+        }
+        if (dimming != 255) { // only dim when needed
+          r *= dimming; g *= dimming; b *= dimming;
+          r  = r  >> 8; g  = g  >> 8; b  = b  >> 8;
+        }
+        if (digitColor) { // grayscale pixel coloring
+          uint8_t l = (r > g) ? ((r > b) ? r:b) : ((g > b) ? g:b);
+          r = g = b = l;
+
+          r *= digitR; g *= digitG; b *= digitB;
+          r  = r >> 8; g  = g >> 8; b  = b >> 8;
+        }
+        output_buffer[row][col] = ((r & 0xF8) << 8) | ((g & 0xFC) << 3) | ((b & 0xFF) >> 3);
       }
     }
     
-    pushImage(0, y, w, h, (uint16_t *)output_buffer);
-    setSwapBytes(oldSwapBytes);
+    drawBuffer();
 
     bmpFS.close();
-    return(true);
+    return true;
   }
 
+  bool drawClk(const char *filename) {
+    fs::File bmpFS;
+
+    // Open requested file on SD card
+    bmpFS = WLED_FS.open(filename, "r");
+
+    if (!bmpFS)
+    {
+      Serial.print("File not found: ");
+      Serial.println(filename);
+      return false;
+    }
+
+    uint16_t r, g, b, dimming = 255, magic;
+    int16_t row, col;
+    
+    magic = read16(bmpFS);
+    if (magic != 0x4B43) { // look for "CK" header
+      Serial.print(F("File not a CLK. Magic: "));
+      Serial.println(magic);
+      bmpFS.close();
+      return false;
+    }
+
+    w = read16(bmpFS);
+    h = read16(bmpFS);
+    x = (width() - w) / 2;
+    y = (height() - h) / 2;
+    
+    uint8_t lineBuffer[w * 2];
+    
+    if (!realtimeMode || realtimeOverride || (realtimeMode && useMainSegmentOnly)) strip.service();
+
+    // 0,0 coordinates are top left
+    for (row = 0; row < h; row++) {
+
+      bmpFS.read(lineBuffer, sizeof(lineBuffer));
+      uint8_t PixM, PixL;
+      
+      // Colors are already in 16-bit R5, G6, B5 format
+      for (col = 0; col < w; col++)
+      {
+        if (dimming == 255 && !digitColor) { // not needed, copy directly
+          output_buffer[row][col+x] = (lineBuffer[col*2+1] << 8) | (lineBuffer[col*2]);
+        } else {
+          // 16 BPP pixel format: R5, G6, B5 ; bin: RRRR RGGG GGGB BBBB
+          PixM = lineBuffer[col*2+1];
+          PixL = lineBuffer[col*2];
+          // align to 8-bit value (MSB left aligned)
+          r = (PixM) & 0xF8;
+          g = ((PixM << 5) | (PixL >> 3)) & 0xFC;
+          b = (PixL << 3) & 0xF8;
+          r *= dimming; g *= dimming; b *= dimming;
+          r  = r  >> 8; g  = g  >> 8; b  = b  >> 8;
+          if (digitColor) { // grayscale pixel coloring
+            uint8_t l = (r > g) ? ((r > b) ? r:b) : ((g > b) ? g:b);
+            r = g = b = l;
+            r *= digitR; g *= digitG; b *= digitB;
+            r  = r >> 8; g  = g >> 8; b  = b >> 8;
+          }
+          output_buffer[row][col+x] = ((r & 0xF8) << 8) | ((g & 0xFC) << 3) | (b >> 3);
+        }
+      }
+    }
+
+    drawBuffer();
+
+    bmpFS.close();
+    return true;
+  }
+
+
 public:
   TFTs() : TFT_eSPI(), chip_select()
     { for (uint8_t digit=0; digit < NUM_DIGITS; digit++) digits[digit] = 0; }
@@ -167,6 +299,9 @@ public:
   enum show_t { no, yes, force };
   // A digit of 0xFF means blank the screen.
   const static uint8_t blanked = 255;
+
+  uint8_t tubeSegment = 1;
+  uint8_t digitOffset = 0;
   
   void begin() {
     pinMode(TFT_ENABLE_PIN, OUTPUT);
@@ -182,34 +317,60 @@ public:
 
   void showDigit(uint8_t digit) {
     chip_select.setDigit(digit);
+    uint8_t digitToDraw = digits[digit];
+    if (digitToDraw < 10) digitToDraw += digitOffset;
 
-    if (digits[digit] == blanked) {
-      fillScreen(TFT_BLACK);
+    if (digitToDraw == blanked) {
+      fillScreen(TFT_BLACK); return;
     }
-    else {
-      // Filenames are no bigger than "255.bmp\0"
-      char file_name[10];
-      sprintf(file_name, "/%d.bmp", digits[digit]);
-      if (WLED_FS.exists(file_name)) {
-        drawBmp(file_name);
-      } else {
-        sprintf(file_name, "/%d.bin", digits[digit]);
-        drawBin(file_name);
-      }
+
+    // if last digit was the same, skip loading from FS to buffer
+    if (!digitColor && digitToDraw == bufferedDigit) drawBuffer();
+    digitR = R(digitColor); digitG = G(digitColor); digitB = B(digitColor);
+
+    // Filenames are no bigger than "254.bmp\0"
+    char file_name[10];
+    // Fastest, raw RGB565
+    sprintf(file_name, "/%d.bin", digitToDraw);
+    if (WLED_FS.exists(file_name)) {
+      if (drawBin(file_name)) bufferedDigit = digitToDraw;
+      return;
     }
-  }
+    // Fast, raw RGB565, see https://github.com/aly-fly/EleksTubeHAX on how to create this clk format
+    sprintf(file_name, "/%d.clk", digitToDraw);
+    if (WLED_FS.exists(file_name)) {
+      if (drawClk(file_name)) bufferedDigit = digitToDraw;
+      return;
+    }
+    // Slow, regular RGB888 or 1,4,8 bit palette BMP
+    sprintf(file_name, "/%d.bmp", digitToDraw);
+    if (drawBmp(file_name)) bufferedDigit = digitToDraw;
+    return;
+  } 
 
   void setDigit(uint8_t digit, uint8_t value, show_t show=yes) {
     uint8_t old_value = digits[digit];
     digits[digit] = value;
-  
+
+    // Color in grayscale bitmaps if Segment 1 exists
+    // TODO If secondary and tertiary are black, color all in primary,
+    // else color first three from Seg 1 color slots and last three from Seg 2 color slots
+    Segment& seg1 = strip.getSegment(tubeSegment);
+    if (seg1.isActive()) {
+      digitColor = strip.getPixelColor(seg1.start + digit);
+      dimming = seg1.opacity;
+    } else {
+      digitColor = 0;
+      dimming = 255;
+    }
+
     if (show != no && (old_value != value || show == force)) {
       showDigit(digit);
     }
   }
-  uint8_t getDigit(uint8_t digit)                 { return digits[digit]; }
+  uint8_t getDigit(uint8_t digit) {return digits[digit];}
 
-  void showAllDigits()               { for (uint8_t digit=0; digit < NUM_DIGITS; digit++) showDigit(digit); }
+  void showAllDigits()            {for (uint8_t digit=0; digit < NUM_DIGITS; digit++) showDigit(digit);}
 
   // Making chip_select public so we don't have to proxy all methods, and the caller can just use it directly.
   ChipSelect chip_select;

usermods/EleksTube_IPS/readme.md

@@ -5,16 +5,17 @@ It enables running all WLED effects on the background SK6812 lighting, while dis
 Code is largely based on https://github.com/SmittyHalibut/EleksTubeHAX by Mark Smith!
 
 Supported:
-- Display with custom bitmaps or raw RGB565 images (.bin) from filesystem
+- Display with custom bitmaps (.bmp) or raw RGB565 images (.bin) from filesystem
 - Background lighting
-- Power button
+- All 4 hardware buttons
 - RTC (with RTC usermod)
 - Standard WLED time features (NTP, DST, timezones)
 
 Not supported:
-- 3 navigation buttons, on-device setup
+- On-device setup with buttons (WiFi setup only)
 
-Your images must be exactly 135 pixels wide and 1-240 pixels high.
+Your images must be 1-135 pixels wide and 1-240 pixels high.
+BMP 1, 4, 8, and 24 bits per pixel formats are supported.
 
 ## Installation 
 
@@ -25,7 +26,20 @@ Use LED pin 12, relay pin 27 and button pin 34.
 
 ## Use of RGB565 images
 
-Binary 16-bit per pixel RGB565 format `.bin` images are now supported. This has the benefit of only using 2/3rds of the file size a `.bmp` has.
-The drawback is that this format cannot be handled by common image programs and that an extra conversion step is needed.
-You can use https://lvgl.io/tools/imageconverter to convert your .bmp to a .bin file (settings `True color` and `Binary RGB565`)
-Thank you to @RedNax67 for adding .bin support.
+Binary 16-bit per pixel RGB565 format `.bin` and `.clk` images are now supported. This has the benefit of using only 2/3rds of the file space a 24 BPP `.bmp` occupies.
+The drawback is this format cannot be handled by common image programs and an extra conversion step is needed.
+You can use https://lvgl.io/tools/imageconverter to convert your .bmp to a .bin file (settings `True color` and `Binary RGB565`).  
+Thank you to @RedNax67 for adding .bin and .clk support.  
+For most clockface designs, using 4 or 8 BPP BMP format will reduce file size even more:
+
+| Bits per pixel | File size in kB (for 135x240 img) | % of 24 BPP BMP | Max unique colors
+| --- | --- | --- | --- |
+24 | 98 | 100% | 16M (66K)
+16 (.clk) | 64.8 | 66% | 66K
+8 | 33.7 | 34% | 256
+4 | 16.4 | 17% | 16
+1 | 4.9 | 5% | 2
+
+Comparison 1 vs. 4 vs. 8 vs. 24 BPP. With this clockface on the actual clock, 4 bit looks good, and 8 bit is almost indistinguishable from 24 bit.
+
+![comparison](https://user-images.githubusercontent.com/21045690/156899667-5b55ed9f-6e03-4066-b2aa-1260e9570369.png)

usermods/EleksTube_IPS/usermod_elekstube_ips.h

@@ -6,6 +6,13 @@
 
 class ElekstubeIPSUsermod : public Usermod {
   private:
+    // strings to reduce flash memory usage (used more than twice)
+    static const char _name[];
+    static const char _tubeSeg[];
+    static const char _digitOffset[];
+
+    char cronixieDisplay[7] = "HHMMSS";
+
     TFTs tfts;
     void updateClockDisplay(TFTs::show_t show=TFTs::yes) {
       bool set[6] = {false}; 
@@ -21,6 +28,8 @@ class ElekstubeIPSUsermod : public Usermod {
           set[i] = false; //display HHMMSS time
         }
       }
+
+      
       uint8_t hr = hour(localTime);
       uint8_t hrTens = hr/10;
       uint8_t mi = minute(localTime);
@@ -37,6 +46,10 @@ class ElekstubeIPSUsermod : public Usermod {
     unsigned long lastTime = 0;
   public:
 
+    uint8_t lastBri;
+    uint32_t lastCols[6];
+    TFTs::show_t fshow=TFTs::yes;
+
     void setup() {
       tfts.begin();
       tfts.fillScreen(TFT_BLACK);
@@ -47,14 +60,99 @@ class ElekstubeIPSUsermod : public Usermod {
     }
 
     void loop() {
-      if (toki.isTick()) {
-        updateLocalTime();
-        updateClockDisplay();
+      if (!toki.isTick()) return;
+      updateLocalTime();
+
+      Segment& seg1 = strip.getSegment(tfts.tubeSegment);
+      if (seg1.isActive()) {
+        bool update = false;
+        if (seg1.opacity != lastBri) update = true;
+        lastBri = seg1.opacity;
+        for (uint8_t i = 0; i < 6; i++) {
+          uint32_t c = strip.getPixelColor(seg1.start + i);
+          if (c != lastCols[i]) update = true;
+          lastCols[i] = c;
+        }
+        if (update) fshow=TFTs::force;
+      } else if (lastCols[0] != 0) { // Segment 1 deleted
+        fshow=TFTs::force;
+        lastCols[0] = 0;
       }
+      
+      updateClockDisplay(fshow);
+      fshow=TFTs::yes;
+    }
+
+    /**
+     * addToConfig() (called from set.cpp) stores persistent properties to cfg.json
+     */
+    void addToConfig(JsonObject &root) {
+      // we add JSON object: {"EleksTubeIPS": {"tubeSegment": 1, "digitOffset": 0}}
+      JsonObject top = root.createNestedObject(FPSTR(_name)); // usermodname
+      top[FPSTR(_tubeSeg)] = tfts.tubeSegment;
+      top[FPSTR(_digitOffset)] = tfts.digitOffset;
+      DEBUG_PRINTLN(F("EleksTube 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 readFromConfig(JsonObject &root) {
+      // we look for JSON object: {"EleksTubeIPS": {"tubeSegment": 1, "digitOffset": 0}}
+      DEBUG_PRINT(FPSTR(_name));
+
+      JsonObject top = root[FPSTR(_name)];
+      if (top.isNull()) {
+        DEBUG_PRINTLN(F(": No config found. (Using defaults.)"));
+        return false;
+      }
+
+      tfts.tubeSegment = top[FPSTR(_tubeSeg)] | tfts.tubeSegment;
+      uint8_t digitOffsetPrev = tfts.digitOffset;
+      tfts.digitOffset = top[FPSTR(_digitOffset)] | tfts.digitOffset;
+      if (tfts.digitOffset > 240) tfts.digitOffset = 240;
+      if (tfts.digitOffset != digitOffsetPrev) fshow=TFTs::force;
+
+      // use "return !top["newestParameter"].isNull();" when updating Usermod with new features
+      return !top[FPSTR(_digitOffset)].isNull();
+    }
+
+    /*
+     * 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["nx"] = cronixieDisplay;
+      root[FPSTR(_digitOffset)] = tfts.digitOffset;
+    }
+
+
+    /*
+     * 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["nx"].is<const char*>()) {
+        strncpy(cronixieDisplay, root["nx"], 6);
+      }
+
+      uint8_t digitOffsetPrev = tfts.digitOffset;
+      tfts.digitOffset = root[FPSTR(_digitOffset)] | tfts.digitOffset;
+      if (tfts.digitOffset > 240) tfts.digitOffset = 240;
+      if (tfts.digitOffset != digitOffsetPrev) fshow=TFTs::force;
     }
 
     uint16_t getId()
     {
       return USERMOD_ID_ELEKSTUBE_IPS;
     }
-};
+};
+
+// strings to reduce flash memory usage (used more than twice)
+const char ElekstubeIPSUsermod::_name[]         PROGMEM = "EleksTubeIPS";
+const char ElekstubeIPSUsermod::_tubeSeg[]      PROGMEM = "tubeSegment";
+const char ElekstubeIPSUsermod::_digitOffset[]  PROGMEM = "digitOffset";

usermods/Enclosure_with_OLED_temp_ESP07/readme.md

@@ -10,7 +10,7 @@ For BME280 sensor use usermod_bme280.cpp. Copy to wled00 and rename to usermod.c
 ## Features
 -   SSD1306 128x32 and 128x64 I2C OLED display
 -   On screen IP address, SSID and controller status (e.g. ON or OFF, recent effect)
--   Auto display shutoff for saving display lifetime
+-   Auto display shutoff for extending display lifetime
 -   Dallas temperature sensor
 -   Reporting temperature to MQTT broker
 
@@ -39,15 +39,15 @@ default_envs = esp07
 ...
 lib_deps_external =
   ...
-  #For use SSD1306 OLED display uncomment following
+  #To use the SSD1306 OLED display, uncomment following
   U8g2@~2.27.3
-  #For Dallas sensor uncomment following 2 lines
+  #For Dallas sensor, uncomment the following 2 lines
   DallasTemperature@~3.8.0
   OneWire@~2.3.5
 ...
 ```
 
-For BME280 sensor uncomment `U8g2@~2.27.3`,`BME280@~3.0.0 under` `[common]` section in `platformio.ini`:
+For BME280 sensor, uncomment `U8g2@~2.27.3`,`BME280@~3.0.0 under` `[common]` section in `platformio.ini`:
 ```ini
 # platformio.ini
 ...
@@ -60,7 +60,7 @@ default_envs = esp07
 ...
 lib_deps_external =
   ...
-  #For use SSD1306 OLED display uncomment following
+  #To use the SSD1306 OLED display, uncomment following
   U8g2@~2.27.3
   #For BME280 sensor uncomment following
   BME280@~3.0.0

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
@@ -100,9 +104,9 @@ void userLoop() {
     needRedraw = true;
   } else if (knownBrightness != bri) {
     needRedraw = true;
-  } else if (knownMode != strip.getMode()) {
+  } else if (knownMode != strip.getMainSegment().mode) {
     needRedraw = true;
-  } else if (knownPalette != strip.getSegment(0).palette) {
+  } else if (knownPalette != strip.getMainSegment().palette) {
     needRedraw = true;
   }
 
@@ -126,19 +130,19 @@ void userLoop() {
   #endif
   knownIp = apActive ? IPAddress(4, 3, 2, 1) : WiFi.localIP();
   knownBrightness = bri;
-  knownMode = strip.getMode();
-  knownPalette = strip.getSegment(0).palette;
+  knownMode = strip.getMainSegment().mode;
+  knownPalette = strip.getMainSegment().palette;
   u8x8.clear();
   u8x8.setFont(u8x8_font_chroma48medium8_r);
 
   // 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)
@@ -148,58 +152,14 @@ void userLoop() {
 
   // Third row with mode name
   u8x8.setCursor(2, 2);
-  uint8_t qComma = 0;
-  bool insideQuotes = false;
-  uint8_t printedChars = 0;
-  char singleJsonSymbol;
+  char lineBuffer[17];
+  extractModeName(knownMode, JSON_mode_names, lineBuffer, 16);
+  u8x8.print(lineBuffer);
 
-  // Find the mode name in JSON
-  for (size_t i = 0; i < strlen_P(JSON_mode_names); i++) {
-    singleJsonSymbol = pgm_read_byte_near(JSON_mode_names + i);
-    switch (singleJsonSymbol) {
-    case '"':
-      insideQuotes = !insideQuotes;
-      break;
-    case '[':
-    case ']':
-      break;
-    case ',':
-      qComma++;
-    default:
-      if (!insideQuotes || (qComma != knownMode))
-        break;
-      u8x8.print(singleJsonSymbol);
-      printedChars++;
-    }
-    if ((qComma > knownMode) || (printedChars > u8x8.getCols() - 2))
-      break;
-  }
   // Fourth row with palette name
   u8x8.setCursor(2, 3);
-  qComma = 0;
-  insideQuotes = false;
-  printedChars = 0;
-  // Looking for palette name in JSON.
-  for (size_t i = 0; i < strlen_P(JSON_palette_names); i++) {
-    singleJsonSymbol = pgm_read_byte_near(JSON_palette_names + i);
-    switch (singleJsonSymbol) {
-    case '"':
-      insideQuotes = !insideQuotes;
-      break;
-    case '[':
-    case ']':
-      break;
-    case ',':
-      qComma++;
-    default:
-      if (!insideQuotes || (qComma != knownPalette))
-        break;
-      u8x8.print(singleJsonSymbol);
-      printedChars++;
-    }
-    if ((qComma > knownMode) || (printedChars > u8x8.getCols() - 2))
-      break;
-  }
+  extractModeName(knownPalette, JSON_palette_names, lineBuffer, 16);
+  u8x8.print(lineBuffer);
 
   u8x8.setFont(u8x8_font_open_iconic_embedded_1x1);
   u8x8.drawGlyph(0, 0, 80); // wifi icon

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
 
@@ -143,9 +147,9 @@ void userLoop() {
     needRedraw = true;
   } else if (knownBrightness != bri) {
     needRedraw = true;
-  } else if (knownMode != strip.getMode()) {
+  } else if (knownMode != strip.getMainSegment().mode) {
     needRedraw = true;
-  } else if (knownPalette != strip.getSegment(0).palette) {
+  } else if (knownPalette != strip.getMainSegment().palette) {
     needRedraw = true;
   }
 
@@ -169,19 +173,19 @@ void userLoop() {
   #endif
   knownIp = apActive ? IPAddress(4, 3, 2, 1) : WiFi.localIP();
   knownBrightness = bri;
-  knownMode = strip.getMode();
-  knownPalette = strip.getSegment(0).palette;
+  knownMode = strip.getMainSegment().mode;
+  knownPalette = strip.getMainSegment().palette;
   u8x8.clear();
   u8x8.setFont(u8x8_font_chroma48medium8_r);
 
   // 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)
@@ -191,58 +195,14 @@ void userLoop() {
 
   // Third row with mode name
   u8x8.setCursor(2, 2);
-  uint8_t qComma = 0;
-  bool insideQuotes = false;
-  uint8_t printedChars = 0;
-  char singleJsonSymbol;
+  char lineBuffer[17];
+  extractModeName(knownMode, JSON_mode_names, lineBuffer, 16);
+  u8x8.print(lineBuffer);
 
-  // Find the mode name in JSON
-  for (size_t i = 0; i < strlen_P(JSON_mode_names); i++) {
-    singleJsonSymbol = pgm_read_byte_near(JSON_mode_names + i);
-    switch (singleJsonSymbol) {
-    case '"':
-      insideQuotes = !insideQuotes;
-      break;
-    case '[':
-    case ']':
-      break;
-    case ',':
-      qComma++;
-    default:
-      if (!insideQuotes || (qComma != knownMode))
-        break;
-      u8x8.print(singleJsonSymbol);
-      printedChars++;
-    }
-    if ((qComma > knownMode) || (printedChars > u8x8.getCols() - 2))
-      break;
-  }
   // Fourth row with palette name
   u8x8.setCursor(2, 3);
-  qComma = 0;
-  insideQuotes = false;
-  printedChars = 0;
-  // Looking for palette name in JSON.
-  for (size_t i = 0; i < strlen_P(JSON_palette_names); i++) {
-    singleJsonSymbol = pgm_read_byte_near(JSON_palette_names + i);
-    switch (singleJsonSymbol) {
-    case '"':
-      insideQuotes = !insideQuotes;
-      break;
-    case '[':
-    case ']':
-      break;
-    case ',':
-      qComma++;
-    default:
-      if (!insideQuotes || (qComma != knownPalette))
-        break;
-      u8x8.print(singleJsonSymbol);
-      printedChars++;
-    }
-    if ((qComma > knownMode) || (printedChars > u8x8.getCols() - 2))
-      break;
-  }
+  extractModeName(knownPalette, JSON_palette_names, lineBuffer, 16);
+  u8x8.print(lineBuffer);
 
   u8x8.setFont(u8x8_font_open_iconic_embedded_1x1);
   u8x8.drawGlyph(0, 0, 80); // wifi icon

usermods/Fix_unreachable_netservices_v2/readme.md

@@ -2,15 +2,16 @@
 
 **Attention: This usermod compiles only for ESP8266**
 
-This usermod-v2 modification performs a ping request to the local IP address every 60 seconds. By this procedure the net services of WLED remains 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.
 
 _Story:_
 
-Unfortunately, with all ESP projects where a web server or other network services are running, I have the problem that after some time the web server is no longer accessible.  Now I found out that the connection is at least reestablished when a ping request is executed by the device.
+Unfortunately, with many ESP projects where a web server or other network services are running, after some time, the connecton to the web server is lost.
+The connection can be reestablished with a ping request from the device.
 
-With this modification, in the worst case, the network functions are not available for 60 seconds until the next ping request.
+With this modification, in the worst case, the network functions are not available until the next ping request. (60 seconds)
 
 ## Webinterface
 
@@ -23,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/JSON_IR_remote/readme.md

@@ -2,8 +2,8 @@
 
 ## Purpose 
 
-The JSON IR remote allows users to customize IR remote behavior without writing custom code and compiling. 
-It also enables using any remote that is compatible with your IR receiver. Using the JSON IR remote, you can
+The JSON IR remote enables users to customize IR remote behavior without writing custom code and compiling. 
+It also allows using any remote compatible with your IR receiver. Using the JSON IR remote, you can
 map buttons from any remote to any HTTP request API or JSON API command.  
 
 ## Usage

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/MAX17048_v2/readme.md

@@ -0,0 +1,64 @@
+# Adafruit MAX17048 Usermod (LiPo & LiIon Battery Monitor & Fuel Gauge)
+This usermod reads information from an Adafruit MAX17048  and outputs the following:
+- Battery Voltage
+- Battery Level Percentage
+
+
+## Dependencies
+Libraries:
+- `Adafruit_BusIO@~1.14.5` (by [adafruit](https://github.com/adafruit/Adafruit_BusIO))
+- `Adafruit_MAX1704X@~1.0.2` (by [adafruit](https://github.com/adafruit/Adafruit_MAX1704X))
+
+These must be added under `lib_deps` in your `platform.ini` (or `platform_override.ini`).
+Data is published over MQTT - make sure you've enabled the MQTT sync interface.
+
+## Compilation
+
+To enable, compile with `USERMOD_MAX17048` define in the build_flags (e.g. in `platformio.ini` or `platformio_override.ini`) such as in the example below:
+```ini
+[env:usermod_max17048_d1_mini]
+extends = env:d1_mini
+build_flags =
+  ${common.build_flags_esp8266}
+  -D USERMOD_MAX17048
+lib_deps = 
+  ${esp8266.lib_deps}
+  https://github.com/adafruit/Adafruit_BusIO @ 1.14.5
+  https://github.com/adafruit/Adafruit_MAX1704X @ 1.0.2
+```
+
+### Configuration Options
+The following settings can be set at compile-time but are configurable on the usermod menu (except First Monitor time):
+- USERMOD_MAX17048_MIN_MONITOR_INTERVAL (the min number of milliseconds between checks, defaults to 10,000 ms)
+- USERMOD_MAX17048_MAX_MONITOR_INTERVAL (the max number of milliseconds between checks, defaults to 10,000 ms)
+- USERMOD_MAX17048_FIRST_MONITOR_AT
+
+
+Additionally, the Usermod Menu allows you to:
+- Enable or Disable the usermod
+- Enable or Disable Home Assistant Discovery (turn on/off to sent MQTT Discovery entries for Home Assistant)
+- Configure SCL/SDA GPIO Pins
+
+## API
+The following method is available to interact with the usermod from other code modules:
+- `getBatteryVoltageV` read the last battery voltage (in Volt) obtained from the sensor
+- `getBatteryPercent` reads the last battery percentage obtained from the sensor
+
+## MQTT
+MQTT topics are as follows (`<deviceTopic>` is set in MQTT section of Sync Setup menu):
+Measurement type | MQTT topic
+--- | ---
+Battery Voltage | `<deviceTopic>/batteryVoltage`
+Battery Percent | `<deviceTopic>/batteryPercent`
+
+## Authors
+Carlos Cruz [@ccruz09](https://github.com/ccruz09)
+
+
+## Revision History
+Jan 2024
+- Added Home Assistant Discovery
+- Implemented PinManager to register pins
+- Added API call for other modules to read battery voltage and percentage
+- Added info-screen outputs
+- Updated `readme.md`

usermods/MAX17048_v2/usermod_max17048.h

@@ -0,0 +1,281 @@
+// force the compiler to show a warning to confirm that this file is included
+#warning **** Included USERMOD_MAX17048 V2.0 ****
+
+#pragma once
+
+#include "wled.h"
+#include "Adafruit_MAX1704X.h"
+
+
+// the max interval to check battery level, 10 seconds
+#ifndef USERMOD_MAX17048_MAX_MONITOR_INTERVAL
+#define USERMOD_MAX17048_MAX_MONITOR_INTERVAL 10000
+#endif
+
+// the min  interval to check battery level, 500 ms
+#ifndef USERMOD_MAX17048_MIN_MONITOR_INTERVAL
+#define USERMOD_MAX17048_MIN_MONITOR_INTERVAL 500
+#endif
+
+// how many seconds after boot to perform the first check, 10 seconds
+#ifndef USERMOD_MAX17048_FIRST_MONITOR_AT
+#define USERMOD_MAX17048_FIRST_MONITOR_AT 10000
+#endif
+
+/* 
+ * Usermod to display Battery Life using Adafruit's MAX17048 LiPoly/ LiIon Fuel Gauge and Battery Monitor.
+ */
+class  Usermod_MAX17048 : public Usermod {
+
+  private:
+
+    bool enabled = true;
+
+    unsigned long maxReadingInterval = USERMOD_MAX17048_MAX_MONITOR_INTERVAL;
+    unsigned long minReadingInterval = USERMOD_MAX17048_MIN_MONITOR_INTERVAL;
+    unsigned long lastCheck = UINT32_MAX - (USERMOD_MAX17048_MAX_MONITOR_INTERVAL - USERMOD_MAX17048_FIRST_MONITOR_AT);
+    unsigned long lastSend = UINT32_MAX - (USERMOD_MAX17048_MAX_MONITOR_INTERVAL - USERMOD_MAX17048_FIRST_MONITOR_AT);
+
+
+    uint8_t  VoltageDecimals = 3;  // Number of decimal places in published voltage values
+    uint8_t  PercentDecimals = 1;    // Number of decimal places in published percent values
+
+    // string that are used multiple time (this will save some flash memory)
+    static const char _name[];
+    static const char _enabled[];
+    static const char _maxReadInterval[];
+    static const char _minReadInterval[];
+    static const char _HomeAssistantDiscovery[];
+
+    bool monitorFound = false;
+    bool firstReadComplete = false;
+    bool initDone = false;
+
+    Adafruit_MAX17048 maxLipo;
+    float lastBattVoltage = -10;
+    float lastBattPercent = -1;
+
+    // MQTT and Home Assistant Variables
+    bool HomeAssistantDiscovery = false;    // Publish Home Assistant Device Information
+    bool mqttInitialized = false; 
+
+    void _mqttInitialize()
+    {
+        char mqttBatteryVoltageTopic[128];
+        char mqttBatteryPercentTopic[128];
+
+        snprintf_P(mqttBatteryVoltageTopic, 127, PSTR("%s/batteryVoltage"), mqttDeviceTopic);
+        snprintf_P(mqttBatteryPercentTopic, 127, PSTR("%s/batteryPercent"), mqttDeviceTopic);
+
+        if (HomeAssistantDiscovery) {
+        _createMqttSensor(F("BatteryVoltage"), mqttBatteryVoltageTopic, "voltage", F("V"));
+        _createMqttSensor(F("BatteryPercent"), mqttBatteryPercentTopic, "battery", F("%"));
+        }
+    }
+
+    void _createMqttSensor(const String &name, const String &topic, const String &deviceClass, const String &unitOfMeasurement)
+    {
+        String t = String(F("homeassistant/sensor/")) + mqttClientID + F("/") + name + F("/config");
+
+        StaticJsonDocument<600> doc;
+
+        doc[F("name")] = String(serverDescription) + " " + name;
+        doc[F("state_topic")] = topic;
+        doc[F("unique_id")] = String(mqttClientID) + name;
+        if (unitOfMeasurement != "")
+        doc[F("unit_of_measurement")] = unitOfMeasurement;
+        if (deviceClass != "")
+        doc[F("device_class")] = deviceClass;
+        doc[F("expire_after")] = 1800;
+
+        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("sw_version")] = versionString;
+
+        String temp;
+        serializeJson(doc, temp);
+        DEBUG_PRINTLN(t);
+        DEBUG_PRINTLN(temp);
+
+        mqtt->publish(t.c_str(), 0, true, temp.c_str());
+    }
+
+    void publishMqtt(const char *topic, const char* state) {
+    #ifndef WLED_DISABLE_MQTT
+      //Check if MQTT Connected, otherwise it will crash the 8266
+      if (WLED_MQTT_CONNECTED){
+        char subuf[128];
+        snprintf_P(subuf, 127, PSTR("%s/%s"), mqttDeviceTopic, topic);
+        mqtt->publish(subuf, 0, false, state);
+      }
+    #endif
+    }
+
+  public:
+
+    inline void enable(bool enable) { enabled = enable; }
+
+    inline bool isEnabled() { return enabled; }
+
+    void setup() {
+      // do your set-up here
+      if (i2c_scl<0 || i2c_sda<0) { enabled = false; return; }
+      monitorFound = maxLipo.begin();
+      initDone = true;
+    }
+
+    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 (!enabled || strip.isUpdating()) return;
+
+        unsigned long now = millis();
+
+        if (now - lastCheck < minReadingInterval) { return; }
+
+        bool shouldUpdate = now - lastSend > maxReadingInterval;
+
+        float battVoltage = maxLipo.cellVoltage();
+        float battPercent = maxLipo.cellPercent();
+        lastCheck = millis();
+        firstReadComplete = true;
+
+        if (shouldUpdate)
+        {
+          lastBattVoltage = roundf(battVoltage * powf(10, VoltageDecimals)) / powf(10, VoltageDecimals);
+          lastBattPercent = roundf(battPercent * powf(10, PercentDecimals)) / powf(10, PercentDecimals);
+          lastSend = millis();
+
+          publishMqtt("batteryVoltage", String(lastBattVoltage, VoltageDecimals).c_str());
+          publishMqtt("batteryPercent", String(lastBattPercent, PercentDecimals).c_str());
+          DEBUG_PRINTLN(F("Battery Voltage: ") + String(lastBattVoltage, VoltageDecimals) + F("V"));
+          DEBUG_PRINTLN(F("Battery Percent: ") + String(lastBattPercent, PercentDecimals) + F("%"));
+        }
+    }
+
+    void onMqttConnect(bool sessionPresent)
+    {
+        if (WLED_MQTT_CONNECTED && !mqttInitialized)
+        {
+            _mqttInitialize();
+            mqttInitialized = true;
+        }
+    }
+
+    inline float getBatteryVoltageV() {
+        return (float) lastBattVoltage;
+    }
+
+    inline float getBatteryPercent() {
+        return (float) lastBattPercent;
+    }
+
+    void addToJsonInfo(JsonObject& root)
+    {
+      // if "u" object does not exist yet wee need to create it
+      JsonObject user = root["u"];
+      if (user.isNull()) user = root.createNestedObject("u");
+
+
+      JsonArray battery_json = user.createNestedArray(F("Battery Monitor"));
+      if (!enabled) {
+        battery_json.add(F("Disabled"));
+      }
+      else if(!monitorFound) {
+        battery_json.add(F("MAX17048 Not Found"));
+      }        
+      else if (!firstReadComplete) {
+        // if we haven't read the sensor yet, let the user know
+        // that we are still waiting for the first measurement
+        battery_json.add((USERMOD_MAX17048_FIRST_MONITOR_AT - millis()) / 1000);
+        battery_json.add(F(" sec until read"));
+      } else {
+        battery_json.add(F("Enabled"));
+        JsonArray voltage_json = user.createNestedArray(F("Battery Voltage"));
+        voltage_json.add(lastBattVoltage);
+        voltage_json.add(F("V"));
+        JsonArray percent_json = user.createNestedArray(F("Battery Percent"));
+        percent_json.add(lastBattPercent);
+        percent_json.add(F("%"));
+      }
+    }
+
+    void addToJsonState(JsonObject& root)
+    {
+        JsonObject usermod = root[FPSTR(_name)];
+        if (usermod.isNull())
+        {
+        usermod = root.createNestedObject(FPSTR(_name));
+        }
+        usermod[FPSTR(_enabled)] = enabled;
+    }
+
+    void readFromJsonState(JsonObject& root)
+    {
+        JsonObject usermod = root[FPSTR(_name)];
+        if (!usermod.isNull())
+        {
+            if (usermod[FPSTR(_enabled)].is<bool>())
+            {
+                enabled = usermod[FPSTR(_enabled)].as<bool>();
+            }
+        }
+    }
+
+    void addToConfig(JsonObject& root)
+    {
+      JsonObject top = root.createNestedObject(FPSTR(_name));
+      top[FPSTR(_enabled)] = enabled;
+      top[FPSTR(_maxReadInterval)] = maxReadingInterval;
+      top[FPSTR(_minReadInterval)] = minReadingInterval;
+      top[FPSTR(_HomeAssistantDiscovery)] = HomeAssistantDiscovery;
+      DEBUG_PRINT(F(_name));
+      DEBUG_PRINTLN(F(" config saved."));
+    }
+
+    bool readFromConfig(JsonObject& root)
+    {
+      JsonObject top = root[FPSTR(_name)];
+
+      if (top.isNull()) {
+        DEBUG_PRINT(F(_name));
+        DEBUG_PRINTLN(F(": No config found. (Using defaults.)"));
+        return false;
+      }
+
+      bool configComplete = !top.isNull();
+
+      configComplete &= getJsonValue(top[FPSTR(_enabled)], enabled);
+      configComplete &= getJsonValue(top[FPSTR(_maxReadInterval)], maxReadingInterval, USERMOD_MAX17048_MAX_MONITOR_INTERVAL);
+      configComplete &= getJsonValue(top[FPSTR(_minReadInterval)], minReadingInterval, USERMOD_MAX17048_MIN_MONITOR_INTERVAL);
+      configComplete &= getJsonValue(top[FPSTR(_HomeAssistantDiscovery)], HomeAssistantDiscovery, false);
+
+      DEBUG_PRINT(FPSTR(_name));
+      if (!initDone) {
+        // first run: reading from cfg.json
+        DEBUG_PRINTLN(F(" config loaded."));
+      } else {
+        DEBUG_PRINTLN(F(" config (re)loaded."));
+        // changing parameters from settings page
+      }
+
+      return configComplete;
+    }
+
+    uint16_t getId()
+    {
+      return USERMOD_ID_MAX17048;
+    }
+
+};
+
+
+// add more strings here to reduce flash memory usage
+const char Usermod_MAX17048::_name[]    PROGMEM = "Adafruit MAX17048 Battery Monitor";
+const char Usermod_MAX17048::_enabled[] PROGMEM = "enabled";
+const char Usermod_MAX17048::_maxReadInterval[] PROGMEM = "max-read-interval-ms";
+const char Usermod_MAX17048::_minReadInterval[] PROGMEM = "min-read-interval-ms";
+const char Usermod_MAX17048::_HomeAssistantDiscovery[] PROGMEM = "HomeAssistantDiscovery";

usermods/MY9291/MY92xx.h

@@ -0,0 +1,321 @@
+/*
+
+MY92XX LED Driver for Arduino
+Based on the C driver by MaiKe Labs
+
+Copyright (c) 2016 - 2026 MaiKe Labs
+Copyright (C) 2017 - 2018 Xose Pérez for the Arduino compatible library
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+*/
+
+#ifndef _my92xx_h
+#define _my92xx_h
+
+#include <Arduino.h>
+
+#ifdef DEBUG_MY92XX
+#if ARDUINO_ARCH_ESP8266
+#define DEBUG_MSG_MY92XX(...) DEBUG_MY92XX.printf( __VA_ARGS__ )
+#elif ARDUINO_ARCH_AVR
+#define DEBUG_MSG_MY92XX(...) { char buffer[80]; snprintf(buffer, sizeof(buffer),  __VA_ARGS__ ); DEBUG_MY92XX.print(buffer); }
+#endif
+#else
+#define DEBUG_MSG_MY92XX(...)
+#endif
+
+typedef enum my92xx_model_t {
+    MY92XX_MODEL_MY9291 = 0X00,
+    MY92XX_MODEL_MY9231 = 0X01,
+} my92xx_model_t;
+
+typedef enum my92xx_cmd_one_shot_t {
+    MY92XX_CMD_ONE_SHOT_DISABLE = 0X00,
+    MY92XX_CMD_ONE_SHOT_ENFORCE = 0X01,
+} my92xx_cmd_one_shot_t;
+
+typedef enum my92xx_cmd_reaction_t {
+    MY92XX_CMD_REACTION_FAST = 0X00,
+    MY92XX_CMD_REACTION_SLOW = 0X01,
+} my92xx_cmd_reaction_t;
+
+typedef enum my92xx_cmd_bit_width_t {
+    MY92XX_CMD_BIT_WIDTH_16 = 0X00,
+    MY92XX_CMD_BIT_WIDTH_14 = 0X01,
+    MY92XX_CMD_BIT_WIDTH_12 = 0X02,
+    MY92XX_CMD_BIT_WIDTH_8 = 0X03,
+} my92xx_cmd_bit_width_t;
+
+typedef enum my92xx_cmd_frequency_t {
+    MY92XX_CMD_FREQUENCY_DIVIDE_1 = 0X00,
+    MY92XX_CMD_FREQUENCY_DIVIDE_4 = 0X01,
+    MY92XX_CMD_FREQUENCY_DIVIDE_16 = 0X02,
+    MY92XX_CMD_FREQUENCY_DIVIDE_64 = 0X03,
+} my92xx_cmd_frequency_t;
+
+typedef enum my92xx_cmd_scatter_t {
+    MY92XX_CMD_SCATTER_APDM = 0X00,
+    MY92XX_CMD_SCATTER_PWM = 0X01,
+} my92xx_cmd_scatter_t;
+
+typedef struct {
+    my92xx_cmd_scatter_t scatter : 1;
+    my92xx_cmd_frequency_t frequency : 2;
+    my92xx_cmd_bit_width_t bit_width : 2;
+    my92xx_cmd_reaction_t reaction : 1;
+    my92xx_cmd_one_shot_t one_shot : 1;
+    unsigned char resv : 1;
+} __attribute__((aligned(1), packed)) my92xx_cmd_t;
+
+#define MY92XX_COMMAND_DEFAULT { \
+    .scatter = MY92XX_CMD_SCATTER_APDM, \
+    .frequency = MY92XX_CMD_FREQUENCY_DIVIDE_1, \
+    .bit_width = MY92XX_CMD_BIT_WIDTH_8, \
+    .reaction = MY92XX_CMD_REACTION_FAST, \
+    .one_shot = MY92XX_CMD_ONE_SHOT_DISABLE, \
+    .resv = 0 \
+}
+
+class my92xx {
+
+public:
+
+    my92xx(my92xx_model_t model, unsigned char chips, unsigned char di, unsigned char dcki, my92xx_cmd_t command);
+    unsigned char getChannels();
+    void setChannel(unsigned char channel, unsigned int value);
+    unsigned int getChannel(unsigned char channel);
+    void setState(bool state);
+    bool getState();
+    void update();
+
+private:
+
+    void _di_pulse(unsigned int times);
+    void _dcki_pulse(unsigned int times);
+    void _set_cmd(my92xx_cmd_t command);
+    void _send();
+    void _write(unsigned int data, unsigned char bit_length);
+
+    my92xx_cmd_t _command;
+    my92xx_model_t _model = MY92XX_MODEL_MY9291;
+    unsigned char _chips = 1;
+    unsigned char _channels;
+    uint16_t* _value;
+    bool _state = false;
+    unsigned char _pin_di;
+    unsigned char _pin_dcki;
+
+
+};
+
+
+#if ARDUINO_ARCH_ESP8266
+
+extern "C" {
+    void os_delay_us(unsigned int);
+}
+
+#elif ARDUINO_ARCH_AVR
+
+#define os_delay_us delayMicroseconds
+
+#endif
+
+void my92xx::_di_pulse(unsigned int times) {
+    for (unsigned int i = 0; i < times; i++) {
+        digitalWrite(_pin_di, HIGH);
+        digitalWrite(_pin_di, LOW);
+    }
+}
+
+void my92xx::_dcki_pulse(unsigned int times) {
+    for (unsigned int i = 0; i < times; i++) {
+        digitalWrite(_pin_dcki, HIGH);
+        digitalWrite(_pin_dcki, LOW);
+    }
+}
+
+void my92xx::_write(unsigned int data, unsigned char bit_length) {
+
+    unsigned int mask = (0x01 << (bit_length - 1));
+
+    for (unsigned int i = 0; i < bit_length / 2; i++) {
+        digitalWrite(_pin_dcki, LOW);
+        digitalWrite(_pin_di, (data & mask) ? HIGH : LOW);
+        digitalWrite(_pin_dcki, HIGH);
+        data = data << 1;
+        digitalWrite(_pin_di, (data & mask) ? HIGH : LOW);
+        digitalWrite(_pin_dcki, LOW);
+        digitalWrite(_pin_di, LOW);
+        data = data << 1;
+    }
+
+}
+
+void my92xx::_set_cmd(my92xx_cmd_t command) {
+
+    // ets_intr_lock();
+
+    // TStop > 12us.
+    os_delay_us(12);
+
+    // Send 12 DI pulse, after 6 pulse's falling edge store duty data, and 12
+    // pulse's rising edge convert to command mode.
+    _di_pulse(12);
+
+    // Delay >12us, begin send CMD data
+    os_delay_us(12);
+
+    // Send CMD data
+    unsigned char command_data = *(unsigned char*)(&command);
+    for (unsigned char i = 0; i < _chips; i++) {
+        _write(command_data, 8);
+    }
+
+    // TStart > 12us. Delay 12 us.
+    os_delay_us(12);
+
+    // Send 16 DI pulse，at 14 pulse's falling edge store CMD data, and
+    // at 16 pulse's falling edge convert to duty mode.
+    _di_pulse(16);
+
+    // TStop > 12us.
+    os_delay_us(12);
+
+    // ets_intr_unlock();
+
+}
+
+void my92xx::_send() {
+
+#ifdef DEBUG_MY92XX
+    DEBUG_MSG_MY92XX("[MY92XX] Refresh: %s (", _state ? "ON" : "OFF");
+    for (unsigned char channel = 0; channel < _channels; channel++) {
+        DEBUG_MSG_MY92XX(" %d", _value[channel]);
+    }
+    DEBUG_MSG_MY92XX(" )\n");
+#endif
+
+    unsigned char bit_length = 8;
+    switch (_command.bit_width) {
+    case MY92XX_CMD_BIT_WIDTH_16:
+        bit_length = 16;
+        break;
+    case MY92XX_CMD_BIT_WIDTH_14:
+        bit_length = 14;
+        break;
+    case MY92XX_CMD_BIT_WIDTH_12:
+        bit_length = 12;
+        break;
+    case MY92XX_CMD_BIT_WIDTH_8:
+        bit_length = 8;
+        break;
+    default:
+        bit_length = 8;
+        break;
+    }
+
+    // ets_intr_lock();
+
+    // TStop > 12us.
+    os_delay_us(12);
+
+    // Send color data
+    for (unsigned char channel = 0; channel < _channels; channel++) {
+        _write(_state ? _value[channel] : 0, bit_length);
+    }
+
+    // TStart > 12us. Ready for send DI pulse.
+    os_delay_us(12);
+
+    // Send 8 DI pulse. After 8 pulse falling edge, store old data.
+    _di_pulse(8);
+
+    // TStop > 12us.
+    os_delay_us(12);
+
+    // ets_intr_unlock();
+
+}
+
+// -----------------------------------------------------------------------------
+
+unsigned char my92xx::getChannels() {
+    return _channels;
+}
+
+void my92xx::setChannel(unsigned char channel, unsigned int value) {
+    if (channel < _channels) {
+        _value[channel] = value;
+    }
+}
+
+unsigned int my92xx::getChannel(unsigned char channel) {
+    if (channel < _channels) {
+        return _value[channel];
+    }
+    return 0;
+}
+
+bool my92xx::getState() {
+    return _state;
+}
+
+void my92xx::setState(bool state) {
+    _state = state;
+}
+
+void my92xx::update() {
+    _send();
+}
+
+// -----------------------------------------------------------------------------
+
+my92xx::my92xx(my92xx_model_t model, unsigned char chips, unsigned char di, unsigned char dcki, my92xx_cmd_t command) : _command(command) {
+
+    _model = model;
+    _chips = chips;
+    _pin_di = di;
+    _pin_dcki = dcki;
+
+    // Init channels
+    if (_model == MY92XX_MODEL_MY9291) {
+        _channels = 4 * _chips;
+    }
+    else if (_model == MY92XX_MODEL_MY9231) {
+        _channels = 3 * _chips;
+    }
+    _value = new uint16_t[_channels];
+    for (unsigned char i = 0; i < _channels; i++) {
+        _value[i] = 0;
+    }
+
+    // Init GPIO
+    pinMode(_pin_di, OUTPUT);
+    pinMode(_pin_dcki, OUTPUT);
+    digitalWrite(_pin_di, LOW);
+    digitalWrite(_pin_dcki, LOW);
+
+    // Clear all duty register
+    _dcki_pulse(32 * _chips);
+
+    // Send init command
+    _set_cmd(command);
+
+    DEBUG_MSG_MY92XX("[MY92XX] Initialized\n");
+
+}
+
+#endif

usermods/MY9291/usermode_MY9291.h

@@ -0,0 +1,45 @@
+#pragma once
+
+#include "wled.h"
+#include "MY92xx.h"
+
+#define MY92XX_MODEL        MY92XX_MODEL_MY9291
+#define MY92XX_CHIPS        1
+#define MY92XX_DI_PIN       13
+#define MY92XX_DCKI_PIN     15
+
+#define MY92XX_RED          0
+#define MY92XX_GREEN        1
+#define MY92XX_BLUE         2
+#define MY92XX_WHITE        3
+
+class MY9291Usermod : public Usermod {
+  private:
+    my92xx _my92xx = my92xx(MY92XX_MODEL, MY92XX_CHIPS, MY92XX_DI_PIN, MY92XX_DCKI_PIN, MY92XX_COMMAND_DEFAULT);
+
+  public:
+
+    void setup() {
+      _my92xx.setState(true);
+    }
+
+    void connected() {
+    }
+
+    void loop() {
+      uint32_t c = strip.getPixelColor(0);
+      int w = ((c >> 24) & 0xff) * bri / 255.0;
+      int r = ((c >> 16) & 0xff) * bri / 255.0;
+      int g = ((c >> 8) & 0xff) * bri / 255.0;
+      int b = (c & 0xff) * bri / 255.0;
+      _my92xx.setChannel(MY92XX_RED, r);
+      _my92xx.setChannel(MY92XX_GREEN, g);
+      _my92xx.setChannel(MY92XX_BLUE, b);
+      _my92xx.setChannel(MY92XX_WHITE, w);
+      _my92xx.update();
+    }
+
+    uint16_t getId() {
+      return USERMOD_ID_MY9291;
+    }
+};

usermods/PIR_sensor_mqtt_v1/README.md

@@ -1,9 +0,0 @@
-# PIR sensor with MQTT
-
-This simple usermod allows attaching a PIR sensor like the AM312 and publish the readings over MQTT. A message is sent when motion is detected as well as when motion has stopped.
-
-This usermod has only been tested with the AM312 sensor though should work for any other PIR sensor. Note that this does not control the LED strip directly, it only publishes MQTT readings for use with other integrations like Home Assistant.
-
-## Installation
-
-Copy and replace the file `usermod.cpp` in wled00 directory.

usermods/PIR_sensor_mqtt_v1/usermod.cpp

@@ -1,55 +0,0 @@
-#include "wled.h"
-/*
- * This v1 usermod 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)
- * If you just need 8 bytes, use 2551-2559 (you do not need to increase EEPSIZE)
- * 
- * Consider the v2 usermod API if you need a more advanced feature set!
- */
-
-//Use userVar0 and userVar1 (API calls &U0=,&U1=, uint16_t)
-
-// PIR sensor pin
-const int MOTION_PIN = 16;
- // MQTT topic for sensor values
-const char MQTT_TOPIC[] = "/motion";
-
-int prevState = LOW;
-
-//gets called once at boot. Do all initialization that doesn't depend on network here
-void userSetup()
-{
-  pinMode(MOTION_PIN, INPUT);
-}
-
-//gets called every time WiFi is (re-)connected. Initialize own network interfaces here
-void userConnected()
-{
-
-}
-
-void publishMqtt(String state)
-{
-  //Check if MQTT Connected, otherwise it will crash the 8266
-  if (mqtt != nullptr){
-    char subuf[38];
-    strcpy(subuf, mqttDeviceTopic);
-    strcat(subuf, MQTT_TOPIC);
-    mqtt->publish(subuf, 0, true, state.c_str());
-  }
-}
-
-//loop. You can use "if (WLED_CONNECTED)" to check for successful connection
-void userLoop()
-{
-  if (digitalRead(MOTION_PIN) == HIGH && prevState == LOW) { // Motion detected
-    publishMqtt("ON");
-    prevState = HIGH;
-  } 
-  if (digitalRead(MOTION_PIN) == LOW && prevState == HIGH) {  // Motion stopped
-    publishMqtt("OFF");
-    prevState = LOW;
-  }
-}
-

usermods/PIR_sensor_switch/PIR_Highlight_Standby

@@ -61,7 +61,7 @@ class PIRsensorSwitch : public Usermod {
   private:
     // PIR sensor pin
     const uint8_t PIRsensorPin = 13; // D7 on D1 mini
-    // notification mode for colorUpdated()
+    // notification mode for stateUpdated()
     const byte NotifyUpdateMode = CALL_MODE_NO_NOTIFY; // CALL_MODE_DIRECT_CHANGE
     // 1 min delay before switch off after the sensor state goes LOW
     uint32_t m_switchOffDelay = 60000;
@@ -127,7 +127,7 @@ class PIRsensorSwitch : public Usermod {
         if (bri != briHighlight) { 
           bri = briHighlight; // set current highlight brightness to last set highlight brightness
         }
-        colorUpdated(NotifyUpdateMode);
+        stateUpdated(NotifyUpdateMode);
         highlightActive = true; // flag highlight is on
       }    
       else { // **pir timer has elapsed**
@@ -157,7 +157,7 @@ class PIRsensorSwitch : public Usermod {
           }
           applyMacro(macroLongPress); // apply standby lighting without brightness
         }
-        colorUpdated(NotifyUpdateMode);
+        stateUpdated(NotifyUpdateMode);
         highlightActive = false; // flag highlight is off
       }
     }

usermods/PIR_sensor_switch/readme.md

@@ -7,68 +7,35 @@ _Story:_
 I use the PIR Sensor to automatically turn on the WLED analog clock in my home office room when I am there.
 The LED strip is switched [using a relay](https://github.com/Aircoookie/WLED/wiki/Control-a-relay-with-WLED) to keep the power consumption low when it is switched off.
 
-## Webinterface
+## Web interface
 
-The info page in the web interface shows the remaining time of the off timer. 
+The info page in the web interface shows the remaining time of the off timer. Usermod can also be temporarily disbled/enabled from the info page by clicking PIR button.
 
 ## Sensor connection
 
-My setup uses an HC-SR501 sensor, a HC-SR505 should also work.
+My setup uses an HC-SR501 or HC-SR602 sensor, an HC-SR505 should also work.
 
-The usermod uses GPIO13 (D1 mini pin D7) by default for the sensor signal but can be changed in the Usermod settings page.
+The usermod uses GPIO13 (D1 mini pin D7) by default for the sensor signal, but can be changed in the Usermod settings page.
 [This example page](http://www.esp8266learning.com/wemos-mini-pir-sensor-example.php) describes how to connect the sensor.
 
-Use the potentiometers on the sensor to set the time-delay to the minimum and the sensitivity to about half, or slightly above.
+Use the potentiometers on the sensor to set the time delay to the minimum and the sensitivity to about half, or slightly above.
+You can also use usermod's off timer instead of sensor's. In such case rotate the potentiometer to its shortest time possible (or use SR602 which lacks such potentiometer).
 
 ## Usermod installation
 
-1. Copy the file `usermod_PIR_sensor_switch.h` to the `wled00` directory.
-2. Register the usermod by adding `#include "usermod_PIR_sensor_switch.h"` in the top and `registerUsermod(new PIRsensorSwitch());` in the bottom of `usermods_list.cpp`.
+**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`.
 
-Example **usermods_list.cpp**:
-
-```cpp
-#include "wled.h"
-/*
- * Register your v2 usermods here!
- *   (for v1 usermods using just usermod.cpp, you can ignore this file)
- */
-
-/*
- * Add/uncomment your usermod filename here (and once more below)
- * || || ||
- * \/ \/ \/
- */
-//#include "usermod_v2_example.h"
-//#include "usermod_temperature.h"
-//#include "usermod_v2_empty.h"
-#include "usermod_PIR_sensor_switch.h"
-
-void registerUsermods()
-{
-  /*
-   * Add your usermod class name here
-   * || || ||
-   * \/ \/ \/
-   */
-  //usermods.add(new MyExampleUsermod());
-  //usermods.add(new UsermodTemperature());
-  //usermods.add(new UsermodRenameMe());
-  usermods.add(new PIRsensorSwitch());
-
-}
-```
-
-## API to enable/disable the PIR sensor from outside. For example from another usermod.
+## API to enable/disable the PIR sensor from outside. For example from another usermod:
 
 To query or change the PIR sensor state the methods `bool PIRsensorEnabled()` and `void EnablePIRsensor(bool enable)` are available.
 
 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 just send MQTT message and not change WLED state using settings page as well as responding to motion only during nighttime (assuming NTP and lattitude/longitude are set to determine sunrise/sunset times).
+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 latitude/longitude are set to determine sunrise/sunset times).
 
 ### There are two options to get access to the usermod instance:
 
-1. Include `usermod_PIR_sensor_switch.h` **before** you include the other usermod in `usermods_list.cpp'
+1. Include `usermod_PIR_sensor_switch.h` **before** you include other usermods in `usermods_list.cpp'
 
 or
 
@@ -95,8 +62,42 @@ class MyUsermod : public Usermod {
 };
 ```
 
-Have fun - @gegu
+### Configuration options
+
+Usermod can be configured via the Usermods settings page.
+
+* `PIRenabled` - enable/disable usermod
+* `pin` - dynamically change GPIO pin where PIR sensor is attached to ESP
+* `PIRoffSec` - number of seconds after PIR sensor deactivates when usermod triggers Off preset (or turns WLED off)
+* `on-preset` - preset triggered when PIR activates (if this is 0 it will just turn WLED on)
+* `off-preset` - preset triggered when PIR deactivates (if this is 0 it will just turn WLED off)
+* `nighttime-only` - enable triggering only between sunset and sunrise (you will need to set up _NTP_, _Lat_ & _Lon_ in Time & Macro settings)
+* `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
 
 ## Change log
 2021-04
-* Adaptation for runtime configuration.
+* Adaptation for runtime configuration.
+
+2021-11
+* Added information about dynamic configuration options
+* 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

@@ -1,409 +1,569 @@
-#pragma once
-
-#include "wled.h"
-
-#ifndef PIR_SENSOR_PIN
-  // compatible with QuinLED-Dig-Uno
-  #ifdef ARDUINO_ARCH_ESP32
-    #define PIR_SENSOR_PIN 23 // Q4
-  #else //ESP8266 boards
-    #define PIR_SENSOR_PIN 13 // Q4 (D7 on D1 mini)
-  #endif
-#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. 
- * 
- * 
- * Usermods allow you to add own functionality to WLED more easily
- * See: https://github.com/Aircoookie/WLED/wiki/Add-own-functionality
- * 
- * v2 usermods are class inheritance based and can (but don't have to) implement more functions, each of them is shown in this example.
- * Multiple v2 usermods can be added to one compilation easily.
- * 
- * Creating a usermod:
- * This file serves as an example. If you want to create a usermod, it is recommended to use usermod_v2_empty.h from the usermods folder as a template.
- * Please remember to rename the class and file to a descriptive name.
- * You may also use multiple .h and .cpp files.
- * 
- * Using a usermod:
- * 1. Copy the usermod into the sketch folder (same folder as wled00.ino)
- * 2. Register the usermod by adding #include "usermod_filename.h" in the top and registerUsermod(new MyUsermodClass()) in the bottom of usermods_list.cpp
- */
-
-class PIRsensorSwitch : public Usermod
-{
-public:
-  /**
-   * constructor
-   */
-  PIRsensorSwitch() {}
-  /**
-   * desctructor
-   */
-  ~PIRsensorSwitch() {}
-
-  /**
-   * Enable/Disable the PIR sensor
-   */
-  void EnablePIRsensor(bool en) { enabled = en; }
-  /**
-   * Get PIR sensor enabled/disabled state
-   */
-  bool PIRsensorEnabled() { return enabled; }
-
-private:
-  // PIR sensor pin
-  int8_t PIRsensorPin = PIR_SENSOR_PIN;
-  // notification mode for colorUpdated()
-  const byte NotifyUpdateMode = CALL_MODE_NO_NOTIFY; // CALL_MODE_DIRECT_CHANGE
-  // delay before switch off after the sensor state goes LOW
-  uint32_t m_switchOffDelay = 600000; // 10min
-  // off timer start time
-  uint32_t m_offTimerStart = 0;
-  // current PIR sensor pin state
-  byte sensorPinState = LOW;
-  // PIR sensor enabled
-  bool enabled = true;
-  // status of initialisation
-  bool initDone = false;
-  // on and off presets
-  uint8_t m_onPreset = 0;
-  uint8_t m_offPreset = 0;
-  // flag to indicate that PIR sensor should activate WLED during nighttime only
-  bool m_nightTimeOnly = false;
-  // flag to send MQTT message only (assuming it is enabled)
-  bool m_mqttOnly = false;
-  // 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 PIRtriggered = false;
-
-  unsigned long lastLoop = 0;
-
-  // strings to reduce flash memory usage (used more than twice)
-  static const char _name[];
-  static const char _switchOffDelay[];
-  static const char _enabled[];
-  static const char _onPreset[];
-  static const char _offPreset[];
-  static const char _nightTime[];
-  static const char _mqttOnly[];
-  static const char _offOnly[];
-
-  /**
-   * check if it is daytime
-   * if sunrise/sunset is not defined (no NTP or lat/lon) default to nighttime
-   */
-  bool isDayTime() {
-    bool isDayTime = false;
-    updateLocalTime();
-    uint8_t hr = hour(localTime);
-    uint8_t mi = minute(localTime);
-
-    if (sunrise && sunset) {
-      if (hour(sunrise)<hr && hour(sunset)>hr) {
-        isDayTime = true;
-      } else {
-        if (hour(sunrise)==hr && minute(sunrise)<mi) {
-          isDayTime = true;
-        }
-        if (hour(sunset)==hr && minute(sunset)>mi) {
-          isDayTime = true;
-        }
-      }
-    }
-    return isDayTime;
-  }
-
-  /**
-   * switch strip on/off
-   */
-  void switchStrip(bool switchOn)
-  {
-    if (m_offOnly && bri && (switchOn || (!PIRtriggered && !switchOn))) return;
-    PIRtriggered = switchOn;
-    if (switchOn && m_onPreset) {
-      applyPreset(m_onPreset);
-    } else if (!switchOn && m_offPreset) {
-      applyPreset(m_offPreset);
-    } else if (switchOn && bri == 0) {
-      bri = briLast;
-      colorUpdated(NotifyUpdateMode);
-    } else if (!switchOn && bri != 0) {
-      briLast = bri;
-      bri = 0;
-      colorUpdated(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);
-    }
-  }
-
-  /**
-   * Read and update PIR sensor state.
-   * Initilize/reset switch off timer
-   */
-  bool updatePIRsensorState()
-  {
-    bool pinState = digitalRead(PIRsensorPin);
-    if (pinState != sensorPinState) {
-      sensorPinState = pinState; // change previous state
-
-      if (sensorPinState == HIGH) {
-        m_offTimerStart = 0;
-        if (!m_mqttOnly && (!m_nightTimeOnly || (m_nightTimeOnly && !isDayTime()))) switchStrip(true);
-        publishMqtt("on");
-      } else /*if (bri != 0)*/ {
-        // start switch off timer
-        m_offTimerStart = millis();
-      }
-      return true;
-    }
-    return false;
-  }
-
-  /**
-   * switch off the strip if the delay has elapsed 
-   */
-  bool handleOffTimer()
-  {
-    if (m_offTimerStart > 0 && millis() - m_offTimerStart > m_switchOffDelay)
-    {
-      if (enabled == true)
-      {
-        if (!m_mqttOnly && (!m_nightTimeOnly || (m_nightTimeOnly && !isDayTime()))) switchStrip(false);
-        publishMqtt("off");
-      }
-      m_offTimerStart = 0;
-      return true;
-    }
-    return false;
-  }
-
-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()
-  {
-    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;
-  }
-
-  /**
-   * connected() is called every time the WiFi is (re)connected
-   * Use it to initialize network interfaces
-   */
-  void connected()
-  {
-  }
-
-  /**
-   * 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();
-    }
-  }
-
-  /**
-   * 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");
-
-    if (enabled)
-    {
-      // off timer
-      String uiDomString = F("PIR <i class=\"icons\">&#xe325;</i>");
-      JsonArray infoArr = user.createNestedArray(uiDomString); // timer value
-      if (m_offTimerStart > 0)
-      {
-        uiDomString = "";
-        unsigned int offSeconds = (m_switchOffDelay - (millis() - m_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 {
-      String uiDomString = F("PIR sensor");
-      JsonArray infoArr = user.createNestedArray(uiDomString);
-      infoArr.add(F("disabled"));
-    }
-  }
-
-  /**
-   * 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)
-  {
-  }
-*/
-
-  /**
-   * 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;
-    DEBUG_PRINTLN(F("PIR config saved."));
-  }
-
-  /**
-   * restore the changeable values
-   * 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)
-  {
-    bool oldEnabled = enabled;
-    int8_t oldPin = PIRsensorPin;
-
-    JsonObject top = root[FPSTR(_name)];
-    if (top.isNull()) {
-      DEBUG_PRINT(FPSTR(_name));
-      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;
-
-    DEBUG_PRINT(FPSTR(_name));
-    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(_offOnly)].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_PIRSWITCH;
-  }
-};
-
-// strings to reduce flash memory usage (used more than twice)
-const char PIRsensorSwitch::_name[]           PROGMEM = "PIRsensorSwitch";
-const char PIRsensorSwitch::_enabled[]        PROGMEM = "PIRenabled";
-const char PIRsensorSwitch::_switchOffDelay[] PROGMEM = "PIRoffSec";
-const char PIRsensorSwitch::_onPreset[]       PROGMEM = "on-preset";
-const char PIRsensorSwitch::_offPreset[]      PROGMEM = "off-preset";
-const char PIRsensorSwitch::_nightTime[]      PROGMEM = "nighttime-only";
-const char PIRsensorSwitch::_mqttOnly[]       PROGMEM = "mqtt-only";
-const char PIRsensorSwitch::_offOnly[]        PROGMEM = "off-only";
+#pragma once
+
+#include "wled.h"
+
+#ifndef PIR_SENSOR_PIN
+  // compatible with QuinLED-Dig-Uno
+  #ifdef ARDUINO_ARCH_ESP32
+    #define PIR_SENSOR_PIN 23 // Q4
+  #else //ESP8266 boards
+    #define PIR_SENSOR_PIN 13 // Q4 (D7 on D1 mini)
+  #endif
+#endif
+
+#ifndef PIR_SENSOR_OFF_SEC
+  #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
+ * 
+ * v2 usermods are class inheritance based and can (but don't have to) implement more functions, each of them is shown in this example.
+ * Multiple v2 usermods can be added to one compilation easily.
+ */
+
+class PIRsensorSwitch : public Usermod
+{
+public:
+  // constructor
+  PIRsensorSwitch() {}
+  // destructor
+  ~PIRsensorSwitch() {}
+
+  //Enable/Disable the PIR sensor
+  inline void EnablePIRsensor(bool en) { enabled = en; }
+  
+  // Get PIR sensor enabled/disabled state
+  inline bool PIRsensorEnabled() { return enabled; }
+
+private:
+
+  byte prevPreset   = 0;
+  byte prevPlaylist = 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_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
+  bool m_nightTimeOnly      = false;          // flag to indicate that PIR sensor should activate WLED during nighttime only
+  bool m_mqttOnly           = false;          // flag to send MQTT message only (assuming it is enabled)
+  // 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[];
+  static const char _switchOffDelay[];
+  static const char _enabled[];
+  static const char _onPreset[];
+  static const char _offPreset[];
+  static const char _nightTime[];
+  static const char _mqttOnly[];
+  static const char _offOnly[];
+  static const char _haDiscovery[];
+  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
+   */
+  static bool isDayTime();
+
+  /**
+   * switch strip on/off
+   */
+  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();
+
+  /**
+   * Read and update PIR sensor state.
+   * Initialize/reset switch off timer
+   */
+  bool updatePIRsensorState();
+
+  /**
+   * switch off the strip if the delay has elapsed 
+   */
+  bool handleOffTimer();
+
+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() override;
+
+  /**
+   * connected() is called every time the WiFi is (re)connected
+   * Use it to initialize network interfaces
+   */
+  //void connected();
+
+  /**
+   * onMqttConnect() is called when MQTT connection is established
+   */
+  void onMqttConnect(bool sessionPresent) override;
+
+  /**
+   * loop() is called continuously. Here you can check for events, read sensors, etc.
+   */
+  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) override;
+
+  /**
+   * 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);
+
+  /**
+   * 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) override;
+
+  /**
+   * provide the changeable values
+   */
+  void addToConfig(JsonObject &root) override;
+
+  /**
+   * provide UI information and allow extending UI options
+   */
+  void appendConfigData() override;
+
+  /**
+   * restore the changeable values
+   * 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) 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() override { return USERMOD_ID_PIRSWITCH; }
+};
+
+// strings to reduce flash memory usage (used more than twice)
+const char PIRsensorSwitch::_name[]           PROGMEM = "PIRsensorSwitch";
+const char PIRsensorSwitch::_enabled[]        PROGMEM = "PIRenabled";
+const char PIRsensorSwitch::_switchOffDelay[] PROGMEM = "PIRoffSec";
+const char PIRsensorSwitch::_onPreset[]       PROGMEM = "on-preset";
+const char PIRsensorSwitch::_offPreset[]      PROGMEM = "off-preset";
+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::_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

@@ -2,12 +2,12 @@
 
 v2 Usermod to to control PWM fan with RPM feedback and temperature control
 
-This usermod requires Dallas Temperature usermod to obtain temperature information. If this is not available the fan will always run at 100% speed.
-If the fan does not have _tacho_ (RPM) output you can set the _tacho-pin_ to -1 to not use that feature.
+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 actual temperature measured will be 3°C greater than 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 _tacho_ is supported the current speed (in RPM) will be repored in WLED Info page.
+If the _tachometer_ is supported, the current speed (in RPM) will be displayed on the WLED Info page.
 
 ## Installation
 
@@ -19,10 +19,10 @@ You will also need `-D USERMOD_DALLASTEMPERATURE`.
 All of the parameters are configured during run-time using Usermods settings page.
 This includes:
 
-* PWM output pin
-* tacho input pin
+* 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.
 
@@ -30,7 +30,16 @@ _NOTE:_ You may also need to tweak Dallas Temperature usermod sampling frequency
 
 No special requirements.
 
+## Control PWM fan speed using JSON API
+
+e.g. you can use `{"PWM-fan":{"speed":30,"lock":true}}` to lock fan speed to 30 percent of maximum. (replace 30 with an arbitrary value between 0 and 100)
+If you include `speed` property you can set fan speed as a percentage (%) of maximum speed.
+If you include `lock` property you can lock (_true_) or unlock (_false_) the fan speed.
+If the fan speed is unlocked, it will revert to temperature controlled speed on the next update cycle. Once fan speed is locked it will remain so until it is unlocked by the next API call.
+
 ## Change Log
 
 2021-10
 * First public release
+2022-05
+* Added JSON API call to allow changing of speed

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"
@@ -10,6 +10,13 @@
 // https://github.com/KlausMu/esp32-fan-controller/tree/main/src
 // adapted for WLED usermod by @blazoncek
 
+#ifndef TACHO_PIN
+  #define TACHO_PIN -1
+#endif
+
+#ifndef PWM_PIN
+  #define PWM_PIN -1
+#endif
 
 // tacho counter
 static volatile unsigned long counter_rpm = 0;
@@ -31,18 +38,28 @@ class PWMFanUsermod : public Usermod {
     #ifdef ARDUINO_ARCH_ESP32
     uint8_t pwmChannel = 255;
     #endif
+    bool lockFan = false;
 
     #ifdef USERMOD_DALLASTEMPERATURE
     UsermodTemperature* tempUM;
+    #elif defined(USERMOD_SHT)
+    ShtUsermod* tempUM;
     #endif
 
     // configurable parameters
-    int8_t  tachoPin          = -1;
-    int8_t  pwmPin            = -1;
+    int8_t  tachoPin          = TACHO_PIN;
+    int8_t  pwmPin            = PWM_PIN;
     uint8_t tachoUpdateSec    = 30;
-    float   targetTemperature = 25.0;
-    uint8_t minPWMValuePct    = 50;
+    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[];
@@ -52,7 +69,10 @@ 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[];
 
     void initTacho(void) {
       if (tachoPin < 0 || !pinManager.allocatePin(tachoPin, false, PinOwner::UM_Unspecified)){
@@ -73,6 +93,8 @@ class PWMFanUsermod : public Usermod {
     }
 
     void updateTacho(void) {
+      // store milliseconds when tacho was measured the last time
+      msLastTachoMeasurement = millis();
       if (tachoPin < 0) return;
 
       // start of tacho measurement
@@ -83,8 +105,6 @@ class PWMFanUsermod : public Usermod {
       last_rpm /= tachoUpdateSec;
       // reset counter
       counter_rpm = 0; 
-      // store milliseconds when tacho was measured the last time
-      msLastTachoMeasurement = millis();
       // attach interrupt again
       attachInterrupt(digitalPinToInterrupt(tachoPin), rpm_fan, FALLING);
     }
@@ -92,6 +112,7 @@ class PWMFanUsermod : public Usermod {
     // https://randomnerdtutorials.com/esp32-pwm-arduino-ide/
     void initPWMfan(void) {
       if (pwmPin < 0 || !pinManager.allocatePin(pwmPin, true, PinOwner::UM_Unspecified)) {
+        enabled = false;
         pwmPin = -1;
         return;
       }
@@ -123,7 +144,7 @@ class PWMFanUsermod : public Usermod {
     }
 
     void updateFanSpeed(uint8_t pwmValue){
-      if (pwmPin < 0) return;
+      if (!enabled || pwmPin < 0) return;
 
       #ifdef ESP8266
       analogWrite(pwmPin, pwmValue);
@@ -133,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
@@ -142,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 <= 0.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();
@@ -186,19 +203,19 @@ 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();
       if ((now - msLastTachoMeasurement) < (tachoUpdateSec * 1000)) return;
 
       updateTacho();
-      setFanPWMbasedOnTemperature();
+      if (!lockFan) setFanPWMbasedOnTemperature();
     }
 
     /*
@@ -206,13 +223,42 @@ 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) {
-      if (tachoPin < 0) return;
+    void addToJsonInfo(JsonObject& root) override {
       JsonObject user = root["u"];
       if (user.isNull()) user = root.createNestedObject("u");
-      JsonArray data = user.createNestedArray(FPSTR(_name));
-      data.add(last_rpm);
-      data.add(F("rpm"));
+
+      JsonArray infoArr = user.createNestedArray(FPSTR(_name));
+      String uiDomString = F("<button class=\"btn btn-xs\" onclick=\"requestJson({'");
+      uiDomString += FPSTR(_name);
+      uiDomString += F("':{'");
+      uiDomString += FPSTR(_enabled);
+      uiDomString += F("':");
+      uiDomString += enabled ? "false" : "true";
+      uiDomString += F("}});\"><i class=\"icons ");
+      uiDomString += enabled ? "on" : "off";
+      uiDomString += F("\">&#xe08f;</i></button>");
+      infoArr.add(uiDomString);
+
+      if (enabled) {
+        JsonArray infoArr = user.createNestedArray(F("Manual"));
+        String uiDomString = F("<div class=\"slider\"><div class=\"sliderwrap il\"><input class=\"noslide\" onchange=\"requestJson({'");
+        uiDomString += FPSTR(_name);
+        uiDomString += F("':{'");
+        uiDomString += FPSTR(_speed);
+        uiDomString += F("':parseInt(this.value)}});\" oninput=\"updateTrail(this);\" max=100 min=0 type=\"range\" value=");
+        uiDomString += pwmValuePct;
+        uiDomString += F(" /><div class=\"sliderdisplay\"></div></div></div>"); //<output class=\"sliderbubble\"></output>
+        infoArr.add(uiDomString);
+
+        JsonArray data = user.createNestedArray(F("Speed"));
+        if (tachoPin >= 0) {
+          data.add(last_rpm);
+          data.add(F("rpm"));
+        } else {
+          if (lockFan) data.add(F("locked"));
+          else         data.add(F("auto"));
+        }
+      }
     }
 
     /*
@@ -226,9 +272,24 @@ 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) {
-    //  if (!initDone) return;  // prevent crash on boot applyPreset()
-    //}
+    void readFromJsonState(JsonObject& root) override {
+      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>();
+          if (!enabled) updateFanSpeed(0);
+        }
+        if (enabled && !usermod[FPSTR(_speed)].isNull() && usermod[FPSTR(_speed)].is<int>()) {
+          pwmValuePct = usermod[FPSTR(_speed)].as<int>();
+          updateFanSpeed((constrain(pwmValuePct,0,100) * 255) / 100);
+          if (pwmValuePct) lockFan = true;
+        }
+        if (enabled && !usermod[FPSTR(_lock)].isNull() && usermod[FPSTR(_lock)].is<bool>()) {
+          lockFan = usermod[FPSTR(_lock)].as<bool>();
+        }
+      }
+    }
 
     /*
      * addToConfig() can be used to add custom persistent settings to the cfg.json file in the "um" (usermod) object.
@@ -244,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;
@@ -252,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."));
     }
@@ -266,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;
 
@@ -285,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
 
@@ -316,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;
     }
 };
@@ -329,4 +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/QuinLED_Dig_Uno_Temp_MQTT/readme.md

@@ -1,34 +0,0 @@
-# QuinLED Dig Uno board
-
-These files allow WLED 0.9.1 to report the temp sensor on the Quinled board to MQTT. I use it to report the board temp to Home Assistant via MQTT, so it will send notifications if something happens and the board start to heat up.
-This code uses Aircookie's WLED software. It has a premade file for user modifications. I use it to publish the temperature from the dallas temperature sensor on the Quinled board. The entries for the top of the WLED00 file, initializes the required libraries, and variables for the sensor. The .ino file waits for 60 seconds, and checks to see if the MQTT server is connected (thanks Aircoookie). It then poles the sensor, and published it using the MQTT service already running, using the main topic programmed in the WLED UI.
-
-Installation of file: Copy and replace file in wled00 directory
-
-## Project link
-
-* [QuinLED-Dig-Uno](https://quinled.info/2018/09/15/quinled-dig-uno/) - Project link
-
-### Platformio requirements
-
-Uncomment `DallasTemperature@~3.8.0`,`OneWire@~2.3.5 under` `[common]` section in `platformio.ini`:
-
-```ini
-# platformio.ini
-...
-[platformio]
-...
-; default_envs = esp07
-default_envs = d1_mini
-...
-[common]
-...
-lib_deps_external =
-  ...
-  #For use SSD1306 OLED display uncomment following
-  U8g2@~2.27.3
-  #For Dallas sensor uncomment following 2 lines
-  DallasTemperature@~3.8.0
-  OneWire@~2.3.5
-...
-```

usermods/QuinLED_Dig_Uno_Temp_MQTT/usermod.cpp

@@ -1,54 +0,0 @@
-#include <Arduino.h>
-#include "wled.h"
-//Intiating code for QuinLED Dig-Uno temp sensor
-//Uncomment Celsius if that is your prefered temperature scale
-#include <DallasTemperature.h> //Dallastemperature sensor
-#ifdef ARDUINO_ARCH_ESP32 //ESP32 boards
-OneWire oneWire(18);
-#else //ESP8266 boards
-OneWire oneWire(14);
-#endif
-DallasTemperature sensor(&oneWire);
-long temptimer = millis();
-long lastMeasure = 0;
-#define Celsius // Show temperature mesaurement in Celcius otherwise is in Fahrenheit
-void userSetup()
-{
-// Start the DS18B20 sensor
-  sensor.begin();
-}
-    
-//gets called every time WiFi is (re-)connected. Initialize own network interfaces here
-void userConnected()
-{
-
-}
-
-void userLoop()
-{
-  temptimer = millis();
-  
-// Timer to publishe new temperature every 60 seconds
-  if (temptimer - lastMeasure > 60000) {
-    lastMeasure = temptimer;
-    
-//Check if MQTT Connected, otherwise it will crash the 8266
-    if (mqtt != nullptr){
-      sensor.requestTemperatures();
-
-//Gets prefered temperature scale based on selection in definitions section
-      #ifdef Celsius
-      float board_temperature = sensor.getTempCByIndex(0);
-      #else
-      float board_temperature = sensors.getTempFByIndex(0);
-      #endif
-
-//Create character string populated with user defined device topic from the UI, and the read temperature. Then publish to MQTT server.
-      char subuf[38];
-      strcpy(subuf, mqttDeviceTopic);
-      strcat(subuf, "/temperature");
-      mqtt->publish(subuf, 0, true, String(board_temperature).c_str());
-    return;}
-  return;}
-return;
-}

usermods/RTC/readme.md

@@ -1,6 +1,6 @@
 # DS1307/DS3231 Real time clock
 
-Gets the time from I2C RTC module on boot. This allows clocks to operate e.g. if temporarily no WiFi is available.
+Gets the time from I2C RTC module on boot. This allows clock operation if WiFi is not available.
 The stored time is updated each time NTP is synced. 
 
 ## Installation 

usermods/RTC/usermod_rtc.h

@@ -12,6 +12,8 @@ class RTCUsermod : public Usermod {
   public:
 
     void setup() {
+      if (i2c_scl<0 || i2c_sda<0) { disabled = true; return; }
+      RTC.begin();
       time_t rtcTime = RTC.get();
       if (rtcTime) {
         toki.setTime(rtcTime,TOKI_NO_MS_ACCURACY,TOKI_TS_RTC);
@@ -22,12 +24,26 @@ class RTCUsermod : public Usermod {
     }
 
     void loop() {
-      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
       }
     }
 
+    /*
+     * 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("RTC");
+//      JsonArray pins = top.createNestedArray("pin");
+//      pins.add(i2c_scl);
+//      pins.add(i2c_sda);
+//    }
+
     uint16_t getId()
     {
       return USERMOD_ID_RTC;

usermods/RelayBlinds/index.htm

@@ -0,0 +1,76 @@
+<!DOCTYPE html>
+<html>
+<head><meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
+  <meta charset="utf-8">
+  <title>Blinds</title>
+  <script>
+      strA = "";
+    function send()
+    {
+      nocache = "&nocache=" + Math.random() * 1000000;
+      var request = new XMLHttpRequest();
+      // send HTTP request
+      request.open("GET", "win/" + strA +nocache, true);
+      request.send(null);
+      strA = "";
+    }
+    function up()
+    {
+      strA = "&U0=2";
+      send();
+    }
+    function down()
+    {
+      strA = "&U0=1";
+      send();
+    }
+    function OpenSettings()
+    {
+      window.open("/settings", "_self");
+    }
+  </script>
+  <style>
+    body {
+      text-align: center;
+      background: linear-gradient(45deg,#0ca,#0ac);
+      height: 100%;
+      margin: 0;
+      background-repeat: no-repeat;
+      background-attachment: fixed;
+    }
+    html {
+      height: 100%;
+    }
+    svg {
+      width: 30vw;
+      padding: 2vh;
+    }
+    .tool_box {
+      position: absolute;
+      top: 50%;
+      left: 50%;
+      transform: translate(-50%, -50%);
+    }
+  </style>
+<style id="holderjs-style" type="text/css"></style></head>
+<body class=" __plain_text_READY__">
+<svg style="position: absolute; width: 0; height: 0; overflow: hidden;" version="1.1" xmlns="http://www.w3.org/2000/svg">
+<defs>
+<symbol id="icon-box-add" viewBox="0 0 32 32">
+<path d="M26 2h-20l-6 6v21c0 0.552 0.448 1 1 1h30c0.552 0 1-0.448 1-1v-21l-6-6zM16 26l-10-8h6v-6h8v6h6l-10 8zM4.828 6l2-2h18.343l2 2h-22.343z"></path>
+</symbol>
+<symbol id="icon-box-remove" viewBox="0 0 32 32">
+<path d="M26 2h-20l-6 6v21c0 0.552 0.448 1 1 1h30c0.552 0 1-0.448 1-1v-21l-6-6zM20 20v6h-8v-6h-6l10-8 10 8h-6zM4.828 6l2-2h18.343l2 2h-22.343z"></path>
+</symbol>
+<symbol id="icon-cog" viewBox="0 0 32 32">
+<path d="M29.181 19.070c-1.679-2.908-0.669-6.634 2.255-8.328l-3.145-5.447c-0.898 0.527-1.943 0.829-3.058 0.829-3.361 0-6.085-2.742-6.085-6.125h-6.289c0.008 1.044-0.252 2.103-0.811 3.070-1.679 2.908-5.411 3.897-8.339 2.211l-3.144 5.447c0.905 0.515 1.689 1.268 2.246 2.234 1.676 2.903 0.672 6.623-2.241 8.319l3.145 5.447c0.895-0.522 1.935-0.82 3.044-0.82 3.35 0 6.067 2.725 6.084 6.092h6.289c-0.003-1.034 0.259-2.080 0.811-3.038 1.676-2.903 5.399-3.894 8.325-2.219l3.145-5.447c-0.899-0.515-1.678-1.266-2.232-2.226zM16 22.479c-3.578 0-6.479-2.901-6.479-6.479s2.901-6.479 6.479-6.479c3.578 0 6.479 2.901 6.479 6.479s-2.901 6.479-6.479 6.479z"></path>
+</symbol>
+</defs>
+</svg>
+  <div id="tbB" class="tool_box">
+    <svg id="upb" onclick="up()"><use xlink:href="#icon-box-remove"></use></svg>
+    <svg id="dnb" onclick="down()"><use xlink:href="#icon-box-add"></use></svg>
+    <svg id="stb" onclick="OpenSettings()"><use xlink:href="#icon-cog"></use></svg>
+  </div>
+</body>
+</html>

usermods/RelayBlinds/presets.json

@@ -0,0 +1 @@
+{"0":{},"2":{"n":"▲","win":"U0=2"},"1":{"n":"▼","win":"U0=1"}}

usermods/RelayBlinds/readme.md

@@ -0,0 +1,8 @@
+# RelayBlinds usermod
+
+This simple usermod toggles two relay pins momentarily (defaults to 500ms) when `userVar0` is set.  
+e.g. can be used to "push" the buttons of a window blinds motor controller.
+
+v1 usermod. Please replace usermod.cpp in the `wled00` directory with the one in this file.
+You may upload `index.htm` to `[WLED-IP]/edit` to replace the default lighting UI with a simple Up/Down button one.  
+A simple `presets.json` file is available. This makes the relay actions controllable via two presets to facilitate control e.g. the default UI or Alexa.

usermods/RelayBlinds/usermod.cpp

@@ -0,0 +1,83 @@
+#include "wled.h"
+
+//Use userVar0 and userVar1 (API calls &U0=,&U1=, uint16_t)
+
+//gets called once at boot. Do all initialization that doesn't depend on network here
+void userSetup()
+{
+  
+}
+
+//gets called every time WiFi is (re-)connected. Initialize own network interfaces here
+void userConnected()
+{
+
+}
+
+/*
+ * Physical IO
+ */
+#define PIN_UP_RELAY 4
+#define PIN_DN_RELAY 5
+#define PIN_ON_TIME  500
+bool upActive = false, upActiveBefore = false, downActive = false, downActiveBefore = false;
+unsigned long upStartTime = 0, downStartTime = 0;
+
+void handleRelay()
+{
+  //up and down relays
+  if (userVar0) {
+    upActive = true;
+    if (userVar0 == 1) {
+      upActive = false;
+      downActive = true;
+    }
+    userVar0 = 0;
+  }
+  
+  if (upActive)
+  {
+    if(!upActiveBefore)
+    {
+      pinMode(PIN_UP_RELAY, OUTPUT);
+      digitalWrite(PIN_UP_RELAY, LOW);
+      upActiveBefore = true;
+      upStartTime = millis();
+      DEBUG_PRINTLN(F("UPA"));
+    }
+    if (millis()- upStartTime > PIN_ON_TIME)
+    {
+      upActive = false;
+      DEBUG_PRINTLN(F("UPN"));
+    }
+  } else if (upActiveBefore)
+  {
+    pinMode(PIN_UP_RELAY, INPUT);
+    upActiveBefore = false;
+  }
+
+  if (downActive)
+  {
+    if(!downActiveBefore)
+    {
+      pinMode(PIN_DN_RELAY, OUTPUT);
+      digitalWrite(PIN_DN_RELAY, LOW);
+      downActiveBefore = true;
+      downStartTime = millis();
+    }
+    if (millis()- downStartTime > PIN_ON_TIME)
+    {
+      downActive = false;
+    }
+  } else if (downActiveBefore)
+  {
+    pinMode(PIN_DN_RELAY, INPUT);
+    downActiveBefore = false;
+  }
+}
+
+//loop. You can use "if (WLED_CONNECTED)" to check for successful connection
+void userLoop()
+{
+  handleRelay();
+}

usermods/SN_Photoresistor/readme.md

@@ -1,7 +1,7 @@
 # SN_Photoresistor usermod
 
-This usermod will read from an attached photoresistor sensor like the KY-018 sensor.
-The luminance is displayed both in the Info section of the web UI as well as published to the `/luminance` MQTT topic if enabled.
+This usermod will read from an attached photoresistor sensor like the KY-018.
+The luminance is displayed in both the Info section of the web UI as well as published to the `/luminance` MQTT topic, if enabled.
 
 ## Installation
 
@@ -9,15 +9,15 @@ Copy the example `platformio_override.ini` to the root directory.  This file sho
 
 ### Define Your Options
 
-* `USERMOD_SN_PHOTORESISTOR`                      - define this to have this user mod included wled00\usermods_list.cpp
-* `USERMOD_SN_PHOTORESISTOR_MEASUREMENT_INTERVAL` - the number of milliseconds between measurements, defaults to 60 seconds
-* `USERMOD_SN_PHOTORESISTOR_FIRST_MEASUREMENT_AT` - the number of milliseconds after boot to take first measurement, defaults to 20 seconds
-* `USERMOD_SN_PHOTORESISTOR_REFERENCE_VOLTAGE`    - the voltage supplied to the sensor, defaults to 5v
-* `USERMOD_SN_PHOTORESISTOR_ADC_PRECISION`        - the ADC precision is the number of distinguishable ADC inputs, defaults to 1024.0 (10 bits)
-* `USERMOD_SN_PHOTORESISTOR_RESISTOR_VALUE`       - the resistor size, defaults to 10000.0 (10K hms)
-* `USERMOD_SN_PHOTORESISTOR_OFFSET_VALUE`         - the offset value to report on, defaults to 25
+* `USERMOD_SN_PHOTORESISTOR`                      - Enables this user mod. wled00\usermods_list.cpp
+* `USERMOD_SN_PHOTORESISTOR_MEASUREMENT_INTERVAL` - Number of milliseconds between measurements. Defaults to 60000 ms
+* `USERMOD_SN_PHOTORESISTOR_FIRST_MEASUREMENT_AT` - Number of milliseconds after boot to take first measurement. Defaults to 20000 ms
+* `USERMOD_SN_PHOTORESISTOR_REFERENCE_VOLTAGE`    - Voltage supplied to the sensor. Defaults to 5v
+* `USERMOD_SN_PHOTORESISTOR_ADC_PRECISION`        - ADC precision. Defaults to 10 bits
+* `USERMOD_SN_PHOTORESISTOR_RESISTOR_VALUE`       - Resistor size, defaults to 10000.0 (10K Ohms)
+* `USERMOD_SN_PHOTORESISTOR_OFFSET_VALUE`         - Offset value to report on. Defaults to 25
 
-All parameters can be configured at runtime using Usermods settings page.
+All parameters can be configured at runtime via the Usermods settings page.
 
 ## Project link
 

usermods/SN_Photoresistor/usermod_sn_photoresistor.h

@@ -22,15 +22,15 @@
 
 // 10 bits
 #ifndef USERMOD_SN_PHOTORESISTOR_ADC_PRECISION
-#define USERMOD_SN_PHOTORESISTOR_ADC_PRECISION 1024.0
+#define USERMOD_SN_PHOTORESISTOR_ADC_PRECISION 1024.0f
 #endif
 
 // resistor size 10K hms
 #ifndef USERMOD_SN_PHOTORESISTOR_RESISTOR_VALUE
-#define USERMOD_SN_PHOTORESISTOR_RESISTOR_VALUE 10000.0
+#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,15 @@ public:
       }
       else
       {
-        DEBUG_PRINTLN("Missing MQTT connection. Not publishing data");
+        DEBUG_PRINTLN(F("Missing MQTT connection. Not publishing data"));
       }
     }
+#endif
+  }
+
+  uint16_t getLastLDRValue()
+  {
+    return lastLDRValue;
   }
 
   void addToJsonInfo(JsonObject &root)

usermods/ST7789_display/README.md

@@ -1,18 +1,21 @@
-# ST7789 TFT IPS Color display 240x240pxwith ESP32 boards
+# Using the ST7789 TFT IPS 240x240 pixel color display with ESP32 boards
 
-This usermod allow to use 240x240 display to display following:
+This usermod enables display of the following:
 
+* Current date and time;
 * Network SSID;
 * IP address;
+* WiFi signal strength;
 * Brightness;
-* Chosen effect;
-* Chosen palette;
+* Selected effect;
+* Selected palette;
+* Effect speed and intensity;
 * Estimated current in mA;
 
 ## Hardware
 
 ***
-![Hardware](images/ST7789_guide.jpg)
+![Hardware](images/ST7789_Guide.jpg)
 
 ## Library used
 
@@ -38,35 +41,37 @@ lib_deps =
 ...
 ```
 
-Also, while in the `platformio.ini` file, you must change the environment setup to build for just the esp32dev platform as follows:
+In the `platformio.ini` file, you must change the environment setup to build for just the esp32dev platform as follows:
 
-Add lines to section:
+Add the following lines to section:
 
 ```ini
 default_envs = esp32dev
 build_flags = ${common.build_flags_esp32}
   -D USERMOD_ST7789_DISPLAY
-
+    -DUSER_SETUP_LOADED=1
+    -DST7789_DRIVER=1
+    -DTFT_WIDTH=240
+    -DTFT_HEIGHT=240
+    -DCGRAM_OFFSET=1
+    -DTFT_MOSI=21
+    -DTFT_SCLK=22
+    -DTFT_DC=27
+    -DTFT_RST=26
+    -DTFT_BL=14
+    -DLOAD_GLCD=1
+    ;optional for WROVER
+    ;-DCONFIG_SPIRAM_SUPPORT=1
 ```
 
-Save the `platformio.ini` file.  Once this is saved, the required library files should be automatically downloaded for modifications in a later step.
+Save the `platformio.ini` file.  Once saved, the required library files should be automatically downloaded for modifications in a later step.
 
 ### TFT_eSPI Library Adjustments
 
-We need to modify a file in the `TFT_eSPI` library. If you followed the directions to modify and save the `platformio.ini` file above, the `User_Setup_Select.h` file can be found in the `/.pio/libdeps/esp32dev/TFT_eSPI` folder.
+If you are not using PlatformIO, you need to modify a file in the `TFT_eSPI` library. If you followed the directions to modify and save the `platformio.ini` file above, the `Setup24_ST7789.h` file can be found in the `/.pio/libdeps/esp32dev/TFT_eSPI/User_Setups/` folder.
 
-Modify the  `User_Setup_Select.h` file as follows:
+Edit `Setup_ST7789.h` file and uncomment and change GPIO pin numbers in lines containing `TFT_MOSI`, `TFT_SCLK`, `TFT_RST`, `TFT_DC`.
 
-* Comment out the following line (which is the 'default' setup file):
+Modify the `User_Setup_Select.h` by uncommenting the line containing `#include <User_Setups/Setup24_ST7789.h>` and commenting out the line containing `#include <User_Setup.h>`.
 
-```ini
-//#include <User_Setup.h>           // Default setup is root library folder
-```
-
-* Add following line:
-
-```ini
-#include <User_Setups/Setup_ST7789_Display.h>    // Setup file for ESP32 ST7789V SPI bus TFT
-```
-
-* Copy file `"Setup_ST7789_Display.h"` from usermod folder to `/.pio/libdeps/esp32dev/TFT_eSPI/User_Setups`
+If your display uses the backlight enable pin, add this definition: #define TFT_BL with backlight enable GPIO number.

usermods/ST7789_display/ST7789_display.h

@@ -7,33 +7,49 @@
 #include <TFT_eSPI.h>
 #include <SPI.h>
 
-#define USERMOD_ST7789_DISPLAY 97
-
-#ifndef TFT_DISPOFF
-#define TFT_DISPOFF 0x28
+#ifndef USER_SETUP_LOADED
+    #ifndef ST7789_DRIVER
+        #error Please define ST7789_DRIVER
+    #endif
+    #ifndef TFT_WIDTH
+        #error Please define TFT_WIDTH
+    #endif
+    #ifndef TFT_HEIGHT
+        #error Please define TFT_HEIGHT
+    #endif
+    #ifndef TFT_DC
+        #error Please define TFT_DC
+    #endif
+    #ifndef TFT_RST
+        #error Please define TFT_RST
+    #endif
+    #ifndef LOAD_GLCD
+        #error Please define LOAD_GLCD
+    #endif
+#endif
+#ifndef TFT_BL
+    #define TFT_BL -1
 #endif
 
-#ifndef TFT_SLPIN
-#define TFT_SLPIN   0x10
-#endif
+#define USERMOD_ID_ST7789_DISPLAY 97
 
-#define TFT_MOSI            21
-#define TFT_SCLK            22
-#define TFT_DC              18
-#define TFT_RST             5
-#define TFT_BL              26  // Display backlight control pin
+TFT_eSPI tft = TFT_eSPI(TFT_WIDTH, TFT_HEIGHT); // Invoke custom library
 
-TFT_eSPI tft = TFT_eSPI(240, 240); // Invoke custom library
+// Extra char (+1) for null
+#define LINE_BUFFER_SIZE          20
 
 // How often we are redrawing screen
 #define USER_LOOP_REFRESH_RATE_MS 1000
 
+extern int getSignalQuality(int rssi);
+
 
 //class name. Use something descriptive and leave the ": public Usermod" part :)
 class St7789DisplayUsermod : public Usermod {
   private:
     //Private class members. You can declare variables and functions only accessible to your usermod here
     unsigned long lastTime = 0;
+    bool enabled = true;
 
     bool displayTurnedOff = false;
     long lastRedraw = 0;
@@ -45,9 +61,70 @@ class St7789DisplayUsermod : public Usermod {
     uint8_t knownBrightness = 0;
     uint8_t knownMode = 0;
     uint8_t knownPalette = 0;
-    uint8_t tftcharwidth = 19;  // Number of chars that fit on screen with text size set to 2
+    uint8_t knownEffectSpeed = 0;
+    uint8_t knownEffectIntensity = 0;
+    uint8_t knownMinute = 99;
+    uint8_t knownHour = 99;
+
+    const uint8_t tftcharwidth = 19;  // Number of chars that fit on screen with text size set to 2
     long lastUpdate = 0;
 
+    void center(String &line, uint8_t width) {
+      int len = line.length();
+      if (len<width) for (byte i=(width-len)/2; i>0; i--) line = ' ' + line;
+      for (byte i=line.length(); i<width; i++) line += ' ';
+    }
+
+    /**
+     * Display the current date and time in large characters
+     * on the middle rows. Based 24 or 12 hour depending on
+     * the useAMPM configuration.
+     */
+    void showTime() {
+        if (!ntpEnabled) return;
+        char lineBuffer[LINE_BUFFER_SIZE];
+
+        updateLocalTime();
+        byte minuteCurrent = minute(localTime);
+        byte hourCurrent   = hour(localTime);
+        //byte secondCurrent = second(localTime);
+        knownMinute = minuteCurrent;
+        knownHour = hourCurrent;
+
+        byte currentMonth = month(localTime);
+        sprintf_P(lineBuffer, PSTR("%s %2d "), monthShortStr(currentMonth), day(localTime));
+        tft.setTextColor(TFT_SILVER);
+        tft.setCursor(84, 0);
+        tft.setTextSize(2);
+        tft.print(lineBuffer);
+
+        byte showHour = hourCurrent;
+        boolean isAM = false;
+        if (useAMPM) {
+            if (showHour == 0) {
+                showHour = 12;
+                isAM = true;
+            } else if (showHour > 12) {
+                showHour -= 12;
+                isAM = false;
+            } else {
+                isAM = true;
+            }
+        }
+
+        sprintf_P(lineBuffer, PSTR("%2d:%02d"), (useAMPM ? showHour : hourCurrent), minuteCurrent);
+        tft.setTextColor(TFT_WHITE);
+        tft.setTextSize(4);
+        tft.setCursor(60, 24);
+        tft.print(lineBuffer);
+
+        tft.setTextSize(2);
+        tft.setCursor(186, 24);
+        //sprintf_P(lineBuffer, PSTR("%02d"), secondCurrent);
+        if (useAMPM) tft.print(isAM ? "AM" : "PM");
+        //else         tft.print(lineBuffer);
+    }
+
   public:
     //Functions called by WLED
 
@@ -55,8 +132,17 @@ 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 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.
         tft.fillScreen(TFT_BLACK);
@@ -65,10 +151,10 @@ class St7789DisplayUsermod : public Usermod {
         tft.setTextDatum(MC_DATUM);
         tft.setTextSize(2);
         tft.print("Loading...");
-        if (TFT_BL > 0) 
-        { // TFT_BL has been set in the TFT_eSPI library
-         pinMode(TFT_BL, OUTPUT); // Set backlight pin to output mode
-         digitalWrite(TFT_BL, HIGH); // Turn backlight on.
+        if (TFT_BL >= 0) 
+        {
+            pinMode(TFT_BL, OUTPUT); // Set backlight pin to output mode
+            digitalWrite(TFT_BL, HIGH); // Turn backlight on.
         }
     }
 
@@ -76,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!");
     }
 
@@ -90,200 +176,161 @@ 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() {
-// Check if we time interval for redrawing passes.
-    if (millis() - lastUpdate < USER_LOOP_REFRESH_RATE_MS)
+    void loop() override {
+        char buff[LINE_BUFFER_SIZE];
+
+        // Check if we time interval for redrawing passes.
+        if (millis() - lastUpdate < USER_LOOP_REFRESH_RATE_MS)
         {
             return;
         }
-    lastUpdate = millis();
+        lastUpdate = millis();
   
-// Turn off display after 5 minutes with no change.
-    if(!displayTurnedOff && millis() - lastRedraw > 5*60*1000)
+        // Turn off display after 5 minutes with no change.
+        if (!displayTurnedOff && millis() - lastRedraw > 5*60*1000)
         {
-            digitalWrite(TFT_BL, LOW); // Turn backlight off. 
+            if (TFT_BL >= 0) digitalWrite(TFT_BL, LOW); // Turn backlight off. 
             displayTurnedOff = true;
         } 
 
-// Check if values which are shown on display changed from the last time.
-    if (((apActive) ? String(apSSID) : WiFi.SSID()) != knownSsid)
-    {
-    needRedraw = true;
-    }
-    else if (knownIp != (apActive ? IPAddress(4, 3, 2, 1) : WiFi.localIP()))
-    {
-    needRedraw = true;
-    }
-    else if (knownBrightness != bri)
-    {
-    needRedraw = true;
-    }
-    else if (knownMode != strip.getMode())
-    {
-    needRedraw = true;
-    }
-    else if (knownPalette != strip.getSegment(0).palette)
-    {
-    needRedraw = true;
-    }
-
-    if (!needRedraw)
-    {
-    return;
-    }
-    needRedraw = false;
-  
-    if (displayTurnedOff)
-    {
-        digitalWrite(TFT_BL, TFT_BACKLIGHT_ON); // Turn backlight on.
-        displayTurnedOff = false;
-    }
-    lastRedraw = millis();
-
-// Update last known values.
-    #if defined(ESP8266)
-        knownSsid = apActive ? WiFi.softAPSSID() : WiFi.SSID();
-    #else
-        knownSsid = WiFi.SSID();
-    #endif
-    knownIp = apActive ? IPAddress(4, 3, 2, 1) : WiFi.localIP();
-    knownBrightness = bri;
-    knownMode = strip.getMode();
-    knownPalette = strip.getSegment(0).palette;
-
-    tft.fillScreen(TFT_BLACK);
-    tft.setTextSize(2);
-// First row with Wifi name
-    tft.setTextColor(TFT_SILVER);
-    tft.setCursor(3, 40);
-    tft.print(knownSsid.substring(0, tftcharwidth > 1 ? tftcharwidth - 1 : 0));
-// Print `~` char to indicate that SSID is longer, than our dicplay
-    if (knownSsid.length() > tftcharwidth)
-        tft.print("~");
-
-// Second row with AP IP and Password or IP
-    tft.setTextColor(TFT_GREEN);
-    tft.setTextSize(2);
-    tft.setCursor(3, 64);
-// Print AP IP and password in AP mode or knownIP if AP not active.
-
-    if (apActive)
-    {
-    tft.setTextColor(TFT_YELLOW);
-    tft.print("AP IP: ");
-    tft.print(knownIp);
-    tft.setCursor(3,86);
-    tft.setTextColor(TFT_YELLOW);
-    tft.print("AP Pass:");
-    tft.print(apPass);
-    }
-    else
-    {
-    tft.setTextColor(TFT_GREEN);
-    tft.print("IP: ");
-    tft.print(knownIp);
-    tft.setCursor(3,86);
-    //tft.print("Signal Strength: ");
-    //tft.print(i.wifi.signal);
-    tft.setTextColor(TFT_WHITE);
-    tft.print("Bri: ");
-    tft.print(((float(bri)/255)*100),0);
-    tft.print("%");
-    }
-
-// Third row with mode name
-    tft.setCursor(3, 108);
-    uint8_t qComma = 0;
-    bool insideQuotes = false;
-    uint8_t printedChars = 0;
-    char singleJsonSymbol;
-// Find the mode name in JSON
-    for (size_t i = 0; i < strlen_P(JSON_mode_names); i++)
-    {
-        singleJsonSymbol = pgm_read_byte_near(JSON_mode_names + i);
-        switch (singleJsonSymbol)
+        // Check if values which are shown on display changed from the last time.
+        if ((((apActive) ? String(apSSID) : WiFi.SSID()) != knownSsid) ||
+            (knownIp != (apActive ? IPAddress(4, 3, 2, 1) : Network.localIP())) ||
+            (knownBrightness != bri) ||
+            (knownEffectSpeed != strip.getMainSegment().speed) ||
+            (knownEffectIntensity != strip.getMainSegment().intensity) ||
+            (knownMode != strip.getMainSegment().mode) ||
+            (knownPalette != strip.getMainSegment().palette))
         {
-            case '"':
-            insideQuotes = !insideQuotes;
-        break;
-        case '[':
-        case ']':
-        break;
-        case ',':
-        qComma++;
-        default:
-            if (!insideQuotes || (qComma != knownMode))
-            break;
-        tft.setTextColor(TFT_MAGENTA);
-        tft.print(singleJsonSymbol);
-        printedChars++;
+            needRedraw = true;
         }
-    if ((qComma > knownMode) || (printedChars > tftcharwidth - 1))
-      break;
-    }
-// Fourth row with palette name
-    tft.setTextColor(TFT_YELLOW);
-    tft.setCursor(3, 130);
-    qComma = 0;
-    insideQuotes = false;
-    printedChars = 0;
-// Looking for palette name in JSON.
-    for (size_t i = 0; i < strlen_P(JSON_palette_names); i++)
-    {
-    singleJsonSymbol = pgm_read_byte_near(JSON_palette_names + i);
-        switch (singleJsonSymbol)
+
+        if (!needRedraw)
         {
-        case '"':
-        insideQuotes = !insideQuotes;
-        break;
-        case '[':
-        case ']':
-        break;
-        case ',':
-        qComma++;
-        default:
-            if (!insideQuotes || (qComma != knownPalette))
-            break;
-        tft.print(singleJsonSymbol);
-        printedChars++;
+            return;
         }
-// The following is modified from the code from the u8g2/u8g8 based code (knownPalette was knownMode)
-    if ((qComma > knownPalette) || (printedChars > tftcharwidth - 1))
-      break;
-    }
-// Fifth row with estimated mA usage
-    tft.setTextColor(TFT_SILVER);
-    tft.setCursor(3, 152);
-// Print estimated milliamp usage (must specify the LED type in LED prefs for this to be a reasonable estimate).
-    tft.print("Current: ");
-    tft.print(strip.currentMilliamps);
-    tft.print("mA");
+        needRedraw = false;
+    
+        if (displayTurnedOff)
+        {
+            digitalWrite(TFT_BL, HIGH); // Turn backlight on.
+            displayTurnedOff = false;
+        }
+        lastRedraw = millis();
+
+        // Update last known values.
+        #if defined(ESP8266)
+            knownSsid = apActive ? WiFi.softAPSSID() : WiFi.SSID();
+        #else
+            knownSsid = WiFi.SSID();
+        #endif
+        knownIp = apActive ? IPAddress(4, 3, 2, 1) : WiFi.localIP();
+        knownBrightness = bri;
+        knownMode = strip.getMainSegment().mode;
+        knownPalette = strip.getMainSegment().palette;
+        knownEffectSpeed = strip.getMainSegment().speed;
+        knownEffectIntensity = strip.getMainSegment().intensity;
+
+        tft.fillScreen(TFT_BLACK);
+
+        showTime();
+
+        tft.setTextSize(2);
+
+        // Wifi name
+        tft.setTextColor(TFT_GREEN);
+        tft.setCursor(0, 60);
+        String line = knownSsid.substring(0, tftcharwidth-1);
+        // Print `~` char to indicate that SSID is longer, than our display
+        if (knownSsid.length() > tftcharwidth) line = line.substring(0, tftcharwidth-1) + '~';
+        center(line, tftcharwidth);
+        tft.print(line.c_str());
+
+        // Print AP IP and password in AP mode or knownIP if AP not active.
+        if (apActive)
+        {
+            tft.setCursor(0, 84);
+            tft.print("AP IP: ");
+            tft.print(knownIp);
+            tft.setCursor(0,108);
+            tft.print("AP Pass:");
+            tft.print(apPass);
+        }
+        else
+        {
+            tft.setCursor(0, 84);
+            line = knownIp.toString();
+            center(line, tftcharwidth);
+            tft.print(line.c_str());
+            // percent brightness
+            tft.setCursor(0, 120);
+            tft.setTextColor(TFT_WHITE);
+            tft.print("Bri: ");
+            tft.print((((int)bri*100)/255));
+            tft.print("%");
+            // signal quality
+            tft.setCursor(124,120);
+            tft.print("Sig: ");
+            if (getSignalQuality(WiFi.RSSI()) < 10) {
+                tft.setTextColor(TFT_RED);
+            } else if (getSignalQuality(WiFi.RSSI()) < 25) {
+                tft.setTextColor(TFT_ORANGE);
+            } else {
+                tft.setTextColor(TFT_GREEN);
+            }
+            tft.print(getSignalQuality(WiFi.RSSI()));
+            tft.setTextColor(TFT_WHITE);
+            tft.print("%");
+        }
+
+        // mode name
+        tft.setTextColor(TFT_CYAN);
+        tft.setCursor(0, 144);
+        char lineBuffer[tftcharwidth+1];
+        extractModeName(knownMode, JSON_mode_names, lineBuffer, tftcharwidth);
+        tft.print(lineBuffer);
+
+        // palette name
+        tft.setTextColor(TFT_YELLOW);
+        tft.setCursor(0, 168);
+        extractModeName(knownPalette, JSON_palette_names, lineBuffer, tftcharwidth);
+        tft.print(lineBuffer);
+
+        tft.setCursor(0, 192);
+        tft.setTextColor(TFT_SILVER);
+        sprintf_P(buff, PSTR("FX  Spd:%3d Int:%3d"), effectSpeed, effectIntensity);
+        tft.print(buff);
+
+        // Fifth row with estimated mA usage
+        tft.setTextColor(TFT_SILVER);
+        tft.setCursor(0, 216);
+        // 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(BusManager::currentMilliamps());
+        tft.print("mA");
     }
+
     /*
      * 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)
+    void addToJsonInfo(JsonObject& root) override
     {
-      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 lightArr = user.createNestedArray("Light"); //name
-      lightArr.add(reading); //value
-      lightArr.add(" lux"); //unit
+      JsonArray lightArr = user.createNestedArray("ST7789"); //name
+      lightArr.add(enabled?F("installed"):F("disabled")); //unit
     }
-    */
 
 
     /*
      * 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;
     }
@@ -293,9 +340,9 @@ 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
+      //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!"));
     }
 
@@ -314,13 +361,25 @@ 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("exampleUsermod");
-      top["great"] = userVar0; //save this var persistently whenever settings are saved
+      JsonObject top = root.createNestedObject("ST7789");
+      JsonArray pins = top.createNestedArray("pin");
+      pins.add(TFT_CS);
+      pins.add(TFT_DC);
+      pins.add(TFT_RST);
+      pins.add(TFT_BL);
+      //top["great"] = userVar0; //save this var persistently whenever settings are saved
     }
 
 
+    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)
@@ -329,10 +388,11 @@ 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 :)
      */
-    void 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)
+      //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)
+      return true;
     }
 
 
@@ -340,9 +400,9 @@ 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_ST7789_DISPLAY;
+      return USERMOD_ID_ST7789_DISPLAY;
     }
 
    //More methods can be added in the future, this example will then be extended.

usermods/ST7789_display/Setup_ST7789_Display.h

@@ -1,39 +0,0 @@
-// Setup for the ESP32 board with 1.5" 240x240 display
-
-// See SetupX_Template.h for all options available
-
-#define ST7789_DRIVER
-#define TFT_SDA_READ   // Display has a bidirectionsl SDA pin
-
-#define TFT_WIDTH  240
-#define TFT_HEIGHT 240
-
-#define CGRAM_OFFSET      // Library will add offsets required
-
-//#define TFT_MISO -1
-
-#define TFT_MOSI            21
-#define TFT_SCLK            22
-//#define TFT_CS              5
-#define TFT_DC              18
-#define TFT_RST             5
-
-#define TFT_BL          26  // Display backlight control pin
-
-#define TFT_BACKLIGHT_ON HIGH  // HIGH or LOW are options
-
-#define LOAD_GLCD
-#define LOAD_FONT2
-#define LOAD_FONT4
-#define LOAD_FONT6
-#define LOAD_FONT7
-#define LOAD_FONT8
-#define LOAD_GFXFF
-
-//#define SMOOTH_FONT
-
-//#define SPI_FREQUENCY  27000000
-  #define SPI_FREQUENCY  40000000   // Maximum for ILI9341
-
-
-#define SPI_READ_FREQUENCY  6000000 // 6 MHz is the maximum SPI read speed for the ST7789V

usermods/Si7021_MQTT_HA/readme.md

@@ -0,0 +1,69 @@
+# Si7021 to MQTT (with Home Assistant Auto Discovery) usermod
+
+This usermod implements support for [Si7021 I²C temperature and humidity sensors](https://www.silabs.com/documents/public/data-sheets/Si7021-A20.pdf).
+
+As of this writing, the sensor data will *not* be shown on the WLED UI, but it _is_ published via MQTT to WLED's "built-in" MQTT device topic. 
+
+```
+temperature: $mqttDeviceTopic/si7021_temperature
+humidity: $mqttDeviceTopic/si7021_humidity
+```
+
+The following sensors can also be published:
+
+```
+heat_index: $mqttDeviceTopic/si7021_heat_index
+dew_point: $mqttDeviceTopic/si7021_dew_point
+absolute_humidity: $mqttDeviceTopic/si7021_absolute_humidity
+```
+
+Sensor data will be updated/sent every 60 seconds.
+
+This usermod also supports Home Assistant Auto Discovery.
+
+## Settings via Usermod Setup
+
+- `enabled`: Enables this usermod
+- `Send Dew Point, Abs. Humidity and Heat Index`: Enables additional sensors
+- `Home Assistant MQTT Auto-Discovery`: Enables Home Assistant Auto Discovery
+
+# Installation
+
+## Hardware
+
+Attach the Si7021 sensor to the I²C interface.
+
+Default PINs ESP32:
+
+```
+SCL_PIN = 22;
+SDA_PIN = 21;
+```
+
+Default PINs ESP8266:
+
+```
+SCL_PIN = 5;
+SDA_PIN = 4;
+```
+
+## Software
+
+Add to `build_flags` in platformio.ini:
+
+```
+   -D USERMOD_SI7021_MQTT_HA
+```
+
+Add to `lib_deps` in platformio.ini:
+
+```
+   adafruit/Adafruit Si7021 Library @ 1.4.0
+   BME280@~3.0.0
+```
+
+# Credits
+
+- Aircoookie for making WLED
+- Other usermod creators for example code (`sensors_to_mqtt` and `multi_relay` especially)
+- You, for reading this

usermods/Si7021_MQTT_HA/usermod_si7021_mqtt_ha.h

@@ -0,0 +1,231 @@
+#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)
+// and usermod_multi_relay.h (multi_relay usermod)
+
+#include "wled.h"
+#include <Adafruit_Si7021.h>
+#include <EnvironmentCalculations.h> // EnvironmentCalculations::HeatIndex(), ::DewPoint(), ::AbsoluteHumidity()
+
+Adafruit_Si7021 si7021;
+
+class Si7021_MQTT_HA : public Usermod
+{
+  private:
+    bool sensorInitialized = false;
+    bool mqttInitialized = false;
+    float sensorTemperature = 0;
+    float sensorHumidity = 0;
+    float sensorHeatIndex = 0;
+    float sensorDewPoint = 0;
+    float sensorAbsoluteHumidity= 0;
+    String mqttTemperatureTopic = "";
+    String mqttHumidityTopic = "";
+    String mqttHeatIndexTopic = "";
+    String mqttDewPointTopic = "";
+    String mqttAbsoluteHumidityTopic = "";
+    unsigned long nextMeasure = 0;
+    bool enabled = false;
+    bool haAutoDiscovery = true;
+    bool sendAdditionalSensors = true;
+
+    // strings to reduce flash memory usage (used more than twice)
+    static const char _name[];
+    static const char _enabled[];
+    static const char _sendAdditionalSensors[];
+    static const char _haAutoDiscovery[];
+
+    void _initializeSensor()
+    {
+      sensorInitialized = si7021.begin();
+      Serial.printf("Si7021_MQTT_HA: sensorInitialized = %d\n", sensorInitialized);
+    }
+
+    void _initializeMqtt()
+    {
+      mqttTemperatureTopic = String(mqttDeviceTopic) + "/si7021_temperature";
+      mqttHumidityTopic = String(mqttDeviceTopic) + "/si7021_humidity";
+      mqttHeatIndexTopic = String(mqttDeviceTopic) + "/si7021_heat_index";
+      mqttDewPointTopic = String(mqttDeviceTopic) + "/si7021_dew_point";
+      mqttAbsoluteHumidityTopic = String(mqttDeviceTopic) + "/si7021_absolute_humidity";
+
+      // Update and publish sensor data
+      _updateSensorData();
+      _publishSensorData();
+
+      if (haAutoDiscovery) {
+        _publishHAMqttSensor("temperature", "Temperature", mqttTemperatureTopic, "temperature", "°C");
+        _publishHAMqttSensor("humidity", "Humidity", mqttHumidityTopic, "humidity", "%");
+        if (sendAdditionalSensors) {
+          _publishHAMqttSensor("heat_index", "Heat Index", mqttHeatIndexTopic, "temperature", "°C");
+          _publishHAMqttSensor("dew_point", "Dew Point", mqttDewPointTopic, "", "°C");
+          _publishHAMqttSensor("absolute_humidity", "Absolute Humidity", mqttAbsoluteHumidityTopic, "", "g/m³");
+        }
+      }
+      
+      mqttInitialized = true;
+    }
+
+    void _publishHAMqttSensor(
+      const String &name, 
+      const String &friendly_name, 
+      const String &state_topic, 
+      const String &deviceClass, 
+      const String &unitOfMeasurement)
+    {
+      if (WLED_MQTT_CONNECTED) {
+        String topic = String("homeassistant/sensor/") + mqttClientID + "/" + name + "/config";
+
+        StaticJsonDocument<300> doc;
+
+        doc["name"] = String(serverDescription) + " " + friendly_name;
+        doc["state_topic"] = state_topic;
+        doc["unique_id"] = String(mqttClientID) + name;
+        if (unitOfMeasurement != "")
+          doc["unit_of_measurement"] = unitOfMeasurement;
+        if (deviceClass != "")
+          doc["device_class"] = deviceClass;
+        doc["expire_after"] = 1800;
+
+        JsonObject device = doc.createNestedObject("device"); // attach the sensor to the same device
+        device["name"] = String(serverDescription);
+        device["model"] = F(WLED_PRODUCT_NAME);
+        device["manufacturer"] = F(WLED_BRAND);
+        device["identifiers"] = String("wled-") + String(serverDescription);
+        device["sw_version"] = VERSION;
+
+        String payload;
+        serializeJson(doc, payload);
+
+        mqtt->publish(topic.c_str(), 0, true, payload.c_str());
+      }
+    }
+
+    void _updateSensorData()
+    {
+      sensorTemperature = si7021.readTemperature();
+      sensorHumidity = si7021.readHumidity();
+
+      // Serial.print("Si7021_MQTT_HA: Temperature: ");
+      // Serial.print(sensorTemperature, 2);
+      // Serial.print("\tHumidity: ");
+      // Serial.print(sensorHumidity, 2);
+
+      if (sendAdditionalSensors) {
+        EnvironmentCalculations::TempUnit envTempUnit(EnvironmentCalculations::TempUnit_Celsius);
+        sensorHeatIndex = EnvironmentCalculations::HeatIndex(sensorTemperature, sensorHumidity, envTempUnit);
+        sensorDewPoint = EnvironmentCalculations::DewPoint(sensorTemperature, sensorHumidity, envTempUnit);
+        sensorAbsoluteHumidity = EnvironmentCalculations::AbsoluteHumidity(sensorTemperature, sensorHumidity, envTempUnit);
+
+        // Serial.print("\tHeat Index: ");
+        // Serial.print(sensorHeatIndex, 2);
+        // Serial.print("\tDew Point: ");
+        // Serial.print(sensorDewPoint, 2);
+        // Serial.print("\tAbsolute Humidity: ");
+        // Serial.println(sensorAbsoluteHumidity, 2);
+      }
+      // else
+      //   Serial.println("");
+    }
+
+    void _publishSensorData()
+    {
+      if (WLED_MQTT_CONNECTED) {
+        mqtt->publish(mqttTemperatureTopic.c_str(), 0, false, String(sensorTemperature).c_str());
+        mqtt->publish(mqttHumidityTopic.c_str(), 0, false, String(sensorHumidity).c_str());
+        if (sendAdditionalSensors) {
+          mqtt->publish(mqttHeatIndexTopic.c_str(), 0, false, String(sensorHeatIndex).c_str());
+          mqtt->publish(mqttDewPointTopic.c_str(), 0, false, String(sensorDewPoint).c_str());
+          mqtt->publish(mqttAbsoluteHumidityTopic.c_str(), 0, false, String(sensorAbsoluteHumidity).c_str());
+        }
+      }
+    }
+
+  public:
+    void addToConfig(JsonObject& root)
+    {
+      JsonObject top = root.createNestedObject(FPSTR(_name));
+      
+      top[FPSTR(_enabled)] = enabled;
+      top[FPSTR(_sendAdditionalSensors)] = sendAdditionalSensors;
+      top[FPSTR(_haAutoDiscovery)] = haAutoDiscovery;
+    }
+
+    bool readFromConfig(JsonObject& root)
+    {
+      JsonObject top = root[FPSTR(_name)];
+      
+      bool configComplete = !top.isNull();
+      configComplete &= getJsonValue(top[FPSTR(_enabled)], enabled);
+      configComplete &= getJsonValue(top[FPSTR(_sendAdditionalSensors)], sendAdditionalSensors);
+      configComplete &= getJsonValue(top[FPSTR(_haAutoDiscovery)], haAutoDiscovery);
+
+      return configComplete;
+    }
+
+    void onMqttConnect(bool sessionPresent) {
+      if (mqttDeviceTopic[0] != 0)
+        _initializeMqtt();
+    }
+
+    void setup()
+    {
+      if (enabled) {
+        Serial.println("Si7021_MQTT_HA: Starting!");
+        Serial.println("Si7021_MQTT_HA: Initializing sensors.. ");
+        _initializeSensor();
+      }
+    }
+
+    // gets called every time WiFi is (re-)connected.
+    void connected()
+    {
+      nextMeasure = millis() + 5000; // Schedule next measure in 5 seconds
+    }
+
+    void loop()
+    {
+      yield();
+      if (!enabled || strip.isUpdating()) return; // !sensorFound || 
+
+      unsigned long tempTimer = millis();
+
+      if (tempTimer > nextMeasure) {
+        nextMeasure = tempTimer + 60000; // Schedule next measure in 60 seconds
+
+        if (!sensorInitialized) {
+          Serial.println("Si7021_MQTT_HA: Error! Sensors not initialized in loop()!");
+          _initializeSensor();
+          return; // lets try again next loop
+        }
+
+        if (WLED_MQTT_CONNECTED) {
+          if (!mqttInitialized)
+            _initializeMqtt();
+
+          // Update and publish sensor data
+          _updateSensorData();
+          _publishSensorData();
+        }
+        else {
+          Serial.println("Si7021_MQTT_HA: Missing MQTT connection. Not publishing data");
+          mqttInitialized = false;
+        }
+      }
+    }
+    
+    uint16_t getId()
+    {
+      return USERMOD_ID_SI7021_MQTT_HA;
+    }
+};
+
+// strings to reduce flash memory usage (used more than twice)
+const char Si7021_MQTT_HA::_name[]                   PROGMEM = "Si7021 MQTT (Home Assistant)";
+const char Si7021_MQTT_HA::_enabled[]                PROGMEM = "enabled";
+const char Si7021_MQTT_HA::_sendAdditionalSensors[]  PROGMEM = "Send Dew Point, Abs. Humidity and Heat Index";
+const char Si7021_MQTT_HA::_haAutoDiscovery[]        PROGMEM = "Home Assistant MQTT Auto-Discovery";

usermods/TTGO-T-Display/README.md

@@ -1,19 +1,19 @@
 # TTGO T-Display ESP32 with 240x135 TFT via SPI with TFT_eSPI
-This usermod allows use of the TTGO T-Display ESP32 module with integrated 240x135 display
+This usermod enables use of the TTGO 240x135 T-Display ESP32 module
 for controlling WLED and showing the following information: 
 * Current SSID
-* IP address if obtained
-  * If connected to a network, current brightness % is shown 
-  * in AP mode AP IP and password are shown
+* IP address, if obtained
+  * If connected to a network, current brightness percentage is shown 
+  * In AP mode, AP, IP and password are shown
 * Current effect
 * Current palette
-* Estimated current in mA is shown (NOTE: for this to be a reasonable value, the correct LED type must be specified in the LED Prefs section)
+* Estimated current in mA (NOTE: for this to be a reasonable value, the correct LED type must be specified in the LED Prefs section)
 
-Button pin is mapped to the onboard button next to the side actuated reset button of the TTGO T-Display board.
+Button pin is mapped to the onboard button adjacent to the reset button of the TTGO T-Display board.
 
-I have designed a 3D printed case around this board and an ["ElectroCookie"](https://amzn.to/2WCNeeA) project board, a [level shifter](https://amzn.to/3hbKu18), a [buck regulator](https://amzn.to/3mLMy0W), and a DC [power jack](https://amzn.to/3phj9NZ).  I use 12V WS2815 LED strips for my projects, and power them with 12V power supplies, so the regulator drops the voltage to the 5V level I need to power the ESP module and the level shifter.  If there is any interest in this case, which elevates the board and display on some custom extended headers to make place the screen at the top of the enclosure (with accessible buttons), let me know, and I could post the STL files.  It is a bit tricky to get the height correct, so I also designed a one-time use 3D printed solder fixture to set the board in the right location and at the correct height for the housing.  (It is one-time use because it has to be cut off after soldering to be able to remove it).  I didn't think the effort to make it in multiple pieces was worthwhile.
+I have designed a 3D printed case around this board and an ["ElectroCookie"](https://amzn.to/2WCNeeA) project board, a [level shifter](https://amzn.to/3hbKu18), a [buck regulator](https://amzn.to/3mLMy0W), and a DC [power jack](https://amzn.to/3phj9NZ).  I use 12V WS2815 LED strips for my projects, and power them with 12V power supplies. The regulator supplies 5V for the ESP module and the level shifter.  If there is any interest in this case which elevates the board and display on custom extended standoffs to place the screen at the top of the enclosure (with accessible buttons), let me know, and I will post the STL files.  It is a bit tricky to get the height correct, so I also designed a one-time use 3D printed solder fixture to set the board in the right location and at the correct height for the housing.  (It is one-time use because it has to be cut off after soldering to be able to remove it).  I didn't think the effort to make it in multiple pieces was worthwhile.
 
-Usermod based on a rework of the ssd1306_i2c_oled_u8g2 usermod from the WLED repo.
+Based on a rework of the ssd1306_i2c_oled_u8g2 usermod from the WLED repo.
 
 ## Hardware
 ![Hardware](assets/ttgo_hardware1.png)
@@ -30,8 +30,8 @@ Usermod based on a rework of the ssd1306_i2c_oled_u8g2 usermod from the WLED rep
 Functionality checked with:
 * TTGO T-Display
 * PlatformIO
-* Group of 4 individual Neopixels from Adafruit, and a several full strings of 12v WS2815 LEDs.
-* The hardware design shown above should be limited to shorter strings.  For larger strings, I use a different setup with a dedicated 12v power supply and power them directly off the supply (in addition to dropping the 12v supply down to 5v with a buck regulator for the ESP module and level shifter).
+* Group of 4 individual Neopixels from Adafruit and several full strings of 12v WS2815 LEDs.
+* The hardware design shown above should be limited to shorter strings.  For larger strings, I use a different setup with a dedicated 12v power supply and power them directly from said supply (in addition to dropping the 12v to 5v with a buck regulator for the ESP module and level shifter).
 
 ## Setup Needed:
 * As with all usermods, copy the usermod.cpp file from the TTGO-T-Display usermod folder to the wled00 folder (replacing the default usermod.cpp file).
@@ -51,24 +51,24 @@ lib_deps =
 ...
 ```
 
-Also, while in the `platformio.ini` file, you must change the environment setup to build for just the esp32dev platform as follows:
+In the `platformio.ini` file, you must change the environment setup to build for just the esp32dev platform as follows:
 
 Comment out the line described below:
 ```ini
-# Travis CI binaries (comment this out when building for single board)
-; default_envs = travis_esp8266, esp01, esp01_1m_ota, travis_esp32
+# Release binaries
+; default_envs = nodemcuv2, esp8266_2m, esp01_1m_full, esp32dev, esp32_eth, esp32s2_saola, esp32c3
 ```
-and UNCOMMENT the following line in the 'Single binaries' section:
+and uncomment the following line in the 'Single binaries' section:
 ```ini
 default_envs = esp32dev
 ```
-Save the `platformio.ini` file.  Once this is saved, the required library files should be automatically downloaded for modifications in a later step.
+Save the `platformio.ini` file.  Once saved, the required library files should be automatically downloaded for modifications in a later step.
 
 ### Platformio_overrides.ini (added)
 Copy the `platformio_overrides.ini` file which is contained in the `usermods/TTGO-T-Display/` folder into the root of your project folder. This file contains an override that remaps the button pin of WLED to use the on-board button to the right of the USB-C connector (when viewed with the port oriented downward - see hardware photo).
 
 ### TFT_eSPI Library Adjustments (board selection)
-We need to modify a file in the `TFT_eSPI` library to select the correct board.  If you followed the directions to modify and save the `platformio.ini` file above, the `User_Setup_Select.h` file can be found in the `/.pio/libdeps/esp32dev/TFT_eSPI_ID1559` folder.
+You need to modify a file in the `TFT_eSPI` library to select the correct board.  If you followed the directions to modify and save the `platformio.ini` file above, the `User_Setup_Select.h` file can be found in the `/.pio/libdeps/esp32dev/TFT_eSPI_ID1559` folder.
 
 Modify the  `User_Setup_Select.h` file as follows:
 * Comment out the following line (which is the 'default' setup file):
@@ -80,12 +80,12 @@ Modify the  `User_Setup_Select.h` file as follows:
 #include <User_Setups/Setup25_TTGO_T_Display.h>    // Setup file for ESP32 and TTGO T-Display ST7789V SPI bus TFT
 ```
 
-Run the build and it should complete correctly.  If you see a failure like this:
+Build the file.  If you see a failure like this:
 ```ini
 xtensa-esp32-elf-g++: error: wled00\wled00.ino.cpp: No such file or directory
 xtensa-esp32-elf-g++: fatal error: no input files
 ```
-Just try building again - I find that sometimes this happens on the first build attempt and subsequent attempts will build correctly.
+try building again. Sometimes this happens on the first build attempt and subsequent attempts build correctly.
 
 ## Arduino IDE
-- UNTESTED
+- UNTESTED

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
  */
 
 /*
@@ -110,9 +110,9 @@ void userLoop() {
     needRedraw = true;
   } else if (knownBrightness != bri) {
     needRedraw = true;
-  } else if (knownMode != strip.getMode()) {
+  } else if (knownMode != strip.getMainSegment().mode) {
     needRedraw = true;
-  } else if (knownPalette != strip.getSegment(0).palette) {
+  } else if (knownPalette != strip.getMainSegment().palette) {
     needRedraw = true;
   }
 
@@ -136,15 +136,15 @@ void userLoop() {
   #endif
   knownIp = apActive ? IPAddress(4, 3, 2, 1) : WiFi.localIP();
   knownBrightness = bri;
-  knownMode = strip.getMode();
-  knownPalette = strip.getSegment(0).palette;
+  knownMode = strip.getMainSegment().mode;
+  knownPalette = strip.getMainSegment().palette;
 
   tft.fillScreen(TFT_BLACK);
   tft.setTextSize(2);
   // 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("~");
 
@@ -177,58 +177,15 @@ void userLoop() {
 
   // Third row with mode name
   tft.setCursor(1, 68);
-  uint8_t qComma = 0;
-  bool insideQuotes = false;
-  uint8_t printedChars = 0;
-  char singleJsonSymbol;
-  // Find the mode name in JSON
-  for (size_t i = 0; i < strlen_P(JSON_mode_names); i++) {
-    singleJsonSymbol = pgm_read_byte_near(JSON_mode_names + i);
-    switch (singleJsonSymbol) {
-    case '"':
-      insideQuotes = !insideQuotes;
-      break;
-    case '[':
-    case ']':
-      break;
-    case ',':
-      qComma++;
-    default:
-      if (!insideQuotes || (qComma != knownMode))
-        break;
-      tft.print(singleJsonSymbol);
-      printedChars++;
-    }
-    if ((qComma > knownMode) || (printedChars > tftcharwidth - 1))
-      break;
-  }
+  char lineBuffer[tftcharwidth+1];
+  extractModeName(knownMode, JSON_mode_names, lineBuffer, tftcharwidth);
+  tft.print(lineBuffer);
+
   // Fourth row with palette name
   tft.setCursor(1, 90);
-  qComma = 0;
-  insideQuotes = false;
-  printedChars = 0;
-  // Looking for palette name in JSON.
-  for (size_t i = 0; i < strlen_P(JSON_palette_names); i++) {
-    singleJsonSymbol = pgm_read_byte_near(JSON_palette_names + i);
-    switch (singleJsonSymbol) {
-    case '"':
-      insideQuotes = !insideQuotes;
-      break;
-    case '[':
-    case ']':
-      break;
-    case ',':
-      qComma++;
-    default:
-      if (!insideQuotes || (qComma != knownPalette))
-        break;
-      tft.print(singleJsonSymbol);
-      printedChars++;
-    }
-    // The following is modified from the code from the u8g2/u8g8 based code (knownPalette was knownMode)
-    if ((qComma > knownPalette) || (printedChars > tftcharwidth - 1))
-      break;
-  }
+  extractModeName(knownPalette, JSON_palette_names, lineBuffer, tftcharwidth);
+  tft.print(lineBuffer);
+
   // Fifth row with estimated mA usage
   tft.setCursor(1, 112);
   // Print estimated milliamp usage (must specify the LED type in LED prefs for this to be a reasonable estimate).

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

@@ -1,22 +1,24 @@
 # Temperature usermod
 
-Based on the excellent `QuinLED_Dig_Uno_Temp_MQTT` by srg74 and 400killer!  
-This usermod will read from an attached DS18B20 temperature sensor (as available on the QuinLED Dig-Uno)  
-The temperature is displayed both in the Info section of the web UI as well as published to the `/temperature` MQTT topic if enabled.  
-This usermod may be expanded with support for different sensor types in the future.
+Based on the excellent `QuinLED_Dig_Uno_Temp_MQTT` usermod by srg74 and 400killer!  
+Reads an attached DS18B20 temperature sensor (as available on the QuinLED Dig-Uno)  
+Temperature is displayed in both the Info section of the web UI as well as published to the `/temperature` MQTT topic, if enabled.  
+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`.
 
 ### Define Your Options
 
-* `USERMOD_DALLASTEMPERATURE`                      - define this to have this user mod included wled00\usermods_list.cpp
-* `USERMOD_DALLASTEMPERATURE_FIRST_MEASUREMENT_AT` - the number of milliseconds after boot to take first measurement, defaults to 20 seconds
+* `USERMOD_DALLASTEMPERATURE`                      - enables this user mod wled00/usermods_list.cpp
+* `USERMOD_DALLASTEMPERATURE_MEASUREMENT_INTERVAL` - number of milliseconds between measurements, defaults to 60000 ms (60s)
 
-All parameters can be configured at runtime using Usermods settings page, including pin, selection to display temerature in degrees Celsius or Farenheit mand 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 using Usermods settings page, includ
 
 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,16 +44,20 @@ 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
 
 2020-09-12 
-* Changed to use async, non-blocking implementation
-* Do not report low temperatures that indicate an error to mqtt
+* Changed to use async non-blocking implementation
+* Do not report erroneous low temperatures to MQTT
 * Disable plugin if temperature sensor not detected
 * Report the number of seconds until the first read in the info screen instead of sensor error
 2021-04
-* Adaptation for runtime configuration.
+* 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
@@ -37,267 +38,415 @@ class UsermodTemperature : public Usermod {
     // used to determine when we can read the sensors temperature
     // we have to wait at least 93.75 ms after requestTemperatures() is called
     unsigned long lastTemperaturesRequest;
-    float temperature = -100; // default to -100, DS18B20 only goes down to -50C
+    float temperature;
     // indicates requestTemperatures has been called but the sensor measurement is not complete
     bool waitingForConversion = false;
     // flag set at startup if DS18B20 sensor not found, avoids trying to keep getting
     // temperature if flashed to a board without a sensor attached
-    bool sensorFound = false;
+    byte sensorFound;
 
     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 i;
-      byte data[2];
-      int16_t result;                         // raw data from sensor
-      if (!oneWire->reset()) return -127.0f;  // send reset command and fail fast
-      oneWire->skip();                        // skip ROM
-      oneWire->write(0xBE);                   // read (temperature) from EEPROM
-      for (i=0; i < 2; i++) data[i] = oneWire->read();  // first 2 bytes contain temperature
-      for (i=2; i < 8; i++) oneWire->read();  // read unused bytes  
-      result = (data[1]<<4) | (data[0]>>4);   // we only need whole part, we will add fraction when returning
-      if (data[1]&0x80) result |= 0xFF00;     // fix negative value
-      oneWire->reset();
-      oneWire->skip();                        // skip ROM
-      oneWire->write(0x44,parasite);          // request new temperature reading (without parasite power)
-      return (float)result + ((data[0]&0x0008) ? 0.5f : 0.0f);
-    }
-
-    void requestTemperatures() {
-      readDallas();
-      lastTemperaturesRequest = millis();
-      waitingForConversion = true;
-      DEBUG_PRINTLN(F("Requested temperature."));
-    }
-
-    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."));
-              return true;
-          }
-        }
-      }
-      return false;
-    }
+    float readDallas();
+    void requestTemperatures();
+    void readTemperature();
+    bool findSensor();
+#ifndef WLED_DISABLE_MQTT
+    void publishHomeAssistantAutodiscovery();
+#endif
 
   public:
 
-    void setup() {
-      int retries = 10;
-      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()) {
-            sensorFound = false;   // resetting 1-Wire bus yielded an error
-          } else {
-            while ((sensorFound=findSensor()) && retries--) {
-              delay(25); // try to find sensor
-            }
-          }
-        } else {
-          if (temperaturePin >= 0) {
-            DEBUG_PRINTLN(F("Temperature pin allocation failed."));
-          }
-          temperaturePin = -1;  // allocation failed
-          sensorFound = false;
-        }
-      }
-      lastMeasurement = millis() - readingInterval + 10000;
-      initDone = true;
-    }
-
-    void loop() {
-      if (!enabled || strip.isUpdating()) return;
-
-      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 >= 100 /* 93.75ms per the datasheet but can be up to 750ms */) {
-        readTemperature();
-
-        if (WLED_MQTT_CONNECTED) {
-          char subuf[64];
-          strcpy(subuf, mqttDeviceTopic);
-          if (-100 <= temperature) {
-            // 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(temperature).c_str());
-            strcat_P(subuf, PSTR("_f"));
-            mqtt->publish(subuf, 0, false, String((float)temperature * 1.8f + 32).c_str());
-          } else {
-            // publish something else to indicate status?
-          }
-        }
-      }
-    }
-
     /*
      * 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));
-      //temp.add(F("Loaded."));
-
-      if (temperature <= -100.0 || (!sensorFound && temperature == -1.0)) {
-        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 ? temperature : (float)temperature * 1.8f + 32);
-      if (degC) temp.add(F("°C"));
-      else      temp.add(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;
+  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_PRINT(FPSTR(_name));
-        DEBUG_PRINTLN(F(": No config found. (Using defaults.)"));
-        return false;
-      }
-
-      enabled           = top[FPSTR(_enabled)] | enabled;
-      newTemperaturePin = top["pin"] | newTemperaturePin;
-//      newTemperaturePin = min(33,max(-1,(int)newTemperaturePin)); // bounds check
-      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;
-
-      DEBUG_PRINT(FPSTR(_name));
-      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__ */