Skip to content

Add valve platform support to google_assistant#106139

Merged
jbouwh merged 2 commits into
devfrom
jbouwh-google-assistant-valve
Dec 23, 2023
Merged

Add valve platform support to google_assistant#106139
jbouwh merged 2 commits into
devfrom
jbouwh-google-assistant-valve

Conversation

@jbouwh
Copy link
Copy Markdown
Contributor

@jbouwh jbouwh commented Dec 20, 2023

Proposed change

Add valve platform to google_assistant

Binary valve example screenshot

and with stop feature:

Position reporting valve example

and with stop feature:

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.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@home-assistant
Copy link
Copy Markdown
Contributor

Hey there @home-assistant/cloud, mind taking a look at this pull request as it has been labeled with an integration (google_assistant) you are listed as a code owner for? Thanks!

Code owner commands

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

COVER_VALVE_STATES[domain]["closing"],
COVER_VALVE_STATES[domain]["opening"],
)
or domain == valve.DOMAIN
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We want the stop function to be always available since we can not read determine from, the state if stop should be available,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is that?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It will ensure that the Stop button is shown, not the Start button. See also the comment below.

Comment on lines +881 to +882
if domain == valve.DOMAIN:
return {"isRunning": True}
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We return True, so the state is always running and the Stop function will be always available (if supported)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, why don't we rely on CLOSING + OPENING states like we do for cover?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reason is that not all valves support that, but they can support the stop function. Which should be always available and not depend on the reported state.
Futher the Start button, that will pop up instead will not make any sense, hence I made this button to always show Stop.

To avoid this:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that should be a UX fix. Replace Start button for open/close depending on the state. And isRunning uses the same logic as the cover.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not something we can easily customize. It is how the start stop treat works. The integration can decide if a stop command should be processed.

Copy link
Copy Markdown
Contributor Author

@jbouwh jbouwh Dec 22, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BTW. the cover implentation ideed has the same issue:

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest I open a separate PR to fix this for cover as well.

Copy link
Copy Markdown
Contributor Author

@jbouwh jbouwh Dec 25, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another suggestion is to use Start to toggle the valve (or cover) #106378

Copy link
Copy Markdown
Contributor

@rokam rokam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, only one item called my attention.

Comment thread homeassistant/components/google_assistant/trait.py
Copy link
Copy Markdown
Contributor

@emontnemery emontnemery left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, just some minor comments and a question about the opening / closing states.

Comment thread homeassistant/components/google_assistant/trait.py Outdated
Comment on lines +881 to +882
if domain == valve.DOMAIN:
return {"isRunning": True}
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, why don't we rely on CLOSING + OPENING states like we do for cover?

Comment thread homeassistant/components/google_assistant/trait.py Outdated
COVER_VALVE_STATES[domain]["closing"],
COVER_VALVE_STATES[domain]["opening"],
)
or domain == valve.DOMAIN
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is that?

Comment thread homeassistant/components/google_assistant/trait.py Outdated
Comment thread homeassistant/components/google_assistant/trait.py Outdated
Comment thread homeassistant/components/google_assistant/trait.py Outdated
@home-assistant
Copy link
Copy Markdown
Contributor

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

Learn more about our pull request process.

@home-assistant home-assistant Bot marked this pull request as draft December 22, 2023 10:32
@jbouwh jbouwh marked this pull request as ready for review December 22, 2023 12:21
Copy link
Copy Markdown
Member

@joostlek joostlek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jbouwh jbouwh dismissed emontnemery’s stale review December 23, 2023 15:45

As discussed on discord, will open a PR to adjust the behavior for cover as well

@jbouwh jbouwh merged commit e311a68 into dev Dec 23, 2023
@jbouwh jbouwh deleted the jbouwh-google-assistant-valve branch December 23, 2023 15:46
Bre77 pushed a commit to Bre77/core that referenced this pull request Dec 23, 2023
* Add valve platform to google_assistant

* Use constant for domains set
Bre77 pushed a commit to Bre77/core that referenced this pull request Dec 23, 2023
* Add valve platform to google_assistant

* Use constant for domains set
@github-actions github-actions Bot locked and limited conversation to collaborators Dec 24, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants