-
-
Notifications
You must be signed in to change notification settings - Fork 7.6k
Add binary sensor to miele integration #38590
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
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Caution Review failedThe pull request is closed. 📝 Walkthrough""" WalkthroughThe documentation for the Miele integration was updated to reflect the inclusion of "binary_sensor" as a supported platform and category. The description of Miele's product range was corrected, and the guidance on entity availability was expanded to recommend consulting product manuals. A new section was added, detailing six types of binary sensors supported by the integration, each with a brief description. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Documentation
User ->> Documentation: Reads Miele integration docs
Documentation -->> User: Shows supported platforms (including binary_sensor)
Documentation -->> User: Displays binary sensor types and descriptions
User ->> Documentation: Checks entity availability note
Documentation -->> User: Advises to consult product manual for details
""" 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this 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 (1)
source/_integrations/miele.markdown (1)
83-94
: Document supported binary sensors and fix verb agreement
The new section comprehensively lists all supported binary sensor entities. Minor nit: adjust verb agreement in descriptions for plural "appliances."@@ -89,7 +89,7 @@ - - **Full remote control**: Signals the state of Full remote control feature on appliances that supports it. + - **Full remote control**: Signals the state of Full remote control feature on appliances that support it. @@ -90,7 +90,7 @@ - - **Mobile start**: Signals the state of Mobile start feature on appliances that supports it. + - **Mobile start**: Signals the state of Mobile start feature on appliances that support it. @@ -93,7 +93,7 @@ - - **Smart grid**: Signals the state of Smart grid feature on appliances that supports it. + - **Smart grid**: Signals the state of Smart grid feature on appliances that support it.🧰 Tools
🪛 LanguageTool
[uncategorized] ~93-~93: 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 %} ### Sensor {% de...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/miele.markdown
(3 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/miele.markdown
[uncategorized] ~93-~93: 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 %} ### Sensor {% de...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
⏰ 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/miele.markdown (4)
5-5
: Add Binary sensor to integration categories
Adding "Binary sensor" underha_category
ensures the integration appears in the binary sensor documentation and aligns with the newly implemented feature.
15-15
: Add binary_sensor to supported platforms
Includingbinary_sensor
underha_platforms
makes the new platform available for configuration, matching the actual implementation in the core integration.
22-22
: Correct Miele product description
Updating from "floorcare" to "floor care" improves readability and consistency in describing Miele’s appliance categories.
78-78
: Enhance entity availability note
The expanded note clearly highlights that feature availability varies by model/generation and directs users to consult the product manual for specifics, reducing potential user confusion.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, @astrandb 👍
There was a problem hiding this 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 (3)
source/_integrations/miele.markdown (3)
87-87
: Remove redundant “Operation state” bullet
The top-level “Operation state” entry is unnecessary here and duplicates the section title. Removing it will streamline the list of binary sensors.- - **Operation state**:
89-89
: Fix article and verb agreement in Full remote control description
Add the missing article and correct the verb to plural for consistency.- - **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.🧰 Tools
🪛 LanguageTool
[uncategorized] ~89-~89: 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)
93-93
: Fix article and verb agreement in Smart grid description
Add the missing article and adjust the verb form for grammatical accuracy.- - **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] ~93-~93: 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 %} ### Sensor {% de...(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/miele.markdown
(3 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/miele.markdown
[uncategorized] ~89-~89: 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] ~93-~93: 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 %} ### Sensor {% de...
(AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT)
⏰ 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 (5)
source/_integrations/miele.markdown (5)
5-5
: Added binary_sensor to documentation categories
Including "Binary sensor" underha_category
aligns the metadata with the new feature and ensures it shows up correctly in the Home Assistant docs.
15-15
: Included binary_sensor in supported platforms
Addingbinary_sensor
toha_platforms
accurately reflects the integration’s capabilities after the new feature merge.
22-22
: Corrected product range wording
Changing "floorcare" to "floor care" improves readability and aligns with standard terminology.
78-78
: Expanded note to reference product manuals
The added sentence directs users to consult their appliance manual for implementation details—a valuable clarification.
83-83
: Added “Binary sensor” section header
Introducing the### Binary sensor
heading cleanly segregates the binary sensor details under supported functionality.
There was a problem hiding this 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
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
Proposed change
Add examples on implemented binary sensors
Type of change
current
branch).current
branch).next
branch).next
branch).Additional information
Checklist
current
branch.next
branch.Summary by CodeRabbit