Skip to content
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

animARTrix not showing in Usermods config despite being visible in "Info" tab #4465

Open
1 task done
twintersx opened this issue Jan 8, 2025 · 11 comments
Open
1 task done
Assignees
Labels
confirmed The bug is reproducable and confirmed enhancement
Milestone

Comments

@twintersx
Copy link

What happened?

Mod is not visible in Usermods config despite being visible in Info tab
IMG_5023
IMG_5022

To Reproduce Bug

Add usermod build_flag -D USERMOD_ANIMARTRIX
Uncomment library dependency ;https://github.com/netmindz/animartrix.git#18bf17389e57c69f11bc8d04ebe1d215422c7fb7

Expected Behavior

usermod header and checkbox should be visible in Usermod config

Install Method

Self-Compiled

What version of WLED?

WLED v0.16.0-alpha

Which microcontroller/board are you seeing the problem on?

ESP32, ESP32-C3

Relevant log/trace output

No response

Anything else?

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct
@twintersx twintersx added the bug label Jan 8, 2025
@dosipod
Copy link
Contributor

dosipod commented Jan 8, 2025

Confirmed also from our side on both esp32c3 and classic esp32

@softhack007
Copy link
Collaborator

softhack007 commented Jan 8, 2025

How did you add the animartix usermod? It's not part of the usermods included in the Aircoookie/WLED repo.

Sorry my fault - its here, seems that @netmindz has added it a few weeks ago.

@softhack007
Copy link
Collaborator

animartix currently relies on a small extension from the MoonModules fork, which allows any usermod to have an "enabled" option without requiring to explicitly implement addToConfig() and readFromConfig().

https://github.com/MoonModules/WLED/blob/79c26db4fab4327813b2362519a0f5104ac035d3/wled00/fcn_declare.h#L311-L318

actually it might be worth bringing this small enhancement to upstream - it allows to simplify usermods that do not need settings other than "enable".

@softhack007 softhack007 added the confirmed The bug is reproducable and confirmed label Jan 8, 2025
@blazoncek
Copy link
Collaborator

If a usermod does not have any persistent configuration (i.e. does not implement addToConfig()) it will not show in settings.

@netmindz netmindz self-assigned this Jan 8, 2025
@netmindz netmindz added this to the 0.15.1 candidate milestone Jan 8, 2025
@netmindz
Copy link
Collaborator

netmindz commented Jan 8, 2025

Do the effects show in the list? There aren't actually any settings so it should be enabled by default

@dosipod
Copy link
Contributor

dosipod commented Jan 8, 2025

Yes the effects will show in the list but I thought there will be enable/disable button in the usermod same as in MM but as softhack mentioned it is not there .

@netmindz
Copy link
Collaborator

netmindz commented Jan 8, 2025

In the version in AC the enabled value does nothing at all, so having the option to enable/disable in the settings would make no sense

@netmindz netmindz closed this as completed Jan 8, 2025
@dosipod
Copy link
Contributor

dosipod commented Jan 8, 2025

@netmindz I think the option to enable/disable in the settings would make sense if you want to remove the effects from the list as there are too many but sure if you think so .It is just the inconstant UI behavior between MM and AC may lead to confusion. This is the only usermod I could see with this behavior but could be others we missed , at least adding a comment in the readme might do .

@netmindz
Copy link
Collaborator

netmindz commented Jan 8, 2025

As it's not included in any of the AC builds, if you don't want the effects, just don't add the usermod surely?

MM has a better way to handle enable/disable for all usermods, but this is isn't present in AC so would need to bring that over really before looking to add optional effect adding to this usermod

@softhack007
Copy link
Collaborator

softhack007 commented Jan 8, 2025

@netmindz the "minimal impact solution" would be to simply add the (MM default) functions addToConfig() and readFromConfig() into the AC version of the animartix usermod - plus some minor sugar around it to define the _name and _enabled strings.

I think that having an "enable" checkbox makes sense for the animArtrix usermod.

@softhack007
Copy link
Collaborator

re-opring as an enhancement.

@softhack007 softhack007 reopened this Jan 8, 2025
@netmindz netmindz modified the milestones: 0.15.1 candidate, 0.15.2 Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
confirmed The bug is reproducable and confirmed enhancement
Projects
None yet
Development

No branches or pull requests

5 participants