-
Notifications
You must be signed in to change notification settings - Fork 443
Add v16.0.0 documentation updates #323
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
netmindz
wants to merge
16
commits into
main
Choose a base branch
from
v16-updates
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
213719d
Add v0.16.0 documentation updates
netmindz 848258d
Expand audio-reactive docs with configuration, AGC, and sync improvem…
netmindz 08f22dd
Add more info and fix AI slop
DedeHai bd67e96
improve scrolling text how-to
DedeHai a395074
gif-> GIF plus typo
DedeHai 7a14a1b
0.16 => 16.0 ( AI slop)
softhack007 92b5ec5
Update docs/interfaces/espnow.md
softhack007 3577195
markdown style fixes
softhack007 bb48b96
changing a few more "callouts" into admonitions
softhack007 16bebd0
a RGB -> an RGB
softhack007 2cf888f
Merge branch 'main' into v16-updates
softhack007 f56c1bc
HUB75 clarifications
softhack007 9ab3817
Update docs/interfaces/infrared.md
softhack007 4418961
Merge branch 'v16-updates' of https://github.com/wled/WLED-Docs into …
DedeHai 6269c1b
corrections and improvements for audio-reactive.md
softhack007 b6b9d64
Update docs/features/palettes.md
softhack007 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,65 +1,74 @@ | ||
| --- | ||
| title: HUB75 support | ||
| title: HUB75 Support | ||
| --- | ||
|
|
||
| WLED now features support for LED matrix panels using the HUB75 format | ||
| WLED now features support for LED matrix panels using the HUB75 format. HUB75 support was added as an official mainline feature in **v16.0.0** — dedicated `_HUB75` build variants are included in the standard release downloads. | ||
|
|
||
| You can use either a regular ESP32 with a suitable adapter board such as Huidu HD-WF2, [ESP32 Trinity](https://esp32trinity.com/), [MoonHub75](https://github.com/MoonModules/Hardware/tree/main/MOONHUB75), [rorosaurus/esp32-hub75-driver](https://github.com/rorosaurus/esp32-hub75-driver) or the dedicated [Adafruit Matrix Portal S3](https://www.adafruit.com/product/5778) | ||
|
|
||
| This support is supplied by the [ESP32-HUB75-MatrixPanel-DMA](https://github.com/mrcodetastic/ESP32-HUB75-MatrixPanel-DMA?tab=readme-ov-file) library, so see here for more details about supported hardware panels | ||
|
|
||
|
|
||
| # Setup | ||
| ## Required Software Build | ||
|
|
||
| ### Adafruit Matrix Portal S3 | ||
| Please use the dedicated ESP32-S3_Adafruit_Matrixportal.bin build as this is pre-configured for the pins needed for HUB75 output | ||
|
|
||
| Please use the dedicated `ESP32-S3_Adafruit_Matrixportal.bin` build as this is pre-configured for the pins needed for HUB75 output | ||
|
|
||
| ### Huidu HD-WF2 ESP32-S3 | ||
| * Hold the button down as you use a USB-A to USB-A cable to upload ESP32-S3_HD-WF2.bin | ||
|
|
||
| * Hold the button down as you use a USB-A to USB-A cable to upload `ESP32-S3_HD-WF2.bin` | ||
| * See more at https://github.com/mrcodetastic/ESP32-HUB75-MatrixPanel-DMA/issues/433 | ||
| * The HD-WF2 board doesn't have PSRAM, and may become unstable if you use more than 64x64 pixels. | ||
|
|
||
| ### Generic ESP32 Support | ||
|
|
||
| ### Generic ESP32 support | ||
| You must use a build with WLED_ENABLE_HUB75MATRIX defined, for example, ESP32_HUB75.bin. If you do not see Hub75 options in the list of LED types, you are not using the correct build | ||
|
|
||
| If you are using a board such as the ESP32 Trinity or other boards wired for the default pinout of the ESP32-HUB75-MatrixPanel-DMA driver, this is selected by default | ||
|
|
||
|  | ||
|
|
||
|
|
||
| If you are using the rorosaurus/esp32-hub75-driver or any other board using the SmartMatrix default pinout then you will need to use the ESP32_HUB75_forum_pinout.bin which has ESP32_FORUM_PINOUT defined | ||
|
|
||
| If you are using any other config, you currently need to edit wled00/bus_manager.cpp to add a new elif block and define to your build - it is not possible to set the HUB75 pin config in LED preferences at the moment | ||
|
|
||
| ### MoonHub75 | ||
|
|
||
| This project is a passive adapter board to connect a [Lilygo T7-S3](https://lilygo.cc/products/t7-s3) to a HUB75 Panel. Use ESP32-S3_16MB_opi_HUB75.bin. | ||
| This is the recommended option as it had the most memory, so can handle the highest number of pixels and also supports multiple digital mic options. | ||
|
|
||
|
|
||
| ## Configuration | ||
| ### Panel size and chain length | ||
| * Due to limitations in the HUB75 DMA driver, only these panel dimensions are supported: | ||
| * 32 x 32 (2-scan or 4-scan) | ||
| * 64 x 32 (2-scan or 4-scan) | ||
| * 64 x 64 (2-scan or 4-scan) | ||
| * 128 x 64 (2-scan or 4-scan). | ||
| * Only _one HUB75e port_ is supported. | ||
| * Please chain your panels (panel#1 _OUT_ --> panel#2 _IN_) if you want to control more than one panel. | ||
| * Maximum possible size: | ||
| * Classic ESP32: the maximum possible size is 128x64 - however WLED might get unstable with this setup. We recommend to use no more than 64x64 on classic esp32. | ||
| * ESP32-S3 without PSRAM (including Huidu HD-WF2): the maximum possible size is 128x64, however we recommend to use 64x64 because the firmware might get unstable above this size. | ||
| * ESP32-S3 with PSRAM - octal "opi" PSRAM recommended (including LilyGO T7-S3) : the maximum possible size is 256x64, i.e. 4 chained panels of 64x64 pixels each. | ||
| * ESP32-S2 is possible, however _not recommended_ due to smaller RAM | ||
| * ESP32-C3, ESP32-C6 and ESP8266 do not support HUB75 | ||
|
|
||
| ### Panel Size and Chain Length | ||
|
|
||
| Due to limitations in the HUB75 DMA driver, only these panel dimensions are supported: | ||
|
|
||
| * 32 x 32 (2-scan or 4-scan) | ||
| * 64 x 32 (2-scan or 4-scan) | ||
| * 64 x 64 (2-scan or 4-scan) | ||
| * 128 x 64 (2-scan or 4-scan). | ||
|
|
||
| Only _one HUB75e port_ is supported. | ||
| Please chain your panels (panel#1 _OUT_ --> panel#2 _IN_) if you want to control more than one panel. | ||
|
|
||
| #### Maximum possible size with panel chaining: | ||
|
|
||
| * Classic ESP32: the maximum possible size is 128x64 - however WLED might get unstable with this setup. We recommend to use no more than 64x64 on classic esp32. | ||
| * ESP32-S3 without PSRAM (including Huidu HD-WF2): the maximum possible size is 128x64, however we recommend to use 64x64 because the firmware might get unstable above this size. | ||
| * ESP32-S3 with PSRAM - octal "opi" PSRAM recommended (including LilyGO T7-S3) : the maximum possible size is 256x64, i.e. 4 chained panels of 64x64 pixels each. | ||
| * ESP32-S2 is possible, however _not recommended_ due to smaller RAM | ||
| * ESP32-C3, ESP32-C6 and ESP8266 do not support HUB75 | ||
|
|
||
| ### Setup | ||
|
|
||
| First, you must set the LED output to match the correct Hub75Matrix option for the panel size you are using. The chain length is the number of panels connected. Note: currently only a horizontal chain of panels is supported. ~~You can used 2D setup to configure physical panel positions~~ unfortunately it's not possible to use 2D setup to change the panel layout of chained panels. | ||
|
|
||
| Next, you need to go into the 2D Configuration and create a _single_ matrix with the total size of your hub75 setup. e.g a chain of 2 panels with 32x32 pixels each, would be created as a 64x32 matrix in the 2D configuration page | ||
|
|
||
| ## HUB75 Known Problems and Limitations | ||
|
|
||
| ## HUB75 Known Problems and Limitations | ||
| * Maximum possible sizes: see previous section | ||
| * combining HUB75 with other LED types (including virtual leds) was not tested yet - it may or may not work. | ||
| * Maximum possible sizes: [see previous section](#panel-size-and-chain-length) | ||
| * After changing HUB75 options (LED preferences), your display will go black. You need to reboot for driver changes to take effect. | ||
| * classic ESP32: using audioreactive microphones (or line-in) causes crashes and wifi instabilities. You can still use UDP sound receive for receiving audio data from another board. Please select "None - network receive only" as DigitalMic type. | ||
| * ESP32-S2: its not possible to use HUB75 and audioreactive at the same time. | ||
| * ESP32-S3: After changing HUB75 options (LED preferences), your display will go black. You need to reboot for driver changes to take effect. | ||
| * ESP32-S3: audioreactive works together with HUB75 panel output. There are no known restrictions. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not sure if this still applies in upstream WLED, need to test.