Add CalDAV todo documentation (#29711)

* Add CalDAV todo documentation

* Add todo category and platform
This commit is contained in:
Allen Porter 2023-11-07 00:12:30 -08:00 committed by GitHub
parent 312790f4d8
commit d4a2d71940
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -3,19 +3,24 @@ title: CalDAV
description: Instructions on how to integrate a WebDav calendar into Home Assistant. description: Instructions on how to integrate a WebDav calendar into Home Assistant.
ha_category: ha_category:
- Calendar - Calendar
- To-do List
ha_iot_class: Cloud Polling ha_iot_class: Cloud Polling
ha_release: '0.60' ha_release: '0.60'
ha_domain: caldav ha_domain: caldav
ha_platforms: ha_platforms:
- calendar - calendar
- todo
ha_integration_type: integration ha_integration_type: integration
--- ---
The CalDAV integration allows you to connect your WebDAV calendar to Home Assistant. The CalDAV integration allows you to connect your WebDAV calendar to Home Assistant
Each calendar is a [calendar](/integrations/calendar) entity which can be used as one of these entity types:
to trigger automations based on the the start or end of an event using criteria
such as the event name or description. The WebDAV calendar is updated roughly - A [calendar](/integrations/calendar) entity which can be used to trigger automations based on the the start or end of an event using criteria such as the event name or description.
every 15 minutes. - A [todo](/integrations/todo) entity which tracks the number of active items
on the to-do list.
The WebDAV entities are updated roughly every 15 minutes.
{% include integrations/config_flow.md %} {% include integrations/config_flow.md %}
@ -26,7 +31,7 @@ This integration was tested against [iCloud Calendar](https://www.icloud.com/cal
## Manual Configuration ## Manual Configuration
You may also manually add a WebDAV calendar in Home Assistant by adding the following section to your `configuration.yaml` file: You may also manually add a WebDAV calendar in Home Assistant by adding the following section to your `configuration.yaml` file. This method does not support to-do lists.
{% details Manual configuration examples %} {% details Manual configuration examples %}
@ -167,6 +172,12 @@ Using the entity state and attributes is more error prone and less flexible than
- **start_time**: Start time of event. - **start_time**: Start time of event.
- **end_time**: End time of event. - **end_time**: End time of event.
## To-do Entity
The todo entity is the number of incomplete items on the to-do list. See the
[todo integration](/integrations/todo) documentation for details and available
services that can be used in automations.
## Troubleshooting ## Troubleshooting
{% details "Home Assistant Core Installations" %} {% details "Home Assistant Core Installations" %}