mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-02 00:06:49 +00:00
81743d0a9a
The schedule helper now creates a `schedule` sensor instead of a binary sensor. I am not sure when this changed, but when I added a schedule helper on 2024.1.3 it did not create a binary_sensor but instead a schedule sensor that has an on/off state.
128 lines
3.4 KiB
Markdown
128 lines
3.4 KiB
Markdown
---
|
|
title: Schedule
|
|
description: Instructions on how use make weekly schedule in Home Assistant.
|
|
ha_category:
|
|
- Automation
|
|
- Helper
|
|
ha_release: 2022.9
|
|
ha_quality_scale: internal
|
|
ha_codeowners:
|
|
- '@home-assistant/core'
|
|
ha_domain: schedule
|
|
ha_integration_type: helper
|
|
---
|
|
|
|
The schedule integration provides a way to create a weekly schedule in
|
|
Home Assistant that can be used to trigger or make decisions in your
|
|
automations and scripts.
|
|
|
|
The preferred way to configure a schedule is via the user interface at
|
|
**{% my helpers title="Settings > Devices & Services > Helpers." %}** Click the add button
|
|
and then choose the **{% my config_flow_start domain=schedule title="Schedule" %}** option, or click the My button below.
|
|
|
|
{% include integrations/config_flow.md %}
|
|
|
|
To be able to add **{% my helpers title="Helpers" %}** via the user interface you should
|
|
have `default_config:` in your `configuration.yaml`, it should already
|
|
be there by default unless you removed it.
|
|
|
|
If you removed `default_config:` from your configuration,
|
|
you must add it back or, alternatively, `schedule:` to your
|
|
`configuration.yaml` first, before you can create them via the UI.
|
|
|
|
Alternatively, a schedule can also be created and configured via YAML
|
|
configuration. For example:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
schedule:
|
|
thermostat_schedule:
|
|
name: "Thermostat schedule"
|
|
monday:
|
|
- from: "17:00:00"
|
|
to: "21:00:00"
|
|
tuesday:
|
|
- from: "17:00:00"
|
|
to: "21:00:00"
|
|
wednesday:
|
|
- from: "17:00:00"
|
|
to: "21:00:00"
|
|
thursday:
|
|
- from: "17:00:00"
|
|
to: "21:00:00"
|
|
friday:
|
|
- from: "17:00:00"
|
|
to: "23:00:00"
|
|
saturday:
|
|
- from: "07:00:00"
|
|
to: "10:00:00"
|
|
- from: "16:00:00"
|
|
to: "23:00:00"
|
|
sunday:
|
|
- from: "07:00:00"
|
|
to: "21:00:00"
|
|
```
|
|
|
|
{% configuration %}
|
|
schedule:
|
|
description: Alias for the schedule. Multiple entries are allowed.
|
|
required: true
|
|
type: map
|
|
keys:
|
|
name:
|
|
description: Friendly name of the schedule.
|
|
required: true
|
|
type: string
|
|
icon:
|
|
description: Icon to display in the frontend for this schedule.
|
|
required: false
|
|
type: icon
|
|
"monday|tuesday|wednesday|thursday|friday|saturday|sunday":
|
|
description: A schedule for each day of the week.
|
|
required: false
|
|
required: true
|
|
type: list
|
|
keys:
|
|
from:
|
|
description: The start time to mark the schedule as active/on.
|
|
required: true
|
|
type: time
|
|
to:
|
|
description: The end time to mark as inactive/off again.
|
|
required: true
|
|
type: time
|
|
{% endconfiguration %}
|
|
|
|
### Attributes
|
|
|
|
A schedule entity's state exports attributes that can be useful in
|
|
automations and templates.
|
|
|
|
| Attribute | Description |
|
|
| ----- | ----- |
|
|
| `next_event` | A datetime object containing the next time the schedule is going to change state. |
|
|
|
|
### Automation example
|
|
|
|
A schedule creates an on/off (schedule) sensor within the times set. Using the thermostat schedule example above, you can turn on your thermostat:
|
|
|
|
```yaml
|
|
trigger:
|
|
- platform: state
|
|
entity_id:
|
|
- schedule.thermostat_schedule
|
|
to: "on"
|
|
action:
|
|
- service: climate.turn_on
|
|
target:
|
|
entity_id: climate.thermostat
|
|
```
|
|
|
|
### Services
|
|
|
|
Available service: `schedule.reload`.
|
|
|
|
#### schedule.reload
|
|
|
|
`schedule.reload` service allows one to reload the schedule's configuration without restarting Home Assistant itself.
|