Skip to content

Commit

Permalink
Deployed af8e14d with MkDocs version: 1.6.1
Browse files Browse the repository at this point in the history
  • Loading branch information
Unknown committed Oct 27, 2024
1 parent 576230c commit 79f5314
Show file tree
Hide file tree
Showing 61 changed files with 121 additions and 80 deletions.
2 changes: 1 addition & 1 deletion 404.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@


<link rel="icon" href="/assets/images/ui/aircoookie/blurple.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">



Expand Down
2 changes: 1 addition & 1 deletion about/contributors/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


<link rel="icon" href="../../assets/images/ui/aircoookie/blurple.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">



Expand Down
2 changes: 1 addition & 1 deletion about/privacy-policy/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


<link rel="icon" href="../../assets/images/ui/aircoookie/blurple.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">



Expand Down
2 changes: 1 addition & 1 deletion about/roadmap/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@


<link rel="icon" href="../../assets/images/ui/aircoookie/blurple.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">



Expand Down
2 changes: 1 addition & 1 deletion advanced/2d-1d-Mixed-Setup/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


<link rel="icon" href="../../assets/images/ui/aircoookie/blurple.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">



Expand Down
83 changes: 62 additions & 21 deletions advanced/audio-reactive/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


<link rel="icon" href="../../assets/images/ui/aircoookie/blurple.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">



Expand Down Expand Up @@ -1506,18 +1506,18 @@
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#1-analog-microphones" class="md-nav__link">
<a href="#1-analog-microphones-not-recommended" class="md-nav__link">
<span class="md-ellipsis">
1. Analog microphones
1. Analog microphones - Not recommended
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#2-i2s-digital-microphones" class="md-nav__link">
<a href="#2-i2s-digital-microphones-better-option" class="md-nav__link">
<span class="md-ellipsis">
2. I2S digital microphones
2. I2S digital microphones - Better option
</span>
</a>

Expand Down Expand Up @@ -1557,9 +1557,9 @@
</li>

<li class="md-nav__item">
<a href="#2-line-in-to-i2s-adapter" class="md-nav__link">
<a href="#2-line-in-to-i2s-adapter-best-option" class="md-nav__link">
<span class="md-ellipsis">
2. Line-in to I2S adapter
2. Line-in to I2S adapter - Best Option
</span>
</a>

Expand All @@ -1568,6 +1568,24 @@
</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#audio-sync-wled" class="md-nav__link">
<span class="md-ellipsis">
Audio Sync - WLED
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#audio-sync-wledsrserver" class="md-nav__link">
<span class="md-ellipsis">
Audio Sync - WledSRServer
</span>
</a>

</li>

</ul>
Expand Down Expand Up @@ -2035,18 +2053,18 @@
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#1-analog-microphones" class="md-nav__link">
<a href="#1-analog-microphones-not-recommended" class="md-nav__link">
<span class="md-ellipsis">
1. Analog microphones
1. Analog microphones - Not recommended
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#2-i2s-digital-microphones" class="md-nav__link">
<a href="#2-i2s-digital-microphones-better-option" class="md-nav__link">
<span class="md-ellipsis">
2. I2S digital microphones
2. I2S digital microphones - Better option
</span>
</a>

Expand Down Expand Up @@ -2086,9 +2104,9 @@
</li>

<li class="md-nav__item">
<a href="#2-line-in-to-i2s-adapter" class="md-nav__link">
<a href="#2-line-in-to-i2s-adapter-best-option" class="md-nav__link">
<span class="md-ellipsis">
2. Line-in to I2S adapter
2. Line-in to I2S adapter - Best Option
</span>
</a>

Expand All @@ -2097,6 +2115,24 @@
</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#audio-sync-wled" class="md-nav__link">
<span class="md-ellipsis">
Audio Sync - WLED
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#audio-sync-wledsrserver" class="md-nav__link">
<span class="md-ellipsis">
Audio Sync - WledSRServer
</span>
</a>

</li>

</ul>
Expand Down Expand Up @@ -2142,17 +2178,17 @@ <h2 id="what-is-audio-reactive-wled">What is Audio Reactive WLED?</h2>
<p>Audio Reactive WLED is a possibility of using WLED controllers in such a way that the LEDs react to music and light up in time. First time this was implemented by a <a href="https://github.com/atuline/WLED">Sound Reactive Fork</a>. As of WLED version 0.14.0-beta1 an usermod is available for original WLED too.
Currently only ESP32 microcontrollers are supported.</p>
<h2 id="hardware-required">Hardware required</h2>
<p>The audio must be "feed" into the microcontroller. There are basically two options: using microphones or line-in adapters.</p>
<p>The audio must be "feed" into the microcontroller. There are basically four options: using microphones, line-in adapters, another WLED instance or directly from a PC.</p>
<h3 id="microphones-supported">Microphones supported</h3>
<p>Three microphone types are supported:</p>
<h4 id="1-analog-microphones">1. Analog microphones</h4>
<p>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.
<h4 id="1-analog-microphones-not-recommended">1. Analog microphones - Not recommended</h4>
<p>Examples are MAX4466 (really not 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 are highly influenced by the power supply noise.
<img alt="Example analog microphone" src="../../assets/images/content/example_analog_mic.jpg" /></p>
<div class="admonition info">
<p class="admonition-title">Analog microphones and analog buttons (potentiometers) rule out each other</p>
<p>WLED can use analog microphones or <a href="/features/macros/#analog-button">analog buttons</a> but not both at the same time!</p>
</div>
<h4 id="2-i2s-digital-microphones">2. I2S digital microphones</h4>
<h4 id="2-i2s-digital-microphones-better-option">2. I2S digital microphones - Better option</h4>
<p>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.</p>
<p><img alt="Example I2S microphone" src="../../assets/images/content/example_i2s_mic.jpg" /></p>
<p>There are also some commercial controllers with integrated digital microphone or plug-in capability available. Be sure to setup correct GPIOs according to the information you typically will find printed on the board or in user manual.</p>
Expand All @@ -2165,12 +2201,17 @@ <h4 id="1-analog-line-in-option">1. Analog line-in option</h4>
<p>At least a simple analog circuit as shown below is required to prepare the analog line-out signal and to feed it to the ADC converter of ESP32 microcontroller. In this case, the whole thing works like with an analog microphone. The quality is not the best here either because the ESP32 ADC is not particularly good at converting audio signals and the signal conditioning circuitry is very simple, but not very good. In addition, the sensitivity can be quite poor, so that the whole thing only works at a higher volume of the signal.</p>
<p><img alt="Example analog line-in" src="../../assets/images/content/example_analog_linein.jpg" /></p>
<p>In some cases, you can do it without this circuit and connect the GND of the audio source and an audio channel (left or right) directly to ESP32 ADC Pin (GND and analog input, e.g. GPIO36 pin on the ESP32). This solution is rather quite dirty workaround and might work well or not at all.</p>
<h4 id="2-line-in-to-i2s-adapter">2. Line-in to I2S adapter</h4>
<p>Line-in to I2S adapter converts the analog line-out or headphone signal into a digital I2S signal that can be proceed by ESP32. There are some general or for WLED specially developed analog-to-I2S adapters based on for example CirrusLogic CS5343, TI PCM1808 or es7243 chips on the market. In this case, the whole thing works like with a digital I2S microphone. The only difference to I2S microphone is that you at least need an extra PIN for MCLK (Master Clock) signal, which can only be generated by the ESP32 on GPIOs 0, 1 or 3. The other complication is that MCLK is a high frequency signal and must be wired extremely accurate and have short wires. Some adapter types also require more additional signals. For stability it is better to use ready-to-use controller with special Line-In to I2S adapter or DIY PCB design where you can integrate general analog-to-I2S adapter directly without long wires.</p>
<h4 id="2-line-in-to-i2s-adapter-best-option">2. Line-in to I2S adapter - Best Option</h4>
<p>Line-in to I2S adapter converts the analog line-out or headphone signal into a digital I2S signal that can be processed by ESP32. There are some general or for WLED specially developed analog-to-I2S adapters based on for example CirrusLogic CS5343, TI PCM1808 or es7243 chips on the market. In this case, the whole thing works like with a digital I2S microphone. The only difference with I2S microphone is that you at least need an extra PIN for MCLK (Master Clock) signal, which can only be generated by the ESP32 on GPIOs 0, 1 or 3. The other complication is that MCLK is a high-frequency signal and must be wired extremely carefully and have short wires. Some adapter types also require more additional signals. For stability, it is better to use a ready-to-use controller with a special Line-In to I2S adapter or DIY PCB design where you can integrate a general analog-to-I2S adapter directly without long wires.</p>
<p>An example board with integrated Line-In is the <a href="https://docs.espressif.com/projects/esp-adf/en/latest/design-guide/dev-boards/board-esp32-lyrat-v4.3.html">LyraT</a></p>
<p><img alt="Examples analog to I2S" src="../../assets/images/content/examples_analog_to_i2s.jpg" /></p>
<p>For some more details please refer to <a href="https://github.com/atuline/WLED/wiki">Sound Reactive WLED WIKI</a></p>
<p>For some more details please refer to <a href="https://mm.kno.wled.ge/soundreactive/introduction/">Sound Reactive WLED WIKI</a></p>
<h3 id="audio-sync-wled">Audio Sync - WLED</h3>
<p>You do not need to include an audio input source in every WLED device to take advantage of the Audio Reactive effects. Simply set the sync mode to "send" on the device with the audio input and all the other devices set to "receive" for their sync mode in the Audio Reactive settings. </p>
<h3 id="audio-sync-wledsrserver">Audio Sync - WledSRServer</h3>
<p>For Windows, there is <a href="https://github.com/Victoare/SR-WLED-audio-server-win">WledSRServer</a> which is a small application that can capture audio directly from your PC, process it into WLED Audio Sync data and send it out onto your network - emulating WLED in send mode. Configure all your WLED instances to receive.</p>
<h2 id="software-required">Software required</h2>
<p>Because audio reactive capability is currently implemented as a usermod, you need WLED compiled with this usermod included or use Sound Reactive WLED fork. The <a href="https://install.wled.me/">official WEB-based WLED installer</a> does not include original WLED with audio reactive usermod, but offers Sound Reactive WLED as an option. The <a href="https://wled-install.github.io/">unofficial WEB-based WLED installer</a> offers more options including original WLED with audio reactive usermod.</p>
<p>Because audio reactive capability is currently implemented as a usermod, you need WLED compiled with this usermod included. The <a href="https://install.wled.me/">official WEB-based WLED installer</a> does not include original WLED with audio reactive usermod, but offers Sound Reactive WLED as an option. The <a href="https://wled-install.github.io/">unofficial WEB-based WLED installer</a> offers more options including original WLED with audio reactive usermod.</p>



Expand Down
2 changes: 1 addition & 1 deletion advanced/compile-analog/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@


<link rel="icon" href="../../assets/images/ui/aircoookie/blurple.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">



Expand Down
2 changes: 1 addition & 1 deletion advanced/compile-wled/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@


<link rel="icon" href="../../assets/images/ui/aircoookie/blurple.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">



Expand Down
2 changes: 1 addition & 1 deletion advanced/compiling-wled/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


<link rel="icon" href="../../assets/images/ui/aircoookie/blurple.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">



Expand Down
2 changes: 1 addition & 1 deletion advanced/custom-ap/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


<link rel="icon" href="../../assets/images/ui/aircoookie/blurple.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">



Expand Down
2 changes: 1 addition & 1 deletion advanced/custom-features/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


<link rel="icon" href="../../assets/images/ui/aircoookie/blurple.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">



Expand Down
2 changes: 1 addition & 1 deletion advanced/ddp/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


<link rel="icon" href="../../assets/images/ui/aircoookie/blurple.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">



Expand Down
2 changes: 1 addition & 1 deletion advanced/esp32-recovery/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


<link rel="icon" href="../../assets/images/ui/aircoookie/blurple.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">



Expand Down
2 changes: 1 addition & 1 deletion advanced/home-automation/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


<link rel="icon" href="../../assets/images/ui/aircoookie/blurple.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">



Expand Down
2 changes: 1 addition & 1 deletion advanced/longdata/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


<link rel="icon" href="../../assets/images/ui/aircoookie/blurple.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">



Expand Down
2 changes: 1 addition & 1 deletion advanced/mapping/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


<link rel="icon" href="../../assets/images/ui/aircoookie/blurple.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">



Expand Down
2 changes: 1 addition & 1 deletion advanced/pir-sensors/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


<link rel="icon" href="../../assets/images/ui/aircoookie/blurple.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">



Expand Down
2 changes: 1 addition & 1 deletion advanced/remote-access-ifttt/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


<link rel="icon" href="../../assets/images/ui/aircoookie/blurple.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">



Expand Down
2 changes: 1 addition & 1 deletion advanced/security/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


<link rel="icon" href="../../assets/images/ui/aircoookie/blurple.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">



Expand Down
2 changes: 1 addition & 1 deletion advanced/wiring/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


<link rel="icon" href="../../assets/images/ui/aircoookie/blurple.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">



Expand Down
2 changes: 1 addition & 1 deletion basics/compatible-controllers/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


<link rel="icon" href="../../assets/images/ui/aircoookie/blurple.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">



Expand Down
2 changes: 1 addition & 1 deletion basics/compatible-hardware/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


<link rel="icon" href="../../assets/images/ui/aircoookie/blurple.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">



Expand Down
2 changes: 1 addition & 1 deletion basics/compatible-led-strips/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


<link rel="icon" href="../../assets/images/ui/aircoookie/blurple.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">



Expand Down
2 changes: 1 addition & 1 deletion basics/compatible-software/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


<link rel="icon" href="../../assets/images/ui/aircoookie/blurple.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">



Expand Down
2 changes: 1 addition & 1 deletion basics/compiling-wled/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@


<link rel="icon" href="../../assets/images/ui/aircoookie/blurple.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">



Expand Down
2 changes: 1 addition & 1 deletion basics/faq/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


<link rel="icon" href="../../assets/images/ui/aircoookie/blurple.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.41">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">



Expand Down
Loading

0 comments on commit 79f5314

Please sign in to comment.