From 321275e2a670476793e3050ee33bc50749a94ab6 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Wed, 17 Jul 2024 10:39:22 +0200 Subject: [PATCH] Rename Services to Actions: several tweaks (#33845) --- source/_docs/automation/action.markdown | 4 ++-- source/_docs/configuration/basic.markdown | 2 +- source/_docs/configuration/events.markdown | 20 ++++++++++---------- source/_docs/scripts/service-calls.markdown | 2 +- source/_docs/tools/dev-tools.markdown | 2 +- source/_docs/tools/quick-bar.markdown | 2 +- source/_includes/asides/docs_sitemap.html | 2 +- source/dashboards/dashboards.markdown | 2 +- 8 files changed, 18 insertions(+), 18 deletions(-) diff --git a/source/_docs/automation/action.markdown b/source/_docs/automation/action.markdown index ca876ce108d..ab37fb54837 100644 --- a/source/_docs/automation/action.markdown +++ b/source/_docs/automation/action.markdown @@ -34,10 +34,10 @@ automation 2: event: sunset offset: -00:30 variables: - notification_service: notify.paulus_iphone + notification_action: notify.paulus_iphone action: # Actions are scripts so can also be a list of actions - - service: "{{ notification_service }}" + - service: "{{ notification_action }}" data: message: "Beautiful sunset!" - delay: 0:35 diff --git a/source/_docs/configuration/basic.markdown b/source/_docs/configuration/basic.markdown index 791dabc7783..016a622a5d1 100644 --- a/source/_docs/configuration/basic.markdown +++ b/source/_docs/configuration/basic.markdown @@ -13,7 +13,7 @@ As part of the default onboarding process, Home Assistant can detect your locati Screenshot showing the General settings page.

-The general settings described here are managed by the [Home Assistant Core integration](/integrations/homeassistant/). If you are interested in the services offered by this integration, check out the integration documentation. +The general settings described here are managed by the [Home Assistant Core integration](/integrations/homeassistant/). If you are interested in the actions offered by this integration, check out the integration documentation. ## Editing the general settings diff --git a/source/_docs/configuration/events.markdown b/source/_docs/configuration/events.markdown index 30548a0aeb0..627114b8c2b 100644 --- a/source/_docs/configuration/events.markdown +++ b/source/_docs/configuration/events.markdown @@ -26,13 +26,13 @@ In addition, all events contain a `data` dictionary with event-specific informat ### `call_service` -This event is fired when a service is called. +This event is fired when an service action is performed | Field | Description | | ----------------- | ------------------------------------------------------------------------------ | -| `domain` | Domain of the service. Example: `light`. | -| `service` | The service to call. Example: `turn_on` | -| `service_data` | Dictionary with the service call parameters. Example: `{ 'brightness': 120 }`. | +| `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`. | ### `component_loaded` @@ -96,21 +96,21 @@ If you want to trigger automation on a Home Assistant stop event, we recommend u ### `service_registered` -This event is fired when a new service has been registered within Home Assistant. +This event is fired when a new service action has been registered within Home Assistant. | Field | Description | | --------- | ----------------------------------------------------------------------- | -| `domain` | The domain of the integration that offers this service. Example: `light`. | -| `service` | The name of the service. Example: `turn_on` | +| `domain` | The domain of the integration that offers this action. Example: `light`. | +| `service` | The name of the service action. Example: `turn_on` | ### `service_removed` -This event is fired when a service has been removed from Home Assistant. +This event is fired when a service action has been removed from Home Assistant. | Field | Description | | --------- | ----------------------------------------------------------------------- | -| `domain` | The domain of the integration that offers this service. Example: `light`. | -| `service` | The name of the service. Example: `turn_on` | +| `domain` | The domain of the integration that offers this action. Example: `light`. | +| `service` | The name of the service action. Example: `turn_on` | ### `state_changed` diff --git a/source/_docs/scripts/service-calls.markdown b/source/_docs/scripts/service-calls.markdown index ea7c4b92d08..ab9676ae411 100644 --- a/source/_docs/scripts/service-calls.markdown +++ b/source/_docs/scripts/service-calls.markdown @@ -129,7 +129,7 @@ data: > Some actions may respond with data that can be used in automation. This data is called _action response data_. Action response data is typically used for data that is dynamic or large and which may not be suited for use in entity state. -Examples of service response data are upcoming calendar events for the next week or detailed driving directions. +Examples of action response data are upcoming calendar events for the next week or detailed driving directions. Templates can also be used for handling response data. The action can specify a `response_variable`. This is the [variable](/docs/scripts/#variables) diff --git a/source/_docs/tools/dev-tools.markdown b/source/_docs/tools/dev-tools.markdown index 57f8b3bf9e7..d6504dda3ba 100644 --- a/source/_docs/tools/dev-tools.markdown +++ b/source/_docs/tools/dev-tools.markdown @@ -57,7 +57,7 @@ The attribute filter supports separate filters for attribute names and values, s ## Actions tab -This section is used to perform actions that are available in the ServiceRegistry. +This section is used to perform actions that are available in Home Assistant. The list of actions in the **Actions** dropdown are automatically populated based on the integrations that are found in the configuration, automation and script files. If a desired action does not exist, it means either the integration is not configured properly or not defined in the configuration, automation or script files. diff --git a/source/_docs/tools/quick-bar.markdown b/source/_docs/tools/quick-bar.markdown index ae4c666b182..df86c08417d 100644 --- a/source/_docs/tools/quick-bar.markdown +++ b/source/_docs/tools/quick-bar.markdown @@ -57,7 +57,7 @@ Run various commands from anywhere without having to navigate to another view. Type | Available | | ------------- | ------------- | | Navigate | All entries in the sidebar and settings | -| Reload | All currently-supported "Reload {domain}" services.
*(E.g., "Reload Scripts")* | +| Reload | All currently-supported "Reload {domain}" actions.
*(E.g., "Reload Scripts")* | | Server | Restart/Stop | ## My links diff --git a/source/_includes/asides/docs_sitemap.html b/source/_includes/asides/docs_sitemap.html index 50361edec2c..c736bebd972 100644 --- a/source/_includes/asides/docs_sitemap.html +++ b/source/_includes/asides/docs_sitemap.html @@ -41,7 +41,7 @@ {% icon "mdi:script-text" %} {% active_link /docs/scripts/ Scripts %} {% if doc == 'scripts' or include.docs_index %} {% endif %} diff --git a/source/dashboards/dashboards.markdown b/source/dashboards/dashboards.markdown index ae7370fd31d..36b8c09cfc2 100644 --- a/source/dashboards/dashboards.markdown +++ b/source/dashboards/dashboards.markdown @@ -181,7 +181,7 @@ mode: type: string resources: required: false - description: "List of resources that should be loaded. Only use this when mode is `yaml`. If you change anything here, click the three dots {% icon "mdi:dots-vertical" %} menu (top-right) and click on `Reload resources` to pick up changes without restarting Home Assistant. You can also call `lovelace.reload_resources` service directly." + description: "List of resources that should be loaded. Only use this when mode is `yaml`. If you change anything here, click the three dots {% icon "mdi:dots-vertical" %} menu (top-right) and click on `Reload resources` to pick up changes without restarting Home Assistant. You can also call `lovelace.reload_resources` action directly." type: list keys: url: