Document workarounds for WLED HA integration limitations#314
Document workarounds for WLED HA integration limitations#314
Conversation
Added workarounds for known limitations of the WLED integration, including issues with custom palettes, AudioReactive usermod, sound-reactive effects, and color control.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughDocumentation clarifying that WLED should be configured via Home Assistant's official WLED integration and adding a "Workarounds for known HA integration limitations" section with REST and preset examples for palettes, AudioReactive control, RGB+CCT behavior, multi-segment control, and secondary/tertiary color mapping. ChangesHome Assistant Integration Documentation
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/advanced/home-automation.md (1)
46-47: ⚡ Quick winUse admonitions for workaround callouts instead of bold labels.
At Lines 46, 70, 90, 106, 114, 158, and 172,
**Workaround:**should be converted to MkDocs admonitions for consistency and better scanability.Example conversion pattern
-**Workaround:** Use `rest_command` to set the palette by ID. +!!! tip "Workaround" + Use `rest_command` to set the palette by ID.As per coding guidelines: “Use MkDocs Material admonitions (
!!! info,!!! tip,!!! warning,!!! danger) for callouts instead of plain text or other formatting.”Also applies to: 70-71, 90-91, 106-107, 114-115, 158-159, 172-173
🤖 Prompt for 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. In `@docs/advanced/home-automation.md` around lines 46 - 47, Replace each bold " **Workaround:** " callout in docs/advanced/home-automation.md with a MkDocs Material admonition (use "!!! tip" for workaround semantics); e.g., locate occurrences of the literal string "**Workaround:**" and convert the following sentence/block into an indented body under "!!! tip" (preserve any inline code, URLs, and examples), ensuring proper indentation for multiline content and leaving surrounding text unchanged — update all instances of that literal (the ones noted in the review) so the rendered pages use MkDocs admonitions instead of bold labels.
🤖 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/home-automation.md`:
- Around line 38-42: Change the new workaround section and its subsections from
level-5/sentence-case headings to the prescribed `###`/`####` depth and Title
Case; specifically update the "Workarounds for known integration limitations"
heading and each subsection heading such as "Custom palettes not visible in HA"
(and the other subsection titles referenced) to use `###` or `####` as
appropriate and convert their text to Title Case (e.g., "Custom Palettes Not
Visible in HA"); ensure heading markers and capitalization are consistent with
the project's guideline of using `##` for top-level and `###`/`####` for
sub-sections.
---
Nitpick comments:
In `@docs/advanced/home-automation.md`:
- Around line 46-47: Replace each bold " **Workaround:** " callout in
docs/advanced/home-automation.md with a MkDocs Material admonition (use "!!!
tip" for workaround semantics); e.g., locate occurrences of the literal string
"**Workaround:**" and convert the following sentence/block into an indented body
under "!!! tip" (preserve any inline code, URLs, and examples), ensuring proper
indentation for multiline content and leaving surrounding text unchanged —
update all instances of that literal (the ones noted in the review) so the
rendered pages use MkDocs admonitions instead of bold labels.
🪄 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
Run ID: 7062834f-db85-4ecc-8a89-5d16c2c57026
📒 Files selected for processing (1)
docs/advanced/home-automation.md
| #### Workarounds for known integration limitations | ||
|
|
||
| The native integration has known limitations documented in the [official HA WLED integration docs](https://www.home-assistant.io/integrations/wled/). Below are practical workarounds using WLED's REST API. | ||
|
|
||
| ##### Custom palettes not visible in HA |
There was a problem hiding this comment.
Fix heading levels and title case for the new workaround section.
Line 38 and the subsection headings at Lines 42, 66, 86, 102, 110, and 154 currently use level-5 headings and sentence case. Please keep subsection depth at ###/#### and switch these headings to title case.
Suggested heading structure
-#### Workarounds for known integration limitations
+### Workarounds for Known Integration Limitations
-##### Custom palettes not visible in HA
+#### Custom Palettes Not Visible in HA
-##### AudioReactive usermod not controllable
+#### AudioReactive Usermod Not Controllable
-##### Sound-reactive and 2D matrix effects may not work
+#### Sound-Reactive and 2D Matrix Effects May Not Work
-##### Mixed RGB+CCT strips – only one color model active
+#### Mixed RGB+CCT Strips – Only One Color Model Active
-##### No master control for color/effect across all segments
+#### No Master Control for Color/Effect Across All Segments
-##### Secondary and tertiary effect colors cannot be set from HA
+#### Secondary and Tertiary Effect Colors Cannot Be Set from HAAs per coding guidelines: “Use ## for top-level sections… use ### and #### for sub-sections” and “Use title case for section and subsection headings.”
Also applies to: 66-67, 86-87, 102-103, 110-111, 154-155
🤖 Prompt for 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.
In `@docs/advanced/home-automation.md` around lines 38 - 42, Change the new
workaround section and its subsections from level-5/sentence-case headings to
the prescribed `###`/`####` depth and Title Case; specifically update the
"Workarounds for known integration limitations" heading and each subsection
heading such as "Custom palettes not visible in HA" (and the other subsection
titles referenced) to use `###` or `####` as appropriate and convert their text
to Title Case (e.g., "Custom Palettes Not Visible in HA"); ensure heading
markers and capitalization are consistent with the project's guideline of using
`##` for top-level and `###`/`####` for sub-sections.
There was a problem hiding this comment.
Pull request overview
This PR expands the Home Assistant documentation to include practical workarounds (primarily via Home Assistant rest_command and WLED presets) for limitations of the native WLED integration.
Changes:
- Adds a new “Workarounds for known integration limitations” section under the Home Assistant native integration docs.
- Documents REST API–based approaches for setting palettes, applying multi-segment changes, and setting secondary/tertiary colors.
- Recommends using WLED presets as a reliable control mechanism when HA entity support is incomplete.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| **Workaround:** Use a `rest_command` to set the palette by ID. Custom palettes are numbered starting from ID 71 (after the ~71 built-in palettes). To find the exact ID of your custom palette, query `GET http://<wled-ip>/json/palettes` and check the array index. | ||
|
|
||
| ```yaml | ||
| rest_command: | ||
| wled_set_palette: | ||
| url: "http://{{ ip }}/json/state" | ||
| method: POST | ||
| content_type: application/json | ||
| payload: '{"seg":[{"id":0,"pal":{{ palette_id }}}]}' | ||
| ``` | ||
|
|
||
| Example automation: | ||
| ```yaml | ||
| action: rest_command.wled_set_palette | ||
| data: | ||
| ip: "192.168.1.100" | ||
| palette_id: 71 # first custom palette | ||
| ``` |
| ```yaml | ||
| rest_command: | ||
| wled_set_palette: | ||
| url: "http://{{ ip }}/json/state" | ||
| method: POST | ||
| content_type: application/json | ||
| payload: '{"seg":[{"id":0,"pal":{{ palette_id }}}]}' | ||
| ``` |
There was a problem hiding this comment.
Not needed. This isn't documentation for beginners.
There was a problem hiding this comment.
@mik-laj you'd be surprised 😉
a short hint may help some "pseudo-experts" to avoid mistakes.
Updated workaround for custom palettes to reflect new ID numbering.
Updated section headers for clarity and consistency in the documentation regarding Home Assistant WLED integration workarounds.
Removed section about sound-reactive and 2D matrix effects, including workarounds and preset usage.
This comment was marked as outdated.
This comment was marked as outdated.
The WLED HA integration has known limitations that can be worked around using WLED's JSON API. This PR adds a new section documenting practical workarounds with YAML examples.
These workarounds are documented here rather than in the HA integration docs to keep them maintainable. The HA team is limited in its ability to maintain them due to limited knowledge of the WLED JSON API.
Summary by CodeRabbit