Improving Home Assistant notifications

config/pai.conf.example

@@ -116,6 +116,14 @@ import logging
 ### MQTT Home Assistant Auto Discovery
 # MQTT_HOMEASSISTANT_AUTODISCOVERY_ENABLE = False
 # MQTT_HOMEASSISTANT_CODE = None
+# HOMEASSISTANT_PUBLISH_PARTITION_PROPERTIES = [
+#     'target_state',
+#     'current_state'
+# ]
+# HOMEASSISTANT_PUBLISH_ZONE_PROPERTIES = [
+#     'open',
+#     'tamper'
+# ]
 #
 ### Dash App
 # MQTT_DASH_PUBLISH = False
@@ -139,16 +147,11 @@ import logging
 #
 ### Home Assistant Notifications (HASS.io required)
 # HOMEASSISTANT_NOTIFICATIONS_ENABLE = False
+# HOMEASSISTANT_NOTIFICATIONS_API_URL = "http://supervisor/core/api/services/:domain/:service"
+# HOMEASSISTANT_NOTIFICATIONS_API_TOKEN = "" # Long-Lived Access Token. Required if you do not use HA Supervisor
+# HOMEASSISTANT_NOTIFICATIONS_LOVELACE_URI = "" # URI to open when notification is clicked
 # HOMEASSISTANT_NOTIFICATIONS_NOTIFIER_NAME = 'notify'
 # HOMEASSISTANT_NOTIFICATIONS_MIN_EVENT_LEVEL = 'INFO'
-# HOMEASSISTANT_PUBLISH_PARTITION_PROPERTIES = [
-#     'target_state',
-#     'current_state'
-# ]
-# HOMEASSISTANT_PUBLISH_ZONE_PROPERTIES = [
-#     'open',
-#     'tamper'
-# ]
 ## Event filtering by tags:
 # HOMEASSISTANT_NOTIFICATIONS_EVENT_FILTERS = [ # list of tags to include or exclude see hardware event.py for tag list
 #     'live,alarm,-restore', # or

paradox/config.py

@@ -170,14 +170,6 @@ class Config:
             "armed_away": "arm",
             "disarmed": "disarm",
         },
-        # Home Assistant Notifications (HASS.io required)
-        "HOMEASSISTANT_NOTIFICATIONS_ENABLE": False,
-        "HOMEASSISTANT_NOTIFICATIONS_NOTIFIER_NAME": "notify",
-        "HOMEASSISTANT_NOTIFICATIONS_MIN_EVENT_LEVEL": (
-            "INFO",
-            str,
-            ["DEBUG", "INFO", "WARN", "ERROR", "CRITICAL"],
-        ),
         "HOMEASSISTANT_PUBLISH_PARTITION_PROPERTIES": [  # List of partition properties to publish
             "target_state",
             "current_state",
@@ -186,6 +178,17 @@ class Config:
             "open",
             "tamper",
         ],
+        # Home Assistant Notifications (HASS.io required)
+        "HOMEASSISTANT_NOTIFICATIONS_ENABLE": False,
+        "HOMEASSISTANT_NOTIFICATIONS_API_URL": "http://supervisor/core/api/services/:domain/:service",
+        "HOMEASSISTANT_NOTIFICATIONS_API_TOKEN": "",  # Authentication token used for Home Assistant if not using Supervisor
+        "HOMEASSISTANT_NOTIFICATIONS_LOVELACE_URI": "",  # URI to open when notification is clicked
+        "HOMEASSISTANT_NOTIFICATIONS_NOTIFIER_NAME": "notify",
+        "HOMEASSISTANT_NOTIFICATIONS_MIN_EVENT_LEVEL": (
+            "INFO",
+            str,
+            ["DEBUG", "INFO", "WARN", "ERROR", "CRITICAL"],
+        ),
         "HOMEASSISTANT_NOTIFICATIONS_IGNORE_EVENTS": [],  # List of tuples or regexp matching "type,label,property=value,property2=value" eg. [(major, minor), "zone:HOME:entry_delay=True", ...]
         "HOMEASSISTANT_NOTIFICATIONS_ALLOW_EVENTS": [],  # Same as before but as a white list. Default is use EVENT_FILTERS
         "HOMEASSISTANT_NOTIFICATIONS_EVENT_FILTERS": [  # list of tags, property changes to include or exclude. See event.py for tag list

paradox/interfaces/text/homeassistant_notifications.py

@@ -22,7 +22,14 @@ def __init__(self, alarm):
             cfg.HOMEASSISTANT_NOTIFICATIONS_MIN_EVENT_LEVEL,
         )
 
+        self.api_url = "http://supervisor/core/api/services/:domain/:service"
         self.token = os.environ.get("SUPERVISOR_TOKEN")
+        if cfg.HOMEASSISTANT_NOTIFICATIONS_API_TOKEN:
+            self.token = cfg.HOMEASSISTANT_NOTIFICATIONS_API_TOKEN
+
+        if cfg.HOMEASSISTANT_NOTIFICATIONS_API_URL:
+            self.api_url = cfg.HOMEASSISTANT_NOTIFICATIONS_API_URL
+
         if not self.token:
             logger.error(
                 f'"SUPERVISOR_TOKEN" environment variable must be set to use {__class__.__name__}'
@@ -35,10 +42,33 @@ def send_message(self, message: str, level: EventLevel):
             )
             return
 
-        notifier_name = cfg.HOMEASSISTANT_NOTIFICATIONS_NOTIFIER_NAME
-        url = f"http://supervisor/core/api/services/notify/{notifier_name}"
+        url = self.api_url.replace(":domain", "notify").replace(
+            ":service", cfg.HOMEASSISTANT_NOTIFICATIONS_NOTIFIER_NAME
+        )
+
+        data = {}
+
+        if cfg.HOMEASSISTANT_NOTIFICATIONS_LOVELACE_URI:
+            # iOS
+            data["url"] = cfg.HOMEASSISTANT_NOTIFICATIONS_LOVELACE_URI
+            # Android
+            data["clickAction"] = cfg.HOMEASSISTANT_NOTIFICATIONS_LOVELACE_URI
+
+        if level == EventLevel.CRITICAL:
+            data.update(
+                {
+                    # iOS
+                    "push": {
+                        "interruption-level": "critical",
+                    },
+                    # Android
+                    "ttl": 0,
+                    "priority": "high",
+                    "channel": "alarm_stream",
+                }
+            )
 
-        payload = {"message": message, "title": "Paradox", "data": {"level": level}}
+        payload = {"message": message, "title": "Paradox", "data": data}
 
         headers = {"Authorization": f"Bearer {self.token}"}