Calendar entity

A calendar entity is an entity that represents a set of events with a start and end date and/or time, helpful for automations. A calendar entity is derived from the homeassistant.components.calendar.CalendarEntity.

Calendar integrations should be compatible with rfc5545 and may optionally support event creation following patterns established in rfc5546. Integrations that support recurring events are responsible for handling expansion of recurring events, such as in a service or API that returns the expanded set of events in the series as separate individual events.

Properties

tip

Properties should always only return information from memory and not do I/O (like network requests). Implement update() or async_update() to fetch data.

Name	Type	Default	Description
event	CalendarEvent | None	Required	The current or next upcoming CalendarEvent or None.

States

A CalendarEntity state is similar to a binary sensor, reflecting whether or not there is an active event:

Constant	Description
STATE_ON	The calendar has an active event.
STATE_OFF	The calendar does not have an active event.

A calendar entity has an event property that returns either the current or next upcoming CalendarEvent which is used to determine the state. A calendar entity implementation is responsible for determining the next upcoming event, including correctly ordering events and interpreting all day events in the Home Assistant timezone. An entity should call homeassistant.util.dt.now to get the current time which has a tzinfo value set to the HomeAssistant timezone or examine homeassistant.components.util.dt.DEFAULT_TIMEZONE

Supported features

Supported features are defined by using values in the CalendarEntityFeature enum and are combined using the bitwise or (|) operator.

Value	Description
CREATE_EVENT	Entity implements the methods to allow creation of events.
DELETE_EVENT	Entity implements the methods to allow deletion of events.
UPDATE_EVENT	Entity implements the methods to allow update of events.

Methods

Get events

A calendar entity can return events that occur during a particular time range. Some notes for implementors:

• The start_date is the lower bound and applied to the event's end (exclusive). This has a tzinfo of the local Home Assistant timezone.
• The end_date is the upper bound and applied to the event's start (exclusive). This has the same tzinfo as start_date.
• Recurring events should be flattened and returned as individual CalendarEvent.

An calendar entity is responsible for returning the events in order including correctly ordering all day events. An all day event should be ordered to start at midnight in the Home Assistant timezone (e.g. from the start/end time argument tzinfo, or using homeassistant.util.dt.start_of_local_day). Note that all day events should still set a datetime.date in the CalendarEvent and not a date with a time.

import datetime
from homeassistant.core import HomeAssistant
from homeassistant.components.calendar import CalendarEntity

class MyCalendar(CalendarEntity):

    async def async_get_events(
        self,
        hass: HomeAssistant,
        start_date: datetime.datetime,
        end_date: datetime.datetime,
    ) -> list[CalendarEvent]:
        """Return calendar events within a datetime range."""

Create events

A calendar entity may support creating events by specifying the CREATE_EVENT supported feature. Integrations that support mutation must handle rfc5545 fields and best practices such as preserving any new unknown fields that are set and recurring events.

from homeassistant.components.calendar import CalendarEntity

class MyCalendar(CalendarEntity):

    async def async_create_event(self, **kwargs: Any) -> None:
        """Add a new event to calendar."""

Delete events

A calendar entity may support deleting events by specifying the DELETE_EVENT supported feature. Integrations that support mutation must support rfc5545 recurring events.

There are three ways that recurring events may be deleted:

• Specifying only the uid will delete the entire series
• Specifying the uid and recurrence_id will delete the specific event instance in the series
• Specifying uid, recurrence_id, and a recurrence_range value may delete a range of events starting at recurrence_id. Currently rfc5545 allows the range value of THISANDFUTURE.

from homeassistant.components.calendar import CalendarEntity


class MyCalendar(CalendarEntity):

    async def async_delete_event(
        self,
        uid: str,
        recurrence_id: str | None = None,
        recurrence_range: str | None = None,
    ) -> None:
        """Delete an event on the calendar."""

Update events

A calendar entity may support updating events by specifying the UPDATE_EVENT supported feature. Integrations that support mutation must support rfc5545 recurring events.

There are three ways that recurring events may be updated:

• Specifying only the uid will update the entire series
• Specifying the uid and recurrence_id will update the specific event instance in the series
• Specifying uid, recurrence_id, and a recurrence_range value may update a range of events starting at recurrence_id. Currently rfc5545 allows the range value of THISANDFUTURE.

from homeassistant.components.calendar import CalendarEntity


class MyCalendar(CalendarEntity):

    async def async_update_event(
        self,
        uid: str,
        event: dict[str, Any],
        recurrence_id: str | None = None,
        recurrence_range: str | None = None,
    ) -> None:
        """Update an event on the calendar."""

CalendarEvent

A CalendarEvent represents an individual event on a calendar.

Name	Type	Default	Description
start	datetime or date	Required	The start (inclusive) of the event. Must be before end. Both start and end must be the same type. As a datetime, must have a timezone.
end	datetime or date	Required	The end (exclusive) of the event. Must be after start. As a datetime, must have a timezone that is the same as start.
summary	string	Required	A title or summary of the event.
location	string	None	A geographic location of the event.
description	string	None	A detailed description of the event.
uid	string	None	A unique identifier for the event (required for mutations)
recurrence_id	string	None	An optional identifier for a specific instance of a recurring event (required for mutations of recurring events)
rrule	string	None	A recurrence rule string e.g. FREQ=DAILY