Option for custom actions to override hooks

[Foggy2]

Hi All,

I am starting this discussion to continue what has started in #693.

I understand that the current behavior of controllers is to simultaneously fire both the hook action and any custom actions, when a button is pressed.

I can see situations where this behavior is beneficial, but I can also see situations where this behavior is undesirable.

For example, I could see a scenario such as the following being encountered commonly. When using two button controllers such as the Ikea E2201 Rodret. The light hook for those controllers, contains an action mapping for all possible button combinations by default.

If you wish to re-map a button to perform a different action, such as using a double press event to quickly recall a preset color/brightness combination. You are unable as the double press will also trigger the hook action of adjusting the light color which will cause a conflict.

To resolve this potential conflict. I propose that another configuration option (toggle switch) be added to the blueprint UI that allows the user to select the behavior of custom actions. With the possible choices being:

• off (default) - The current behavior of both actions being executed
• on - The event to trigger any attached hooks is ignored and only the custom action is executed. If no custom action is defined, then no action would be executed. This would double as a way of disabling specific hook actions, if the need ever arises.

I am happy to take on the project of updating all of the controllers if it is decided to adopt this added functionality.

Happy to discuss, let me know your thoughts.

Thanks!

[EPMatt]

Hey @Foggy2,

Thanks for bringing this up! The way hooks and custom actions interact has always been a bit tricky - especially when you only want to override hook actions for specific buttons.

I really like your approach, however I'd go for a bit of a different take on the per-event input boolean:

• Name: "Fire Hook Actions"
• Description: Controls whether this event triggers hook actions. If turned off, only the custom action (if set) will run. If no custom action is defined, nothing will happen.
• Default: On (to keep things working as they do now)

This would give users the flexibility to disable hook actions per button while also allowing them to fully deactivate a button if needed.

Also, huge thanks for offering to implement this - would love to see your contribution! 🚀

What do you think? Curious to hear what the community thinks about this too. 🔥

[yarafie]

I think this is easily doable and probably have least impact.

[Foggy2]

Hey @EPMatt

That sounds good to me. Unless someone contributes to the discussion with a reason not to go ahead, I’ll start working on implementing this.

I’ve got a few things going on the next few weeks and will be a bit short on time but I’ll work on this as soon as I can.

[EPMatt]

@Foggy2 Sounds great! I'm happy to have you contribute to this feature.

Best of luck in the coming weeks - I’m really looking forward to your PR!

By the way, perfect timing - I’m currently revisiting documentation generation to streamline the process of creating and updating blueprints. You can check it out here: #722.

Hopefully, this will make things easier for you and future contributors 🚀