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-15 13:26:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename Services to Actions in integrations: Y (#33834)

Browse Source
This commit is contained in:
Franck Nijhof 2024-07-17 07:18:03 +02:00 committed by GitHub
parent 213c1a9b1f
commit 0fc9c499df
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 39 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
source/_integrations/yale_smart_alarm.markdown
View File

@ -37,7 +37,7 @@ There is currently support for the following device types within Home Assistant:
## Alarm control panel ## Alarm control panel
Services provided are `armed_away`, `armed_home`, and `disarmed`. Actions provided are `armed_away`, `armed_home`, and `disarmed`.
No code is required to operate the alarm. No code is required to operate the alarm.

2
source/_integrations/yalexs_ble.markdown
View File

@ -61,7 +61,7 @@ Some locks only send push updates when they have an active HomeKit pairing. If y
One easy way to fix this is to create a new/second home in the Apple Home app and add the lock to that new home. Push updates should occur as intended after the lock is added. One easy way to fix this is to create a new/second home in the Apple Home app and add the lock to that new home. Push updates should occur as intended after the lock is added.
Alternatively, call the `homeassistant.update_entity` service to force the {% term integration %} to update the lock state, or enable the always connected option. Alternatively, call the `homeassistant.update_entity` action to force the {% term integration %} to update the lock state, or enable the always connected option.
{% include integrations/option_flow.md %} {% include integrations/option_flow.md %}

14
source/_integrations/yamaha.markdown
View File

@ -70,7 +70,7 @@ zone_names:
- Media players created by Yamaha support powering on/off, mute, - Media players created by Yamaha support powering on/off, mute,
volume control and source selection. Playback controls, for instance volume control and source selection. Playback controls, for instance
play and stop are available for sources that supports it. play and stop are available for sources that supports it.
- The `play_media` service is implemented for `NET RADIO` source - The `play_media` action is implemented for `NET RADIO` source
only. The `media_id` is a `>` separated string of the menu path on only. The `media_id` is a `>` separated string of the menu path on
the vtuner service. For instance `Bookmarks>Internet>WAMC 90.3 FM`. the vtuner service. For instance `Bookmarks>Internet>WAMC 90.3 FM`.
MusicCast devices use the path `Radio>Favorites>WAMC 90.3 FM`. MusicCast devices use the path `Radio>Favorites>WAMC 90.3 FM`.
@ -127,30 +127,30 @@ script:
``` ```
### Service `enable_output` ### Action `enable_output`
Enable or disable an output port (HDMI) on the receiver. Enable or disable an output port (HDMI) on the receiver.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------------- | | ---------------------- | -------- | ------------------------------------------------------------------------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`s of Yamaha receivers. | | `entity_id` | yes | String or list of strings that point at `entity_id`s of Yamaha receivers. |
| `port` | no | Port to enable or disable, e.g., `hdmi1`. | | `port` | no | Port to enable or disable, e.g., `hdmi1`. |
| `enabled` | no | To enable set true, otherwise set to false. | | `enabled` | no | To enable set true, otherwise set to false. |
### Service `menu_cursor` ### Action `menu_cursor`
Control the menu cursor. Control the menu cursor.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------------------- | | ---------------------- | -------- | ---------------------------------------------------------------------------------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`s of Yamaha receivers. | | `entity_id` | yes | String or list of strings that point at `entity_id`s of Yamaha receivers. |
| `cursor` | no | Name of the cursor key to press: `up`, `down`, `left`, `right`, `select`, `return` | | `cursor` | no | Name of the cursor key to press: `up`, `down`, `left`, `right`, `select`, `return` |
### Service `select_scene` ### Action `select_scene`
Select a scene on the receiver. Select a scene on the receiver.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------- | | ---------------------- | -------- | -------------------------------------------------------------------------------------------------------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`s of Yamaha receivers. | | `entity_id` | yes | String or list of strings that point at `entity_id`s of Yamaha receivers. |
| `scene` | no | Scene to select, e.g., `BD/DVD Movie Viewing`, `TV Viewing`, `NET Audio Listening` or `Radio Listening`. | | `scene` | no | Scene to select, e.g., `BD/DVD Movie Viewing`, `TV Viewing`, `NET Audio Listening` or `Radio Listening`. |

8
source/_integrations/yamaha_musiccast.markdown
View File

@ -27,20 +27,20 @@ Supported devices are listed on their [site](https://usa.yamaha.com/products/con
## Grouping functionality ## Grouping functionality
The Yamaha MusicCast {% term integration %} implements the grouping services. There are some limitations in the MusicCast system for grouping: The Yamaha MusicCast {% term integration %} implements the grouping actions. There are some limitations in the MusicCast system for grouping:
- It is not possible to let mediaplayer entities of the same device (e.g., different zones) be in distinct groups. - It is not possible to let mediaplayer entities of the same device (e.g., different zones) be in distinct groups.
- If a non-main zone is the master of a group, it is not possible to let other mediaplayers of the same device join this group. - If a non-main zone is the master of a group, it is not possible to let other mediaplayers of the same device join this group.
## Play media functionality ## Play media functionality
The MusicCast {% term integration %} supports the Home Assistant media browser for all streaming services, your device supports. For services such as Deezer, you have to log in using the official MusicCast app. In addition, local HTTP URLs can be played back using this service. This includes the Home Assistant text-to-speech services. The MusicCast {% term integration %} supports the Home Assistant media browser for all streaming services, your device supports. For services such as Deezer, you have to log in using the official MusicCast app. In addition, local HTTP URLs can be played back using this action. This includes the Home Assistant text-to-speech actions.
It is also possible to recall NetUSB presets using the play media service. To do so "presets:<preset_num>" has to be used as `media_content_id` in the service call. It is also possible to recall NetUSB presets using the play media action. To do so "presets:<preset_num>" has to be used as `media_content_id` in the action.
### Examples: ### Examples:
This 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): This is an example action that plays an audio file from a web server on the local network (like the Home Assistant built-in webserver):
```yaml ```yaml
service: media_player.play_media service: media_player.play_media

6
source/_integrations/yardian.markdown
View File

@ -27,13 +27,13 @@ During the configuration, you will have to manually set the **Host** and the **A
![Yardian Host/Token Location](/images/integrations/yardian/yardian_config_flow.jpg) ![Yardian Host/Token Location](/images/integrations/yardian/yardian_config_flow.jpg)
## Services ## Actions
### yardian.start_irrigation ### yardian.start_irrigation
Start a zone for a given number of minutes. This service accepts an Yardian Zone switch {% term entity %} and allows a given duration. Start a zone for a given number of minutes. This action accepts an Yardian Zone switch {% term entity %} and allows a given duration.
| Service Data Attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------------------------------------------------- | | ---------------------- | -------- | ----------------------------------------------------- |
| `entity_id` | yes | The Yardian Zone switch to turn on. | | `entity_id` | yes | The Yardian Zone switch to turn on. |
| `duration` | no | Number of minutes for this zone to be turned on. | | `duration` | no | Number of minutes for this zone to be turned on. |

38
source/_integrations/yeelight.markdown
View File

@ -33,7 +33,7 @@ There is support for the following device types within Home Assistant:
### Custom effects ### Custom effects
Custom effects can only be set up through YAML configuration. To turn on the effect you can use [light.turn_on](/integrations/light/#service-lightturn_on) service. Custom effects can only be set up through YAML configuration. To turn on the effect you can use [light.turn_on](/integrations/light/#action-lightturn_on) action.
Possible transitions are `RGBTransition`, `HSVTransition`, `TemperatureTransition`, `SleepTransition`. Possible transitions are `RGBTransition`, `HSVTransition`, `TemperatureTransition`, `SleepTransition`.
@ -210,84 +210,84 @@ This {% term integration %} is tested to work with the following models. If you
| ?, may be `ceilb` | YLXD013-C | Yeelight Arwen Ceiling Light 550C | | ?, may be `ceilb` | YLXD013-C | Yeelight Arwen Ceiling Light 550C |
| `ceilb` | YLXD013 | Yeelight Arwen Ceiling Light 450S | | `ceilb` | YLXD013 | Yeelight Arwen Ceiling Light 450S |
## Services ## Actions
### Service `yeelight.set_mode` ### Action `yeelight.set_mode`
Set an operation mode. Set an operation mode.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------------------------------------------------| |---------------------------|----------|---------------------------------------------------------------------------------------------|
| `entity_id` | yes | Only act on specific lights. | | `entity_id` | yes | Only act on specific lights. |
| `mode` | no | Operation mode. Valid values are 'last', 'normal', 'rgb', 'hsv', 'color_flow', 'moonlight'. | | `mode` | no | Operation mode. Valid values are 'last', 'normal', 'rgb', 'hsv', 'color_flow', 'moonlight'. |
### Service `yeelight.start_flow` ### Action `yeelight.start_flow`
Start flow with specified transitions Start flow with specified transitions
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------------------------------------------------| |---------------------------|----------|---------------------------------------------------------------------------------------------|
| `entity_id` | yes | Only act on specific lights. | | `entity_id` | yes | Only act on specific lights. |
| `count` | yes | The number of times to run this flow (0 to run forever). | | `count` | yes | The number of times to run this flow (0 to run forever). |
| `action` | yes | The action to take after the flow stops. Can be 'recover', 'stay', 'off'. Default 'recover' | | `action` | yes | The action to take after the flow stops. Can be 'recover', 'stay', 'off'. Default 'recover' |
| `transitions` | no | Array of transitions. See [custom effects](#custom-effects). | | `transitions` | no | Array of transitions. See [custom effects](#custom-effects). |
### Service `yeelight.set_color_scene` ### Action `yeelight.set_color_scene`
Changes the light to the specified RGB color and brightness. If the light is off, it will be turned on. Changes the light to the specified RGB color and brightness. If the light is off, it will be turned on.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------------------------------------------------| |---------------------------|----------|---------------------------------------------------------------------------------------------|
| `entity_id` | yes | Only act on specific lights. | | `entity_id` | yes | Only act on specific lights. |
| `rgb_color` | no | A list containing three integers between 0 and 255 representing the RGB color you want the light to be. Three comma-separated integers that represent the color in RGB, within square brackets.| | `rgb_color` | no | A list containing three integers between 0 and 255 representing the RGB color you want the light to be. Three comma-separated integers that represent the color in RGB, within square brackets.|
| `brightness` | no | The brightness value to set (1-100). | | `brightness` | no | The brightness value to set (1-100). |
### Service `yeelight.set_hsv_scene` ### Action `yeelight.set_hsv_scene`
Changes the light to the specified HSV color and brightness. If the light is off, it will be turned on. Changes the light to the specified HSV color and brightness. If the light is off, it will be turned on.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------------------------------------------------| |---------------------------|----------|---------------------------------------------------------------------------------------------|
| `entity_id` | yes | Only act on specific lights. | | `entity_id` | yes | Only act on specific lights. |
| `hs_color` | no | A list containing two floats representing the hue and saturation of the color you want the light to be. Hue is scaled 0-360, and saturation is scaled 0-100. | | `hs_color` | no | A list containing two floats representing the hue and saturation of the color you want the light to be. Hue is scaled 0-360, and saturation is scaled 0-100. |
| `brightness` | no | The brightness value to set (1-100). | | `brightness` | no | The brightness value to set (1-100). |
### Service `yeelight.set_color_temp_scene` ### Action `yeelight.set_color_temp_scene`
Changes the light to the specified color temperature. If the light is off, it will be turned on. Changes the light to the specified color temperature. If the light is off, it will be turned on.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------------------------------------------------| |---------------------------|----------|---------------------------------------------------------------------------------------------|
| `entity_id` | yes | Only act on specific lights. | | `entity_id` | yes | Only act on specific lights. |
| `kelvin` | no | Color temperature in Kelvin. | | `kelvin` | no | Color temperature in Kelvin. |
| `brightness` | no | The brightness value to set (1-100). | | `brightness` | no | The brightness value to set (1-100). |
### Service `yeelight.set_color_flow_scene` ### Action `yeelight.set_color_flow_scene`
Starts a color flow. Difference between this and [yeelight.start_flow](#service-yeelightstart_flow), this service call uses different a Yeelight API call. If the light was off, it will be turned on. There might be some firmware differences in handling complex flows, etc. Starts a color flow. Difference between this and [yeelight.start_flow](#action-yeelightstart_flow), this action uses different a Yeelight API call. If the light was off, it will be turned on. There might be some firmware differences in handling complex flows, etc.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------------------------------------------------| |---------------------------|----------|---------------------------------------------------------------------------------------------|
| `entity_id` | yes | Only act on specific lights. | | `entity_id` | yes | Only act on specific lights. |
| `count` | yes | The number of times to run this flow (0 to run forever). | | `count` | yes | The number of times to run this flow (0 to run forever). |
| `action` | yes | The action to take after the flow stops. Can be 'recover', 'stay', 'off'. Default 'recover' | | `action` | yes | The action to take after the flow stops. Can be 'recover', 'stay', 'off'. Default 'recover' |
| `transitions` | no | Array of transitions. See [custom effects](#custom-effects). | | `transitions` | no | Array of transitions. See [custom effects](#custom-effects). |
### Service `yeelight.set_auto_delay_off_scene` ### Action `yeelight.set_auto_delay_off_scene`
Turns the light on to the specified brightness and sets a timer to turn it back off after the given number of minutes. If the light is off, it will be turned on. Turns the light on to the specified brightness and sets a timer to turn it back off after the given number of minutes. If the light is off, it will be turned on.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------------------------------------------------| |---------------------------|----------|---------------------------------------------------------------------------------------------|
| `entity_id` | yes | Only act on specific lights. | | `entity_id` | yes | Only act on specific lights. |
| `minutes` | no | The minutes to wait before automatically turning the light off. | | `minutes` | no | The minutes to wait before automatically turning the light off. |
| `brightness` | no | The brightness value to set (1-100). | | `brightness` | no | The brightness value to set (1-100). |
### Service `yeelight.set_music_mode` ### Action `yeelight.set_music_mode`
Enable or disable music_mode. Enable or disable music_mode.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
|---------------------------|----------|---------------------------------------------------------------------------------------------| |---------------------------|----------|---------------------------------------------------------------------------------------------|
| `entity_id` | yes | Only act on specific lights. | | `entity_id` | yes | Only act on specific lights. |
| `music_mode` | no | Use 'true' or 'false' to enable / disable music_mode. | | `music_mode` | no | Use 'true' or 'false' to enable / disable music_mode. |

8
source/_integrations/yolink.markdown
View File

@ -37,16 +37,16 @@ Integrates [YoLink](https://www.yosmart.com/) Devices into Home Assistant.
{% details "Using custom application credentials" %} {% details "Using custom application credentials" %}
Home Assistant will use account linking provided by Nabu Casa for authenticating with YoLink, this service is provided for free and does not require a Nabu Casa subscription. The steps below are thus not required. Home Assistant will use account linking provided by Nabu Casa for authenticating with YoLink, this service is provided for free and does not require a Nabu Casa subscription. The steps below are thus not required.
If you want to use separate credentials, please contact <service@yosmart.com> to obtain a `client_id` and `client_secret`. Then you can add your credentials via application credentials. Settings > Devices & Services > click the menu (three dots at the top right of the screen) and then **Application Credentials**. Enter your credentials in the pop-up window. If you want to use separate credentials, please contact <service@yosmart.com> to obtain a `client_id` and `client_secret`. Then you can add your credentials via application credentials. Settings > Devices & services > click the menu (three dots at the top right of the screen) and then **Application Credentials**. Enter your credentials in the pop-up window.
{% enddetails %} {% enddetails %}
## Services ## Actions
### `Play on SpeakerHub` ### `Play on SpeakerHub`
With this service, you can convert text to speech for playback on SpeakerHub. With this action, you can convert text to speech for playback on SpeakerHub.
Service data attribute | Optional | Description Data attribute | Optional | Description
-|-|- -|-|-
`target_device` | no| SpeakerHub device ID for audio playback. `target_device` | no| SpeakerHub device ID for audio playback.
`message` | no| Text for speech conversion. `message` | no| Text for speech conversion.