Add Zimi Cloud Controller Documentation #36668
Conversation
home-assistant
bot
added
has-parent
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request introduces a new Home Assistant integration for the Zimi Cloud Controller, enabling users to connect and control Zimi-based devices through a cloud platform. It includes detailed setup instructions, configuration parameters, and troubleshooting guidelines. The integration supports various device types, such as covers, fans, lights, and switches, and facilitates instant data updates via the Zimi API. Changes
Sequence DiagramsequenceDiagram
participant User
participant HomeAssistant
participant ZimiCloudController
participant ZimiDevices
User->>HomeAssistant: Configure Zimi Integration
HomeAssistant->>ZimiCloudController: Connect with credentials
ZimiCloudController-->>HomeAssistant: Authenticate and discover devices
HomeAssistant->>ZimiDevices: Establish control connections
ZimiDevices-->>HomeAssistant: Enable real-time updates
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? 🪧 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
source/_integrations/zimi.markdown (7)
19-19: Improve concisenessConsider revising to: "The Zimi integration allows you to control local devices connected to the Zimi mesh through your Zimi Cloud Controller in Home Assistant."
🧰 Tools
🪛 LanguageTool
[style] ~19-~19: Consider removing “of” to be more concise
Context: ...istant and via this integration control all of the local devices connected to the Zimi mes...(ALL_OF_THE)
42-42: Add details about locating device informationConsider adding specific instructions on how to find the IP and MAC address within the Zimi app interface.
51-55: Improve text formatting and readabilityPlease apply these improvements to the configuration descriptions:
- Add missing commas after conditional clauses
- Remove multiple consecutive spaces
- Use consistent punctuation
Example fix for the host description:
- description: "The IP address of your Zimi Cloud Connect. You can find it via your router admin interface. If no IP address is entered the integration will attempt to discover a Zimi Cloud Connect via a broadcast message on the local LAN." + description: "The IP address of your Zimi Cloud Connect. You can find it via your router admin interface. If no IP address is entered, the integration will attempt to discover a Zimi Cloud Connect via a broadcast message on the local LAN."🧰 Tools
🪛 LanguageTool
[uncategorized] ~51-~51: Possible missing comma found.
Context: ...admin interface. If no IP address is entered the integration will attempt to discove...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~53-~53: Possible missing comma found.
Context: ...i Cloud Connect. If no port number is entered the integration will use the default po...(AI_HYDRA_LEO_MISSING_COMMA)
80-81: Remove extra blank linesRemove the multiple consecutive blank lines to maintain consistent formatting.
🧰 Tools
🪛 Markdownlint (0.37.0)
80-80: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
81-81: Expected: 1; Actual: 3
Multiple consecutive blank lines(MD012, no-multiple-blanks)
66-78: Enhance entity capability descriptionsConsider adding more details about the capabilities of each entity type, such as:
- Supported cover positions or tilt functionality
- Available fan speeds or modes
- Light color/temperature support if applicable
- Any special features or limitations
84-84: Add details about the update mechanismConsider adding more information about:
- Expected update frequency
- Any potential delays or timeouts
- Network requirements for reliable updates
112-112: Use en dash for number rangesReplace the hyphen with an en dash in "3-5 requests" for proper typography.
-typically more than 3-5 requests +typically more than 3–5 requests🧰 Tools
🪛 LanguageTool
[typographical] ~112-~112: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...xceed these limits (typically more than 3-5 requests within a few minutes), the dev...(HYPHEN_TO_EN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/zimi.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/zimi.markdown
[style] ~19-~19: Consider removing “of” to be more concise
Context: ...istant and via this integration control all of the local devices connected to the Zimi mes...
(ALL_OF_THE)
[uncategorized] ~51-~51: Possible missing comma found.
Context: ...admin interface. If no IP address is entered the integration will attempt to discove...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~53-~53: Possible missing comma found.
Context: ...i Cloud Connect. If no port number is entered the integration will use the default po...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~112-~112: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...xceed these limits (typically more than 3-5 requests within a few minutes), the dev...
(HYPHEN_TO_EN)
🪛 Markdownlint (0.37.0)
source/_integrations/zimi.markdown
80-80: Expected: 1; Actual: 2
Multiple consecutive blank lines
(MD012, no-multiple-blanks)
81-81: Expected: 1; Actual: 3
Multiple consecutive blank lines
(MD012, no-multiple-blanks)
🔇 Additional comments (2)
source/_integrations/zimi.markdown (2)
5-5: Verify IoT class classificationThe integration is marked as
Local Push, but the description mentions cloud connectivity. Please verify if this should beCloud Pushinstead, as the integration seems to be cloud-based according to the documentation.
27-33: Verify product specification linksBoth the Cloud Connect and Matter Connect products link to the same URL. Please verify if these should be different links.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
source/_integrations/zimi.markdown (5)
19-19: Consider a more concise introduction.The sentence can be more concise by removing "of":
-The Zimi integration allows you to connect your Zimi Cloud Controller to Home Assistant and via this integration control all of the local devices connected to the Zimi mesh. +The Zimi integration allows you to connect your Zimi Cloud Controller to Home Assistant and via this integration control all local devices connected to the Zimi mesh.🧰 Tools
🪛 LanguageTool
[style] ~19-~19: Consider removing “of” to be more concise
Context: ...istant and via this integration control all of the local devices connected to the Zimi mes...(ALL_OF_THE)
53-53: Add the default port number in the description.For completeness and to help users troubleshoot, consider including the actual default port number in the description.
62-79: Consider enhancing entity documentation.While the basic functionality is covered, users would benefit from:
- Examples of supported features (e.g., supported cover positions, fan speeds)
- Available attributes and states
- Example service calls or automations
Would you like me to help generate more detailed entity documentation with examples?
80-81: Remove extra blank lines.Remove the extra blank lines to follow markdown formatting guidelines.
## Data updates - - The integration is pushed updates from the Zimi Cloud Controller instantly via the Zimi API. + +The integration is pushed updates from the Zimi Cloud Controller instantly via the Zimi API.🧰 Tools
🪛 Markdownlint (0.37.0)
80-80: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
81-81: Expected: 1; Actual: 3
Multiple consecutive blank lines(MD012, no-multiple-blanks)
109-111: Improve rate limiting documentation.Consider:
- Using an en dash for the range: "3–5 requests"
- Adding more specific information about the rate limiting window
- Clarifying if these limits are per device or per network
🧰 Tools
🪛 LanguageTool
[typographical] ~110-~110: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...xceed these limits (typically more than 3-5 requests within a few minutes), the dev...(HYPHEN_TO_EN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/zimi.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/zimi.markdown
[style] ~19-~19: Consider removing “of” to be more concise
Context: ...istant and via this integration control all of the local devices connected to the Zimi mes...
(ALL_OF_THE)
[typographical] ~110-~110: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...xceed these limits (typically more than 3-5 requests within a few minutes), the dev...
(HYPHEN_TO_EN)
🪛 Markdownlint (0.37.0)
source/_integrations/zimi.markdown
80-80: Expected: 1; Actual: 2
Multiple consecutive blank lines
(MD012, no-multiple-blanks)
81-81: Expected: 1; Actual: 3
Multiple consecutive blank lines
(MD012, no-multiple-blanks)
🔇 Additional comments (2)
source/_integrations/zimi.markdown (2)
1-17: LGTM! Metadata follows Home Assistant documentation standards.The frontmatter is well-structured with appropriate categories matching the supported entities and correct IoT classification.
27-33: Verify device specification URLs.Both the Cloud Connect and Matter Connect devices link to the same specifications URL. Please verify if these should be different URLs.
Proposed change
Add documentation for new integration for Zimi Cloud Connect support.
Replaces #35578
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
New Features
Limitations