Merge branch 'main' into power-ap

.github/ISSUE_TEMPLATE/bug.yml

@@ -56,6 +56,9 @@ body:
       options:
         - ESP8266
         - ESP32
+        - ESP32-S3
+        - ESP32-S2
+        - ESP32-C3
         - Other
     validations:
       required: true

.gitignore

@@ -18,3 +18,4 @@ wled-update.sh
 esp01-update.sh
 /wled00/LittleFS
 replace_fs.py
+wled00/wled00.ino.cpp

CHANGELOG.md

@@ -1,5 +1,92 @@
 ## WLED changelog
 
+#### 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"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "wled",
-  "version": "0.14.0-b0",
+  "version": "0.14.0-b2",
   "description": "Tools for WLED project",
   "main": "tools/cdata.js",
   "directories": {
@@ -25,7 +25,7 @@
     "clean-css": "^4.2.3",
     "html-minifier-terser": "^5.1.1",
     "inliner": "^1.13.1",
-    "nodemon": "^2.0.4",
+    "nodemon": "^2.0.20",
     "zlib": "^1.0.5"
   }
 }

platformio.ini

@@ -6,16 +6,14 @@
 # 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)
+# Release / CI binaries
-; default_envs = travis_esp8266, travis_esp32
+default_envs = nodemcuv2, esp8266_2m, esp01_1m_full, esp32dev, esp32_eth, esp32s2_saola, esp32c3, esp32s3dev_8MB
-
-# Release binaries
-default_envs = nodemcuv2, esp8266_2m, esp01_1m_full, esp32dev, esp32_eth, esp32s2_saola, esp32c3
 
 # Build everything
-; default_envs = esp32dev, esp8285_4CH_MagicHome, codm-controller-0.6-rev2, codm-controller-0.6, esp32s2_saola, d1_mini_5CH_Shojo_PCB, d1_mini, sp501e, travis_esp8266, travis_esp32, nodemcuv2, esp32_eth, anavi_miracle_controller, esp07, esp01_1m_full, m5atom, h803wf, d1_mini_ota, heltec_wifi_kit_8, esp8285_H801, d1_mini_debug, wemos_shield_esp32, elekstube_ips
+; default_envs = esp32dev, esp8285_4CH_MagicHome, codm-controller-0.6-rev2, codm-controller-0.6, esp32s2_saola, d1_mini_5CH_Shojo_PCB, d1_mini, sp501e, nodemcuv2, esp32_eth, anavi_miracle_controller, esp07, esp01_1m_full, m5atom, h803wf, d1_mini_ota, heltec_wifi_kit_8, esp8285_H801, d1_mini_debug, wemos_shield_esp32, elekstube_ips
 
 # Single binaries (uncomment your board)
 ; default_envs = elekstube_ips
@@ -113,6 +111,7 @@ build_flags =
   -D DECODE_SONY=true
   -D DECODE_SAMSUNG=true
   -D DECODE_LG=true
+  ; -Dregister= # remove warnings in C++17 due to use of deprecated register keyword by the FastLED library
   -DWLED_USE_MY_CONFIG
   ; -D USERMOD_SENSORSTOMQTT
   #For ADS1115 sensor uncomment following
@@ -120,13 +119,6 @@ build_flags =
 
 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}
 
@@ -159,7 +151,7 @@ upload_speed = 115200
 #   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
+#     ArduinoJson@5.13.5, E131@1.0.0(changed), Time@1.5, Timezone@1.2.1
 # ------------------------------------------------------------------------------
 lib_compat_mode = strict
 lib_deps =
@@ -222,6 +214,7 @@ build_flags = -g
   -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 builing with arduino-esp32 >=2.0.3
 
 default_partitions = tools/WLED_ESP32_4MB_1MB_FS.csv
 
@@ -238,6 +231,9 @@ build_flags = -g
   -DCONFIG_IDF_TARGET_ESP32S2
   -D CONFIG_ASYNC_TCP_USE_WDT=0
   -DCO
+  -DARDUINO_USB_MODE=0 ;; this flag is mandatory for ESP32-S2 !
+  ;; please make sure that the following flags are properly set (to 0 or 1) by your board.json, or included in your custom platformio_override.ini entry:
+  ;; ARDUINO_USB_CDC_ON_BOOT, ARDUINO_USB_MSC_ON_BOOT, ARDUINO_USB_DFU_ON_BOOT
 
 lib_deps =
   ${env.lib_deps}
@@ -251,6 +247,9 @@ build_flags = -g
   -DCONFIG_IDF_TARGET_ESP32C3
   -D CONFIG_ASYNC_TCP_USE_WDT=0
   -DCO
+  -DARDUINO_USB_MODE=1 ;; this flag is mandatory for ESP32-C3
+  ;; please make sure that the following flags are properly set (to 0 or 1) by your board.json, or included in your custom platformio_override.ini entry:
+  ;; ARDUINO_USB_CDC_ON_BOOT
 
 lib_deps =
   ${env.lib_deps}
@@ -266,11 +265,13 @@ build_flags = -g
   -DCONFIG_IDF_TARGET_ESP32S3
   -D CONFIG_ASYNC_TCP_USE_WDT=0
   -DCO
+  ;; please make sure that the following flags are properly set (to 0 or 1) by your board.json, or included in your custom platformio_override.ini entry:
+  ;; ARDUINO_USB_MODE, ARDUINO_USB_CDC_ON_BOOT, ARDUINO_USB_MSC_ON_BOOT, ARDUINO_USB_DFU_ON_BOOT
 
 lib_deps =
   ${env.lib_deps}
-  ;; currently we need the latest NeoPixelBus dev version, because it contains important bugfixes for -S3
+  ;; NeoPixelBus 2.7.1 is the first that has official support for ESP32-S3
-  https://github.com/Makuna/NeoPixelBus.git#master @ 2.7.0
+  makuna/NeoPixelBus @ ~2.7.1
   https://github.com/pbolduc/AsyncTCP.git @ 1.2.0
 
 
@@ -284,7 +285,7 @@ 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
 
@@ -349,7 +350,7 @@ board = esp32dev
 platform = ${esp32.platform}
 platform_packages = ${esp32.platform_packages}
 build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp32} -D WLED_RELEASE_NAME=ESP32 #-D WLED_DISABLE_BLYNK #-D WLED_DISABLE_BROWNOUT_DET
+build_flags = ${common.build_flags_esp32} -D WLED_RELEASE_NAME=ESP32 #-D WLED_DISABLE_BROWNOUT_DET
 lib_deps = ${esp32.lib_deps}
 monitor_filters = esp32_exception_decoder
 board_build.partitions = ${esp32.default_partitions}
@@ -359,7 +360,7 @@ board = esp32dev
 platform = ${esp32.platform}
 platform_packages = ${esp32.platform_packages}
 build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp32} -D WLED_RELEASE_NAME=ESP32_qio80 #-D WLED_DISABLE_BLYNK #-D WLED_DISABLE_BROWNOUT_DET
+build_flags = ${common.build_flags_esp32} -D WLED_RELEASE_NAME=ESP32_qio80 #-D WLED_DISABLE_BROWNOUT_DET
 lib_deps = ${esp32.lib_deps}
 monitor_filters = esp32_exception_decoder
 board_build.partitions = ${esp32.default_partitions}
@@ -372,7 +373,7 @@ platform = ${esp32.platform}
 platform_packages = ${esp32.platform_packages}
 upload_speed = 921600
 build_unflags = ${common.build_unflags}
-build_flags = ${common.build_flags_esp32} -D WLED_RELEASE_NAME=ESP32_Ethernet -D RLYPIN=-1 -D WLED_USE_ETHERNET -D BTNPIN=-1 -D WLED_DISABLE_BLYNK
+build_flags = ${common.build_flags_esp32} -D WLED_RELEASE_NAME=ESP32_Ethernet -D RLYPIN=-1 -D WLED_USE_ETHERNET -D BTNPIN=-1
 lib_deps = ${esp32.lib_deps}
 board_build.partitions = ${esp32.default_partitions}
 
@@ -385,15 +386,18 @@ 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
 lib_deps = ${esp32s2.lib_deps}
 
 [env:esp32c3]
-platform = espressif32@5.1.1
+platform = espressif32@5.1.1    ;; well-tested on -C3, good compatibility with WLED
+; platform = espressif32@~5.2.0 ;; might help in case you experience bootloops due to corrupted flash filesystem
 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
+  ; -DARDUINO_USB_CDC_ON_BOOT=1 ;; for virtual USB
 upload_speed = 460800
 build_unflags = ${common.build_unflags}
 lib_deps = ${esp32c3.lib_deps}
@@ -403,13 +407,18 @@ lib_deps = ${esp32c3.lib_deps}
 board = esp32-s3-devkitc-1
 platform = espressif32@5.1.1
 platform_packages =
-upload_speed = 921600
+upload_speed = 921600 ; or  460800
 build_unflags = ${common.build_unflags}
-build_flags =  ${common.build_flags} ${esp32s3.build_flags} -D CONFIG_LITTLEFS_FOR_IDF_3_2 -D WLED_WATCHDOG_TIMEOUT=0 -D ARDUINO_USB_MODE=1 -D ARDUINO_USB_CDC_ON_BOOT=0 -D ARDUINO_USB_MSC_ON_BOOT=0
+build_flags =  ${common.build_flags} ${esp32s3.build_flags} 
+  -D CONFIG_LITTLEFS_FOR_IDF_3_2 -D WLED_WATCHDOG_TIMEOUT=0
+  -D ARDUINO_USB_CDC_ON_BOOT=0 -D ARDUINO_USB_MSC_ON_BOOT=0 -D ARDUINO_DFU_ON_BOOT=0 -D ARDUINO_USB_MODE=1 ;; for boards with serial-to-USB chip
+  ;-D ARDUINO_USB_CDC_ON_BOOT=1 -D ARDUINO_USB_MSC_ON_BOOT=0 -D ARDUINO_DFU_ON_BOOT=0 ; -D ARDUINO_USB_MODE=0 ;; for boards with USB-OTG connector only (USBCDC or "TinyUSB")
+  ;-D WLED_DEBUG
 lib_deps = ${esp32s3.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
 
 [env:esp32s3dev_8MB_PSRAM]
@@ -422,8 +431,8 @@ platform_packages =
 upload_speed = 921600
 build_unflags = ${common.build_unflags}
 build_flags =  ${common.build_flags} ${esp32s3.build_flags} 
-  -D CONFIG_LITTLEFS_FOR_IDF_3_2 -D WLED_WATCHDOG_TIMEOUT=0 -D ARDUINO_USB_MODE=1 -D ARDUINO_USB_MSC_ON_BOOT=0 
+  -D CONFIG_LITTLEFS_FOR_IDF_3_2 -D WLED_WATCHDOG_TIMEOUT=0
-  ; -D ARDUINO_USB_CDC_ON_BOOT=0
+  -D ARDUINO_USB_MODE=1 -D ARDUINO_USB_MSC_ON_BOOT=0 ; -D ARDUINO_USB_CDC_ON_BOOT=0
   ; -D WLED_RELEASE_NAME=ESP32-S3_PSRAM
   -D WLED_USE_PSRAM -DBOARD_HAS_PSRAM ; tells WLED that PSRAM shall be used
 lib_deps = ${esp32s3.lib_deps}
@@ -565,20 +574,58 @@ board_build.ldscript = ${common.ldscript_2m512k}
 build_flags = ${common.build_flags_esp8266} -D LEDPIN=3 -D BTNPIN=2 -D IRPIN=5 -D WLED_MAX_BUTTONS=3
 lib_deps = ${esp8266.lib_deps}
 
-[env:athom7w]
+[env:Athom_RGBCW]        ;7w and 5w(GU10) bulbs
-board = esp_wroom_02
+board = esp8285
 platform = ${common.platform_wled_default}
+platform_packages = ${common.platform_packages}
 board_build.ldscript = ${common.ldscript_2m512k}
-build_flags = ${common.build_flags_esp8266} -D WLED_MAX_CCT_BLEND=0 -D BTNPIN=-1 -D IRPIN=-1 -D WLED_DISABLE_INFRARED
+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:athom15w]
+
-board = esp_wroom_02
+[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_flags = ${common.build_flags_esp8266} -D WLED_USE_IC_CCT -D BTNPIN=-1 -D IRPIN=-1 -D WLED_DISABLE_INFRARED
+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}
@@ -588,22 +635,6 @@ 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}
 
-# ------------------------------------------------------------------------------
-# 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
@@ -640,7 +671,6 @@ build_flags = ${common.build_flags_esp32} -D WLED_DISABLE_BROWNOUT_DET -D WLED_D
   -D LEDPIN=12
   -D RLYPIN=27
   -D BTNPIN=34
-  -D WLED_DISABLE_BLYNK
   -D DEFAULT_LED_COUNT=6
   # Display config
   -D ST7789_DRIVER

platformio_override.ini.sample

@@ -26,7 +26,6 @@ build_flags = ${common.build_flags_esp8266}
 ; disable specific features
 ;  -D WLED_DISABLE_OTA
 ;  -D WLED_DISABLE_ALEXA
-;  -D WLED_DISABLE_BLYNK
 ;  -D WLED_DISABLE_HUESYNC
 ;  -D WLED_DISABLE_INFRARED
 ;  -D WLED_DISABLE_WEBSOCKETS

readme.md

@@ -15,11 +15,11 @@
 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  
+- Segments to set different effects and colors to user defined parts of the LED string  
-- Settings page - configuration over network  
+- 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  
@@ -28,14 +28,13 @@ A fast and feature-rich implementation of an ESP8266/ESP32 webserver to control
 - Nightlight function (gradually dims down)  
 - Full OTA software updatability (HTTP + ArduinoOTA), password protectable  
 - Configurable analog clock (Cronixie, 7-segment and EleksTube IPS clock support via usermods) 
-- Configurable Auto Brightness limit for safer operation  
+- 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  
 - 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,7 +50,7 @@ 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://kno.wled.ge/basics/tutorials/) 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!
 
 ## 🖼️ 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%">
@@ -70,12 +69,16 @@ 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>
 
 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

@@ -14,7 +14,7 @@ async-timeout==4.0.2
     # via zeroconf
 bottle==0.12.23
     # via platformio
-certifi==2022.6.15
+certifi==2022.12.7
     # via requests
 charset-normalizer==2.1.1
     # via requests
@@ -23,9 +23,7 @@ click==8.1.3
     #   platformio
     #   uvicorn
 colorama==0.4.5
-    # via
+    # via platformio
-    #   click
-    #   platformio
 h11==0.13.0
     # via
     #   uvicorn
@@ -58,8 +56,6 @@ starlette==0.20.4
     # via platformio
 tabulate==0.8.10
     # via platformio
-typing-extensions==4.3.0
-    # via starlette
 urllib3==1.26.11
     # via requests
 uvicorn==0.18.2

tools/cdata.js

@@ -220,6 +220,7 @@ function writeChunks(srcDir, specs, resultFile) {
 
 writeHtmlGzipped("wled00/data/index.htm", "wled00/html_ui.h", 'index');
 writeHtmlGzipped("wled00/data/simple.htm", "wled00/html_simple.h", 'simple');
+writeHtmlGzipped("wled00/data/pixart/pixart.htm", "wled00/html_pixart.h", 'pixart');
 /*
 writeChunks(
   "wled00/data",

usermods/ADS1115_v2/readme.md

@@ -2,7 +2,7 @@
 
 This usermod will read from an ADS1115 ADC. The voltages are displayed in the Info section of the web UI.
 
-Configuration is all completed via the Usermod menu. There are no settings to set in code!
+Configuration is performed via the Usermod menu. There are no parameters to set in code!
 
 ## Installation 
 

usermods/Analog_Clock/Analog_Clock.h

@@ -203,45 +203,45 @@ public:
     void addToConfig(JsonObject& root) override {
         validateAndUpdate();
 
-        JsonObject top = root.createNestedObject("Analog Clock");
+        JsonObject top = root.createNestedObject(F("Analog Clock"));
-        top["Overlay Enabled"]               = enabled;
+        top[F("Overlay Enabled")]               = enabled;
-        top["First LED (Main Ring)"]         = mainSegment.firstLed;
+        top[F("First LED (Main Ring)")]         = mainSegment.firstLed;
-        top["Last LED (Main Ring)"]          = mainSegment.lastLed;
+        top[F("Last LED (Main Ring)")]          = mainSegment.lastLed;
-        top["Center/12h LED (Main Ring)"]    = mainSegment.centerLed;
+        top[F("Center/12h LED (Main Ring)")]    = mainSegment.centerLed;
-        top["Hour Marks Enabled"]            = hourMarksEnabled;
+        top[F("Hour Marks Enabled")]            = hourMarksEnabled;
-        top["Hour Mark Color (RRGGBB)"]      = colorToHexString(hourMarkColor);
+        top[F("Hour Mark Color (RRGGBB)")]      = colorToHexString(hourMarkColor);
-        top["Hour Color (RRGGBB)"]           = colorToHexString(hourColor);
+        top[F("Hour Color (RRGGBB)")]           = colorToHexString(hourColor);
-        top["Minute Color (RRGGBB)"]         = colorToHexString(minuteColor);
+        top[F("Minute Color (RRGGBB)")]         = colorToHexString(minuteColor);
-        top["Show Seconds"]                  = secondsEnabled;
+        top[F("Show Seconds")]                  = secondsEnabled;
-        top["First LED (Seconds Ring)"]      = secondsSegment.firstLed;
+        top[F("First LED (Seconds Ring)")]      = secondsSegment.firstLed;
-        top["Last LED (Seconds Ring)"]       = secondsSegment.lastLed;
+        top[F("Last LED (Seconds Ring)")]       = secondsSegment.lastLed;
-        top["Center/12h LED (Seconds Ring)"] = secondsSegment.centerLed;
+        top[F("Center/12h LED (Seconds Ring)")] = secondsSegment.centerLed;
-        top["Second Color (RRGGBB)"]         = colorToHexString(secondColor);
+        top[F("Second Color (RRGGBB)")]         = colorToHexString(secondColor);
-        top["Seconds Effect (0-1)"]          = secondsEffect;
+        top[F("Seconds Effect (0-1)")]          = secondsEffect;
-        top["Blend Colors"]                  = blendColors;
+        top[F("Blend Colors")]                  = blendColors;
     }
 
     bool readFromConfig(JsonObject& root) override {
-        JsonObject top = root["Analog Clock"];
+        JsonObject top = root[F("Analog Clock")];
 
         bool configComplete = !top.isNull();
 
         String color;
-        configComplete &= getJsonValue(top["Overlay Enabled"], enabled, false);
+        configComplete &= getJsonValue(top[F("Overlay Enabled")], enabled, false);
-        configComplete &= getJsonValue(top["First LED (Main Ring)"], mainSegment.firstLed, 0);
+        configComplete &= getJsonValue(top[F("First LED (Main Ring)")], mainSegment.firstLed, 0);
-        configComplete &= getJsonValue(top["Last LED (Main Ring)"], mainSegment.lastLed, 59);
+        configComplete &= getJsonValue(top[F("Last LED (Main Ring)")], mainSegment.lastLed, 59);
-        configComplete &= getJsonValue(top["Center/12h LED (Main Ring)"], mainSegment.centerLed, 0);
+        configComplete &= getJsonValue(top[F("Center/12h LED (Main Ring)")], mainSegment.centerLed, 0);
-        configComplete &= getJsonValue(top["Hour marks Enabled"], hourMarksEnabled, false);
+        configComplete &= getJsonValue(top[F("Hour Marks Enabled")], hourMarksEnabled, false);
-        configComplete &= getJsonValue(top["Hour mark Color (RRGGBB)"], color, "FF0000") && hexStringToColor(color, hourMarkColor, 0x0000FF);
+        configComplete &= getJsonValue(top[F("Hour Mark Color (RRGGBB)")], color, F("161616")) && hexStringToColor(color, hourMarkColor, 0x161616);
-        configComplete &= getJsonValue(top["Hour Color (RRGGBB)"], color, "0000FF") && hexStringToColor(color, hourColor, 0x0000FF);
+        configComplete &= getJsonValue(top[F("Hour Color (RRGGBB)")], color, F("0000FF")) && hexStringToColor(color, hourColor, 0x0000FF);
-        configComplete &= getJsonValue(top["Minute Color (RRGGBB)"], color, "00FF00") && hexStringToColor(color, minuteColor, 0x00FF00);
+        configComplete &= getJsonValue(top[F("Minute Color (RRGGBB)")], color, F("00FF00")) && hexStringToColor(color, minuteColor, 0x00FF00);
-        configComplete &= getJsonValue(top["Show Seconds"], secondsEnabled, true);
+        configComplete &= getJsonValue(top[F("Show Seconds")], secondsEnabled, true);
-        configComplete &= getJsonValue(top["First LED (Seconds Ring)"], secondsSegment.firstLed, 0);
+        configComplete &= getJsonValue(top[F("First LED (Seconds Ring)")], secondsSegment.firstLed, 0);
-        configComplete &= getJsonValue(top["Last LED (Seconds Ring)"], secondsSegment.lastLed, 59);
+        configComplete &= getJsonValue(top[F("Last LED (Seconds Ring)")], secondsSegment.lastLed, 59);
-        configComplete &= getJsonValue(top["Center/12h LED (Seconds Ring)"], secondsSegment.centerLed, 0);
+        configComplete &= getJsonValue(top[F("Center/12h LED (Seconds Ring)")], secondsSegment.centerLed, 0);
-        configComplete &= getJsonValue(top["Second Color (RRGGBB)"], color, "FF0000") && hexStringToColor(color, secondColor, 0xFF0000);
+        configComplete &= getJsonValue(top[F("Second Color (RRGGBB)")], color, F("FF0000")) && hexStringToColor(color, secondColor, 0xFF0000);
-        configComplete &= getJsonValue(top["Seconds Effect (0-1)"], secondsEffect, 0);
+        configComplete &= getJsonValue(top[F("Seconds Effect (0-1)")], secondsEffect, 0);
-        configComplete &= getJsonValue(top["Blend Colors"], blendColors, true);
+        configComplete &= getJsonValue(top[F("Blend Colors")], blendColors, true);
 
         if (initDone) {
             validateAndUpdate();

usermods/Animated_Staircase/Animated_Staircase.h

@@ -92,12 +92,14 @@ class Animated_Staircase : public Usermod {
     static const char _bottomEchoCm[];
     
     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() {
@@ -345,6 +347,7 @@ class Animated_Staircase : public Usermod {
 
     uint16_t getId() { return USERMOD_ID_ANIMATED_STAIRCASE; }
 
+#ifndef WLED_DISABLE_MQTT
     /**
      * handling of MQTT message
      * topic only contains stripped topic (part after /wled/MAC)
@@ -382,6 +385,7 @@ class Animated_Staircase : public Usermod {
         mqtt->subscribe(subuf, 0);
       }
     }
+#endif
 
     void addToJsonState(JsonObject& root) {
       JsonObject staircase = root[FPSTR(_name)];

usermods/Animated_Staircase/README.md

@@ -1,14 +1,14 @@
 # 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).
@@ -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.
+You can configure usermod using the Usermods settings page.
-Please enter GPIO pins for PIR sensors or ultrasonic sensor (trigger and echo).
+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.
+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
+2. Connect the ESP8266 pin D4 or ESP32 pin D2 to the first LED data pin at the bottom step.
-   of your stairs.
 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
@@ -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, includng 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
+**Please note:** 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
+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
+In addition to activation by one of the stair sensors, you can also trigger the animation manually
-the API. To simulate triggering the bottom sensor, use:
+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

usermods/BH1750_v2/readme.md

@@ -1,7 +1,7 @@
 # BH1750 usermod
 
-This usermod will read from an ambient light sensor like the BH1750 sensor.
+This usermod will read from an ambient light sensor like the BH1750.
-The luminance is displayed both in the Info section of the web UI as well as published to the `/luminance` MQTT topic if enabled.
+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
@@ -28,9 +28,9 @@ The following settings can be set at compile-time but are configurable on the us
 *   `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 10 seconds
+*   `USERMOD_BH1750_FIRST_MEASUREMENT_AT` - the number of milliseconds after boot to take first measurement, defaults to 10000 ms
 
-In addition, on the Usermod screen allows you to:
+In addition, the Usermod screen allows you to:
 - enable/disable the usermod
 - Enable Home Assistant Discovery of usermod
 - Configure the SCL/SDA pins
@@ -44,6 +44,6 @@ Jul 2022
 - Added Home Assistant Discovery
 - Implemented PinManager to register pins
 - Made pins configurable in usermod menu
-- Added API call to read illuminance from other modules
+- Added API call to read luminance from other modules
 - Enhanced info-screen outputs
 - Updated `readme.md`

usermods/BH1750_v2/usermod_bh1750.h

@@ -1,6 +1,10 @@
 // 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"
@@ -156,6 +160,7 @@ public:
     {
       lastLux = lux;
       lastSend = millis();
+#ifndef WLED_DISABLE_MQTT
       if (WLED_MQTT_CONNECTED)
       {
         if (!mqttInitialized)
@@ -170,6 +175,7 @@ public:
       {
         DEBUG_PRINTLN(F("Missing MQTT connection. Not publishing data"));
       }
+#endif
     }
   }
 

usermods/BME280_v2/README.md

@@ -6,14 +6,14 @@ This Usermod is designed to read a `BME280` or `BMP280` sensor and output the fo
 - Heat Index (`BME280` only)
 - Dew Point (`BME280` only)
 
-Configuration is all completed via the Usermod menu.  There are no settings to set in code!  The following settings can be configured in the Usermod Menu:
+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 reads of temperature and humidity)
+- 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 Farenheit)
+- Use Celsius (turn off to use Fahrenheit)
 - Home Assistant Discovery (turn on to sent MQTT Discovery entries for Home Assistant)
 - SCL/SDA GPIO Pins
 
@@ -23,7 +23,7 @@ Dependencies
   - `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 listening on the serial TX pin of your board will get confused by log messages!
+- 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.
 
@@ -37,7 +37,7 @@ Methods also exist to read the read/calculated values from other WLED modules th
 - `getHeatIndexC()`
 - `getHeatIndexF()`
 
-# Complilation
+# Compiling
 
 To enable, compile with `USERMOD_BME280` defined  (e.g. in `platformio_override.ini`)
 ```ini
@@ -63,7 +63,7 @@ Pressure | `<deviceTopic>/pressure`
 Heat index | `<deviceTopic>/heat_index`
 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 seperate from the main WLED device and will contain sensors for Pressure, Humidity, Temperature, Dew Point and Heat Index.
+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
@@ -82,8 +82,8 @@ Apr 2021
 
 Dec 2020
 - Ported to V2 Usermod format
-- Customisable `measure intervals`
+- Customizable `measure intervals`
-- Customisable number of `decimal places` in published sensor values
+- 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

usermods/BME280_v2/usermod_bme280.h

@@ -1,6 +1,10 @@
 // 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"

usermods/Battery/battery_defaults.h

@@ -0,0 +1,72 @@
+// 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
+
+#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 posibilities
+
+## 🎈 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 parralel sumed 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,773 @@
+#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;
+    // 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);
+      }      
+    }
+
+  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;
+          }
+
+        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);
+      #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;
+
+#ifdef ARDUINO_ARCH_ESP32
+      // use calibrated millivolts analogread on esp32 (150 mV ~ 2450 mV)
+      rawValue = analogReadMilliVolts(batteryPin);
+      // calculate the voltage
+      voltage = (rawValue / 1000.0f) + calibration;
+      // usually a voltage divider (50%) is used on ESP32, so we need to multiply by 2
+      voltage *= 2.0f;
+#else
+      // read battery raw input
+      rawValue = analogRead(batteryPin);
+
+      // calculate the voltage     
+      voltage = ((rawValue / getAdcPrecision()) * maxBatteryVoltage) + calibration;
+#endif
+      // check if voltage is within specified voltage range, allow 10% over/under 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[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;
+
+      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);
+      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 choosen adc precision
+     * esp8266 = 10bit resolution = 1024.0f 
+     * esp32 = 12bit resolution = 4095.0f
+     */
+    float getAdcPrecision()
+    {
+      #ifdef ARDUINO_ARCH_ESP32
+        // esp32
+        return 4096.0f;
+      #else
+        // esp8266
+        return 1024.0f;
+      #endif
+    }
+
+    /*
+     * 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;
+    }
+
+
+    /*
+     * Get auto-off feature enabled status
+     * is auto-off enabled, true/false
+     */
+    bool getAutoOffEnabled()
+    {
+      return autoOffEnabled;
+    }
+
+    /*
+     * Set auto-off feature status 
+     */
+    void setAutoOffEnabled(bool enabled)
+    {
+      autoOffEnabled = enabled;
+    }
+    
+    /*
+     * Get auto-off threshold in percent (0-100)
+     */
+    int8_t getAutoOffThreshold()
+    {
+      return autoOffThreshold;
+    }
+
+    /*
+     * Set auto-off threshold in percent (0-100) 
+     */
+    void setAutoOffThreshold(int8_t threshold)
+    {
+      autoOffThreshold = min((int8_t)100, max((int8_t)0, threshold));
+      // when low power indicator is enabled the auto-off threshold cannot be above indicator threshold
+      autoOffThreshold  = lowPowerIndicatorEnabled /*&& autoOffEnabled*/ ? min(lowPowerIndicatorThreshold-1, (int)autoOffThreshold) : autoOffThreshold;
+    }
+
+
+    /*
+     * Get low-power-indicator feature enabled status
+     * is the low-power-indicator enabled, true/false
+     */
+    bool getLowPowerIndicatorEnabled()
+    {
+      return lowPowerIndicatorEnabled;
+    }
+
+    /*
+     * Set low-power-indicator feature status 
+     */
+    void setLowPowerIndicatorEnabled(bool enabled)
+    {
+      lowPowerIndicatorEnabled = enabled;
+    }
+
+    /*
+     * Get low-power-indicator preset to activate when low power is detected
+     */
+    int8_t getLowPowerIndicatorPreset()
+    {
+      return lowPowerIndicatorPreset;
+    }
+
+    /* 
+     * Set low-power-indicator preset to activate when low power is detected
+     */
+    void setLowPowerIndicatorPreset(int8_t presetId)
+    {
+      // String tmp = ""; For what ever reason this doesn't work :(
+      // lowPowerIndicatorPreset = getPresetName(presetId, tmp) ? presetId : lowPowerIndicatorPreset;
+      lowPowerIndicatorPreset = presetId;
+    }
+
+    /*
+     * Get low-power-indicator threshold in percent (0-100)
+     */
+    int8_t getLowPowerIndicatorThreshold()
+    {
+      return lowPowerIndicatorThreshold;
+    }
+
+    /*
+     * Set low-power-indicator threshold in percent (0-100)
+     */
+    void setLowPowerIndicatorThreshold(int8_t threshold)
+    {
+      lowPowerIndicatorThreshold = threshold;
+      // when auto-off is enabled the indicator threshold cannot be below auto-off threshold
+      lowPowerIndicatorThreshold  = autoOffEnabled /*&& lowPowerIndicatorEnabled*/ ? max(autoOffThreshold+1, (int)lowPowerIndicatorThreshold) : max(5, (int)lowPowerIndicatorThreshold);
+    }
+
+    /*
+     * Get low-power-indicator duration in seconds
+     */
+    int8_t getLowPowerIndicatorDuration()
+    {
+      return lowPowerIndicatorDuration;
+    }
+
+    /*
+     * Set low-power-indicator duration in seconds
+     */
+    void setLowPowerIndicatorDuration(int8_t duration)
+    {
+      lowPowerIndicatorDuration = duration;
+    }
+
+
+    /*
+     * Get low-power-indicator status when the indication is done thsi returns true
+     */
+    bool getLowPowerIndicatorDone()
+    {
+      return lowPowerIndicationDone;
+    }
+};
+
+// strings to reduce flash memory usage (used more than twice)
+const char UsermodBattery::_name[]          PROGMEM = "Battery";
+const char UsermodBattery::_readInterval[]  PROGMEM = "interval";
+const char UsermodBattery::_enabled[]       PROGMEM = "enabled";
+const char UsermodBattery::_threshold[]     PROGMEM = "threshold";
+const char UsermodBattery::_preset[]        PROGMEM = "preset";
+const char UsermodBattery::_duration[]      PROGMEM = "duration";
+const char UsermodBattery::_init[]          PROGMEM = "init";

usermods/Cronixie/usermod_cronixie.h

@@ -271,6 +271,7 @@ class UsermodCronixie : public Usermod {
     {
       if (root["nx"].is<const char*>()) {
         strncpy(cronixieDisplay, root["nx"], 6);
+        setCronixie();
       }
     }
 

usermods/DHT/readme.md

@@ -1,11 +1,11 @@
 # 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 (and optionally send to a MQTT broker).
+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
+If enabled, measured temperature and humidity will be published to the following MQTT topics
 * `{devceTopic}/dht/temperature`
 * `{devceTopic}/dht/humidity`
 
@@ -15,13 +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_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 60 seconds
+* `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 90 seconds
+* `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 the MQTT broker
+* `USERMOD_DHT_MQTT`                 - publish measurements to an MQTT broker
 * `USERMOD_DHT_STATS`                - For debug, report delay stats
 
 ## Project link
@@ -35,11 +35,11 @@ If you are using `platformio_override.ini`, you should be able to refresh the ta
 
 ## Change Log
 2022-10-15
-* Add possibility to publish sensor readings to an MQTT broker
+* 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

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>
 

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
+    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 methosd 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() {
+      // do your set-up here
       //Serial.println("Hello from my usermod!");
+      initDone = true;
     }
 
 
@@ -69,6 +114,11 @@ class MyExampleUsermod : public Usermod {
      *    Instead, use a timer check as shown here.
      */
     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;
+
+      // do your magic here
       if (millis() - lastTime > 1000) {
         //Serial.println("I'm alive!");
         lastTime = millis();
@@ -81,19 +131,25 @@ 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)
     {
-      int reading = 20;
+      // if "u" object does not exist yet wee need to create it
-      //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
+      //this code adds "u":{"ExampleUsermod":[20," lux"]} to the info object
-      lightArr.add(reading); //value
+      //int reading = 20;
-      lightArr.add(" lux"); //unit
+      //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"));
     }
-    */
 
 
     /*
@@ -102,7 +158,12 @@ class MyExampleUsermod : public Usermod {
      */
     void addToJsonState(JsonObject& root)
     {
-      //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;
     }
 
 
@@ -112,7 +173,14 @@ class MyExampleUsermod : public Usermod {
      */
     void readFromJsonState(JsonObject& root)
     {
-      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!"));
     }
 
@@ -154,8 +222,10 @@ class MyExampleUsermod : public Usermod {
      */
     void addToConfig(JsonObject& root)
     {
-      JsonObject top = root.createNestedObject("exampleUsermod");
+      JsonObject top = root.createNestedObject(FPSTR(_name));
-      top["great"] = userVar0; //save these vars persistently whenever settings are saved
+      top[FPSTR(_enabled)] = enabled;
+      //save these vars persistently whenever settings are saved
+      top["great"] = userVar0;
       top["testBool"] = testBool;
       top["testInt"] = testInt;
       top["testLong"] = testLong;
@@ -188,7 +258,7 @@ class MyExampleUsermod : public Usermod {
       // default settings values could be set here (or below using the 3-argument getJsonValue()) instead of in the class definition or constructor
       // setting them inside readFromConfig() is slightly more robust, handling the rare but plausible use case of single value being missing after boot (e.g. if the cfg.json was manually edited and a value was removed)
 
-      JsonObject top = root["exampleUsermod"];
+      JsonObject top = root[FPSTR(_name)];
 
       bool configComplete = !top.isNull();
 
@@ -201,6 +271,8 @@ class MyExampleUsermod : public Usermod {
       // A 3-argument getJsonValue() assigns the 3rd argument as a default value if the Json value is missing
       configComplete &= getJsonValue(top["testInt"], testInt, 42);  
       configComplete &= getJsonValue(top["testLong"], testLong, -42424242);
+
+      // "pin" fields have special handling in settings page (or some_pin as well)
       configComplete &= getJsonValue(top["pin"][0], testPins[0], -1);
       configComplete &= getJsonValue(top["pin"][1], testPins[1], -1);
 
@@ -208,6 +280,21 @@ class MyExampleUsermod : public Usermod {
     }
 
 
+    /*
+     * appendConfigData() is called when user enters usermod settings page
+     * it may add additional metadata for certain entry fields (adding drop down is possible)
+     * be careful not to add too much as oappend() buffer is limited to 3k
+     */
+    void appendConfigData()
+    {
+      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.
@@ -219,6 +306,71 @@ class MyExampleUsermod : public Usermod {
     }
 
 
+    /**
+     * 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) {
+      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) {
+      // 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) {
+      // 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) {
+      // 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.
@@ -231,3 +383,24 @@ class MyExampleUsermod : public Usermod {
    //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/readme.md

@@ -15,7 +15,7 @@ Not supported:
 - On-device setup with buttons (WiFi setup only)
 
 Your images must be 1-135 pixels wide and 1-240 pixels high.
-For BMP, 1, 4, 8, and 24 bits per pixel formats are supported.
+BMP 1, 4, 8, and 24 bits per pixel formats are supported.
 
 ## Installation 
 
@@ -26,11 +26,11 @@ Use LED pin 12, relay pin 27 and button pin 34.
 
 ## Use of RGB565 images
 
-Binary 16-bit per pixel RGB565 format `.bin` and `.clk` images are now supported. This has the benefit of only using 2/3rds of the file size a 24 BPP `.bmp` has.
+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 that this format cannot be handled by common image programs and that an extra conversion step is needed.
+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 formats will save even more file size:
+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
 | --- | --- | --- | --- |

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/

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/

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 WLAN 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
 

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. 
+The JSON IR remote enables 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
+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/PIR_sensor_switch/readme.md

@@ -13,28 +13,29 @@ The info page in the web interface shows the remaining time of the off timer. Us
 
 ## Sensor connection
 
-My setup uses an HC-SR501 or HC-SR602 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
 
-**NOTE:** Usermod has been included in master branch of WLED so it can be compiled in directly just by defining `-D USERMOD_PIRSWITCH` and optionaly `-D PIR_SENSOR_PIN=16` to override default pin. You can also change the default off tim by adding `-D PIR_SENSOR_OFF_SEC=30`.
+**NOTE:** Usermod has been included in master branch of WLED so it can be compiled in directly just by defining `-D USERMOD_PIRSWITCH` and optionaly `-D PIR_SENSOR_PIN=16` to override default pin. You can also change the default off time by adding `-D PIR_SENSOR_OFF_SEC=30`.
 
-## 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 lattitude/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
 
@@ -63,7 +64,7 @@ class MyUsermod : public Usermod {
 
 ### Configuration options
 
-Usermod can be configured in Usermods settings page.
+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
@@ -71,8 +72,8 @@ Usermod can be configured in Usermods settings page.
 * `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` - only send MQTT messages, do not interact with WLED
+* `mqtt-only` - send only MQTT messages, do not interact with WLED
-* `off-only` - only trigger presets or turn WLED on/off in WLED is not already on (displaying effect)
+* `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
 
 

usermods/PIR_sensor_switch/usermod_PIR_sensor_switch.h

@@ -114,6 +114,7 @@ private:
     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) {
@@ -136,7 +137,7 @@ private:
       }
     } else {
       if (m_offPreset) {
-        if (currentPreset==m_onPreset || currentPlaylist==m_onPreset) applyPreset(m_offPreset, NotifyUpdateMode);
+        applyPreset(m_offPreset, NotifyUpdateMode);
         return;
       } else if (prevPlaylist) {
         if (currentPreset==m_onPreset || currentPlaylist==m_onPreset) applyPreset(prevPlaylist, NotifyUpdateMode);
@@ -159,6 +160,7 @@ private:
 
   void publishMqtt(const char* state)
   {
+  #ifndef WLED_DISABLE_MQTT
     //Check if MQTT Connected, otherwise it will crash the 8266
     if (WLED_MQTT_CONNECTED) {
       char subuf[64];
@@ -166,11 +168,13 @@ private:
       strcat_P(subuf, PSTR("/motion"));
       mqtt->publish(subuf, 0, false, state);
     }
+  #endif
   }
 
   // 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()
   {
+  #ifndef WLED_DISABLE_MQTT
     if (WLED_MQTT_CONNECTED) {
       StaticJsonDocument<600> doc;
       char uid[24], json_str[1024], buf[128];
@@ -200,6 +204,7 @@ private:
 
       mqtt->publish(buf, 0, true, json_str, payload_size); // do we really need to retain?
     }
+  #endif
   }
 
   /**
@@ -235,7 +240,7 @@ private:
     if (offTimerStart > 0 && millis() - offTimerStart > m_switchOffDelay) {
       offTimerStart = 0;
       if (enabled == true) {
-        if (!m_mqttOnly && (!m_nightTimeOnly || (m_nightTimeOnly && !isDayTime()))) switchStrip(false);
+        if (!m_mqttOnly && (!m_nightTimeOnly || (m_nightTimeOnly && !isDayTime()) || PIRtriggered)) switchStrip(false);
         else if (NotifyUpdateMode != CALL_MODE_NO_NOTIFY) updateInterfaces(CALL_MODE_WS_SEND);
         publishMqtt("off");
       }
@@ -366,6 +371,20 @@ public:
     sensor[F("motion")] = sensorPinState || offTimerStart>0 ? true : false;
   }
 
+  /**
+   * onStateChanged() is used to detect WLED state change
+   */
+  void onStateChange(uint8_t mode) {
+    if (!initDone) return;
+    DEBUG_PRINT(F("PIR: offTimerStart=")); DEBUG_PRINTLN(offTimerStart);
+    if (PIRtriggered && offTimerStart) {
+      // checking PIRtriggered and offTimerStart will prevent cancellation upon On trigger
+      DEBUG_PRINTLN(F("PIR: Canceled."));
+      offTimerStart = 0;
+      PIRtriggered = 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

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.
+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 _tacho_ (RPM) output you can set the _tacho-pin_ to -1 to not use that feature.
+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 thershold temperature at which fan runs at lowest speed. If the measured temperature is 3°C greater than the threshold temperature, the fan will run at 100%.
 
-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
 
@@ -20,7 +20,7 @@ All of the parameters are configured during run-time using Usermods settings pag
 This includes:
 
 * PWM output pin (can be configured at compile time `-D PWM_PIN=xx`)
-* tacho input pin (can be configured at compile time `-D TACHO_PIN=xx`)
+* tachometer input pin (can be configured at compile time `-D TACHO_PIN=xx`)
 * sampling frequency in seconds
 * threshold temperature in degees C
 
@@ -32,10 +32,10 @@ No special requirements.
 
 ## Control PWM fan speed using JSON API
 
-You can use e.g. `{"PWM-fan":{"speed":30,"lock":true}}` to set fan speed to 30 percent of maximum speed (replace 30 with arbitrary value between 0 and 100) and lock the speed.
+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 in percent (%) of maximum speed.
+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_) fan 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 next update cycle. Once fan speed is locked it will remain so until it is unlocked by next API call.
+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
 

usermods/PWM_fan/usermod_PWM_fan.h

@@ -1,7 +1,7 @@
 #pragma once
 
-#ifndef USERMOD_DALLASTEMPERATURE
+#if !defined(USERMOD_DALLASTEMPERATURE) && !defined(USERMOD_SHT)
-#error The "PWM fan" usermod requires "Dallas Temeprature" usermod to function properly.
+#error The "PWM fan" usermod requires "Dallas Temeprature" or "SHT" usermod to function properly.
 #endif
 
 #include "wled.h"
@@ -42,6 +42,8 @@ class PWMFanUsermod : public Usermod {
 
     #ifdef USERMOD_DALLASTEMPERATURE
     UsermodTemperature* tempUM;
+    #elif defined(USERMOD_SHT)
+    ShtUsermod* tempUM;
     #endif
 
     // configurable parameters
@@ -145,7 +147,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
@@ -189,6 +191,8 @@ class PWMFanUsermod : public Usermod {
       #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();

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

@@ -1,8 +1,8 @@
 # RelayBlinds usermod
 
-This simple usermod toggles two relay pins momentarily (default for 500ms) when `userVar0` is set.  
+This simple usermod toggles two relay pins momentarily (defaults to 500ms) when `userVar0` is set.  
-This can be used to e.g. "push" the buttons of a window blinds motor controller.
+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.  
-Also, a simple `presets.json` file is available, this makes the relay actions controllable via two presets to facilitate control e.g. via the default UI or Alexa.
+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/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.
+This usermod will read from an attached photoresistor sensor like the KY-018.
-The luminance is displayed both in the Info section of the web UI as well as published to the `/luminance` MQTT topic if enabled.
+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`                      - Enables this user mod. wled00\usermods_list.cpp
-* `USERMOD_SN_PHOTORESISTOR_MEASUREMENT_INTERVAL` - the number of milliseconds between measurements, defaults to 60 seconds
+* `USERMOD_SN_PHOTORESISTOR_MEASUREMENT_INTERVAL` - Number of milliseconds between measurements. Defaults to 60000 ms
-* `USERMOD_SN_PHOTORESISTOR_FIRST_MEASUREMENT_AT` - the number of milliseconds after boot to take first measurement, defaults to 20 seconds
+* `USERMOD_SN_PHOTORESISTOR_FIRST_MEASUREMENT_AT` - Number of milliseconds after boot to take first measurement. Defaults to 20000 ms
-* `USERMOD_SN_PHOTORESISTOR_REFERENCE_VOLTAGE`    - the voltage supplied to the sensor, defaults to 5v
+* `USERMOD_SN_PHOTORESISTOR_REFERENCE_VOLTAGE`    - 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_ADC_PRECISION`        - ADC precision. Defaults to 10 bits
-* `USERMOD_SN_PHOTORESISTOR_RESISTOR_VALUE`       - the resistor size, defaults to 10000.0 (10K hms)
+* `USERMOD_SN_PHOTORESISTOR_RESISTOR_VALUE`       - Resistor size, defaults to 10000.0 (10K Ohms)
-* `USERMOD_SN_PHOTORESISTOR_OFFSET_VALUE`         - the offset value to report on, defaults to 25
+* `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

@@ -109,6 +109,7 @@ public:
     {
       lastLDRValue = currentLDRValue;
 
+#ifndef WLED_DISABLE_MQTT
       if (WLED_MQTT_CONNECTED)
       {
         char subuf[45];
@@ -121,6 +122,7 @@ public:
         DEBUG_PRINTLN("Missing MQTT connection. Not publishing data");
       }
     }
+#endif
   }
 
   uint16_t getLastLDRValue()

usermods/ST7789_display/README.md

@@ -1,15 +1,15 @@
-# 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;
+* Current date and time;
 * Network SSID;
 * IP address;
 * WiFi signal strength;
 * Brightness;
-* Chosen effect;
+* Selected effect;
-* Chosen palette;
+* Selected palette;
-* effect speed and intensity;
+* Effect speed and intensity;
 * Estimated current in mA;
 
 ## Hardware
@@ -41,9 +41,9 @@ 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
@@ -64,14 +64,14 @@ build_flags = ${common.build_flags_esp32}
     ;-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
 
-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.
+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.
 
-Edit `Setup_ST7789.h` file and uncomment nad changep GPIO pin numbers in lines containing `TFT_MOSI`, `TFT_SCLK`, `TFT_RST`, `TFT_DC`.
+Edit `Setup_ST7789.h` file and uncomment and change GPIO pin numbers in lines containing `TFT_MOSI`, `TFT_SCLK`, `TFT_RST`, `TFT_DC`.
 
-Modify the `User_Setup_Select.h` by uncommentig the line containing `#include <User_Setups/Setup24_ST7789.h>` and commenting out line containing `#include <User_Setup.h>`.
+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>`.
 
-If your display includes backlight enable pin, #define TFT_BL with backlight enable GPIO number.
+If your display uses the backlight enable pin, add this definition: #define TFT_BL with backlight enable GPIO number.

usermods/Si7021_MQTT_HA/readme.md

@@ -2,14 +2,14 @@
 
 This usermod implements support for [Si7021 I²C temperature and humidity sensors](https://www.silabs.com/documents/public/data-sheets/Si7021-A20.pdf).
 
-The sensor data will *not* be shown on the WLED UI (so far) but published via MQTT to WLED's "build in" MQTT device topic. 
+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
 ```
 
-Additionally the following sensors can be published:
+The following sensors can also be published:
 
 ```
 heat_index: $mqttDeviceTopic/si7021_heat_index
@@ -17,7 +17,7 @@ dew_point: $mqttDeviceTopic/si7021_dew_point
 absolute_humidity: $mqttDeviceTopic/si7021_absolute_humidity
 ```
 
-Sensor data will be updated/send every 60 seconds.
+Sensor data will be updated/sent every 60 seconds.
 
 This usermod also supports Home Assistant Auto Discovery.
 

usermods/Si7021_MQTT_HA/usermod_si7021_mqtt_ha.h

@@ -1,3 +1,7 @@
+#ifndef WLED_ENABLE_MQTT
+#error "This user mod requires MQTT to be enabled."
+#endif
+
 #pragma once
 
 // this is remixed from usermod_v2_SensorsToMqtt.h (sensors_to_mqtt usermod)

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
+* IP address, if obtained
-  * If connected to a network, current brightness % is shown 
+  * If connected to a network, current brightness percentage is shown 
-  * in AP mode AP IP and password are 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.
+* 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 off the supply (in addition to dropping the 12v supply down to 5v with a buck regulator for the ESP module and level shifter).
+* 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)
+# Release binaries
-; default_envs = travis_esp8266, esp01, esp01_1m_ota, travis_esp32
+; 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

usermods/Temperature/readme.md

@@ -1,9 +1,9 @@
 # Temperature usermod
 
-Based on the excellent `QuinLED_Dig_Uno_Temp_MQTT` by srg74 and 400killer!  
+Based on the excellent `QuinLED_Dig_Uno_Temp_MQTT` usermod by srg74 and 400killer!  
-This usermod will read from an attached DS18B20 temperature sensor (as available on the QuinLED Dig-Uno)  
+Reads 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.  
+Temperature is displayed in both 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.
+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.
 
@@ -13,10 +13,10 @@ Copy the example `platformio_override.ini` to the root directory.  This file sho
 
 ### Define Your Options
 
-* `USERMOD_DALLASTEMPERATURE`                      - define this to have this user mod included wled00\usermods_list.cpp
+* `USERMOD_DALLASTEMPERATURE`                      - enables this user mod 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_FIRST_MEASUREMENT_AT` - number of milliseconds after boot to take first measurement, defaults to 20000 ms
 
-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 Farenheit and measurement interval.
 
 ## Project link
 
@@ -50,8 +50,8 @@ lib_deps =
 ## Change Log
 
 2020-09-12 
-* Changed to use async, non-blocking implementation
+* Changed to use async non-blocking implementation
-* Do not report low temperatures that indicate an error to mqtt
+* 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

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
@@ -53,6 +54,7 @@ class UsermodTemperature : public Usermod {
     static const char _enabled[];
     static const char _readInterval[];
     static const char _parasite[];
+    static const char _parasitePin[];
 
     //Dallas sensor quick (& dirty) reading. Credit to - Author: Peter Scargill, August 17th, 2013
     float readDallas() {
@@ -94,12 +96,14 @@ class UsermodTemperature : public Usermod {
       DEBUG_PRINTLN(F("Requesting temperature."));
       oneWire->reset();
       oneWire->skip();                        // skip ROM
-      oneWire->write(0x44,parasite);          // request new temperature reading (TODO: parasite would need special handling)
+      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;
     }
 
     void readTemperature() {
+      if (parasite && parasitePin >=0 ) digitalWrite(parasitePin, LOW); // deactivate power (close MOSFET)
       temperature = readDallas();
       lastMeasurement = millis();
       waitingForConversion = false;
@@ -134,6 +138,7 @@ class UsermodTemperature : public Usermod {
       return false;
     }
 
+#ifndef WLED_DISABLE_MQTT
     void publishHomeAssistantAutodiscovery() {
       if (!WLED_MQTT_CONNECTED) return;
 
@@ -155,6 +160,7 @@ class UsermodTemperature : public Usermod {
       mqtt->publish(buf, 0, true, json_str, payload_size);
       HApublished = true;
     }
+#endif
 
   public:
 
@@ -173,6 +179,12 @@ class UsermodTemperature : public Usermod {
               delay(25); // try to find sensor
             }
           }
+          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."));
@@ -212,6 +224,7 @@ class UsermodTemperature : public Usermod {
         }
         errorCount = 0;
 
+#ifndef WLED_DISABLE_MQTT
         if (WLED_MQTT_CONNECTED) {
           char subuf[64];
           strcpy(subuf, mqttDeviceTopic);
@@ -227,6 +240,7 @@ class UsermodTemperature : public Usermod {
             // publish something else to indicate status?
           }
         }
+#endif
       }
     }
 
@@ -236,6 +250,7 @@ class UsermodTemperature : public Usermod {
      */
     //void connected() {}
 
+#ifndef WLED_DISABLE_MQTT
     /**
      * subscribe to MQTT topic if needed
      */
@@ -246,6 +261,7 @@ class UsermodTemperature : public Usermod {
         publishHomeAssistantAutodiscovery();
       }
     }
+#endif
 
     /*
      * API calls te enable data exchange between WLED modules
@@ -315,6 +331,7 @@ class UsermodTemperature : public Usermod {
       top["degC"] = degC;  // usermodparam
       top[FPSTR(_readInterval)] = readingInterval / 1000;
       top[FPSTR(_parasite)] = parasite;
+      top[FPSTR(_parasitePin)] = parasitePin;
       DEBUG_PRINTLN(F("Temperature config saved."));
     }
 
@@ -340,6 +357,7 @@ class UsermodTemperature : public Usermod {
       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;
 
       if (!initDone) {
         // first run: reading from cfg.json
@@ -354,12 +372,21 @@ class UsermodTemperature : public Usermod {
           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(_parasite)].isNull();
+      return !top[FPSTR(_parasitePin)].isNull();
+    }
+
+    void 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
     }
 
     uint16_t getId()
@@ -373,3 +400,4 @@ 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";

usermods/VL53L0X_gestures/readme.md

@@ -1,10 +1,10 @@
 # Description
 
-That usermod implements support of simple hand gestures with VL53L0X sensor: on/off and brightness correction.
+Implements support of simple hand gestures via a VL53L0X sensor: on/off and brightness adjustment.
-It can be useful for kitchen strips to avoid any touches.
+Useful for controlling strips when you want to avoid touching anything.
- - on/off - just swipe a hand below your sensor ("shortPressAction" is called and can be customized through WLED macros)
+ - on/off - swipe your hand below the sensor ("shortPressAction" is called. Can be customized via WLED macros)
- - brightness correction - keep your hand below sensor for 1 second to switch to "brightness" mode.
+ - brightness adjustment - hold your hand below the sensor for 1 second to switch to "brightness" mode.
-                           Configure brightness by changing distance to the sensor (see parameters below for customization).
+                           adjust the brightness by changing the distance between your hand and the sensor (see parameters below for customization).
    
 ## Installation
 

usermods/Wemos_D1_mini+Wemos32_mini_shield/readme.md

@@ -9,10 +9,10 @@
 ## Features
 -   SSD1306 128x32 or 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
--   Relay for energy saving
+-   Relay for saving energy
 
 ## Hardware
 ![Shield](https://github.com/srg74/WLED-wemos-shield/blob/master/resources/Images/Assembly_8.jpg)

usermods/Wemos_D1_mini+Wemos32_mini_shield/usermod.cpp

@@ -101,6 +101,7 @@ void userLoop() {
   if (temptimer - lastMeasure > 60000) 
   {
     lastMeasure = temptimer;    
+#ifndef WLED_DISABLE_MQTT
 //Check if MQTT Connected, otherwise it will crash the 8266
     if (mqtt != nullptr)
     {
@@ -116,6 +117,7 @@ void userLoop() {
         t += "/temperature";
         mqtt->publish(t.c_str(), 0, true, String(board_temperature).c_str());
     }
+  #endif
   }
 
   // Check if we time interval for redrawing passes.

usermods/Wemos_D1_mini+Wemos32_mini_shield/usermod_bme280.cpp

@@ -103,6 +103,7 @@ void userLoop() {
   {
     lastMeasure = tempTimer;    
 
+#ifndef WLED_DISABLE_MQTT
 // Check if MQTT Connected, otherwise it will crash the 8266
     if (mqtt != nullptr)
     {
@@ -122,6 +123,7 @@ void userLoop() {
       h += "/humidity";
       mqtt->publish(h.c_str(), 0, true, String(board_humidity).c_str());
     }
+  #endif
   }
 
   // Check if we time interval for redrawing passes.

usermods/audioreactive/readme.md

@@ -1,11 +1,11 @@
 # Audioreactive usermod
 
-This usermod allows controlling LEDs using audio input. Audio input can be either microphone or analog-in (AUX) using appropriate adapter.
+Enabless controlling LEDs via audio input. Audio source can be a microphone or analog-in (AUX) using an appropriate adapter.
-Supported microphones range from cheap analog (MAX4466, MAX9814, ...) to high quality digital (INMP441, ICS-43434, ...) and dgital Line-In.
+Supported microphones range from analog (MAX4466, MAX9814, ...) to digital (INMP441, ICS-43434, ...).
 
-The usermod does audio processing and provides data structure that specially written effect can use.
+Does audio processing and provides data structure that specially written effects can use.
 
-The usermod **does not** provide effects or draws anything to LED strip/matrix.
+**does not** provide effects or draw anything to an LED strip/matrix.
 
 ## Additional Documentation
 This usermod is an evolution of [SR-WLED](https://github.com/atuline/WLED), and a lot of documentation and information can be found in the [SR-WLED wiki](https://github.com/atuline/WLED/wiki):
@@ -42,9 +42,9 @@ ArduinoFFT `develop` library is slightly more accurate, and slighly faster than
 
 ## Configuration
 
-All parameters are runtime configurable though some may require hard boot after change (I2S microphone or selected GPIOs).
+All parameters are runtime configurable. Some may require a hard reset after changing them (I2S microphone or selected GPIOs).
 
-If you want to define default GPIOs during compile time use the following addtional build_flags (default values in parentheses):
+If you want to define default GPIOs during compile time, use the following (default values in parentheses):
 
 - `-D SR_DMTYPE=x` : defines digital microphone type: 0=analog, 1=generic I2S (default), 2=ES7243 I2S, 3=SPH0645 I2S, 4=generic I2S with master clock, 5=PDM I2S
 - `-D AUDIOPIN=x`  : GPIO for analog microphone/AUX-in (36)
@@ -55,7 +55,7 @@ If you want to define default GPIOs during compile time use the following addtio
 - `-D ES7243_SDAPIN` : GPIO for I2C SDA pin on ES7243 microphone (-1)
 - `-D ES7243_SCLPIN` : GPIO for I2C SCL pin on ES7243 microphone (-1)
 
-**NOTE** Due to the fact that usermod uses I2S peripherial for analog audio sampling, use of analog *buttons* (i.e. potentiometers) is disabled while running this usermod with analog microphone.
+**NOTE** I2S is used for analog audio sampling. Hence, the analog *buttons* (i.e. potentiometers) are disabled when running this usermod with an analog microphone.
 
 ### Advanced Compile-Time Options
 You can use the following additional flags in your `build_flags`

usermods/battery_status_basic/readme.md

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

usermods/battery_status_basic/usermod_v2_battery_status_basic.h

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

usermods/blynk_relay_control/README.md

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

usermods/blynk_relay_control/wled06_usermod.ino

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

usermods/boblight/boblight.h

@@ -0,0 +1,459 @@
+#pragma once
+
+#include "wled.h"
+
+/*
+ * Usermod that implements BobLight "ambilight" protocol
+ * 
+ * See the accompanying README.md file for more info.
+ */
+
+#ifndef BOB_PORT
+  #define BOB_PORT 19333       // Default boblightd port
+#endif
+
+class BobLightUsermod : public Usermod {
+  typedef struct _LIGHT {
+    char lightname[5];
+    float hscan[2];
+    float vscan[2];
+  } light_t;
+
+  private:
+    unsigned long lastTime = 0;
+    bool enabled  = false;
+    bool initDone = false;
+
+    light_t *lights = nullptr;
+    uint16_t numLights = 0;  // 16 + 9 + 16 + 9
+    uint16_t top, bottom, left, right;  // will be filled in readFromConfig()
+    uint16_t pct;
+
+    WiFiClient bobClient;
+    WiFiServer *bob;
+    uint16_t   bobPort = BOB_PORT;
+
+    static const char _name[];
+    static const char _enabled[];
+
+    /*
+    # boblight
+    # Copyright (C) Bob  2009 
+    #
+    # makeboblight.sh created by Adam Boeglin <adamrb@gmail.com>
+    #
+    # boblight 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.
+    # 
+    # boblight 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/>.
+    */
+
+    // fills the lights[] array with position & depth of scan for each LED
+    void fillBobLights(int bottom, int left, int top, int right, float pct_scan) {
+
+      int lightcount = 0;
+      int total = top+left+right+bottom;
+      int bcount;
+
+      if (total > strip.getLengthTotal()) {
+        DEBUG_PRINTLN(F("BobLight: Too many lights."));
+        return;
+      }
+
+      // start left part of bottom strip (clockwise direction, 1st half)
+      if (bottom > 0) {
+        bcount = 1;
+        float brange = 100.0/bottom;
+        float bcurrent = 50.0;
+        if (bottom < top) {
+          int diff = top - bottom;
+          brange = 100.0/top;
+          bcurrent -= (diff/2)*brange;
+        }
+        while (bcount <= bottom/2) {
+          float btop = bcurrent - brange;
+          String name = "b"+String(bcount);
+          strncpy(lights[lightcount].lightname, name.c_str(), 4);
+          lights[lightcount].hscan[0] = btop;
+          lights[lightcount].hscan[1] = bcurrent;
+          lights[lightcount].vscan[0] = 100 - pct_scan;
+          lights[lightcount].vscan[1] = 100;
+          lightcount+=1;
+          bcurrent = btop;
+          bcount+=1;
+        }
+      }
+
+      // left side
+      if (left > 0) {
+        int lcount = 1;
+        float lrange = 100.0/left;
+        float lcurrent = 100.0;
+        while (lcount <= left) {
+          float ltop = lcurrent - lrange;
+          String name = "l"+String(lcount);
+          strncpy(lights[lightcount].lightname, name.c_str(), 4);
+          lights[lightcount].hscan[0] = 0;
+          lights[lightcount].hscan[1] = pct_scan;
+          lights[lightcount].vscan[0] = ltop;
+          lights[lightcount].vscan[1] = lcurrent;
+          lightcount+=1;
+          lcurrent = ltop;
+          lcount+=1;
+        }
+      }
+
+      // top side
+      if (top > 0) {
+        int tcount = 1;
+        float trange = 100.0/top;
+        float tcurrent = 0;
+        while (tcount <= top) {
+          float ttop = tcurrent + trange;
+          String name = "t"+String(tcount);
+          strncpy(lights[lightcount].lightname, name.c_str(), 4);
+          lights[lightcount].hscan[0] = tcurrent;
+          lights[lightcount].hscan[1] = ttop;
+          lights[lightcount].vscan[0] = 0;
+          lights[lightcount].vscan[1] = pct_scan;
+          lightcount+=1;
+          tcurrent = ttop;
+          tcount+=1;
+        }
+      }
+
+      // right side
+      if (right > 0) {
+        int rcount = 1;
+        float rrange = 100.0/right;
+        float rcurrent = 0;
+        while (rcount <= right) {
+          float rtop = rcurrent + rrange;
+          String name = "r"+String(rcount);
+          strncpy(lights[lightcount].lightname, name.c_str(), 4);
+          lights[lightcount].hscan[0] = 100-pct_scan;
+          lights[lightcount].hscan[1] = 100;
+          lights[lightcount].vscan[0] = rcurrent;
+          lights[lightcount].vscan[1] = rtop;
+          lightcount+=1;
+          rcurrent = rtop;
+          rcount+=1;
+        }
+      }
+      
+      // right side of bottom strip (2nd half)
+      if (bottom > 0) {
+        float brange = 100.0/bottom;
+        float bcurrent = 100;
+        if (bottom < top) {
+          brange = 100.0/top;
+        }
+        while (bcount <= bottom) {
+          float btop = bcurrent - brange;
+          String name = "b"+String(bcount);
+          strncpy(lights[lightcount].lightname, name.c_str(), 4);
+          lights[lightcount].hscan[0] = btop;
+          lights[lightcount].hscan[1] = bcurrent;
+          lights[lightcount].vscan[0] = 100 - pct_scan;
+          lights[lightcount].vscan[1] = 100;
+          lightcount+=1;
+          bcurrent = btop;
+          bcount+=1;
+        }
+      }
+
+      numLights = lightcount;
+
+      #if WLED_DEBUG
+      DEBUG_PRINTLN(F("Fill light data: "));
+      DEBUG_PRINTF(" lights %d\n", numLights);
+      for (int i=0; i<numLights; i++) {
+        DEBUG_PRINTF(" light %s scan %2.1f %2.1f %2.1f %2.1f\n", lights[i].lightname, lights[i].vscan[0], lights[i].vscan[1], lights[i].hscan[0], lights[i].hscan[1]);
+      }
+      #endif
+    }
+
+    void BobSync()  { yield(); } // allow other tasks, should also be used to force pixel redraw (not with WLED)
+    void BobClear() { for (size_t i=0; i<numLights; i++) setRealtimePixel(i, 0, 0, 0, 0); }
+    void pollBob();
+
+  public:
+
+    void setup() {
+      uint16_t totalLights = bottom + left + top + right;
+      if ( totalLights > strip.getLengthTotal() ) {
+        DEBUG_PRINTLN(F("BobLight: Too many lights."));
+        DEBUG_PRINTF("%d+%d+%d+%d>%d\n", bottom, left, top, right, strip.getLengthTotal());
+        totalLights = strip.getLengthTotal();
+        top = bottom = (uint16_t) roundf((float)totalLights * 16.0f / 50.0f);
+        left = right = (uint16_t) roundf((float)totalLights *  9.0f / 50.0f);
+      }
+      lights = new light_t[totalLights];
+      if (lights) fillBobLights(bottom, left, top, right, float(pct)); // will fill numLights
+      else        enable(false);
+      initDone = true;
+    }
+
+    void connected() {
+      // we can only start server when WiFi is connected
+      if (!bob) bob = new WiFiServer(bobPort, 1);
+      bob->begin();
+      bob->setNoDelay(true);
+    }
+
+    void loop() {
+      if (!enabled || strip.isUpdating()) return;
+      if (millis() - lastTime > 10) {
+        lastTime = millis();
+        pollBob();
+      }
+    }
+
+    void enable(bool en) { enabled = en; }
+    
+#ifndef WLED_DISABLE_MQTT
+    /**
+     * handling of MQTT message
+     * topic only contains stripped topic (part after /wled/MAC)
+     * topic should look like: /swipe with amessage of [up|down]
+     */
+    bool onMqttMessage(char* topic, char* payload) {
+      //if (strlen(topic) == 6 && strncmp_P(topic, PSTR("/subtopic"), 6) == 0) {
+      //  String action = payload;
+      //  if (action == "on") {
+      //    enable(true);
+      //    return true;
+      //  } else if (action == "off") {
+      //    enable(false);
+      //    return true;
+      //  }
+      //}
+      return false;
+    }
+
+    /**
+     * subscribe to MQTT topic for controlling usermod
+     */
+    void onMqttConnect(bool sessionPresent) {
+      //char subuf[64];
+      //if (mqttDeviceTopic[0] != 0) {
+      //  strcpy(subuf, mqttDeviceTopic);
+      //  strcat_P(subuf, PSTR("/subtopic"));
+      //  mqtt->subscribe(subuf, 0);
+      //}
+    }
+#endif
+
+    void addToJsonInfo(JsonObject& root)
+    {
+      JsonObject user = root["u"];
+      if (user.isNull()) user = root.createNestedObject("u");
+
+      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 += enabled ? F(":false}});\">") : F(":true}});\">");
+      uiDomString += F("<i class=\"icons ");
+      uiDomString += enabled ? "on" : "off";
+      uiDomString += F("\">&#xe08f;</i></button>");
+      infoArr.add(uiDomString);
+    }
+
+    /*
+     * 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) {
+      if (!initDone) return;  // prevent crash on boot applyPreset()
+      bool en = enabled;
+      JsonObject um = root[FPSTR(_name)];
+      if (!um.isNull()) {
+        if (um[FPSTR(_enabled)].is<bool>()) {
+          en = um[FPSTR(_enabled)].as<bool>();
+        } else {
+          String str = um[FPSTR(_enabled)]; // checkbox -> off or on
+          en = (bool)(str!="off"); // off is guaranteed to be present
+        }
+        if (en != enabled && lights) {
+          enable(en);
+          if (!enabled && bob && bob->hasClient()) {
+            if (bobClient) bobClient.stop();
+            bobClient = bob->available();
+            BobClear();
+            exitRealtime();
+          }
+        }
+      }
+    }
+
+    void appendConfigData() {
+      //oappend(SET_F("dd=addDropdown('usermod','selectfield');"));
+      //oappend(SET_F("addOption(dd,'1st value',0);"));
+      //oappend(SET_F("addOption(dd,'2nd value',1);"));
+      oappend(SET_F("addInfo('BobLight:top',1,'LEDs');"));                // 0 is field type, 1 is actual field
+      oappend(SET_F("addInfo('BobLight:bottom',1,'LEDs');"));             // 0 is field type, 1 is actual field
+      oappend(SET_F("addInfo('BobLight:left',1,'LEDs');"));               // 0 is field type, 1 is actual field
+      oappend(SET_F("addInfo('BobLight:right',1,'LEDs');"));              // 0 is field type, 1 is actual field
+      oappend(SET_F("addInfo('BobLight:pct',1,'Depth of scan [%]');"));   // 0 is field type, 1 is actual field
+    }
+
+    void addToConfig(JsonObject& root) {
+      JsonObject umData = root.createNestedObject(FPSTR(_name));
+      umData[FPSTR(_enabled)] = enabled;
+      umData[F("port")]       = bobPort;
+      umData[F("top")]        = top;
+      umData[F("bottom")]     = bottom;
+      umData[F("left")]       = left;
+      umData[F("right")]      = right;
+      umData[F("pct")]        = pct;
+    }
+
+    bool readFromConfig(JsonObject& root) {
+      JsonObject umData = root[FPSTR(_name)];
+      bool configComplete = !umData.isNull();
+
+      bool en = enabled;
+      configComplete &= getJsonValue(umData[FPSTR(_enabled)], en);
+      enable(en);
+
+      configComplete &= getJsonValue(umData[F("port")],   bobPort);
+      configComplete &= getJsonValue(umData[F("bottom")], bottom,    16);
+      configComplete &= getJsonValue(umData[F("top")],    top,       16);
+      configComplete &= getJsonValue(umData[F("left")],   left,       9);
+      configComplete &= getJsonValue(umData[F("right")],  right,      9);
+      configComplete &= getJsonValue(umData[F("pct")],    pct,        5); // Depth of scan [%]
+      pct = MIN(50,MAX(1,pct));
+
+      uint16_t totalLights = bottom + left + top + right;
+      if (initDone && numLights != totalLights) {
+        if (lights) delete[] lights;
+        setup();
+      }
+      return configComplete;
+    }
+
+    /*
+     * 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() {
+      //strip.setPixelColor(0, RGBW32(0,0,0,0)) // set the first pixel to black
+    }
+
+    uint16_t getId() { return USERMOD_ID_BOBLIGHT; }
+
+};
+
+// strings to reduce flash memory usage (used more than twice)
+const char BobLightUsermod::_name[]    PROGMEM = "BobLight";
+const char BobLightUsermod::_enabled[] PROGMEM = "enabled";
+
+// main boblight handling (definition here prevents inlining)
+void BobLightUsermod::pollBob() {
+  
+  //check if there are any new clients
+  if (bob && bob->hasClient()) {
+    //find free/disconnected spot
+    if (!bobClient || !bobClient.connected()) {
+      if (bobClient) bobClient.stop();
+      bobClient = bob->available();
+      DEBUG_PRINTLN(F("Boblight: Client connected."));
+    }
+    //no free/disconnected spot so reject
+    WiFiClient bobClientTmp = bob->available();
+    bobClientTmp.stop();
+    BobClear();
+    exitRealtime();
+  }
+  
+  //check clients for data
+  if (bobClient && bobClient.connected()) {
+    realtimeLock(realtimeTimeoutMs); // lock strip as we have a client connected
+
+    //get data from the client
+    while (bobClient.available()) {
+      String input = bobClient.readStringUntil('\n');
+      // DEBUG_PRINT("Client: "); DEBUG_PRINTLN(input); // may be to stressful on Serial
+      if (input.startsWith(F("hello"))) {
+        DEBUG_PRINTLN(F("hello"));
+        bobClient.print(F("hello\n"));
+      } else if (input.startsWith(F("ping"))) {
+        DEBUG_PRINTLN(F("ping 1"));
+        bobClient.print(F("ping 1\n"));
+      } else if (input.startsWith(F("get version"))) {
+        DEBUG_PRINTLN(F("version 5"));
+        bobClient.print(F("version 5\n"));
+      } else if (input.startsWith(F("get lights"))) {
+        char tmp[64];
+        String answer = "";
+        sprintf_P(tmp, PSTR("lights %d\n"), numLights);
+        DEBUG_PRINT(tmp);
+        answer.concat(tmp);
+        for (int i=0; i<numLights; i++) {
+          sprintf_P(tmp, PSTR("light %s scan %2.1f %2.1f %2.1f %2.1f\n"), lights[i].lightname, lights[i].vscan[0], lights[i].vscan[1], lights[i].hscan[0], lights[i].hscan[1]);
+          DEBUG_PRINT(tmp);
+          answer.concat(tmp);
+        }
+        bobClient.print(answer);
+      } else if (input.startsWith(F("set priority"))) {
+        DEBUG_PRINTLN(F("set priority not implemented"));
+        // not implemented
+      } else if (input.startsWith(F("set light "))) { // <id> <cmd in rgb, speed, interpolation> <value> ...
+        input.remove(0,10);
+        String tmp = input.substring(0,input.indexOf(' '));
+        
+        int light_id = -1;
+        for (uint16_t i=0; i<numLights; i++) {
+          if (strncmp(lights[i].lightname, tmp.c_str(), 4) == 0) {
+            light_id = i;
+            break;
+          }
+        }
+        if (light_id == -1) return;
+
+        input.remove(0,input.indexOf(' ')+1);
+        if (input.startsWith(F("rgb "))) {
+          input.remove(0,4);
+          tmp = input.substring(0,input.indexOf(' '));
+          uint8_t red = (uint8_t)(255.0f*tmp.toFloat());
+          input.remove(0,input.indexOf(' ')+1);        // remove first float value
+          tmp = input.substring(0,input.indexOf(' '));
+          uint8_t green = (uint8_t)(255.0f*tmp.toFloat());
+          input.remove(0,input.indexOf(' ')+1);        // remove second float value
+          tmp = input.substring(0,input.indexOf(' '));
+          uint8_t blue = (uint8_t)(255.0f*tmp.toFloat());
+
+          //strip.setPixelColor(light_id, RGBW32(red, green, blue, 0));
+          setRealtimePixel(light_id, red, green, blue, 0);
+        } // currently no support for interpolation or speed, we just ignore this
+      } else if (input.startsWith(F("sync"))) {
+        BobSync();
+      } else {
+        // Client sent gibberish
+        DEBUG_PRINTLN(F("Client sent gibberish."));
+        bobClient.stop();
+        bobClient = bob->available();
+        BobClear();
+      }
+    }
+  }
+}

usermods/boblight/readme.md

@@ -0,0 +1,37 @@
+# BobLight usermod
+
+This usermod allows displaying BobLight ambilight protocol on WLED device with a limited command set (not a full implementation).
+BobLight protocol uses a TCP connection which guarantees packet delivery at the possible expense of latency delays. It is not very efficient (as it uses plaintext comands) so is not suited for large number of LEDs.
+
+This implementation is intended for TV backlight in combination with XBMC/Kodi BobLight add-on.
+
+The LEDs can be configured in usermod settings page. The configuration is simple: you enter the number of LED pixels on each side of your TV (top, right, bottom, left).
+The LEDs should be wired in a clockwise orientation starting in the middle of bottom side (left half of bottom leds is where the string should start).
+
+```
++-------->-------+
+|                |
+^                v
+|                |
++---<--+  ---<---+
+       ^
+     start
+```
+
+## Installation 
+
+Add `-D USERMOD_BOBLIGHT` to your PlatformIO environment.
+If you are not using PlatformIO (which you should) try adding `#define USERMOD_BOBLIGHT` to *my_config.h*.
+
+## Configuration
+
+All parameters are runtime configurable though changing port may require reboot.
+
+If you want to define default port during compile time use the following (default values in parentheses):
+
+- `BOB_PORT=x` : defines default TCP port for usermod to listen on (19333)
+
+
+## Release notes
+
+2022-11 Initial implementation by @blazoncek (AKA Blaz Kristan)

usermods/mpu6050_imu/readme.md

@@ -1,13 +1,13 @@
 # MPU-6050 Six-Axis (Gyro + Accelerometer) Driver
 
-This usermod-v2 modification allows the connection of a MPU-6050 IMU sensor to
+v2 of this usermod enables connection of a MPU-6050 IMU sensor to
-allow for effects that are controlled by the orientation or motion of the WLED Device.
+work with effects controlled by the orientation or motion of the WLED Device.
 
-The MPU6050 has a built in "Digital Motion Processor" which does a lot of the heavy
+The MPU6050 has a built in "Digital Motion Processor" which does the "heavy lifting"
-lifting in integrating the gyro and accel measurements to get potentially more
+integrating the gyro and accelerometer measurements to get potentially more
 useful gravity vector and orientation output.
 
-It is pretty straightforward to comment out some of the variables being read off the device if they're not needed to save CPU/Mem/Bandwidth.
+It is fairly straightforward to comment out variables being read from the device if they're not needed. Saves CPU/Memory/Bandwidth.
 
 _Story:_
 

usermods/mpu6050_imu/usermod_mpu6050_imu.h

@@ -138,7 +138,7 @@ class MPU6050Driver : public Usermod {
         // (if it's going to break, usually the code will be 1)
         DEBUG_PRINT(F("DMP Initialization failed (code "));
         DEBUG_PRINT(devStatus);
-        DEBUG_PRINTLN(F(")"));
+        DEBUG_PRINTLN(")");
       }
     }
 
@@ -209,7 +209,7 @@ class MPU6050Driver : public Usermod {
       JsonObject user = root["u"];
       if (user.isNull()) user = root.createNestedObject("u");
 
-      JsonArray imu_meas = user.createNestedObject("IMU");
+      JsonObject imu_meas = user.createNestedObject("IMU");
       JsonArray quat_json = imu_meas.createNestedArray("Quat");
       quat_json.add(qat.w);
       quat_json.add(qat.x);

usermods/multi_relay/readme.md

@@ -1,37 +1,37 @@
 # Multi Relay
 
-This usermod-v2 modification allows the connection of multiple relays each with individual delay and on/off mode.
+This usermod-v2 modification allows the connection of multiple relays, each with individual delay and on/off mode.
 
 ## HTTP API
-All responses are returned as JSON. 
+All responses are returned in JSON format. 
 
 * Status Request: `http://[device-ip]/relays`
 * Switch Command: `http://[device-ip]/relays?switch=1,0,1,1`
 
-The number of numbers behind the switch parameter must correspond to the number of relays. The number 1 switches the relay on. The number 0 switches the relay off. 
+The number of values behind the switch parameter must correspond to the number of relays. The value 1 switches the relay on, 0 switches it off. 
 
 * Toggle Command: `http://[device-ip]/relays?toggle=1,0,1,1`
 
-The number of numbers behind the parameter switch must correspond to the number of relays. The number 1 causes a toggling of the relay. The number 0 leaves the state of the device.
+The number of values behind the parameter switch must correspond to the number of relays. The value 1 causes the relay to toggle, 0 leaves its state unchanged.
 
-Examples
+Examples:
 1. total of 4 relays, relay 2 will be toggled: `http://[device-ip]/relays?toggle=0,1,0,0`
 2. total of 3 relays, relay 1&3 will be switched on: `http://[device-ip]/relays?switch=1,0,1`
 
 ## JSON API
-You can switch relay state using the following JSON object transmitted to: `http://[device-ip]/json`
+You can toggle the relay state by sending the following JSON object to: `http://[device-ip]/json`
-
 
 Switch relay 0 on: `{"MultiRelay":{"relay":0,"on":true}}`
 
-Switch relay4 3 & 4 off: `{"MultiRelay":[{"relay":2,"on":false},{"relay":3,"on":false}]}`
+Switch relay 3 and 4 off: `{"MultiRelay":[{"relay":2,"on":false},{"relay":3,"on":false}]}`
+
 
 ## MQTT API
 
 * `wled`/_deviceMAC_/`relay`/`0`/`command` `on`|`off`|`toggle`
 * `wled`/_deviceMAC_/`relay`/`1`/`command` `on`|`off`|`toggle`
 
-When relay is switched it will publish a message:
+When a relay is switched, a message is published:
 
 * `wled`/_deviceMAC_/`relay`/`0` `on`|`off`
 
@@ -42,7 +42,7 @@ When relay is switched it will publish a message:
 or
 2. Use `#define USERMOD_MULTI_RELAY` in wled.h or `-D USERMOD_MULTI_RELAY` in your platformio.ini
 
-You can override the default maximum number (4) of relays by defining MULTI_RELAY_MAX_RELAYS.
+You can override the default maximum number of relays (which is 4) by defining MULTI_RELAY_MAX_RELAYS.
 
 Example **usermods_list.cpp**:
 
@@ -78,15 +78,15 @@ void registerUsermods()
 
 ## Configuration
 
-Usermod can be configured in Usermods settings page.
+Usermod can be configured via the Usermods settings page.
 
 * `enabled` - enable/disable usermod
-* `pin` - GPIO pin where relay is attached to ESP (can be configured at compile time `-D MULTI_RELAY_PINS=xx,xx,...`)
+* `pin` - ESP GPIO pin the relay is connected to (can be configured at compile time `-D MULTI_RELAY_PINS=xx,xx,...`)
 * `delay-s` - delay in seconds after on/off command is received
-* `active-high` - toggle high/low activation of relay (can be used to reverse relay states)
+* `active-high` - assign high/low activation of relay (can be used to reverse relay states)
-* `external` - if enabled WLED does not control relay, it can only be triggered by external command (MQTT, HTTP, JSON or button)
+* `external` - if enabled, WLED does not control relay, it can only be triggered by an external command (MQTT, HTTP, JSON or button)
 * `button` - button (from LED Settings) that controls this relay
-* `broadcast`- time in seconds between state broadcasts using MQTT
+* `broadcast`- time in seconds between MQTT relay-state broadcasts
 * `HA-discovery`- enable Home Assistant auto discovery
 
 If there is no MultiRelay section, just save current configuration and re-open Usermods settings page. 

usermods/multi_relay/usermod_multi_relay.h

@@ -66,12 +66,14 @@ class MultiRelay : public Usermod {
     static const char _HAautodiscovery[];
 
     void publishMqtt(int relay) {
+#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/relay/%d"), mqttDeviceTopic, relay);
         mqtt->publish(subuf, 0, false, _relay[relay].state ? "on" : "off");
       }
+#endif
     }
 
     /**
@@ -182,7 +184,7 @@ class MultiRelay : public Usermod {
      */
     MultiRelay() {
       const int8_t defPins[] = {MULTI_RELAY_PINS};
-      for (int i=0; i<MULTI_RELAY_MAX_RELAYS; i++) {
+      for (size_t i=0; i<MULTI_RELAY_MAX_RELAYS; i++) {
         _relay[i].pin      = i<sizeof(defPins) ? defPins[i] : -1;
         _relay[i].delay    = 0;
         _relay[i].mode     = false;
@@ -232,6 +234,7 @@ class MultiRelay : public Usermod {
 
     //Functions called by WLED
 
+#ifndef WLED_DISABLE_MQTT
     /**
      * handling of MQTT message
      * topic only contains stripped topic (part after /wled/MAC)
@@ -313,6 +316,7 @@ class MultiRelay : public Usermod {
         mqtt->publish(buf, 0, true, json_str, payload_size);
       }
     }
+#endif
 
     /**
      * setup() is called once at boot. WiFi is not yet connected at this point.

usermods/photoresistor_sensor_mqtt_v1/README.md

@@ -1,10 +1,12 @@
 # Photoresister sensor with MQTT
 
-This simple usermod allows attaching a photoresistor sensor like the KY-018 and publish the readings in percentage over MQTT. The frequency of MQTT messages can be modified, and there is a threshold value that can be set so that significant changes in the readings can be published immediately instead of waiting for the next update. This was found to be a good compromise between spamming MQTT messages and delayed updates.
+Enables attaching a photoresistor sensor like the KY-018 and publishing the readings as a percentage, via MQTT. The frequency of MQTT messages is user definable.
+A threshold value can be set so significant changes in the readings are published immediately vice waiting for the next update. This was found to be a good compromise between excessive MQTT traffic and delayed updates.
 
-I also found it useful to limit the frequency of analog pin reads because otherwise the board hangs.
+I also found it useful to limit the frequency of analog pin reads, otherwise the board hangs.
 
-This usermod has only been tested with the KY-018 sensor though should work for any other analog pin sensor. Note that this does not control the LED strip directly, it only publishes MQTT readings for use with other integrations like Home Assistant.
+This usermod has only been tested with the KY-018 sensor though it should work for any other analog pin sensor.
+Note: this does not control the LED strip directly, it only publishes MQTT readings for use with other integrations like Home Assistant.
 
 ## Installation
 

usermods/project_cars_shiftlight/readme.md

@@ -1,12 +1,11 @@
 ### Shift Light for Project Cars
 
 Turn your WLED lights into a rev light and shift indicator for Project Cars.
+It's easy to use.
 
-It is pretty straight forward to use.
+1. Make sure your WLED device and your PC/console are on the same network and can talk to each other
 
-1. Make sure, your WLED device and your PC/console are on the same network and can talk to each other
+2. Go to the gameplay settings menu in PCARS and enable UDP. There are 9 numbers you can choose from. This is the refresh rate. The lower the number, the better. However, you might run into problems at faster rates.
-
-2. Go to the gameplay settings menu in PCARS and enable UDP. There are 9 numbers you can choose from. This is the refresh rate. The lower the number, the better. But you might run into problems at faster rates.
 
 | Number | Updates/Second |
 | ------ | -------------- |
@@ -20,4 +19,5 @@ It is pretty straight forward to use.
 | 8      | 05             |
 | 9      | 1              |
 
-3. once you enter a race, WLED should automatically shift to PCARS mode. Done.
+3. Once you enter a race, WLED should automatically shift to PCARS mode.
+4. Done.

usermods/quinled-an-penta/readme.md

@@ -1,5 +1,5 @@
 # QuinLED-An-Penta
-The (un)official usermod to get the best out of the QuinLED-An-Penta (https://quinled.info/quinled-an-penta/), like using the OLED and the SHT30 temperature/humidity sensor.
+The (un)official usermod to get the best out of the QuinLED-An-Penta (https://quinled.info/quinled-an-penta/), e.g. using the OLED and the SHT30 temperature/humidity sensor.
 
 ## Requirements
 * "u8gs" by olikraus, v2.28 or higher: https://github.com/olikraus/u8g2
@@ -31,15 +31,15 @@ lib_deps = ${esp32.lib_deps}
 ## Some words about the (optional) OLED
 This mod has been optimized for an SSD1306 driven 128x64 OLED. Using a smaller OLED or an OLED using a different driver will result in unexpected results.
 I highly recommend using these "two color monochromatic OLEDs", which have the first 16 pixels in a different color than the other 48, e.g. a yellow/blue OLED.
-Also note, you need to have an **SPI** driven OLED, **not i2c**!
+Note: you _must_ use an **SPI** driven OLED, **not an i2c one**!
 
 ### Limitations combined with Ethernet
-The initial development of this mod had been done with a beta version of the QuinLED-An-Penta, which had a different IO layout for the OLED: The CS pin used to be IO_0, but has been changed to IO27 with the first v1 public release. Unfortunately, IO27 is used by the Ethernet boards, so WLED will not let you enable the OLED screen, if you're using it with Ethernet. This unfortunately makes the development I've done to support/show Ethernet information void, as it cannot be used.
+The initial development of this mod was done with a beta version of the QuinLED-An-Penta, which had a different IO layout for the OLED: The CS pin _was_ IO_0, but has been changed to IO27 with the first v1 public release. Unfortunately, IO27 is used by Ethernet boards, so WLED will not let you enable the OLED screen, if you're using it with Ethernet. Unfortunately, that makes the development I've done to support/show Ethernet information invalid, as it cannot be used.
-However (and I've not tried this, as I don't own a v1 board): You can try to modify this mod and try to use IO27 for the OLED and share it with the Ethernet board. It is "just" the chip select pin, so there is a chance that both can coexist and use the same IO. You need to skip WLEDs PinManager for the CS pin, so WLED will not block using it. If you don't know how this works: Leave it. If you know what I'm talking about: Try it and please let me know on the Intermit.Tech (QuinLED) Discord server: https://discord.gg/WdbAauG
+However, (and I've not tried this, as I don't own a v1 board) you can modify this usermod and try to use IO27 for the OLED and share it with the Ethernet board. It is "just" the chip select pin, so there is a chance that both can coexist and use the same IO. You need to skip WLEDs PinManager for the CS pin, so WLED will not block using it. If you don't know how this works, don't change it. If you know what I'm talking about, try it and please let me know on the Intermit.Tech (QuinLED) Discord server: https://discord.gg/WdbAauG
 
 ### My OLED flickers after some time, what should I do?
-That's a tricky one: During development I saw that the OLED sometimes starts to "bug out" / flicker and won't work anymore. This seems to be caused by the high PWM interference the board produces. It seems to loose its settings and then doesn't know how to draw anymore. Turns out the only way to fix this is to call the libraries `begin()` method again which will re-initialize the display.
+That's a tricky one. During development I saw that the OLED sometimes starts to "drop out" / flicker and won't work anymore. This seems to be caused by the high PWM interference the board produces. It seems to lose its settings then doesn't know how to draw anymore. Turns out the only way to fix this is to call the libraries `begin()` method again which re-initializes the display.
-If you're facing this issue, you can enable a setting I've added which will call the `begin()` roughly every 60 seconds between a page change. This will make the page change take ~500ms, but will fix the display.
+If you're facing this issue, you can enable a setting which will call the `begin()` roughly every 60 seconds between page changes. This will make the page change take ~500ms, but will fix the display.
 
 
 ## Configuration
@@ -53,11 +53,11 @@ Navigate to the "Config" and then to the "Usermods" section. If you compiled WLE
   * Possible values: Enabled/Disabled
   * Default: Disabled
 * OLED-Flip-Screen-180:
-  * What it does: Flips the screen 180° / upside-down
+  * What it does: Flips the screen 180°
   * Possible values: Enabled/Disabled
   * Default: Disabled
 * OLED-Seconds-Per-Page:
-  * What it does: Defines how long the OLED should stay on one page in seconds before changing to the next
+  * What it does: Number of seconds the OLED should stay on one page before changing pages
   * Possible values: Enabled/Disabled
   * Default: 10
 * OLED-Fix-Bugged-Screen:

usermods/readme.md

@@ -2,17 +2,17 @@
 
 This folder serves as a repository for usermods (custom `usermod.cpp` files)!
 
-If you have created an usermod that you believe is useful (for example to support a particular sensor, display, feature...), feel free to contribute by opening a pull request!
+If you have created a usermod you believe is useful (for example to support a particular sensor, display, feature...), feel free to contribute by opening a pull request!
 
 In order for other people to be able to have fun with your usermod, please keep these points in mind:
 
 -   Create a folder in this folder with a descriptive name (for example `usermod_ds18b20_temp_sensor_mqtt`)  
 -   Include your custom files 
--   If your usermod requires changes to other WLED files, please write a `readme.md` outlining the steps one has to take to use the usermod  
+-   If your usermod requires changes to other WLED files, please write a `readme.md` outlining the steps one needs to take  
 -   Create a pull request!  
 -   If your feature is useful for the majority of WLED users, I will consider adding it to the base code!  
 
-While I do my best to not break too much, keep in mind that as WLED is being updated, usermods might break.  
+While I do my best to not break too much, keep in mind that as WLED is updated, usermods might break.  
 I am not actively maintaining any usermod in this directory, that is your responsibility as the creator of the usermod.
 
 For new usermods, I would recommend trying out the new v2 usermod API, which allows installing multiple usermods at once and new functions!

usermods/rgb-rotary-encoder/readme.md

@@ -5,8 +5,8 @@ This usermod-v2 adds support for the awesome RGB Rotary Encoder Board by Adam Ze
 https://user-images.githubusercontent.com/3090131/124680599-0180ab80-dec7-11eb-9065-a6d08ebe0287.mp4
 
 ## Credits
-The actual / original code that does the different LED modes is from Adam Zeloof. So I don't take credit for these. But I ported it to WLED, which involved replacing the LED library he used (because, guess what, WLED already has one; so no need to add another one, but use whatever WLED uses), plus the rotary encoder library, because that one was not compatible with ESP, only Arduino.
+The actual / original code that controls the LED modes is from Adam Zeloof. I take no credit for it. I ported it to WLED, which involved replacing the LED library he used, (because WLED already has one, so no need to add another one) plus the rotary encoder library because it was not compatible with ESP, only Arduino.
-So it was quite more work than I hoped, but I got there eventually :)
+It was quite a bit more work than I hoped, but I got there eventually :)
 
 ## Requirements
 * "ESP Rotary" by Lennart Hennigs, v1.5.0 or higher: https://github.com/LennartHennigs/ESPRotary
@@ -33,25 +33,25 @@ lib_deps = ${esp8266.lib_deps}
 ```
 
 ## How to connect the board to your ESP
-We gonna need (minimum) three or (maximum) four GPIOs for the board:
+We'll need (minimum) three or (maximum) four GPIOs for the board:
-* "ea": Basically tells if the encoder goes into one or the other direction
+* "ea": reports the encoder direction
-* "eb": Same thing, but the other direction
+* "eb": Same thing, opposite direction
-* "di": LED data in. To actually control the LEDs
+* "di": LED data in.
-* *(optional)* "sw": The integrated switch in the rotary encoder. Can be omitted for the bare functionality of just controlling the brightness
+* *(optional)* "sw": The integrated switch in the rotary encoder. Can be omitted for the bare functionality of controlling only the brightness
 
-We also gonna need some power, so:
+We'll also need power:
 
 * "vdd": Needs to be connected to **+5V**.
-* "gnd": Well, it's GND.
+* "gnd": Ground.
 
-You can freely pick the GPIOs, it doesn't matter. Those will be configured in the "Usermods" section in the WLED web panel:
+You can freely pick the GPIOs, it doesn't matter. Those will be configured in the "Usermods" section of the WLED web panel:
 
 ## Configuration
-Navigate to the "Config" and then to the "Usermods" section. If you compiled WLED with `-D RGB_ROTARY_ENCODER`, you will see the config for it there. The settings there are the GPIOs we mentioned before (*Note: The switch pin is not there, as this can just be configured the "normal" button on the "LED Preferences" page*), plus a few more:
+Navigate to the "Config" and then to the "Usermods" section. If you compiled WLED with `-D RGB_ROTARY_ENCODER`, you will see the config for it there. The settings there are the aforementioned GPIOs, (*Note: The switch pin is not there, as this can just be configured the "normal" button on the "LED Preferences" page*) plus a few more:
 * LED pin:
   * Possible values: Any valid and available GPIO
   * Default: 3
-  * What it does: Pin to control the LED ring
+  * What it does: controls the LED ring
 * ea pin:
   * Possible values: Any valid and available GPIO
   * Default: 15
@@ -63,7 +63,7 @@ Navigate to the "Config" and then to the "Usermods" section. If you compiled WLE
 * LED Mode:
   * Possible values: 1-3
   * Default: 3
-  * What it does: The usermod provides three different modes of how the LEDs can look like. Here's an example: https://github.com/isotope-engineering/RGB-Encoder-Board/blob/master/images/rgb-encoder-animations.gif
+  * What it does: The usermod provides three different modes of how the LEDs can appear. Here's an example: https://github.com/isotope-engineering/RGB-Encoder-Board/blob/master/images/rgb-encoder-animations.gif
     * Up left is "1"
     * Up right is not supported / doesn't make sense for brightness control
     * Bottom left is "2"
@@ -71,15 +71,15 @@ Navigate to the "Config" and then to the "Usermods" section. If you compiled WLE
 * LED Brightness:
   * Possible values: 1-255
   * Default: 64
-  * What it does: Brightness of the LED ring
+  * What it does: sets LED ring Brightness
 * Steps per click:
   * Possible values: Any positive number
   * Default: 4
-  * What it does: With each "click", a rotary encoder actually increments it's "steps". Most rotary encoder do four "steps" per "click". I know this sounds super weird, so just leave this the default value, unless your rotary encoder behaves weirdly, like with one click, it makes two LEDs light up, or you sometimes need two click for one LED. Then you should play around with this value or write a small sketch using the same "ESP Rotary" library and read out the steps it does.
+  * What it does: With each "click", a rotary encoder actually increments its "steps". Most rotary encoders produce four "steps" per "click". Leave this at the default value unless your rotary encoder behaves strangely. e.g. with one click, it makes two LEDs light up, or you need two clicks for one LED. If that's the case, adjust this value or write a small sketch using the same "ESP Rotary" library and read out the steps it produce.
 * Increment per click:
   * Possible values: Any positive number
   * Default: 5
-  * What it does: Most rotary encoder have 20 "clicks", so basically 20 positions. This value should be set to 100 / `number of clicks`
+  * What it does: Most rotary encoders have 20 "clicks" or positions. This value should be set to 100/`number of clicks`
 
 ## Change log
 2021-07

usermods/sensors_to_mqtt/readme.md

@@ -1,12 +1,12 @@
-# Sensors To Home Assistant (or mqtt)
+# Send sensor data To Home Assistant
 
-This usermod will publish values of the BMP280, CCS811 and Si7021 sensors to Home Assistant via MQTT.
+Publishes BMP280, CCS811 and Si7021 measurements to Home Assistant via MQTT.
 
-Its using home assistant automatic device discovery feature.
+Uses Home Assistant Automatic Device Discovery.
 
-The use of Home Assistant is not mandatory; it will publish the sensor values via MQTT just fine without it.
+The use of Home Assistant is not mandatory. The mod will publish sensor values via MQTT just fine without it.
 
-Its resusing the mqtt connection set in the WLED web user interface.
+Uses the MQTT connection set in the WLED web user interface.
 
 ## Maintainer
 
@@ -15,12 +15,12 @@ twitter.com/mpronk89
 ## Features
 
 - Reads BMP280, CCS811 and Si7021 senors
-- Publishes via MQTT, configured via webui of wled
+- Publishes via MQTT, configured via WLED webUI
 - Announces device in Home Assistant for easy setup
 - Efficient energy usage
 - Updates every 60 seconds
 
-## Example mqtt topics:
+## Example MQTT topics:
 
 `$mqttDeviceTopic` is set in webui of WLED!
 
@@ -40,7 +40,7 @@ IAQ:  $mqttDeviceTopic/iaq
 ### Requirements
 
 1. BMP280/CCS811/Si7021 sensor. E.g. https://aliexpress.com/item/32979998543.html
-2. A microcontroller which can talk i2c, e.g. esp32
+2. A microcontroller that supports i2c. e.g. esp32
 
 ### installation
 
@@ -77,7 +77,7 @@ SDA_PIN = 4;
   adafruit/Adafruit Si7021 Library @ 1.4.0
 ```
 
-The #ifdefs in `usermods_list.cpp` should do the rest :)
+The #ifdefs in `usermods_list.cpp` should do the rest
 
 # Credits
 

usermods/sensors_to_mqtt/usermod_v2_SensorsToMqtt.h

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

usermods/seven_segment_display/readme.md

@@ -1,25 +1,25 @@
 # Seven Segment Display
 
-Usermod that uses the overlay feature to create a configurable seven segment display.  
+Uses the overlay feature to create a configurable seven segment display.  
-This has only been tested on a single configuration. Colon support is entirely  untested. 
+This has only been tested on a single configuration. Colon support has _not_ been tested. 
 
 ## Installation
 
 Add the compile-time option `-D USERMOD_SEVEN_SEGMENT` to your `platformio.ini` (or `platformio_override.ini`) or use `#define USERMOD_SEVEN_SEGMENT` in `my_config.h`.
 
 ## Settings
-Settings can be controlled through both the usermod setting page and through MQTT with a raw payload.
+Settings can be controlled via both the usermod setting page and through MQTT with a raw payload.
 ##### Example
  Topic ```<mqttDeviceTopic||mqttGroupTopic>/sevenSeg/perSegment/set```  
  Payload ```3```
 #### perSegment -- ssLEDPerSegment
-The number of individual LEDs per segment. There are 7 segments per digit.  
+The number of individual LEDs per segment. 7 segments per digit.  
 #### perPeriod -- ssLEDPerPeriod
-The number of individual LEDs per period. A ':' has 2x periods.
+The number of individual LEDs per period. A ':' (colon) has two periods.
 #### startIdx -- ssStartLED
-Index of the LED that the display starts at. Allows a seven segment display to be in the middle of a string.
+Index of the LED the display starts at. Enabless a seven segment display to be in the middle of a string.
 #### timeEnable -- ssTimeEnabled
-When true, when displayMask is configured for a time output and no message is set the time will  be displayed.
+When true, when displayMask is configured for a time output and no message is set, the time will be displayed.
 #### scrollSpd -- ssScrollSpeed
 Time, in milliseconds, between message shifts when the length of displayMsg exceeds the length of the displayMask.
 #### displayMask -- ssDisplayMask
@@ -35,9 +35,9 @@ All others for alpha numeric, (will be blank when displaying time)
 ```HHMMSS ```  
 ```hh:MM:SS ```
 #### displayMsg -- ssDisplayMessage
-Message to be displayed across the display. If the length exceeds the length of the displayMask the message will scroll at scrollSpd. To 'remove' a message or revert  back to time, if timeEnabled is true, set the message to '~'.
+Message to be displayed. If the message length exceeds the length of displayMask, the message will scroll at scrollSpd. To 'remove' a message or revert  back to time, if timeEnabled is true, set the message to '~'.
 #### displayCfg -- ssDisplayConfig
-The order that your LEDs are configured. All seven segments in the display need to be wired the same way.
+The order your LEDs are configured in. All segments in the display need to be wired the same way.
 <pre>
            -------
          /   A   /          0 - EDCGFAB

usermods/seven_segment_display/usermod_v2_seven_segment_display.h

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

usermods/seven_segment_display_reloaded/readme.md

@@ -1,6 +1,6 @@
 # Seven Segment Display Reloaded
 
-Usermod that uses the overlay feature to create a configurable seven segment display.
+Uses the overlay feature to create a configurable seven segment display.
 Optimized for maximum configurability and use with seven segment clocks by parallyze (https://www.instructables.com/member/parallyze/instructables/)
 Very loosely based on the existing usermod "seven segment display".
 
@@ -12,26 +12,26 @@ Add the compile-time option `-D USERMOD_SSDR` to your `platformio.ini` (or `plat
 For the auto brightness option, the usermod SN_Photoresistor has to be installed as well. See SN_Photoresistor/readme.md for instructions.
 
 ## Settings
-All settings can be controlled the usermod setting page.
+All settings can be controlled via the usermod settings page.
 Part of the settings can be controlled through MQTT with a raw payload or through a json request to /json/state.
 
 ### enabled
-Enables/disables this overlay usermod
+Enables/disables this usermod
 
 ### inverted
-Enables the inverted mode in which the background should be enabled and the digits should be black (leds off)
+Enables the inverted mode in which the background should be enabled and the digits should be black (LEDs off)
 
 ### Colon-blinking
 Enables the blinking colon(s) if they are defined
 
 ### enable-auto-brightness
-Enables the auto brightness feature. Can be only used with the usermod SN_Photoresistor installed.
+Enables the auto brightness feature. Can be used only when the usermod SN_Photoresistor is installed.
 
 ### auto-brightness-min / auto-brightness-max
 The lux value calculated from usermod SN_Photoresistor will be mapped to the values defined here.
-The mapping is 0 - 1000 lux will be mapped to auto-brightness-min - auto-brightness-max
+The mapping, 0 - 1000 lux, will be mapped to auto-brightness-min and auto-brightness-max
 
-The mA current protection of WLED will override the calculated value if it is too high.
+WLED current protection will override the calculated value if it is too high.
 
 ### Display-Mask
 Defines the type of the time/date display. 
@@ -61,7 +61,7 @@ See following example for usage.
 
 ## Example
 
-Example for Leds definition
+Example of an LED definition:
 ```
   <  A  >
 /\       /\
@@ -74,15 +74,15 @@ E        C
   <  D  >
 ```
 
-Leds or Range of Leds are seperated by a comma ","
+LEDs or Range of LEDs are separated by a comma ","
 
-Segments are seperated by a semicolon ";" and are read as A;B;C;D;E;F;G
+Segments are separated by a semicolon ";" and are read as A;B;C;D;E;F;G
 
-Digits are seperated by colon ":" -> A;B;C;D;E;F;G:A;B;C;D;E;F;G
+Digits are separated by colon ":" -> A;B;C;D;E;F;G:A;B;C;D;E;F;G
 
 Ranges are defined as lower to higher (lower first)
 
-For example, an clock definition for the following clock (https://www.instructables.com/Lazy-7-Quick-Build-Edition/) is
+For example, a clock definition for the following clock (https://www.instructables.com/Lazy-7-Quick-Build-Edition/) is
 
 - hour "59,46;47-48;50-51;52-53;54-55;57-58;49,56:0,13;1-2;4-5;6-7;8-9;11-12;3,10"
 
@@ -96,18 +96,18 @@ or
 
 depending on the orientation.
 
-# The example detailed:
+# Example details:
 hour "59,46;47-48;50-51;52-53;54-55;57-58;49,56:0,13;1-2;4-5;6-7;8-9;11-12;3,10"
 
-there are two digits seperated by ":"
+there are two digits separated by ":"
 
 - 59,46;47-48;50-51;52-53;54-55;57-58;49,56
 - 0,13;1-2;4-5;6-7;8-9;11-12;3,10
 
 In the first digit, 
-the **segment A** consists of the leds number **59 and 46**., **segment B** consists of the leds number **47, 48** and so on
+the **segment A** consists of the LEDs number **59 and 46**., **segment B** consists of the LEDs number **47, 48** and so on
 
-The second digit starts again with **segment A** and leds **0 and 13**, **segment B** consists of the leds number **1 and 2** and so on
+The second digit starts again with **segment A** and LEDs **0 and 13**, **segment B** consists of the LEDs number **1 and 2** and so on
 
 ### first digit of the hour
 - Segment A: 59, 46

usermods/seven_segment_display_reloaded/usermod_seven_segment_reloaded.h

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

usermods/sht/readme.md

@@ -0,0 +1,56 @@
+# SHT
+Usermod to support various SHT i2c sensors like the SHT30, SHT31, SHT35 and SHT85
+
+## Requirements
+* "SHT85" by Rob Tillaart, v0.2 or higher: https://github.com/RobTillaart/SHT85
+
+## Usermod installation
+Simply copy the below block (build task) to your `platformio_override.ini` and compile WLED using this new build task. Or use an existing one, add the buildflag `-D USERMOD_SHT` and the below library dependencies.
+
+ESP32:
+```
+[env:custom_esp32dev_usermod_sht]
+extends = env:esp32dev
+build_flags = ${common.build_flags_esp32}
+  -D USERMOD_SHT
+lib_deps = ${esp32.lib_deps}
+    robtillaart/SHT85@~0.3.3
+```
+
+ESP8266:
+```
+[env:custom_d1_mini_usermod_sht]
+extends = env:d1_mini
+build_flags = ${common.build_flags_esp8266}
+  -D USERMOD_SHT
+lib_deps = ${esp8266.lib_deps}
+    robtillaart/SHT85@~0.3.3
+```
+
+## MQTT Discovery for Home Assistant
+If you're using Home Assistant and want to have the temperature and humidity available as entities in HA, you can tick the "Add-To-Home-Assistant-MQTT-Discovery" option in the usermod settings. If you have an MQTT broker configured under "Sync Settings" and it is connected, the mod will publish the auto discovery message to your broker and HA will instantly find it and create an entity each for the temperature and humidity.
+
+### Publishing readings via MQTT
+Regardless of having MQTT discovery ticked or not, the mod will always report temperature and humidity to the WLED MQTT topic of that instance, if you have a broker configured and it's connected.
+
+## Configuration
+Navigate to the "Config" and then to the "Usermods" section. If you compiled WLED with `-D USERMOD_SHT`, you will see the config for it there:
+* SHT-Type:
+  * What it does: Select the SHT sensor type you want to use
+  * Possible values: SHT30, SHT31, SHT35, SHT85
+  * Default: SHT30
+* Unit:
+  * What it does: Select which unit should be used to display the temperature in the info section. Also used when sending via MQTT discovery, see below.
+  * Possible values: Celsius, Fahrenheit
+  * Default: Celsius
+* Add-To-HA-MQTT-Discovery:
+  * What it does: Makes the temperature and humidity available via MQTT discovery, so they're automatically added to Home Assistant, because that way it's typesafe.
+  * Possible values: Enabled/Disabled
+  * Default: Disabled
+
+## Change log
+2022-12
+* First implementation.
+
+## Credits
+ezcGman | Andy: Find me on the Intermit.Tech (QuinLED) Discord server: https://discord.gg/WdbAauG

usermods/sht/usermod_sht.h

@@ -0,0 +1,485 @@
+#ifndef WLED_ENABLE_MQTT
+#error "This user mod requires MQTT to be enabled."
+#endif
+
+#pragma once
+
+#include "SHT85.h"
+
+#define USERMOD_SHT_TYPE_SHT30 0
+#define USERMOD_SHT_TYPE_SHT31 1
+#define USERMOD_SHT_TYPE_SHT35 2
+#define USERMOD_SHT_TYPE_SHT85 3
+
+class ShtUsermod : public Usermod
+{
+  private:
+    bool enabled = false; // Is usermod enabled or not
+    bool firstRunDone = false; // Remembers if the first config load run had been done
+    bool pinAllocDone = true; // Remembers if we have allocated pins
+    bool initDone = false; // Remembers if the mod has been completely initialised
+    bool haMqttDiscovery = false; // Is MQTT discovery enabled or not
+    bool haMqttDiscoveryDone = false; // Remembers if we already published the HA discovery topics
+
+    // SHT vars
+    SHT *shtTempHumidSensor; // Instance of SHT lib
+    byte shtType = 0; // SHT sensor type to be used. Default: SHT30
+    byte unitOfTemp = 0; // Temperature unit to be used. Default: Celsius (0 = Celsius, 1 = Fahrenheit)
+    bool shtInitDone = false; // Remembers if SHT sensor has been initialised
+    bool shtReadDataSuccess = false; // Did we have a successful data read and is a valid temperature and humidity available?
+    const byte shtI2cAddress = 0x44; // i2c address of the sensor. 0x44 is the default for all SHT sensors. Change this, if needed
+    unsigned long shtLastTimeUpdated = 0; // Remembers when we read data the last time
+    bool shtDataRequested = false; // Reading data is done async. This remembers if we asked the sensor to read data
+    float shtCurrentTempC = 0.0f; // Last read temperature in Celsius
+    float shtCurrentHumidity = 0.0f; // Last read humidity in RH%
+
+
+    void initShtTempHumiditySensor();
+    void cleanupShtTempHumiditySensor();
+    void cleanup();
+    bool isShtReady();
+
+    void publishTemperatureAndHumidityViaMqtt();
+    void publishHomeAssistantAutodiscovery();
+    void appendDeviceToMqttDiscoveryMessage(JsonDocument& root);
+
+  public:
+    // Strings to reduce flash memory usage (used more than twice)
+    static const char _name[];
+    static const char _enabled[];
+    static const char _shtType[];
+    static const char _unitOfTemp[];
+    static const char _haMqttDiscovery[];
+
+    void setup();
+    void loop();
+    void onMqttConnect(bool sessionPresent);
+    void appendConfigData();
+    void addToConfig(JsonObject &root);
+    bool readFromConfig(JsonObject &root);
+    void addToJsonInfo(JsonObject& root);
+
+    bool isEnabled() { return enabled; }
+
+    float getTemperature();
+    float getTemperatureC() { return roundf(shtCurrentTempC * 10.0f) / 10.0f; }
+    float getTemperatureF() { return (getTemperatureC() * 1.8f) + 32.0f; }
+    float getHumidity() { return roundf(shtCurrentHumidity * 10.0f) / 10.0f; }
+    const char* getUnitString();
+
+    uint16_t getId() { return USERMOD_ID_SHT; }
+};
+
+// Strings to reduce flash memory usage (used more than twice)
+const char ShtUsermod::_name[]            PROGMEM = "SHT-Sensor";
+const char ShtUsermod::_enabled[]         PROGMEM = "Enabled";
+const char ShtUsermod::_shtType[]         PROGMEM = "SHT-Type";
+const char ShtUsermod::_unitOfTemp[]      PROGMEM = "Unit";
+const char ShtUsermod::_haMqttDiscovery[] PROGMEM = "Add-To-HA-MQTT-Discovery";
+
+/**
+ * Initialise SHT sensor.
+ *
+ * Using the correct constructor according to config and initialises it using the
+ * global i2c pins.
+ *
+ * @return void
+ */
+void ShtUsermod::initShtTempHumiditySensor()
+{
+  switch (shtType) {
+    case USERMOD_SHT_TYPE_SHT30: shtTempHumidSensor = (SHT *) new SHT30(); break;
+    case USERMOD_SHT_TYPE_SHT31: shtTempHumidSensor = (SHT *) new SHT31(); break;
+    case USERMOD_SHT_TYPE_SHT35: shtTempHumidSensor = (SHT *) new SHT35(); break;
+    case USERMOD_SHT_TYPE_SHT85: shtTempHumidSensor = (SHT *) new SHT85(); break;
+  }
+
+  shtTempHumidSensor->begin(shtI2cAddress, i2c_sda, i2c_scl);
+  if (shtTempHumidSensor->readStatus() == 0xFFFF) {
+    DEBUG_PRINTF("[%s] SHT init failed!\n", _name);
+    cleanup();
+    return;
+  }
+
+  shtInitDone = true;
+}
+
+/**
+ * Cleanup the SHT sensor.
+ *
+ * Properly calls "reset" for the sensor then releases it from memory.
+ *
+ * @return void
+ */
+void ShtUsermod::cleanupShtTempHumiditySensor()
+{
+  if (isShtReady()) shtTempHumidSensor->reset();
+  delete shtTempHumidSensor;
+  shtInitDone = false;
+}
+
+/**
+ * Cleanup the mod completely.
+ *
+ * Calls ::cleanupShtTempHumiditySensor() to cleanup the SHT sensor and
+ * deallocates pins.
+ *
+ * @return void
+ */
+void ShtUsermod::cleanup()
+{
+  cleanupShtTempHumiditySensor();
+
+  if (pinAllocDone) {
+    PinManagerPinType pins[2] = { { i2c_sda, true }, { i2c_scl, true } };
+    pinManager.deallocateMultiplePins(pins, 2, PinOwner::HW_I2C);
+    pinAllocDone = false;
+  }
+
+  enabled = false;
+}
+
+/**
+ * Checks if the SHT sensor has been initialised.
+  *
+ * @return bool
+ */
+bool ShtUsermod::isShtReady()
+{
+  return shtInitDone;
+}
+
+/**
+ * Publish temperature and humidity to WLED device topic.
+ *
+ * Will add a "/temperature" and "/humidity" topic to the WLED device topic.
+ * Temperature will be written in configured unit.
+ *
+ * @return void
+ */
+void ShtUsermod::publishTemperatureAndHumidityViaMqtt() {
+  if (!WLED_MQTT_CONNECTED) return;
+  char buf[128];
+
+  snprintf_P(buf, 127, PSTR("%s/temperature"), mqttDeviceTopic);
+  mqtt->publish(buf, 0, false, String(getTemperature()).c_str());
+  snprintf_P(buf, 127, PSTR("%s/humidity"), mqttDeviceTopic);
+  mqtt->publish(buf, 0, false, String(getHumidity()).c_str());
+}
+
+/**
+ * If enabled, publishes HA MQTT device discovery topics.
+ *
+ * Will make Home Assistant add temperature and humidity as entities automatically.
+ *
+ * Note: Whenever usermods are part of the WLED integration in HA, this can be dropped.
+ *
+ * @return void
+ */
+void ShtUsermod::publishHomeAssistantAutodiscovery() {
+  if (!WLED_MQTT_CONNECTED) return;
+
+  char json_str[1024], buf[128];
+  size_t payload_size;
+  StaticJsonDocument<1024> json;
+
+  snprintf_P(buf, 127, PSTR("%s Temperature"), serverDescription);
+  json[F("name")] = buf;
+  snprintf_P(buf, 127, PSTR("%s/temperature"), mqttDeviceTopic);
+  json[F("stat_t")] = buf;
+  json[F("dev_cla")] = F("temperature");
+  json[F("stat_cla")] = F("measurement");
+  snprintf_P(buf, 127, PSTR("%s-temperature"), escapedMac.c_str());
+  json[F("uniq_id")] = buf;
+  json[F("unit_of_meas")] = unitOfTemp ? F("°F") : F("°C");
+  appendDeviceToMqttDiscoveryMessage(json);
+  payload_size = serializeJson(json, json_str);
+  snprintf_P(buf, 127, PSTR("homeassistant/sensor/%s/%s-temperature/config"), escapedMac.c_str(), escapedMac.c_str());
+  mqtt->publish(buf, 0, true, json_str, payload_size);
+
+  json.clear();
+
+  snprintf_P(buf, 127, PSTR("%s Humidity"), serverDescription);
+  json[F("name")] = buf;
+  snprintf_P(buf, 127, PSTR("%s/humidity"), mqttDeviceTopic);
+  json[F("stat_t")] = buf;
+  json[F("dev_cla")] = F("humidity");
+  json[F("stat_cla")] = F("measurement");
+  snprintf_P(buf, 127, PSTR("%s-humidity"), escapedMac.c_str());
+  json[F("uniq_id")] = buf;
+  json[F("unit_of_meas")] = F("%");
+  appendDeviceToMqttDiscoveryMessage(json);
+  payload_size = serializeJson(json, json_str);
+  snprintf_P(buf, 127, PSTR("homeassistant/sensor/%s/%s-humidity/config"), escapedMac.c_str(), escapedMac.c_str());
+  mqtt->publish(buf, 0, true, json_str, payload_size);
+
+  haMqttDiscoveryDone = true;
+}
+
+/**
+ * Helper to add device information to MQTT discovery topic.
+ *
+ * @return void
+ */
+void ShtUsermod::appendDeviceToMqttDiscoveryMessage(JsonDocument& root) {
+  JsonObject device = root.createNestedObject(F("dev"));
+  device[F("ids")] = escapedMac.c_str();
+  device[F("name")] = serverDescription;
+  device[F("sw")] = versionString;
+  device[F("mdl")] = ESP.getChipModel();
+  device[F("mf")] = F("espressif");
+}
+
+/**
+ * Setup the mod.
+ *
+ * Allocates i2c pins as PinOwner::HW_I2C, so they can be allocated multiple times.
+ * And calls ::initShtTempHumiditySensor() to initialise the sensor.
+ *
+ * @see Usermod::setup()
+ * @see UsermodManager::setup()
+ *
+ * @return void
+ */
+void ShtUsermod::setup()
+{
+  if (enabled) {
+    PinManagerPinType pins[2] = { { i2c_sda, true }, { i2c_scl, true } };
+    // GPIOs can be set to -1 and allocateMultiplePins() will return true, so check they're gt zero
+    if (i2c_sda < 0 || i2c_scl < 0 || !pinManager.allocateMultiplePins(pins, 2, PinOwner::HW_I2C)) {
+      DEBUG_PRINTF("[%s] SHT pin allocation failed!\n", _name);
+      cleanup();
+      return;
+    }
+    pinAllocDone = true;
+
+    initShtTempHumiditySensor();
+
+    initDone = true;
+  }
+
+  firstRunDone = true;
+}
+
+/**
+ * Actually reading data (async) from the sensor every 30 seconds.
+ *
+ * If last reading is at least 30 seconds, it will trigger a reading using
+ * SHT::requestData(). We will then continiously check SHT::dataReady() if
+ * data is ready to be read. If so, it's read, stored locally and published
+ * via MQTT.
+ *
+ * @see Usermod::loop()
+ * @see UsermodManager::loop()
+ *
+ * @return void
+ */
+void ShtUsermod::loop()
+{
+  if (!enabled || !initDone || strip.isUpdating()) return;
+
+  if (isShtReady()) {
+    if (millis() - shtLastTimeUpdated > 30000 && !shtDataRequested) {
+      shtTempHumidSensor->requestData();
+      shtDataRequested = true;
+
+      shtLastTimeUpdated = millis();
+    }
+
+    if (shtDataRequested) {
+      if (shtTempHumidSensor->dataReady()) {
+        if (shtTempHumidSensor->readData(false)) {
+          shtCurrentTempC = shtTempHumidSensor->getTemperature();
+          shtCurrentHumidity = shtTempHumidSensor->getHumidity();
+
+          publishTemperatureAndHumidityViaMqtt();
+          shtReadDataSuccess = true;
+        } else {
+          shtReadDataSuccess = false;
+        }
+
+        shtDataRequested = false;
+      }
+    }
+  }
+}
+
+/**
+ * Whenever MQTT is connected, publish HA autodiscovery topics.
+ *
+ * Is only donce once.
+ *
+ * @see Usermod::onMqttConnect()
+ * @see UsermodManager::onMqttConnect()
+ *
+ * @return void
+ */
+void ShtUsermod::onMqttConnect(bool sessionPresent) {
+  if (haMqttDiscovery && !haMqttDiscoveryDone) publishHomeAssistantAutodiscovery();
+}
+
+/**
+ * Add dropdown for sensor type and unit to UM config page.
+ *
+ * @see Usermod::appendConfigData()
+ * @see UsermodManager::appendConfigData()
+ *
+ * @return void
+ */
+void ShtUsermod::appendConfigData() {
+  oappend(SET_F("dd=addDropdown('"));
+  oappend(_name);
+  oappend(SET_F("','"));
+  oappend(_shtType);
+  oappend(SET_F("');"));
+  oappend(SET_F("addOption(dd,'SHT30',0);"));
+  oappend(SET_F("addOption(dd,'SHT31',1);"));
+  oappend(SET_F("addOption(dd,'SHT35',2);"));
+  oappend(SET_F("addOption(dd,'SHT85',3);"));
+  oappend(SET_F("dd=addDropdown('"));
+  oappend(_name);
+  oappend(SET_F("','"));
+  oappend(_unitOfTemp);
+  oappend(SET_F("');"));
+  oappend(SET_F("addOption(dd,'Celsius',0);"));
+  oappend(SET_F("addOption(dd,'Fahrenheit',1);"));
+}
+
+/**
+ * Add config data to be stored in cfg.json.
+ *
+ * @see Usermod::addToConfig()
+ * @see UsermodManager::addToConfig()
+ *
+ * @return void
+ */
+void ShtUsermod::addToConfig(JsonObject &root)
+{
+  JsonObject top = root.createNestedObject(FPSTR(_name)); // usermodname
+
+  top[FPSTR(_enabled)] = enabled;
+  top[FPSTR(_shtType)] = shtType;
+  top[FPSTR(_unitOfTemp)] = unitOfTemp;
+  top[FPSTR(_haMqttDiscovery)] = haMqttDiscovery;
+}
+
+/**
+ * Apply config on boot or save of UM config page.
+ *
+ * This is called whenever WLED boots and loads cfg.json, or when the UM config
+ * page is saved. Will properly re-instantiate the SHT class upon type change and
+ * publish HA discovery after enabling.
+ *
+ * @see Usermod::readFromConfig()
+ * @see UsermodManager::readFromConfig()
+ *
+ * @return bool
+ */
+bool ShtUsermod::readFromConfig(JsonObject &root)
+{
+  JsonObject top = root[FPSTR(_name)];
+  if (top.isNull()) {
+    DEBUG_PRINTF("[%s] No config found. (Using defaults.)\n", _name);
+    return false;
+  }
+
+  bool oldEnabled = enabled;
+  byte oldShtType = shtType;
+  byte oldUnitOfTemp = unitOfTemp;
+  bool oldHaMqttDiscovery = haMqttDiscovery;
+
+  getJsonValue(top[FPSTR(_enabled)], enabled);
+  getJsonValue(top[FPSTR(_shtType)], shtType);
+  getJsonValue(top[FPSTR(_unitOfTemp)], unitOfTemp);
+  getJsonValue(top[FPSTR(_haMqttDiscovery)], haMqttDiscovery);
+
+  // First run: reading from cfg.json, nothing to do here, will be all done in setup()
+  if (!firstRunDone) {
+    DEBUG_PRINTF("[%s] First run, nothing to do\n", _name);
+  }
+  // Check if mod has been en-/disabled
+  else if (enabled != oldEnabled) {
+    enabled ? setup() : cleanup();
+    DEBUG_PRINTF("[%s] Usermod has been en-/disabled\n", _name);
+  }
+  // Config has been changed, so adopt to changes
+  else if (enabled) {
+    if (oldShtType != shtType) {
+      cleanupShtTempHumiditySensor();
+      initShtTempHumiditySensor();
+    }
+
+    if (oldUnitOfTemp != unitOfTemp) {
+      publishTemperatureAndHumidityViaMqtt();
+      publishHomeAssistantAutodiscovery();
+    }
+
+    if (oldHaMqttDiscovery != haMqttDiscovery && haMqttDiscovery) {
+      publishHomeAssistantAutodiscovery();
+    }
+
+    DEBUG_PRINTF("[%s] Config (re)loaded\n", _name);
+  }
+
+  return true;
+}
+
+/**
+ * Adds the temperature and humidity actually to the info section and /json info.
+ *
+ * This is called every time the info section is opened ot /json is called.
+ *
+ * @see Usermod::addToJsonInfo()
+ * @see UsermodManager::addToJsonInfo()
+ *
+ * @return void
+ */
+void ShtUsermod::addToJsonInfo(JsonObject& root)
+{
+  if (!enabled && !isShtReady()) {
+    return;
+  }
+
+  JsonObject user = root["u"];
+  if (user.isNull()) user = root.createNestedObject("u");
+
+  JsonArray jsonTemp = user.createNestedArray(F("Temperature"));
+  JsonArray jsonHumidity = user.createNestedArray(F("Humidity"));
+
+  if (shtLastTimeUpdated == 0 || !shtReadDataSuccess) {
+    jsonTemp.add(0);
+    jsonHumidity.add(0);
+    if (shtLastTimeUpdated == 0) {
+      jsonTemp.add(F(" Not read yet"));
+      jsonHumidity.add(F(" Not read yet"));
+    } else {
+      jsonTemp.add(F(" Error"));
+      jsonHumidity.add(F(" Error"));
+    }
+    return;
+  }
+
+  jsonHumidity.add(getHumidity());
+  jsonHumidity.add(F(" RH"));
+
+  jsonTemp.add(getTemperature());
+  jsonTemp.add(unitOfTemp ? "°F" : "°C");
+}
+
+/**
+ * Getter for last read temperature for configured unit.
+ *
+ * @return float
+ */
+float ShtUsermod::getTemperature() {
+  return unitOfTemp ? getTemperatureF() : getTemperatureC();
+}
+
+/**
+ * Returns the current configured unit as human readable string.
+ *
+ * @return const char*
+ */
+const char* ShtUsermod::getUnitString() {
+  return unitOfTemp ? "°F" : "°C";
+}

usermods/smartnest/readme.md

@@ -1,6 +1,6 @@
 # Smartnest
 
-This usermod-v2 modification allows integration with `smartnest.cz` service which provides MQTT integration with voice assistants.
+Enables integration with `smartnest.cz` service which provides MQTT integration with voice assistants.
 In order to setup Smartnest follow the [documentation](https://www.docu.smartnest.cz/).
 
 ## MQTT API
@@ -49,7 +49,7 @@ void registerUsermods()
 
 ## Configuration
 
-Usermod has no configuration but relies on the MQTT configuration.\
+Usermod has no configuration, but it relies on the MQTT configuration.\
 Under Config > Sync Interfaces > MQTT:
 * Enable MQTT check box
 * Set the `Broker` field to: `smartnest.cz`

usermods/smartnest/usermod_smartnest.h

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

usermods/stairway_wipe_basic/readme.md

@@ -2,13 +2,13 @@
 
 Quick usermod to accomplish something similar to [this video](https://www.youtube.com/watch?v=NHkju5ncC4A).
 
-This usermod allows you to add a lightstrip alongside or on the steps of a staircase.
+This usermod enables you to add a lightstrip alongside or on the steps of a staircase.
 When the `userVar0` variable is set, the LEDs will gradually turn on in a Wipe effect.
 Both directions are supported by setting userVar0 to 1 and 2, respectively (HTTP API commands `U0=1` and `U0=2`).
 
-After the Wipe is complete, the light will either stay on (Solid effect) indefinitely or after `userVar1` seconds have elapsed.
+After the Wipe is complete, the light will either stay on (Solid effect) indefinitely or extinguish after `userVar1` seconds have elapsed.
-If userVar0 is updated (e.g. by triggering a second sensor) the light will slowly fade off.
+If userVar0 is updated (e.g. by triggering a second sensor) the light will fade slowly until it's off.
-This could be extended to also run a Wipe effect in reverse order to turn the LEDs back off.
+This could be extended to also run a Wipe effect in reverse order to turn the LEDs off.
 
 This is just a basic version to accomplish this using HTTP API calls `U0` and `U1` and/or macros.
-It should be easy to adapt this code however to interface with motion sensors or other input devices.
+It should be easy to adapt this code to interface with motion sensors or other input devices.

usermods/usermod_rotary_brightness_color/README.md

@@ -1,18 +1,18 @@
 # Rotary Encoder (Brightness and Color)
 
-V2 usermod that allows changing brightness and color using a rotary encoder, 
+V2 usermod that enables changing brightness and color using a rotary encoder 
 change between modes by pressing a button (many encoders have one included)
 
-but it will wait for AUTOSAVE_SETTLE_MS milliseconds, a "settle" 
+it will wait for AUTOSAVE_SETTLE_MS milliseconds. a "settle" 
 period in case there are other changes (any change will 
-extend the "settle" window).
+extend the "settle" period).
 
 It will additionally load preset AUTOSAVE_PRESET_NUM at startup.
 during the first `loop()`.  Reasoning below.
 
 AutoSaveUsermod is standalone, but if FourLineDisplayUsermod is installed, it will notify the user of the saved changes.
 
-Note: I don't love that WLED doesn't respect the brightness of the preset being auto loaded, so the AutoSaveUsermod will set the AUTOSAVE_PRESET_NUM preset in the first loop, so brightness IS honored. This means WLED will effectively ignore Default brightness and Apply N preset at boot when the AutoSaveUsermod is installed.
+Note: WLED doesn't respect the brightness of the preset being auto loaded, so the AutoSaveUsermod will set the AUTOSAVE_PRESET_NUM preset in the first loop, so brightness IS honored. This means WLED will effectively ignore Default brightness and Apply N preset at boot when the AutoSaveUsermod is installed.
 
 ## Installation
 

usermods/usermod_v2_auto_save/readme.md

@@ -9,13 +9,13 @@ to preset number AUTOSAVE_PRESET_NUM after a change to any of:
 * palette
 
 but it will wait for AUTOSAVE_AFTER_SEC seconds,
-a "settle" period in case there are other changes (any change will extend the "settle" window).
+a "settle" period in case there are other changes (any change will extend the "settle" period).
 
 It will additionally load preset AUTOSAVE_PRESET_NUM at startup during the first `loop()`.
 
 AutoSaveUsermod is standalone, but if FourLineDisplayUsermod is installed, it will notify the user of the saved changes.
 
-Note: I don't love that WLED doesn't respect the brightness of the preset being auto loaded, so the AutoSaveUsermod will set the AUTOSAVE_PRESET_NUM preset in the first loop, so brightness IS honored. This means WLED will effectively ignore Default brightness and Apply N preset at boot when the AutoSaveUsermod is installed.
+Note: WLED doesn't respect the brightness of the preset being auto loaded, so the AutoSaveUsermod will set the AUTOSAVE_PRESET_NUM preset in the first loop, so brightness IS honored. This means WLED will effectively ignore Default brightness and Apply N preset at boot when the AutoSaveUsermod is installed.
 
 ## Installation
 
@@ -25,7 +25,7 @@ This file should be placed in the same directory as `platformio.ini`.
 
 ### Define Your Options
 
-* `USERMOD_AUTO_SAVE`           - define this to have this the Auto Save usermod included wled00\usermods_list.cpp
+* `USERMOD_AUTO_SAVE`           - define this to have this usermod included wled00\usermods_list.cpp
 * `AUTOSAVE_AFTER_SEC`          - define the delay time after the settings auto-saving routine should be executed
 * `AUTOSAVE_PRESET_NUM`         - define the preset number used by autosave usermod
 * `USERMOD_AUTO_SAVE_ON_BOOT`   - define if autosave should be enabled on boot

usermods/usermod_v2_four_line_display/readme.md

@@ -2,9 +2,9 @@
 
 First, thanks to the authors of the ssd11306_i2c_oled_u8g2 mod.
 
-This usermod provides a four line display using either
+Provides a four line display using either
 128x32 or 128x64 OLED displays.
-It's can operate independently, but starts to provide
+It can operate independently, but starts to provide
 a relatively complete on-device UI when paired with the 
 Rotary Encoder UI usermod. I strongly encourage you to use 
 them together.
@@ -19,11 +19,11 @@ This file should be placed in the same directory as `platformio.ini`.
 
 ### Define Your Options
 
-* `USERMOD_FOUR_LINE_DISPLAY`  - define this to have this the Four Line Display mod included wled00\usermods_list.cpp - also tells Rotary Encoder usermod, if installed, that the display is available
+* `USERMOD_FOUR_LINE_DISPLAY`  - define this to have this mod included wled00\usermods_list.cpp - also tells Rotary Encoder usermod, if installed, the display is available
 * `FLD_PIN_SCL`                - The display SCL pin, defaults to 5
 * `FLD_PIN_SDA`                - The display SDA pin, defaults to 4
 
-All of the parameters can be configured using Usermods settings page, inluding GPIO pins.
+All of the parameters can be configured via the Usermods settings page, inluding GPIO pins.
 
 ### PlatformIO requirements
 
@@ -44,7 +44,7 @@ UI usermod folder for how to include these using `platformio_override.ini`.
     * 6 = SPI SSD1306 128x32
     * 7 = SPI SSD1306 128x64 (4 double-height lines)
 * `contrast` - set display contrast (higher contrast may reduce display lifetime)
-* `refreshRateSec` - time in seconds for display refresh
+* `refreshRateSec` - display refresh time in seconds
 * `screenTimeOutSec` - screen saver time-out in seconds
 * `flip` - flip/rotate display 180°
 * `sleepMode` - enable/disable screen saver

usermods/usermod_v2_four_line_display_ALT/readme.md

@@ -4,12 +4,12 @@ Thank you to the authors of the original version of these usermods. It would not
 "usermod_v2_four_line_display"
 "usermod_v2_rotary_encoder_ui"
 
-The core of these usermods are a copy of the originals. The main changes are done to the FourLineDisplay usermod.
+The core of these usermods are a copy of the originals. The main changes are to the FourLineDisplay usermod.
 The display usermod UI has been completely changed.
 
 
 The changes made to the RotaryEncoder usermod were made to support the new UI in the display usermod. 
-Without the display it functions identical to the original.
+Without the display it, functions identical to the original.
 The original "usermod_v2_auto_save" will not work with the display just yet.
 
 Press the encoder to cycle through the options:
@@ -22,7 +22,7 @@ Press the encoder to cycle through the options:
     *Saturation (only if display is used)
 
 Press and hold the encoder to display Network Info
-    if AP is active then it will display AP ssid and Password
+    if AP is active, it will display AP, SSID and password
 
 Also shows if the timer is enabled
 

usermods/usermod_v2_four_line_display_ALT/usermod_v2_four_line_display_ALT.h

@@ -106,6 +106,7 @@ class FourLineDisplayUsermod : public Usermod {
     static FourLineDisplayUsermod *instance;
     bool initDone = false;
     volatile bool drawing = false;
+    volatile bool lockRedraw = false;
 
     // HW interface & configuration
     U8X8 *u8x8 = nullptr;           // pointer to U8X8 display object
@@ -198,25 +199,33 @@ class FourLineDisplayUsermod : public Usermod {
     }
     void drawString(uint8_t col, uint8_t row, const char *string, bool ignoreLH=false) {
       if (type == NONE || !enabled) return;
+      drawing = true;
       u8x8->setFont(u8x8_font_chroma48medium8_r);
       if (!ignoreLH && lineHeight==2) u8x8->draw1x2String(col, row, string);
       else                            u8x8->drawString(col, row, string);
+      drawing = false;
     }
     void draw2x2String(uint8_t col, uint8_t row, const char *string) {
       if (type == NONE || !enabled) return;
+      drawing = true;
       u8x8->setFont(u8x8_font_chroma48medium8_r);
       u8x8->draw2x2String(col, row, string);
+      drawing = false;
     }
     void drawGlyph(uint8_t col, uint8_t row, char glyph, const uint8_t *font, bool ignoreLH=false) {
       if (type == NONE || !enabled) return;
+      drawing = true;
       u8x8->setFont(font);
       if (!ignoreLH && lineHeight==2) u8x8->draw1x2Glyph(col, row, glyph);
       else                            u8x8->drawGlyph(col, row, glyph);
+      drawing = false;
     }
     void draw2x2Glyph(uint8_t col, uint8_t row, char glyph, const uint8_t *font) {
       if (type == NONE || !enabled) return;
+      drawing = true;
       u8x8->setFont(font);
       u8x8->draw2x2Glyph(col, row, glyph);
+      drawing = false;
     }
     uint8_t getCols() {
       if (type==NONE || !enabled) return 0;
@@ -224,7 +233,9 @@ class FourLineDisplayUsermod : public Usermod {
     }
     void clear() {
       if (type == NONE || !enabled) return;
+      drawing = true;
       u8x8->clear();
+      drawing = false;
     }
     void setPowerSave(uint8_t save) {
       if (type == NONE || !enabled) return;
@@ -238,6 +249,7 @@ class FourLineDisplayUsermod : public Usermod {
     }
 
     void draw2x2GlyphIcons() {
+      drawing = true;
       if (lineHeight == 2) {
         drawGlyph( 1,            0, 1, u8x8_4LineDisplay_WLED_icons_2x2, true); //brightness icon
         drawGlyph( 5,            0, 2, u8x8_4LineDisplay_WLED_icons_2x2, true); //speed icon
@@ -251,6 +263,7 @@ class FourLineDisplayUsermod : public Usermod {
         drawGlyph(15, 2, 4, u8x8_4LineDisplay_WLED_icons_1x1); //palette icon
         drawGlyph(15, 3, 5, u8x8_4LineDisplay_WLED_icons_1x1); //effect icon
       }
+      drawing = false;
     }
 
     /**
@@ -262,8 +275,8 @@ class FourLineDisplayUsermod : public Usermod {
       if (type == NONE || !enabled || !displayTurnedOff) return;
 
       unsigned long now = millis();
-      while (drawing && millis()-now < 250) delay(1); // wait if someone else is drawing
+      while (drawing && millis()-now < 125) delay(1); // wait if someone else is drawing
-      drawing = true;
+      if (drawing) return;
 
       char lineBuffer[LINE_BUFFER_SIZE];
       static byte lastSecond;
@@ -299,7 +312,23 @@ class FourLineDisplayUsermod : public Usermod {
         sprintf_P(lineBuffer, PSTR("%02d"), secondCurrent);
         drawString(12, lineHeight*2+1, lineBuffer, true); // even with double sized rows print seconds in 1 line
       }
-      drawing = false;
+    }
+
+    /**
+     * Enable sleep (turn the display off) or clock mode.
+     */
+    void sleepOrClock(bool enabled) {
+      if (enabled) {
+        displayTurnedOff = true;
+        if (clockMode && ntpEnabled) {
+          knownMinute = knownHour = 99;
+          showTime();
+        } else
+          setPowerSave(1);
+      } else {
+        displayTurnedOff = false;
+        setPowerSave(0);
+      }
     }
 
   public:
@@ -483,7 +512,8 @@ class FourLineDisplayUsermod : public Usermod {
         }
       }
 
-      while (drawing && millis()-now < 250) delay(1); // wait if someone else is drawing
+      while (drawing && millis()-now < 25) delay(1); // wait if someone else is drawing
+      if (drawing || lockRedraw) return;
 
       if (apActive && WLED_WIFI_CONFIGURED && now<15000) {
         knownSsid = apSSID;
@@ -580,44 +610,49 @@ class FourLineDisplayUsermod : public Usermod {
     void updateBrightness() {
       knownBrightness = bri;
       if (overlayUntil == 0) {
+        lockRedraw = true;
         brightness100 = ((uint16_t)bri*100)/255;
         char lineBuffer[4];
         sprintf_P(lineBuffer, PSTR("%-3d"), brightness100);
         drawString(1, lineHeight, lineBuffer);
-        //lastRedraw = millis();
+        lockRedraw = false;
       }
     }
 
     void updateSpeed() {
       knownEffectSpeed = effectSpeed;
       if (overlayUntil == 0) {
+        lockRedraw = true;
         fxspeed100 = ((uint16_t)effectSpeed*100)/255;
         char lineBuffer[4];
         sprintf_P(lineBuffer, PSTR("%-3d"), fxspeed100);
         drawString(5, lineHeight, lineBuffer);
-        //lastRedraw = millis();
+        lockRedraw = false;
       }
     }
 
     void updateIntensity() {
       knownEffectIntensity = effectIntensity;
       if (overlayUntil == 0) {
+        lockRedraw = true;
         fxintensity100 = ((uint16_t)effectIntensity*100)/255;
         char lineBuffer[4];
         sprintf_P(lineBuffer, PSTR("%-3d"), fxintensity100);
         drawString(9, lineHeight, lineBuffer);
-        //lastRedraw = millis();
+        lockRedraw = false;
       }
     }
 
     void drawStatusIcons() {
       uint8_t col = 15;
       uint8_t row = 0;
+      lockRedraw = true;
       drawGlyph(col, row,   (wificonnected ? 20 : 0), u8x8_4LineDisplay_WLED_icons_1x1, true); // wifi icon
       if (lineHeight==2) { col--; } else { row++; }
       drawGlyph(col, row,          (bri > 0 ? 9 : 0), u8x8_4LineDisplay_WLED_icons_1x1, true); // power icon
       if (lineHeight==2) { col--; } else { col = row = 0; }
       drawGlyph(col, row, (nightlightActive ? 6 : 0), u8x8_4LineDisplay_WLED_icons_1x1, true); // moon icon for nighlight mode
+      lockRedraw = false;
     }
     
     /**
@@ -632,7 +667,9 @@ class FourLineDisplayUsermod : public Usermod {
 
     //Draw the arrow for the current setting beiong changed
     void drawArrow() {
+      lockRedraw = true;
       if (markColNum != 255 && markLineNum !=255) drawGlyph(markColNum, markLineNum*lineHeight, 21, u8x8_4LineDisplay_WLED_icons_1x1);
+      lockRedraw = false;
     }
 
     //Display the current effect or palette (desiredEntry) 
@@ -640,6 +677,7 @@ class FourLineDisplayUsermod : public Usermod {
     void showCurrentEffectOrPalette(int inputEffPal, const char *qstring, uint8_t row) {
       char lineBuffer[MAX_JSON_CHARS];
       if (overlayUntil == 0) {
+        lockRedraw = true;
         // Find the mode name in JSON
         uint8_t printedChars = extractModeName(inputEffPal, qstring, lineBuffer, MAX_JSON_CHARS-1);
         if (lineBuffer[0]=='*' && lineBuffer[1]==' ') {
@@ -692,6 +730,7 @@ class FourLineDisplayUsermod : public Usermod {
           smallBuffer3[smallChars3] = 0;
           drawString(1, row*lineHeight, smallBuffer3, true);
         }
+        lockRedraw = false;
       }
     }
 
@@ -706,12 +745,12 @@ class FourLineDisplayUsermod : public Usermod {
       if (displayTurnedOff) {
         unsigned long now = millis();
         while (drawing && millis()-now < 250) delay(1); // wait if someone else is drawing
-        drawing = true;
+        if (drawing) return false;
+        lockRedraw = true;
         clear();
         // Turn the display back on
         sleepOrClock(false);
-        //lastRedraw = millis();
+        lockRedraw = false;
-        drawing = false;
         return true;
       }
       return false;
@@ -724,8 +763,9 @@ class FourLineDisplayUsermod : public Usermod {
      */
     void overlay(const char* line1, long showHowLong, byte glyphType) {
       unsigned long now = millis();
-      while (drawing && millis()-now < 250) delay(1); // wait if someone else is drawing
+      while (drawing && millis()-now < 125) delay(1); // wait if someone else is drawing
-      drawing = true;
+      if (drawing) return;
+      lockRedraw = true;
       // Turn the display back on
       if (!wakeDisplay()) clear();
       // Print the overlay
@@ -739,7 +779,7 @@ class FourLineDisplayUsermod : public Usermod {
         drawString(0, (glyphType<255?3:0)*lineHeight, buf.c_str());
       }
       overlayUntil = millis() + showHowLong;
-      drawing = false;
+      lockRedraw = false;
     }
 
     /**
@@ -748,8 +788,9 @@ class FourLineDisplayUsermod : public Usermod {
      */
     void overlayLogo(long showHowLong) {
       unsigned long now = millis();
-      while (drawing && millis()-now < 250) delay(1); // wait if someone else is drawing
+      while (drawing && millis()-now < 125) delay(1); // wait if someone else is drawing
-      drawing = true;
+      if (drawing) return;
+      lockRedraw = true;
       // Turn the display back on
       if (!wakeDisplay()) clear();
       // Print the overlay
@@ -799,7 +840,7 @@ class FourLineDisplayUsermod : public Usermod {
         }
       }
       overlayUntil = millis() + showHowLong;
-      drawing = false;
+      lockRedraw = false;
     }
 
     /**
@@ -809,8 +850,9 @@ class FourLineDisplayUsermod : public Usermod {
      */
     void overlay(const char* line1, const char* line2, long showHowLong) {
       unsigned long now = millis();
-      while (drawing && millis()-now < 250) delay(1); // wait if someone else is drawing
+      while (drawing && millis()-now < 125) delay(1); // wait if someone else is drawing
-      drawing = true;
+      if (drawing) return;
+      lockRedraw = true;
       // Turn the display back on
       if (!wakeDisplay()) clear();
       // Print the overlay
@@ -825,13 +867,14 @@ class FourLineDisplayUsermod : public Usermod {
         drawString(0, 2*lineHeight, buf.c_str());
       }
       overlayUntil = millis() + showHowLong;
-      drawing = false;
+      lockRedraw = false;
     }
 
     void networkOverlay(const char* line1, long showHowLong) {
       unsigned long now = millis();
-      while (drawing && millis()-now < 250) delay(1); // wait if someone else is drawing
+      while (drawing && millis()-now < 125) delay(1); // wait if someone else is drawing
-      drawing = true;
+      if (drawing) return;
+      lockRedraw = true;
 
       String line;
       // Turn the display back on
@@ -863,27 +906,10 @@ class FourLineDisplayUsermod : public Usermod {
       center(line, getCols());
       drawString(0, lineHeight*3, line.c_str());
       overlayUntil = millis() + showHowLong;
-      drawing = false;
+      lockRedraw = false;
     }
 
 
-    /**
-     * Enable sleep (turn the display off) or clock mode.
-     */
-    void sleepOrClock(bool enabled) {
-      if (enabled) {
-        displayTurnedOff = true;
-        if (clockMode && ntpEnabled) {
-          knownMinute = knownHour = 99;
-          showTime();
-        } else
-          setPowerSave(1);
-      } else {
-        displayTurnedOff = false;
-        setPowerSave(0);
-      }
-    }
-
     /**
      * handleButton() can be used to override default button behaviour. Returning true
      * will prevent button working in a default way.

usermods/usermod_v2_klipper_percentage/readme.md

@@ -0,0 +1,40 @@
+# Klipper Percentage Usermod
+This usermod polls the Klipper API every 10s for the progressvalue.
+The leds are then filled with a solid color according to that progress percentage. 
+the solid color is the secondary color of the segment.
+
+A corresponding curl command would be:
+```
+curl --location --request GET 'http://[]/printer/objects/query?virtual_sdcard=progress'
+```
+## Usage
+Compile the source with the buildflag  `-D USERMOD_KLIPPER_PERCENTAGE` added.
+
+You can also use the WLBD bot in the Discord by simply extending an exsisting build enviroment:
+```
+[env:esp32klipper]
+extends = env:esp32dev
+build_flags = ${common.build_flags_esp32} -D USERMOD_KLIPPER_PERCENTAGE
+```
+
+## Settings 
+
+### Enabled:
+Checkbox to enable or disable the overlay
+
+### Klipper IP: 
+IP adress of your Klipper instance you want to poll. ESP has to be restarted after change
+
+### Direction : 
+0 = normal
+
+1 = reversed
+
+2 = center
+
+-----
+Author:
+
+Sören Willrodt
+
+Discord: Sören#5281

usermods/usermod_v2_klipper_percentage/usermod_v2_klipper_percentage.h

@@ -0,0 +1,222 @@
+#pragma once
+
+#include "wled.h"
+
+class klipper_percentage : public Usermod
+{
+private:
+  unsigned long lastTime = 0;
+  String ip = "192.168.25.207";
+  WiFiClient wifiClient;
+  char errorMessage[100] = "";
+  int printPercent = 0;
+  int direction = 0; // 0 for along the strip, 1 for reversed direction
+
+  static const char _name[];
+  static const char _enabled[];
+  bool enabled = false;
+
+  void httpGet(WiFiClient &client, char *errorMessage)
+  {
+    // https://arduinojson.org/v6/example/http-client/
+    // is this the most compact way to do http get and put it in arduinojson object???
+    // would like async response ... ???
+    client.setTimeout(10000);
+    if (!client.connect(ip.c_str(), 80))
+    {
+      strcat(errorMessage, PSTR("Connection failed"));
+    }
+    else
+    {
+      // Send HTTP request
+      client.println(F("GET /printer/objects/query?virtual_sdcard=progress HTTP/1.0"));
+      client.println("Host: " + ip);
+      client.println(F("Connection: close"));
+      if (client.println() == 0)
+      {
+        strcat(errorMessage, PSTR("Failed to send request"));
+      }
+      else
+      {
+        // Check HTTP status
+        char status[32] = {0};
+        client.readBytesUntil('\r', status, sizeof(status));
+        if (strcmp(status, "HTTP/1.1 200 OK") != 0)
+        {
+          strcat(errorMessage, PSTR("Unexpected response: "));
+          strcat(errorMessage, status);
+        }
+        else
+        {
+          // Skip HTTP headers
+          char endOfHeaders[] = "\r\n\r\n";
+          if (!client.find(endOfHeaders))
+          {
+            strcat(errorMessage, PSTR("Invalid response"));
+          }
+        }
+      }
+    }
+  }
+
+public:
+  void setup()
+  {
+  }
+
+  void connected()
+  {
+  }
+
+  void loop()
+  {
+    if (enabled)
+    {
+      if (WLED_CONNECTED)
+      {
+        if (millis() - lastTime > 10000)
+        {
+          httpGet(wifiClient, errorMessage);
+          if (strcmp(errorMessage, "") == 0)
+          {
+            PSRAMDynamicJsonDocument klipperDoc(4096); // in practive about 2673
+            DeserializationError error = deserializeJson(klipperDoc, wifiClient);
+            if (error)
+            {
+              strcat(errorMessage, PSTR("deserializeJson() failed: "));
+              strcat(errorMessage, error.c_str());
+            }
+            printPercent = (int)(klipperDoc["result"]["status"]["virtual_sdcard"]["progress"].as<float>() * 100);
+
+            DEBUG_PRINT("Percent: ");
+            DEBUG_PRINTLN((int)(klipperDoc["result"]["status"]["virtual_sdcard"]["progress"].as<float>() * 100));
+            DEBUG_PRINT("LEDs: ");
+            DEBUG_PRINTLN(direction == 2 ? (strip.getLengthTotal() / 2) * printPercent / 100 : strip.getLengthTotal() * printPercent / 100);
+          }
+          else
+          {
+            DEBUG_PRINTLN(errorMessage);
+            DEBUG_PRINTLN(ip);
+          }
+          lastTime = millis();
+        }
+      }
+    }
+  }
+
+  void addToConfig(JsonObject &root)
+  {
+    JsonObject top = root.createNestedObject("Klipper Printing Percentage");
+    top["Enabled"] = enabled;
+    top["Klipper IP"] = ip;
+    top["Direction"] = direction;
+  }
+
+  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["Klipper Printing Percentage"];
+
+    bool configComplete = !top.isNull();
+    configComplete &= getJsonValue(top["Klipper IP"], ip);
+    configComplete &= getJsonValue(top["Enabled"], enabled);
+    configComplete &= getJsonValue(top["Direction"], direction);
+    return configComplete;
+  }
+
+  /*
+   * 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");
+
+    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 += enabled ? F(":false}});\">") : F(":true}});\">");
+    uiDomString += F("<i class=\"icons");
+    uiDomString += enabled ? F(" on") : F(" off");
+    uiDomString += F("\">&#xe08f;</i>");
+    uiDomString += F("</button>");
+    infoArr.add(uiDomString);
+  }
+
+  void addToJsonState(JsonObject &root)
+  {
+    JsonObject usermod = root[FPSTR(_name)];
+    if (usermod.isNull())
+    {
+      usermod = root.createNestedObject(FPSTR(_name));
+    }
+    usermod["on"] = 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>();
+      }
+    }
+  }
+
+  /*
+   * 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()
+  {
+    if (enabled)
+    {
+      if (direction == 0) // normal
+      {
+        for (int i = 0; i < strip.getLengthTotal() * printPercent / 100; i++)
+        {
+          strip.setPixelColor(i, strip.getSegment(0).colors[1]);
+        }
+      }
+      else if (direction == 1) // reversed
+      {
+        for (int i = 0; i < strip.getLengthTotal() * printPercent / 100; i++)
+        {
+          strip.setPixelColor(strip.getLengthTotal() - i, strip.getSegment(0).colors[1]);
+        }
+      }
+      else if (direction == 2) // center
+      {
+        for (int i = 0; i < (strip.getLengthTotal() / 2) * printPercent / 100; i++)
+        {
+          strip.setPixelColor((strip.getLengthTotal() / 2) + i, strip.getSegment(0).colors[1]);
+          strip.setPixelColor((strip.getLengthTotal() / 2) - i, strip.getSegment(0).colors[1]);
+        }
+      }
+      else
+      {
+        direction = 0;
+      }
+    }
+  }
+
+  /*
+   * 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_KLIPPER;
+  }
+};
+const char klipper_percentage::_name[] PROGMEM = "Klipper_Percentage";
+const char klipper_percentage::_enabled[] PROGMEM = "enabled";

usermods/usermod_v2_mode_sort/readme.md

@@ -8,26 +8,26 @@ palettes to other usermods. Notably it provides:
 
 ```char **getModesQStrings()```
 
-Provides an array of char* (pointers) to the names of the
+Provides a char* array (pointers) to the names of the
-palettes within JSON_mode_names, in the same order as 
+palettes contained in JSON_mode_names, in the same order as 
 JSON_mode_names. These strings end in double quote (")
 (or \0 if there is a problem).
 
 ```byte *getModesAlphaIndexes()```
 
-An array of byte designating the indexes of names of the
+A byte array designating the indexes of names of the
 modes in alphabetical order. "Solid" will always remain 
-at the front of the list.
+at the top of the list.
 
 ```char **getPalettesQStrings()```
 
-Provides an array of char* (pointers) to the names of the
+Provides a char* array (pointers) to the names of the
-palettes within JSON_palette_names, in the same order as 
+palettes contained in JSON_palette_names, in the same order as 
 JSON_palette_names. These strings end in double quote (")
 (or \0 if there is a problem).
 
 ```byte *getPalettesAlphaIndexes()```
 
-An array of byte designating the indexes of names of the
+A byte array designating the indexes of names of the
 palettes in alphabetical order. "Default" and those
-starting with "(" will always remain at the front of the list.
+starting with "(" will always remain at the top of the list.

usermods/usermod_v2_ping_pong_clock/readme.md

@@ -1,8 +1,10 @@
 # Ping Pong LED Clock
 
-This Usermod File contains a modification to use WLED in combination with the Ping Pong Ball LED Clock as built in [Instructables](https://www.instructables.com/Ping-Pong-Ball-LED-Clock/).
+Contains a modification to use WLED in combination with the Ping Pong Ball LED Clock as built in [Instructables](https://www.instructables.com/Ping-Pong-Ball-LED-Clock/).
 
 ## Installation 
 
-To install this Usermod you instruct PlatformIO to compile the Projekt with the USERMOD_PING_PONG_CLOCK flag. WLED then automatically provides you with various settings in the Usermod Page to configure this Usermod.    
+To install this Usermod, you instruct PlatformIO to compile the Project with the USERMOD_PING_PONG_CLOCK flag.
-Note: If your clock is bigger or smaller then mine, you may have to update the led indices for the indivdual numbers and the base indices.
+WLED then automatically provides you with various settings on the Usermod Page.
+
+Note: Depending on the size of your clock, you may have to update the led indices for the indivdual numbers and the base indices.

usermods/usermod_v2_rotary_encoder_ui/readme.md

@@ -20,10 +20,10 @@ This file should be placed in the same directory as `platformio.ini`.
 * `USERMOD_FOUR_LINE_DISPLAY`       - define this to have this the Four Line Display mod included wled00\usermods_list.cpp
                                         also tells this usermod that the display is available
                                         (see the Four Line Display usermod `readme.md` for more details)
-* `ENCODER_DT_PIN`                  - The encoders DT pin, defaults to 12
+* `ENCODER_DT_PIN`                    - defaults to 12
-* `ENCODER_CLK_PIN`                 - The encoders CLK pin, defaults to 14
+* `ENCODER_CLK_PIN`                 - defaults to 14
-* `ENCODER_SW_PIN`                  - The encoders SW pin, defaults to 13
+* `ENCODER_SW_PIN`                    - defaults to 13
-* `USERMOD_ROTARY_ENCODER_GPIO`     - The GPIO functionality:
+* `USERMOD_ROTARY_ENCODER_GPIO`     - GPIO functionality:
                                         `INPUT_PULLUP` to use internal pull-up
                                         `INPUT` to use pull-up on the PCB
 

usermods/usermod_v2_rotary_encoder_ui_ALT/readme.md

@@ -4,12 +4,12 @@ Thank you to the authors of the original version of these usermods. It would not
 "usermod_v2_four_line_display"
 "usermod_v2_rotary_encoder_ui"
 
-The core of these usermods are a copy of the originals. The main changes are done to the FourLineDisplay usermod.
+The core of these usermods are a copy of the originals. The main changes are to the FourLineDisplay usermod.
 The display usermod UI has been completely changed.
 
 
 The changes made to the RotaryEncoder usermod were made to support the new UI in the display usermod. 
-Without the display it functions identical to the original.
+Without the display, it functions identical to the original.
 The original "usermod_v2_auto_save" will not work with the display just yet.
 
 Press the encoder to cycle through the options:
@@ -22,17 +22,17 @@ Press the encoder to cycle through the options:
     *Saturation (only if display is used)
 
 Press and hold the encoder to display Network Info
-    if AP is active then it will display AP ssid and Password
+    if AP is active, it will display the AP, SSID and Password
 
-Also shows if the timer is enabled
+Also shows if the timer is enabled.
 
 [See the pair of usermods in action](https://www.youtube.com/watch?v=ulZnBt9z3TI)
 
 ## Installation
 
-Please refer to the original `usermod_v2_rotary_encoder_ui` readme for the main instructions
+Please refer to the original `usermod_v2_rotary_encoder_ui` readme for the main instructions.<br/>
-Then to activate this alternative usermod add `#define USE_ALT_DISPlAY` to the `usermods_list.cpp` file,
+To activate this alternative usermod, add `#define USE_ALT_DISPlAY` to the `usermods_list.cpp` file,
-                                        or add `-D USE_ALT_DISPlAY` to the original `platformio_override.ini.sample` file
+or add `-D USE_ALT_DISPlAY` to the original `platformio_override.ini.sample` file.
 
 
 ### PlatformIO requirements

usermods/usermod_v2_rotary_encoder_ui_ALT/usermod_v2_rotary_encoder_ui_ALT.h

@@ -750,7 +750,7 @@ public:
       StaticJsonDocument<64> root;
       char str[64];
       sprintf_P(str, PSTR("%d~%d~%s"), presetLow, presetHigh, increase?"":"-");
-      root[F("ps")] = str;
+      root["ps"] = str;
       deserializeState(root.as<JsonObject>(), CALL_MODE_BUTTON_PRESET);
 /*
       String apireq = F("win&PL=~");

usermods/usermod_v2_word_clock/readme.md

@@ -1,8 +1,8 @@
 # Word Clock Usermod V2
 
-This usermod can be used to drive a wordclock with a 11x10 pixel matrix with WLED. There are also 4 additional dots for the minutes. 
+This usermod drives an 11x10 pixel matrix wordclock with WLED. There are 4 additional dots for the minutes. 
-The visualisation is desribed in 4 mask with LED numbers (single dots for minutes, minutes, hours and "clock/Uhr"). The index of the LEDs in the masks always starts with the index 0, even if the ledOffset is not 0.
+The visualisation is described by 4 masks with LED numbers (single dots for minutes, minutes, hours and "clock"). The index of the LEDs in the masks always starts at 0, even if the ledOffset is not 0.
-There are 3 parameters to change the behaviour:
+There are 3 parameters that control behavior:
  
 active: enable/disable usermod
 diplayItIs: enable/disable display of "Es ist" on the clock
@@ -10,23 +10,23 @@ ledOffset: number of LEDs before the wordclock LEDs
 
 ### Update for alternatative wiring pattern
 Based on this fantastic work I added an alternative wiring pattern.
-For original you have to use a long wire to connect DO - DI from first line to the next line.
+The original used a long wire to connect DO to DI, from one line to the next line.
 
-I wired my clock in meander style. So the first LED in second line is in the right.
+I wired my clock in meander style. So the first LED in the second line is on the right.
-With this problem every second line was inverted and showed the wrong letter.
+With this method, every other line was inverted and showed the wrong letter.
 
-I added a switch in usermod called "meander wiring?" to enable/disable alternativ wiring pattern.
+I added a switch in usermod called "meander wiring?" to enable/disable the alternate wiring pattern.
 
 
 ## Installation
 
 Copy and update the example `platformio_override.ini.sample` 
-from the Rotary Encoder UI usermode folder to the root directory of your particular build.
+from the Rotary Encoder UI usermod folder to the root directory of your particular build.
 This file should be placed in the same directory as `platformio.ini`.
 
 ### Define Your Options
 
-* `USERMOD_WORDCLOCK`   - define this to have this the Auto Save usermod included wled00\usermods_list.cpp
+* `USERMOD_WORDCLOCK`   - define this to have this usermod included wled00\usermods_list.cpp
 
 ### PlatformIO requirements
 

usermods/usermod_v2_word_clock/usermod_v2_word_clock.h

@@ -25,6 +25,7 @@ class WordClockUsermod : public Usermod
     bool displayItIs = false;
     int ledOffset = 100;
     bool meander = false;
+    bool nord = false;
     
     // defines for mask sizes
     #define maskSizeLeds        114
@@ -37,7 +38,7 @@ class WordClockUsermod : public Usermod
 
     // "minute" masks
     // Normal wiring
-    const int maskMinutes[12][maskSizeMinutes] = 
+    const int maskMinutes[14][maskSizeMinutes] = 
     {
       {107, 108, 109,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1}, // :00
       {  7,   8,   9,  10,  40,  41,  42,  43,  -1,  -1,  -1,  -1}, // :05 fünf nach
@@ -50,11 +51,13 @@ class WordClockUsermod : public Usermod
       { 15,  16,  17,  18,  19,  20,  21,  33,  34,  35,  -1,  -1}, // :40 zwanzig vor
       { 22,  23,  24,  25,  26,  27,  28,  29,  30,  31,  32,  -1}, // :45 dreiviertel
       { 11,  12,  13,  14,  33,  34,  35,  -1,  -1,  -1,  -1,  -1}, // :50 zehn vor
-      {  7,   8,   9,  10,  33,  34,  35,  -1,  -1,  -1,  -1,  -1}  // :55 fünf vor
+      {  7,   8,   9,  10,  33,  34,  35,  -1,  -1,  -1,  -1,  -1}, // :55 fünf vor
+      { 26,  27,  28,  29,  30,  31,  32,  40,  41,  42,  43,  -1}, // :15 alternative viertel nach
+      { 26,  27,  28,  29,  30,  31,  32,  33,  34,  35,  -1,  -1}  // :45 alternative viertel vor
     };
 
     // Meander wiring
-    const int maskMinutesMea[12][maskSizeMinutesMea] = 
+    const int maskMinutesMea[14][maskSizeMinutesMea] = 
     {
       { 99, 100, 101,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1,  -1}, // :00
       {  7,   8,   9,  10,  33,  34,  35,  36,  -1,  -1,  -1,  -1}, // :05 fünf nach
@@ -67,9 +70,12 @@ class WordClockUsermod : public Usermod
       { 11,  12,  13,  14,  15,  16,  17,  41,  42,  43,  -1,  -1}, // :40 zwanzig vor
       { 22,  23,  24,  25,  26,  27,  28,  29,  30,  31,  32,  -1}, // :45 dreiviertel
       { 18,  19,  20,  21,  41,  42,  43,  -1,  -1,  -1,  -1,  -1}, // :50 zehn vor
-      {  7,   8,   9,  10,  41,  42,  43,  -1,  -1,  -1,  -1,  -1}  // :55 fünf vor
+      {  7,   8,   9,  10,  41,  42,  43,  -1,  -1,  -1,  -1,  -1}, // :55 fünf vor
+      { 26,  27,  28,  29,  30,  31,  32,  33,  34,  35,  36,  -1}, // :15 alternative viertel nach
+      { 26,  27,  28,  29,  30,  31,  32,  41,  42,  43,  -1,  -1}  // :45 alternative viertel vor
     };
 
+
     // hour masks
     // Normal wiring
     const int maskHours[13][maskSizeHours] = 
@@ -242,9 +248,15 @@ class WordClockUsermod : public Usermod
             setHours(hours, false);
             break;
         case 3:
+            if (nord) {
+              // viertel nach
+              setMinutes(12);
+              setHours(hours, false);
+            } else {
               // viertel 
               setMinutes(3);
               setHours(hours + 1, false);
+            };
             break;
         case 4:
             // 20 nach
@@ -272,8 +284,13 @@ class WordClockUsermod : public Usermod
             setHours(hours + 1, false);
             break;
         case 9:
-            // viertel vor
+            // viertel vor bzw dreiviertel
+            if (nord) {
               setMinutes(9);
+            } 
+              else {
+              setMinutes(12);
+            }
             setHours(hours + 1, false);
             break;
         case 10:
@@ -410,6 +427,7 @@ class WordClockUsermod : public Usermod
       top["displayItIs"] = displayItIs;
       top["ledOffset"] = ledOffset;
       top["Meander wiring?"] = meander;
+      top["Norddeutsch"] = nord;
     }
 
     /*
@@ -440,6 +458,7 @@ class WordClockUsermod : public Usermod
       configComplete &= getJsonValue(top["displayItIs"], displayItIs);
       configComplete &= getJsonValue(top["ledOffset"], ledOffset);
       configComplete &= getJsonValue(top["Meander wiring?"], meander);
+      configComplete &= getJsonValue(top["Norddeutsch"], nord);
 
       return configComplete;
     }

usermods/wizlights/readme.md

@@ -1,6 +1,6 @@
 # Controlling Wiz lights
 
-This usermod allows the control of [WiZ](https://www.wizconnected.com/en/consumer/) lights that are in the same network as the WLED controller.
+Enabless controlling [WiZ](https://www.wizconnected.com/en/consumer/) lights that are part of the same network as the WLED controller.
 
 The mod takes the colors from the first few pixels and sends them to the lights.
 
@@ -8,22 +8,22 @@ The mod takes the colors from the first few pixels and sends them to the lights.
 
 - Interval (ms)
     - How frequently to update the WiZ lights, in milliseconds.
-    - Setting too low may causse ESP to become unresponsive.
+    - Setting it too low may causse the ESP to become unresponsive.
 - Send Delay (ms)
     - An optional millisecond delay after updating each WiZ light. 
-    - Can help smooth out effects when using a larger number of WiZ lights
+    - Can help smooth out effects when using a large number of WiZ lights
 - Use Enhanced White
-    - Enables using the WiZ lights onboard white LEDs instead of sending maximum RGB values.
+    - Uses the WiZ lights onboard white LEDs instead of sending maximum RGB values.
     - Tunable with warm and cool LEDs as supported by WiZ bulbs
-    - Note: Only sent when max RGB value is set, need to have automatic brightness limiter disabled
+    - Note: Only sent when max RGB value is set, the automatic brightness limiter must be disabled
-    - ToDo: Have better logic for white value mixing to better take advantage of the lights capabilities
+    - ToDo: Have better logic for white value mixing to take advantage of the light's capabilities
 - Always Force Update
-    - Can be enabled to always send update message to light, even when color matches what was previously sent.
+    - Can be enabled to always send update message to light even if the new value matches the old value.
 - Force update every x minutes
-    - Configuration option to allow adjusting the default force update timeout of 5 minutes.
+    - adjusts the default force update timeout of 5 minutes.
-    - Setting to 0 has the same impact as enabling Always Force Update
+    - Setting to 0 is the same as enabling Always Force Update
     - 
-Then enter the IPs for the lights to be controlled, in order. There is currently a limit of 15 devices that can be controled, but that number
+Next, enter the IP addresses for the lights to be controlled, in order. The limit is 15 devices, but that number
 can be easily changed by updating _MAX_WIZ_LIGHTS_.
 
 
@@ -31,5 +31,5 @@ can be easily changed by updating _MAX_WIZ_LIGHTS_.
 
 ## Related project
 
-If you use these lights and python, make sure to check out the [pywizlight](https://github.com/sbidy/pywizlight) project. I learned how to
+If you use these lights and python, make sure to check out the [pywizlight](https://github.com/sbidy/pywizlight) project. You can learn how to
 format the messages to control the lights from that project.

usermods/wizlights/wizlights.h

@@ -75,6 +75,10 @@ class WizLightsUsermod : public Usermod {
       UDP.endPacket();
     }
 
+    // Override definition so it compiles
+    void setup() {
+      
+    }
 
 
     // TODO: Check millis() rollover

usermods/word-clock-matrix/readme.md

@@ -2,8 +2,8 @@
 
 By @bwente
 
-See https://www.hackster.io/bwente/word-clock-with-just-two-components-073834 for the hardware guide!
+See https://www.hackster.io/bwente/word-clock-with-just-two-components-073834 for the hardware guide!<br/>
-Includes a customizable feature to lower the brightness at night.
+Includes a customizable feature to reduce the brightness at night.
 
 ![image](https://user-images.githubusercontent.com/371964/197094071-f8ccaf59-1d85-4dd2-8e09-1389675291e1.png)
 

wled00/FX.h

@@ -72,8 +72,12 @@
   #ifndef MAX_NUM_SEGMENTS
     #define MAX_NUM_SEGMENTS  32
   #endif
+  #if defined(ARDUINO_ARCH_ESP32S2)
+    #define MAX_SEGMENT_DATA  24576
+  #else
     #define MAX_SEGMENT_DATA  32767
   #endif
+#endif
 
 /* How much data bytes each segment should max allocate to leave enough space for other segments,
   assuming each segment uses the same amount of data. 256 for ESP8266, 640 for ESP32. */
@@ -143,7 +147,7 @@
 #define FX_MODE_SAW                     16
 #define FX_MODE_TWINKLE                 17
 #define FX_MODE_DISSOLVE                18
-#define FX_MODE_DISSOLVE_RANDOM         19
+#define FX_MODE_DISSOLVE_RANDOM         19  // candidate for removal (use Dissolve with with check 3)
 #define FX_MODE_SPARKLE                 20
 #define FX_MODE_FLASH_SPARKLE           21
 #define FX_MODE_HYPER_SPARKLE           22
@@ -227,7 +231,7 @@
 #define FX_MODE_HEARTBEAT              100
 #define FX_MODE_PACIFICA               101
 #define FX_MODE_CANDLE_MULTI           102
-#define FX_MODE_SOLID_GLITTER          103
+#define FX_MODE_SOLID_GLITTER          103  // candidate for removal (use glitter)
 #define FX_MODE_SUNRISE                104
 #define FX_MODE_PHASED                 105
 #define FX_MODE_TWINKLEUP              106
@@ -241,7 +245,7 @@
 // #define FX_MODE_CANDY_CANE             114  // removed in 0.14!
 #define FX_MODE_BLENDS                 115
 #define FX_MODE_TV_SIMULATOR           116
-#define FX_MODE_DYNAMIC_SMOOTH         117
+#define FX_MODE_DYNAMIC_SMOOTH         117 // candidate for removal (check3 in dynamic)
 
 // new 0.14 2D effects
 #define FX_MODE_2DSPACESHIPS           118 //gap fill
@@ -250,6 +254,7 @@
 #define FX_MODE_2DBLOBS                121 //gap fill
 #define FX_MODE_2DSCROLLTEXT           122 //gap fill
 #define FX_MODE_2DDRIFTROSE            123 //gap fill
+#define FX_MODE_2DDISTORTIONWAVES      124
 
 // WLED-SR effects (SR compatible IDs !!!)
 #define FX_MODE_PIXELS                 128
@@ -369,9 +374,10 @@ typedef struct Segment {
     uint32_t call;  // call counter
     uint16_t aux0;  // custom var
     uint16_t aux1;  // custom var
-    byte* data;
+    byte* data;     // effect data pointer
-    CRGB* leds;
+    CRGB* leds;     // local leds[] array (may be a pointer to global)
-    static CRGB *_globalLeds;
+    static CRGB *_globalLeds;             // global leds[] array
+    static uint16_t maxWidth, maxHeight;  // these define matrix width & height (max. segment dimensions)
 
   private:
     union {
@@ -458,7 +464,7 @@ typedef struct Segment {
       _dataLen(0),
       _t(nullptr)
     {
-      refreshLightCapabilities();
+      //refreshLightCapabilities();
     }
 
     Segment(uint16_t sStartX, uint16_t sStopX, uint16_t sStartY, uint16_t sStopY) : Segment(sStartX, sStopX) {
@@ -494,6 +500,9 @@ typedef struct Segment {
     inline bool     isSelected(void)     const { return selected; }
     inline bool     isActive(void)       const { return stop > start; }
     inline bool     is2D(void)           const { return (width()>1 && height()>1); }
+    inline bool     hasRGB(void)         const { return _isRGB; }
+    inline bool     hasWhite(void)       const { return _hasW; }
+    inline bool     isCCT(void)          const { return _isCCT; }
     inline uint16_t width(void)          const { return stop - start; }       // segment width in physical pixels (length if 1D)
     inline uint16_t height(void)         const { return stopY - startY; }     // segment height (if 2D) in physical pixels
     inline uint16_t length(void)         const { return width() * height(); } // segment length (count) in physical pixels
@@ -503,6 +512,7 @@ typedef struct Segment {
     static uint16_t getUsedSegmentData(void)    { return _usedSegmentData; }
     static void     addUsedSegmentData(int len) { _usedSegmentData += len; }
 
+    void    set(uint16_t i1, uint16_t i2, uint8_t grp=1, uint8_t spc=0, uint16_t ofs=UINT16_MAX, uint16_t i1Y=0, uint16_t i2Y=1);
     bool    setColor(uint8_t slot, uint32_t c); //returns true if changed
     void    setCCT(uint16_t k);
     void    setOpacity(uint8_t o);
@@ -586,11 +596,13 @@ typedef struct Segment {
     void moveX(int8_t delta);
     void moveY(int8_t delta);
     void move(uint8_t dir, uint8_t delta);
+    void draw_circle(uint16_t cx, uint16_t cy, uint8_t radius, CRGB c);
     void fill_circle(uint16_t cx, uint16_t cy, uint8_t radius, CRGB c);
     void drawLine(uint16_t x0, uint16_t y0, uint16_t x1, uint16_t y1, uint32_t c);
     void drawLine(uint16_t x0, uint16_t y0, uint16_t x1, uint16_t y1, CRGB c) { drawLine(x0, y0, x1, y1, RGBW32(c.r,c.g,c.b,0)); } // automatic inline
-    void drawCharacter(unsigned char chr, int16_t x, int16_t y, uint8_t w, uint8_t h, uint32_t color);
+    void drawCharacter(unsigned char chr, int16_t x, int16_t y, uint8_t w, uint8_t h, uint32_t color, uint32_t col2 = 0);
     void drawCharacter(unsigned char chr, int16_t x, int16_t y, uint8_t w, uint8_t h, CRGB c) { drawCharacter(chr, x, y, w, h, RGBW32(c.r,c.g,c.b,0)); } // automatic inline
+    void drawCharacter(unsigned char chr, int16_t x, int16_t y, uint8_t w, uint8_t h, CRGB c, CRGB c2) { drawCharacter(chr, x, y, w, h, RGBW32(c.r,c.g,c.b,0), RGBW32(c2.r,c2.g,c2.b,0)); } // automatic inline
     void wu_pixel(uint32_t x, uint32_t y, CRGB c);
     void blur1d(fract8 blur_amount); // blur all rows in 1 dimension
     void blur2d(fract8 blur_amount) { blur(blur_amount); }
@@ -653,14 +665,7 @@ class WS2812FX {  // 96 bytes
       timebase(0),
       isMatrix(false),
 #ifndef WLED_DISABLE_2D
-      hPanels(1),
+      panels(1),
-      vPanels(1),
-      panelH(8),
-      panelW(8),
-      matrixWidth(DEFAULT_LED_COUNT),
-      matrixHeight(1),
-      matrix{0,0,0,0},
-      panel{{0,0,0,0}},
 #endif
       // semi-private (just obscured) used in effect functions through macros
       _currentPalette(CRGBPalette16(CRGB::Black)),
@@ -697,6 +702,9 @@ class WS2812FX {  // 96 bytes
       _mode.clear();
       _modeData.clear();
       _segments.clear();
+#ifndef WLED_DISABLE_2D
+      panel.clear();
+#endif
       customPalettes.clear();
       if (useLedsArray && Segment::_globalLeds) free(Segment::_globalLeds);
     }
@@ -710,7 +718,6 @@ class WS2812FX {  // 96 bytes
       finalizeInit(),
       service(void),
       setMode(uint8_t segid, uint8_t m),
-      setColor(uint8_t slot, uint8_t r, uint8_t g, uint8_t b, uint8_t w = 0),
       setColor(uint8_t slot, uint32_t c),
       setCCT(uint16_t k),
       setBrightness(uint8_t b, bool direct = false),
@@ -725,10 +732,10 @@ class WS2812FX {  // 96 bytes
       fixInvalidSegments(),
       setPixelColor(int n, uint32_t c),
       show(void),
-      setTargetFps(uint8_t fps),
+      setTargetFps(uint8_t fps);
-      deserializeMap(uint8_t n=0);
 
-    void fill(uint32_t c) { for (int i = 0; i < _length; i++) setPixelColor(i, c); } // fill whole strip with color (inline)
+    void setColor(uint8_t slot, uint8_t r, uint8_t g, uint8_t b, uint8_t w = 0) { setColor(slot, RGBW32(r,g,b,w)); }
+    void fill(uint32_t c) { for (int i = 0; i < getLengthTotal(); i++) setPixelColor(i, c); } // fill whole strip with color (inline)
     void addEffect(uint8_t id, mode_ptr mode_fn, const char *mode_name); // add effect to the list; defined in FX.cpp
     void setupEffectData(void); // add default effects to the list; defined in FX.cpp
 
@@ -746,6 +753,7 @@ class WS2812FX {  // 96 bytes
       hasCCTBus(void),
       // return true if the strip is being sent pixel updates
       isUpdating(void),
+      deserializeMap(uint8_t n=0),
       useLedsArray = false;
 
     inline bool isServicing(void) { return _isServicing; }
@@ -775,17 +783,17 @@ class WS2812FX {  // 96 bytes
       ablMilliampsMax,
       currentMilliamps,
       getLengthPhysical(void),
+      getLengthTotal(void), // will include virtual/nonexistent pixels in matrix
       getFps();
 
     inline uint16_t getFrameTime(void) { return _frametime; }
     inline uint16_t getMinShowDelay(void) { return MIN_SHOW_DELAY; }
-    inline uint16_t getLengthTotal(void) { return _length; }
+    inline uint16_t getLength(void) { return _length; } // 2D matrix may have less pixels than W*H
     inline uint16_t getTransition(void) { return _transitionDur; }
 
     uint32_t
       now,
       timebase,
-      currentColor(uint32_t colorNew, uint8_t tNr),
       getPixelColor(uint16_t);
 
     inline uint32_t getLastShow(void) { return _lastShow; }
@@ -809,24 +817,31 @@ class WS2812FX {  // 96 bytes
 #ifndef WLED_DISABLE_2D
     #define WLED_MAX_PANELS 64
     uint8_t
-      hPanels,
+      panels;
-      vPanels;
 
-    uint16_t
+    typedef struct panel_t {
-      panelH,
+      uint16_t xOffset; // x offset relative to the top left of matrix in LEDs
-      panelW,
+      uint16_t yOffset; // y offset relative to the top left of matrix in LEDs
-      matrixWidth,
+      uint8_t  width;   // width of the panel
-      matrixHeight;
+      uint8_t  height;  // height of the panel
-
+      union {
-    typedef struct panel_bitfield_t {
+        uint8_t options;
+        struct {
           bool bottomStart : 1; // starts at bottom?
           bool rightStart  : 1; // starts on right?
           bool vertical    : 1; // is vertical?
           bool serpentine  : 1; // is serpentine?
+        };
+      };
+      panel_t()
+        : xOffset(0)
+        , yOffset(0)
+        , width(8)
+        , height(8)
+        , options(0)
+      {}
     } Panel;
-    Panel
+    std::vector<Panel> panel;
-      matrix,
-      panel[WLED_MAX_PANELS];
 #endif
 
     void