Zimi: Add fan details #38905

markhannon · 2025-05-06T11:09:52Z

Proposed change

Add fan details
Add a few other improvements

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).
- I've opened up a PR to add logos and icons in Brands repository.
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: Add fan entity to Zimi integration core#144327
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
- Updated integration documentation to reflect support for "Switch" and "Fan" devices.
- Added a link to the Zimi website.
- Revised device support table to show expanded compatibility for multiple devices.
- Included new sections describing capabilities for the Zimi fan and switch controllers.

Add extra categories Add related

home-assistant · 2025-05-06T11:09:56Z

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.

netlify · 2025-05-06T11:10:08Z

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	`1bbd2ab`
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/6819fdf0ebf6be00083f5b55
😎 Deploy Preview	https://deploy-preview-38905--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle 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 · 2025-05-06T11:12:32Z

📝 Walkthrough

Walkthrough

The documentation for the Zimi integration was updated to reflect expanded device support and improved clarity. Metadata now includes "Switch" and "Fan" categories and platforms, a related URL was added, the device support table was revised to indicate more supported devices, and new sections describe the capabilities of fan and switch controllers.

Changes

File(s)	Change Summary
source/_integrations/zimi.markdown	Updated integration metadata to include "Switch" and "Fan" categories/platforms; added Zimi website URL; revised device support table to mark more devices as supported; added descriptive sections for fan and switch controllers.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Zimi Integration Documentation

    User->>Zimi Integration Documentation: Reads updated metadata and device support
    User->>Zimi Integration Documentation: Views new sections on Fan and Switch controllers
    Zimi Integration Documentation-->>User: Provides details on supported devices and entity capabilities

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between aab1273 and 9f209c5.

📒 Files selected for processing (1)

source/_integrations/zimi.markdown (2 hunks)

🧰 Additional context used

🪛 LanguageTool

source/_integrations/zimi.markdown

[grammar] ~92-~92: Did you mean “PowerPoint” (= Microsoft presentation software)?
Context: ...{Name}
Switch {Name} | Yes | | Power Point | Outlet | ...

(MICROSOFT_PRODUCTS)

🔇 Additional comments (7)

source/_integrations/zimi.markdown (7)

12-13: Expand ha_category to include Switch and Fan.

Adding Switch and Fan under ha_category accurately reflects the extended device support surface in this integration. This aligns with the new documentation content.

17-18: Add Switch and Fan to ha_platforms.

Including switch and fan in ha_platforms ensures Home Assistant recognizes and loads the correct platforms for these entities.

22-23: Introduce Related URL section.

The new related: block pointing to the Zimi website provides users with a helpful external reference. It follows the standard metadata pattern.

83-83: Update device support table for Fan and Light Controller.

Marking the “Fan and Light Controller” as supported (Yes) and detailing its multi-entity output correctly documents the new functionality.

88-92: Mark Multi-Purpose Switch variants and Power Point as supported.

Updating these rows to Yes accurately reflects the current integration coverage for all switch variants and the Power Point outlet.

🧰 Tools

🪛 LanguageTool

[grammar] ~92-~92: Did you mean “PowerPoint” (= Microsoft presentation software)?
Context: ...{Name}
Switch {Name} | Yes | | Power Point | Outlet | ...

(MICROSOFT_PRODUCTS)

94-97: Add Zimi fan controller section.

The new “Zimi fan controller” section clearly describes basic on/off and speed control support for fan entities. It enhances user understanding of fan capabilities.

102-105: Add Zimi switch controller section.

The “Zimi switch controller” section correctly documents on/off support for switch entities, completing the set of device descriptions.

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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.

c0ffeeca7 · 2025-05-06T11:23:39Z

Hi there, @markhannon 👋

Please fill out the PR template and under Link to parent pull request in the codebase:, provide the link to the related core PR.
The bot will then also stop complaining that this PR needs a rebase 😄

markhannon · 2025-05-06T11:26:12Z

Sorry about all the noise I am generating ... anxious to get all of the various parts of this integration in play.

c0ffeeca7 · 2025-05-06T11:27:29Z

no stress. I was trying to help, not complaining

c0ffeeca7 · 2025-05-06T11:34:40Z

usually, you need to create a separate docs PR for each core PR. So the switch documentation should go in a separate PR, normally. home-assistant/core#144236. So that when your code PR is merged, the related docs can be merged with it.

markhannon · 2025-05-06T11:38:39Z

I am probably trying to move too fast and launch parallel PR's rather than waiting for the entities to be merged. I can mark that future PR's as draft for the moment

source/_integrations/zimi.markdown

Add fan details

8fe2288

Add extra categories Add related

home-assistant bot assigned markhannon May 6, 2025

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 May 6, 2025

Switches will also be include ...

9f209c5

c0ffeeca7 changed the title ~~Add fan details~~ Add switch and fan details May 6, 2025

markhannon mentioned this pull request May 6, 2025

Add fan entity to Zimi integration home-assistant/core#144327

Draft

11 tasks

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 May 6, 2025

c0ffeeca7 changed the title ~~Add switch and fan details~~ Add fan details May 6, 2025

c0ffeeca7 changed the title ~~Add fan details~~ Zimi: Add fan details May 6, 2025

markhannon marked this pull request as draft May 6, 2025 11:39

c0ffeeca7 reviewed May 6, 2025

View reviewed changes

source/_integrations/zimi.markdown Outdated Show resolved Hide resolved

source/_integrations/zimi.markdown Outdated Show resolved Hide resolved

remove unrelated

1bbd2ab

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Zimi: Add fan details #38905

Zimi: Add fan details #38905

markhannon commented May 6, 2025 •

edited by c0ffeeca7

Loading

home-assistant bot commented May 6, 2025

netlify bot commented May 6, 2025 •

edited

Loading

coderabbitai bot commented May 6, 2025 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

c0ffeeca7 commented May 6, 2025

markhannon commented May 6, 2025

c0ffeeca7 commented May 6, 2025

c0ffeeca7 commented May 6, 2025

markhannon commented May 6, 2025

Zimi: Add fan details #38905

Are you sure you want to change the base?

Zimi: Add fan details #38905

Conversation

markhannon commented May 6, 2025 • edited by c0ffeeca7 Loading

Proposed change

Type of change

Additional information

Checklist

Summary by CodeRabbit

home-assistant bot commented May 6, 2025

netlify bot commented May 6, 2025 • edited Loading

✅ Deploy Preview for home-assistant-docs ready!

coderabbitai bot commented May 6, 2025 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

c0ffeeca7 commented May 6, 2025

markhannon commented May 6, 2025

c0ffeeca7 commented May 6, 2025

c0ffeeca7 commented May 6, 2025

markhannon commented May 6, 2025

markhannon commented May 6, 2025 •

edited by c0ffeeca7

Loading

netlify bot commented May 6, 2025 •

edited

Loading

coderabbitai bot commented May 6, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)