home-assistant.io icon indicating copy to clipboard operation
home-assistant.io copied to clipboard

Add documentation for new WMS WebControl pro integration

Open mback2k opened this issue 1 year ago • 2 comments

Proposed change

Add documentation for new WMS WebControl pro integration.

Type of change

  • [ ] Spelling, grammar or other readability improvements (current branch).
  • [ ] Adjusted missing or incorrect information in the current documentation (current branch).
  • [x] 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

  • Link to parent pull request in the codebase: https://github.com/home-assistant/core/pull/124176
  • Link to parent pull request in the Brands repository: https://github.com/home-assistant/brands/pull/5792
  • This PR fixes or closes issue: fixes #

Checklist

  • [x] 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.
  • [x] The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Introduced WMS WebControl pro integration for Home Assistant, enabling seamless connection to WAREMA devices.
    • Enabled local network discovery and control of patio awnings, dimmers, and switches.
    • Users can activate scenes but cannot modify or monitor them through this integration.
  • Documentation

    • Added comprehensive instructions for integrating WAREMA devices with references to related consumer and technical documentation.

mback2k avatar Aug 18 '24 20:08 mback2k

Deploy Preview for home-assistant-docs ready!

Name Link
Latest commit 03b804fa97de2dfc531ba2243a7057b8f428affd
Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/66f1145f873fb000086ade69
Deploy Preview https://deploy-preview-34353--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.

netlify[bot] avatar Aug 18 '24 20:08 netlify[bot]

[!WARNING]

Rate limit exceeded

@c0ffeeca7 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 6 minutes and 2 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 66f7fa4b137d1519de3cefc0110632eb54385360 and 03b804fa97de2dfc531ba2243a7057b8f428affd.

Walkthrough

Walkthrough

The update introduces the WMS WebControl pro integration for Home Assistant, enabling users to seamlessly integrate WAREMA devices. It leverages a local API for device management and supports various cover operations, including opening, closing, and setting specific positions. The documentation includes configuration instructions and links to consumer information and technical resources.

Changes

Files Change Summary
source/_integrations/wmspro.markdown New integration documentation for WMS WebControl pro, detailing features and supported devices. Changes include updates to title, description, ha_category, ha_release, and more, enhancing clarity and usability.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant WMSWebControlPro

    User->>HomeAssistant: Initiate integration setup
    HomeAssistant->>WMSWebControlPro: Discover devices via local API
    WMSWebControlPro-->>HomeAssistant: Return list of available devices
    HomeAssistant->>User: Display devices for selection
    User->>HomeAssistant: Select cover to control
    HomeAssistant->>WMSWebControlPro: Send control command (open/close/set position)
    WMSWebControlPro-->>HomeAssistant: Acknowledge command execution

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

coderabbitai[bot] avatar Aug 18 '24 20:08 coderabbitai[bot]