Introduce ZHA entities unique id migration support.

[mrrstux]

Breaking change

No.

Proposed change

Entities that have a "previous_unique_id" would be migrated from previous_unique_id to unique_id.

Related to: zigpy/zha#328

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 #
• 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.

To help with the load of incoming pull requests:

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

[home-assistant]

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

Code owner commands

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

[TheJulianJES]

This is interesting! I've actually wanted to look at this in the future, and potentially also add support for it via quirks v2.
We'd also need some tests.

With zigpy/zha#362 and zigpy/zigpy#1541, you can also change the unique_id_suffix from quirks v2, so you should already be able to replace v1/ZHA entities from quirks v2 (if they're removed from ZHA).
With zigpy/zha#365, we should also be able to disable discovery for (default) ZHA entities to replace them with device-specific quirks v2 entities in the future.

We also have this old section in ZHA:
https://github.com/zigpy/zha/blob/8fd7bc522f9820e427f57ca01a4c8764ff963888/zha/application/discovery.py#L564-L579
The well-known device type stuff can most likely be removed, but the unique ids do not contain the cluster id. So we'd also have to migrate them eventually to remove the well-known device part, as we'd break all existing entities otherwise.

[mrrstux]

The support is general and allowing replace of default entities from v2 quirks is just a side effect.

Adding the cluster id in all unique ids is included here.