Skip to content

Rework HUB75 docs: multi-panel grids, board table, power, 16.0.1 updates#340

Open
bharvey88 wants to merge 3 commits into
wled:mainfrom
bharvey88:hub75-docs-rework
Open

Rework HUB75 docs: multi-panel grids, board table, power, 16.0.1 updates#340
bharvey88 wants to merge 3 commits into
wled:mainfrom
bharvey88:hub75-docs-rework

Conversation

@bharvey88

@bharvey88 bharvey88 commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

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:

  • "Only a horizontal chain of panels is supported" and "it's not possible to use 2D setup to change the panel layout of chained panels" are outdated. The HUB75 output has had No. of Panels and rows x cols fields 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.
  • The limit is total pixel count, not shape: four 64x64 panels on S3 + octal PSRAM can be 128x128 (2x2), not only 256x64.

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

  • Documentation
    • Reorganized and expanded HUB75 setup guidance with a new “Supported Boards and Builds” overview.
    • Added clearer wiring and chaining/custom pinout explanations, including build-time limitations and default wiring guidance.
    • Strengthened power guidance, updated panel sizing/display limits, and clarified brightness/power estimate caveats for HUB75.
    • Refined HUB75 configuration steps (output/scan rate, total pixel matrix inputs) and noted reboot/resizing requirements.
    • Documented grid layout behavior (including folded/back-mounted cases) and refreshed known problems/limitations, including ESP32-S3 compatibility.

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.
@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: ef9d94fd-9cb7-40e5-8d07-64a97ac77a10

📥 Commits

Reviewing files that changed from the base of the PR and between 01d64f0 and d8967d4.

⛔ Files ignored due to path filters (1)
  • docs/assets/images/content/hub75-esp32-wiring.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • docs/advanced/HUB75.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/advanced/HUB75.md

Walkthrough

Changes

The HUB75 guide now covers supported builds, wiring and power, display limits, configuration, grid construction, and board-specific limitations.

HUB75 Documentation

Layer / File(s) Summary
Supported builds and hardware setup
docs/advanced/HUB75.md
Adds board/build guidance and consolidates chained-panel wiring, custom pinouts, and dedicated 5V power requirements.
Display limits and configuration
docs/advanced/HUB75.md
Documents supported display assemblies, chip limits, HUB75 settings, 2D matrix sizing, reboot requirements, and 2x2 grid rotation.
Known problems and limitations
docs/advanced/HUB75.md
Updates reboot, audioreactive, Wi-Fi, ESP32-S2, and ESP32-S3 limitation notes.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

  • wled/WLED-Docs#321: Reworks the same HUB75 documentation page and its setup, configuration, and limitations sections.

Poem

A rabbit hops through panels bright,
Wiring tidy, pixels light.
Five volts flow and grids align,
Scan rates march in perfect time.
HUB75 blooms, row by row!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main docs rework around HUB75 grids, supported boards, power guidance, and v16.0.1 updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified 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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1bce1e6 and 45db057.

⛔ Files ignored due to path filters (1)
  • docs/assets/images/content/hub75-64x64-4-panel.jpg is excluded by !**/*.jpg
📒 Files selected for processing (1)
  • docs/advanced/HUB75.md

Comment thread docs/advanced/HUB75.md Outdated
Comment thread docs/advanced/HUB75.md Outdated
Comment thread docs/advanced/HUB75.md Outdated
Comment thread docs/advanced/HUB75.md
Comment thread docs/advanced/HUB75.md Outdated
Comment thread docs/advanced/HUB75.md Outdated
Comment thread docs/advanced/HUB75.md Outdated
Comment thread docs/advanced/HUB75.md Outdated
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".
@softhack007

Copy link
Copy Markdown
Member

Thanks, I'll cross-read your changes over the weekend 👍

@bharvey88

Copy link
Copy Markdown
Contributor Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants