Skip to content

Add light platform to miele integration #38585

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 3 commits into from
Apr 24, 2025

Conversation

astrandb
Copy link
Contributor

@astrandb astrandb commented Apr 16, 2025

Proposed change

Add description of light entities.

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 Miele integration documentation to include support for light entities, detailing general and ambient light functionality in compatible devices. The documentation now lists "Light" as a supported category and platform.

@home-assistant home-assistant bot added in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch next This PR goes into the next branch labels Apr 16, 2025
@home-assistant
Copy link

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.

Copy link

netlify bot commented Apr 16, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 3135da3
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6800e7a7d5b0620008f002e1
😎 Deploy Preview https://deploy-preview-38585--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.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo and removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Apr 16, 2025
@astrandb astrandb marked this pull request as ready for review April 16, 2025 21:33
Copy link
Contributor

coderabbitai bot commented Apr 16, 2025

📝 Walkthrough

Walkthrough

The Miele integration documentation was updated to reflect support for light entities. The changes include adding "Light" to the list of supported categories and platforms, and introducing a new section describing the types of light entities available (general and ambient lights). These updates complement the existing documentation for sensor entities and clarify the integration's expanded capabilities without modifying any underlying code or logic.

Changes

File(s) Change Summary
source/_integrations/miele.markdown Updated documentation to include support for light entities, expanded categories and platforms.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant MieleIntegration

    User -> HomeAssistant: Configures Miele integration
    HomeAssistant -> MieleIntegration: Loads supported platforms (sensor, light)
    MieleIntegration -> HomeAssistant: Registers sensor and light entities
    User -> HomeAssistant: Views available entities
    HomeAssistant -> User: Displays sensors and lights (including ambient/general lights)
Loading

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

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

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 (1)
source/_integrations/miele.markdown (1)

97-97: Remove trailing whitespace
Markdownlint flagged a trailing space on this line (MD009). Removing it will satisfy the rule.

-**Ambient light**: Some models of cooker hoods have ambient light that can be turned on and off. 
+**Ambient light**: Some models of cooker hoods have ambient light that can be turned on and off.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

97-97: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e588b51 and ee43cfd.

📒 Files selected for processing (1)
  • source/_integrations/miele.markdown (3 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/miele.markdown

97-97: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

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

6-6: Add Light category
Including Light in the ha_category list ensures the integration metadata accurately reflects support for light entities.


15-15: Add light to ha_platforms
Lowercase light aligns with Home Assistant’s platform identifiers and matches the newly added category.


92-98: Document new Light entities
The ### Light section correctly mirrors the existing sensor documentation, detailing both general and ambient light entities. This clearly informs users of the new capabilities without altering existing content.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

97-97: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

c0ffeeca7
c0ffeeca7 previously approved these changes Apr 17, 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 👍

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 (1)
source/_integrations/miele.markdown (1)

92-98: Review new Light section formatting
The new Light section mirrors the existing Sensor section structure and clearly describes the available entities.
Minor nit: line 97 has a single trailing space causing a markdownlint MD009 warning. Remove the extra space to avoid trailing whitespace.

- - **Ambient light**: Some models of cooker hoods have ambient light that can be turned on and off. 
+ - **Ambient light**: Some models of cooker hoods have ambient light that can be turned on and off.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

97-97: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ee43cfd and f5b1284.

📒 Files selected for processing (1)
  • source/_integrations/miele.markdown (3 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/miele.markdown

97-97: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

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

6-6: Include 'Light' in integration categories is correct
The new Light entry under ha_category aligns with the added light platform and follows Home Assistant documentation conventions.


15-15: Add 'light' platform entry correctly
Including light under ha_platforms ensures the documentation accurately reflects the supported platform for this integration.

@c0ffeeca7 c0ffeeca7 added awaits-parent Awaits the merge of an parent PR in-progress This PR/Issue is currently being worked on and removed in-progress This PR/Issue is currently being worked on labels Apr 17, 2025
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 (1)
source/_integrations/miele.markdown (1)

95-99: Document light entities – Remove trailing space
The details block accurately covers both general and ambient light entities. Please remove the trailing space at the end of line 98 to adhere to Markdown linting (MD009).

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

98-98: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f5b1284 and 3135da3.

📒 Files selected for processing (1)
  • source/_integrations/miele.markdown (3 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/miele.markdown

98-98: Trailing spaces
Expected: 0 or 2; Actual: 1

(MD009, no-trailing-spaces)

⏰ 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 (3)
source/_integrations/miele.markdown (3)

6-6: Add "Light" to ha_category list – Verified
The new category "Light" aligns with existing entries ("Hub", "Sensor") and is correctly sorted.


16-16: Add "light" to ha_platforms list – Verified
Including the lowercase "light" alongside "diagnostics" and "sensor" maintains consistency and alphabetical order.


93-94: Introduce "### Light" section header – Consistent
The section heading matches the style and level of the existing "### Sensor" section under Supported functionality.

@home-assistant home-assistant bot added the parent-merged The parent PR has been merged already label Apr 24, 2025
@joostlek joostlek merged commit d030ac5 into home-assistant:next Apr 24, 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 in-progress This PR/Issue is currently being worked on labels Apr 24, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Apr 25, 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