jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 09:17:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update alert docs (#15024)

Browse Source 
Added state overview for the entity, 'idle' was not mentioned and corrected message options descriptions.
This commit is contained in:
Alexander Leisentritt 2020-10-07 22:14:36 +02:00 committed by GitHub
parent affe9ff7e8
commit 9c60dffc16
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
source/_integrations/alert.markdown
View File

@ -15,8 +15,15 @@ remind you of this by sending you repeating notifications at customizable
intervals. This is also used for low battery sensors, intervals. This is also used for low battery sensors,
water leak sensors, or any condition that may need your attention. water leak sensors, or any condition that may need your attention.
Alerts will add an entity to the front end only when they are firing. Alerts will add an entity to the front end.
This entity allows you to silence an alert until it is resolved. This entity allows you to silence an alert until it is resolved and has three
possible states:
State | Description
-|-
`idle` | The condition for the alert is false.
`on` | The condition for the alert is true.
`off` | The condition for the alert is true but it was acknowledged.
### Basic Example ### Basic Example
@ -80,13 +87,13 @@ skip_first:
default: false default: false
message: message:
description: > description: >
A message to be sent after an alert transitions from `off` to `on` A message to be sent after an alert transitions from `idle` to `on`
with [template](/docs/configuration/templating/) support. with [template](/docs/configuration/templating/) support.
required: false required: false
type: template type: template
done_message: done_message:
description: > description: >
A message sent after an alert transitions from `on` to `off` with A message sent after an alert transitions from `on` to `idle` with
[template](/docs/configuration/templating/) support. Is only sent if an alert notification [template](/docs/configuration/templating/) support. Is only sent if an alert notification
was sent for transitioning from `off` to `on`. was sent for transitioning from `off` to `on`.
required: false required: false