info.md

Installation Instructions

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\appdaemon\appdaemon.yaml and make the changes under appdeamon section as described:

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, remember to transfer all files from /addon_configs/a0d7b954_appdaemon/apps/ to /homeassistant/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:

Manual Download

1. Download the Python file from This Link.
2. Place the downloaded file inside the 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. Make sure to replace the city_names values as described below and save the file:

#/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!

Upon restarting the AppDaemon add-on, Home Assistant will create four entities:

• The primary entity, binary_sensor.red_alert, activates when there’s a Red Alert in Israel and deactivates otherwise. This sensor also includes various attributes such as category, ID, title, data, description, the count of active alerts, and emojis.
• The second entity, binary_sensor.red_alert_city, stores PIKUD-HA-OREF data and only activates if the defined city is included in the alert cities.
• The third entity, input_text.red_alert, is mainly for recording historical alert data on the logbook screen. Please note that Home Assistant has a character limit of 255 for text entities. This means that during significant events, like large-scale attacks involving multiple areas or cities, some data might be truncated or lost. Hence, it’s not recommended to use this text input entity as a trigger for automations or to create sub-sensors from it.
• The final entity, input_boolean.red_alert, when toggled on, sends false data to the sensor, which activates it for the period you defined in the timer value.

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:

#/homeassistant/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