Skip to content

Add fan to miele integration #38769

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

Merged
merged 2 commits into from
Apr 29, 2025
Merged

Add fan to miele integration #38769

merged 2 commits into from
Apr 29, 2025

Conversation

astrandb
Copy link
Contributor

@astrandb astrandb commented Apr 27, 2025

Proposed change

Add text on fan entiy

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).
  • [ x ] 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 reorganized the Miele integration documentation for improved clarity.
    • Added detailed sections for binary sensors and fan entities, including fan speed control for cooker hoods and induction hobs.
    • Expanded supported platforms and categories to include "binary_sensor" and "fan."
    • Clarified supported functionality and removed redundant binary sensor sections.

@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 Apr 27, 2025
Copy link

netlify bot commented Apr 27, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 630d1f0
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6810a75a890b1b000886726c
😎 Deploy Preview https://deploy-preview-38769--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 Apr 27, 2025

📝 Walkthrough

Walkthrough

The documentation for the Miele integration was reorganized to improve clarity and coverage. The lists of supported platforms and categories were reordered to prioritize "binary_sensor" and now include the newly added "fan" platform and category. The supported functionality section was expanded to mention appliance control settings. The binary sensor entity list was repositioned earlier in the document, and a new section was added to describe fan entities, specifically for cooker hoods and induction hobs. A redundant binary sensor section was removed to avoid duplication.

Changes

File Change Summary
source/_integrations/miele.markdown Reordered and expanded supported platforms/categories; added "fan" platform/category; enhanced functionality section; moved and expanded binary sensor and fan documentation; removed duplicate binary sensor section.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Documentation
    User->>Documentation: Reads supported platforms/categories
    Documentation-->>User: Shows binary_sensor, fan, and others (reordered)
    User->>Documentation: Looks for supported functionality
    Documentation-->>User: Displays use cases including appliance control
    User->>Documentation: Seeks entity details
    Documentation-->>User: Presents binary sensor section (moved up)
    Documentation-->>User: Presents new fan section for cooker hoods/hobs
Loading

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

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/miele.markdown (2)

40-40: Nitpick: Refine use-case phrasing.
Consider rephrasing
- Control settings on the appliances.
to
- Control appliance settings.
to maintain the verb-first style and improve readability.


129-133: Optional: Expand fan entity details.
It may be helpful to specify supported speed levels or modes (e.g., numeric speeds, “off”) under the fan details for greater clarity to end users.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f902f68 and 7c3e74f.

📒 Files selected for processing (1)
  • source/_integrations/miele.markdown (5 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/miele.markdown

[uncategorized] ~102-~102: You might be missing the article “the” here.
Context: ...ll remote control**: Shows the state of Full remote control feature on appliances th...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~106-~106: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...f Smart grid feature on appliances that supports it. {% enddetails %} ### Button {% de...

(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)

🔇 Additional comments (4)
source/_integrations/miele.markdown (4)

5-5: Add Binary sensor to ha_category.
This update correctly surfaces the binary_sensor category at the top, aligning with the supported platforms list.


9-9: Add Fan to ha_category.
Introducing the fan category here matches the newly documented fan platform below.


20-24: Add binary_sensor and fan to ha_platforms.
These platform entries now mirror the ha_category ordering. Ensure the core integration code includes and activates these platforms.


96-98: Verify duplicate binary sensor section removal.
You’ve moved the “### Binary sensor” heading up in the document. Please confirm that the old duplicate section later in the file was removed to prevent redundancy.

c0ffeeca7
c0ffeeca7 previously approved these changes Apr 28, 2025
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, @astrandb 👍

@c0ffeeca7 c0ffeeca7 added the awaits-parent Awaits the merge of an parent PR label Apr 28, 2025
@home-assistant home-assistant bot added the parent-merged The parent PR has been merged already label Apr 29, 2025
Copy link
Member

@joostlek joostlek left a comment

Choose a reason for hiding this comment

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

There's a merge conflict, can you take a look?

@home-assistant home-assistant bot marked this pull request as draft April 29, 2025 09:01
@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.

@astrandb astrandb marked this pull request as ready for review April 29, 2025 10:26
@home-assistant home-assistant bot requested a review from joostlek April 29, 2025 10:26
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/miele.markdown (2)

40-40: Refine phrasing of the new use case bullet
The new bullet reads:

  • Control settings on the appliances.
    For consistency and clarity, consider shortening to something like:
  • Control appliance settings.

102-106: Fix grammar and verb agreement in binary sensor descriptions

  • Add the definite article “the” before feature names for consistency.
  • Change “supports” to “support” to agree with plural “appliances.”
-  - **Full remote control**: Shows the state of Full remote control feature on appliances that supports it.
+  - **Full remote control**: Shows the state of the Full remote control feature on appliances that support it.
-  - **Smart grid**: Shows the state of Smart grid feature on appliances that supports it.
+  - **Smart grid**: Shows the state of the Smart grid feature on appliances that support it.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~102-~102: You might be missing the article “the” here.
Context: ...ll remote control**: Shows the state of Full remote control feature on appliances th...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~106-~106: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...f Smart grid feature on appliances that supports it. {% enddetails %} ### Button {% de...

(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7c3e74f and 630d1f0.

📒 Files selected for processing (1)
  • source/_integrations/miele.markdown (5 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/miele.markdown

[uncategorized] ~102-~102: You might be missing the article “the” here.
Context: ...ll remote control**: Shows the state of Full remote control feature on appliances th...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~106-~106: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...f Smart grid feature on appliances that supports it. {% enddetails %} ### Button {% de...

(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)

🔇 Additional comments (4)
source/_integrations/miele.markdown (4)

5-5: Add new categories for Binary sensor and Fan
The additions of the Binary sensor and Fan categories align with the Miele integration's new capabilities.
Please verify that your core integration's manifest.json (and platforms.yaml, if applicable) also includes these categories so the docs rendering matches the actual metadata.

Also applies to: 9-9


20-20: Include binary_sensor and fan in supported platforms
Listing these platforms ensures that Home Assistant users can enable and configure the new sensor and fan entities.
Double-check that your core integration code implements the binary_sensor and fan platforms so the docs and functionality stay in sync.

Also applies to: 24-24


96-107: New “Binary sensor” section is well formatted
The header level and use of a details block match the existing pattern for other entity types. The enumeration of binary sensors clearly describes the available features.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~102-~102: You might be missing the article “the” here.
Context: ...ll remote control**: Shows the state of Full remote control feature on appliances th...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)


[uncategorized] ~106-~106: This verb does not appear to agree with the subject. Consider using a different form.
Context: ...f Smart grid feature on appliances that supports it. {% enddetails %} ### Button {% de...

(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)


129-135: Add “Fan” section describing extraction fan control
The new section correctly uses the same header level and details formatting.
Please ensure that the core integration's fan platform implementation is tested and up to date so users can actually control and monitor these fans.

@c0ffeeca7 c0ffeeca7 enabled auto-merge (squash) April 29, 2025 11:22
@c0ffeeca7 c0ffeeca7 disabled auto-merge April 29, 2025 11:23
@c0ffeeca7 c0ffeeca7 dismissed joostlek’s stale review April 29, 2025 11:24

merge conflict has been resolved

@c0ffeeca7 c0ffeeca7 merged commit 91c09af into home-assistant:next Apr 29, 2025
7 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 Apr 29, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Apr 30, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
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