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

Added recognized options to Home Connect actions #130662

Draft
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

Diegorro98
Copy link
Contributor

@Diegorro98 Diegorro98 commented Nov 14, 2024

Breaking change

Proposed change

Actions in Home Connect now have recognized options that will allow the user to easily choose options for their programs when starting and selecting a program and changing options of a already selected and started program.

These options are grouped based on the options for each appliance type, just like API documentation.

There are also custom options key at services where the users can use option keys that are not recognized here, and can be multiple options (before only one option was available per service call). Also is an easy way to migrate from the old action payload. So old action keys key, value, and units are being deprecated (An issue will be generated).

Program keys can be still be used like always at start and select program actions, but the user can select one of the recognized programs from the selector.

Also ServiceValidationError exceptions have been added to give direct feedback to the user.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • 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

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • 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.

To help with the load of incoming pull requests:

@home-assistant
Copy link

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

Code owner commands

Code owners of home_connect 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 home_connect 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.

@Diegorro98
Copy link
Contributor Author

Diegorro98 commented Nov 14, 2024

I let this PR as a draft until #126157 is merged, as both use some common things

@Diegorro98
Copy link
Contributor Author

The action options doesn't have descriptions because I was thinking to use the same descriptions than API documentation have, but I wanted to hear opinions about that.

@Diegorro98
Copy link
Contributor Author

Because this services.yaml and strings have become huge, I though that for a future PR maybe start and select actions can be merged into just one action with an option that could allow to start or select the program.

Same for the services that allow to set options to selected and active programs.

@Diegorro98
Copy link
Contributor Author

@boergegrunicke, these are the action changes I mentioned to you the other day. Please let me know your thoughts. :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant