Israeli Red Alert Service for Home Assistant (AppDaemon)

Not Official Pikud Ha-Oref

This script creates a suite of binary sensors that issue warnings for all hazards signaled by PIKUD HA-OREF. These hazards encompass red alerts for missile and rocket fire, breaches by unauthorized aircraft, seismic activity, tsunami warnings, terrorist incursions, chemical spill emergencies, non-conventional warfare, among other dangers. Upon receiving an alert, the specific type of threat is indicated at the start of the message (for instance, ירי רקטות וטילים for rocket and missile fire).

The script offers additional functionalities, such as archiving all alert details in a historical text file and facilitating the creation of additional sub-sensors derived from the primary sensor.

---

This script introduces four new entities in Home Assistant:

Note

You can customize the sensor name to your liking, with red_alert set as the default.

• binary_sensor.red_alert: Holds PIKUD HA-OREF data, triggering on alarms and resetting otherwise. It’s useful for automations or creating additional sensors.
• binary_sensor.red_alert_city: Similar to the above but only triggers if the specified city is targeted by the alarm.
• input_text.red_alert: Logs the most recent alert data, serving as a historical log.
• input_boolean.red_alert_test: Simulates a dummy alert to verify automation setups.

Installation Instructions

Tip

To ensure the history of sensors is maintained after a restart in Home Assistant, it’s advisable to establish input text and boolean helpers. It’s best to do this prior to installation. Here’s how you can proceed:

1. Open configuration.yaml.
2. Add this lines and restart Home Assistant:

#/config/configuration.yaml
input_text:
  red_alert:
    name: Last Alert in Israel
    min: 0
    max: 255

input_boolean:
  red_alert_test:
    name: Test Alert
    icon: mdi:alert-circle

1. Install the AppDaemon addon in Home Assistant by going to Settings > Add-ons > Ad-on-store and search for AppDaemon.
2. Once AppDaemon is installed, enable the Auto-Start and Watchdog options.
3. Go to the AppDaemon configuration page and add requests Python package under the Python Packages section.

4. Start the add-on
5. In file editor open /addon_configs/a0d7b954_appdaemon/appdaemon.yaml and make the changes under appdeamon section as described:

Tip

If you’re using the File Editor add-on, it’s set up by default to only allow file access to the main Home Assistant directory. However, the AppDaemon add-on files are located in the root directory. To access these files, follow these steps:

1. Go to Settings > Add-ons > File Editor > Configuration

2. Toggle off the Enforce Basepath option.

3. In the File Editor, click on the arrow next to the directory name (which will be ‘homeassistant’). This should give you access to the root directory where the AppDaemon add-on files are located.

   

Important

You can locate your own coordinates (latitude & longitude) here: https://www.latlong.net/

• latitude: 31.9837528
• longitude: 34.7359077
• time_zone: Asia/Jerusalem.
• If you install this script via HACS - Specify the apps directory in app_dir: /homeassistant/appdaemon/apps/.
  • Also transfer all files from /addon_configs/a0d7b954_appdaemon/apps to /config/appdaemon/apps.

  #/addon_configs/a0d7b954_appdaemon/appdaemon.yaml
  ---
  secrets: /homeassistant/secrets.yaml
  appdaemon:
      app_dir: /homeassistant/appdaemon/apps/ # If you install this script via HACS
      latitude: 31.9837528
      longitude: 34.7359077
      elevation: 2
      time_zone: Asia/Jerusalem
      plugins:
        HASS:
          type: hass
  http:
      url: http://127.0.0.1:5050
  admin:
  api:
  hadashboard:

You have two choices to download the script: manually or via HACS. Installing from HACS ensures that if any new version of the script becomes available, you’ll receive a notification in Home Assistant. Manual download won’t provide you with future automatic updates. Pick the method that suits you best.

Manual Download

1. Download the Python file from This Link.
2. Place the downloaded file inside the /addon_configs/a0d7b954_appdaemon/apps directory and proceed to the final step

HACS Download

1. In Home Assistant: Navigate to HACS > Automation
   • If this option is not available, go to Settings > Integrations > HACS > Configure and enable AppDaemon apps discovery & tracking. After enabling, return to the main HACS screen and select Automation
2. Navigate to the Custom Repositories page and add the following repository as Appdaemon: https://github.com/idodov/RedAlert/
3. Return to the HACS Automation screen, search for Red Alerts Israel, click on Download and proceed to the final step

Final Step

In the appdaemon/apps/apps.yaml file, add the following code.

Important

Make sure to replace the city_names values as PIKUD HA-OREF defines them. For example, don’t write תל אביב, instead write: תל אביב - דרום העיר.

For a list of city and area names - Click Here

#/appdaemon/apps/apps.yaml
red_alerts_israel:
  module: red_alerts_israel
  class: Red_Alerts_Israel
  interval: 2
  timer: 120
  sensor_name: "red_alert"
  save_2_file: True
  city_names:
    - תל אביב - מרכז העיר
    - כיסופים
    - שדרות, איבים, ניר עם
    - אשדוד - א,ב,ד,ה
    - נתיב הל''ה

Parameter	Description	Example
interval	The interval in seconds at which the script runs	2
timer	The duration, in seconds, for which the sensor remains on after an alert	120
sensor_name	The name of the primary binary sensor in Home Assistant (binary_sensor.#sensor_name#)	red_alert
save_2_file	An option to save the alerts information in a text file	True
city_names	The names of the cities that activate the second binary sensor that will be named binary_sensor.#sensor_name#_city. You can add as many cities you want	תל אביב - מרכז העיר

---

YOU ARE ALL SET!

Home Assistant initializes four distinct entities:

• binary_sensor.red_alert: This is the main entity that becomes active during a Red Alert in Israel and reverts to inactive otherwise. It encompasses a range of attributes like category, ID, title, data, description, active alert count, and emojis.
• binary_sensor.red_alert_city: This entity retains PIKUD-HA-OREF data and is activated solely if the alert includes the specified city.
• input_text.red_alert: Intended for logging alert history in the logbook. Given Home Assistant’s 255-character limit for text entities, extensive events may lead to data being cut off or omitted. Therefore, it’s inadvisable to rely on this entity for automation triggers or to generate sub-sensors.
• input_boolean.red_alert_test: Flipping this switch generates fictitious data (for selected cities) that activates the sensor for a set duration as per the timer configuration.

Card Example

type: vertical-stack
cards:
  - type: tile
    entity: input_text.red_alert
    vertical: true
    state_content: last-changed
  - type: entities
    entities:
      - entity: binary_sensor.red_alert
      - entity: binary_sensor.red_alert_city
      - entity: input_boolean.red_alert_test
    state_color: true

Tip

Use this trigger in automation {{ (as_timestamp(now()) - as_timestamp(states.binary_sensor.red_alert.last_updated)) > 30 }} to know when the script fails to run.

You can also create a special markdown card to track the sensor:

type: markdown
content: >-
  {% set status = (as_timestamp(now()) -
  as_timestamp(states.binary_sensor.red_alert.last_updated)) < 30 %}
  {% if status %}
  <ha-alert alert-type="info">Run **{{ state_attr('binary_sensor.red_alert', 'count') }}** times since restart
  {% else %}
  <ha-alert alert-type="warning">**SCRIPT IS NOT RUNNING!!!**
  {% endif %}
  </ha-alert>

binary_sensor.red_alert Attribues

You can use any attribue from the sensor. For example, to show the title on lovelace card, use this code syntax: {{ state_attr('binary_sensor.red_alert', 'title') }}

Attribute name	Means	Example
count	Counts the number of times the script has run since the last restart of Home Assistant. By monitoring this data, you can determine if and when the script is not running.	12345
cat	Category number. can be from 1 to 13	1
title	Attack type in text	ירי רקטות וטילים
data	List of cities	תל אביב - מרכז העיר
areas	List of areas	גוש דן
desc	Explain what to do	היכנסו למרחב המוגן ושהו בו 10 דקות
duration	How many seconds to be in the safe room	600
id	Id of the alert	133413399870000000
data_count	Number of cities that are attacked	1
emoji	Icon for type of attack	🚀
prev_*	Last data from each attribue	Stores the most recent information when the sensor was active
alert	One line full text	ירי רקטות וטילים ב־קו העימות - בצת, שלומי
alert_alt	Breaking line full text	ירי רקטות וטילים/n* קו העימות: בצת, שלומי
alert_txt	One line text	קו העימות: בצת, שלומי
alert_wa	Optimize text message to send via whatsapp
alert_tg	Optimize text message to send via telegram

Example:

count: 237
id: 1234567890000000
cat: 1
title: ירי רקטות וטילים
desc: היכנסו למרחב המוגן ושהו בו 10 דקות
data: אבירים, פסוטה
areas: קו העימות
data_count: 2
duration: 600
last_changed: "2024-03-29T20:18:36.354614"
emoji: ⚠️
icon_alert: mdi:alert
prev_last_changed: "2024-03-29T20:18:36.354636"
prev_cat: 1
prev_title: ירי רקטות וטילים
prev_desc: היכנסו למרחב המוגן ושהו בו 10 דקות
prev_data: שלומי
prev_data_count: 1
prev_duration: 600
prev_areas: קו העימות
alert: "ירי רקטות וטילים ב־קו העימות: שלומי"
alert_alt: |-
  ירי רקטות וטילים
   * קו העימות: שלומי
alert_txt: "קו העימות: שלומי"
alert_wa: |-
  🚀 *ירי רקטות וטילים*
  > קו העימות
  שלומי

  _היכנסו למרחב המוגן ושהו בו 10 דקות_
friendly_name: All Red Alerts
icon: mdi:alert
alert_tg: |-
  🚀 **ירי רקטות וטילים**
  **__קו העימות__** — שלומי

  __היכנסו למרחב המוגן ושהו בו 10 דקות__

Usage Red Alert for Home Assistant

History File

The script stores the sensor data in a text file named red_alert_history.txt, located in the \\homeassistant\config\www directory. Each time an alert (including test alerts) is triggered, the file gets updated. You can directly access this file from your browser using the provided URL: http://homeassistant.local:8123/local/red_alert_history.txt

Lovelace Card Example

Displays whether there is an alert, the number of active alerts, and their respective locations.

type: markdown
content: >-
  <center><h3>{% if state_attr('binary_sensor.red_alert', 'data_count') > 0 %}
  כרגע יש {% if state_attr('binary_sensor.red_alert', 'data_count') > 1 %}{{
  state_attr('binary_sensor.red_alert', 'data_count') }} התרעות פעילות{% elif
  state_attr('binary_sensor.red_alert', 'data_count') == 1 %} התרעה פעילה אחת{%
  endif %}{% else %} אין התרעות פעילות{% endif %}</h3>

  {% if state_attr('binary_sensor.red_alert', 'data_count') > 0 %}<h2>{{
  state_attr('binary_sensor.red_alert', 'emoji') }} {{
  state_attr('binary_sensor.red_alert', 'title') }}</h2>
  <h3>{{ state_attr('binary_sensor.red_alert', 'data') }}</h3>
  **{{ state_attr('binary_sensor.red_alert', 'desc') }}** {% endif %} </center>
title: Red Alert

Using this script, you have the flexibility to include additional information, such as the precise time the alert was triggered.

type: markdown
content: >-
  <center><h3>{% if state_attr('binary_sensor.red_alert', 'data_count') > 0 %}
  כרגע יש {% if state_attr('binary_sensor.red_alert', 'data_count') > 1 %}{{
  state_attr('binary_sensor.red_alert', 'data_count') }} התרעות פעילות{% elif
  state_attr('binary_sensor.red_alert', 'data_count') == 1 %} התרעה פעילה אחת{%
  endif %}{% else %} אין התרעות פעילות{% endif %}</h3>

  {% if state_attr('binary_sensor.red_alert', 'data_count') > 0 %}<h2>{{
  state_attr('binary_sensor.red_alert', 'emoji') }} {{
  state_attr('binary_sensor.red_alert', 'title') }}</h2> <h3>{{
  state_attr('binary_sensor.red_alert', 'data') }}</h3> **{{
  state_attr('binary_sensor.red_alert', 'desc') }}** {% endif %}

  {% if state_attr('binary_sensor.red_alert', 'last_changed') |
  regex_match("^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\d{2}:\d{2}.\d+$") %}

  {% set last_changed_timestamp = state_attr('binary_sensor.red_alert',
  'last_changed') | as_timestamp %}

  {% set current_date = now().date() %}

  {% if current_date == (last_changed_timestamp | timestamp_custom('%Y-%m-%d',
  true)
   | as_datetime).date() %}
   ההתרעה האחרונה נשלחה היום בשעה {{ last_changed_timestamp | timestamp_custom('%H:%M', true) }}
  {% else %}התרעה אחרונה נשלחה בתאריך {{ last_changed_timestamp |
  timestamp_custom('%d/%m/%Y', true) }}, בשעה {{ last_changed_timestamp |
  timestamp_custom('%H:%M', true) }}

  {% endif %}
  {% endif %}
  </center>

Another nicer way:

type: markdown
content: >-
  <ha-icon icon="{{ state_attr('binary_sensor.red_alert', 'icon')
  }}"></ha-icon> {% if state_attr('binary_sensor.red_alert', 'data_count') > 0
  %}כרגע יש {% if state_attr('binary_sensor.red_alert', 'data_count') > 1 %}{{
  state_attr('binary_sensor.red_alert', 'data_count') }} התרעות פעילות{% elif
  state_attr('binary_sensor.red_alert', 'data_count') == 1 %} התרעה פעילה אחת{%
  endif %}{% else %}אין התרעות פעילות{% endif %}{% if
  state_attr('binary_sensor.red_alert', 'data_count') > 0 %}

  <ha-alert alert-type="error" title="{{ state_attr('binary_sensor.red_alert',
  'title') }}">{{ state_attr('binary_sensor.red_alert', 'data') }}</ha-alert>

  <ha-alert alert-type="warning">{{ state_attr('binary_sensor.red_alert',
  'desc') }}</ha-alert>

  {% endif %}

  {% if state_attr('binary_sensor.red_alert', 'last_changed') |
  regex_match("^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\d{2}:\d{2}.\d+$") %}

  {% set last_changed_timestamp = state_attr('binary_sensor.red_alert',
  'last_changed') | as_timestamp %}

  {% set current_date = now().date() %}{% if current_date ==
  (last_changed_timestamp | timestamp_custom('%Y-%m-%d', true)
   | as_datetime).date() %}<ha-alert alert-type="info">ההתרעה האחרונה נשלחה היום בשעה {{ last_changed_timestamp | timestamp_custom('%H:%M', true) }}
  {% else %}התרעה אחרונה נשלחה בתאריך {{ last_changed_timestamp |
  timestamp_custom('%d/%m/%Y', true) }}, בשעה {{ last_changed_timestamp |
  timestamp_custom('%H:%M', true) }}{% endif %}{% endif %}</ha-alert>

Automation Examples

You have the flexibility to generate various automated actions triggered by the binary sensor or its subsidiary sensors. As an example, one potential application is to dispatch alert messages to a LED matrix screen (in pic: forwarding all alerts to the Ulanzi Smart Clock, which is based on ESPHome32 and features a screen).

Send a notification to the phone (Home Assistant app) when there is an alert in Israel (all cities)

(Change #your phone# to your entity name)

alias: Notify attack
description: "Real-time Attack Notification"
trigger:
  - platform: state
    entity_id:
      - binary_sensor.red_alert
    from: "off"
    to: "on"
condition: []
action:
  - service: notify.mobile_app_#your phone#
    data:
      message: "{{ state_attr('binary_sensor.red_alert', 'data') }}"
      title: "{{ state_attr('binary_sensor.red_alert', 'title') }} {{ state_attr('binary_sensor.red_alert', 'areas') }}"
mode: single

Change the light color when there is an active alert in your city

As another illustration, you can configure your RGB lights to change colors repeatedly while the alert is active.

(Change light.#light-1# to your entity name)

alias: Alert in city
description: "When an alert occurs in your define city, the lights will cyclically change to red and blue for a duration of 30 seconds, after which they will revert to their previous states"
trigger:
- platform: state
  entity_id:
    - binary_sensor.red_alert_city
  from: "off"
  to: "on"
condition: []
action:
  - service: scene.create
    data:
      scene_id: before_red_alert
      snapshot_entities:
        - light.#light-1#
        - light.#light-2#
        - light.#light-3#
  - repeat:
      count: 30
      sequence:
        - service: light.turn_on
          data:
            color_name: blue
          target:
            entity_id: 
            - light.#light-1#
            - light.#light-2#
            - light.#light-3#
        - delay:
            hours: 0
            minutes: 0
            seconds: 0
            milliseconds: 500
        - service: light.turn_on
          data:
            color_name: red
          target:
            entity_id: 
            - light.#light-1#
            - light.#light-2#
            - light.#light-3#
        - delay:
            hours: 0
            minutes: 0
            seconds: 0
            milliseconds: 500
  - service: scene.turn_on
    data: {}
    target:
      entity_id: scene.before_red_alert
mode: single

Get notification When it's safe

The "desc" attribute provides information on the duration in minutes for staying inside the safe room. This automation will generate a timer based on the data from this attribute. Before implementing this automation, it's essential to create a TIMER helper.

1. Create a new TIMER helper. You can generate a new timer entity within the user interface under 'Settings' > 'Devices and Services' > 'Helpers' > 'Create Helper' > 'Timer'
2. Name it "Red Alert".
3. Create automation with your desire trigger, for example: (change #your phone# to your entity name)

Alias: Safe to go out
description: "Notify on phone that it's safe to go outside"
mode: single
trigger:
  - platform: template
    value_template: >-
      {{ "תל אביב - מרכז העיר" in state_attr('binary_sensor.red_alert',
      'data').split(', ') }}
condition: []
action:
  - service: timer.start
    data:
      duration: >-
        {{ state_attr('binary_sensor.red_alert_city', 'duration') }}
    target:
      entity_id: timer.red_alert
  - service: notify.mobile_app_#your phone#
    data:
      title: ההתרעה הוסרה
      message: אפשר לחזור לשגרה

Creating Sub Sensors

While you need to specify the cities in which the secondary binary sensor will be activated, you also have the flexibility to define additional sub-sensors based on the main sensor. Here are a few examples of how you can do this.

Note

To create a sensor that activates only when an attack occurs in a specific city that has similar character patterns in other city names, you should use the following approach. For example, if you want to create a sensor that activates when only "יבנה" and not "גן יבנה" is attacked, you can use the following code syntax. If you want to trigger a specific area, use the SPLIT function and make sure to type the city name and area exactly as they appear in https://www.oref.org.il/12481-he/Pakar.aspx

{{ "תל אביב - מרכז העיר" in state_attr('binary_sensor.red_alert', 'data').split(', ') }}

Yavne city and not Gan-Yavne city

{{ "יבנה" in state_attr('binary_sensor.red_alert', 'data').split(', ') }}

Multiple cities or city areas

{{ "אירוס" in state_attr('binary_sensor.red_alert', 'data').split(', ')
 or "בית חנן" in state_attr('binary_sensor.red_alert', 'data').split(', ')
 or "גן שורק" in state_attr('binary_sensor.red_alert', 'data').split(', ') }}

Cities With Multiple Zones:

In cities with multiple zones, relying solely on the SPLIT function won't be effective if you've only defined the city name. If you need a sensor that triggers for all zones within the 11 cities divided into multiple alert zones, it's advisable to utilize the SEARCH_REGEX function instead of splitting the data.

{{ state_attr('binary_sensor.red_alert', 'data') | regex_search("תל אביב") }} 

Metropolitan Areas

Israel is segmented into 30 metropolitan areas, allowing you to determine the general status of nearby towns without the need to specify each one individually. To achieve this, you can utilize the "areas" attribute. Here's the list of the 30 metropolitan areas in Israel, presented in alphabetical order:

אילת, בקעה, בקעת בית שאן, גוש דן, גליל עליון, גליל תחתון, דרום הגולן, דרום הנגב, הכרמל, המפרץ, העמקים, השפלה, ואדי ערה, יהודה, ים המלח, ירושלים, ירקון, לכיש, מנשה, מערב הנגב, מערב לכיש, מרכז הגליל, מרכז הנגב, עוטף עזה, ערבה, צפון הגולן, קו העימות, שומרון, שפלת יהודה ושרון

{{ "גוש דן" in state_attr('binary_sensor.red_alert', 'areas').split(', ') }}

Red Alert Trigger for Particular Type of Alert:

The 'cat' attribute defines the alert type, with a range from 1 to 13. You have the option to set up a binary sensor for a particular type of alert with or without any city or area of your choice.

Cat (number)	Type of Alert
1	Missle Attack
6	Unauthorized Aircraft Penetration
13	Infiltration of Terrorists

Trigger for Automation

{{ state_attr('binary_sensor.red_alert', 'cat') == '6' }}

Sample trigger alert for unauthorized aircraft penetration in Nahal-Oz

{{ state_attr('binary_sensor.red_alert', 'cat') == '6'
and "נחל עוז" in state_attr('binary_sensor.red_alert', 'data').split(', ') }}