From 2bcd9ecfbb99d4d67780b9e08d9f89f264e9b086 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Wed, 4 Sep 2024 10:43:00 +0200 Subject: [PATCH] Event docs and integration: add related links (#34569) --- source/_docs/configuration/events.markdown | 27 +++++++++++++--------- source/_integrations/event.markdown | 2 ++ 2 files changed, 18 insertions(+), 11 deletions(-) diff --git a/source/_docs/configuration/events.markdown b/source/_docs/configuration/events.markdown index 627114b8c2b..01d5cbce076 100644 --- a/source/_docs/configuration/events.markdown +++ b/source/_docs/configuration/events.markdown @@ -1,6 +1,11 @@ --- title: "Events" description: "Describes all there is to know about events in Home Assistant." +related: + - docs: /docs/automation/trigger/#event-trigger + title: Event triggers + - docs: /integrations/event/ + title: Event integration --- The core of Home Assistant is the event bus. The event bus allows any integration to fire or listen for events. It is the core of everything. @@ -28,12 +33,12 @@ In addition, all events contain a `data` dictionary with event-specific informat This event is fired when an service action is performed -| Field | Description | -| ----------------- | ------------------------------------------------------------------------------ | -| `domain` | Domain of the action. Example: `light`. | -| `service` | The service action that is performed. Example: `turn_on` | +| Field | Description | +| ----------------- | ---------------------------------------------------------------------- | +| `domain` | Domain of the action. Example: `light`. | +| `service` | The service action that is performed. Example: `turn_on` | | `service_data` | Dictionary with the call parameters. Example: `{ 'brightness': 120 }`. | -| `service_call_id` | String with a unique call id. Example: `23123-4`. | +| `service_call_id` | String with a unique call id. Example: `23123-4`. | ### `component_loaded` @@ -98,19 +103,19 @@ If you want to trigger automation on a Home Assistant stop event, we recommend u This event is fired when a new service action has been registered within Home Assistant. -| Field | Description | -| --------- | ----------------------------------------------------------------------- | +| Field | Description | +| --------- | ------------------------------------------------------------------------ | | `domain` | The domain of the integration that offers this action. Example: `light`. | -| `service` | The name of the service action. Example: `turn_on` | +| `service` | The name of the service action. Example: `turn_on` | ### `service_removed` This event is fired when a service action has been removed from Home Assistant. -| Field | Description | -| --------- | ----------------------------------------------------------------------- | +| Field | Description | +| --------- | ------------------------------------------------------------------------ | | `domain` | The domain of the integration that offers this action. Example: `light`. | -| `service` | The name of the service action. Example: `turn_on` | +| `service` | The name of the service action. Example: `turn_on` | ### `state_changed` diff --git a/source/_integrations/event.markdown b/source/_integrations/event.markdown index c0e4378e5e0..eaa4f6d0c5e 100644 --- a/source/_integrations/event.markdown +++ b/source/_integrations/event.markdown @@ -10,6 +10,8 @@ ha_codeowners: - '@home-assistant/core' ha_integration_type: entity related: + - docs: /docs/automation/trigger/#event-trigger + title: Event triggers - docs: /docs/configuration/customizing-devices/ title: Customizing devices - docs: /dashboards/