Skip to content

Add user_fx installation instructions and a usermod config example#5327

Open
gustebeast wants to merge 4 commits intowled:mainfrom
gustebeast:wled-gtb-effect-config-example
Open

Add user_fx installation instructions and a usermod config example#5327
gustebeast wants to merge 4 commits intowled:mainfrom
gustebeast:wled-gtb-effect-config-example

Conversation

@gustebeast
Copy link
Contributor

@gustebeast gustebeast commented Jan 28, 2026

When I was getting started I had trouble with WLED information referencing old methods for installing usermods. Since user_fx is a form of example/getting started effect it seems worth explaining the process again to be clear.

I also just had difficulty figuring out how to read usermod config values from my effect function, and having an example for that would have helped a lot.

Summary by CodeRabbit

  • Documentation

    • Added an Installation guide with activation instructions and examples; expanded navigation with sections on metadata, effects, combining effects, and compilation.
  • Chores

    • Added developer scaffolding and commented reference blocks showing where to add persistent configuration read/write guidance (documentation-only; no runtime or behavioral changes).

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 28, 2026

Walkthrough

Adds an Installation section and navigation entries to usermods/user_fx/README.md, and inserts commented configuration scaffolding and examples in usermods/user_fx/user_fx.cpp. No executable code, public API signatures, or runtime behavior were changed. (50 words)

Changes

Cohort / File(s) Summary
Documentation
usermods/user_fx/README.md
Added "Installation" TOC entry and new Installation section with platformio_override.ini examples and alternative wording for including the usermod.
Commented config scaffolding
usermods/user_fx/user_fx.cpp
Inserted commented guidance showing where to add class-level config fields and example addToConfig / readFromConfig implementations; comments only, no active code or API changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 75.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and concisely describes the main changes: adding installation instructions to the README and including a usermod configuration example in the source code.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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 and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@usermods/user_fx/README.md`:
- Around line 18-22: Update the Installation section to show the setting as an
.ini code block and demonstrate both the simple add and the safe append case so
users don't overwrite existing usermods; explicitly reference the
platformio_override.ini key name custom_usermods and the usermod name user_fx,
show the single-entry example (custom_usermods = user_fx) inside an ini block,
and add a second ini block showing how to append to an existing list (e.g.,
custom_usermods = user_v2, user_fx).

@gustebeast gustebeast force-pushed the wled-gtb-effect-config-example branch from 0235b62 to ff351a1 Compare February 4, 2026 18:28
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.

1 participant