Default button actions overrides

[vicfergar]

This PR includes a new configuration option called start_action that can be used to define which service to call when the start button is pressed.

I have updated documentation file too.

This can solve issue #158

[denysdovhan]

I've suggested a few changes. Please, test locally.

[vicfergar]

Proposed changes included and tested locally. Thanks!

[vicfergar]

There is something that maybe should be changed. Differentiate between HandleStart and HandleResume, because probably for most cases only HandleStart must be replaced.

Would you like if I add this distinction and include custom action (resume_action) just in case someone needs to override the default behavior for resume too?

[denysdovhan]

@vicfergar yes, I'd like to. Maybe we can also add custom handlers for stop and pause. Grouping them under the prop would be great.

I'd like to call it actions and rename actions to shortcuts, but it's gonna be a breaking change 😞

[vicfergar]

@denysdovhan I'm agree with that. If breaking change is an issue (I suppose it can be 😄), what about a group called custom_actions or override_actions and rename current actions to shortcuts (while accepting actions as backward compatibility)

Something like:

type: 'custom:vacuum-card'
entity: vacuum.vacuum_cleaner
override_actions:
  start:
    service: xiaomi_miio.vacuum_clean_segment
    service_data:
      entity_id: vacuum.vacuum_cleaner
      segments: [16, 20]
  resume:
    service: script.custom_resume
  pause:
    service: script.custom_pause
  stop:
    service: script.custom_stop
  return_to_base:
    service: script.custom_return_to_base
  localize:
    service: script.custom_localize
shortcuts: #or actions for backward compatibility
  - name: Clean living room
    service: script.clean_living_room
    icon: 'mdi:sofa'

What do you think?

[denysdovhan]

We can release a breaking version — this is not a problem. It's relatively easy to check what we have in actions. If it's an object — it's an override for start, stop, etc; if it's an array — it's a list of shortcuts and we should display a deprecation warning and do not render them.

[vicfergar]

Hi @denysdovhan I tried to acomplish the proposed solution.

Please let me know if you would like to change something or propose any change if needed 😉

[vicfergar]

Hi @denysdovhan

Any news on this? I have been using this branch without problems for a while since our last conversation.

[mikhail5555]

If its not too big of a feature creep, could you maybe add the option to completely disable the default buttons? (I personally use only selected rooms cleaning which renders that button useless and only prone to misclicks)

[denysdovhan]

Thanks for contributing!

[github-actions]

🎉 This PR is included in version 2.0.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀