Migrate cover platform to entity descriptions in Overkiz by iMicknl · Pull Request #141330 · home-assistant/core

iMicknl · 2025-03-24T22:54:12Z

Proposed change

Rewrite the current Overkiz platform to leverage entity descriptions. This will remove the additional classes and make it easier to support new covers and add exceptions.

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

This PR fixes or closes issue: fixes Implement lower/upper cover controls for PositionableDualRollerShutter in Overkiz #140865, fixes Missing tilt functionality for UpDownExteriorVenetianBlind (rts:ExteriorVenetianBlindRTSComponent) in Overkiz #106708, fixes Somfy Smoove Uno A/M io reporting wrong status and not controllable in Overkiz #134407
This PR is related to issue:
Link to documentation pull request:

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:

Documentation added/updated for www.home-assistant.io

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:

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

everharder · 2025-05-26T07:33:44Z

Hi @iMicknl,
I'm dying to get the tilt functionality for the integration.
I would love if you could merge this soon!
Thank you for your work.

iMicknl · 2025-05-26T12:32:33Z

@everharder have you tried this PR and does it work for you? What is your device? (Hardware name and model name in Home Assistant).

Don't expect this PR anytime soon, as it is not ready yet, and will require a lot of testing. Currently I don't have time the coming month(s).

everharder · 2025-05-27T09:37:22Z

@iMicknl It does work when setting the value to the cover entity via this control.

But, I can't add this to the dashboard. I can only add this (but it might be my fault, I'm very new to HA):

This is the device I am using:

PositionableExteriorVenetianBlind
by Somfy
Connected via [TaHoma Switch](http://localhost:8123/config/devices/device/abda62fad4b33e3b054144174b156510)
Firmware: 5162904A04
Hardware: io:ExteriorVenetianBlindIOComponent

iMicknl · 2025-05-27T09:39:49Z

Ok great! Your dashboard is another discussion (and having this PR merged won't change a thing. Best to seek support at the community forum or Discord.

Hint in the right direction; you should edit the card and enable the tilt controls there.

github-actions · 2025-07-26T10:06:08Z

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
If you are the author of this PR, please leave a comment if you want to keep it open. Also, please rebase your PR onto the latest dev branch to ensure that it's up to date with the latest changes.
Thank you for your contribution!

MarijnS95 · 2025-11-15T10:26:40Z

No regressions are noticed with this PR after following up on the testing request in #96665 (comment). The various inversions that I reported in #123810 and started testing this for still seem to be present and may be outside of Overkiz' control?

I've summarized them in home-assistant/frontend#25481 (comment).

github-actions · 2026-01-14T11:08:03Z

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
If you are the author of this PR, please leave a comment if you want to keep it open. Also, please rebase your PR onto the latest dev branch to ensure that it's up to date with the latest changes.
Thank you for your contribution!

…losed_state attribute

…djust current_tilt_position in snapshots

Copilot

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.

… moving

Copilot

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

…ver entity

… snapshots for current_position values

Copilot

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

…atures in test snapshots

…cover entity

…to 'open'

Copilot

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

joostlek · 2026-04-21T12:38:54Z

Are the changes in the snapshot expected?

Yes!

DualRollerShutter now has upper and lower closure implemented (hence moving supported features value 15 -> 255) and adding tilt_position field

The values of -8 and -24 is an API bug, which we now handle in our integration and map to the right value.

joostlek · 2026-04-21T12:40:03Z

+        if self.entity_description.open_command and self.executor.has_command(
+            self.entity_description.open_command
+        ):
+            supported_features |= CoverEntityFeature.OPEN
+
+            if self.entity_description.stop_command and self.executor.has_command(
+                self.entity_description.stop_command
+            ):
+                supported_features |= CoverEntityFeature.STOP
+
+        if self.entity_description.close_command and self.executor.has_command(
+            self.entity_description.close_command
+        ):
+            supported_features |= CoverEntityFeature.CLOSE
+
+        if self.entity_description.open_tilt_command and self.executor.has_command(
+            self.entity_description.open_tilt_command
+        ):
+            supported_features |= CoverEntityFeature.OPEN_TILT
+
+            if self.entity_description.stop_tilt_command and self.executor.has_command(
+                self.entity_description.stop_tilt_command
+            ):
+                supported_features |= CoverEntityFeature.STOP_TILT
+
+        if self.entity_description.close_tilt_command and self.executor.has_command(
+            self.entity_description.close_tilt_command
+        ):
+            supported_features |= CoverEntityFeature.CLOSE_TILT
+
+        if (
+            self.entity_description.set_tilt_position_command
+            and self.executor.has_command(
+                self.entity_description.set_tilt_position_command
+            )
+        ):
+            supported_features |= CoverEntityFeature.SET_TILT_POSITION
+
+        if self.entity_description.set_position_command and self.executor.has_command(
+            self.entity_description.set_position_command
+        ):
+            supported_features |= CoverEntityFeature.SET_POSITION


I think you could even make this a for loop

Let me check. The challenge here is that some if statements are nested (mainly the stop commands).

# (entity description attribute, feature flag, required feature or None) _COMMAND_TO_FEATURE: list[tuple[str, CoverEntityFeature, CoverEntityFeature | None]] = [ ("open_command", CoverEntityFeature.OPEN, None), ("stop_command", CoverEntityFeature.STOP, CoverEntityFeature.OPEN), ("close_command", CoverEntityFeature.CLOSE, None), ("open_tilt_command", CoverEntityFeature.OPEN_TILT, None), ("stop_tilt_command", CoverEntityFeature.STOP_TILT, CoverEntityFeature.OPEN_TILT), ("close_tilt_command", CoverEntityFeature.CLOSE_TILT, None), ("set_tilt_position_command", CoverEntityFeature.SET_TILT_POSITION, None), ("set_position_command", CoverEntityFeature.SET_POSITION, None), ] supported_features = CoverEntityFeature(0) for attr, feature, requires in _COMMAND_TO_FEATURE: if (command := getattr(self.entity_description, attr)) and self.executor.has_command(command): if requires is None or requires in supported_features: supported_features |= feature

I am not sure if I prefer a loop here, what do you think @joostlek. This makes it less readable in my opinion, but happy to change it to the loop if this is what you prefer.

Oh the nested part didn't occur to me, then the old situation is likely better

home-assistant Bot added cla-signed code-quality integration: overkiz new-platform remove-platform by-code-owner Quality Scale: No score labels Mar 24, 2025

iMicknl removed new-platform remove-platform labels Mar 24, 2025

iMicknl force-pushed the overkiz/cover_entity_description branch from 7207777 to f8fcff4 Compare March 25, 2025 11:39

iMicknl force-pushed the overkiz/cover_entity_description branch from f8fcff4 to 9debd7e Compare April 17, 2025 21:09

iMicknl mentioned this pull request Apr 17, 2025

Missing tilt functionality for UpDownExteriorVenetianBlind (rts:ExteriorVenetianBlindRTSComponent) in Overkiz #106708

Closed

iMicknl mentioned this pull request Jul 15, 2025

Open/close command inverted for PergolaHorizontalAwningUno in Overkiz #96665

Closed

github-actions Bot added the stale label Jul 26, 2025

github-actions Bot closed this Aug 2, 2025

github-actions Bot locked and limited conversation to collaborators Aug 3, 2025

iMicknl reopened this Aug 5, 2025

home-assistant unlocked this conversation Oct 15, 2025

github-actions Bot removed the stale label Oct 15, 2025

MarijnS95 mentioned this pull request Nov 15, 2025

UX / Awning display should be a reversed cover home-assistant/frontend#25481

Open

4 tasks

iMicknl added 2 commits April 21, 2026 07:42

Fix regression

28d66a4

Refactor Overkiz cover entity to replace is_closed function with is_c…

ac72bbc

…losed_state attribute

Copilot AI review requested due to automatic review settings April 21, 2026 07:55

Copilot started reviewing on behalf of iMicknl April 21, 2026 07:55 View session

Update Overkiz cover entity to set invert_tilt_position to True and a…

548f275

…djust current_tilt_position in snapshots

Copilot AI reviewed Apr 21, 2026

View reviewed changes

Comment thread homeassistant/components/overkiz/cover.py Outdated

Comment thread homeassistant/components/overkiz/cover.py

Comment thread homeassistant/components/overkiz/cover.py

iMicknl added 3 commits April 21, 2026 08:19

Sort UIClass alphabetically

be812bb

Refactor Overkiz cover entity to use tuples for tilt command arguments

595d2e4

Add moving_offset property to OverkizCover to return offset only when…

b80c627

… moving

iMicknl marked this pull request as ready for review April 21, 2026 08:38

Copilot AI review requested due to automatic review settings April 21, 2026 08:38

Copilot started reviewing on behalf of iMicknl April 21, 2026 08:39 View session

Copilot AI reviewed Apr 21, 2026

View reviewed changes

Comment thread homeassistant/components/overkiz/cover.py Outdated

Comment thread homeassistant/components/overkiz/cover.py

iMicknl added 3 commits April 21, 2026 08:59

Add tests for handling moving offset and closure states in Overkiz co…

b4d4905

…ver entity

Add missing UIWidget

019bcaa

Remove invert_position from Overkiz cover description and update test…

7770436

… snapshots for current_position values

Copilot AI review requested due to automatic review settings April 21, 2026 09:10

Copilot started reviewing on behalf of iMicknl April 21, 2026 09:11 View session

Copilot AI reviewed Apr 21, 2026

View reviewed changes

Comment thread homeassistant/components/overkiz/cover.py

Comment thread homeassistant/components/overkiz/cover.py Outdated

iMicknl added 3 commits April 21, 2026 09:39

Add stop command to Overkiz cover description and update supported fe…

fba3fe8

…atures in test snapshots

Fix moving_offset property to handle None state correctly in Overkiz …

44f5980

…cover entity

Update cover entity snapshots to reflect state change from 'opening' …

524d76b

…to 'open'

Copilot AI review requested due to automatic review settings April 21, 2026 11:02

Copilot started reviewing on behalf of iMicknl April 21, 2026 11:03 View session

Copilot AI reviewed Apr 21, 2026

View reviewed changes

Comment thread tests/components/overkiz/test_cover.py

joostlek reviewed Apr 21, 2026

View reviewed changes

Merge branch 'dev' into overkiz/cover_entity_description

e607058

joostlek approved these changes Apr 23, 2026

View reviewed changes

joostlek merged commit 13105bd into home-assistant:dev Apr 23, 2026
33 checks passed

github-actions Bot locked and limited conversation to collaborators Apr 24, 2026

Uh oh!

Conversation

iMicknl commented Mar 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Checklist

Uh oh!

everharder commented May 26, 2025

Uh oh!

iMicknl commented May 26, 2025

Uh oh!

everharder commented May 27, 2025

Uh oh!

iMicknl commented May 27, 2025

Uh oh!

github-actions Bot commented Jul 26, 2025

Uh oh!

MarijnS95 commented Nov 15, 2025

Uh oh!

github-actions Bot commented Jan 14, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

joostlek Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

iMicknl Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

joostlek Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

iMicknl Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

iMicknl Apr 23, 2026

Choose a reason for hiding this comment

Uh oh!

joostlek Apr 23, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

iMicknl commented Mar 24, 2025 •

edited

Loading