93 lines
2.9 KiB
Python
93 lines
2.9 KiB
Python
"""Calendar platform for a Remote Calendar."""
|
|
|
|
from datetime import datetime
|
|
import logging
|
|
|
|
from ical.event import Event
|
|
|
|
from homeassistant.components.calendar import CalendarEntity, CalendarEvent
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
|
|
from homeassistant.helpers.update_coordinator import CoordinatorEntity
|
|
from homeassistant.util import dt as dt_util
|
|
|
|
from . import RemoteCalendarConfigEntry
|
|
from .const import CONF_CALENDAR_NAME
|
|
from .coordinator import RemoteCalendarDataUpdateCoordinator
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
# Coordinator is used to centralize the data updates
|
|
PARALLEL_UPDATES = 0
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
entry: RemoteCalendarConfigEntry,
|
|
async_add_entities: AddConfigEntryEntitiesCallback,
|
|
) -> None:
|
|
"""Set up the remote calendar platform."""
|
|
coordinator = entry.runtime_data
|
|
entity = RemoteCalendarEntity(coordinator, entry)
|
|
async_add_entities([entity])
|
|
|
|
|
|
class RemoteCalendarEntity(
|
|
CoordinatorEntity[RemoteCalendarDataUpdateCoordinator], CalendarEntity
|
|
):
|
|
"""A calendar entity backed by a remote iCalendar url."""
|
|
|
|
_attr_has_entity_name = True
|
|
|
|
def __init__(
|
|
self,
|
|
coordinator: RemoteCalendarDataUpdateCoordinator,
|
|
entry: RemoteCalendarConfigEntry,
|
|
) -> None:
|
|
"""Initialize RemoteCalendarEntity."""
|
|
super().__init__(coordinator)
|
|
self._attr_name = entry.data[CONF_CALENDAR_NAME]
|
|
self._attr_unique_id = entry.entry_id
|
|
|
|
@property
|
|
def event(self) -> CalendarEvent | None:
|
|
"""Return the next upcoming event."""
|
|
now = dt_util.now()
|
|
events = self.coordinator.data.timeline_tz(now.tzinfo).active_after(now)
|
|
if event := next(events, None):
|
|
return _get_calendar_event(event)
|
|
return None
|
|
|
|
async def async_get_events(
|
|
self, hass: HomeAssistant, start_date: datetime, end_date: datetime
|
|
) -> list[CalendarEvent]:
|
|
"""Get all events in a specific time frame."""
|
|
events = self.coordinator.data.timeline_tz(start_date.tzinfo).overlapping(
|
|
start_date,
|
|
end_date,
|
|
)
|
|
return [_get_calendar_event(event) for event in events]
|
|
|
|
|
|
def _get_calendar_event(event: Event) -> CalendarEvent:
|
|
"""Return a CalendarEvent from an API event."""
|
|
|
|
return CalendarEvent(
|
|
summary=event.summary,
|
|
start=(
|
|
dt_util.as_local(event.start)
|
|
if isinstance(event.start, datetime)
|
|
else event.start
|
|
),
|
|
end=(
|
|
dt_util.as_local(event.end)
|
|
if isinstance(event.end, datetime)
|
|
else event.end
|
|
),
|
|
description=event.description,
|
|
uid=event.uid,
|
|
rrule=event.rrule.as_rrule_str() if event.rrule else None,
|
|
recurrence_id=event.recurrence_id,
|
|
location=event.location,
|
|
)
|