Rework HUB75 docs: multi-panel grids, board table, power, 16.0.1 updates#340
Rework HUB75 docs: multi-panel grids, board table, power, 16.0.1 updates#340bharvey88 wants to merge 3 commits into
Conversation
Correct the multi-panel documentation (grids via rows x cols have worked since v16.0.0, not just horizontal chains) and reorganize the page into focused sections: boards table, wiring/pinouts, power, panel size limits, configuration (with a 2x2 grid walkthrough), and known problems. Also add the Waveshare board and Seengreat pinout (new in 16.0.1), a power section, a version tip, a photo of a 2x2 build, and cross-links to Segments and LED mapping.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
WalkthroughChangesThe HUB75 guide now covers supported builds, wiring and power, display limits, configuration, grid construction, and board-specific limitations. HUB75 Documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches✨ Simplify code
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 8
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/advanced/HUB75.md`:
- Line 8: Update the HUB75 documentation sentence to use “bug fixes” instead of
“bugfixes,” preserving the surrounding wording and meaning.
- Line 77: Update the subsection heading `Building a grid` to title case as
`Building a Grid`.
- Line 12: Update the “Supported boards and builds” section heading to title
case: “Supported Boards and Builds.”
- Line 44: Update the “Panel size and limits” section heading to title case:
“Panel Size and Limits.”
- Line 26: Update the “Wiring and custom pinouts” section heading to title case:
“Wiring and Custom Pinouts”.
- Around line 28-34: Download the HUB75 wiring image referenced by the
display_esp32_wiring_bb Markdown image, add it under
docs/assets/images/content/, and update the image link in the HUB75
documentation to use that local asset path instead of the GitHub
user-attachments URL.
- Around line 53-60: Clarify the 128 x 64 entry in the HUB75 sizing table to
distinguish general compatibility from the recommended stable configuration.
Update its ESP32 capability wording to indicate that PSRAM is recommended or
required for stability, while preserving the chip-limit note’s guidance for
boards without PSRAM.
- Line 75: Update the “Segments” and “LED mapping” links in the matrix
configuration guidance to use root-relative paths without the .md extensions,
preserving their existing destinations and link text.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro Plus
Run ID: 60c965d4-511e-486b-931c-8df9a61f2e80
⛔ Files ignored due to path filters (1)
docs/assets/images/content/hub75-64x64-4-panel.jpgis excluded by!**/*.jpg
📒 Files selected for processing (1)
docs/advanced/HUB75.md
Align with AGENTS.md: Title Case headings, root-relative internal links without the .md extension, and the info admonition type.
Localize the ESP32 wiring diagram into docs/assets/images/content instead of external hosting, note that 128x64 prefers PSRAM for stability, and use "bug fixes" instead of "bugfixes".
|
Thanks, I'll cross-read your changes over the weekend 👍 |
Thanks! I used 4x chained 64x64 hub75 in a 128x128 2x2 setup and noticed the docs were out of date. Then instead of just changing a few things decided to try and improve the doc fully. I went back and forth with Claude extensively changing wording and rearranging things in to tables. I think I ended up with a much improved document. |
The HUB75 page predates the multi-panel grid support in v16.0.0/16.0.1 and mixed build, wiring, sizing, and config into a few prose sections. This reworks it.
Main fixes:
No. of Panelsandrows x colsfields since v16.0.0 (wled00/data/settings_leds.htm), so panels can be arranged as a grid (e.g. 2x2). Verified on hardware: a 2x2 of 64x64 panels (128x128) with the bottom row rotated 180°,rows x cols = 2x2, renders upright with no further config.Reorganized into: Supported boards (table), Wiring/pinouts, Power, Panel size and limits, Configuration (with a grid walkthrough), Known problems. Also adds the Waveshare board and Seengreat pinout (both new in 16.0.1), a Power section, a v16.0.1+ tip, a note that a resized matrix needs its segment resized, a photo of a 2x2 build, and cross-links to Segments and LED mapping.
New image:
docs/assets/images/content/hub75-64x64-4-panel.jpg.Summary by CodeRabbit