Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 39 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,10 +135,12 @@ Note - `alert2-overview` will show currently firing old Alert-1 alerts, but it w
The order of displayed alerts is:
1. Alerts currently on and unacked, sorted by priority and then recency.
1. Alerts currently off and unacked, sorted by priority and then recency. This includes event alerts.
1. Alerts currently on and acked, sorted by priority and then recency.
1. Alerts currently off and acked, sorted by priority and then recency. This includes event alerts.
1. Alerts currently on and acked (not snoozed/disabled), sorted by priority and then recency.
1. Alerts currently on and acked+snoozed/disabled, sorted by priority and then recency.
1. Alerts currently off and acked (not snoozed/disabled), sorted by priority and then recency. This includes event alerts.
1. Alerts currently off and acked+snoozed/disabled, sorted by priority and then recency. This includes event alerts.

For the purpose of ordering, alerts that are snoozed or disabled are treated as if acked.
Snoozed or disabled alerts are treated as acked but sorted after regular acked alerts within each section.

If alert A is superseded by another alert that's firing, alert A will appear in UI without a badge, directly below the alert that supersedes it.

Expand All @@ -152,6 +154,17 @@ The Overview card supports a few configuration options:
| `include_old_unacked` | A boolean incidating whether to always show unacked alerts, even if they have fallen out of the display time window. Can be truthy string values like "true", "on", "yes", or the opposites. Defaults to false. |
| `filter_entity_id` | A glob or regex filter that restricts the candidate set of Alert2 entities to be displayed. A glob is a string with \* in it at least once. A regex is a string that begins and ends with "/". Defaults to "*" (i.e., do not exclude any entities) |
| `hide_superseded` | When truthy (string values like "true", "on", or "yes"), do not display in the Overview card any alert that is superseded by a currently firing alert. |
| `hide_states` | An array of alert states to hide from the Overview card. Valid values are: `on`, `off`, `acked_on`, `acked_off`, `disabled_on`, `disabled_off`, `snoozed_on`, `snoozed_off`. Convenience states: `acked` (includes both `acked_on` and `acked_off`), `disabled` (includes both `disabled_on` and `disabled_off`), `snoozed` (includes both `snoozed_on` and `snoozed_off`). If not specified, all states are shown. |
| `show_priorities` | An array of priority levels to show in the Overview card. Valid values are: `low`, `medium`, `high`. Defaults to show all priorities. |
| `default_slider_value` | Sets the default time window for the slider. Must be an integer from 0 to 6 corresponding to: 0=1 minute, 1=10 minutes, 2=1 hour, 3=4 hours (default), 4=1 day, 5=4 days, 6=2 weeks. |
| `low_color` | Custom color for low priority alerts when "on". Any valid CSS color (e.g., `"blue"`, `"#0066cc"`, `"rgb(0,102,204)"`). Defaults to theme color. |
| `medium_color` | Custom color for medium priority alerts when "on". Defaults to orange if not specified. |
| `high_color` | Custom color for high priority alerts when "on". Defaults to red if not specified. |
| `off_color` | Custom color for acked alerts when "off" and acked trigger alerts. Defaults to theme color. |
| `unacked_off_color` | Custom color for unacked alerts when "off" and unacked trigger alerts. Defaults to theme color. |
| `snoozed_disabled_use_off_color` | If `true`, snoozed and disabled alerts use `off_color` instead of their priority colors. Defaults to `false`. |
| `hide_top_bar` | Hide the entire top control bar (time slider and "Ack all" button). Can be truthy string values like "true", "on", "yes", or the opposites. Defaults to false. |
| `hide_ack_buttons` | Hide individual "Ack"/"Unack" buttons on each alert. Can be truthy string values like "true", "on", "yes", or the opposites. Defaults to false. |

Example Lovelace YAML config:

Expand All @@ -162,13 +175,36 @@ Example Lovelace YAML config:
- type: "custom:alert2-overview"
title: House Alerts
include_old_unacked: yes
default_slider_value: 2 # Start with 1 hour window

# Glob filter
filter_entity_id: "alert2.house_*"
#
# OR
# Regex filter
filter_entity_id: "/house[12]_/"

# Hide specific alert states (using convenience states)
hide_states:
- acked # Hides both acked_on and acked_off
- disabled # Hides both disabled_on and disabled_off

# Show only medium and high priority alerts
show_priorities:
- medium
- high

# Custom icon colors
low_color: "#2196F3" # Blue for low priority
medium_color: "#FF9800" # Orange for medium priority
high_color: "#F44336" # Red for high priority
off_color: "#9E9E9E" # Gray for acked off/trigger alerts
unacked_off_color: "#FFC107" # Amber for unacked off/trigger alerts
snoozed_disabled_use_off_color: true # Snoozed/disabled alerts use off_color

# Hide UI elements
hide_top_bar: false # Show the top control bar (default)
hide_ack_buttons: false # Show individual Ack buttons (default)

The same config options are available in the UI itself. When you add the Overview card, you can directly edit the "code" in YAML to specify options:

Expand Down
Loading