mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-17 14:26:51 +00:00
Document schedule data property (#32560)
* Document schedule data property * Update schedule helper examples to remove data shorthand syntax https://github.com/home-assistant/core/pull/116585#pullrequestreview-2280260436 --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
parent
a8129081a7
commit
6df1dc1822
@ -63,6 +63,43 @@ schedule:
|
|||||||
to: "21:00:00"
|
to: "21:00:00"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Defining the schedule in YAML also allows adding extra data to each block, which will
|
||||||
|
appear as attributes on the schedule helper entity when that block is active. This can
|
||||||
|
be used to easily build schedule-based automations.
|
||||||
|
|
||||||
|
The `data` key of each block should be a mapping of attribute names to values. In this example,
|
||||||
|
the schedule helper entity will have "Brightness" and "Color temp" attributes when
|
||||||
|
the blocks are active:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
schedule:
|
||||||
|
light_schedule:
|
||||||
|
name: "Light schedule"
|
||||||
|
wednesday:
|
||||||
|
- from: "17:00:00"
|
||||||
|
to: "21:00:00"
|
||||||
|
data:
|
||||||
|
brightness: 100
|
||||||
|
color_temp: 4000
|
||||||
|
thursday:
|
||||||
|
- from: "17:00:00"
|
||||||
|
to: "23:00:00"
|
||||||
|
data:
|
||||||
|
brightness: 90
|
||||||
|
color_temp: 3500
|
||||||
|
friday:
|
||||||
|
- from: "07:00:00"
|
||||||
|
to: "10:00:00"
|
||||||
|
data:
|
||||||
|
brightness: 80
|
||||||
|
color_temp: 3000
|
||||||
|
- from: "16:00:00"
|
||||||
|
to: "23:00:00"
|
||||||
|
data:
|
||||||
|
brightness: 60
|
||||||
|
color_temp: 2500
|
||||||
|
```
|
||||||
|
|
||||||
{% configuration %}
|
{% configuration %}
|
||||||
schedule:
|
schedule:
|
||||||
description: Alias for the schedule. Multiple entries are allowed.
|
description: Alias for the schedule. Multiple entries are allowed.
|
||||||
@ -91,6 +128,11 @@ schedule:
|
|||||||
description: The end time to mark as inactive/off again.
|
description: The end time to mark as inactive/off again.
|
||||||
required: true
|
required: true
|
||||||
type: time
|
type: time
|
||||||
|
data:
|
||||||
|
description: Additional data to add to the entity's attributes when this block is active.
|
||||||
|
required: false
|
||||||
|
type: map
|
||||||
|
default: {}
|
||||||
{% endconfiguration %}
|
{% endconfiguration %}
|
||||||
|
|
||||||
### Attributes
|
### Attributes
|
||||||
@ -118,6 +160,27 @@ trigger:
|
|||||||
entity_id: climate.thermostat
|
entity_id: climate.thermostat
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Using the `light_schedule` example from above in an automation might look like this:
|
||||||
|
|
||||||
|
{% raw %}
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
trigger:
|
||||||
|
- platform: state
|
||||||
|
entity_id:
|
||||||
|
- schedule.light_schedule
|
||||||
|
to: "on"
|
||||||
|
action:
|
||||||
|
- service: light.turn_on
|
||||||
|
target:
|
||||||
|
entity_id: climate.thermostat
|
||||||
|
data_template:
|
||||||
|
brightness_pct: "{{ state_attr('schedule.light_schedule', 'brightness') }}"
|
||||||
|
kelvin: "{{ state_attr('schedule.light_schedule, 'temperature') }}"
|
||||||
|
```
|
||||||
|
|
||||||
|
{% endraw %}
|
||||||
|
|
||||||
### Actions
|
### Actions
|
||||||
|
|
||||||
Available action: `schedule.reload`.
|
Available action: `schedule.reload`.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user