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

Add documentation for MINI Connected

Open rikroe opened this issue 1 year ago • 2 comments

Proposed change

Add documentation for MINI Connected virtual 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/120874
  • Link to parent pull request in the Brands repository: https://github.com/home-assistant/brands/pull/5625
  • 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

  • New Features

    • Introduced the MINI Connected integration, enabling users to interact with their MINI vehicle through the BMW Connected Drive integration.
    • Added support for various functionalities such as binary sensors, buttons, car control, lock control, notifications, presence detection, number input, select options, sensors, and switches.
  • Documentation

    • Added documentation for the MINI Connected integration in supported_brand.md.

rikroe avatar Jun 30 '24 18:06 rikroe

[!WARNING]

Rate limit exceeded

@rikroe has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 15 minutes and 32 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 b90bc84e17ddf6ea273afbaddb143464c6681924 and 458ab7b01f0cc4e67e417a5cc3486e7905f551c7.

Walkthrough

The new mini_connected.markdown file introduces integration for MINI Connected within the BMW Connected Drive ecosystem. This enables users to control and receive notifications from their MINI vehicles through various platforms like sensors, locks, and switches. The update includes the configuration and export of a new virtual, cloud-polling integration named MINI Connected, along with detailing its support for the BMW Connected Drive integration.

Changes

File Path Change Summary
source/_integrations/mini_connected.markdown Added documentation for the new MINI Connected integration, detailing its functionalities and configurations.
... (various files) Added integration configuration, code owners, IoT class, integration type, category, and release version updated.
.../supported_brand.md Included information about brand support for the new MINI Connected integration.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant MINIConnected
    participant BMWConnectedDrive

    User ->> HomeAssistant: Adds MINI Connected Integration
    HomeAssistant ->> BMWConnectedDrive: Authenticate and Connect
    BMWConnectedDrive -->> HomeAssistant: Authentication Success
    HomeAssistant ->> MINIConnected: Setup integration
    MINIConnected ->> BMWConnectedDrive: Fetch Vehicle Data
    BMWConnectedDrive -->> MINIConnected: Vehicle Data
    MINIConnected -->> HomeAssistant: Vehicle data and controls
    HomeAssistant -->> User: MINI Connected Integration Available

[!TIP]

Early access features: enabled

We are currently testing the following features in early access:

  • OpenAI gpt-4o model for code reviews and chat: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available.

Note:

  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
  • Please join our Discord Community to provide feedback and report issues.
  • OSS projects are always opted into early access features.

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

coderabbitai[bot] avatar Jun 30 '24 18:06 coderabbitai[bot]

Deploy Preview for home-assistant-docs ready!

Name Link
Latest commit 458ab7b01f0cc4e67e417a5cc3486e7905f551c7
Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6681a2557ebf5400082790ea
Deploy Preview https://deploy-preview-33490--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 Jun 30 '24 18:06 netlify[bot]