Skip to content

Add button as entity platform for MQTT subentries #38902

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
May 6, 2025
Merged

Add button as entity platform for MQTT subentries #38902

merged 1 commit into from
May 6, 2025

Conversation

jbouwh
Copy link
Contributor

@jbouwh jbouwh commented May 6, 2025 •
edited by coderabbitai bot
Loading

Proposed change

Add button as entity platform for MQTT subentries

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 MQTT integration documentation to include the Button component as configurable via Subentries, with a link to its MQTT integration details.

@jbouwh jbouwh requested review from emontnemery and bdraco as code owners May 6, 2025 09:39
@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 May 6, 2025
@netlify Netlify
Copy link

netlify bot commented May 6, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit d2ac01d
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6819d8b9c9eb3f0008702a60
😎 Deploy Preview https://deploy-preview-38902--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.

@jbouwh jbouwh mentioned this pull request May 6, 2025
Merged
19 tasks
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented May 6, 2025

📝 Walkthrough

Walkthrough

The documentation for the MQTT integration was updated to add the "Button" component to the list of MQTT components that can be configured via Subentries. This change is limited to documentation and does not affect any code or control flow.

Changes

File(s) Change Summary
source/_integrations/mqtt.markdown Updated Subentries section to include "Button" as a supported MQTT component with a doc link.

Sequence Diagram(s)

No sequence diagram is provided as the changes are limited to documentation updates.

📜 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 aab1273 and d2ac01d.

📒 Files selected for processing (1)
  • source/_integrations/mqtt.markdown (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (4)
source/_integrations/mqtt.markdown (4)

16-20: Button platform added to ha_platforms frontmatter

Good catch adding button to the list of supported platforms. The entry is placed alphabetically between binary_sensor and camera, and matches the lowercase domain naming convention.

59-63: Include Button in MQTT discovery components

The [Button](/integrations/button.mqtt/) link is correctly inserted in the "Configuration via MQTT discovery" section and follows the alphabetical ordering.

93-97: Include Button in YAML configuration list

The [Button](/integrations/button.mqtt/) entry is properly added to the "Configuration via YAML" section in the right position.

125-129: Add Button to Subentries documentation

The - [Button](/integrations/button.mqtt/) item is now included under "Configuration via Subentries" in the expected alphabetical spot.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

c0ffeeca7
c0ffeeca7 approved these changes May 6, 2025
View reviewed changes
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.

Thank you, @jbouwh 👍

@c0ffeeca7 c0ffeeca7 added the awaits-parent Awaits the merge of an parent PR label May 6, 2025
@home-assistant home-assistant bot added the parent-merged The parent PR has been merged already label May 6, 2025
@jbouwh jbouwh merged commit 54c58f4 into next May 6, 2025
9 checks passed
@home-assistant home-assistant bot removed awaits-parent Awaits the merge of an parent PR parent-merged The parent PR has been merged already labels May 6, 2025
@jbouwh jbouwh deleted the mqtt-subentry-button branch May 6, 2025 11:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@c0ffeeca7 c0ffeeca7 c0ffeeca7 approved these changes

@emontnemery emontnemery Awaiting requested review from emontnemery emontnemery is a code owner

@bdraco bdraco Awaiting requested review from bdraco bdraco is a code owner

Assignees
No one assigned
Labels
has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jbouwh @c0ffeeca7