Skip to content
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

Add Remote calendar integration #37568

Open
wants to merge 2 commits into
base: next
Choose a base branch
from

Conversation

Thomas55555
Copy link
Contributor

@Thomas55555 Thomas55555 commented Feb 19, 2025

Proposed change

Add Remote calendar integration

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
    • Added comprehensive guidance for the Remote Calendar integration, outlining installation instructions, update intervals, and configurable polling settings.
    • Provided examples detailing how calendar events can trigger automations and notifications, enabling users to leverage calendar data more effectively in Home Assistant.
    • Explained the integration's capabilities, including state maintenance for upcoming events and flexibility in automation triggers.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Feb 19, 2025
Copy link

netlify bot commented Feb 19, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 481a928
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/67b62c0e6d724e0008ae9c8e
😎 Deploy Preview https://deploy-preview-37568--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.

Copy link
Contributor

coderabbitai bot commented Feb 19, 2025

📝 Walkthrough

Walkthrough

A new documentation file for the Remote Calendar integration in Home Assistant has been introduced. This file outlines the integration's title, description, category, IoT class, release version, configuration flow, domain, and platforms. It provides details on installation, the default 24-hour update interval (with an option for a custom polling interval), and explains how calendar events are used to trigger automations. The documentation also references related resources and clarifies that removal uses standard procedures.

Changes

File(s) Change Summary
source/_integrations/remote_calendar.markdown New documentation file added for the Remote Calendar integration, covering installation, update interval, automation triggers, and removal procedures.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant HA as Home Assistant
    participant RC as Remote Calendar Integration
    participant C as Calendar Service

    U->>HA: Configures automation with calendar trigger
    HA->>RC: Polls calendar data (default 24 hrs / custom interval)
    RC->>C: Requests upcoming event
    C-->>RC: Returns next event information
    RC-->>HA: Updates calendar entity state and attributes
    HA->>U: Executes automation based on event update
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b36b04d and 481a928.

📒 Files selected for processing (1)
  • source/_integrations/remote_calendar.markdown (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • source/_integrations/remote_calendar.markdown

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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 (2)
source/_integrations/remote_calendar.markdown (2)

21-26: Duplicate Configuration Flow Include.
The file includes the {% include integrations/config_flow.md %} directive twice—once before and once after the "Installation instructions" header. Please confirm if this repetition is intentional (perhaps to emphasize configuration flow details) or if one instance can be removed to avoid redundancy and maintain a cleaner layout.


35-42: Calendar Event Automations Section.
The section on Calendar Event Automations effectively illustrates how individual calendar events can trigger automations, complete with a practical example. For added clarity, you might consider including another example or linking to more detailed usage cases if available.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e7392c7 and b36b04d.

📒 Files selected for processing (1)
  • source/_integrations/remote_calendar.markdown (1 hunks)
⏰ 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 (5)
source/_integrations/remote_calendar.markdown (5)

1-15: YAML Front Matter Review.
The YAML front matter is well structured and provides all the necessary metadata for the integration. Please verify that using ha_integration_type: service is the intended classification for a calendar integration, and that setting ha_config_flow: true aligns with the integration’s design. Also, double-check the release version (2025.04) to ensure it reflects your release plan accurately.


17-19: Integration Overview Clarity.
The introductory description clearly explains the purpose of the Remote Calendar integration and how it leverages calendar entities to trigger automations. The explanation is concise and instructive.


27-30: Update Interval Documentation.
The "Update interval" section clearly states that the calendar updates every 24 hours. If the default interval might be subject to change, consider adding a clarifying note on how users can override this setting (in conjunction with the custom polling interval instructions).


31-34: Custom Polling Interval Guidance.
Including the {% include common-tasks/define_custom_polling.md %} snippet helps maintain consistency with other integration documentation. Please verify that the referenced instructions are current and align with Home Assistant’s guidelines.


43-48: Integration Removal Instructions.
The removal instructions are straightforward and indicate that standard removal procedures apply. The inclusion of {% include integrations/remove_device_service.md %} is appropriate for providing users with detailed removal guidance if needed.

@c0ffeeca7 c0ffeeca7 added the new-integration This PR adds documentation for a new Home Assistant integration label Feb 25, 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 new-integration This PR adds documentation for a new Home Assistant integration next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants