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 and CSV files 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](https://github.com/idodov/RedAlert/blob/main/apps/red_alerts_israel/red_alerts_israel.py).
    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:
- תל אביב - מרכז העיר
- כיסופים
- שדרות, איבים, ניר עם
- אשדוד - א,ב,ד,ה
- נתיב הל''ה

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

24 Hours History

[!TIP] You can modify the card by choosing to show or not to show the history and more information data. {% set show_history = False %} False is to not show the 24 hours alert history {% set show_info = False %} - False is to not show the more info data

type: markdown
content: >-
{% set show_history = True %}

{% set show_info = True %}

{% set alerts = state_attr('binary_sensor.red_alert', 'last_24h_alerts_group') %}

{% set oref = states('binary_sensor.red_alert') %}

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

{% if state_attr('binary_sensor.red_alert', 'prev_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', 'prev_last_changed') | as_timestamp %}

{% if current_date == (last_changed_timestamp | timestamp_custom('%Y-%m-%d', true) | as_datetime).date() %}

{% set current_timestamp = now().timestamp() %}

{% set time_difference = current_timestamp - last_changed_timestamp %}