Spelling check by @wthomson (wled#2940)

A lot of spelling corrections. Now repo will sound like educated person :)

Co-authored-by: Bill Thomson <[email protected]>

Author: srg74

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  
-- Settings page - configuration over network  
+- Segments to set different effects and colors to user defined parts of the LED string  
+- Settings page - configuration via the network  
 - Access Point and station mode - automatic failsafe AP  
 - Up to 10 LED outputs per instance
 - Support for RGBW strips  
@@ -28,7 +28,7 @@ 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
@@ -51,7 +51,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 +70,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 [[email protected]](mailto:[email protected]), 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 [[email protected]](mailto:[email protected]), 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.  
 

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/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 your 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.
-Please enter GPIO pins for PIR sensors or ultrasonic sensor (trigger and echo).
+You can configure usermod using the Usermods settings page.
+Please enter GPIO pins for PIR or ultrasonic sensors (trigger and echo).
 If you use PIR sensor enter -1 for echo pin.
-Maximum distance for ultrasonic sensor can be configured as a time needed for echo (see below).
+Maximum distance for ultrasonic sensor can be configured as the time needed for an echo (see below).
 
 ## Hardware installation
-1. Stick the LED strip under each step of the stairs.
-2. Connect the ESP8266 pin D4 or ESP32 pin D2 to the first LED data pin at the bottom step
-   of your stairs.
+1. Attach the LED strip to each step of the stairs.
+2. Connect the ESP8266 pin D4 or ESP32 pin D2 to the first LED data pin at the bottom step.
 3. Connect the data-out pin at the end of each strip per step to the data-in pin on the 
-   other end of the next step, creating one large virtual LED strip.
+   next step, creating one large virtual LED strip.
 4. Mount sensors of choice at the bottom and top of the stairs and connect them to the ESP.
 5. To make sure all LEDs get enough power and have your staircase lighted evenly, power each
    step from one side, using at least AWG14 or 2.5mm^2 cable. Don't connect them serial as you
@@ -62,22 +61,22 @@ 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
 {
     "state": {
         "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,25 +91,25 @@ 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
-distances creates delays in the WLED software, and _might_ introduce timing hickups in your animations or
+**Please note:** using an HC-SR04 sensor, particularly when detecting echos at longer
+distances creates delays in the WLED software, _might_ introduce timing hiccups in your animation or
 a less responsive web interface. It is therefore advised to keep the detection distance as short as possible.
 
 ### Animation triggering through the API
-Instead of stairs activation by one of the sensors, you can also trigger the animation through
-the API. To simulate triggering the bottom sensor, use:
+In addition to activation by one of the stair sensors, you can also trigger the animation manually
+via the API. To simulate triggering the bottom sensor, use:
 
 ```bash
 curl -X POST -H "Content-Type: application/json" \
      -d '{"staircase":{"bottom-sensor":true}}' \
      xxx.xxx.xxx.xxx/json/state
 ```
 
-Likewise, to trigger the top sensor, use:
+Likewise, to trigger the top sensor:
 
 ```bash
 curl -X POST -H "Content-Type: application/json" \
@@ -119,7 +118,7 @@ curl -X POST -H "Content-Type: application/json" \
 ```
 **MQTT**
 You can publish a message with either `up` or `down` on topic `/swipe` to trigger animation.
-You can also use `on` or `off` for enabling or disabling usermod.
+You can also use `on` or `off` for enabling or disabling the usermod.
 
 Have fun with this usermod.<br/>
 www.rolfje.com
@@ -128,4 +127,4 @@ Modifications @blazoncek
 
 ## Change log
 2021-04
-* Adaptation for runtime configuration.
+* Adaptation for runtime configuration.

usermods/BH1750_v2/readme.md

@@ -1,7 +1,7 @@
 # BH1750 usermod
 
-This usermod will read from an ambient light sensor like the BH1750 sensor.
-The luminance is displayed both in the Info section of the web UI as well as published to the `/luminance` MQTT topic if enabled.
+This usermod will read from an 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
@@ -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`
+- Updated `readme.md`

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,9 +82,9 @@ Apr 2021
 
 Dec 2020
 - Ported to V2 Usermod format
-- Customisable `measure intervals`
-- Customisable number of `decimal places` in published sensor values
+- Customizable `measure intervals`
+- Customizable number of `decimal places` in published sensor values
 - Pressure measured in units of hPa instead of Pa
 - Calculation of heat index (apparent temperature) and dew point
 - `16x oversampling` of sensor during measurement
-- Values only published if they are different from the previous value
+- Values only published if they are different from the previous value

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_MEASUREMENT_INTERVAL` - the number of milliseconds between measurements, defaults to 60 seconds
-* `USERMOD_DHT_FIRST_MEASUREMENT_AT` - the number of milliseconds after boot to take first measurement, defaults to 90 seconds
-* `USERMOD_DHT_MQTT`                 - publish measurements to the MQTT broker
+* `USERMOD_DHT_CELSIUS`              - define this to report temperatures in degrees Celsius, otherwise Fahrenheit will be reported
+* `USERMOD_DHT_MEASUREMENT_INTERVAL` - the number of milliseconds between measurements, defaults to 60000 ms
+* `USERMOD_DHT_FIRST_MEASUREMENT_AT` - the number of milliseconds after boot to take first measurement, defaults to 90000 ms
+* `USERMOD_DHT_MQTT`                 - publish measurements to an MQTT broker
 * `USERMOD_DHT_STATS`                - For debug, report delay stats
 
 ## Project link
@@ -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/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.
-The drawback is that this format cannot be handled by common image programs and that an extra conversion step is needed.
+Binary 16-bit per pixel RGB565 format `.bin` and `.clk` images are now supported. This has the benefit of using only 2/3rds of the file space a 24 BPP `.bmp` occupies.
+The drawback is this format cannot be handled by common image programs and an extra conversion step is needed.
 You can use https://lvgl.io/tools/imageconverter to convert your .bmp to a .bin file (settings `True color` and `Binary RGB565`).  
 Thank you to @RedNax67 for adding .bin and .clk support.  
-For most clockface designs, using 4 or 8 BPP BMP 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
 | --- | --- | --- | --- |
@@ -42,4 +42,4 @@ For most clockface designs, using 4 or 8 BPP BMP formats will save even more fil
 
 Comparison 1 vs. 4 vs. 8 vs. 24 BPP. With this clockface on the actual clock, 4 bit looks good, and 8 bit is almost indistinguishable from 24 bit.
 
-![comparison](https://user-images.githubusercontent.com/21045690/156899667-5b55ed9f-6e03-4066-b2aa-1260e9570369.png)
+![comparison](https://user-images.githubusercontent.com/21045690/156899667-5b55ed9f-6e03-4066-b2aa-1260e9570369.png)