Skip to content

Add sensor #38906

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

Draft
wants to merge 1 commit into
base: next
Choose a base branch
from
Draft

Add sensor #38906

wants to merge 1 commit into from

Conversation

markhannon
Copy link

@markhannon markhannon commented May 6, 2025

Proposed change

Add sensor details

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 Zimi Cloud Controller integration documentation to include support for Switch, Fan, and Sensor device categories.
    • Revised device support table to reflect current support statuses for various devices.
    • Added detailed descriptions for Zimi fan, sensor, and switch controllers.
    • Included a link to the Zimi website for additional information.

@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 May 6, 2025
@home-assistant
Copy link

home-assistant bot commented May 6, 2025

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

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 6bfb6c3
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6819f0972002300008c11a67
😎 Deploy Preview https://deploy-preview-38906--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.

@markhannon markhannon marked this pull request as draft May 6, 2025 11:21
Copy link
Contributor

coderabbitai bot commented May 6, 2025

📝 Walkthrough

Walkthrough

The documentation for the Zimi Cloud Controller integration was updated to reflect expanded device support. New device categories (Switch, Fan, Sensor) were added, support statuses in tables were revised, and new descriptive sections for these devices were included. A related URL was also added. No code or logic changes occurred.

Changes

File(s) Change Summary
source/_integrations/zimi.markdown Expanded supported device categories and platforms; updated device support table; added sections for new devices; included a related URL.

Sequence Diagram(s)

No sequence diagram is generated as the changes are limited to documentation updates.


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.

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/zimi.markdown (1)

96-96: Ensure consistent section heading naming.
Consider aligning the sensor section heading with the others—either add “controller” (e.g., ### Zimi sensor controller) or drop “controller” from fan/switch/light headings for consistency.

Also applies to: 104-104, 108-108

📜 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 6bfb6c3.

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

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

(MICROSOFT_PRODUCTS)

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

12-14: Add new device categories in front matter.
The updated ha_category now correctly reflects the additional device types supported by this integration.


18-20: Add new platforms in front matter.
The ha_platforms list has been expanded to include switch, fan, and sensor to match the newly supported entities.


24-25: Add related URL to integration metadata.
Including the related link to the official Zimi website provides useful context for users seeking more information.


85-94: Update device support table with new entries and statuses.
The table now accurately reflects support for the Fan and Light Controller, expands Garage Door Controller support to include sensors, and adds all Multi-Purpose Switch variants along with the Power Point outlet. Formatting (including <br> tags) is consistent with existing table cells.

🧰 Tools
🪛 LanguageTool

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

(MICROSOFT_PRODUCTS)


94-94: Verify product name formatting.
LanguageTool flagged “Power Point” as a possible typo (it suggested “PowerPoint”), but here it refers to an electrical outlet. Please confirm that “Power Point” matches the official Zimi product branding.

🧰 Tools
🪛 LanguageTool

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

(MICROSOFT_PRODUCTS)


96-96: Add Zimi fan controller section.
The new ### Zimi fan controller heading properly introduces the fan-specific entity details.


104-104: Add Zimi sensor section.
The ### Zimi sensor heading and description correctly document the sensor entity’s capabilities.


108-108: Add Zimi switch controller section.
The ### Zimi switch controller heading is now in place to describe basic on/off switch entities.

@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 May 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
has-parent This PR has a parent PR in a other repo in-progress This PR/Issue is currently being worked on next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant