New schedule ENTITY so it can be used in integrations

ihr · October 1, 2022, 6:14pm

Custom integrations can provide a schedule entity with the same functionality provided by the schedule helper. Actually only schedules stored in the “store” can be edited by the schedule helper (front-end) this is a limitation for custom integrations. For example, I’ve a boiler at home and it provides a weekly schedule for circuits “a”, “b”, “c” and “acs”.

Looking at the source code, it looks like editable Schedule are those that belongs to the storage_collection but they are stored in the local store (json) there are no callbacks to read/store the data in an entity provided by the integration.

If there were a “schedule” entity whose UI were the current schedule editor that would be also great. In the meantime, there is no way to use the schedule UI functionality in custom integrations.

Thanks in advance!

Regards
Ignacio

corporategoth · May 23, 2023, 8:35pm

+1 on this.

In my own integration,I managed to use the schedule entity to be able to tell if my power pet door sensor is in the on or off state. I can retrieve and even have code to set schedules for my entity. But no way to visualize / edit it because of the backing store.

github.com

corporategoth/ha-powerpetdoor/blob/93ba9299d8edff7946da1db4e8a9742bb52f5e73/custom_components/powerpetdoor/schedule.py

from __future__ import annotations

from datetime import datetime, date, time, timezone, timedelta
from copy import deepcopy

from homeassistant.core import HomeAssistant, callback
from homeassistant.const import EntityCategory
from homeassistant.helpers.typing import ConfigType
from homeassistant.helpers.entity import DeviceInfo
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, CoordinatorEntity
from homeassistant.config_entries import ConfigEntry, SOURCE_IMPORT
from homeassistant.components.schedule import Schedule, WEEKDAY_TO_CONF, CONF_FROM, CONF_TO, ENTITY_SCHEMA
from .client import PowerPetDoorClient

from .const import (
    DOMAIN,
    CONF_HOST,
    CONF_PORT,
    CONF_NAME,

This file has been truncated. show original

corporategoth · January 2, 2024, 5:03pm

A PR I created to get access to the underlying storage for Schedule entities, which would at least allow me to integrate the schedule helper entity with my integration was rejected - Expose the storage collection for schedules. by corporategoth · Pull Request #106882 · home-assistant/core · GitHub

Oh well, I guess we wait until they decide that having an entity for schedules that’s not a helper is a good idea is part of core. As even the third-party integration for schedules is not really appropriate for my use (it’s designed to create a schedule and execute actions directly for a bunch of different entities, rather than just giving me the ability to represent/edit the schedule for a single entity, without taking actions on it).