Skip to content

Commit 77eef89

Browse files
tjorimfrenck
authored andcommitted
Updated Configuration Variables sections (#5929)
* Updated Configuration Variables sections Squashed commit of the following: commit a95d114 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Mon Jul 30 20:08:02 2018 +0200 Clean some things up commit db63a37 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Mon Jul 30 18:28:20 2018 +0200 Revert "The rest for this PR" This reverts commit bb1b2f9. commit df90512 Merge: deef4fd e4ed00d Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Mon Jul 30 17:05:27 2018 +0200 Merge remote-tracking branch 'upstream/current' into patch-1 commit deef4fd Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sun Jul 29 12:40:01 2018 +0200 Fix Liquid error commit 74369fb Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sun Jul 29 12:37:03 2018 +0200 Update Configuration Variables sections commit 6e50eaa Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sun Jul 29 11:52:51 2018 +0200 Fix empty keys commit 7e4852e Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sun Jul 29 11:41:46 2018 +0200 Update binary_sensor.netatmo.markdown commit e1d83df Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sun Jul 29 11:28:39 2018 +0200 More updated Configuration Variables sections commit 66cbe39 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 22:00:25 2018 +0200 Fix Liquid Exception sensor.speedtest commit bb1b2f9 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 21:54:34 2018 +0200 The rest for this PR - Update components with new Configuration Variables section to have YAML block syntax - Fix wrong capitalised booleans commit 5e67726 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 20:43:52 2018 +0200 Try multiline string in Cast Trying out a multiline string in a {% configuration %}-block. commit b8d34e9 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 20:41:39 2018 +0200 Lint fixes etc. All default True/False capital letters have been fixed. Tried to reduce lines to 80 characters or less where possible. commit 88228b2 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 16:32:46 2018 +0200 Update notify.webostv.markdown commit 7204c1d Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 16:15:18 2018 +0200 Fix capital letter commit 6e1b3db Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 16:14:05 2018 +0200 Update media_player.webostv.markdown commit 89ee235 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 16:08:59 2018 +0200 Update http.markdown commit 418f5cb Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 16:02:19 2018 +0200 Fix capital letter commit d5264c3 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 16:01:39 2018 +0200 Fix capital letter commit e4cd512 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 16:01:08 2018 +0200 Update sensor.iota.markdown commit c18b25f Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 16:01:01 2018 +0200 Fix capital letter commit 79a78f2 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 15:56:22 2018 +0200 Update Configuration Variables section commit 0db5228 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 15:54:47 2018 +0200 Update Configuration Variables section commit d5d26f1 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 15:54:14 2018 +0200 Update Configuration Variables section commit ab3f045 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 15:52:50 2018 +0200 Update Configuration Variables section commit 37b2d18 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 15:51:29 2018 +0200 Update Configuration Variables section commit 39b3ecd Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 15:50:53 2018 +0200 Update Configuration Variables section commit 823ea87 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 15:50:11 2018 +0200 Update Configuration Variables section commit 6560a2b Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 15:49:53 2018 +0200 Update Configuration Variables section commit cc97df2 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 15:47:23 2018 +0200 Update Configuration Variables section commit fdc881e Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 15:46:55 2018 +0200 Update Configuration Variables section commit 81e292c Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 15:46:16 2018 +0200 Update Configuration Variables section commit 05d3481 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 15:45:25 2018 +0200 Update Configuration Variables section commit ef34f8c Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 15:41:08 2018 +0200 Update Configuration Variables section commit 49f69a3 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 15:16:27 2018 +0200 Update Configuration Variables section commit 14732ee Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 15:14:58 2018 +0200 Update Configuration Variables section commit e0f8578 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 15:11:56 2018 +0200 Update media_player.samsungtv.markdown commit 8be3c95 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 15:10:45 2018 +0200 Update Configuration Variables section commit 53b6672 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 15:10:40 2018 +0200 Update media_player.webostv.markdown commit 421e903 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 15:03:33 2018 +0200 Update Configuration Variables section commit 7f142fd Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 14:59:54 2018 +0200 webOS brand fix + filename clarification commit 1f1051b Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 14:52:29 2018 +0200 Update sensor.yr.markdown commit 8be62f4 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 14:52:05 2018 +0200 Update Configuration Variables section commit 69c615b Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 14:50:57 2018 +0200 Update notify.webostv.markdown commit 4b1175e Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 14:50:30 2018 +0200 Update notify.html5.markdown commit 4ba06dd Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 14:49:59 2018 +0200 Update image_processing.openalpr_local.markdown commit ec919d5 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 14:49:18 2018 +0200 Update image_processing.microsoft_face_detect.markdown commit da657b5 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 14:42:46 2018 +0200 Update Configuration Variables section commit 3b066ba Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 14:40:33 2018 +0200 Update Configuration Variables section commit 360c542 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 14:38:54 2018 +0200 Update Configuration Variables section commit 7965ff8 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 13:51:12 2018 +0200 Update Configuration Variables section commit 48d20dd Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 13:48:33 2018 +0200 Update Configuration Variables section commit 4c6efe7 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 13:40:33 2018 +0200 Update Configuration Variables section commit 8c45d83 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 13:35:19 2018 +0200 Update Configuration Variables section commit bbfa64a Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 13:33:14 2018 +0200 Newline commit f0577bb Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 13:32:54 2018 +0200 Fix typo commit 65f73ce Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 13:19:23 2018 +0200 Update notify.webostv.markdown commit 1a11c97 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 13:18:44 2018 +0200 Update notify.html5.markdown commit 4653233 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 13:18:04 2018 +0200 Update image_processing.openalpr_local.markdown commit ce9ca34 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Sat Jul 28 13:15:05 2018 +0200 Update Configuration Variables section commit 6ae8a40 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Thu Jul 26 22:58:55 2018 +0200 Update Configuration Variables section commit c4bed22 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Thu Jul 26 22:56:35 2018 +0200 Update Configuration Variables section commit 9fe09af Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Wed Jul 25 23:46:23 2018 +0200 Update Configuration Variables section commit 8efc72f Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Wed Jul 25 23:44:08 2018 +0200 Update image_processing.openalpr_cloud.markdown commit 52046e5 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Wed Jul 25 23:43:52 2018 +0200 Update Configuration Variables section commit c7a9296 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Wed Jul 25 23:27:08 2018 +0200 Update image_processing.microsoft_face_detect.markdown commit 3b37dc0 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Wed Jul 25 23:20:26 2018 +0200 Update Configuration Variables section commit 870cd41 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Wed Jul 25 23:18:38 2018 +0200 Update image_processing.microsoft_face_identify.markdown commit 0f76212 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Wed Jul 25 23:17:09 2018 +0200 Update Configuration Variables section commit 73513b9 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Wed Jul 25 23:13:26 2018 +0200 Update image_processing.microsoft_face_detect.markdown commit c171a08 Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Wed Jul 25 23:01:06 2018 +0200 Update image_processing.microsoft_face_detect.markdown commit 294a37f Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Wed Jul 25 21:46:14 2018 +0200 Update image_processing.microsoft_face_detect.markdown commit 9f4c3fa Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Wed Jul 25 21:21:17 2018 +0200 Update image_processing.microsoft_face_detect.markdown commit 11579aa Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Wed Jul 25 21:13:30 2018 +0200 Update camera.mjpeg.markdown commit e93f5db Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Wed Jul 25 19:34:36 2018 +0200 Update Configuration Variables section commit 383b9ac Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Wed Jul 25 17:49:38 2018 +0200 Remove leftover line commit 7e2e72f Author: Jorim Tielemans <tielemans.jorim@gmail.com> Date: Wed Jul 25 17:46:55 2018 +0200 Update Configuration Variables section * Remove encapsulation Double quotes were visible in the frontend. * Remove empty default value * :ambulance: Correcting types * :pencil2: Removes double italic
1 parent 5465025 commit 77eef89

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+1958
-729
lines changed

source/_components/abode.markdown

Lines changed: 48 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,12 @@ ha_release: 0.52
1313
ha_iot_class: "Cloud Push"
1414
---
1515

16-
The `abode` component will allow users to integrate their Abode Home Security systems into Home Assistant and use its alarm system and sensors to automate their homes.
16+
The `abode` component will allow users to integrate their Abode Home Security
17+
systems into Home Assistant and use its alarm system and sensors to automate
18+
their homes.
1719

18-
Please visit the [Abode website](https://goabode.com/) for further information about Abode Security.
20+
Please visit the [Abode website](https://goabode.com/) for further information
21+
about Abode Security.
1922

2023
There is currently support for the following device types within Home Assistant:
2124

@@ -30,34 +33,61 @@ There is currently support for the following device types within Home Assistant:
3033

3134
## {% linkable_title Configuration %}
3235

33-
To use Abode devices in your installation, add the following `abode` section to your `configuration.yaml` file:
36+
To use Abode devices in your installation,
37+
add the following `abode` section to your `configuration.yaml` file:
3438

3539
```yaml
3640
# Example configuration.yaml entry
3741
abode:
3842
username: abode_username
3943
password: abode_password
4044
name: Abode Alarm System
41-
polling: False
45+
polling: false
4246
exclude:
4347
- 'ZW:0000000034'
4448
- 'RF:00000011'
4549
lights:
4650
- 'ZW:0000000022'
4751
```
4852
49-
Configuration variables:
50-
51-
- **username** (*Required*): Username for your Abode account.
52-
- **password** (*Required*): Password for your Abode account.
53-
- **name** (*Optional*): The name for your alarm controller.
54-
- **polling** (*Optional*): Enable polling if cloud push updating is less reliable. Will update the devices once every 30 seconds. Defaults to False.
55-
- **exclude** (*Optional*): A list of devices to exclude from Home Assistant by their Abode `device_id` or `automation_id`, found within the component attributes.
56-
- **lights** (*Optional*): A list of switch devices that Home Assistant should treat as lights by the switches Abode `device_id`, found within the component attributes.
53+
{% configuration %}
54+
username:
55+
description: Username for your Abode account.
56+
required: true
57+
type: string
58+
password:
59+
description: Password for your Abode account.
60+
required: true
61+
type: string
62+
name:
63+
description: The name for your alarm controller.
64+
required: false
65+
type: string
66+
polling:
67+
description: >
68+
Enable polling if cloud push updating is less reliable.
69+
Will update the devices once every 30 seconds.
70+
required: false
71+
type: boolean
72+
default: false
73+
exclude:
74+
description: >
75+
A list of devices to exclude from Home Assistant by their Abode `device_id`
76+
or `automation_id`, found within the component attributes.
77+
required: false
78+
type: list
79+
lights:
80+
description: >
81+
A list of switch devices that Home Assistant should treat as lights by the
82+
switches Abode `device_id`, found within the component attributes.
83+
required: false
84+
type: list
85+
{% endconfiguration %}
5786

5887
## {% linkable_title Events %}
5988

60-
There are a number of events that can be triggered from Abode. They are grouped into the below events:
89+
There are a number of events that can be triggered from Abode.
90+
They are grouped into the below events:
6191

6292
- **abode_alarm**: Fired when an alarm event is triggered from Abode. This includes Smoke, CO, Panic, and Burglar alarms.
6393
- **abode_alarm_end**: Fired when an alarm end event is triggered from Abode.
@@ -80,13 +110,16 @@ Field | Description
80110
`date` | The date of the event in the format `MM/DD/YYYY`.
81111
`time` | The time of the event in the format `HH:MM AM`.
82112

83-
There is a unique list of known event_codes that can be found [here](https://github.com/MisterWil/abodepy/files/1262019/timeline_events.txt).
113+
There is a unique list of known event_codes that can be found
114+
[here](https://github.com/MisterWil/abodepy/files/1262019/timeline_events.txt).
84115

85116
## {% linkable_title Services %}
86117

87118
### {% linkable_title Service `change_setting` %}
88119

89-
Change settings on your Abode system. For a full list of settings and valid values, consult the [AbodePy settings section](https://github.com/MisterWil/abodepy/blob/master/README.rst#settings).
120+
Change settings on your Abode system.
121+
For a full list of settings and valid values, consult the
122+
[AbodePy settings section](https://github.com/MisterWil/abodepy/blob/master/README.rst#settings).
90123

91124
| Service data attribute | Optional | Description |
92125
| ---------------------- | -------- | ----------- |

source/_components/alert.markdown

Lines changed: 89 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,25 @@ ha_category: Automation
1212
ha_release: 0.38
1313
---
1414

15-
The `alert` component is designed to notify you when problematic issues arise. For example, if the garage door is left open, the `alert` component can be used remind you of this by sending you repeating notifications at customizable intervals. This is also used for low battery sensors, water leak sensors, or any condition that may need your attention.
15+
The `alert` component is designed to notify you when problematic issues arise.
16+
For example, if the garage door is left open, the `alert` component can be used
17+
remind you of this by sending you repeating notifications at customizable
18+
intervals. This is also used for low battery sensors,
19+
water leak sensors, or any condition that may need your attention.
1620

17-
Alerts will add an entity to the front end only when they are firing. This entity allows you to silence an alert until it is resolved.
21+
Alerts will add an entity to the front end only when they are firing.
22+
This entity allows you to silence an alert until it is resolved.
1823

1924
<p class='note warning'>
20-
When using the `alert` component, it is important that the time zone used for Home Assistant and the underlying operating system match. Failing to do so may result in multiple alerts being sent at the same time (such as when Home Assistant is set to the `America/Detroit` time zone but the operating system uses `UTC`).
25+
When using the `alert` component, it is important that the time zone used for Home Assistant and the underlying operating system match.
26+
Failing to do so may result in multiple alerts being sent at the same time (such as when Home Assistant is set to the `America/Detroit` time zone but the operating system uses `UTC`).
2127
</P>
2228

2329
### {% linkable_title Basic Example %}
2430

25-
The `alert` component makes use of any of the `notifications` components. To setup the `alert` component, first, you must setup a `notification` component. Then, add the following to your configuration file:
31+
The `alert` component makes use of any of the `notifications` components. To
32+
setup the `alert` component, first, you must setup a `notification` component.
33+
Then, add the following to your configuration file:
2634

2735
```yaml
2836
# Example configuration.yaml entry
@@ -39,20 +47,65 @@ alert:
3947
- ryans_phone
4048
- kristens_phone
4149
```
42-
Configuration variables:
4350
44-
- **name** (*Required*): The friendly name of the alert.
45-
- **done_message** (*Optional*): A message sent after an alert transitions from `on` to `off`. Is only sent if an alert notification was sent for transitioning from `off` to `on`.
46-
- **entity_id** (*Required*): The ID of the entity to watch.
47-
- **state** (*Optional*): The problem condition for the entity. Defaults to `on`.
48-
- **repeat** (*Required*): Number of minutes before the notification should be repeated. Can be either a number or a list of numbers.
49-
- **can_acknowledge** (*Optional*): Allows the alert to be unacknowledgeable. Defaults to `true`.
50-
- **skip_first** (*Optional*): Controls whether the notification should be sent immediately or after the first delay. Defaults to `false`.
51-
- **notifiers** (*Required*): List of `notification` components to use for alerts.
52-
53-
In this example, the garage door status (`input_boolean.garage_door`) is watched and this alert will be triggered when its status is equal to `on`. This indicates that the door has been opened. Because the `skip_first` option was set to `True`, the first notification will not be delivered immediately. However, every 30 minutes, a notification will be delivered until either `input_boolean.garage_door` no longer has a state of `on` or until the alert is acknowledged using the Home Assistant frontend.
54-
55-
For notifiers that require other parameters (such as `twilio_sms` which requires you specify a `target` parameter when sending the notification), you can use the `group` notification to wrap them for an alert. Simply create a `group` notification type with a single notification member (such as `twilio_sms`) specifying the required parameters other than `message` provided by the `alert` component:
51+
{% configuration %}
52+
name:
53+
description: The friendly name of the alert.
54+
required: true
55+
type: string
56+
done_message:
57+
description: >
58+
A message sent after an alert transitions from `on` to `off`. Is only sent
59+
if an alert notification was sent for transitioning from `off` to `on`.
60+
required: false
61+
type: string
62+
entity_id:
63+
description: The ID of the entity to watch.
64+
required: true
65+
type: string
66+
state:
67+
description: The problem condition for the entity.
68+
required: false
69+
type: string
70+
default: on
71+
repeat:
72+
description: >
73+
Number of minutes before the notification should be repeated.
74+
Can be either a number or a list of numbers.
75+
required: true
76+
type: [int, list]
77+
can_acknowledge:
78+
description: Allows the alert to be unacknowledgeable.
79+
required: false
80+
type: boolean
81+
default: true
82+
skip_first:
83+
description: >
84+
Controls whether the notification should be
85+
sent immediately or after the first delay.
86+
required: false
87+
type: boolean
88+
default: false
89+
notifiers:
90+
description: "List of `notification` components to use for alerts."
91+
required: true
92+
type: list
93+
{% endconfiguration %}
94+
95+
In this example, the garage door status (`input_boolean.garage_door`) is watched
96+
and this alert will be triggered when its status is equal to `on`.
97+
This indicates that the door has been opened. Because the `skip_first` option
98+
was set to `True`, the first notification will not be delivered immediately.
99+
However, every 30 minutes, a notification will be delivered until either
100+
`input_boolean.garage_door` no longer has a state of `on` or until the alert is
101+
acknowledged using the Home Assistant frontend.
102+
103+
For notifiers that require other parameters (such as `twilio_sms` which requires
104+
you specify a `target` parameter when sending the notification), you can use the
105+
`group` notification to wrap them for an alert.
106+
Simply create a `group` notification type with a single notification member
107+
(such as `twilio_sms`) specifying the required parameters other than `message`
108+
provided by the `alert` component:
56109

57110
```yaml
58111
- platform: group
@@ -77,7 +130,13 @@ freshwater_temp_alert:
77130

78131
### {% linkable_title Complex Alert Criteria %}
79132

80-
By design, the `alert` component only handles very simple criteria for firing. That is, it only checks if a single entity's state is equal to a value. At some point, it may be desirable to have an alert with a more complex criteria. Possibly, when a battery percentage falls below a threshold. Maybe you want to disable the alert on certain days. Maybe the alert firing should depend on more than one input. For all of these situations, it is best to use the alert in conjunction with a `Template Binary Sensor`. The following example does that.
133+
By design, the `alert` component only handles very simple criteria for firing.
134+
That is, it only checks if a single entity's state is equal to a value. At some
135+
point, it may be desirable to have an alert with a more complex criteria.
136+
Possibly, when a battery percentage falls below a threshold. Maybe you want to
137+
disable the alert on certain days. Maybe the alert firing should depend on more
138+
than one input. For all of these situations, it is best to use the alert in
139+
conjunction with a `Template Binary Sensor`. The following example does that.
81140

82141
```yaml
83142
binary_sensor:
@@ -97,11 +156,16 @@ alert:
97156
- kristens_phone
98157
```
99158

100-
This example will begin firing as soon as the entity `sensor.motion`'s `battery` attribute falls below 15. It will continue to fire until the battery attribute raises above 15 or the alert is acknowledged on the frontend.
159+
This example will begin firing as soon as the entity `sensor.motion`'s `battery`
160+
attribute falls below 15. It will continue to fire until the battery attribute
161+
raises above 15 or the alert is acknowledged on the frontend.
101162

102163
### {% linkable_title Dynamic Notification Delay Times %}
103164

104-
It may be desirable to have the delays between alert notifications dynamically change as the alert continues to fire. This can be done by setting the `repeat` configuration key to a list of numbers rather than a single number. Altering the first example would look like the following.
165+
It may be desirable to have the delays between alert notifications dynamically
166+
change as the alert continues to fire. This can be done by setting the `repeat`
167+
configuration key to a list of numbers rather than a single number.
168+
Altering the first example would look like the following.
105169

106170
```yaml
107171
# Example configuration.yaml entry
@@ -121,4 +185,8 @@ alert:
121185
- kristens_phone
122186
```
123187

124-
Now the first message will be sent after a 15 minute delay, the second will be sent 30 minutes after that, and a 60 minute delay will fall between every following notification. For example, if the garage door opens at 2:00, a notification will be sent at 2:15, 2:45, 3:45, 4:45, etc., continuing every 60 minutes.
188+
Now the first message will be sent after a 15 minute delay, the second will be
189+
sent 30 minutes after that, and a 60 minute delay will fall between every
190+
following notification.
191+
For example, if the garage door opens at 2:00, a notification will be
192+
sent at 2:15, 2:45, 3:45, 4:45, etc., continuing every 60 minutes.

0 commit comments

Comments
 (0)