Merge branch 'wled:main' into main

Author: robertvb83

usermods/Animated_Staircase/README.md

@@ -1,4 +1,5 @@
 # Usermod Animated Staircase
+
 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:
 
@@ -11,11 +12,13 @@ The Animated Staircase can be controlled by the WLED API. Change settings such a
 speed, on/off time and distance by sending an HTTP request, see below.
 
 ## WLED integration
+
 To include this usermod in your WLED setup, you have to be able to [compile WLED from source](https://kno.wled.ge/advanced/compiling-wled/).
 
 Before compiling, you have to make the following modifications:
 
 Edit your environment in `platformio_override.ini`
+
 1. Open `platformio_override.ini`
 2. add `Animated_Staircase` to the `custom_usermods` line for your environment
 
@@ -25,10 +28,10 @@ If you use PIR sensor enter -1 for echo pin.
 Maximum distance for ultrasonic sensor can be configured as the time needed for an echo (see below).
 
 ## Hardware installation
+
 1. Attach the LED strip to each step of the stairs.
 2. Connect the ESP8266 pin D4 or ESP32 pin D2 to the first LED data pin at the bottom step.
-3. Connect the data-out pin at the end of each strip per step to the data-in pin on the 
-   next step, creating one large virtual LED strip.
+3. Connect the data-out pin at the end of each strip per step to the data-in pin on the 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
@@ -37,24 +40,23 @@ Maximum distance for ultrasonic sensor can be configured as the time needed for
 You _may_ need to use 10k pull-down resistors on the selected PIR pins, depending on the sensor.
 
 ## WLED configuration
-1. In the WLED UI, configure a segment for each step. The lowest step of the stairs is the 
-   lowest segment id. 
-2. Save your segments into a preset. 
-3. Ideally, add the preset in the config > LED setup menu to the "apply 
-   preset **n** at boot" setting.
+
+1. In the WLED UI, configure a segment for each step. The lowest step of the stairs is the lowest segment id.
+2. Save your segments into a preset.
+3. Ideally, add the preset in the config > LED setup menu to the "apply preset **n** at boot" setting.
 
 ## Changing behavior through API
+
 The Staircase settings can be changed through the WLED JSON api.
 
 **NOTE:** We are using [curl](https://curl.se/) to send HTTP POSTs to the WLED API.
 If you're using Windows and want to use the curl commands, replace the `\` with a `^`
 or remove them and put everything on one line.
 
-
 | Setting          | Description                                                   | Default |
 |------------------|---------------------------------------------------------------|---------|
 | enabled          | Enable or disable the usermod                                 | true    |
-| bottom-sensor    | Manually trigger a down to up animation via API               | false   | 
+| bottom-sensor    | Manually trigger a down to up animation via API               | false   |
 | top-sensor       | Manually trigger an up to down animation via API              | false   |
 
 
@@ -74,6 +76,7 @@ The staircase settings and sensor states are inside the WLED "state" element:
 ```
 
 ### 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 you to play with the lights without the usermod switching them on or off.
 
@@ -90,6 +93,7 @@ To enable the usermod again, use `"enabled":true`.
 Alternatively you can use _Usermod_ Settings page where you can change other parameters as well.
 
 ### Changing animation parameters and detection range of the ultrasonic HC-SR04 sensor
+
 Using _Usermod_ Settings page you can define different usermod parameters, including sensor pins, delay between segment activation etc.
 
 When an ultrasonic sensor is enabled you can enter maximum detection distance in centimeters separately for top and bottom sensors.
@@ -99,6 +103,7 @@ distances creates delays in the WLED software, _might_ introduce timing hiccups
 a less responsive web interface. It is therefore advised to keep the detection distance as short as possible.
 
 ### Animation triggering through the API
+
 In addition to activation by one of the stair sensors, you can also trigger the animation manually
 via the API. To simulate triggering the bottom sensor, use:
 
@@ -115,15 +120,19 @@ curl -X POST -H "Content-Type: application/json" \
      -d '{"staircase":{"top-sensor":true}}' \
      xxx.xxx.xxx.xxx/json/state
 ```
+
 **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 the usermod.
 
-Have fun with this usermod.<br/>
-www.rolfje.com
+Have fun with this usermod
+
+`www.rolfje.com`
 
 Modifications @blazoncek
 
 ## Change log
+
 2021-04
-* Adaptation for runtime configuration.
+
+- Adaptation for runtime configuration.

usermods/BH1750_v2/readme.md

@@ -4,6 +4,7 @@ This usermod will read from an ambient light sensor like the BH1750.
 The luminance is displayed in both the Info section of the web UI, as well as published to the `/luminance` MQTT topic if enabled.
 
 ## Dependencies
+
 - Libraries
   - `claws/BH1750 @^1.2.0`
 - Data is published over MQTT - make sure you've enabled the MQTT sync interface.
@@ -13,23 +14,30 @@ The luminance is displayed in both the Info section of the web UI, as well as pu
 To enable, compile with `BH1750` in `custom_usermods` (e.g. in `platformio_override.ini`)
 
 ### Configuration Options
+
 The following settings can be set at compile-time but are configurable on the usermod menu (except First Measurement time):
-*   `USERMOD_BH1750_MAX_MEASUREMENT_INTERVAL` - the max number of milliseconds between measurements, defaults to 10000ms
-*   `USERMOD_BH1750_MIN_MEASUREMENT_INTERVAL` - the min number of milliseconds between measurements, defaults to 500ms
-*   `USERMOD_BH1750_OFFSET_VALUE` - the offset value to report on, defaults to 1
-*   `USERMOD_BH1750_FIRST_MEASUREMENT_AT` - the number of milliseconds after boot to take first measurement, defaults to 10000 ms
+
+- `USERMOD_BH1750_MAX_MEASUREMENT_INTERVAL` - the max number of milliseconds between measurements, defaults to 10000ms
+- `USERMOD_BH1750_MIN_MEASUREMENT_INTERVAL` - the min number of milliseconds between measurements, defaults to 500ms
+- `USERMOD_BH1750_OFFSET_VALUE` - the offset value to report on, defaults to 1
+- `USERMOD_BH1750_FIRST_MEASUREMENT_AT` - the number of milliseconds after boot to take first measurement, defaults to 10000 ms
 
 In addition, the Usermod screen allows you to:
+
 - enable/disable the usermod
 - Enable Home Assistant Discovery of usermod
 - Configure the SCL/SDA pins
 
 ## API
+
 The following method is available to interact with the usermod from other code modules:
+
 - `getIlluminance` read the brightness from the sensor
 
 ## Change Log
+
 Jul 2022
+
 - Added Home Assistant Discovery
 - Implemented PinManager to register pins
 - Made pins configurable in usermod menu

usermods/PIR_sensor_switch/readme.md

@@ -25,23 +25,24 @@ You can also use usermod's off timer instead of sensor's. In such case rotate th
 
 **NOTE:** Usermod has been included in master branch of WLED so it can be compiled in directly just by defining `-D USERMOD_PIRSWITCH` and optionally `-D PIR_SENSOR_PIN=16` to override default pin. You can also change the default off time by adding `-D PIR_SENSOR_OFF_SEC=30`.
 
-## API to enable/disable the PIR sensor from outside. For example from another usermod:
+## 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 send just the MQTT message but not change WLED state using settings page as well as responding to motion only at night
 (assuming NTP and latitude/longitude are set to determine sunrise/sunset times).
 
-### There are two options to get access to the usermod instance:
+### There are two options to get access to the usermod instance
 
-1. Include `usermod_PIR_sensor_switch.h` **before** you include other usermods in `usermods_list.cpp'
+_1._ Include `usermod_PIR_sensor_switch.h` **before** you include other usermods in `usermods_list.cpp'
 
 or
 
-2. Use `#include "usermod_PIR_sensor_switch.h"` at the top of the `usermod.h` where you need it.
+_2._ Use `#include "usermod_PIR_sensor_switch.h"` at the top of the `usermod.h` where you need it.
 
 **Example usermod.h :**
+
 ```cpp
 #include "wled.h"
 
@@ -79,25 +80,30 @@ Usermod can be configured via the Usermods settings page.
 * `override` - override PIR input when WLED state is changed using UI
 * `domoticz-idx` - Domoticz virtual switch ID (used with MQTT `domoticz/in`)
 
-
 Have fun - @gegu & @blazoncek
 
 ## Change log
+
 2021-04
+
 * Adaptation for runtime configuration.
 
 2021-11
+
 * Added information about dynamic configuration options
 * Added option to temporary enable/disable usermod from WLED UI (Info dialog)
 
 2022-11
+
 * Added compile time option for off timer.
 * Added Home Assistant autodiscovery MQTT broadcast.
 * Updated info on compiling.
 
 2023-??
+
 * Override option
 * Domoticz virtual switch ID (used with MQTT `domoticz/in`)
 
 2024-02
-* Added compile time option to expand number of PIR sensors (they are logically ORed) `-D PIR_SENSOR_MAX_SENSORS=3`
+
+* Added compile time option to expand number of PIR sensors (they are logically ORed) `-D PIR_SENSOR_MAX_SENSORS=3`

usermods/PWM_fan/readme.md

@@ -40,6 +40,9 @@ If the fan speed is unlocked, it will revert to temperature controlled speed on
 ## Change Log
 
 2021-10
+
 * First public release
+
 2022-05
+
 * Added JSON API call to allow changing of speed

usermods/Temperature/readme.md

@@ -35,19 +35,23 @@ All parameters can be configured at runtime via the Usermods settings page, incl
 
 ## Change Log
 
-2020-09-12 
+2020-09-12
+
 * Changed to use async non-blocking implementation
 * Do not report erroneous low temperatures to MQTT
 * Disable plugin if temperature sensor not detected
 * Report the number of seconds until the first read in the info screen instead of sensor error
 
 2021-04
+
 * Adaptation for runtime configuration.
 
 2023-05
+
 * Rewrite to conform to newer recommendations.
 * Recommended @blazoncek fork of OneWire for ESP32 to avoid Sensor error
 
 2024-09
+
 * Update OneWire to version 2.3.8, which includes stickbreaker's and garyd9's ESP32 fixes:
-  blazoncek's fork is no longer needed
+  blazoncek's fork is no longer needed

usermods/audioreactive/readme.md

@@ -8,24 +8,27 @@ Does audio processing and provides data structure that specially written effects
 **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):
+
 * [getting started with audio](https://github.com/atuline/WLED/wiki/First-Time-Setup#sound)
 * [Sound settings](https://github.com/atuline/WLED/wiki/Sound-Settings) - similar to options on the usemod settings page in WLED.
 * [Digital Audio](https://github.com/atuline/WLED/wiki/Digital-Microphone-Hookup)
 * [Analog Audio](https://github.com/atuline/WLED/wiki/Analog-Audio-Input-Options)
 * [UDP Sound sync](https://github.com/atuline/WLED/wiki/UDP-Sound-Sync)
 
-
 ## Supported MCUs
-This audioreactive usermod works best on "classic ESP32" (dual core), and on ESP32-S3 which also has dual core and hardware floating point support. 
 
-It will compile successfully for ESP32-S2 and ESP32-C3, however might not work well, as other WLED functions will become slow. Audio processing requires a lot of computing power, which can be problematic on smaller MCUs like -S2 and -C3. 
+This audioreactive usermod works best on "classic ESP32" (dual core), and on ESP32-S3 which also has dual core and hardware floating point support.
+
+It will compile successfully for ESP32-S2 and ESP32-C3, however might not work well, as other WLED functions will become slow. Audio processing requires a lot of computing power, which can be problematic on smaller MCUs like -S2 and -C3.
 
 Analog audio is only possible on "classic" ESP32, but not on other MCUs like ESP32-S3.
 
-Currently ESP8266 is not supported, due to low speed and small RAM of this chip. 
+Currently ESP8266 is not supported, due to low speed and small RAM of this chip.
 There are however plans to create a lightweight audioreactive for the 8266, with reduced features.
-## Installation 
+
+## Installation
 
 Add 'ADS1115_v2' to `custom_usermods` in your platformio environment.
 
@@ -35,29 +38,31 @@ All parameters are runtime configurable. Some may require a hard reset after cha
 
 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)
-- `-D I2S_SDPIN=x` : GPIO for SD pin on digital microphone (32)
-- `-D I2S_WSPIN=x` : GPIO for WS pin on digital microphone (15)
-- `-D I2S_CKPIN=x` : GPIO for SCK pin on digital microphone (14)
-- `-D MCLK_PIN=x`  : GPIO for master clock pin on digital Line-In boards (-1)
-- `-D ES7243_SDAPIN` : GPIO for I2C SDA pin on ES7243 microphone (-1)
-- `-D ES7243_SCLPIN` : GPIO for I2C SCL pin on ES7243 microphone (-1)
+* `-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)
+* `-D I2S_SDPIN=x` : GPIO for SD pin on digital microphone (32)
+* `-D I2S_WSPIN=x` : GPIO for WS pin on digital microphone (15)
+* `-D I2S_CKPIN=x` : GPIO for SCK pin on digital microphone (14)
+* `-D MCLK_PIN=x`  : GPIO for master clock pin on digital Line-In boards (-1)
+* `-D ES7243_SDAPIN` : GPIO for I2C SDA pin on ES7243 microphone (-1)
+* `-D ES7243_SCLPIN` : GPIO for I2C SCL pin on ES7243 microphone (-1)
 
 Other options:
 
-- `-D UM_AUDIOREACTIVE_ENABLE` : makes usermod default enabled (not the same as include into build option!)
-- `-D UM_AUDIOREACTIVE_DYNAMICS_LIMITER_OFF` : disables rise/fall limiter default
+* `-D UM_AUDIOREACTIVE_ENABLE` : makes usermod default enabled (not the same as include into build option!)
+* `-D UM_AUDIOREACTIVE_DYNAMICS_LIMITER_OFF` : disables rise/fall limiter default
 
 **NOTE** I2S is used for analog audio sampling. Hence, the analog *buttons* (i.e. potentiometers) are disabled when running this usermod with an analog microphone.
 
 ### Advanced Compile-Time Options
+
 You can use the following additional flags in your `build_flags`
+
 * `-D SR_SQUELCH=x`  : Default "squelch" setting (10)
 * `-D SR_GAIN=x`     : Default "gain" setting (60)
 * `-D I2S_USE_RIGHT_CHANNEL`: Use RIGHT instead of LEFT channel (not recommended unless you strictly need this).
 * `-D I2S_USE_16BIT_SAMPLES`: Use 16bit instead of 32bit for internal sample buffers. Reduces sampling quality, but frees some RAM ressources (not recommended unless you absolutely need this).
-* `-D I2S_GRAB_ADC1_COMPLETELY`: Experimental: continuously sample analog ADC microphone. Only effective on ESP32. WARNING this _will_ cause conflicts(lock-up) with any analogRead() call.
+* `-D I2S_GRAB_ADC1_COMPLETELY`: Experimental: continuously sample analog ADC microphone. Only effective on ESP32. WARNING this *will* cause conflicts(lock-up) with any analogRead() call.
 * `-D MIC_LOGGER`     : (debugging) Logs samples from the microphone to serial USB. Use with serial plotter (Arduino IDE)
 * `-D SR_DEBUG`       : (debugging) Additional error diagnostics and debug info on serial USB.
 

usermods/project_cars_shiftlight/readme.md

@@ -1,11 +1,11 @@
-### Shift Light for Project Cars
+# Shift Light for Project Cars
 
 Turn your WLED lights into a rev light and shift indicator for Project Cars.
 It's easy 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. However, you might run into problems at faster rates.
 
 | Number | Updates/Second |
 | ------ | -------------- |
@@ -19,5 +19,5 @@ It's easy to use.
 | 8      | 05             |
 | 9      | 1              |
 
-3. Once you enter a race, WLED should automatically shift to PCARS mode.
-4. Done.
+_3._ Once you enter a race, WLED should automatically shift to PCARS mode.
+_4._ Done.

usermods/readme.md

@@ -1,16 +1,16 @@
-### Usermods
+# Usermods
 
 This folder serves as a repository for usermods (custom `usermod.cpp` files)!
 
 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 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!  
+* 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 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 updated, usermods might break.  
 I am not actively maintaining any usermod in this directory, that is your responsibility as the creator of the usermod.