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-23 01:06:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename Services to Actions in integrations: V (#33831)

Browse Source
This commit is contained in:
Franck Nijhof 2024-07-17 07:08:17 +02:00 committed by GitHub
parent 2b0e78caf6
commit efe4109d52
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
16 changed files with 91 additions and 91 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
source/_integrations/vacuum.markdown
View File

@ -15,74 +15,74 @@ The **Vacuum** {% term integration %} enables the ability to control home cleani
{% include integrations/building_block_integration.md %}
## Services
## Actions
Available services: `start`, `pause`, `stop`, `return_to_base`, `locate`, `clean_spot`, `set_fan_speed` and `send_command`.
Available actions: `start`, `pause`, `stop`, `return_to_base`, `locate`, `clean_spot`, `set_fan_speed` and `send_command`.
Before calling one of these services, make sure your vacuum platform supports it.
Before calling one of these actions, make sure your vacuum platform supports it.
### Service `vacuum.start`
### Action `vacuum.start`
Start or resume a cleaning task.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------- |
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
### Service `vacuum.pause`
### Action `vacuum.pause`
Pause a cleaning task.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------- |
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
### Service `vacuum.stop`
### Action `vacuum.stop`
Stop the current activity of the vacuum.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------- |
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
### Service `vacuum.return_to_base`
### Action `vacuum.return_to_base`
Tell the vacuum to return home.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------- |
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
### Service `vacuum.locate`
### Action `vacuum.locate`
Locate the vacuum cleaner robot.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------- |
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
### Service `vacuum.clean_spot`
### Action `vacuum.clean_spot`
Tell the vacuum cleaner to do a spot clean-up.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------- |
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
### Service `vacuum.set_fan_speed`
### Action `vacuum.set_fan_speed`
Set the fan speed of the vacuum. The `fanspeed` can be a label, as `balanced` or `turbo`, or be a number; it depends on the `vacuum` platform.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------ |
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
| `fan_speed` | no | Platform dependent vacuum cleaner fan speed, with speed steps, like 'medium', or by percentage, between 0 and 100. |
### Service `vacuum.send_command`
### Action `vacuum.send_command`
Send a platform-specific command to the vacuum cleaner.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------- |
| `entity_id` | yes | Only act on specific vacuum. Use `entity_id: all` to target all. |
| `command` | no | Command to execute. |

2
source/_integrations/vacuum.mqtt.markdown
View File

@ -268,7 +268,7 @@ If params are provided service sends JSON as payload with such structure:
}
```
Service trigger example:
Action trigger example:
```yaml
- alias: "Push command based on sensor"

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

@ -19,7 +19,7 @@ related:
---
The `template` platform creates vacuums that combine integrations and provides the
ability to run scripts or invoke services for each of the start, pause, stop,
ability to run scripts or invoke actions for each of the start, pause, stop,
return_to_base, clean_spot, locate and set_fan_speed commands of a vacuum.
To enable Template Vacuums in your installation, add the following to your

16
source/_integrations/vallox.markdown
View File

@ -57,7 +57,7 @@ The date platform allows you to set the filter change date.
## Profile switching
For convenient switching of ventilation profiles in the GUI, just click on the `Vallox` fan {% term entity %} to get a drop-down menu to select from. Alternatively, the service `fan/set_preset_mode` can be used.
For convenient switching of ventilation profiles in the GUI, just click on the `Vallox` fan {% term entity %} to get a drop-down menu to select from. Alternatively, the action `fan/set_preset_mode` can be used.
The four standard Vallox profiles are supported:
@ -66,28 +66,28 @@ The four standard Vallox profiles are supported:
- `Boost`
- `Fireplace`
## Fan services
## Fan actions
### Service `vallox.set_profile_fan_speed_home`
### Action `vallox.set_profile_fan_speed_home`
Set the fan speed of the `Home` profile.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
|------------------------|----------|-------------------------------------------------|
| `fan_speed` | no | Fan speed in %. `Integer`, between 0 and 100. |
### Service `vallox.set_profile_fan_speed_away`
### Action `vallox.set_profile_fan_speed_away`
Set the fan speed of the `Away` profile.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
|------------------------|----------|-------------------------------------------------|
| `fan_speed` | no | Fan speed in %. `Integer`, between 0 and 100. |
### Service `vallox.set_profile_fan_speed_boost`
### Action `vallox.set_profile_fan_speed_boost`
Set the fan speed of the `Boost` profile.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
|------------------------|----------|-------------------------------------------------|
| `fan_speed` | no | Fan speed in %. `Integer`, between 0 and 100. |

10
source/_integrations/valve.markdown
View File

@ -30,14 +30,14 @@ The following device classes are supported for valves:
- **water**: Valve that controls the flow of water through a system.
- **gas**: Valve that controls the flow of gas through a system.
## Services
## Actions
### Valve control services
### Valve control actions
All valves respond to `valve.open`, `valve.close`, and `valve.toggle`.
Valves that allow setting a specific position may also be controlled with `valve.set_position` and `valve.stop`.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of valves. Use `entity_id: all` to target all.
@ -54,11 +54,11 @@ automation:
entity_id: valve.demo
```
### Service `valve.set_position`
### Action `valve.set_position`
Set the position of one or multiple valves if they support setting a specific position.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of valves. Use `entity_id: all` to target all.
| `position` | no | Integer between 0 (fully closed) and 100 (fully open).

8
source/_integrations/valve.mqtt.markdown
View File

@ -38,7 +38,7 @@ Example of a JSON state update:
{"state": "opening", "position": 10}
```
The wanted position value or `payload_stop` will be published to `command_topic` to control the valve when the services `valve.open`, `value.close`, or `value.set_position` are called.
The wanted position value or `payload_stop` will be published to `command_topic` to control the valve when the actions `valve.open`, `value.close`, or `value.set_position` are called.
To use your MQTT valve in your installation, add the following to your {% term "`configuration.yaml`" %} file:
@ -215,16 +215,16 @@ payload_open:
type: string
default: OPEN
payload_stop:
description: The command payload that stops the valve. When not configured, the valve will not support the `valve.stop` service.
description: The command payload that stops the valve. When not configured, the valve will not support the `valve.stop` action.
required: false
type: string
position_closed:
description: Number which represents closed position. The valve's position will be scaled to the(`position_closed`...`position_open`) range when a service is called and scaled back when a value is received.
description: Number which represents closed position. The valve's position will be scaled to the(`position_closed`...`position_open`) range when an action is performed and scaled back when a value is received.
required: false
type: integer
default: 0
position_open:
description: Number which represents open position. The valve's position will be scaled to (`position_closed`...`position_open`) range when a service is called and scaled back when a value is received.
description: Number which represents open position. The valve's position will be scaled to (`position_closed`...`position_open`) range when an is performed and scaled back when a value is received.
required: false
type: integer
default: 100

28
source/_integrations/velbus.markdown
View File

@ -41,35 +41,35 @@ The port string used in the user interface or the configuration file can have 2
- For a TCP/IP device: `127.0.0.1:3678`
- For the VMBSIG module: `tls://192.168.1.9:27015`
## Services
## Actions
- `velbus.sync clock`: Synchronize Velbus time to local clock.
- `velbus.scan`: Scan the bus for new devices.
- `velbus.set_memo_text`: Show memo text on Velbus display modules.
- `velbus.clear_cache`: Clear the full velbuscache or the cache for one module only.
### Service `velbus.sync_clock`
### Action `velbus.sync_clock`
You can use the service `velbus.sync_clock` to synchronize the clock of the Velbus modules to the clock of the machine running Home Assistant. This is the same as the 'sync clock' button at the VelbusLink software.
You can use the `velbus.sync_clock` action to synchronize the clock of the Velbus modules to the clock of the machine running Home Assistant. This is the same as the 'sync clock' button at the VelbusLink software.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------- |
| `interface` | no | The port used to connect to the bus (the same one as used during configuration). |
### Service `velbus.scan`
### Action `velbus.scan`
You can use the service `velbus.scan` to synchronize the modules between the bus and Home Assistant. This is the same as the 'scan' button at the VelbusLink software.
You can use the `velbus.scan` action to synchronize the modules between the bus and Home Assistant. This is the same as the 'scan' button at the VelbusLink software.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------- |
| `interface` | no | The port used to connect to the bus (the same one as used during configuration). |
### Service `velbus.set_memo_text`
### Action `velbus.set_memo_text`
You can use the service `velbus.set_memo_text` to provide the memo text to be displayed at Velbus modules like VMBGPO(D) and VMBELO.
You can use the `velbus.set_memo_text` action to provide the memo text to be displayed at Velbus modules like VMBGPO(D) and VMBELO.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------- |
| `interface` | no | The port used to connect to the bus (the same one as used during configuration). |
| `address` | no | The module address in decimal format, which is displayed at the device list at the integration page. |
@ -89,12 +89,12 @@ script:
service: velbus.set_memo_text
```
### Service `velbus.clear_cache`
### Action `velbus.clear_cache`
You can use the service `velbus.clear_cache` to clear the cache of one module or the full cache. Once the clear happens, the integration will start a new scan.
Use this service when you make changes to your configuration via velbuslink.
You can use the `velbus.clear_cache` action to clear the cache of one module or the full cache. Once the clear happens, the integration will start a new scan.
Use this action when you make changes to your configuration via velbuslink.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------- |
| `interface` | no | The port used to connect to the bus (the same one used during configuration). |
| `address` | no | The module address in decimal format, which is displayed on the device list on the integration page, if provided the service will only clear the cache for this model, without an address, the full velbuscache will be cleared. |

4
source/_integrations/velux.markdown
View File

@ -37,9 +37,9 @@ During configuration, you will be asked for a hostname and password:
You must complete the configuration within 5 minutes of rebooting the KLF 200 gateway while the access point is still available.
## Services
## Actions
### Service `velux.reboot_gateway`
### Action `velux.reboot_gateway`
Reboots the configured KLF 200 Gateway.

2
source/_integrations/verisure.markdown
View File

@ -67,7 +67,7 @@ automation:
{% endraw %}
## Services
## Actions
| Service | Description |
| ------- | ----------- |

4
source/_integrations/vesync.markdown
View File

@ -74,9 +74,9 @@ the configuration section below.
{% include integrations/config_flow.md %}
## Services
## Actions
| Service | Description |
| Action | Description |
|---------|-------------|
| `update_devices` | Poll Vesync server to find and add any new devices |

30
source/_integrations/vicare.markdown
View File

@ -64,22 +64,22 @@ The {% term integration %} polls the Viessmann API every 60 seconds and will wor
A note about the current temperature attribute: Viessmann devices with room temperature sensing will show the current room temperature via `current_temperature`. All other devices will show the current supply temperature of the heating circuit.
### Supported services `climate.vicare_heating`
### Supported actions `climate.vicare_heating`
The following services of the [Climate integration](/integrations/climate/) are provided by the ViCare {% term integration %}: `set_temperature`, `set_hvac_mode`, `set_preset_mode`
The following actions of the [Climate integration](/integrations/climate/) are provided by the ViCare {% term integration %}: `set_temperature`, `set_hvac_mode`, `set_preset_mode`
#### Service `set_temperature`
#### Action `set_temperature`
Sets the target temperature to the given temperature.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. To target all entities, use `all` keyword instead of entity_id.
| `temperature` | no | Desired target temperature
Note that `set_temperature` will always affect the current normal temperature or, if a preset is set, the temperature of the preset (i.e., Viessman program like eco or comfort).
#### Service `climate.set_hvac_mode`
#### Action `climate.set_hvac_mode`
Set HVAC mode for the climate device. The following modes are supported:
@ -91,26 +91,26 @@ The `climate.vicare_heating` {% term integration %} has the following mapping of
| `heat` | `ForcedNormal` | Permanently set heating to normal temperature.
| `auto` | `DHWandHeating` | Switches between reduced and normal temperature as by the heating schedule programmed in your device
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. To target all entities, use `all` keyword instead of entity_id.
| `hvac_mode` | no | New value of HVAC mode
#### Service `climate.set_vicare_mode`
#### Action `climate.set_vicare_mode`
Set the mode for the climate device as defined by Viessmann (see [set_hvac_mode](#service-climateset_hvac_mode) for a mapping to Home Assistant Climate modes. This allows more-fine grained control of the heating modes.
Set the mode for the climate device as defined by Viessmann (see [set_hvac_mode](#action-climateset_hvac_mode) for a mapping to Home Assistant Climate modes. This allows more-fine grained control of the heating modes.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. To target all entities, use `all` keyword instead of entity_id.
| `vicare_mode` | no | New value of ViCare mode. For supported values see the `vicare_modes` attribute of the climate {% term entity %}.
#### Service `set_preset_mode`
#### Action `set_preset_mode`
Sets the preset mode. Supported preset modes are *eco* and *comfort*. These are identical to the respective Viessmann programs and are only active temporarily for 8 hours.
Eco mode reduces the target temperature by 3°C, whereas Comfort mode sets the target temperature to a configurable value. Please consult your heating device manual for more information.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. To target all entities, use `all` keyword instead of entity_id.
| `preset_mode` | no | New value of preset mode.
@ -119,15 +119,15 @@ Eco mode reduces the target temperature by 3°C, whereas Comfort mode sets the t
It is not possible to turn on/off water heating via the water heater {% term integration %} since this would conflict with the operation modes of the heating {% term integration %}. Therefore the operation mode of that {% term integration %} is just available as an attribute and cannot be modified.
### Supported services `water_heater.vicare_water`
### Supported actions `water_heater.vicare_water`
The following services of the [water heater integration](/integrations/water_heater/) are provided by the ViCare {% term integration %}: `set_temperature`
The following actions of the [water heater integration](/integrations/water_heater/) are provided by the ViCare {% term integration %}: `set_temperature`
#### Service `set_temperature`
#### Action `set_temperature`
Sets the target temperature of domestic hot water to the given temperature.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control.
| `temperature` | no | New target temperature for water heater

22
source/_integrations/vivotek.markdown
View File

@ -102,17 +102,17 @@ camera:
stream_path: live2.sdp
```
### Services
### Actions
Once loaded, the `camera` platform will expose services that can be called to perform various actions.
Once loaded, the `camera` platform will expose actions that can be called to perform various actions.
Available services: `enable_motion_detection`, `disable_motion_detection`, `snapshot`, and `play_stream`.
Available actions: `enable_motion_detection`, `disable_motion_detection`, `snapshot`, and `play_stream`.
#### Service `play_stream`
#### Action `play_stream`
Play a live stream from a camera to selected media player(s). Requires [`stream`](/integrations/stream) {% term integration %} to be set up.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------ |
| `entity_id` | no | Name of {% term entity %} to fetch stream from, e.g., `camera.front_door_camera`. |
| `media_player` | no | Name of media player to play stream on, e.g., `media_player.living_room_tv`. |
@ -129,27 +129,27 @@ action:
media_player: media_player.chromecast
```
#### Service `enable_motion_detection`
#### Action `enable_motion_detection`
Enable motion detection in a camera. Currently, this will enable the first event configured on the camera.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------------------------------------- |
| `entity_id` | yes | Name(s) of entities to enable motion detection, e.g., `camera.front_door_camera`. |
#### Service `disable_motion_detection`
#### Action `disable_motion_detection`
Disable the motion detection in a camera. Currently, this will disable the first event configured on the camera.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------------------- |
| `entity_id` | yes | Name(s) of entities to disable motion detection, e.g., `camera.front_door_camera`. |
#### Service `snapshot`
#### Action `snapshot`
Take a snapshot from a camera.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | Name(s) of entities to create a snapshot from, e.g., `camera.front_door_camera`. |
| `filename` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/snapshot_{{ entity_id }}`{% endraw %}. |

6
source/_integrations/vizio.markdown
View File

@ -212,11 +212,11 @@ The list of apps that are provided by default is statically defined [here](https
pyvizio --ip=0 get-apps-list
```
## Service `vizio.update_setting`
## Action `vizio.update_setting`
This service allows you to update a setting on a given VIZIO device. You will need to know the type of setting and the name of the setting to call this service. You can determine this by using the SmartCast app and going to device settings for your target device. The setting type is the lowercase version of the first menu item you'd select (e.g., display, audio, system), and the setting name is what you see in the app, but spaces are replaced with underscores and it is also all lowercase (e.g., AV delay would be called `av_delay`).
This action allows you to update a setting on a given VIZIO device. You will need to know the type of setting and the name of the setting to perform this action. You can determine this by using the SmartCast app and going to device settings for your target device. The setting type is the lowercase version of the first menu item you'd select (e.g., display, audio, system), and the setting name is what you see in the app, but spaces are replaced with underscores and it is also all lowercase (e.g., AV delay would be called `av_delay`).
| Service data attribute | Optional | Description | Example |
| Data attribute | Optional | Description | Example |
| ---------------------- | -------- | ----------- | ------- |
| `entity_id` | yes | The devices to update a setting for. | `media_player.vizio_smartcast`
| `setting_type` | no | The type of setting. | `audio`

2
source/_integrations/vlc.markdown
View File

@ -44,7 +44,7 @@ arguments:
Only the "music" media type is supported for now.
This service will control a background VLC instance, therefore you cannot use this to control a VLC instance launched on your desktop, unlike the Kodi media player for example.
This action will control a background VLC instance, therefore you cannot use this to control a VLC instance launched on your desktop, unlike the Kodi media player for example.
## Full configuration

6
source/_integrations/vlc_telnet.markdown
View File

@ -17,7 +17,7 @@ ha_integration_type: integration
The **VLC media player via Telnet** {% term integration %} allows you to control a [VLC media player](https://www.videolan.org/vlc/index.html) using the built in telnet interface.
This service will control any instance of VLC player on the network with the telnet interface activated.
This action will control any instance of VLC player on the network with the telnet interface activated.
To activate the telnet interface on your VLC Player please read the [official VLC documentation](https://wiki.videolan.org/Documentation:Modules/telnet/). Also remember to add a firewall rule allowing inbound connections for the port used in the device running VLC.
In case the VLC is running on a host with a locale other than English, you may get some errors during the volume change.
@ -26,9 +26,9 @@ Consider to set the locale to `en_US` before starting VLC.
{% include integrations/config_flow.md %}
## Services
## Actions
When using the `media_player.play_media` service, only the "music" media type is supported for now.
When using the `media_player.play_media` action, only the "music" media type is supported for now.
## Home Assistant add-on

2
source/_integrations/vodafone_station.markdown
View File

@ -37,7 +37,7 @@ There is support for the following platform types within Home Assistant:
## Integration options
It is possible to change some behaviors through the {% term integration %} options.
To change the settings, go to {% my integrations title="**Settings** > **Devices & Services**" %}. On the **Vodafone Station** integration, select the cogwheel. Then select **Configure**.
To change the settings, go to {% my integrations title="**Settings** > **Devices & services**" %}. On the **Vodafone Station** integration, select the cogwheel. Then select **Configure**.
- **Consider home**: Number of seconds that must elapse before considering a disconnected device "not at home".