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 select entity to Home Connect #35398

Merged
merged 2 commits into from
Nov 28, 2024

Conversation

Diegorro98
Copy link
Contributor

@Diegorro98 Diegorro98 commented Oct 26, 2024

Proposed change

Add select entity information to Home Connect integration documentation

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

  • New Features

    • Enhanced documentation for the Home Connect integration, now detailing support for select entities.
    • Introduced a new "Select" category and platform, allowing users to choose from available programs on devices with programs.
  • Documentation

    • Clarified functionality regarding program selection in the Home Connect integration documentation.

@home-assistant home-assistant bot added Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Oct 26, 2024
Copy link

netlify bot commented Oct 26, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 8de451f
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6747506449a48400089f2625
😎 Deploy Preview https://deploy-preview-35398--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 Oct 26, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes involve updates to the Home Connect integration documentation, specifically enhancing the description of its capabilities. A new category, "Select," has been added to the ha_category and ha_platforms sections. This indicates that the integration now supports select entities, allowing users to choose from available programs if a device has programs. The overall structure of the documentation remains consistent while clarifying the integration's functionality regarding program selection.

Changes

File Path Change Summary
source/_integrations/home_connect.markdown Added new category "Select" to ha_category and new platform "select" to ha_platforms. Clarified functionality regarding program selection.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeConnectIntegration
    participant Device

    User->>HomeConnectIntegration: Request available programs
    HomeConnectIntegration->>Device: Fetch available programs
    Device-->>HomeConnectIntegration: Return available programs
    HomeConnectIntegration-->>User: Display available programs for selection
    User->>HomeConnectIntegration: Select a program
    HomeConnectIntegration->>Device: Execute selected program
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9291312 and 8de451f.

📒 Files selected for processing (1)
  • source/_integrations/home_connect.markdown (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • source/_integrations/home_connect.markdown

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

🧹 Outside diff range and nitpick comments (1)
source/_integrations/home_connect.markdown (1)

37-37: Consider adding usage examples.

To enhance user understanding, consider adding:

  1. A simple example showing how to use the select entity in automations
  2. A code snippet demonstrating the YAML configuration (if applicable)

Would you like me to help draft example snippets for the documentation?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between e1f0555 and 9291312.

📒 Files selected for processing (1)
  • source/_integrations/home_connect.markdown (3 hunks)
🔇 Additional comments (2)
source/_integrations/home_connect.markdown (2)

9-9: LGTM: Front matter changes are correct and well-structured.

The additions of "Select" to ha_category and "select" to ha_platforms follow Home Assistant's documentation standards and maintain proper alphabetical ordering.

Also applies to: 24-24


37-37: Consider clarifying the relationship between program controls.

While the addition clearly describes the select entity functionality, it might be helpful to clarify:

  1. The relationship between program switches and the select entity
  2. Whether users should prefer one method over the other
  3. If both controls can be used interchangeably

Let me check if there are any related discussions or documentation:

@home-assistant home-assistant bot added the parent-merged The parent PR has been merged already label Nov 27, 2024
@home-assistant home-assistant bot marked this pull request as draft November 27, 2024 15:36
@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.

Also improve a bit the program entities
@Diegorro98 Diegorro98 marked this pull request as ready for review November 27, 2024 17:03
@frenck frenck added this to the 2024.12 milestone Nov 27, 2024
- If the device has programs, switches for each of the individual programs will be added. Note that program options cannot be configured currently.
- If the device has programs, a timestamp sensor for remaining time and a numeric sensor for the progress percentage.
- If the device has programs:
- Switches for each of the individual programs will be added. Note that program options cannot be configured currently.
Copy link
Contributor Author

@Diegorro98 Diegorro98 Nov 27, 2024

Choose a reason for hiding this comment

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

Should I mark the switches as deprecated once home-assistant/core#131641 gets merged?

Copy link
Member

Choose a reason for hiding this comment

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

Deprecation are generally just removed from the documentation.

Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, @Diegorro98 👍

../Frenck

@frenck frenck merged commit d2c7b06 into home-assistant:next Nov 28, 2024
7 checks passed
@home-assistant home-assistant bot removed the parent-merged The parent PR has been merged already label Nov 28, 2024
@Diegorro98 Diegorro98 deleted the home_connect_select_entity branch November 28, 2024 07:30
@frenck frenck added the cherry-picked This PR has been manually picked and merged into the current branch label Nov 28, 2024
frenck pushed a commit that referenced this pull request Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cherry-picked This PR has been manually picked and merged into the current branch Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! 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.

3 participants