Schedule

The schedule helper in Home Assistant is on during the time blocks you give it for each day of the week, and off the rest of the time. Heating that follows the working week, for example.

Spook adds actions to the schedule integration to create and delete these helpers and change their time blocks from automations and scripts.

Devices & entities¶

Spook does not provide any new devices or entities for this integration.

Actions¶

Spook adds the following new actions to your Home Assistant instance:

Create a schedule¶

Creates a new schedule helper, the same as adding one on the helpers page. Great for a script or a blueprint that sets up the week it needs itself.

Each day takes a list of time blocks. A block has a from and a to time, and optionally data: values the schedule shows as attributes while that block is on. A to of 24:00:00 runs until midnight. Blocks on the same day cannot overlap, and each has to end after it starts; a schedule that breaks either is refused before anything is made. A day left out is off all day.

Without a schedule_id, the entity ID follows the name, as it does in the UI, and gets a number at the end if that name is already taken. With a schedule_id, you get exactly that entity ID or an error: one that is already taken is refused, rather than quietly given a number at the end.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
action: schedule.create
data:
  name: "Heating"
  schedule_id: heating
  monday:
    - from: "06:30:00"
      to: "08:30:00"
      data:
        temperature: 21
    - from: "17:00:00"
      to: "22:00:00"
  saturday:
    - from: "09:00:00"
      to: "24:00:00"
response_variable: created

Delete a schedule¶

Deletes one or more schedule helpers made in the UI, disabled ones included. Schedules set up in YAML can only be removed from the YAML.

Everything in the list is checked first: if one of them cannot be deleted, none of them are.

1
2
3
action: schedule.delete
data:
  entity_id: schedule.heating

Set the time blocks of a day¶

Replaces the time blocks of one or more days of a schedule, the same as changing them in its dialog. The other days stay as they are.

Only schedules made in the UI can be changed: a schedule set up in YAML is refused, and can only be changed in the YAML.

A day is one of monday, tuesday, wednesday, thursday, friday, saturday, or sunday. Give a list to set several days to the same blocks at once.

A block has a from and a to time, and optionally data: values the schedule shows as attributes while that block is on. A to of 24:00:00 runs until midnight. Blocks cannot overlap, and each has to end after it starts. Home Assistant checks them the same way its dialog does; blocks it refuses come back as an error, and nothing is changed.

An empty list of blocks leaves the days off all day.

Changing how a schedule is set up is for admins, the same as in its dialog. An automation or a script can still use it.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
action: schedule.set_day
target:
  entity_id: schedule.heating
data:
  day:
    - saturday
    - sunday
  blocks:
    - from: "08:00:00"
      to: "12:00:00"
      data:
        temperature: 21
    - from: "17:00:00"
      to: "23:00:00"

1
2
3
4
5
6
action: schedule.set_day
target:
  entity_id: schedule.heating
data:
  day: friday
  blocks: []

Repairs¶

Spook has no repair detections for this integration.

Use cases¶

Some use cases for the enhancements Spook provides for this integration:

• Let a script or a blueprint make the schedule it needs, with its whole week of time blocks, without a trip to the helpers page.

• Clean up schedules that are no longer needed from a script, so the helpers page only has schedules you actually use.

• Clear the weekdays of a heating schedule when you leave for a holiday, and put them back when you return.

• Let a script or a dashboard button move the morning block, without opening the schedule’s dialog.

Blueprints & tutorials¶

There are currently no known blueprints or tutorials for the enhancements Spook provides for this integration. If you created one or stumbled upon one, please let us know in our discussion forums.

Feature requests, ideas, and support¶

If you have an idea on how to further enhance this integration, for example, by adding a new action, entity, or repairs detection; feel free to let us know in our discussion forums.

Are you stuck using these new features? Or maybe you’ve run into a bug? Please check the Support page on where to go for help.