core icon indicating copy to clipboard operation
core copied to clipboard

Add Ecovacs custom command event

Open lnx85 opened this issue 9 months ago • 2 comments

Breaking change

Proposed change

Add the ability to send custom commands that requires list as params (i.e. getPos that needs a list with two values, "deebotPos" and "chargePos"). Send custom commands' response with a new "ecovacs_custom_command" event.

Type of change

  • [ ] Dependency upgrade
  • [ ] Bugfix (non-breaking change which fixes an issue)
  • [ ] New integration (thank you!)
  • [x] New feature (which adds functionality to an existing integration)
  • [ ] Deprecation (breaking change to happen in the future)
  • [ ] Breaking change (fix/feature causing existing functionality to break)
  • [ ] Code quality improvements to existing code or addition of tests

Additional information

Checklist

  • [x] The code change is tested and works locally.
  • [ ] Local tests pass. Your PR cannot be merged unless tests pass
  • [x] There is no commented out code in this PR.
  • [x] I have followed the development checklist
  • [x] I have followed the perfect PR recommendations
  • [x] The code has been formatted using Ruff (ruff format homeassistant tests)
  • [ ] Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • [ ] The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • [ ] New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • [ ] For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • [ ] Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

lnx85 avatar May 09 '24 12:05 lnx85

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks :+1:

Learn more about our pull request process.

home-assistant[bot] avatar May 09 '24 12:05 home-assistant[bot]

Hey there @overloadut, @mib1185, @edenhaus, @augar, mind taking a look at this pull request as it has been labeled with an integration (ecovacs) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of ecovacs can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign ecovacs Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

home-assistant[bot] avatar May 09 '24 12:05 home-assistant[bot]

HA supports service call responses and we should use it for this usecase.

Can you create a new service call in the ecovacs integration for it? I would call it send_custom_command or something similar

@edenhaus The original send_command service already allows to send custom commands but restricts params to dict instead of dict | list (requested in some custom commands). Do I really need to write a specific method instead of editing the original send_command?

lnx85 avatar May 09 '24 19:05 lnx85

I tried implementing the Service Response but it is not working. The deebot_client library does not return a response after a service call but, instead, generates an asyncronous event with the response.

lnx85 avatar May 10 '24 09:05 lnx85

The only command that requires list instead of dict is getPos. I'm working on a PR that implements the same feature by using deebot_client library.

lnx85 avatar May 17 '24 14:05 lnx85