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 initial support for MQTT subentries with notify platform support #37473

Open
wants to merge 5 commits into
base: next
Choose a base branch
from

Conversation

jbouwh
Copy link
Contributor

@jbouwh jbouwh commented Feb 14, 2025

Proposed change

Add initial support for MQTT subentries.

The initial support allows to set up a MQTT Device with Notify entities.

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).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

Checklist

  • 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.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • Documentation
    • Updated and expanded content for MQTT integrations.
    • Introduced guidance for adding MQTT devices via a subentry approach.
    • Provided structured steps for configuring MQTT components.
    • Added instructions for manual configuration of MQTT Notify items.
    • Maintained existing information on MQTT integration removal for reference.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Feb 14, 2025
@jbouwh jbouwh changed the title Add initial support for MQTT subentries with notify platform Add initial support for MQTT subentries with notify platform support Feb 14, 2025
Copy link

netlify bot commented Feb 14, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 5b9e43c
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/67b2e1d8188dd40008d500db
😎 Deploy Preview https://deploy-preview-37473--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link
Contributor

coderabbitai bot commented Feb 14, 2025

📝 Walkthrough

Walkthrough

The documentation for the MQTT integration has been updated. The changes include the removal of the section detailing the steps to remove the MQTT integration, replaced by a concise statement indicating that MQTT devices and entities can now be set up through MQTT discovery or manual addition via YAML or subentries. New sections have been added to explain configuring MQTT components via subentries and manual configuration for MQTT Notify entities, with examples provided for clarity.

Changes

File Change Summary
source/_integrations/mqtt.markdown - Removed section on removing the MQTT integration.
- Added new section: "Configuration of MQTT components via Subentries".
- Added new section: "Manual configured MQTT items".
- Updated content to streamline device addition and configuration processes.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant UI as MQTT Integration UI
    participant DOC as Documentation
    U->>UI: Navigate to MQTT Integration Settings
    UI-->>U: Display current settings and options
    U->>UI: Select "Add Device via Subentries"
    UI-->>U: Present device configuration form
    U->>UI: Submit new device details
    UI-->>U: Confirm device addition
Loading
sequenceDiagram
    participant U as User
    participant YAML as configuration.yaml
    participant M as MQTT Integration Service
    U->>YAML: Update file with MQTT Notify entity details
    U->>M: Trigger configuration reload/restart
    M-->>U: Activate updated MQTT configuration
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8a5510e and 5b9e43c.

📒 Files selected for processing (1)
  • source/_integrations/mqtt.markdown (5 hunks)
🔇 Additional comments (5)
source/_integrations/mqtt.markdown (5)

54-54: Typographical Consistency for Discovery Link
The text “MQTT -discovery” contains an extraneous hyphen. For clarity and consistency with other sections, consider revising it to “MQTT discovery” (and remove the hyphen).
[nitpick, refactor_suggestion_good_to_have]


122-123: New Subentries Section Introduction
The introduction of the “Configuration of MQTT components via Subentries” section is a strong addition that aligns with the PR’s goal of extending MQTT support to include Notify entities. The use of an anchor and details block aids in navigation. Please verify that the heading style and naming are consistent with related sections (e.g., YAML or MQTT discovery).


125-125: Include Notify in Subentries
Listing the “Notify” platform in this new subentries section appropriately highlights the newly added support for MQTT Notify entities. This addition directly addresses part of the PR objective.


1379-1380: Clarification on Manual Configured MQTT Items
The new note—“Support to add manual items is added for the MQTT Notify entities, other platforms will follow later.”—effectively communicates the current scope of manual configuration. Consider rephrasing for improved clarity, for example:

-Support to add manual items is added for the MQTT Notify entities, other platforms will follow later.
+Support for manually adding MQTT Notify entities has been introduced; support for additional platforms will follow later.

[nitpick, refactor_suggestion_good_to_have]


1593-1601: Integration Removal Instructions Update
The updated “Removing the integration” section—leveraging the include file for removal steps and providing a clear note that the MQTT broker and its data are preserved—is well structured. Please ensure that the formatting and instructional style remain consistent with similar sections in the documentation.
[approved, refactor_suggestion_good_to_have]


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
🪧 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (2)
source/_integrations/mqtt.markdown (2)

1394-1396: Notify Entity Manual Configuration Note
The documentation now includes a note that manual configuration support has been added for MQTT Notify entities (with other platforms to follow). Consider rephrasing for clarity, for example:

“Manual configuration support for MQTT Notify entities has been added. Support for other platforms will follow.”


137-137: Remove Extra Blank Line
Static analysis indicates that there are multiple consecutive blank lines here. Please remove the extra blank line to adhere to markdown style guidelines and improve readability.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

137-137: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 062b0ef and 8a5510e.

📒 Files selected for processing (1)
  • source/_integrations/mqtt.markdown (4 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/mqtt.markdown

137-137: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)

🪛 LanguageTool
source/_integrations/mqtt.markdown

[grammar] ~184-~184: The modal verb ‘can’ requires the verb’s base form.
Context: ...e reconfigured. Additional entities can added, or an entity can bve removed from the ...

(MD_BASEFORM)

🔇 Additional comments (2)
source/_integrations/mqtt.markdown (2)

54-54: New MQTT Devices Setup Note
The added sentence now informs users that MQTT devices and entities can be set up either via MQTT discovery or manually through YAML/subentries. This aligns with the PR’s objective by highlighting the new support for MQTT subentries.


122-127: Introduction of the MQTT Subentries Section
This new section clearly introduces the configuration of MQTT components via subentries and currently lists the Notify integration. This is a good first step toward supporting subentries for MQTT devices—in line with the PR’s goals.

@home-assistant home-assistant bot marked this pull request as draft February 17, 2025 05:22
@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 marked this pull request as ready for review February 17, 2025 07:14
@home-assistant home-assistant bot requested a review from c0ffeeca7 February 17, 2025 07:14
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

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

NIce! Thank you, @jbouwh 👍

@c0ffeeca7 c0ffeeca7 added the awaits-parent Awaits the merge of an parent PR label Feb 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaits-parent Awaits the merge of an parent PR has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants