Skip to content

Explicitly document ESPHome options flow #38622

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
Apr 18, 2025
Merged

Explicitly document ESPHome options flow #38622

merged 1 commit into from
Apr 18, 2025

Conversation

bdraco
Copy link
Member

@bdraco bdraco commented Apr 18, 2025 •
edited by coderabbitai bot
Loading

Proposed change

Explicitly document ESPHome options flow

While all the options are already mentioned, add the summary as well.

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

  • Link to parent pull request in the codebase:
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue: fixes #

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
    • Added details about two optional ESPHome integration settings: enabling device-initiated Home Assistant actions and subscribing to device logs. Descriptions clarify their default disabled state and recommend enabling only for trusted devices.

@home-assistant home-assistant bot added the current This PR goes into the current branch label Apr 18, 2025
@bdraco bdraco mentioned this pull request Apr 18, 2025
Merged
43 tasks
@netlify Netlify
Copy link

netlify bot commented Apr 18, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 758c643
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/68020ef2424d690008725649
😎 Deploy Preview https://deploy-preview-38622--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.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 18, 2025

📝 Walkthrough

Walkthrough

The documentation for the ESPHome integration was updated to include a new section outlining two optional configuration options. These options allow users to enable the device to perform Home Assistant actions and to subscribe to device logs for viewing within Home Assistant. The documentation specifies that both options are disabled by default and should only be enabled if necessary and the device is trusted. No changes were made to code or exported/public entities.

Changes

File Change Summary
source/_integrations/esphome.markdown Added documentation for two optional configuration options: enabling device actions and log subscriptions.

Sequence Diagram(s)

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

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.

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

coderabbitai[bot]
coderabbitai bot reviewed Apr 18, 2025
View reviewed changes
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: 0

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

103-104: Add a clear subheading for the Options Flow section
The introductory sentence for the new options is helpful but appears without a header. To match Home Assistant docs style and improve discoverability, insert a subheading (e.g., ### Options) immediately before line 103.

105-110: Use a table format and specify defaults for options
Presenting the options in a markdown table will make names, descriptions, and default states more explicit and consistent with other integrations. For example:

| Option                                   | Description                                                                                             | Default |
| ---------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------- |
| Allow Home Assistant actions             | When enabled, ESPHome devices can call services or send events. Only enable if you trust the device.     | Off     |
| Subscribe to device logs                 | When enabled, the device will send logs to Home Assistant and you can view them in the logs panel.       | Off     |

If you prefer to keep the configuration_basic directive, at minimum add a default: property for each field to reinforce that both are disabled by default.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 839e28e and 758c643.

📒 Files selected for processing (1)
  • source/_integrations/esphome.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

@bdraco
Copy link
Member Author

bdraco commented Apr 18, 2025

thanks

@bdraco bdraco merged commit 6faed6c into current Apr 18, 2025
9 checks passed
@bdraco bdraco deleted the bdraco-patch-10 branch April 18, 2025 08:59
@github-actions github-actions bot locked and limited conversation to collaborators Apr 19, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@jesserockz jesserockz jesserockz approved these changes

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

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

Assignees
No one assigned
Labels
current This PR goes into the current branch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@bdraco @jesserockz