Merge remote-tracking branch 'upstream/main' into main

README.md

@@ -9,3 +9,35 @@ If you'd like to do more advanced changes (e.g. adding a page), the [Material fo
 ### Images
 
 If possible, it is preferable to store image content within this repository at `/docs/assets/images/content`. With external links, there is always a chance that the resource is deleted accidentally by the external hoster.
+
+### How to add a new page
+
+Let’s consider an example. Let’s imagine we want to add a page called `Top 5 mistakes` in section `Basics` after the `Getting Started` page. This page already exists, so you can already see the results in WLED Docs, but let’s imagine the page is not there and we will go steps needed to add it:
+
+1)	Create a file that should contain the documentation. As we want to place the new page in section `Basics` it makes senso to put this file in subfolder `docs/basics/`. In our example we call the file `top5_mistakes.md`. You can use another .md file as an example. Important is to have the following few lines at the beginning of the file:
+```
+---
+title: TOP 5 mistakes
+hide:
+  # - navigation
+  # - toc
+---
+```
+Don’t forget to adapt the title.
+
+2)	Edit `mkdocs.yml` file. Take care that indentations play an important role in .yml files. Go to `nav:` section in this file and add a new line after the line `- Getting Started: basics/getting-started.md` as we want to add or new page after the `Getting Started` page. The new line must have the same indentation as the previous line and the content is `- Top 5 mistakes: basics/top5_mistakes.md`. By this we say that the new page must be called `Top 5 mistakes` and its content is in the file `top5_mistakes.md` we created before in subfolder `basics`.
+That is!
+
+### How to add a new section
+
+It is even easier. Take a look at `nav:` section in `mkdoks.yml` file. To add a new section you just have to add a new line at a position where the new section must be. Then write a section name like this: `- Compatibility:`. TAKE CARE on indentations! After this line you can then add new pages as described above.
+
+### How to test the representation of the documentation in web locally (on Windows, MAC OS X or Linux)
+
+You would need to install some tools:
+
+1) WEB Server. The probably easiest way is to use [XAMPP](https://www.apachefriends.org/index.html) to run local WEB server on your PC/Laptop. After installing you would need to start XAMPP Control Panel and run Apache Server. In the folder where XAMPP is installed to you will find a subfolder called `htdocs`. This is the content of the WEB Server and you have to put WLED Docs web pages there, for example in subfolder called `wled-docs`. Later, after generating pages using mkdocs, you will be able to access them via `http://localhost/wled-docs/site/`
+2) [Python](https://www.python.org/)
+3) [MkDocs](https://www.mkdocs.org/user-guide/installation/#mkdocs-installation)
+
+Now you can downlaod WLED Docs sources from the repository to subfolder `wled-docs` in the folder `htdocs` in your XAMPP installation (or if you have git installed you can use git command to clone like `git clone --branch main https://github.com/Aircoookie/WLED-Docs`). To "compile" the resulting web pages you have to run `mkdocs build` command in the `wled-docs` folder using command line. It generates subfolder 'site' with the resulting web pages and you can access them in your browser via `http://localhost/wled-docs/site/`

docs/about/contributors.md

@@ -14,30 +14,37 @@ Everyone you see on the Contributors page and:
 adamo made the animated Discord server logo!  
 [@blazoncek](https://github.com/blazoncek) makes countless new features and improvements to many parts of WLED!  
 [@debsahu](https://github.com/debsahu) provided the HomeAssistant autodiscovery and a lot of help with PIO!  
-[@frenck](https://github.com/frenck) made an amazing, stable and feature-packed native integration with HomeAssistant!  
+[@ewowi](https://github.com/ewoudwijma) numerous optimizations; 2D, audio and various user mod improvements.  MoonModules maintainer.  
+[@frenck](https://github.com/frenck) made an amazing, stable and feature-packed native integration with HomeAssistant!
 [@Moustachauve](https://github.com/Moustachauve)  added palette visualisation and developped the WLED Native app for Android and iOS!  
-[@photocromax](https://github.com/photocromax) is helping bringing the Live visualization feature to life and added GIF previews to the doc!  
+[@pbolduc](https://github.com/pbolduc) DDP UDP synchronization, UI improvements and user mods.  
+[@photocromax](https://github.com/photocromax) is helping bringing the Live visualization feature to life.  
 [@raymiec](https://github.com/raymiec)  is currently working on creating the best clients for Android and iOS!  
+[@scottrbailey](https://github.com/scottrbailey) added JSON IR remote and gif visualizations for the docs.  
+[@softhack007](https://github.com/softhack007) audio processing, new MCU support, code reviews, and various optimizations.  MoonModules maintainer.  
 [@StormPie](https://github.com/stormpie), the creator of the awesome mobile UI!  
 [@timothybrown](https://github.com/timothybrown) added MQTT authentication!  
 [@viknet365](https://github.com/viknet365) ported the Meteor effect!  
 [@wiesendaniel](https://github.com/wiesendaniel) added the configuration for the PlatformIO IDE!  
 [@YeonV](https://github.com/YeonV) provided the initial HomeAssistant MQTT light config!  
+[@werkstrom](https://github.com/werkstrom) added PixelArt converter  
+
 _This list is incomplete._  
 
 ### Testing, Contributors and Supporters
 
 _This list has been redacted for privacy reasons. If you've contributed to the project by testing a lot, helping the community, or sending me a gift, feel free to edit this page and add yourself (maintain alphabetical order)_ 😄 _Thank you very much, your help is truly appreciated!_  
 **Put two spaces behind your name, else the line break will not appear in the final page!**  
-
+ALDIY - user support, documentation, beta tester   
 [@Def3nder](https://github.com/Def3nder)  
 [@DutchmanNL](https://github.com/DutchmanNL)  
-DrZzs (Justin A.)
+DrZzs (Justin A.)  
 Dylan L.  
 Fil  
-Quindor (Andries F.)  
-Tonyno
-
+Quindor (Andries F.) - designed Dig-Quad, Dig-Uno, etc.  
+[@Serg74](https://github.com/srg74) - designed controllers and shields - contributes code - hosts nightly build binaries  
+Tonyno - tireless user support and documentation  
+Wladi - contributes documentation and maintains [WLED FAQ](https://wled-faq.github.io) unofficial documentation.
 ### Used Libraries and Dependencies
 
 [ESP8266](https://github.com/esp8266/Arduino)/[ESP32](https://github.com/espressif/arduino-esp32) Arduino Core  

docs/advanced/2d-1d-Mixed-Setup.md

@@ -0,0 +1,21 @@
+---
+title: 2D and 1D Mixed Setup
+hide:
+  # - navigation
+  # - toc
+---
+
+## Overview
+
+WLED supports mixing 2D and 1D setup on the same unit, the expected result is that you could use 2D fixture and still chain a strip after or setup a strip and then a matrix after on the same pin. 
+
+1. Setup your total LED count in Config -> LED Preferences as usual. For example a 8x8 matrix and a strip of 30 pixels chained to the end of your matrix. The total count should be 64 + 30 = 94. This also works with virtual LEDs via DDP or ArtNet.
+   <img width="448" alt="example" src="/assets/images/content/2D-1D-MIX_Step1.png">
+2. Go to Config -> 2D setup and create the 8x8 matrix
+   <img width="448" alt="example" src="/assets/images/content/2D-1D-MIX_Step2.png">
+3. Go back to edit the segments. The 8x8 segments should be created automatically. Add a new Segment. Initially the form will be for creating a new Matrix.
+   <img width="448" alt="example" src="/assets/images/content/2D-1D-MIX_Step3.png">
+4. In the "Start X" field enter a number larger or equal to the total LEDS in the matrix. In this example you should enter 64 (8 x 8). The form will automatically change to display that of a 1D segment.
+   <img width="448" alt="example" src="/assets/images/content/2D-1D-MIX_Step4.png">
+
+Note: If the matrix is chained after the strip, then use reversing at the bus level, i.e. check Reversed (rotated 180°) in LED & Hardware setup. This may also require you reverse segment.

docs/advanced/audio-reactive.md

@@ -23,6 +23,9 @@ Three microphone types are supported:
 Examples are MAX4466 (not really good) and MAX9814 (slightly better). These microphones are easy to use: you just have to connect 3.3V, GND and the analog output from the microphone to an ADC input (Analog-to-Digital Converter) of ESP32. However, the big disadvantage is the quality: both from the microphones themselves and from the ADCs integrated into microcontrollers, which are actually not well suited for audio processing and highly influenced by the power supply noise.
 ![Example analog microphone](../assets/images/content/example_analog_mic.jpg)
 
+!!! info "Analog microphones and analog buttons rule out each other"
+    WLED can use analog microphones or [analog buttons](features/macros/#analog-button) but not both at the same time!
+
 #### 2. I2S digital microphones
 
 Examples are INMP441 and ICS-43434/ICS-43432. These have an integrated ADC and already output a digital signal. The advantage is the best possible quality. The disadvantage is higher complexity (you need several PINs for a digital signal). For proper trouble-free operation keep wires between the microphone and ESP32 as short as possible and solder them properly.

docs/assets/overrides/main.html

@@ -2,7 +2,7 @@
 {% block announce %}
 <p class="cx-announce">
   <span class="md-announce">
-    <a href="https://discord.gg/KuqP7NE">
+    <a href="https://discord.gg/QAh7wJHrRM">
       Join us on <span class="twemoji discord"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.1.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M524.531 69.836a1.5 1.5 0 0 0-.764-.7A485.065 485.065 0 0 0 404.081 32.03a1.816 1.816 0 0 0-1.923.91 337.461 337.461 0 0 0-14.9 30.6 447.848 447.848 0 0 0-134.426 0 309.541 309.541 0 0 0-15.135-30.6 1.89 1.89 0 0 0-1.924-.91 483.689 483.689 0 0 0-119.688 37.107 1.712 1.712 0 0 0-.788.676C39.068 183.651 18.186 294.69 28.43 404.354a2.016 2.016 0 0 0 .765 1.375 487.666 487.666 0 0 0 146.825 74.189 1.9 1.9 0 0 0 2.063-.676A348.2 348.2 0 0 0 208.12 430.4a1.86 1.86 0 0 0-1.019-2.588 321.173 321.173 0 0 1-45.868-21.853 1.885 1.885 0 0 1-.185-3.126 251.047 251.047 0 0 0 9.109-7.137 1.819 1.819 0 0 1 1.9-.256c96.229 43.917 200.41 43.917 295.5 0a1.812 1.812 0 0 1 1.924.233 234.533 234.533 0 0 0 9.132 7.16 1.884 1.884 0 0 1-.162 3.126 301.407 301.407 0 0 1-45.89 21.83 1.875 1.875 0 0 0-1 2.611 391.055 391.055 0 0 0 30.014 48.815 1.864 1.864 0 0 0 2.063.7A486.048 486.048 0 0 0 610.7 405.729a1.882 1.882 0 0 0 .765-1.352c12.264-126.783-20.532-236.912-86.934-334.541ZM222.491 337.58c-28.972 0-52.844-26.587-52.844-59.239s23.409-59.241 52.844-59.241c29.665 0 53.306 26.82 52.843 59.239 0 32.654-23.41 59.241-52.843 59.241Zm195.38 0c-28.971 0-52.843-26.587-52.843-59.239s23.409-59.241 52.843-59.241c29.667 0 53.307 26.82 52.844 59.239 0 32.654-23.177 59.241-52.844 59.241Z"/></svg></span> <span><strong> Discord </strong></span> for support and updates!
     </a>
   </span>

docs/basics/compatible-controllers.md

@@ -46,6 +46,7 @@ In the following some third-party controllers are listed. Please use a decent an
 [ESP8266 Pixel Controller](https://www.maltepoeggel.de/?site=pixelcontroller) | DIY board for 5V/12V LED strips with TTL or RS485 output using a Wemos D1 mini, integrated fuse, pluggable terminal block, 3D printed module case
 [ESPthings.io ET-AL01](https://www.espthings.io/AL01) | DIY board for 5 Analog channels and/or up to 5 Digital LED channels (or a combination of the latter as required), Integrated level shifter, 5v/12/24v compatibility, 4x pull-up/down GPIO, serial interface and power distribution terminals. Can be used with Wemos D1-style ESP8266 or ESP32 boards.
 [ESP32 WLED pico board](https://www.tindie.com/products/28276/) | ESP32 WLED pico board,super small form factor, ready to buy on [Tindie](https://www.tindie.com/products/28276/) and [Tindie EU](https://www.tindie.com/products/moonmodules/esp32-pico-board-with-digital-microphone/). Integrated level shifter, exposed pins for extending functionality , on board I2S microphone, [Firmware is here](https://github.com/srg74/WLED-ESP32-pico/tree/main/Firmware). Project page is [here](https://github.com/srg74/WLED-ESP32-pico)
+[Hikari](https://github.com/goodmicros/hikari) | Pocket-sized, battery powered RGBW light
 [IOT4WLED](https://iot4.eu/product/iot4wled/) | Ready to use hardware for WLED!
 [Laterna](https://github.com/Planet-Laterna/Laterna) | Based on an ESP32 for digital LED and RBG/RGBW LED strips with support for 5V, 12V and 24V LED strips. (Up to 4 channels)
 [Laterna Mini V3](https://github.com/Planet-Laterna/Laterna-mini-V3) | Small ESP32 based controller with optional digital microphone integrated for digital 5V LED strips.

docs/basics/getting-started.md

@@ -15,7 +15,7 @@ hide:
 **1.** Connect a  WS2812B-compatible RGB(W) led strip to `GPIO2`. On most ESP8266 based development boards this pin is labeled `D4`, on ESP32 based boards use `IO16` or `G16` or `16`. _If the connecting wire cannot be kept short, use a [level shifter/translator](/basics/compatible-hardware#levelshifters)._ Optionally connect a normally open pushbutton to `GPIO0` (NodeMCU/Wemos pin `D3`, on ESP32 use `IO17`) and ground for [configurable actions](/features/macros).
 **Note:** Board pin naming varies depending on the manufacturer. Please use the board pinout from the _specific_ board you purchased and use the GPIO PINS to reference this guide. _Make sure to connect ESP and LED-strip grounds together!_
 
-![Connection schematics](https://i.ibb.co/k9Jgr8S/connections.jpg)
+![connectionsA](https://github.com/Aircoookie/WLED-Docs/assets/59397047/ae32d2c0-ec2d-450d-90e8-4258c349ca3f)
 
 While using an ESP8266 and LEDs that have clock and data, you can either use hardware SPI (mostly faster) or software SPI.
   - hardware SPI: use `GPIO14` (SCLK) for clock and `GPIO13` (MOSI) for data.

docs/features/effects.md

@@ -22,6 +22,7 @@ and the colors: <br />
 ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/color_1.gif) Primary (_Fx_)<br />
 ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/color_2.gif) (or black) Secondary  (_Bg_)<br />
 ![](https://raw.githubusercontent.com/scottrbailey/WLED-Utils/master/gifs/color_3.gif) Tertiary (_Cs_).<br />
+For 2D effects the background (secondary) color is set to black.
 
 
 

docs/features/presets.md

@@ -126,7 +126,8 @@ Here is a simple guide to get it set up quickly!
 - Make sure the time displayed is correct and accurate. It is highly recommended to enable NTP for a reliable schedule. Do not forget to set the correct timezone.
 If applicable, daylight saving time is handled automatically.  
 - Scroll down to `Time-controlled presets`. There are 8 different timer slots available.  
-- Enter the hour, minute, and weekdays you want the preset to activate. In the `Preset` column, enter the preset ID you noted earlier.  
+- Enter the hour, minute, and weekdays you want the preset to activate. In the `Preset` column, enter the preset ID you noted earlier.
+  -Hours are measured with the 24-hour clock, where midnight is 0:00. Entering "24" will instead activate the preset hourly.
 - Save the settings page! You have successfully set up a schedule :)  
 
 !!! info "Note"

docs/index.md

@@ -108,7 +108,7 @@ Credits [here](/about/contributors)!
 
 Join the Discord server to discuss everything about WLED!
 
-<a href="https://discord.gg/KuqP7NE"><img src="https://discordapp.com/api/guilds/473448917040758787/widget.png?style=banner2" width="25%"></a>
+<a href="https://discord.gg/QAh7wJHrRM"><img src="https://discordapp.com/api/guilds/473448917040758787/widget.png?style=banner2" width="25%"></a>
 
 Check out the WLED [Discourse forum](https://wled.discourse.group)!  
 You can also send me mails to [dev.aircoookie@gmail.com](mailto:dev.aircoookie@gmail.com), but please only do so if you want to talk to me privately.  

mkdocs.yml

@@ -121,6 +121,7 @@ nav:
     - Custom Features: advanced/custom-features.md
     - ESP32 Recovery: advanced/esp32-recovery.md
     - Mapping: advanced/mapping.md
+    - Mixed 2D and 1D Bus: advanced/2d-1d-Mixed-Setup.md
     - Virtual LEDs: advanced/ddp.md
     - Custom Access Point Configuration: advanced/custom-ap.md
     - Net debug: advanced/net-debug.md