Add zwave to ozw migration #39081

MartinHjelmare · 2020-08-20T13:39:16Z

Breaking change

Proposed change

Add ozw websocket command to do zwave to ozw migration.
Add zwave websocket command to start a ozw config flow at the import step with zwave config data.
When the migration is done:
- Entity ids, names and icons in the entity registry should be migrated.
- Device name_by_user and area_id in the device registry should be migrated.
- The zwave config entry should be removed.

TODO

Migrate device registry data.
Remove zwave config entry on migration completion.
Warn user if zwave present in configuration.yaml.
Fail zwave setup if migration is done and ozw is setup.
Create frontend part.

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)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Example entry for `configuration.yaml`:

# Example configuration.yaml

Additional information

This PR fixes or closes issue: fixes #
This PR is related to issue:
Link to documentation pull request: Add ozw to zwave migration section home-assistant.io#16135
Link to frontend pull request: Zwave -> OZW migration frontend#7765

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
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

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

The integration reached or maintains the following Integration Quality Scale:

No score or internal
🥈 Silver
🥇 Gold
🏆 Platinum

To help with the load of incoming pull requests:

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

probot-home-assistant · 2020-08-20T13:39:25Z

Hey there @home-assistant/z-wave, mind taking a look at this pull request as its been labeled with an integration (zwave) you are listed as a codeowner for? Thanks!
_{^{(message by CodeOwnersMention)}}

probot-home-assistant · 2020-08-20T13:39:27Z

Hey there @cgarwood, @marcelveldt, mind taking a look at this pull request as its been labeled with an integration (ozw) you are listed as a codeowner for? Thanks!
_{^{(message by CodeOwnersMention)}}

cgarwood · 2020-08-20T14:17:54Z

We'll also need to check if they have a zwave: section in configuration.yaml - as it will try to re-import that as a new config entry on the next HA restart

homeassistant/components/ozw/migration.py

homeassistant/components/ozw/websocket_api.py

tests/components/ozw/test_websocket_api.py

balloob · 2020-11-09T22:58:59Z

homeassistant/components/ozw/migration.py

+async def async_migrate(hass, migration_map):
+    """Perform zwave to ozw migration."""
+    dev_reg = await async_get_device_registry(hass)
+    for ozw_device_id, zwave_device_id in migration_map["device_entries"].items():


Why are we migrating info between devices instead of merging them ? A device can be linked to multiple integrations: https://developers.home-assistant.io/docs/device_registry_index

Calling dev_reg.async_get_or_create with identifiers of both devices will link them up. We find by identifier first, so you just call dev_reg.async_get_or_create with the Z-Wave device ID first, so it gets OZW one added. Then delete OZW device ID.

(this works too, so fine with it)

We'd have to look up the device identifiers first to do that, right? So it looks like the current way is easier.

Yeah, you will need to find both entries first anyway.

We should apply this suggestion to solve the migration of device actions etc.

We've decided to not add more to this migration, consider the recent move with zwave_js.

tests/components/ozw/test_websocket_api.py

homeassistant/components/ozw/websocket_api.py

MartinHjelmare · 2020-11-11T11:33:08Z

We'll wait to merge until we have confirmation from frontend that we have all that is needed in the backend.

CC @bramkragten

MartinHjelmare · 2020-12-07T12:19:44Z

I'll need to look into the meter and notification command class migration. It doesn't work consistently for all users.

Co-authored-by: Paulus Schoutsen <[email protected]>

* 'dev' of https://github.com/home-assistant/core: (98 commits) Bump pymyq to 2.0.13 (home-assistant#44961) Add zwave to ozw migration (home-assistant#39081) Add pressure forecast to HA weather entity model (home-assistant#44965) Deduplicate MQTT entity discovery code (home-assistant#44970) Fix parameters when toggling light (home-assistant#44950) Move MQTT entity helpers to separate file (home-assistant#44838) Helpers type hint improvements (home-assistant#44964) Remove script/test (home-assistant#44967) Add MQTT Number (non optimistic) (home-assistant#44883) Fix Netatmo climate boost for valves (home-assistant#44957) Disambiguate Supervisor HTTPUnauthorized on user/password validation (home-assistant#44940) Add torrent id to Transmission events (home-assistant#44187) Prefix versions in system health (home-assistant#44921) Fix media renderers without volume control (home-assistant#44874) Fix wait_template incorrectly matching falsey values (home-assistant#44938) Upgrade youtube_dl to 2021.01.03 (home-assistant#44942) Upgrade discord.py to 1.6.0 (home-assistant#44941) Fix KNX cover state return open when unknown (home-assistant#44926) Use parent_id to find cause of logbook events with new contexts (home-assistant#44416) Implement support for additional ecobee hold modes (home-assistant#40520) ...

sbruggeman · 2021-02-24T01:35:18Z

Is it possible that this PR is causing the behavior that is being seen in this issue? #46679

If so, I think this is an edge case where this is a breaking change for the zwave component.

frenck · 2021-02-24T01:36:26Z

@sbruggeman Please do not use handled PRs for handling issues. There is an issue, that is sufficient. Thanks 👍

probot-home-assistant bot added has-tests integration: ozw integration: zwave labels Aug 20, 2020

homeassistant added the cla-signed label Aug 20, 2020

probot-home-assistant bot assigned cgarwood Aug 20, 2020

probot-home-assistant bot added the by-code-owner label Aug 20, 2020

MartinHjelmare commented Aug 20, 2020

View reviewed changes

homeassistant/components/ozw/migration.py Outdated Show resolved Hide resolved

homeassistant/components/ozw/migration.py Outdated Show resolved Hide resolved

MartinHjelmare commented Aug 20, 2020

View reviewed changes

homeassistant/components/ozw/websocket_api.py Outdated Show resolved Hide resolved

MartinHjelmare force-pushed the add-ozw-migration branch from fb9ab0c to 3dfcd1d Compare August 30, 2020 18:58

MartinHjelmare commented Aug 30, 2020

View reviewed changes

tests/components/ozw/test_websocket_api.py Outdated Show resolved Hide resolved

MartinHjelmare marked this pull request as ready for review August 31, 2020 18:22

MartinHjelmare force-pushed the add-ozw-migration branch from bb3847f to 6ec340d Compare September 23, 2020 13:22

MartinHjelmare force-pushed the add-ozw-migration branch from dd8a9bf to 702489b Compare November 9, 2020 18:20

balloob reviewed Nov 9, 2020

View reviewed changes

tests/components/ozw/test_websocket_api.py Outdated Show resolved Hide resolved

MartinHjelmare force-pushed the add-ozw-migration branch from 197eaa2 to 9a5ba31 Compare November 11, 2020 07:36

balloob reviewed Nov 11, 2020

View reviewed changes

homeassistant/components/ozw/websocket_api.py Outdated Show resolved Hide resolved

balloob approved these changes Nov 11, 2020

View reviewed changes

MartinHjelmare marked this pull request as draft November 11, 2020 11:32

MartinHjelmare force-pushed the add-ozw-migration branch from e02de06 to 4f9760a Compare November 21, 2020 16:14

bramkragten mentioned this pull request Nov 21, 2020

Zwave -> OZW migration home-assistant/frontend#7765

Merged

10 tasks

MartinHjelmare added 4 commits January 6, 2021 20:28

Add zwave data migration function

ce9a885

Add ozw migration service

d30acbe

Add command class label to data

0996678

Add value index to zwave migration data

43345a2

MartinHjelmare and others added 16 commits January 6, 2021 20:38

Remove zwave config entry on migration completion

a74d05f

Clean up

79a550a

Add warning if zwave has config yaml section

afd1d0b

Fail zwave entry setup if migration is done and ozw is setup

9027163

Clarify warning

dc236da

Check device id migration map

2aee671

Add import step

0483ddd

Add zwave websocket command to start ozw flow

95d9ad5

Add test for zwave websocket import flow

6d9cc9a

Add ozw to zwave after deps

46d7fda

Fix isort

1a14382

Fix index access after library bump

2140f84

Move ozw migration tests to own module

463ae65

Drop coerce to bool

0b06ef9

Co-authored-by: Paulus Schoutsen <[email protected]>

pass node instead of id

39262af

Check migrated entities have the same domain

0a65868

MartinHjelmare force-pushed the add-ozw-migration branch from 4f9760a to 0a65868 Compare January 6, 2021 19:48

Fix mock imports

b1e2c0f

MartinHjelmare marked this pull request as ready for review January 7, 2021 16:12

MartinHjelmare added the docs-missing label Jan 8, 2021

MartinHjelmare mentioned this pull request Jan 9, 2021

Add ozw to zwave migration section home-assistant/home-assistant.io#16135

Merged

8 tasks

MartinHjelmare added docs-missing and removed docs-missing labels Jan 9, 2021

MartinHjelmare merged commit 8b72324 into dev Jan 9, 2021

MartinHjelmare deleted the add-ozw-migration branch January 9, 2021 14:23

home-assistant locked and limited conversation to collaborators Feb 24, 2021

Uh oh!

Add zwave to ozw migration #39081

Add zwave to ozw migration #39081

Uh oh!

Conversation

MartinHjelmare commented Aug 20, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Breaking change

Proposed change

TODO

Type of change

Example entry for configuration.yaml:

Additional information

Checklist

Uh oh!

probot-home-assistant bot commented Aug 20, 2020

Uh oh!

probot-home-assistant bot commented Aug 20, 2020

Uh oh!

cgarwood commented Aug 20, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

balloob Nov 9, 2020

Choose a reason for hiding this comment

Uh oh!

balloob Nov 9, 2020

Choose a reason for hiding this comment

Uh oh!

MartinHjelmare Nov 10, 2020

Choose a reason for hiding this comment

Uh oh!

balloob Nov 10, 2020

Choose a reason for hiding this comment

Uh oh!

MartinHjelmare Dec 7, 2020

Choose a reason for hiding this comment

Uh oh!

MartinHjelmare Jan 6, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

MartinHjelmare commented Nov 11, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MartinHjelmare commented Dec 7, 2020

Uh oh!

sbruggeman commented Feb 24, 2021

Uh oh!

frenck commented Feb 24, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

MartinHjelmare commented Aug 20, 2020 •

edited

Loading

Example entry for `configuration.yaml`:

MartinHjelmare commented Nov 11, 2020 •

edited

Loading