Add Kermi docs

[jr42]

Proposed change

Adds documentation for a new integration supporting kermi heat pumps

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 Kermi integration core#119237
• Link to parent pull request in the Brands repository: Kermi integration brands#5562
• This PR fixes or closes issue: fixes #

Checklist

• This PR uses the correct branch, based on one of the following:
  • 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

• New Features

  • Introduced kermi integration for Home Assistant, enabling control of Kermi's heat pumps with water heaters via Modbus TCP.

• Enhancements

  • Improved control over parameters such as target tank temperature and operation mode for specific Kermi devices.

[coderabbitai]

Warning

Rate limit exceeded

@jr42 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 39 minutes and 41 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 678ae53 and b3011ba.

Walkthrough

The recent updates enhance the kermi integration for Home Assistant, enabling it to support Kermi's heat pumps and water heaters using Modbus TCP. Key changes include updating the kermi_formula function to accept an additional parameter and renaming a global variable for clarity. These modifications improve the integration's functionality and usability, allowing for more precise control over device parameters such as target tank temperature and operation mode.

Changes

File	Change Summary
source/_integrations/kermi.markdown	- Updated kermi_formula to accept an additional parameter z. - Renamed global variable from old_global_var to new_global_var. - Expanded summary to detail the integration's support for specific Kermi devices and control parameters.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant KermiDevice

    User->>HomeAssistant: Configure Kermi integration
    HomeAssistant->>KermiDevice: Establish Modbus TCP connection
    User->>HomeAssistant: Set target tank temperature
    HomeAssistant->>KermiDevice: Send temperature setting
    KermiDevice-->>HomeAssistant: Acknowledge setting
    HomeAssistant-->>User: Confirm setting applied

Loading

---

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?

Share

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

[netlify]

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	b3011ba
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/666774a55e2a840008b85759
😎 Deploy Preview	https://deploy-preview-33188--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]

Actionable comments posted: 4

[coderabbitai]

Actionable comments posted: 2

[frenck]

Closing PR as the parent PR is closed.