Skip to content
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

Remove naming warnings and work-a-rounds for incorrectly configured MQTT entities #107188

Merged
merged 2 commits into from
Jan 5, 2024

Conversation

jbouwh
Copy link
Contributor

@jbouwh jbouwh commented Jan 4, 2024

Breaking change

When an MQTT entity has a device name that is equal to the entity name, or starts with the device name, this will no longer be corrected. When entities like these are created they will have both device and entity name in the friendly name. If the device name is to be omitted because it is the same as the entity name, then the entity name attribute sould be set to null in the JSON payload or YAML config.

Related blogpost: https://developers.home-assistant.io/blog/2023/07/21/change-naming-mqtt-entities

Proposed change

Remove work-arounds, warnings and issue registrations for temporary fixing naming issues with MQTT entities.

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:

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:

@home-assistant
Copy link

home-assistant bot commented Jan 4, 2024

Hey there @emontnemery, 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.

@hmmbob
Copy link
Contributor

hmmbob commented Jan 5, 2024

The link to the blogpost doesn't work anymore 🤔

@emontnemery
Copy link
Contributor

The link to the blogpost doesn't work anymore 🤔

It didn't work because we don't have 57 months. I edited the link :)

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 👍

@emontnemery
Copy link
Contributor

CI failures are not related to this PR.

@emontnemery emontnemery merged commit f0ec123 into dev Jan 5, 2024
47 of 49 checks passed
@emontnemery emontnemery deleted the mqtt-remove-entity-naming-warning branch January 5, 2024 08:32
@jbouwh
Copy link
Contributor Author

jbouwh commented Jan 5, 2024

The link to the blogpost doesn't work anymore 🤔

Link was updated

@github-actions github-actions bot locked and limited conversation to collaborators Jan 6, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants