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.

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

Draft
wants to merge 11 commits into
base: dev
Choose a base branch
from

Conversation

jbouwh
Copy link
Contributor

@jbouwh jbouwh commented Mar 31, 2025

Proposed change

Add YAML and discovery info export feature for MQTT device subentries.

Optional refactoring after implementation of: home-assistant/architecture#1215
The current implementation uses normal a normal TextSelector and TemplateSelector with read_only flag enabled.
Suggestion is to use this as initial implemention and improve the selectors with copy buttons as soon as the frontend is ready to support this.

afbeelding![image]
image

YAML export:
afbeelding

Discovery export:
afbeelding

This allows users to move their MQTT subentries to a YAML or discovery based setup and enables to share the active config for diagnostic purposes.

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
},
"export": {
"title": "Export MQTT device config",
"description": "An export allows you set up the MQTT Device configuration via YAMl or MQTT discovery. The configuration can also be helpful for troubleshooting. The export includes the unique ID's used in the configuration. You cannot activate this configuration unless you remove the MQTT-device or change the unique id's. Removing the MQTT device subentry will also remove the device from the device registry. After removing the MQTT device subentry, it can be set up via YAML or discovery with the same unique ID's.",
Copy link
Contributor

Choose a reason for hiding this comment

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

It's not clear to me as a user what exactly I need to change.

Also, if I don't change it, how am I notified? Does the MQTT integration catch the duplicates, or will I get some cryptic error message about Platform mqtt does not generate unique IDs.?

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants