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

Add origin info support for MQTT discovered items #98782

Merged
merged 5 commits into from Aug 24, 2023

Conversation

jbouwh
Copy link
Contributor

@jbouwh jbouwh commented Aug 21, 2023

Proposed change

Make it possible to define the source of MQTT discovery messages via a new optional dict origin. This will be logged when an MQTT entity or other component is first added and when the configuration is changed.

Examples

Assuming we want to discover a sensor entity and we publish a config payload to homeassistant/sensor/bla/config.
Example of a configuration payload without integration info:

{ "name": "Milk", "state_topic": "test-topic" } 

... would log: Found new component: sensor bla

With minimal integration info:

{ "name": "Beer", "state_topic": "test-topic", "o": {"name": "bla2mqtt" } }

... would log: Found new component: sensor bla from from external application bla2mqtt

Additional software version and a support URL can be supplied:

{ "name": "Milk", "state_topic": "test-topic", "o": {"name": "bla2mqtt", "sw": "1.1", "url": "https://bla2mqtt.example.com/support" } }

... would log: Found new component: sensor bla from external application bla2mqtt, version: 1.1, support URL: https://bla2mqtt.example.com/support

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

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

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

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.

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.

This looks very good, some comments though

homeassistant/components/mqtt/mixins.py Outdated Show resolved Hide resolved
homeassistant/components/mqtt/mixins.py Outdated Show resolved Hide resolved
homeassistant/components/mqtt/mixins.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft August 22, 2023 06:15
@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@jbouwh jbouwh changed the title Add integration info support for MQTT discovered entities Add origin info support for MQTT discovered entities Aug 22, 2023
@jbouwh jbouwh changed the title Add origin info support for MQTT discovered entities Add origin info support for MQTT discovered items Aug 22, 2023
@jbouwh jbouwh marked this pull request as ready for review August 22, 2023 09:37
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.

Looks great, but we should adapt names in the code

homeassistant/components/mqtt/discovery.py Outdated Show resolved Hide resolved
homeassistant/components/mqtt/discovery.py Outdated Show resolved Hide resolved
homeassistant/components/mqtt/discovery.py Outdated Show resolved Hide resolved
homeassistant/components/mqtt/discovery.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft August 23, 2023 06:50
@jbouwh jbouwh marked this pull request as ready for review August 23, 2023 07:14
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.

Nice, thanks @jbouwh 👍

@jbouwh jbouwh merged commit 8b23204 into home-assistant:dev Aug 24, 2023
34 checks passed
@jbouwh jbouwh deleted the mqtt-integration-details branch August 24, 2023 07:50
@github-actions github-actions bot locked and limited conversation to collaborators Aug 25, 2023
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

2 participants