10000 Add YAML and discovery info export feature for MQTT device subentries by jbouwh · Pull Request #141896 · home-assistant/core · GitHub
[go: up one dir, main page]
Skip to content

Add YAML and discovery info export feature for MQTT device subentries #141896

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 19 commits into from
Jul 17, 2025
Merged

Add YAML and discovery info export feature for MQTT device subentries #141896

merged 19 commits into from
Jul 17, 2025

Conversation

jbouwh
Copy link
Contributor
@jbouwh jbouwh commented Mar 31, 2025 •
edited
Loading

Proposed change

Adds YAML and discovery info export and migration feature for MQTT device subentries.

Uses a normal TextSelector and TemplateSelector with read_only flag enabled for the export flow.
Suggestion is to use this as initial implemention and improve the selectors with copy buttons later.

The config export feature helps with trouble shooting the MQTT device subentry and allows to migrate the config to either a YAML based setup or a setup based on MQTT discovery. When the users copies the config, a repair flow is started to assist the user to remove the previous set up MQTT device subentry. The migrated device entities and registry entries will restore after the subentry is removed and the entity is added via the new route (restoring any user customization previous config of the removed device).

Screenshots

afbeelding
afbeelding

YAML export:
afbeelding

Repair flow after YAML config has been copied to remove the subentry and YAML config with the same device identifier has been detected:
afbeelding

The repair flow assists in removing the previous subentry or instructs to change the identifiers as an alternative:
afbeelding

Discovery export:
afbeelding

Repair flow after discovery with the same device identifier has been detected.
afbeelding
afbeelding
afbeelding

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:
  • Link to developer documentation pull request:
  • Link to frontend 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:

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:

@home-assistant
Copy link

Hey there @emontnemery, @bdraco, mind taking a look at this pull request as it has been labeled with an integration (mqtt) you are listed as a code owner for? Thanks!

Code owner commands

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

@jbouwh jbouwh force-pushed the mqtt-subentry-export branch 2 times, most recently from 1af3b60 to d3b845f Compare May 3, 2025 19:19
@jbouwh jbouwh force-pushed the mqtt-subentry-export branch from d3b845f to ec41abd Compare May 24, 2025 09:42
@jbouwh jbouwh marked this pull request as ready for review May 26, 2025 09:32
@jbouwh jbouwh requested review from emontnemery and bdraco as code owners May 26, 2025 09:32
emontnemery
emontnemery reviewed Jun 25, 2025
View reviewed changes
@jbouwh jbouwh marked this pull request as draft June 25, 2025 12:57
@jbouwh jbouwh force-pushed the mqtt-subentry-export branch from 8acd353 to 9747ebc Compare June 25, 2025 12:58
@jbouwh
Copy link
Contributor Author
jbouwh commented Jun 25, 2025

Drafting for now to allow a repair issue to remove the subentry in case an exported item was discovered or added in YAML.

@jbouwh jbouwh marked this pull request as ready for review July 7, 2025 06:32
@jbouwh
Copy link
Contributor Author
jbouwh commented Jul 10, 2025

@NoRi2909 May be you could have a look at the translation strings?

NoRi2909
NoRi2909 reviewed Jul 10, 2025
View reviewed changes
Copy link
Contributor
@NoRi2909 NoRi2909 left a comment

Choose a reason for hiding this comment

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

A few quick notes on the strings.

@jbouwh
Copy link
Contributor Author
jbouwh commented Jul 10, 2025

Thanks @NoRi2909 !

@jbouwh jbouwh force-pushed the mqtt-subentry-export branch from 73ff580 to e7c7c9e Compare July 14, 2025 21:47
NoRi2909
NoRi2909 reviewed Jul 15, 2025
View reviewed changes
NoRi2909
NoRi2909 reviewed Jul 16, 2025
View reviewed changes
@jbouwh @NoRi2909
Apply suggestions from code review
7a6d42e 
Co-authored-by: Norbert Rittel <norbert@rittel.de>
emontnemery
emontnemery reviewed Jul 17, 2025
View reviewed changes
emontnemery
emontnemery approved these changes Jul 17, 2025
View reviewed changes
Copy link
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.

Thanks, @jbouwh 👍

@jbouwh jbouwh merged commit 29afa89 into dev Jul 17, 2025
48 checks passed
@jbouwh jbouwh deleted the mqtt-subentry-export branch July 17, 2025 21:06
@github-actions github-actions bot locked and limited conversation to collaborators Jul 18, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@NoRi2909 NoRi2909 NoRi2909 approved these changes

@emontnemery emontnemery emontnemery approved these changes

@bdraco bdraco Awaiting requested review from bdraco bdraco is a code owner

Assignees

@bdraco bdraco

@emontnemery emontnemery

Labels
by-code-owner cla-signed core has-tests integration: mqtt new-feature Quality Scale: platinum
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@jbouwh @emontnemery @NoRi2909 @bdraco
0