mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-21 16:27:19 +00:00
Update alert docs (#15024)
Added state overview for the entity, 'idle' was not mentioned and corrected message options descriptions.
This commit is contained in:
parent
affe9ff7e8
commit
9c60dffc16
@ -15,8 +15,15 @@ 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.
|
||||
|
||||
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.
|
||||
Alerts will add an entity to the front end.
|
||||
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
|
||||
|
||||
@ -80,13 +87,13 @@ skip_first:
|
||||
default: false
|
||||
message:
|
||||
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.
|
||||
required: false
|
||||
type: template
|
||||
done_message:
|
||||
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
|
||||
was sent for transitioning from `off` to `on`.
|
||||
required: false
|
||||
|
Loading…
x
Reference in New Issue
Block a user