Add device based MQTT auto discovery

[jbouwh]

Proposed change

Add device based MQTT auto discovery.

This is de docs PR for the reworked and reverted PR https://github.com/home-assistant/core/pull/109030

Type of change

• [ ] Spelling, grammar or other readability improvements (current branch).
• [ ] Adjusted missing or incorrect information in the current documentation (current branch).
• [ ] Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • [ ] I've opened up a PR to add logo's and icons in Brands repository.
• [x] Added documentation for a new feature I'm adding to Home Assistant (next branch).
• [ ] Removed stale or deprecated documentation.

Additional information

• Link to parent pull request in the codebase: https://github.com/home-assistant/core/pull/118757
• Link to parent pull request in the Brands repository:
• This PR fixes or closes issue: fixes #

Checklist

• [x] This PR uses the correct branch, based on one of the following:
  • I made a change to the existing documentation and used the current branch.
  • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
• [x] The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

• Documentation
  • Updated MQTT integration documentation to include a new required field platform for each integration.
  • Clarified the unique_id field's requirements for device-based discovery.
  • Introduced a new section on Device discovery payload detailing the structure and requirements for device discovery.
  • Added a section on Supported abbreviations in MQTT discovery messages to optimize payload size.
  • Expanded the section on availability topics to explain device announcements and retained messages.
  • Added a new section on Adding information about the origin of a discovery message.
  • Provided Discovery examples with component discovery for setting up various MQTT components.
  • Updated examples throughout the documentation for consistency and clarity.

[netlify[bot]]

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	8797bd61bde3f4723566e8d955d731f0bc67ad7c
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/67224febe4632900088b5647
😎 Deploy Preview	https://deploy-preview-33072--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[home-assistant[bot]]

Hey there @emontnemery, @bdraco, mind taking a look at this feedback 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 feedback.
• @home-assistant rename Awesome new title Renames the feedback.
• @home-assistant reopen Reopen the feedback.
• @home-assistant unassign mqtt Removes the current integration label and assignees on the feedback, add the integration domain after the command.
• @home-assistant add-label needs-more-information Add a label (needs-more-information) to the feedback.
• @home-assistant remove-label needs-more-information Remove a label (needs-more-information) on the feedback.

[coderabbitai[bot]]

📝 Walkthrough

📝 Walkthrough

Walkthrough

The MQTT integration documentation for Home Assistant has been updated to improve clarity and detail regarding configuration and device discovery processes. New sections have been added, including Device discovery payload, which outlines the structure and requirements for discovery payloads, and Adding information about the origin of a discovery message, which details how to include origin information in the payload. Additional emphasis is placed on the importance of unique identifiers for devices and components, along with expanded guidance on naming MQTT entities.

Changes

File Path	Change Summary
source/_integrations/mqtt.markdown	Added sections on device discovery payload, origin information, and discovery examples; clarified unique identifiers and naming conventions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant MQTT Broker
    participant Home Assistant

    User->>Home Assistant: Configure MQTT integration
    Home Assistant->>MQTT Broker: Send discovery payload with device info
    MQTT Broker-->>Home Assistant: Acknowledge device discovery
    Home Assistant->>User: Integration configured successfully

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[jbouwh]

Hej, you didn't leave anything for me to nit-pick on. 😆 Thank you, @jbouwh 👍

I guess @coderrabbitai challenged me, and caused some concurrency. Thanks 😊 👍