Add Valve integration #102184

cibernox · 2023-10-17T21:17:54Z

Proposed change

This adds the valve integration discussed in home-assistant/architecture#975

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

Most of the code is taken from the cover integration but simplified since valves can't tilt.

This PR fixes or closes issue: Add new Valve integration architecture#975
Link to general documentation pull request: Add documentation for new Valve integration home-assistant.io#29572
Link to the developer's documentation pull request: Document new valve integration developers.home-assistant#1977
Link to frontend pull request: Add valve entity frontend#19024

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][dev-checklist]
I have followed the [perfect PR recommendations][perfect-pr]
The code has been formatted using Black (black --fast homeassistant tests)
Tests have been added to verify that the new code works.

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

Documentation added/updated for [www.home-assistant.io][docs-repository]

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

The [manifest file][manifest-docs] 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:

I have reviewed two other open pull requests in this repository.

cibernox · 2023-10-17T21:22:06Z

This is a WIP but I wanted put it in the wild now.

There are a couple outstanding errors I'm not sure how to solve and prevents me from even making this commit without --no-verify, if anyone has any directions I'd appreciate it.

* [ERROR] [MANIFEST] Domain is missing an IoT Class

What iot_class should an integration that is more like an abstract contract for other integrations to build on top of have?

* [ERROR] [SERVICES] Invalid services.yaml: Unknown supported feature 'valve.ValveEntityFeature.CLOSE' @ data['close_valve']['target']['entity'][0]['supported_features'][0]. Got None

I have a couple errors similar to these but I can't figure out why I get them, I see no difference with how other services manifest and integration handle supported features.

homeassistant/components/valve/__init__.py

homeassistant/components/valve/device_action.py

homeassistant/components/valve/group.py

home-assistant · 2023-10-18T06:03:42Z

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.

MartinHjelmare · 2023-10-18T07:23:21Z

There are a couple outstanding errors I'm not sure how to solve and prevents me from even making this commit without --no-verify, if anyone has any directions I'd appreciate it.

* [ERROR] [MANIFEST] Domain is missing an IoT Class

What iot_class should an integration that is more like an abstract contract for other integrations to build on top of have?

Add the integration domain name to the Platform enum. Then we don't need to set an IoT class for the integration.

https://github.com/home-assistant/core/blob/348e95d026f80fad1ba8b97510d5fdcbda5ab551/homeassistant/const.py#L22

MartinHjelmare · 2023-10-18T08:23:43Z

* [ERROR] [SERVICES] Invalid services.yaml: Unknown supported feature 'valve.ValveEntityFeature.CLOSE' @ data['close_valve']['target']['entity'][0]['supported_features'][0]. Got None

Update the selectors helper:

core/homeassistant/helpers/selector.py

Lines 83 to 125 in 3cedfbc

    
           @cache 
        
           def _entity_features() -> dict[str, type[IntFlag]]: 
        
               """Return a cached lookup of entity feature enums.""" 
        
               # pylint: disable=import-outside-toplevel 
        
               from homeassistant.components.alarm_control_panel import ( 
        
                   AlarmControlPanelEntityFeature, 
        
               ) 
        
               from homeassistant.components.calendar import CalendarEntityFeature 
        
               from homeassistant.components.camera import CameraEntityFeature 
        
               from homeassistant.components.climate import ClimateEntityFeature 
        
               from homeassistant.components.cover import CoverEntityFeature 
        
               from homeassistant.components.fan import FanEntityFeature 
        
               from homeassistant.components.humidifier import HumidifierEntityFeature 
        
               from homeassistant.components.lawn_mower import LawnMowerEntityFeature 
        
               from homeassistant.components.light import LightEntityFeature 
        
               from homeassistant.components.lock import LockEntityFeature 
        
               from homeassistant.components.media_player import MediaPlayerEntityFeature 
        
               from homeassistant.components.remote import RemoteEntityFeature 
        
               from homeassistant.components.siren import SirenEntityFeature 
        
               from homeassistant.components.update import UpdateEntityFeature 
        
               from homeassistant.components.vacuum import VacuumEntityFeature 
        
               from homeassistant.components.water_heater import WaterHeaterEntityFeature 
        
               from homeassistant.components.weather import WeatherEntityFeature 
        
               return { 
        
                   "AlarmControlPanelEntityFeature": AlarmControlPanelEntityFeature, 
        
                   "CalendarEntityFeature": CalendarEntityFeature, 
        
                   "CameraEntityFeature": CameraEntityFeature, 
        
                   "ClimateEntityFeature": ClimateEntityFeature, 
        
                   "CoverEntityFeature": CoverEntityFeature, 
        
                   "FanEntityFeature": FanEntityFeature, 
        
                   "HumidifierEntityFeature": HumidifierEntityFeature, 
        
                   "LawnMowerEntityFeature": LawnMowerEntityFeature, 
        
                   "LightEntityFeature": LightEntityFeature, 
        
                   "LockEntityFeature": LockEntityFeature, 
        
                   "MediaPlayerEntityFeature": MediaPlayerEntityFeature, 
        
                   "RemoteEntityFeature": RemoteEntityFeature, 
        
                   "SirenEntityFeature": SirenEntityFeature, 
        
                   "UpdateEntityFeature": UpdateEntityFeature, 
        
                   "VacuumEntityFeature": VacuumEntityFeature, 
        
                   "WaterHeaterEntityFeature": WaterHeaterEntityFeature, 
        
                   "WeatherEntityFeature": WeatherEntityFeature, 
        
               }

cibernox · 2023-10-18T13:37:08Z

@MartinHjelmare thanks, I can commit normally now! I'll try to have this ready tonight, pending documentation.

homeassistant/components/poolstation/sensor.py

This adds the valve integration discussed in home-assistant/architecture#975 Most of the code is taken from the cover integration but simplified since valves can't tilt. There are a couple outstanding errors I'm not sure how to solve and prevents me from even making this commit without `--no-verify`.

jbouwh · 2023-10-25T21:31:56Z

@cibernox let me know if I can help

cibernox · 2023-10-25T21:48:03Z

@jbouwh I just pushed some changes with the feedback (mostly removing stuff so the functionality is minimal. Those can be added at a later date).

If CI thinks this is good, I'll start writing docs. I may mention you to review and proof-read them, english is not my first language after all.

jbouwh · 2023-10-25T21:52:59Z

@jbouwh I just pushed some changes with the feedback (mostly removing stuff so the functionality is minimal. Those can be added at a later date).

If CI thinks this is good, I'll start writing docs. I may mention you to review and proof-read them, english is not my first language after all.

English isn't my first language either.

As log as homeassistant/components/poolstation/sensor.py is not removed, CI tests will keep failing.

… add-valve-integration

cibernox · 2023-10-25T23:05:27Z

CI seems happy, now the docs.

emontnemery

Very nice, thanks @cibernox 👍

cibernox · 2023-12-12T15:54:34Z

@emontnemery thank you for the last push!

tests/components/valve/test_init.py

MartinHjelmare · 2023-12-12T16:57:27Z

We have the frontend part in progress. When the frontend PR is approved and linked in this PR description, we can merge here.

piitaya · 2023-12-12T17:39:25Z

Front-end PR : home-assistant/frontend#19024

MartinHjelmare

We're changing our base entity descriptions to be keyword only and frozen. Since there are no existing platforms for the valve integration we can set it here without backwards compatibility layer.

homeassistant/components/valve/__init__.py

piitaya · 2023-12-18T12:54:19Z

Front-end is merged

frenck · 2023-12-18T12:56:17Z

Thanks, @piitaya 👍

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

jbouwh

LGTM,
Thnx @cibernox, @emontnemery, @MartinHjelmare

tests/components/valve/test_init.py

cibernox · 2023-12-18T18:55:42Z

🎉 🎉 🎉

* Add Valve integration. This adds the valve integration discussed in home-assistant/architecture#975 Most of the code is taken from the cover integration but simplified since valves can't tilt. There are a couple outstanding errors I'm not sure how to solve and prevents me from even making this commit without `--no-verify`. * Apply PR feedback * Apply more feedback: Intruduce the bare minimum * Remove file commited by mistake * Hopefully this fixes tests * Match cover's typing and mypy settings * Change some configuration files * Fix test * Increase code coverage a little * Code coverate inproved to 91% * 95% code coverage * Coverate up to 97% * Coverage 98% * Apply PR feedback * Even more feedback * Add line I shouldn't have removed * Derive closed/open state from current position * Hopefully last feedback * Update homeassistant/components/valve/__init__.py Co-authored-by: Martin Hjelmare <marhje52@gmail.com> * Update homeassistant/components/valve/__init__.py Co-authored-by: Martin Hjelmare <marhje52@gmail.com> * Remove unnecesary translation * Remove unused method arguments * Complete code coverage * Update homeassistant/components/valve/__init__.py Co-authored-by: Martin Hjelmare <marhje52@gmail.com> * Simplify tests * Update homeassistant/components/valve/__init__.py Co-authored-by: Martin Hjelmare <marhje52@gmail.com> * Apply last feedback * Update tests/components/valve/test_init.py Co-authored-by: Martin Hjelmare <marhje52@gmail.com> * Update tests/components/valve/test_init.py Co-authored-by: Martin Hjelmare <marhje52@gmail.com> * Update tests/testing_config/custom_components/test/valve.py Co-authored-by: Martin Hjelmare <marhje52@gmail.com> * More feedback * Apply suggestion * And more feedback * Apply feedback * Remove commented code * Reverse logic to unindent * Update homeassistant/components/valve/__init__.py Co-authored-by: Martin Hjelmare <marhje52@gmail.com> * Update homeassistant/components/valve/__init__.py Co-authored-by: Martin Hjelmare <marhje52@gmail.com> * Implement stop valve for Mock valve * Fix tests now that I've implemented stop_valve * Assert it's neither opening nor closing * Use current position instead * Avoid scheduling executor when opening or closing * Fix incorrect bitwise operation * Simplify toggle * Remove uneeded partial functions * Make is_last_toggle_direction_open private * Remove valve from test custom integration * Improve test coverage * Address review comments * Address review comments * Address review comments * Update homeassistant/components/valve/__init__.py Co-authored-by: Martin Hjelmare <marhje52@gmail.com> * Update tests --------- Co-authored-by: Martin Hjelmare <marhje52@gmail.com> Co-authored-by: Erik <erik@montnemery.com>

cibernox requested a review from a team as a code owner October 17, 2023 21:17

home-assistant bot added cla-signed core Hacktoberfest has-tests integration: poolstation new-integration integration: valve labels Oct 17, 2023

jbouwh reviewed Oct 17, 2023

View reviewed changes

homeassistant/components/valve/__init__.py Show resolved Hide resolved

homeassistant/components/valve/__init__.py Outdated Show resolved Hide resolved

MartinHjelmare requested changes Oct 18, 2023

View reviewed changes

homeassistant/components/valve/device_action.py Outdated Show resolved Hide resolved

homeassistant/components/valve/group.py Outdated Show resolved Hide resolved

home-assistant bot marked this pull request as draft October 18, 2023 06:03

jbouwh reviewed Oct 25, 2023

View reviewed changes

homeassistant/components/poolstation/sensor.py Outdated Show resolved Hide resolved

cibernox added 2 commits October 25, 2023 23:15

Apply PR feedback

c89804a

cibernox force-pushed the add-valve-integration branch from 9916c29 to c89804a Compare October 25, 2023 21:15

Apply more feedback: Intruduce the bare minimum

187d737

cibernox added 4 commits October 25, 2023 22:01

Remove file commited by mistake

2efe5e4

Merge branch 'dev' into add-valve-integration

e5d9286

Hopefully this fixes tests

c667699

Merge branch 'add-valve-integration' of github.com:cibernox/core into…

374d20c

… add-valve-integration

Merge branch 'dev' into add-valve-integration

b8b7a16

Address review comments

977543c

emontnemery approved these changes Dec 12, 2023

View reviewed changes

MartinHjelmare reviewed Dec 12, 2023

View reviewed changes

tests/components/valve/test_init.py Outdated Show resolved Hide resolved

tests/components/valve/test_init.py Outdated Show resolved Hide resolved

Address review comments

7cf54e4

MartinHjelmare approved these changes Dec 12, 2023

View reviewed changes

piitaya mentioned this pull request Dec 12, 2023

Add valve entity home-assistant/frontend#19024

Merged

9 tasks

jbouwh mentioned this pull request Dec 14, 2023

Add MQTT valve platform #105766

Merged

20 tasks

MartinHjelmare requested changes Dec 16, 2023

View reviewed changes

homeassistant/components/valve/__init__.py Outdated Show resolved Hide resolved

home-assistant bot marked this pull request as draft December 16, 2023 11:56

Update homeassistant/components/valve/__init__.py

b7224b9

Co-authored-by: Martin Hjelmare <marhje52@gmail.com>

emontnemery marked this pull request as ready for review December 18, 2023 14:47

home-assistant bot requested review from MartinHjelmare and emontnemery December 18, 2023 14:47

jbouwh approved these changes Dec 18, 2023

View reviewed changes

MartinHjelmare reviewed Dec 18, 2023

View reviewed changes

tests/components/valve/test_init.py Outdated Show resolved Hide resolved

tests/components/valve/test_init.py Outdated Show resolved Hide resolved

Update tests

b506fc1

MartinHjelmare approved these changes Dec 18, 2023

View reviewed changes

emontnemery mentioned this pull request Dec 18, 2023

Add valve support to switch_as_x #105988

Merged

20 tasks

emontnemery closed this Dec 18, 2023

home-assistant bot removed the Hacktoberfest label Dec 18, 2023

emontnemery reopened this Dec 18, 2023

MartinHjelmare merged commit 5175737 into home-assistant:dev Dec 18, 2023
53 checks passed

github-actions bot locked and limited conversation to collaborators Dec 19, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Valve integration #102184

Add Valve integration #102184

cibernox commented Oct 17, 2023 •

edited by MartinHjelmare

cibernox commented Oct 17, 2023

home-assistant bot commented Oct 18, 2023

MartinHjelmare commented Oct 18, 2023

* [ERROR] [MANIFEST] Domain is missing an IoT Class

MartinHjelmare commented Oct 18, 2023

* [ERROR] [SERVICES] Invalid services.yaml: Unknown supported feature 'valve.ValveEntityFeature.CLOSE' @ data['close_valve']['target']['entity'][0]['supported_features'][0]. Got None

cibernox commented Oct 18, 2023

jbouwh commented Oct 25, 2023

cibernox commented Oct 25, 2023

jbouwh commented Oct 25, 2023

cibernox commented Oct 25, 2023

emontnemery left a comment

cibernox commented Dec 12, 2023

MartinHjelmare commented Dec 12, 2023

piitaya commented Dec 12, 2023

MartinHjelmare left a comment

piitaya commented Dec 18, 2023

frenck commented Dec 18, 2023

jbouwh left a comment

cibernox commented Dec 18, 2023

Add Valve integration #102184

Add Valve integration #102184

Conversation

cibernox commented Oct 17, 2023 • edited by MartinHjelmare

Proposed change

Type of change

Additional information

Checklist

cibernox commented Oct 17, 2023

* [ERROR] [MANIFEST] Domain is missing an IoT Class

* [ERROR] [SERVICES] Invalid services.yaml: Unknown supported feature 'valve.ValveEntityFeature.CLOSE' @ data['close_valve']['target']['entity'][0]['supported_features'][0]. Got None

home-assistant bot commented Oct 18, 2023

MartinHjelmare commented Oct 18, 2023

* [ERROR] [MANIFEST] Domain is missing an IoT Class

MartinHjelmare commented Oct 18, 2023

* [ERROR] [SERVICES] Invalid services.yaml: Unknown supported feature 'valve.ValveEntityFeature.CLOSE' @ data['close_valve']['target']['entity'][0]['supported_features'][0]. Got None

cibernox commented Oct 18, 2023

jbouwh commented Oct 25, 2023

cibernox commented Oct 25, 2023

jbouwh commented Oct 25, 2023

cibernox commented Oct 25, 2023

emontnemery left a comment

Choose a reason for hiding this comment

cibernox commented Dec 12, 2023

MartinHjelmare commented Dec 12, 2023

piitaya commented Dec 12, 2023

MartinHjelmare left a comment

Choose a reason for hiding this comment

piitaya commented Dec 18, 2023

frenck commented Dec 18, 2023

jbouwh left a comment

Choose a reason for hiding this comment

cibernox commented Dec 18, 2023

cibernox commented Oct 17, 2023 •

edited by MartinHjelmare