jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-25 10:17:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename Services to Actions in integrations: S (#33827)

Browse Source 
* Rename Services to Actions in integrations: S

* Update source/_integrations/scene.markdown

* Update source/_integrations/scene.markdown

* tweaks

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Franck Nijhof 2024-07-17 07:40:05 +02:00 committed by GitHub
parent c8eb4f4750
commit 2602651bdc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
52 changed files with 291 additions and 290 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
source/_integrations/sabnzbd.markdown
View File

@ -45,29 +45,29 @@ This integration will create these sensors:
- `monthly_total`: GB downloaded this month. (disabled by default)
## Services
## Actions
Available services:
Available actions:
- `pause`: Pause the download queue.
- `resume`: Resume the download queue.
- `set_speed`: Set the download queue speed limit.
### Service `sabnzbd.pause`
### Action `sabnzbd.pause`
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
|------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `api_key` | no | The SABnzbd API key of the service instance (unique per SABnzbd integration). |
### Service `sabnzbd.resume`
### Action `sabnzbd.resume`
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
|------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `api_key` | no | The SABnzbd API key of the service instance (unique per SABnzbd integration). |
### Service `sabnzbd.set_speed`
### Action `sabnzbd.set_speed`
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
|------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `speed` | yes | Sets the download speed limit. If specified as a number with no units, will be interpreted as a percent. If units are provided (e.g., 500K) will be interpreted absolutely. Defaults to 100 |
| `api_key` | no | The SABnzbd API key of the service instance (unique per SABnzbd integration). |

4
source/_integrations/samsungtv.markdown
View File

@ -53,7 +53,7 @@ Any other [actions](/docs/automation/action/) to power on the device can be conf
#### Changing channels
Changing channels can be done by calling the `media_player.play_media` service
Changing channels can be done by calling the `media_player.play_media` action
with the following payload:
```yaml
@ -69,7 +69,7 @@ Some older models also expose the installed applications through the WebSocket,
### Remote
The integration supports the `remote` platform. The remote allows you to send key commands to your TV with the `remote.send_command` service. The supported keys vary between TV models.
The integration supports the `remote` platform. The remote allows you to send key commands to your TV with the `remote.send_command` action. The supported keys vary between TV models.
{% details "Full keycodes list" %}

20
source/_integrations/scene.markdown
View File

@ -23,17 +23,17 @@ The scene entity is stateless, as in, it cannot have a state like the `on` or
Every scene entity does keep track of the timestamp of when the last time
the scene entity was called via the Home Assistant UI or called via
a service call.
an action.
## Scenes created by integrations
Some integrations like [Philips Hue](/integrations/hue), [MQTT](/integrations/mqtt), and [KNX](/integrations/knx) provide scenes. You can activate them from the Home Assistant UI or via as service calls. In this case, the integration provides the preferred states to restore.
Some integrations like [Philips Hue](/integrations/hue), [MQTT](/integrations/mqtt), and [KNX](/integrations/knx) provide scenes. You can activate them from the Home Assistant UI or via as an action. In this case, the integration provides the preferred states to restore.
## Creating a scene
You can create scenes that capture the states you want certain entities to be. For example, a scene can specify that light A should be turned on and light B should be bright red.
Scenes can be created and managed via the user interface using the [Scene Editor](/docs/scene/editor/). They can also be manually configured via {% term "`configuration.yaml`" %}. Note that the entity data is not service call parameters, it's a representation of the wanted state:
Scenes can be created and managed via the user interface using the [Scene Editor](/docs/scene/editor/). They can also be manually configured via {% term "`configuration.yaml`" %}. Note that entity data is not an action parameter; it's a representation of the wanted state:
```yaml
# Example configuration.yaml entry
@ -86,7 +86,7 @@ As you can see, there are two ways to define the states of each `entity_id`:
- Define the `state` directly with the entity. Be aware, that `state` needs to be defined.
- Define a complex state with its attributes. You can see all attributes available for a particular entity under `developer-tools -> state`.
Scenes can be activated using the service `scene.turn_on` (there is no 'scene.turn_off' service).
Scenes can be activated using the `scene.turn_on` action (there is no `scene.turn_off` action).
```yaml
# Example automation
@ -104,7 +104,7 @@ automation:
## Applying a scene without defining it
With the `scene.apply` service you are able to apply a scene without first defining it via configuration. Instead, you pass the states as part of the service data. The format of the data is the same as the `entities` field in a configuration.
With the `scene.apply` action you are able to apply a scene without first defining it via configuration. Instead, you pass the states as part of the action data. The format of the data is the same as the `entities` field in a configuration.
```yaml
# Example automation
@ -129,7 +129,7 @@ automation:
## Using scene transitions
Both the `scene.apply` and `scene.turn_on` services support setting a transition,
Both the `scene.apply` and `scene.turn_on` actions support setting a transition,
which enables you to smoothen the transition to the scene.
This is an example of an automation that sets a romantic scene, in which the
@ -157,11 +157,11 @@ only lights to have a transition set.
## Reloading scenes
Whenever you make a change to your scene configuration, you can call the `scene.reload` service to reload the scenes.
Whenever you make a change to your scene configuration, you can call the `scene.reload` action to reload the scenes.
## Creating scenes on the fly
Create a new scene without having to configure it by calling the `scene.create` service. This scene will be discarded after reloading the configuration.
Create a new scene without having to configure it by calling the `scene.create` action. This scene will be discarded after reloading the configuration.
You need to pass a `scene_id` in lowercase and with underscores instead of spaces. You also may want to specify the entities in the same format as when configuring the scene. You can also take a snapshot of the current state by using the `snapshot_entities` parameter. In this case, you have to specify the `entity_id` of all entities you want to take a snapshot of. `entities` and `snapshot_entities` can be combined but you have to use at least one of them.
@ -194,11 +194,11 @@ automation:
## Deleting dynamically created scenes
Any scene that you have created with the `scene.create` service can also be deleted on demand with the `scene.delete` service.
Any scene that you have created with the `scene.create` action can also be deleted on demand with the `scene.delete` action.
You will need to pass in the `entity_id` of such a scene. As opposed to the `scene_id` used for creation, the `entity_id` must also include the `scene` domain.
If the scene was not previously created by `scene.create`, the service call will fail and an error will appear in the logs.
If the scene was not previously created by `scene.create`, the action will fail and an error will appear in the logs.
```yaml
# Example automation

8
source/_integrations/schedule.markdown
View File

@ -17,7 +17,7 @@ Home Assistant that can be used to trigger or make decisions in your
automations and scripts.
The preferred way to configure a schedule is via the user interface at
**{% my helpers title="Settings > Devices & Services > Helpers." %}** Click the add button
**{% my helpers title="Settings > Devices & services > Helpers." %}** Click the add button
and then choose the **{% my config_flow_start domain=schedule title="Schedule" %}** option, or click the My button below.
{% include integrations/config_flow.md %}
@ -118,10 +118,10 @@ trigger:
entity_id: climate.thermostat
```
### Services
### Actions
Available service: `schedule.reload`.
Available action: `schedule.reload`.
#### schedule.reload
`schedule.reload` service allows one to reload the schedule's configuration without restarting Home Assistant itself.
`schedule.reload` action allows one to reload the schedule's configuration without restarting Home Assistant itself.

2
source/_integrations/scrape.markdown
View File

@ -184,7 +184,7 @@ scrape:
### Available implementations
Get the counter for all our implementations from the integrations page under {% my integrations title="**Settings** > **Devices & Services**" %}.
Get the counter for all our implementations from the integrations page under {% my integrations title="**Settings** > **Devices & services**" %}.
{% raw %}

10
source/_integrations/screenlogic.markdown
View File

@ -32,17 +32,17 @@ The Pentair ScreenLogic integration allows you to integrate your Pentair Intelli
## Options
ScreenLogic options are set via **Settings** -> **Devices & Services** -> **Pentair ScreenLogic** -> **Options**.
ScreenLogic options are set via **Settings** > **Devices & services** > **Pentair ScreenLogic** > **Options**.
-= Seconds between scans - How many seconds between each polling of the ScreenLogic gateway.
## Services
## Actions
### `screenlogic.set_color_mode`
Sets the operation of any connected color-capable lights.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------------------------------------------------------------------------------- |
| `config_entry` | no | Integration entry_id of the ScreenLogic instance you wish to set the color mode on. |
| `color_mode` | no | The color mode to set. Valid values are listed below. |
@ -51,7 +51,7 @@ Sets the operation of any connected color-capable lights.
Begins super chlorination, running for the specified period or 24 hours if none is specified.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------------------------------------------------------------------------------------- |
| `config_entry` | no | Integration entry_id of the ScreenLogic instance you wish to start super chlorination on. |
| `runtime` | yes | Number of hours to run super chlorination for. Defaults to 24 hours. |
@ -60,7 +60,7 @@ Begins super chlorination, running for the specified period or 24 hours if none
Stops super chlorination.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------------------------- |
| `config_entry` | no | Integration entry_id of the ScreenLogic instance you wish to stop super chlorination on. |

16
source/_integrations/script.markdown
View File

@ -11,7 +11,7 @@ ha_domain: script
ha_integration_type: system
---
The script integration allows users to specify a sequence of actions to be executed by Home Assistant. These are run when you turn the script on. The script integration will create an entity for each script and allow them to be controlled via services.
The script integration allows users to specify a sequence of actions to be executed by Home Assistant. These are run when you turn the script on. The script integration will create an entity for each script and allow them to be controlled via actions.
Scripts can be created via YAML configuration (described below) or via {% my scripts title="the UI" %}.
@ -50,7 +50,7 @@ icon:
required: false
type: string
description:
description: A description of the script that will be displayed in the Services tab under Developer Tools.
description: A description of the script that will be displayed in the **Actions** tab under **Developer tools**.
required: false
default: ''
type: string
@ -88,7 +88,7 @@ fields:
type: boolean
default: false
example:
description: An example value. This will only be shown in table of options available in the Services tab of the Developer Tools.
description: An example value. This will only be shown in table of options available in the **Actions** tab of the **Developer tools**.
type: string
default:
description: The default value for this field, as shown in the UI.
@ -135,7 +135,7 @@ Mode | Description
### Passing variables to scripts
As part of the service, variables can be passed along to a script so they become available within templates in that script.
As part of the action, variables can be passed along to a script so they become available within templates in that script.
To configure a script to accept variables using the UI, the variables can be added as fields in the script editor.
1. In the script editor, in the 3-dots menu, select **Add fields**.
@ -170,7 +170,7 @@ script:
```
{% endraw %}
Aside from the automation editor UI, variables can be passed to scripts within the service data. This can be used either by calling the script directly or the generic `script.turn_on` service. The difference is described in [Waiting for Script to Complete](#waiting-for-script-to-complete). All service data will be made available as variables in templates, even if not specified as fields in the script. This example shows how to call the script directly:
Aside from the automation editor UI, variables can be passed to scripts within the action data. This can be used either by calling the script directly or the generic `script.turn_on` action. The difference is described in [Waiting for Script to Complete](#waiting-for-script-to-complete). All action data will be made available as variables in templates, even if not specified as fields in the script. This example shows how to call the script directly:
{% raw %}
```yaml
@ -189,7 +189,7 @@ automation:
```
{% endraw %}
This example shows using `script.turn_on` service:
This example shows using `script.turn_on` action:
{% raw %}
```yaml
@ -217,7 +217,7 @@ automation:
Script variables that may be used by templates include the following:
- those provided from the configuration as fields
- those that are passed as data when started from a service,
- those that are passed as data when started from an action,
- the `this` variable the value of which is a dictionary of the current script's state.
{% endnote %}
@ -227,7 +227,7 @@ Script variables that may be used by templates include the following:
When calling a script "directly" (e.g., `script.NAME`) the calling script will wait for the called script to finish.
If any errors occur that cause the called script to abort, the calling script will be aborted as well.
When calling a script (or multiple scripts) via the `script.turn_on` service the calling script does _not_ wait. It starts the scripts, in the order listed, and continues as soon as the last script is started.
When calling a script (or multiple scripts) via the `script.turn_on` action the calling script does _not_ wait. It starts the scripts, in the order listed, and continues as soon as the last script is started.
Any errors that occur in the called scripts that cause them to abort will _not_ affect the calling script.
<p class='img'>

38
source/_integrations/select.markdown
View File

@ -17,19 +17,19 @@ a limited set of selectable options for the entity.
{% include integrations/building_block_integration.md %}
## Services
## Actions
The select entity exposes additional services to control the entity in, for example,
automation or scripts. These services can be created via the UI, but are
The select entity exposes additional actions to control the entity in, for example,
automation or scripts. These actions can be created via the UI, but are
also available in YAML (for which examples are provided below).
### Service `select.select_first`
### Action `select.select_first`
The {% my developer_call_service service="select.select_first" %} service
The {% my developer_call_service service="select.select_first" %} action
changes the selected option of the select entity to the first option in the
list of options available.
This service does not have additional options.
This action does not have additional options.
{% my developer_call_service badge service="select.select_first" %}
@ -41,13 +41,13 @@ target:
entity_id: select.my_entity
```
### Service `select.select_last`
### Action `select.select_last`
The {% my developer_call_service service="select.select_last" %} service changes
The {% my developer_call_service service="select.select_last" %} action changes
the selected option of the select entity to the last option in the list of
options available.
This service does not have additional options.
This action does not have additional options.
{% my developer_call_service badge service="select.select_last" %}
@ -59,9 +59,9 @@ target:
entity_id: select.my_entity
```
### Service `select.select_next`
### Action `select.select_next`
The {% my developer_call_service service="select.select_next" %} service changes
The {% my developer_call_service service="select.select_next" %} action changes
the selected option of the select entity to the next option in the list of
options available. If the current select option is unknown, the first option
in the list is selected instead.
@ -69,7 +69,7 @@ in the list is selected instead.
In case the current select option is the last option in the list, it will by
default, cycle back the first option and select that one instead. This cycle
behavior can be disabled by setting the `cycle` option to `false` in the
service call data.
action data.
{% my developer_call_service badge service="select.select_next" %}
@ -90,13 +90,13 @@ data:
cycle: false
```
### Service `select.select_option`
### Action `select.select_option`
The {% my developer_call_service service="select.select_option" %} service
The {% my developer_call_service service="select.select_option" %} action
changes the selected option to a specific desired option provided in the
service call using the required `option` service call data.
action using the required `option` action data.
The service call will not succeed if the selected option is not available in
The action call will not succeed if the selected option is not available in
the list of options for the targeted entity.
{% my developer_call_service badge service="select.select_option" %}
@ -111,9 +111,9 @@ data:
option: "example_option"
```
### Service `select.select_previous`
### Action `select.select_previous`
The {% my developer_call_service service="select.select_previous" %} service
The {% my developer_call_service service="select.select_previous" %} action
changes the selected option of the select entity to the previous option in the
list of options available. If the current select option is unknown, the
last option in the list is selected instead.
@ -121,7 +121,7 @@ last option in the list is selected instead.
In case the current select option is the first option in the list, it will by
default, cycle back the last option and select that one instead. This cycle
behavior can be disabled by setting the `cycle` option to `false` in the
service call data.
action data.
{% my developer_call_service badge service="select.select_previous" %}

2
source/_integrations/sendgrid.markdown
View File

@ -37,7 +37,7 @@ notify:
{% configuration %}
name:
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the `notify.NOTIFIER_NAME` action.
required: false
default: notify
type: string

28
source/_integrations/sensibo.markdown
View File

@ -137,25 +137,25 @@ For climate devices, these switches are available:
Support to enable/disable a timer to delay a start or stop (depending on the current state) of your device.
The switch uses a timer of 60 minutes delay. You can choose a custom delay using the custom `sensibo.enable_timer` service. See [Timer](#timer).
The switch uses a timer of 60 minutes delay. You can choose a custom delay using the custom `sensibo.enable_timer` action. See [Timer](#timer).
Support to enable/disable Climate React
Usage of the Climate React switch requires that the service has been configured previously in the app or by using the custom `sensibo.enable_climate_react` service. See [Climate React](#climate-react)
Usage of the Climate React switch requires that the action has been configured previously in the app or by using the custom `sensibo.enable_climate_react` action. See [Climate React](#climate-react)
For Pure devices, this integration provides support to enable/disable Pure Boost.
To customize the settings of Pure Boost, you can use the custom `sensibo.enable_pure_boost` service. See [Pure Boost](#pure-boost)
To customize the settings of Pure Boost, you can use the custom `sensibo.enable_pure_boost` action. See [Pure Boost](#pure-boost)
## Custom services
## Custom actions
### Full state
You can send a full state command to Sensibo instead of single commands using the service `sensibo.full_state`.
You can send a full state command to Sensibo instead of single commands using the `sensibo.full_state` action.
All fields are required to be according to Sensibo API specifications and are case-sensitive.
To see the options for each field to use this service:
To see the options for each field to use this action:
1. Switch to the relevant HVAC mode (not all HVAC modes have the same options).
2. Retrieve the options for `fan_modes` and `swing_modes` from the climate entity's attributes.
@ -163,29 +163,29 @@ To see the options for each field to use this service:
### Assume state
For devices which are also controlled in other ways or often goes out of sync with Sensibo there is a `sensibo.assume_state` service.
For devices which are also controlled in other ways or often goes out of sync with Sensibo there is a `sensibo.assume_state` action.
With this service you can tell Sensibo if your device is currently running or not without sending a new command to you device.
With this action you can tell Sensibo if your device is currently running or not without sending a new command to you device.
### Pure Boost
You can configure your Pure Boost settings using the services `sensibo.enable_pure_boost`.
You can configure your Pure Boost settings using the `sensibo.enable_pure_boost` action.
- Enable Pure Boost will enable the service with configured settings
- Enable Pure Boost will enable the action with configured settings
Using Geo integration for Pure Boost is only possible by pre-configuration of Presence within the app.
### Timer
You can enable a timer with a custom delay using the service `sensibo.enable_timer` that is provided.
You can enable a timer with a custom delay using the `sensibo.enable_timer` action that is provided.
### Climate React
You can configure your Climate React settings using the services `sensibo.enable_climate_react`.
You can configure your Climate React settings using the `sensibo.enable_climate_react` action.
- Configuring this service also turns Climate React on
- Configuring this action also turns Climate React on
When using the service, the state needs to be set to precisely what Sensibo API expects. The first time it's recommended to use the app to configure it. From that point, you can see what the API requires and how to write from the Climate React switch attribute.
When using the action, the state needs to be set to precisely what Sensibo API expects. The first time it's recommended to use the app to configure it. From that point, you can see what the API requires and how to write from the Climate React switch attribute.
Example for low threshold state:

2
source/_integrations/sentry.markdown
View File

@ -44,6 +44,6 @@ The Sentry integration provides settings to:
- Ability to send out events originating from third-party Python packages.
- Enable performance tracing and tune the tracing sample rate used.
To change the settings, go to {% my integrations title="**Settings** > **Devices & Services**" %}. Select the **Sentry** integration. Then, select **Options**.
To change the settings, go to {% my integrations title="**Settings** > **Devices & services**" %}. Select the **Sentry** integration. Then, select **Options**.
After changing the Sentry settings, you'll need to restart Home Assistant in order to make them effective.

8
source/_integrations/seventeentrack.markdown
View File

@ -73,14 +73,14 @@ content: >
{% endraw %}
## Services
## Actions
### Service `seventeentrack.get_packages`
### Action `seventeentrack.get_packages`
The `seventeentrack.get_packages` service allows you to query the 17track API for the latest package data.
The `seventeentrack.get_packages` action allows you to query the 17track API for the latest package data.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
|------------------------|----------|---------------------------------------------|
| `config_entry_id` | No | The ID of the 17Track service config entry. |
| `package_state` | yes | A list of the package states. |

15
source/_integrations/sharkiq.markdown
View File

@ -19,9 +19,9 @@ The `sharkiq` integration allows you to control your [Shark IQ](https://www.shar
{% include integrations/config_flow.md %}
## Services
## Actions
Currently supported [`vacuum`](/integrations/vacuum/) services are:
Currently supported [`vacuum`](/integrations/vacuum/) actions are:
- `start`
- `pause`
@ -31,7 +31,8 @@ Currently supported [`vacuum`](/integrations/vacuum/) services are:
- `set_fan_speed`
### Room Targeting
In addition to the [`vacuum`](/integrations/vacuum/) services, this integration supports room targeting.
In addition to the [`vacuum`](/integrations/vacuum/) actions, this integration supports room targeting.
This allows you to select specific rooms that you want cleaned, instead of doing a whole-home clean.
```yaml
@ -43,11 +44,11 @@ data:
target:
entity_id: vacuum.my_vacuum
```
**Important Note:** The list of rooms must be written _exactly_ as they appear in the Shark Clean app. If you want exact names that the service will understand,
**Important Note:** The list of rooms must be written _exactly_ as they appear in the Shark Clean app. If you want exact names that the action will understand,
look for the `Rooms` attribute of your Shark Robot Vacuum in Home Assistant. This will be populated with the rooms that the robot has configured, as they will be
understood by the service.
understood by the action.
If you want to use the area selector in the service's UI, you need to format the area names exactly as they appear in the vacuum's `Rooms` attribute. You may also check the attribute using Home Assistant's [Developer Tools](https://www.home-assistant.io/docs/tools/dev-tools/).
If you want to use the area selector in the action's UI, you need to format the area names exactly as they appear in the vacuum's `Rooms` attribute. You may also check the attribute using Home Assistant's [Developer Tools](https://www.home-assistant.io/docs/tools/dev-tools/).
<p class='img'>
<img src='/images/integrations/sharkiq/sharkiq-room-service-attributes.png' />
</p>
@ -58,4 +59,4 @@ If you want to use the area selector in the service's UI, you need to format the
If the integration frequently disconnects and you have an ad blocker runner like [Pi-hole](https://pi-hole.net/) or [AdGuard](https://adguard.com) add `ads-field.aylanetworks.com` to the Allow list . This domain is needed for the connection and can be part of the automatic blocking because of `ads` being part of the subdomain.
If `pause` does not work for you, then it is not supported by your vacuum. The `stop` service will provide similar functionality.
If `pause` does not work for you, then it is not supported by your vacuum. The `stop` action will provide similar functionality.

8
source/_integrations/shell_command.markdown
View File

@ -12,7 +12,7 @@ ha_domain: shell_command
ha_integration_type: integration
---
This integration can expose regular shell commands as services. Services can be called from a [script] or in [automation].
This integration can expose regular shell commands as actions. Actions can be called from a [script] or in [automation].
Shell commands aren't allowed for a camel-case naming, please use lowercase naming only and separate the names with underscores.
Note that the shell command process will be terminated after 60 seconds, full stop. There is no option to alter this behavior, this is by design because Home Assistant is not intended to manage long-running external processes.
@ -24,7 +24,7 @@ Note that the shell command process will be terminated after 60 seconds, full st
```yaml
# Example configuration.yaml entry
# Exposes service shell_command.restart_pow
# Exposes action shell_command.restart_pow
shell_command:
restart_pow: touch ~/.pow/restart.txt
```
@ -38,7 +38,7 @@ alias:
The commands can be dynamic, using templates to insert values for arguments. When using templates, shell_command runs in a more secure environment which doesn't allow any shell helpers like automatically expanding the home dir `~` or using pipe symbols to run multiple commands. Similarly, only content after the first space can be generated by a template. This means the command name itself cannot be generated by a template, but it must be literally provided.
Any service data passed into the service call to activate the shell command will be available as a variable within the template.
Any action data passed into the action to activate the shell command will be available as a variable within the template.
`stdout` and `stderr` output from the command are both captured and will be logged by setting the [log level](/integrations/logger/) to debug.
@ -54,7 +54,7 @@ A `0` exit code means the commands completed successfully without error. In case
## Response
Shell commands provide a service response in a dictionary containing `stdout`, `stderr`, and `returncode`. These can be used in automations to act upon the command results using [`response_variable`](/docs/scripts/service-calls#use-templates-to-handle-response-data).
Shell commands provide an action response in a dictionary containing `stdout`, `stderr`, and `returncode`. These can be used in automations to act upon the command results using [`response_variable`](/docs/scripts/service-calls#use-templates-to-handle-response-data).
## Examples

6
source/_integrations/shelly.markdown
View File

@ -255,9 +255,9 @@ Shelly lights supporting light transition:
The firmware limits the transition time to 5 seconds.
{% endnote %}
## Device services
## Device actions
The integration offers device services which can be triggered by a configuration button.
The integration offers device actions which can be triggered by a configuration button.
### OTA firmware update
@ -337,4 +337,4 @@ Please check from the device Web UI that the configured server is reachable.
- Generation 1 "Shelly 4Pro" and "Shelly Sense" are not supported (devices based on old CoAP v1 protocol)
- Before set up, battery-powered devices must be woken up by pressing the button on the device.
- For battery-powered devices, the `update` platform entities only inform about the availability of firmware updates but are not able to trigger the update process.
- Using the `homeassistant.update_entity` service for an entity belonging to a battery-powered device is not possible because most of the time these devices are sleeping (are offline).
- Using the `homeassistant.update_entity` action for an entity belonging to a battery-powered device is not possible because most of the time these devices are sleeping (are offline).

30
source/_integrations/shopping_list.markdown
View File

@ -20,59 +20,59 @@ Your shopping list will be accessible from the sidebar, and you can optionally a
{% include integrations/config_flow.md %}
## Services
## Actions
You can add or remove items from your shopping list by using the following services.
You can add or remove items from your shopping list by using the following actions.
### Service `shopping_list.add_item`
### Action `shopping_list.add_item`
Add an item to the shopping list.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------- |
| `name` | no | Name of the item to add. Example: "Milk" |
### Service `shopping_list.remove_item`
### Action `shopping_list.remove_item`
Remove the first item with matching name from the shopping list.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------- |
| `name` | no | Name of the item to remove. Example: "Milk" |
### Service `shopping_list.complete_item`
### Action `shopping_list.complete_item`
Mark the first item with matching name as completed in the shopping list. It does not remove the item.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------ |
| `name` | no | Name of the item to mark as completed. Example: "Milk" |
### Service `shopping_list.incomplete_item`
### Action `shopping_list.incomplete_item`
Mark the first item with matching name as incomplete in the shopping list.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------- |
| `name` | no | Name of the item to mark as incomplete. Example: "Milk" |
### Service `shopping_list.complete_all`
### Action `shopping_list.complete_all`
Mark all items as completed in the shopping list (without removing them from the list).
### Service `shopping_list.incomplete_all`
### Action `shopping_list.incomplete_all`
Mark all items as incomplete in the shopping list.
### Service `shopping_list.clear_completed_items`
### Action `shopping_list.clear_completed_items`
Clear completed items from the shopping list.
### Service `shopping_list.sort`
### Action `shopping_list.sort`
Sort all items by name in the shopping list.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------- |
| `reverse` | yes | Whether to sort in reverse (_descending_) order. (default: `False`) |

6
source/_integrations/sighthound.markdown
View File

@ -20,7 +20,7 @@ This {% term integration %} adds an image processing entity where the state of t
If `save_file_folder` is configured, on each new detection of a person, an annotated image with the name `sighthound_{camera_name}_latest.jpg` is saved in the configured folder if it doesn't already exist, and overwritten if it does exist. The saved image shows the bounding box around detected people and can be displayed on the Home Assistant front end using a [Local File](/integrations/local_file/) camera, and used in notifications. If `save_timestamped_file` is configured as `true`, then the annotated image is saved with a file name that includes the time of detection.
**Note** that by default the {% term integration %} will not automatically scan images, but requires you to call the `image_processing.scan` service, e.g., using an automation triggered by motion.
**Note** that by default the {% term integration %} will not automatically scan images, but requires you to call the `image_processing.scan` action, e.g., using an automation triggered by motion.
## Configuration
@ -73,11 +73,11 @@ To verify the integration, check if a new entity is appeared as `image_processin
## Process an Image
When you want to process an image, you have to call `image_processing.scan` service and listen to the `sighthound.person_detected` and/or `sighthound.vehicle_detected` events.
When you want to process an image, you have to call `image_processing.scan` action and listen to the `sighthound.person_detected` and/or `sighthound.vehicle_detected` events.
An example using two automations:
- The first automation is triggered, when a motion is detected. It calls the `image_processing.scan` service to send the camera image to the sighthound server for processing.
- The first automation is triggered, when a motion is detected. It calls the `image_processing.scan` action to send the camera image to the sighthound server for processing.
- The second automation is triggered by a `sighthound.vehicle_detected` event. It sends a notification to a phone.

4
source/_integrations/signal_messenger.markdown
View File

@ -51,7 +51,7 @@ To obtain the Signal Messenger group ids, follow [this guide]( https://github.co
{% configuration %}
name:
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the `notify.NOTIFIER_NAME` action.
required: false
type: string
default: notify
@ -70,7 +70,7 @@ recipients:
{% endconfiguration %}
## Notification Service
## Notification action
### Examples

2
source/_integrations/simplepush.markdown
View File

@ -28,7 +28,7 @@ If you enter your password and salt (as defined in the Simplepush app settings)
## Notifications
Simplepush can send a notification by calling the [`notify` service](/integrations/notify/).
Simplepush can send a notification by calling the [`notify` action](/integrations/notify/).
You can specify the `event` under the `data` key.
Events can be used to customize the notification behavior.

8
source/_integrations/simplisafe.markdown
View File

@ -54,13 +54,13 @@ You must have multi-factor authentication (MFA) enabled on your SimpliSafe accou
SimpliSafe authenticates users via its web app. Due to technical limitations, there is a manual step when adding the integration. For in-depth guidance, refer to step 6 of [the `simplisafe-python` documentation on authentication](https://simplisafe-python.readthedocs.io/en/latest/usage.html#authentication).
## Services
## Actions
### `simplisafe.remove_pin`
Remove a SimpliSafe PIN (by label or PIN value).
| Service Data Attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | -------------------------------- |
| `label_or_pin` | no | The PIN label or value to remove |
@ -68,7 +68,7 @@ Remove a SimpliSafe PIN (by label or PIN value).
Set a SimpliSafe PIN.
| Service Data Attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | -------------------------------------- |
| `label` | no | The label to show in the SimpliSafe UI |
| `pin` | no | The PIN value to use |
@ -77,7 +77,7 @@ Set a SimpliSafe PIN.
Set one or more system properties.
| Service Data Attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------------- |
| `alarm_duration` | yes | The number of seconds a triggered alarm should sound |
| `chime_volume` | yes | The volume of the door chime |

4
source/_integrations/sinch.markdown
View File

@ -37,7 +37,7 @@ notify:
{% configuration %}
name:
description: "Setting the optional parameter name allows multiple notifiers to be created. The default value is `Sinch`. The notifier will bind to the service `notify.NOTIFIER_NAME`."
description: "Setting the optional parameter name allows multiple notifiers to be created. The default value is `Sinch`. The notifier will bind to the `notify.NOTIFIER_NAME` action."
required: false
type: string
service_plan_id:
@ -49,7 +49,7 @@ api_key:
required: true
type: string
default_recipient:
description: "A single or multiple phone numbers. This is where you want to send your SMS notification messages by default (when not specifying `target` in the service call), e.g., `09171234567` or `[09171234567, 09177654321]`."
description: "A single or multiple phone numbers. This is where you want to send your SMS notification messages by default (when not specifying `target` in the action), e.g., `09171234567` or `[09171234567, 09177654321]`."
required: false
type: [string, list]
sender:

20
source/_integrations/siren.markdown
View File

@ -16,21 +16,21 @@ The Siren integration is built for the controlling and monitoring of siren/chime
{% include integrations/building_block_integration.md %}
## Services
## Actions
### siren services
### Siren actions
Available services: `siren.turn_on`, `siren.turn_off`, `siren.toggle`
Available actions: `siren.turn_on`, `siren.turn_off`, `siren.toggle`
### Service `siren.turn_on`
### Action `siren.turn_on`
Turn the siren on.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of sirens to control.
There are three optional input parameters that can be passed into the service call depending on whether or not your device supports them. Check the device's integration documentation for more details.
There are three optional input parameters that can be passed into the action depending on whether or not your device supports them. Check the device's integration documentation for more details.
| Parameter Name | Input Type | Notes |
|---------------- |-------------------------|-------------------------------------------------------------------------------------|
@ -38,18 +38,18 @@ There are three optional input parameters that can be passed into the service ca
| `duration` | `integer` | |
| `volume_level` | `float` between 0 and 1 | |
### Service `siren.turn_off`
### Action `siren.turn_off`
Turn the siren off.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of sirens to control.
### Service `siren.toggle`
### Action `siren.toggle`
Toggle the siren on/off.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of sirens to control.

10
source/_integrations/siren.mqtt.markdown
View File

@ -69,16 +69,16 @@ available_tones:
required: false
type: list
command_template:
description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate a custom payload to send to `command_topic`. The variable `value` will be assigned with the configured `payload_on` or `payload_off` setting. The siren turn on service parameters `tone`, `volume_level` or `duration` can be used as variables in the template. When operation in optimistic mode the corresponding state attributes will be set. Turn on parameters will be filtered if a device misses the support.
description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate a custom payload to send to `command_topic`. The variable `value` will be assigned with the configured `payload_on` or `payload_off` setting. The siren turn on action parameters `tone`, `volume_level` or `duration` can be used as variables in the template. When operation in optimistic mode the corresponding state attributes will be set. Turn on parameters will be filtered if a device misses the support.
required: false
type: template
command_off_template:
description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate a custom payload to send to `command_topic` when the siren turn off service is called. By default `command_template` will be used as template for service turn off. The variable `value` will be assigned with the configured `payload_off` setting.
description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate a custom payload to send to `command_topic` when the siren turn off action is called. By default `command_template` will be used as template for action turn off. The variable `value` will be assigned with the configured `payload_off` setting.
required: false
type: template
command_topic:
description: >
The MQTT topic to publish commands to change the siren state. Without command templates, a default JSON payload like `{"state":"ON", "tone": "bell", "duration": 10, "volume_level": 0.5 }` is published. When the siren turn on service is called, the startup parameters will be added to the JSON payload. The `state` value of the JSON payload will be set to the the `payload_on` or `payload_off` configured payload.
The MQTT topic to publish commands to change the siren state. Without command templates, a default JSON payload like `{"state":"ON", "tone": "bell", "duration": 10, "volume_level": 0.5 }` is published. When the siren turn on action is performed, the startup parameters will be added to the JSON payload. The `state` value of the JSON payload will be set to the the `payload_on` or `payload_off` configured payload.
required: false
type: string
device:
@ -219,12 +219,12 @@ state_value_template:
required: false
type: template
support_duration:
description: Set to `true` if the MQTT siren supports the `duration` service turn on parameter and enables the `duration` state attribute.
description: Set to `true` if the MQTT siren supports the `duration` turn on action parameter and enables the `duration` state attribute.
required: false
type: boolean
default: true
support_volume_set:
description: Set to `true` if the MQTT siren supports the `volume_set` service turn on parameter and enables the `volume_level` state attribute.
description: Set to `true` if the MQTT siren supports the `volume_set` turn on action parameter and enables the `volume_level` state attribute.
required: false
type: boolean
default: true

6
source/_integrations/slack.markdown
View File

@ -94,7 +94,7 @@ Icon/Username:
One of the easiest ways to send a message, is to create a script. You can paste in YAML and make changes in the GUI.
You can call this script as a service.
You can call this script as an action.
1. Go to Home Assistant Settings > Automations and Scenes > Scripts > Add Script
2. Click the three dots in the top right, and pick 'Edit in YAML'. Paste in the contents below.
@ -133,9 +133,9 @@ One sensor entity will be created:
- **Do Not Disturb Timer**: The amount of time left for Do Not Disturb status.
### Slack Service Data
### Slack action data
The following attributes can be placed inside the `data` key of the service call for extended functionality:
The following attributes can be placed inside the `data` key of the action for extended functionality:
| Attribute | Optional | Description |
| ----------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

2
source/_integrations/smappee.markdown
View File

@ -72,7 +72,7 @@ smappee:
client_secret: YOUR_CLIENT_SECRET
```
Once Home Assistant restarted, go to Settings > Devices & Services and select the Smappee integration. You will be redirected to a login page and be able to select the locations you would like to use within Home Assistant.
Once Home Assistant restarted, go to **Settings** > **Devices & services** and select the Smappee integration. You will be redirected to a login page and be able to select the locations you would like to use within Home Assistant.
Using the Smappee cloud integration allows you to access your Smappee monitor and other shared devices from outside your local network. Additionally a number of (binary) sensor entities become available as well.

26
source/_integrations/smarttub.markdown
View File

@ -32,44 +32,44 @@ The `smarttub` integration allows you to view and control hot tubs which use the
{% include integrations/config_flow.md %}
## Services
## Actions
### Service `smarttub.set_primary_filtration`
### Action `smarttub.set_primary_filtration`
This service allows you to update the settings for the primary filtration cycle
This action allows you to update the settings for the primary filtration cycle
on a hot tub.
| Service data attribute | Optional | Description | Example |
| Data attribute | Optional | Description | Example |
| ---------------------- | -------- | ----------- | ------- |
| `entity_id` | no | The entity to update. | sensor.jacuzzi_j_335_primary_filtration_cycle
| `duration` | no | The desired duration of the primary filtration cycle, in hours. | 4
| `start_hour` | no | The desired starting hour of the day for the primary filtration cycle. | 2 (i.e. 02:00 or 2:00am)
### Service `smarttub.set_secondary_filtration`
### Action `smarttub.set_secondary_filtration`
This service allows you to update the settings for the secondary filtration
This action allows you to update the settings for the secondary filtration
cycle on a hot tub.
| Service data attribute | Optional | Description | Example |
| Data attribute | Optional | Description | Example |
| ---------------------- | -------- | ----------- | ------- |
| `entity_id` | no | The entity to update. | sensor.jacuzzi_j_335_secondary_filtration_cycle
| `mode` | no | The desired secondary filtration mode. Can be frequent, infrequent or away. | away
### Service `smarttub.snooze_reminder`
### Action `smarttub.snooze_reminder`
This service allows you to temporarily suppress a maintenance reminder on a hot tub.
This action allows you to temporarily suppress a maintenance reminder on a hot tub.
| Service data attribute | Optional | Description | Example |
| Data attribute | Optional | Description | Example |
| ---------------------- | -------- | ----------- | ------- |
| `entity_id` | no | The entity to update. | binary_sensor.jacuzzi_j_335_refresh_water_reminder
| `days` | no | The number of days to snooze the reminder (minimum 10). | 10
### Service `smarttub.reset_reminder`
### Action `smarttub.reset_reminder`
This service allows you to reset a maintenance reminder on a hot tub.
This action allows you to reset a maintenance reminder on a hot tub.
| Service data attribute | Optional | Description | Example |
| Data attribute | Optional | Description | Example |
| ---------------------- | -------- | ----------- | ------- |
| `entity_id` | no | The entity to update. | binary_sensor.jacuzzi_j_335_refresh_water_reminder
| `days` | no | The number of days when reminder should trigger next (minimum 30). | 180

6
source/_integrations/smtp.markdown
View File

@ -28,7 +28,7 @@ Check your email provider configuration or help pages to get the correct SMTP se
{% configuration %}
name:
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the `notify.NOTIFIER_NAME` action.
required: false
type: string
default: notify
@ -37,7 +37,7 @@ sender:
required: true
type: string
recipient:
description: Default email address of the recipient of the notification. This can be a recipient address or a list of addresses for multiple recipients.<br>This is where you want to send your email notifications by default (when not specifying `target` in the service call). Any email address(es) specified in the service call's `target` field will override this recipient content.
description: Default email address of the recipient of the notification. This can be a recipient address or a list of addresses for multiple recipients.<br>This is where you want to send your email notifications by default (when not specifying `target` in the action). Any email address(es) specified in the action's `target` field will override this recipient content.
required: true
type: [list, string]
server:
@ -105,7 +105,7 @@ A notify integration will be created using the name without spaces. In the above
mode: single
```
The optional `target` field is used to specify recipient(s) for this specific service call. When `target` field is not used, this message will be sent to default recipient(s), specified in the `recipient` part of the smtp notifier in `configuration.yaml`. Line breaks can be added in the body part of the email by using `\r\n`, for instance `message: "Rise and shine\r\n\r\nIt's a brand new day!"`
The optional `target` field is used to specify recipient(s) for this specific action. When `target` field is not used, this message will be sent to default recipient(s), specified in the `recipient` part of the smtp notifier in `configuration.yaml`. Line breaks can be added in the body part of the email by using `\r\n`, for instance `message: "Rise and shine\r\n\r\nIt's a brand new day!"`
Another example attaching images stored locally in a script:

26
source/_integrations/snapcast.markdown
View File

@ -18,48 +18,48 @@ The Snapcast integration allows you to control [Snapcast](https://github.com/bad
{% include integrations/config_flow.md %}
## Services
## Actions
The snapcast integration provides a few services registered under the media_player integration.
The snapcast integration provides a few actions registered under the media_player integration.
### Service `snapcast.snapshot`
### Action `snapcast.snapshot`
Take a snapshot of what is currently playing on one or more speakers. This service, and the following one, are useful if you want to play a doorbell or notification sound and resume playback afterwards.
Take a snapshot of what is currently playing on one or more speakers. This action, and the following one, are useful if you want to play a doorbell or notification sound and resume playback afterwards.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | The speakers to snapshot.
### Service `snapcast.restore`
### Action `snapcast.restore`
Restore a previously taken snapshot of one or more speakers.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of `entity_id`s that should have their snapshot restored.
### Service `snapcast.join`
### Action `snapcast.join`
Group players together under a single group.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `master` | no | Entity ID of the player to synchronize to.
| `entity_id` | yes | String or list of `entity_id`s to join to the master.
### Service `snapcast.unjoin`
### Action `snapcast.unjoin`
Remove one or more speakers from their group of speakers.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of `entity_id`s to separate from their coordinator speaker.
### Service `snapcast.set_latency`
### Action `snapcast.set_latency`
Set the latency of a speaker.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of `entity_id`s for which latency will be adjusted.
| `latency` | no | Latency in ms.

12
source/_integrations/snips.markdown
View File

@ -79,7 +79,7 @@ Note that if you already have an assistant installed and wish to replace it then
Make sure that a microphone is plugged to the Raspberry Pi. If you are having trouble setting up audio, we have written a guide on [Raspberry Pi Microphones](https://docs.snips.ai/articles/raspberrypi/hardware/microphones).
Start the Snips Voice Platform by starting the `snips-*` services:
Start the Snips Voice Platform by starting the `snips-*` actions:
```bash
sudo systemctl start "snips-*"
@ -192,19 +192,19 @@ SetTimer:
### Sending TTS Notifications
You can send TTS notifications to Snips using the `snips.say` and `snips.say_action` services. `say_action` starts a session and waits for user response, "Would you like me to close the garage door?", "Yes, close the garage door".
You can send TTS notifications to Snips using the `snips.say` and `snips.say_action` actions. `say_action` starts a session and waits for user response, "Would you like me to close the garage door?", "Yes, close the garage door".
#### Service `snips.say`
#### Action `snips.say`
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
|------------------------|----------|--------------------------------------------------------|
| `text` | no | Text to say. |
| `site_id` | yes | Site to use to start session. |
| `custom_data` | yes | custom data that will be included with all messages in this session. |
#### Service `snips.say_action`
#### Action `snips.say_action`
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
|------------------------|----------|--------------------------------------------------------|
| `text` | no | Text to say. |
| `site_id` | yes | Site to use to start session. |

10
source/_integrations/snooz.markdown
View File

@ -50,15 +50,15 @@ Fan speed percentage is mapped to the device volume level.
Speed percentages less than 10 have no effect - they all map to a value of 1 on the device.
{% endnote %}
## Services
## Actions
### Service `snooz.transition_on`
### Action `snooz.transition_on`
Transition the volume level over the specified duration. If the device is powered off, the transition will start at the lowest volume level.
{% my developer_call_service badge service="snooz.transition_on" %}
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `duration` | yes | Number of seconds to transition to target volume.
| `volume` | yes | Percentage volume level. If not specified, the volume on the device is used.
@ -79,7 +79,7 @@ automation:
duration: 120
```
### Service `snooz.transition_off`
### Action `snooz.transition_off`
Transition the volume level to the lowest setting over the specified duration, then power off the device.
@ -89,7 +89,7 @@ Once the transition completes, the volume level is restored to the value before
{% my developer_call_service badge service="snooz.transition_off" %}
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `duration` | yes | Number of seconds to complete the transition.

2
source/_integrations/somfy_mylink.markdown
View File

@ -18,4 +18,4 @@ The `Somfy MyLink` integration is used as an interface to a compatible Somfy MyL
{% include integrations/config_flow.md %}
If any of your devices are reversed, they can be adjusted in **Settings** -> **Devices & Services** -> **Somfy MyLink** >> `Options`.
If any of your devices are reversed, they can be adjusted in **Settings** > **Devices & services** > **Somfy MyLink** > **Options**.

10
source/_integrations/songpal.markdown
View File

@ -28,21 +28,21 @@ A few notes:
- The quick start-up mode has to be enabled in order to turn the device on.
- Supports currently only one output terminal, i.e., the volume control works only on the first volume controller as reported by the backend library.
- Some devices, e.g., HT-XT3, do not support decreasing the volume step-by-step correctly.
- Feel free to improve the available services!
- Feel free to improve the available actions!
{% include integrations/config_flow.md %}
See [python-songpal's documentation](https://github.com/rytilahti/python-songpal#locating-the-endpoint) how to get your API endpoint.
## Services
## Actions
In addition to the general [media player services](/integrations/media_player/#services), the following services are provided:
In addition to the general [media player actions](/integrations/media_player/#actions), the following actions are provided:
### Service `songpal/set_sound_setting`
### Action `songpal/set_sound_setting`
For a list of available settings and their values use [`songpal sound`](https://github.com/rytilahti/python-songpal#sound-settings) command.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
|------------------------|----------|--------------------------------------------------|
| `entity_id` | yes | Target entity. To target all songpal devices, use `all` |
| `name` | no | Configuration variable, e.g., `nightmode` |

50
source/_integrations/sonos.markdown
View File

@ -67,9 +67,9 @@ The microphone can only be enabled/disabled from physical buttons on the Sonos d
The favorites sensor provides the names and `media_content_id` values for each of the favorites saved to My Sonos in the native Sonos app. This sensor is intended for users that need to access the favorites in a custom template. For most users, accessing favorites by using the Media Browser functionality and "Play media" script/automation action is recommended.
When calling the `media_player.play_media` service, the `media_content_type` must be set to "favorite_item_id" and the `media_content_id` must be set to just the key portion of the favorite item.
When calling the `media_player.play_media` action, the `media_content_type` must be set to "favorite_item_id" and the `media_content_id` must be set to just the key portion of the favorite item.
Example service call using the item id:
Example action using the item id:
```yaml
service: media_player.play_media
@ -119,17 +119,17 @@ The Sonos favorites sensor (`sensor.sonos_favorites`) is disabled by default. It
## Playing media
Sonos accepts a variety of `media_content_id` formats in the `media_player.play_media` service, but most commonly as URIs. For example, both Spotify and Tidal share links can be provided as-is. Playback of [music hosted on a Plex server](/integrations/plex#sonos-playback) is possible. Direct HTTP/HTTPS links to local or remote media files can also be used if the Sonos device can reach the URI directly, but specific media encoding support may vary.
Sonos accepts a variety of `media_content_id` formats in the `media_player.play_media` action, but most commonly as URIs. For example, both Spotify and Tidal share links can be provided as-is. Playback of [music hosted on a Plex server](/integrations/plex#sonos-playback) is possible. Direct HTTP/HTTPS links to local or remote media files can also be used if the Sonos device can reach the URI directly, but specific media encoding support may vary.
Music services which require an account (e.g., Spotify) must first be configured using the Sonos app.
Playing TTS (text-to-speech) or audio files as alerts (e.g., a doorbell or alarm) is possible by setting the `announce` argument to `true`. Using `announce` will play the provided media URL as an overlay, gently lowering the current music volume and automatically restoring to the original level when finished. An optional `volume` argument can also be provided in the `extra` dictionary to play the alert at a specific volume level. Note that older Sonos hardware or legacy firmware versions ("S1") may not fully support these features. Additionally, see [Network Requirements](#network-requirements) for use in restricted networking environments.
An optional `enqueue` argument can be added to the service call. If `replace` or not provided then the queue will be replaced and the item will be replaced. If `add` the item will be appended to the queue. If `next` the item will be added into the queue to play next. If `play`, the item will be added into the queue and played immediately.
An optional `enqueue` argument can be added to the action. If `replace` or not provided then the queue will be replaced and the item will be replaced. If `add` the item will be appended to the queue. If `next` the item will be added into the queue to play next. If `play`, the item will be added into the queue and played immediately.
### Examples:
Below is an example service call that plays an audio file from a web server on the local network (like the Home Assistant built-in webserver) using the `announce` feature and its associated (optional) `volume` parameter:
Below is an example action that plays an audio file from a web server on the local network (like the Home Assistant built-in webserver) using the `announce` feature and its associated (optional) `volume` parameter:
```yaml
service: media_player.play_media
@ -143,7 +143,7 @@ data:
volume: 20
```
The standard `tts.<source>_say` services do not accept the `volume` parameter directly. To set the `volume` for a TTS announcement, you can use a TTS Media Source URL with the standard `media_player.play_media` service:
The standard `tts.<source>_say` actions do not accept the `volume` parameter directly. To set the `volume` for a TTS announcement, you can use a TTS Media Source URL with the standard `media_player.play_media` action:
```yaml
service: media_player.play_media
target:
@ -157,7 +157,7 @@ data:
volume: 80
```
Sonos can also play music or playlists from Spotify. Both Spotify URIs and URLs can be used directly. An example service call using a playlist URI:
Sonos can also play music or playlists from Spotify. Both Spotify URIs and URLs can be used directly. An example action using a playlist URI:
```yaml
service: media_player.play_media
@ -169,7 +169,7 @@ data:
enqueue: true
```
An example service call using a Spotify URL:
An example action using a Spotify URL:
```yaml
service: media_player.play_media
@ -267,24 +267,24 @@ data:
enqueue: play
```
## Services
## Actions
The Sonos integration makes various custom services available in addition to the [standard media player services](/integrations/media_player/#services).
The Sonos integration makes various custom actions available in addition to the [standard media player actions](/integrations/media_player/#actions).
### Service `sonos.snapshot`
### Action `sonos.snapshot`
Take a snapshot of what is currently playing on one or more speakers. This service, and the following one, are useful if you want to play a doorbell or notification sound and resume playback afterwards.
Take a snapshot of what is currently playing on one or more speakers. This action, and the following one, are useful if you want to play a doorbell or notification sound and resume playback afterwards.
{% note %}
The queue is not snapshotted and must be left untouched until the restore. Using `media_player.play_media` is safe and can be used to play a notification sound, including [TTS](/integrations/tts/) announcements.
{% endnote %}
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | The speakers to snapshot. To target all Sonos devices, use `all`.
| `with_group` | yes | Should we also snapshot the group layout and the state of other speakers in the group, defaults to true.
### Service `sonos.restore`
### Action `sonos.restore`
Restore a previously taken snapshot of one or more speakers.
@ -296,33 +296,33 @@ The playing queue is not snapshotted. Using `sonos.restore` on a speaker that ha
A cloud queue cannot be restarted. This includes queues started from within Spotify and queues controlled by Amazon Alexa.
{% endnote %}
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of `entity_id`s that should have their snapshot restored. To target all Sonos devices, use `all`.
| `with_group` | yes | Should we also restore the group layout and the state of other speakers in the group, defaults to true.
### Service `sonos.set_sleep_timer`
### Action `sonos.set_sleep_timer`
Sets a timer that will turn off a speaker by tapering the volume down to 0 after a certain amount of time. Protip: If you set the sleep_time value to 0, then the speaker will immediately start tapering the volume down.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of `entity_id`s that will have their timers set.
| `sleep_time` | no | Integer number of seconds that the speaker should wait until it starts tapering. Cannot exceed 86399 (one day).
### Service `sonos.clear_sleep_timer`
### Action `sonos.clear_sleep_timer`
Clear the sleep timer on a speaker, if one is set.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of `entity_id`s that will have their timers cleared. Must be a coordinator speaker.
### Service `sonos.update_alarm`
### Action `sonos.update_alarm`
Update an existing Sonos alarm.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of `entity_id`s that will have their timers cleared. Must be a coordinator speaker.
| `alarm_id` | no | Integer that is used in Sonos to refer to your alarm.
@ -331,21 +331,21 @@ Update an existing Sonos alarm.
| `enabled` | yes | Boolean for whether or not to enable this alarm.
| `include_linked_zones` | yes | Boolean that defines if the alarm also plays on grouped players.
### Service `sonos.play_queue`
### Action `sonos.play_queue`
Starts playing the Sonos queue.
Force start playing the queue, allows switching from another stream (such as radio) to playing the queue.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of `entity_id`s that will start playing. It must be the coordinator if targeting a group.
| `queue_position` | yes | Position of the song in the queue to start playing from, starts at 0.
### Service `sonos.remove_from_queue`
### Action `sonos.remove_from_queue`
Removes an item from the queue.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of `entity_id`s that will remove an item from the queue. It must be the coordinator if targeting a group.
| `queue_position` | yes | Position in the queue to remove.

18
source/_integrations/soundtouch.markdown
View File

@ -51,43 +51,43 @@ You can use TTS services like [Google text-to-speech](/integrations/google_trans
A workaround if you want to publish your Home Assistant installation on Internet in SSL is to configure an HTTPS Web Server as a reverse proxy ([NGINX](/docs/ecosystem/nginx/) for example) and let your Home Assistant configuration in HTTP on your local network. The SoundTouch devices will be available to access the TTS files in HTTP in local and your configuration will be in HTTPS on the Internet.
## Services
## Actions
### Service `play_everywhere`
### Action `play_everywhere`
Create a multi-room (zone) from a master and play same content on all other
devices (slaves)
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `master` | no | `entity_id` of the master device
### Service `create_zone`
### Action `create_zone`
Create a multi-room (zone) from a master and play on selected slaves
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `master` | no | `entity_id` of the master device|
| `slaves` | no | List of slaves `entity_id` |
### Service `add_zone_slave`
### Action `add_zone_slave`
Add slave(s) to an existing zone
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------ |
| `master` | no | `entity_id` of the master device |
| `slaves` | no | List of slaves `entity_id` to add|
### Service `remove_zone_slave`
### Action `remove_zone_slave`
Remove slave(s) from an existing zone.
Removing the last slave will destroy the zone. You will need to
create a new zone in order to be able to add slave(s) again
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------- |
| `master` | no | `entity_id` of the master device |
| `slaves` | no | List of slaves `entity_id` to remove |

2
source/_integrations/speedtestdotnet.markdown
View File

@ -22,7 +22,7 @@ The Speedtest.net integration uses the [Speedtest.net](https://speedtest.net/) w
Most Speedtest.net servers require TCP port 8080 outbound to function. Without this port open you may experience significant delays or no results at all. See note on their [help page](https://www.speedtest.net/help).
By default, a speed test will be run every hour. You can disable polling using system options and use the `update_entity` service to automate the speed test frequency.
By default, a speed test will be run every hour. You can disable polling using system options and use the `update_entity` action to automate the speed test frequency.
{% include common-tasks/define_custom_polling.md %}

2
source/_integrations/spotify.markdown
View File

@ -132,7 +132,7 @@ The Spotify API cannot initiate playback to a device not already known to the Sp
## Playing Spotify playlists
You can send playlists to Spotify using the `"media_content_type": "playlist"`, which is part of the
[media_player.play_media](/integrations/media_player/#service-media_playerplay_media) service, for example:
[media_player.play_media](/integrations/media_player/#action-media_playerplay_media) action, for example:
```yaml
# Example script to play playlist

12
source/_integrations/squeezebox.markdown
View File

@ -46,19 +46,19 @@ transporter_toslink:
media_content_type: "music"
```
### Service `call_method`
### Action `call_method`
Call a custom Squeezebox JSON-RPC API.
See documentation for this interface on `http://HOST:PORT/html/docs/cli-api.html?player=` where HOST and PORT are the host name and port for your Lyrion Music Server.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | Name(s) of the Squeezebox entities where to run the API method.
| `command` | no | Command to pass to Lyrion Music Server (p0 in the CLI documentation).
| `parameters` | yes | Array of additional parameters to pass to Lyrion Music Server (p1, ..., pN in the CLI documentation).
This service can be used to integrate any Squeezebox action to an automation.
This action can be used to integrate any Squeezebox action to an automation.
It can also be used to target a Squeezebox from IFTTT (or Dialogflow, Alexa...).
@ -70,19 +70,19 @@ For example, to play an album from your collection, create an IFTTT applet like
This can work with title search and basically any thing. The same wouldn't have worked by calling directly Squeezebox server as IFTTT cannot escape the text field.
### Service `call_query`
### Action `call_query`
Call a custom Squeezebox JSON-RPC API. The result of the query will be stored in the 'query_result' attribute of the player.
See documentation for this interface on `http://HOST:PORT/html/docs/cli-api.html?player=` where HOST and PORT are the host name and port for your Lyrion Music Server.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | Name(s) of the Squeezebox entities where to run the API method.
| `command` | no | Command to pass to Lyrion Music Server (p0 in the CLI documentation).
| `parameters` | yes | Array of additional parameters to pass to Lyrion Music Server (p1, ..., pN in the CLI documentation).
This service can be used to integrate a Squeezebox query into an automation. For example, in a Python script, you can get a list of albums available by an artist like this:
This action can be used to integrate a Squeezebox query into an automation. For example, in a Python script, you can get a list of albums available by an artist like this:
`hass.services.call("squeezebox", "call_query", { "entity_id": "media_player.kitchen", "command": "albums", "parameters": ["0", "20", "search:beatles", "tags:al"] })`
To work with the results:
`result = hass.states.get("media_player.kitchen").attributes['query_result']`

16
source/_integrations/starline.markdown
View File

@ -35,7 +35,7 @@ This integration provides the following platforms:
- Sensors: Battery level, SIM card balance, GSM signal level, GPS satellites count, fuel volume, mileage, OBD errors, interior temperature and engine temperature.
- Switches: Start/stop engine, heater (webasto), additional channel, and service mode.
- Buttons: Sound the horn.
- Services: Update the state, set update frequency. More details can be found [here](#services).
- Actions: Update the state, set update frequency. More details can be found [here](#actions).
## Prerequisites
@ -50,27 +50,27 @@ It is not recommended to set an update interval of less than 90 seconds.
{% include integrations/config_flow.md %}
## Services
## Actions
### Update the state
The service `starline.update_state` fetches the last state of the device from the StarLine server.
The `starline.update_state` action fetches the last state of the device from the StarLine server.
This service does not require any attributes.
This action does not require any attributes.
### Set scan interval
The service `starline.set_scan_interval` sets update frequency for entities.
The `starline.set_scan_interval` action sets update frequency for entities.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `scan_interval` | no | Update frequency in seconds.
### Set scan OBD interval
The service `starline.set_scan_obd_interval` sets update frequency for OBD information.
The `starline.set_scan_obd_interval` action sets update frequency for OBD information.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `scan_interval` | no | Update frequency in seconds.

6
source/_integrations/streamlabswater.markdown
View File

@ -29,11 +29,11 @@ In preparation for using this integration you will need to request an API key fo
{% include integrations/config_flow.md %}
## Service `set_away_mode`
## Action `set_away_mode`
You can use the service `streamlabswater.set_away_mode` to set the mode to `home` or `away`. The away mode will only be changed for the configured location.
You can use the `streamlabswater.set_away_mode` action to set the mode to `home` or `away`. The away mode will only be changed for the configured location.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
|------------------------|----------|------------------------------------------------------------------------------------|
| `away_mode` | no | String, must be `away` or `home`. |
| `location_id` | yes | String, location id to change away mode for. Defaults to first available location. |

8
source/_integrations/subaru.markdown
View File

@ -70,9 +70,9 @@ The current lock status is always unknown due to the fact that the Subaru API do
### Unlock specific door
In addition to the standard services built into the lock entity, this integration also provides a `subaru.unlock_specific_door` service to specify a door to unlock.
In addition to the standard actions built into the lock entity, this integration also provides a `subaru.unlock_specific_door` action to specify a door to unlock.
The service requires the `door` parameter which may be set to one of the following:
The action requires the `door` parameter which may be set to one of the following:
- `all`: unlocks all doors
- `driver`: unlocks only the driver's door
@ -86,7 +86,7 @@ Tracks the most recently reported location of the vehicle. The vehicle reports i
Subaru integration options are set via:
**Settings** -> **Devices & Services** -> **Subaru** -> **Options**.
**Settings** -> **Devices & services** -> **Subaru** -> **Options**.
- **Enable vehicle polling *[Default: off]*:** When enabled, vehicle polling will send a remote command to your vehicle every 2 hours to obtain new sensor data. This involves "waking" your vehicle and requesting that it send new data to Subaru servers. Without vehicle polling, new sensor data is only received when the vehicle automatically pushes data (normally after engine shutdown). This option only applies to vehicles with Security Plus subscriptions because it uses a "locate" command to request the data.
@ -127,4 +127,4 @@ Vehicle polling draws power from the 12V battery. Long term use without driving
**Q:** Should I enable the vehicle polling option?
**A:** Probably not. One use case is if you have a PHEV and want to monitor your charging progress. Otherwise, the data isn't going to change much after you've shutdown your vehicle (tire pressures are only updated when the vehicle is in motion). A future revision will expose vehicle polling as a service to enable incorporation into automations.
**A:** Probably not. One use case is if you have a PHEV and want to monitor your charging progress. Otherwise, the data isn't going to change much after you've shutdown your vehicle (tire pressures are only updated when the vehicle is in motion). A future revision will expose vehicle polling as an action to enable incorporation into automations.

2
source/_integrations/sun.markdown
View File

@ -57,7 +57,7 @@ sun:
## Automation trigger
The sun's event listener will call the service when the sun rises or sets with
The sun's event listener will perform the action when the sun rises or sets with
an offset.
The sun trigger need to have the type 'sun', which event (sunset or sunrise) and an optional offset.

14
source/_integrations/surepetcare.markdown
View File

@ -24,13 +24,13 @@ The Sure Petcare integration allows you to get information on your Sure Petcare
{% include integrations/config_flow.md %}
## Services
## Actions
### Service `surepetcare.set_lock_state`
### Action `surepetcare.set_lock_state`
This service lets you change the locking state of a flap.
This action lets you change the locking state of a flap.
| Service data attribute | Required | Type | Description |
| Data attribute | Required | Type | Description |
| ---------------------- | -------- | -------- | ----------- |
| `flap_id` | `True` | integer | Flap ID to change - see below for instructions on finding device ID
| `lock_state` | `True` | string | New state to change the flap to
@ -48,11 +48,11 @@ The `flap_id` can be found following these instructions:
- `locked_out` - flap is 'out only' - pets can go out, but not back in.
- `locked_all` - flap is locked both ways.
### Service `surepetcare.set_pet_location`
### Action `surepetcare.set_pet_location`
This service lets you set the pet location.
This action lets you set the pet location.
| Service data attribute | Required | Type | Description |
| Data attribute | Required | Type | Description |
| ---------------------- | -------- | -------- | ----------- |
| `name` | yes | string | Pet name
| `location` | yes | string | Pet location

8
source/_integrations/switch.markdown
View File

@ -21,7 +21,7 @@ related:
Keeps track which switches are in your environment, their state and allows you to control them.
- Maintains a state per switch and a combined state `all_switches`.
- Registers services `switch.turn_on`, `switch.turn_off`, and `switch.toggle` to control switches.
- Registers actions `switch.turn_on`, `switch.turn_off`, and `switch.toggle` to control switches.
{% include integrations/building_block_integration.md %}
@ -35,14 +35,14 @@ Keeps track which switches are in your environment, their state and allows you t
- **outlet**: A switch for a power outlet.
- **switch**: A generic switch.
## Use the services
## Using the actions
In the frontend open the sidebar. At the bottom, under **Developer Tools**, click **Services**. From the Service dropdown menu choose `switch.turn_on` or `switch.turn_off` from the list of available services. In the Entity dropdown menu choose or enter the entity ID you want to work with. This will enter something like the sample below into the **Service Data** field. Now hit **CALL SERVICE**.
In the frontend open **Settings**. Select **Developer tools**, click **Actions**. From the **Action** dropdown menu choose `switch.turn_on` or `switch.turn_off` from the list of available actions. In the Entity dropdown menu choose or enter the entity ID you want to work with. This will enter something like the sample below into the **data** field. Now select **Perform action**.
```json
{"entity_id":"switch.livingroom_pin2"}
```
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | String or list of strings that point at `entity_id`s of switches. To target all switches, set `entity_id` to `all`. |

2
source/_integrations/switch.template.markdown
View File

@ -167,7 +167,7 @@ switch:
### Multiple actions for turn_on or turn_off
This example shows multiple service calls for turn_on and turn_off.
This example shows multiple actions for turn_on and turn_off.
{% raw %}

2
source/_integrations/switch_as_x.markdown
View File

@ -48,6 +48,6 @@ Type:
## **Change device type of a switch** from the existing entity
Where compatible, **Change device type of a switch** will appear on entity properties. A list of entities can be found in **{% my entities title="Settings > Devices & Services > Entities" %}**.
Where compatible, **Change device type of a switch** will appear on entity properties. A list of entities can be found in **{% my entities title="Settings > Devices & services > Entities" %}**.
![Entity properties example](/images/integrations/switch_as_x/Entities_Properties.png)

4
source/_integrations/switchbot.markdown
View File

@ -122,11 +122,11 @@ The blind tilt is exposed as a cover entity with control of the tilt position on
| 50% | Fully Open |
| 0% | Closed Down |
The close button will close the blinds to the closest closed position (either 0% or 100%), and defaults to closing down if the blinds are fully open. Because Home Assistant believes 100% is open, the default cards will disable the open button when the tilt is at 100%, but the service call will still work and open the blind to 50%.
The close button will close the blinds to the closest closed position (either 0% or 100%), and defaults to closing down if the blinds are fully open. Because Home Assistant believes 100% is open, the default cards will disable the open button when the tilt is at 100%, but the action will still work and open the blind to 50%.
### Simple cover template entity
Some integrations may expose your SwitchBot Blind Tilt to other services which expect that 100% is open and 0% is fully closed. Using a [Cover Template](/integrations/cover.template), a proxy entity can be created which will be open at 100% and closed at 0%. This template entity is limited to closing in one direction.
Some integrations may expose your SwitchBot Blind Tilt to other actions which expect that 100% is open and 0% is fully closed. Using a [Cover Template](/integrations/cover.template), a proxy entity can be created which will be open at 100% and closed at 0%. This template entity is limited to closing in one direction.
{% raw %}

14
source/_integrations/switcher_kis.markdown
View File

@ -59,28 +59,28 @@ For Switcher power control devices (Switcher Power Plug, Switcher Touch, Switche
*Currently not supported for Switcher Power Plug
## Services
## Actions
For Switcher power control devices (Switcher Touch, Switcher V2/V4) the integration provides the following sensors:
### Service: `switcher_kis.set_auto_off`
### Action: `switcher_kis.set_auto_off`
You can use the `switcher_kis.set_auto_off` service to set the auto-off configuration setting for the device.
You can use the `switcher_kis.set_auto_off` action to set the auto-off configuration setting for the device.
Meaning the device will turn itself off when reaching the auto-off configuration limit.
| Service Field | Mandatory | Description | Example |
| Data attribute | Mandatory | Description | Example |
| ------------- | --------- | -------------------------------------------------------------------------------------- | -------------------------- |
| `entity_id` | Yes | Name of the entity id associated with the integration, used for permission validation | switch.switcher_kis_boiler |
| `auto_off` | Yes | Time period string containing hours and minutes | "02:30" |
### Service: `switcher_kis.turn_on_with_timer`
### Action: `switcher_kis.turn_on_with_timer`
You can use the `switcher_kis.turn_on_with_timer` service to turn on the switcher device with timer.
You can use the `switcher_kis.turn_on_with_timer` action to turn on the switcher device with timer.
Meaning the device will turn itself off when timer ends.
Note: This does not affect the auto off timer.
| Service Field | Mandatory | Description | Example |
| Data attribute | Mandatory | Description | Example |
| ------------- | --------- | -------------------------------------------------------------------------------------- | -------------------------- |
| `entity_id` | Yes | Name of the entity id associated with the integration, used for permission validation | switch.switcher_kis_boiler |
| `timer_minutes` | Yes | Integer containing timer minutes (valid range 1 to 150) | 90 |

4
source/_integrations/synology_chat.markdown
View File

@ -31,7 +31,7 @@ notify:
{% configuration %}
name:
description: "Setting the parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`."
description: "Setting the parameter `name` allows multiple notifiers to be created. The notifier will bind to the `notify.NOTIFIER_NAME` action."
required: true
type: string
verify_ssl:
@ -47,7 +47,7 @@ resource:
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
A full example of a service call:
A full example of an action:
```json
{"message": "This is a test message",

2
source/_integrations/syslog.markdown
View File

@ -28,7 +28,7 @@ notify:
{% configuration %}
name:
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the `notify.NOTIFIER_NAME` action.
required: false
default: notify
type: string

30
source/_integrations/system_bridge.markdown
View File

@ -101,7 +101,7 @@ This integration is available as a media source to use with the media browser in
The integration provides an update component, which will notify you when a new version of the app is available.
## Services
## Actions
### Notifications `notify.system_bridge_hostname`
@ -163,11 +163,11 @@ Here is an example action that will open a URL in the device's browser:
This is an object containing the `source` and `volume` (0-100). The source must be a URL to a playable audio file (an MP3 for example).
### Service `system_bridge.get_process_by_id`
### Action `system_bridge.get_process_by_id`
Returns a process by its pid.
{% my developer_call_service service="system_bridge.get_process_by_id" title="Show service in your Home Assistant instance." %}
{% my developer_call_service service="system_bridge.get_process_by_id" title="Show action in your Home Assistant instance." %}
```yaml
service: system_bridge.get_process_by_id
@ -190,11 +190,11 @@ username: hostname\user
working_directory: null
```
### Service `system_bridge.get_processes_by_name`
### Action `system_bridge.get_processes_by_name`
Returns a count and a list of processes matching the name provided.
{% my developer_call_service service="system_bridge.get_processes_by_name" title="Show service in your Home Assistant instance." %}
{% my developer_call_service service="system_bridge.get_processes_by_name" title="Show action in your Home Assistant instance." %}
```yaml
service: system_bridge.get_processes_by_name
@ -219,11 +219,11 @@ processes:
working_directory: null
```
### Service `system_bridge.open_path`
### Action `system_bridge.open_path`
Open a URL or file on the server using the default application.
{% my developer_call_service service="system_bridge.open_path" title="Show service in your Home Assistant instance." %}
{% my developer_call_service service="system_bridge.open_path" title="Show action in your Home Assistant instance." %}
```yaml
service: system_bridge.open_path
@ -242,11 +242,11 @@ data:
message: Path opened
```
### Service `system_bridge.open_url`
### Action `system_bridge.open_url`
Open a URL or file on the server using the default application.
{% my developer_call_service service="system_bridge.open_url" title="Show service in your Home Assistant instance." %}
{% my developer_call_service service="system_bridge.open_url" title="Show action in your Home Assistant instance." %}
```yaml
service: system_bridge.open_url
@ -265,11 +265,11 @@ data:
message: URL opened
```
### Service`system_bridge.send_keypress`
### Action`system_bridge.send_keypress`
Send a keypress to the server.
{% my developer_call_service service="system_bridge.send_keypress" title="Show service in your Home Assistant instance." %}
{% my developer_call_service service="system_bridge.send_keypress" title="Show action in your Home Assistant instance." %}
```yaml
service: system_bridge.send_keypress
@ -288,11 +288,11 @@ data:
message: Key pressed
```
### Service `system_bridge.send_text`
### Action `system_bridge.send_text`
Sends text for the server to type.
{% my developer_call_service service="system_bridge.send_text" title="Show service in your Home Assistant instance." %}
{% my developer_call_service service="system_bridge.send_text" title="Show action in your Home Assistant instance." %}
```yaml
service: system_bridge.send_text
@ -311,7 +311,7 @@ data:
message: Text entered
```
### Service `system_bridge.power_command`
### Action `system_bridge.power_command`
Sends power command to the system.
@ -324,7 +324,7 @@ Supported commands are:
- `shutdown`
- `sleep`
{% my developer_call_service service="system_bridge.power_command" title="Show service in your Home Assistant instance." %}
{% my developer_call_service service="system_bridge.power_command" title="Show action in your Home Assistant instance." %}
```yaml
service: system_bridge.power_command

16
source/_integrations/system_log.markdown
View File

@ -33,17 +33,17 @@ fire_event:
default: false
{% endconfiguration %}
## Services
## Actions
### Service `clear`
### Action `clear`
To manually clear the system log, call this service.
To manually clear the system log, use this action.
### Service `write`
### Action `write`
Write a log entry
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------------------ |
| `message` | no | Message to log |
| `level` | yes | Log level: debug, info, warning, error, critical. Defaults to 'error'. |
@ -103,19 +103,19 @@ automation:
### Conditional Messages
This automation will create a persistent notification whenever an error or warning is logged that has the word "service" in the message:
This automation will create a persistent notification whenever an error or warning is logged that has the word "action" in the message:
{% raw %}
```yaml
automation:
- alias: "Create notifications for 'service' errors"
- alias: "Create notifications for 'action' errors"
trigger:
platform: event
event_type: system_log_event
condition:
condition: template
value_template: '{{ "service" in trigger.event.data.message[0] }}'
value_template: '{{ "action" in trigger.event.data.message[0] }}'
action:
service: persistent_notification.create
data:

2
source/_integrations/systemmonitor.markdown
View File

@ -59,7 +59,7 @@ memory usage, CPU usage, and running processes.
## Add `process` binary sensor
The `process` binary sensor needs to be configured by the config entry options. Go to **{% my integrations title="Settings > Devices & Services" %}**, select the **System Monitor** integration and click **Configure** to select which `process` binary sensors should be created.
The `process` binary sensor needs to be configured by the config entry options. Go to **{% my integrations title="Settings > Devices & services" %}**, select the **System Monitor** integration and click **Configure** to select which `process` binary sensors should be created.
## Disk usage