Add id to automation triggers

homeassistant/components/arcam_fmj/device_trigger.py

@@ -56,6 +56,7 @@ async def async_attach_trigger(
     automation_info: dict,
 ) -> CALLBACK_TYPE:
     """Attach a trigger."""
+    trigger_id = automation_info.get("trigger_id") if automation_info else None
     job = HassJob(action)
 
     if config[CONF_TYPE] == "turn_on":
@@ -66,7 +67,13 @@ def _handle_event(event: Event):
             if event.data[ATTR_ENTITY_ID] == entity_id:
                 hass.async_run_hass_job(
                     job,
-                    {"trigger": {**config, "description": f"{DOMAIN} - {entity_id}"}},
+                    {
+                        "trigger": {
+                            **config,
+                            "description": f"{DOMAIN} - {entity_id}",
+                            "id": trigger_id,
+                        }
+                    },
                     event.context,
                 )
 

homeassistant/components/automation/__init__.py

@@ -419,7 +419,11 @@ async def async_trigger(self, run_variables, context=None, skip_condition=False)
             automation_trace.set_trigger_description(trigger_description)
 
             # Add initial variables as the trigger step
-            trace_element = TraceElement(variables, "trigger")
+            if "trigger" in variables and "id" in variables["trigger"]:
+                trigger_path = f"trigger/{variables['trigger']['id']}"
+            else:
+                trigger_path = "trigger"
+            trace_element = TraceElement(variables, trigger_path)
             trace_append_element(trace_element)
 
             if (

homeassistant/components/geo_location/trigger.py

@@ -33,6 +33,7 @@ def source_match(state, source):
 
 async def async_attach_trigger(hass, config, action, automation_info):
     """Listen for state changes based on configuration."""
+    trigger_id = automation_info.get("trigger_id") if automation_info else None
     source = config.get(CONF_SOURCE).lower()
     zone_entity_id = config.get(CONF_ZONE)
     trigger_event = config.get(CONF_EVENT)
@@ -74,6 +75,7 @@ def state_change_listener(event):
                         "zone": zone_state,
                         "event": trigger_event,
                         "description": f"geo_location - {source}",
+                        "id": trigger_id,
                     }
                 },
                 event.context,

homeassistant/components/homeassistant/triggers/event.py

@@ -31,6 +31,7 @@ async def async_attach_trigger(
     hass, config, action, automation_info, *, platform_type="event"
 ):
     """Listen for events based on configuration."""
+    trigger_id = automation_info.get("trigger_id") if automation_info else None
     variables = None
     if automation_info:
         variables = automation_info.get("variables")
@@ -95,6 +96,7 @@ def handle_event(event):
                     "platform": platform_type,
                     "event": event,
                     "description": f"event '{event.event_type}'",
+                    "id": trigger_id,
                 }
             },
             event.context,

homeassistant/components/homeassistant/triggers/homeassistant.py

@@ -19,6 +19,7 @@
 
 async def async_attach_trigger(hass, config, action, automation_info):
     """Listen for events based on configuration."""
+    trigger_id = automation_info.get("trigger_id") if automation_info else None
     event = config.get(CONF_EVENT)
     job = HassJob(action)
 
@@ -34,6 +35,7 @@ def hass_shutdown(event):
                         "platform": "homeassistant",
                         "event": event,
                         "description": "Home Assistant stopping",
+                        "id": trigger_id,
                     }
                 },
                 event.context,
@@ -51,6 +53,7 @@ def hass_shutdown(event):
                     "platform": "homeassistant",
                     "event": event,
                     "description": "Home Assistant starting",
+                    "id": trigger_id,
                 }
             },
         )

homeassistant/components/homeassistant/triggers/numeric_state.py

@@ -78,6 +78,7 @@ async def async_attach_trigger(
     attribute = config.get(CONF_ATTRIBUTE)
     job = HassJob(action)
 
+    trigger_id = automation_info.get("trigger_id") if automation_info else None
     _variables = {}
     if automation_info:
         _variables = automation_info.get("variables") or {}
@@ -139,6 +140,7 @@ def call_action():
                         "to_state": to_s,
                         "for": time_delta if not time_delta else period[entity_id],
                         "description": f"numeric state of {entity_id}",
+                        "id": trigger_id,
                     }
                 },
                 to_s.context,

homeassistant/components/homeassistant/triggers/state.py

@@ -87,6 +87,7 @@ async def async_attach_trigger(
     attribute = config.get(CONF_ATTRIBUTE)
     job = HassJob(action)
 
+    trigger_id = automation_info.get("trigger_id") if automation_info else None
     _variables = {}
     if automation_info:
         _variables = automation_info.get("variables") or {}
@@ -140,6 +141,7 @@ def call_action():
                         "for": time_delta if not time_delta else period[entity],
                         "attribute": attribute,
                         "description": f"state of {entity}",
+                        "id": trigger_id,
                     }
                 },
                 event.context,

homeassistant/components/homeassistant/triggers/time.py

@@ -39,6 +39,7 @@
 
 async def async_attach_trigger(hass, config, action, automation_info):
     """Listen for state changes based on configuration."""
+    trigger_id = automation_info.get("trigger_id") if automation_info else None
     entities = {}
     removes = []
     job = HassJob(action)
@@ -54,6 +55,7 @@ def time_automation_listener(description, now, *, entity_id=None):
                     "now": now,
                     "description": description,
                     "entity_id": entity_id,
+                    "id": trigger_id,
                 }
             },
         )

homeassistant/components/homeassistant/triggers/time_pattern.py

@@ -57,6 +57,7 @@ def __call__(self, value):
 
 async def async_attach_trigger(hass, config, action, automation_info):
     """Listen for state changes based on configuration."""
+    trigger_id = automation_info.get("trigger_id") if automation_info else None
     hours = config.get(CONF_HOURS)
     minutes = config.get(CONF_MINUTES)
     seconds = config.get(CONF_SECONDS)
@@ -78,6 +79,7 @@ def time_automation_listener(now):
                     "platform": "time_pattern",
                     "now": now,
                     "description": "time pattern",
+                    "id": trigger_id,
                 }
             },
         )

homeassistant/components/homekit_controller/device_trigger.py

@@ -75,11 +75,14 @@ async def async_attach_trigger(
         automation_info: dict,
     ) -> CALLBACK_TYPE:
         """Attach a trigger."""
+        trigger_id = automation_info.get("trigger_id") if automation_info else None
 
         def event_handler(char):
             if config[CONF_SUBTYPE] != HK_TO_HA_INPUT_EVENT_VALUES[char["value"]]:
                 return
-            self._hass.async_create_task(action({"trigger": config}))
+            self._hass.async_create_task(
+                action({"trigger": {**config, "id": trigger_id}})
+            )
 
         trigger = self._triggers[config[CONF_TYPE], config[CONF_SUBTYPE]]
         iid = trigger["characteristic"]

homeassistant/components/kodi/device_trigger.py

@@ -61,16 +61,21 @@ async def async_get_triggers(hass: HomeAssistant, device_id: str) -> list[dict]:
 
 @callback
 def _attach_trigger(
-    hass: HomeAssistant, config: ConfigType, action: AutomationActionType, event_type
+    hass: HomeAssistant,
+    config: ConfigType,
+    action: AutomationActionType,
+    event_type,
+    automation_info: dict,
 ):
+    trigger_id = automation_info.get("trigger_id") if automation_info else None
     job = HassJob(action)
 
     @callback
     def _handle_event(event: Event):
         if event.data[ATTR_ENTITY_ID] == config[CONF_ENTITY_ID]:
             hass.async_run_hass_job(
                 job,
-                {"trigger": {**config, "description": event_type}},
+                {"trigger": {**config, "description": event_type, "id": trigger_id}},
                 event.context,
             )
 
@@ -85,9 +90,9 @@ async def async_attach_trigger(
 ) -> CALLBACK_TYPE:
     """Attach a trigger."""
     if config[CONF_TYPE] == "turn_on":
-        return _attach_trigger(hass, config, action, EVENT_TURN_ON)
+        return _attach_trigger(hass, config, action, EVENT_TURN_ON, automation_info)
 
     if config[CONF_TYPE] == "turn_off":
-        return _attach_trigger(hass, config, action, EVENT_TURN_OFF)
+        return _attach_trigger(hass, config, action, EVENT_TURN_OFF, automation_info)
 
     return lambda: None

homeassistant/components/litejet/trigger.py

@@ -31,6 +31,7 @@
 
 async def async_attach_trigger(hass, config, action, automation_info):
     """Listen for events based on configuration."""
+    trigger_id = automation_info.get("trigger_id") if automation_info else None
     number = config.get(CONF_NUMBER)
     held_more_than = config.get(CONF_HELD_MORE_THAN)
     held_less_than = config.get(CONF_HELD_LESS_THAN)
@@ -50,6 +51,7 @@ def call_action():
                     CONF_HELD_MORE_THAN: held_more_than,
                     CONF_HELD_LESS_THAN: held_less_than,
                     "description": f"litejet switch #{number}",
+                    "id": trigger_id,
                 }
             },
         )

homeassistant/components/mqtt/trigger.py

@@ -37,6 +37,7 @@
 
 async def async_attach_trigger(hass, config, action, automation_info):
     """Listen for state changes based on configuration."""
+    trigger_id = automation_info.get("trigger_id") if automation_info else None
     topic = config[CONF_TOPIC]
     wanted_payload = config.get(CONF_PAYLOAD)
     value_template = config.get(CONF_VALUE_TEMPLATE)
@@ -78,6 +79,7 @@ def mqtt_automation_listener(mqttmsg):
                 "payload": mqttmsg.payload,
                 "qos": mqttmsg.qos,
                 "description": f"mqtt topic {mqttmsg.topic}",
+                "id": trigger_id,
             }
 
             with suppress(ValueError):

homeassistant/components/philips_js/device_trigger.py

@@ -45,6 +45,7 @@ async def async_attach_trigger(
     automation_info: dict,
 ) -> CALLBACK_TYPE | None:
     """Attach a trigger."""
+    trigger_id = automation_info.get("trigger_id") if automation_info else None
     registry: DeviceRegistry = await async_get_registry(hass)
     if config[CONF_TYPE] == TRIGGER_TYPE_TURN_ON:
         variables = {
@@ -53,6 +54,7 @@ async def async_attach_trigger(
                 "domain": DOMAIN,
                 "device_id": config[CONF_DEVICE_ID],
                 "description": f"philips_js '{config[CONF_TYPE]}' event",
+                "id": trigger_id,
             }
         }
 

homeassistant/components/sun/trigger.py

@@ -26,6 +26,7 @@
 
 async def async_attach_trigger(hass, config, action, automation_info):
     """Listen for events based on configuration."""
+    trigger_id = automation_info.get("trigger_id") if automation_info else None
     event = config.get(CONF_EVENT)
     offset = config.get(CONF_OFFSET)
     description = event
@@ -44,6 +45,7 @@ def call_action():
                     "event": event,
                     "offset": offset,
                     "description": description,
+                    "id": trigger_id,
                 }
             },
         )

homeassistant/components/tag/trigger.py

@@ -18,6 +18,7 @@
 
 async def async_attach_trigger(hass, config, action, automation_info):
     """Listen for tag_scanned events based on configuration."""
+    trigger_id = automation_info.get("trigger_id") if automation_info else None
     tag_ids = set(config[TAG_ID])
     device_ids = set(config[DEVICE_ID]) if DEVICE_ID in config else None
 
@@ -37,6 +38,7 @@ async def handle_event(event):
                     "platform": DOMAIN,
                     "event": event,
                     "description": "Tag scanned",
+                    "id": trigger_id,
                 }
             },
             event.context,

homeassistant/components/template/trigger.py

@@ -31,6 +31,7 @@ async def async_attach_trigger(
     hass, config, action, automation_info, *, platform_type="template"
 ):
     """Listen for state changes based on configuration."""
+    trigger_id = automation_info.get("trigger_id") if automation_info else None
     value_template = config.get(CONF_VALUE_TEMPLATE)
     value_template.hass = hass
     time_delta = config.get(CONF_FOR)
@@ -100,6 +101,7 @@ def template_listener(event, updates):
         trigger_variables = {
             "for": time_delta,
             "description": description,
+            "id": trigger_id,
         }
 
         @callback

homeassistant/components/webhook/trigger.py

@@ -17,7 +17,7 @@
 )
 
 
-async def _handle_webhook(job, hass, webhook_id, request):
+async def _handle_webhook(job, trigger_id, hass, webhook_id, request):
     """Handle incoming webhook."""
     result = {"platform": "webhook", "webhook_id": webhook_id}
 
@@ -28,18 +28,20 @@ async def _handle_webhook(job, hass, webhook_id, request):
 
     result["query"] = request.query
     result["description"] = "webhook"
+    result["id"] = trigger_id
     hass.async_run_hass_job(job, {"trigger": result})
 
 
 async def async_attach_trigger(hass, config, action, automation_info):
     """Trigger based on incoming webhooks."""
+    trigger_id = automation_info.get("trigger_id") if automation_info else None
     webhook_id = config.get(CONF_WEBHOOK_ID)
     job = HassJob(action)
     hass.components.webhook.async_register(
         automation_info["domain"],
         automation_info["name"],
         webhook_id,
-        partial(_handle_webhook, job),
+        partial(_handle_webhook, job, trigger_id),
     )
 
     @callback

homeassistant/components/zone/trigger.py

@@ -37,6 +37,7 @@ async def async_attach_trigger(
     hass, config, action, automation_info, *, platform_type: str = "zone"
 ) -> CALLBACK_TYPE:
     """Listen for state changes based on configuration."""
+    trigger_id = automation_info.get("trigger_id") if automation_info else None
     entity_id = config.get(CONF_ENTITY_ID)
     zone_entity_id = config.get(CONF_ZONE)
     event = config.get(CONF_EVENT)
@@ -80,6 +81,7 @@ def zone_automation_listener(zone_event):
                         "zone": zone_state,
                         "event": event,
                         "description": description,
+                        "id": trigger_id,
                     }
                 },
                 to_s.context,

homeassistant/helpers/trigger.py

@@ -72,8 +72,9 @@ async def async_initialize_triggers(
     }
 
     triggers = []
-    for conf in trigger_config:
+    for idx, conf in enumerate(trigger_config):
         platform = await _async_get_trigger_platform(hass, conf)
+        info = {**info, "trigger_id": f"{idx}"}
         triggers.append(platform.async_attach_trigger(hass, conf, action, info))
 
     attach_results = await asyncio.gather(*triggers, return_exceptions=True)