-
-
Notifications
You must be signed in to change notification settings - Fork 7.6k
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
base: next
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughA 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
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
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this 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
📒 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 usingha_integration_type: service
is the intended classification for a calendar integration, and that settingha_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.
Proposed change
Add Remote calendar integration
Type of change
current
branch).current
branch).next
branch).next
branch).Additional information
Checklist
current
branch.next
branch.Summary by CodeRabbit