mirror of
https://github.com/home-assistant/core.git
synced 2025-05-03 05:29:14 +00:00
b9b5fe6be8
* Add service response data for listing calendar events Add the capability of response data for for the entity component. * Rename input arguments and add service description * Improve list events to be more user friendly Allow the end date to be determined based on a relative time duration. Make the start time optional and set to "now". Add additional test coverage. Update demo calendar to actually perform date range checks. * Wrap docstrings properly. * Increase test coverage * Update to use new API calls * Readability improvements * Wrap docstrings * Require at least one of end or duration * Check for multiple entity matches earlier in the request * Update documentation strings
76 lines
2.4 KiB
Python
76 lines
2.4 KiB
Python
"""Demo platform that has two fake binary sensors."""
|
|
from __future__ import annotations
|
|
|
|
import datetime
|
|
|
|
from homeassistant.components.calendar import CalendarEntity, CalendarEvent
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
|
|
import homeassistant.util.dt as dt_util
|
|
|
|
|
|
def setup_platform(
|
|
hass: HomeAssistant,
|
|
config: ConfigType,
|
|
add_entities: AddEntitiesCallback,
|
|
discovery_info: DiscoveryInfoType | None = None,
|
|
) -> None:
|
|
"""Set up the Demo Calendar platform."""
|
|
add_entities(
|
|
[
|
|
DemoCalendar(calendar_data_future(), "Calendar 1"),
|
|
DemoCalendar(calendar_data_current(), "Calendar 2"),
|
|
]
|
|
)
|
|
|
|
|
|
def calendar_data_future() -> CalendarEvent:
|
|
"""Representation of a Demo Calendar for a future event."""
|
|
half_hour_from_now = dt_util.now() + datetime.timedelta(minutes=30)
|
|
return CalendarEvent(
|
|
start=half_hour_from_now,
|
|
end=half_hour_from_now + datetime.timedelta(minutes=60),
|
|
summary="Future Event",
|
|
description="Future Description",
|
|
location="Future Location",
|
|
)
|
|
|
|
|
|
def calendar_data_current() -> CalendarEvent:
|
|
"""Representation of a Demo Calendar for a current event."""
|
|
middle_of_event = dt_util.now() - datetime.timedelta(minutes=30)
|
|
return CalendarEvent(
|
|
start=middle_of_event,
|
|
end=middle_of_event + datetime.timedelta(minutes=60),
|
|
summary="Current Event",
|
|
)
|
|
|
|
|
|
class DemoCalendar(CalendarEntity):
|
|
"""Representation of a Demo Calendar element."""
|
|
|
|
def __init__(self, event: CalendarEvent, name: str) -> None:
|
|
"""Initialize demo calendar."""
|
|
self._event = event
|
|
self._attr_name = name
|
|
|
|
@property
|
|
def event(self) -> CalendarEvent:
|
|
"""Return the next upcoming event."""
|
|
return self._event
|
|
|
|
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."""
|
|
assert start_date < end_date
|
|
if self._event.start_datetime_local >= end_date:
|
|
return []
|
|
if self._event.end_datetime_local < start_date:
|
|
return []
|
|
return [self._event]
|