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

Rename Services to Actions in integrations: M (#33821)

Browse Source 
* Rename Services to Actions in integrations: M

* Apply suggestions from code review
This commit is contained in:
Franck Nijhof 2024-07-17 06:33:06 +02:00 committed by GitHub
parent ba5fbd0552
commit eb1a3ba031
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
27 changed files with 137 additions and 137 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
source/_integrations/madvr.markdown
View File

@ -28,7 +28,7 @@ This integration supports all current madVR Envy models.
## Remote
The madVR Envy remote platform will create a [remote](/integrations/remote/) entity for the device. This entity allows you to send the following commands via the [remote.send_command](/integrations/remote/) service.
The madVR Envy remote platform will create a [remote](/integrations/remote/) entity for the device. This entity allows you to send the following commands via the [remote.send_command](/integrations/remote/) action.
The command structure uses the same keywords as the [official documentation](https://madvrenvy.com/wp-content/uploads/EnvyIpControl.pdf?r=113a) and simply sends the corresponding command to the device. Please refer to the official documentation for more details and usage.

4
source/_integrations/mailgun.markdown
View File

@ -66,7 +66,7 @@ automation:
## Notifications
The Mailgun notification service allows you to send emails via Mailgun's REST API. It requires the [Mailgun component](#configuration) to be set up.
The Mailgun notification action allows you to send emails via Mailgun's REST API. It requires the [Mailgun component](#configuration) to be set up.
### Notifications configuration
@ -80,7 +80,7 @@ notify:
{% configuration %}
name:
description: "The optional parameter name allows multiple notifiers to be created. The notifier will bind to the service notify.NOTIFIER_NAME."
description: "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

18
source/_integrations/mastodon.markdown
View File

@ -40,7 +40,7 @@ notify:
{% configuration %}
name:
description: "The optional parameter name allows multiple notifiers to be created. The notifier will bind to the service notify.NOTIFIER_NAME."
description: "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
@ -65,26 +65,26 @@ base_url:
### Usage
Mastodon is a notify platform, and can be used by calling notify service as described in the [notify documentation](/integrations/notify/). It will toot messages using
Mastodon is a notify platform, and can be used by calling notify action as described in the [notify documentation](/integrations/notify/). It will toot messages using
your account. An optional **target** parameter can be given to specify whether your toot will be public, private, unlisted, or direct.
| Service attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `message` | no | Body of the notification.
| `target` | yes | If not used, will default to account setting. `public`: post will be public, `unlisted`: post will be public but not appear on the public timeline, `private`: post will only be visible to followers, and `direct`: post will only be visible to mentioned users.
| `data` | yes | See below for extended functionality.
### Service data
### Action data
The following attributes can be placed inside `data` for extended functionality.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `media` | yes | Attach an image or video to the message.
| `media_warning` | yes | If an image or video is attached, `True`: will marked the media as sensitive. `False` is default.
| `content_warning` | yes | Text will be be shown as a warning before the text of the status. If not used, no warning will be displayed.
### Example service call
### Example action
This will post a message to Mastodon. Visibility will default to your account's setting.
@ -93,7 +93,7 @@ This will post a message to Mastodon. Visibility will default to your account's
message: "A toot from Home Assistant"
```
### Example service call - private
### Example action - private
This will post a message to Mastodon, but visibility is marked as `private` so only followers will see it.
@ -103,7 +103,7 @@ This will post a message to Mastodon, but visibility is marked as `private` so o
target: private
```
### Example service call - with media
### Example action - with media
This will post a message to Mastodon that includes an image.
@ -114,7 +114,7 @@ This will post a message to Mastodon that includes an image.
media: /config/www/funny_meme.png
```
### Example service call - with media and content warning to hide post behind a warning
### Example action - with media and content warning to hide post behind a warning
This will post a message to Mastodon that includes an image and a target of `unlisted`, so it doesn't show in the public timeline.

2
source/_integrations/matrix.markdown
View File

@ -173,7 +173,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

4
source/_integrations/matter.markdown
View File

@ -178,14 +178,14 @@ This guide describes how to add a new device. This will use the Bluetooth connec
- Scan the QR code.
- When prompted to **Choose an app**, make sure to select Home Assistant.
- Once the process is complete, select **Done**, then select **Add device**.
4. If you did not see a pop-up, go to {% my integrations title="**Settings** > **Devices & Services**" %}.
4. If you did not see a pop-up, go to {% my integrations title="**Settings** > **Devices & services**" %}.
- On the **Devices** tab, select the **Add device** button, and select **Add Matter device**.
- In the dialog, select **No, it's new.**.
- Scan the QR-code of the Matter device with your phone camera or select **Setup without QR-code** to manually enter the commission code.
- This starts the commissioning process which may take a few minutes.
- If you're adding a test board (e.g. ESP32 running the example apps) and commissioning fails, you might need to take some actions in the Google Developer console, have a look at any instructions for your test device.
- Once the process is complete, select **Done**.
5. To view the device details, go to {% my integrations title="**Settings** > **Devices & Services**" %} and select the **Matter** integration.
5. To view the device details, go to {% my integrations title="**Settings** > **Devices & services**" %} and select the **Matter** integration.
6. By default, the device gets a factory specified name. To rename it, on the device page, select the pencil to edit and rename the device.
![image](/images/integrations/matter/matter-android-rename.png)
7. Your device is now ready to use.

16
source/_integrations/mealie.markdown
View File

@ -46,38 +46,38 @@ The integration will create a calendar for every type of meal plan:
The integration will create a to-do list for every Mealie shopping list.
## Services
## Actions
The Mealie integration has the following services:
The Mealie integration has the following actions:
- `mealie.get_mealplan`
- `mealie.get_recipe`
- `mealie.import_recipe`
### Service `mealie.get_mealplan`
### Action `mealie.get_mealplan`
Get the meal plan for a specified range.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
|------------------------|----------|----------------------------------------------------------|
| `config_entry_id` | No | The ID of the Mealie config entry to get data from. |
| `start_date` | Yes | The start date of the meal plan. (today if not supplied) |
| `end_date` | Yes | The end date of the meal plan. (today if not supplied) |
### Service `mealie.get_recipe`
### Action `mealie.get_recipe`
Get the recipe for a specified recipe ID or slug.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
|------------------------|----------|-----------------------------------------------------|
| `config_entry_id` | No | The ID of the Mealie config entry to get data from. |
| `recipe_id` | No | The ID or the slug of the recipe to get. |
### Service `mealie.import_recipe`
### Action `mealie.import_recipe`
Import the recipe into Mealie from a URL.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
|------------------------|----------|-----------------------------------------------------------------|
| `config_entry_id` | No | The ID of the Mealie config entry to get data from. |
| `url` | No | The URL of the recipe. |

12
source/_integrations/media_extractor.markdown
View File

@ -24,23 +24,23 @@ Media extractor doesn't transcode streams, it just tries to find a stream that m
{% include integrations/config_flow.md %}
### Play media service
### Play media actions
Navigate to the **Services** tab inside **Developer Tools**. From the "Service" dropdown menu select `media_extractor.play_media` and then press the "Fill Example Data" button at the bottom of the page. Use the "Entity ID" dropdown to select your media player and then press the **Call Service** button.
Navigate to the **Actions** tab inside **Developer Tools**. From the **Actions** dropdown menu select `media_extractor.play_media` and then press the "Fill Example Data" button at the bottom of the page. Use the "Entity ID" dropdown to select your media player and then press the **Perform action** button.
This will download the file from the given URL.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------- |
| `entity_id` | yes | Name(s) of entities to seek media on, e.g., `media_player.living_room_chromecast`. Defaults to all. |
| `media_content_id` | no | The ID of the content to play. Platform dependent. |
| `media_content_type` | no | The type of the content to play. Must be one of MUSIC, TVSHOW, VIDEO, EPISODE, CHANNEL or PLAYLIST MUSIC. |
### Extract media URL service
### Extract media URL action
There is also a service that will directly return the URL in the response of the service.
There is also a action that will directly return the URL in the response of the action.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------ |
| `url` | no | The URL of the media to extract. |
| `format_query` | yes | The query that will be used to select the right media. |

50
source/_integrations/media_player.markdown
View File

@ -20,39 +20,39 @@ Interacts with media players on your network.
{% include integrations/building_block_integration.md %}
## Services
## Actions
### Media control services
Available services: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`, `volume_set`, `volume_mute`, `media_play_pause`, `media_play`, `media_pause`, `media_stop`, `media_next_track`, `media_previous_track`, `clear_playlist`, `shuffle_set`, `repeat_set`, `play_media`, `select_source`, `select_sound_mode`, `join`, `unjoin`
### Media control actions
Available actions: `turn_on`, `turn_off`, `toggle`, `volume_up`, `volume_down`, `volume_set`, `volume_mute`, `media_play_pause`, `media_play`, `media_pause`, `media_stop`, `media_next_track`, `media_previous_track`, `clear_playlist`, `shuffle_set`, `repeat_set`, `play_media`, `select_source`, `select_sound_mode`, `join`, `unjoin`
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------ |
| `entity_id` | yes | Target a specific media player. To target all media players, use `all`. |
#### Service `media_player.volume_mute`
#### Action `media_player.volume_mute`
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
|------------------------|----------|--------------------------------------------------|
| `entity_id` | yes | Target a specific media player. To target all media players, use `all`. |
| `is_volume_muted` | no | True/false for mute/unmute |
#### Service `media_player.volume_set`
#### Action `media_player.volume_set`
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
|------------------------|----------|--------------------------------------------------|
| `entity_id` | yes | Target a specific media player. To target all media players, use `all`. |
| `volume_level` | no | Float for volume level. Range 0..1 |
#### Service `media_player.media_seek`
#### Action `media_player.media_seek`
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
|------------------------|----------|--------------------------------------------------------|
| `entity_id` | yes | Target a specific media player. To target all media players, use `all`. |
| `seek_position` | no | Position to seek to. The format is platform dependent. |
#### Service `media_player.play_media`
#### Action `media_player.play_media`
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| -----------------------| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | yes | Target a specific media player. To target all media players, use `all`. |
| `media_content_id` | no | A media identifier. The format of this is integration dependent. For example, you can provide URLs to Sonos and Cast but only a playlist ID to iTunes. |
@ -122,7 +122,7 @@ Documentation:
- [Google Dev Documentation MediaInformation](https://developers.google.com/cast/docs/reference/web_receiver/cast.framework.messages.MediaInformation)
Example of calling media_player service with title and image set:
Example of calling media player action with title and image set:
```yaml
service: media_player.play_media
@ -136,50 +136,50 @@ data:
title: HomeAssistantRadio
```
#### Service `media_player.select_source`
#### Action `media_player.select_source`
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------- |
| `entity_id` | yes | Target a specific media player. To target all media players, use `all`. |
| `source` | no | Name of the source to switch to. Platform dependent. |
#### Service `media_player.select_sound_mode`
#### Action `media_player.select_sound_mode`
Currently only supported on [Denon AVR](/integrations/denonavr/) and [Songpal](/integrations/songpal).
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------- |
| `entity_id` | yes | Target a specific media player. For example `media_player.marantz`|
| `sound_mode` | no | Name of the sound mode to switch to. Platform dependent.|
#### Service `media_player.shuffle_set`
#### Action `media_player.shuffle_set`
Currently only supported on [Sonos](/integrations/sonos), [Spotify](/integrations/spotify), [MPD](/integrations/mpd), [Kodi](/integrations/kodi), [Roon](/integrations/roon), [OwnTone](/integrations/forked_daapd), [Squeezebox](/integrations/squeezebox) and [Universal](/integrations/universal).
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------- |
| `entity_id` | yes | Target a specific media player. For example `media_player.spotify`|
| `shuffle` | no | `true`/`false` for enabling/disabling shuffle |
#### Service `media_player.repeat_set`
#### Action `media_player.repeat_set`
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------- |
| `entity_id` | yes | Target a specific media player. For example `media_player.kitchen`|
| `repeat` | no | `off`/`all`/`one` for setting repeat mode |
#### Service `media_player.join`
#### Action `media_player.join`
Allows to group media players together for synchronous playback. Only works on supported multiroom audio systems.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------- |
| `entity_id` | yes | The media player entity whose playback will be expanded to the players specified in `group_members`. |
| `group_members` | no | The player entities which will be synced with the playback from `entity_id`. |
#### Service `media_player.unjoin`
#### Action `media_player.unjoin`
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------- |
| `entity_id` | yes | Unjoin this media player from any player groups. |

2
source/_integrations/media_source.markdown
View File

@ -69,7 +69,7 @@ The media from the network storage is then automatically added to the local medi
## Playing media from a media source
To play media from a media source via a service call, use the uri
To play media from a media source via an action, use the uri
scheme `media-source://media_source/<media_dir>/<path>`.
Default `media_dir` is `local`.

2
source/_integrations/melcloud.markdown
View File

@ -53,7 +53,7 @@ The following parameters can be controlled for the `climate` platform entities:
#### Controlling vanes
The horizontal and vertical vane positions can be controlled using the corresponding `melcloud.set_vane_horizontal` and `melcloud.set_vane_vertical` services.
The horizontal and vertical vane positions can be controlled using the corresponding `melcloud.set_vane_horizontal` and `melcloud.set_vane_vertical` actions.
Swing mode can also be used to control vertical vane position.

6
source/_integrations/message_bird.markdown
View File

@ -39,7 +39,7 @@ api_key:
required: true
type: string
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
@ -52,9 +52,9 @@ sender:
### Usage
MessageBird is a notify platform and thus can be controlled by calling the notify service [as described here](/integrations/notify/). It will send a notification to the specified mobile phone number(s).
MessageBird is a notify platform and thus can be controlled by calling the notify action [as described here](/integrations/notify/). It will send a notification to the specified mobile phone number(s).
#### Example service payload
#### Example action payload
```json
{

2
source/_integrations/meteo_france.markdown
View File

@ -57,7 +57,7 @@ All the following sensors will be created :
Warning: The probability entities data are not always provided by the API. They are added only if available.
To enable an entity disabled by default, go in **Settings** -> **Devices & Services**, click on the city name in **Météo-France** and then the **X entities** link. You will have the list of the enabled entities. Here click the filter button and select **Show disable entities**. The disabled entities will be visible in the list, select the one you want to enable and click the **Enable Selected** button.
To enable an entity disabled by default, go in **Settings** -> **Devices & services**, click on the city name in **Météo-France** and then the **X entities** link. You will have the list of the enabled entities. Here click the filter button and select **Show disable entities**. The disabled entities will be visible in the list, select the one you want to enable and click the **Enable Selected** button.
### About `next_rain` condition sensor

2
source/_integrations/microsoft_face.markdown
View File

@ -59,7 +59,7 @@ This limits the processing and detection to elements provided by the group.
Home Assistant creates an entity for all groups and allows you to show the
state, person, and IDs directly on the frontend.
The following services are available for managing this feature and can be called
The following actions are available for managing this feature and can be called
via the Frontend, a script, or the REST API.
- *microsoft_face.create_group*

6
source/_integrations/mill.markdown
View File

@ -22,13 +22,13 @@ Integrates Mill heater into Home Assistant.
You can configure it for cloud access or local access.
Local access requires Generation 3 heaters (Sold from Autumn 2021)
## Integration services
## Actions
This cloud integration supports a service to set the temperature for the room connected to heater in the Mill app:
This cloud integration supports an action to set the temperature for the room connected to heater in the Mill app:
`mill.set_room_temperature`
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `room_name` | no | String with room name.
| `away_temp` | yes | Integer with temperature

16
source/_integrations/minio.markdown
View File

@ -121,39 +121,39 @@ automation:
{% endraw %}
## Platform services
## Actions
These services are provided:
These actions are provided:
- `get`
- `put`
- `remove`
### Service `minio.get`
### Action `minio.get`
Download file.
| Service data attribute | Required | Description |
| Data attribute | Required | Description |
| ---------------------- | -------- | ---------------------------------- |
| `bucket` | yes | Bucket to use |
| `key` | yes | Object key of the file |
| `file_path` | yes | File path on the local file system |
### Service `minio.put`
### Action `minio.put`
Upload file.
| Service data attribute | Required | Description |
| Data attribute | Required | Description |
| ---------------------- | -------- | ---------------------------------- |
| `bucket` | yes | Bucket to use |
| `key` | yes | Object key of the file |
| `file_path` | yes | File path on the local file system |
### Service `minio.remove`
### Action `minio.remove`
Delete file.
| Service data attribute | Required | Description |
| Data attribute | Required | Description |
| ---------------------- | -------- | ---------------------- |
| `bucket` | yes | Bucket to use |
| `key` | yes | Object key of the file |

16
source/_integrations/modbus.markdown
View File

@ -1602,11 +1602,11 @@ Some parameters exclude other parameters, the following tables show what can be
| swap: word_byte | No | No | No | Yes | Yes |
# modbus services
# Actions
The modbus integration provides two generic write services in addition to the platform-specific services.
The modbus integration provides two generic write actions in addition to the platform-specific actions.
| Service | Description |
| Action | Description |
| --------------------- | --------------------------- |
| modbus.write_register | Write register or registers |
| modbus.write_coil | Write coil or coils |
@ -1634,17 +1634,17 @@ data:
value: [0x4120, 0x0000]
```
## Service `modbus.set-temperature`
## Action `modbus.set-temperature`
| Service | Description |
| Action | Description |
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| set_temperature | Set temperature. Requires `value` to be passed in, which is the desired target temperature. `value` should be in the same type as `data_type` |
## Service `modbus.set_hvac_mode`
## Action `modbus.set_hvac_mode`
| Service | Description |
| Action | Description |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| set_hvac_mode | Set HVAC mode. Requires `value` to be passed in, which is the desired mode. `value` should be a valid HVAC mode. A mapping between the desired state and the value to be written to the HVAC mode register must exist. Calling this service will also set the On/Off register to an appropriate value, if such a register is defined. |
| set_hvac_mode | Set HVAC mode. Requires `value` to be passed in, which is the desired mode. `value` should be a valid HVAC mode. A mapping between the desired state and the value to be written to the HVAC mode register must exist. Performing this action will also set the On/Off register to an appropriate value, if such a register is defined. |
# Opening an issue

28
source/_integrations/modern_forms.markdown
View File

@ -28,16 +28,16 @@ ha_integration_type: integration
{% include integrations/config_flow.md %}
{% note %}
If the Modern Forms fan does not have a light unit installed, then the Light entities and services will not show up.
If the Modern Forms fan does not have a light unit installed, then the Light entities and actions will not show up.
{% endnote %}
## Fans
The Modern Forms integration has support for the Modern Forms fans. This includes directional support, and sleep timer services for the fan.
The Modern Forms integration has support for the Modern Forms fans. This includes directional support, and sleep timer actions for the fan.
## Lights
The Modern Forms integration has support for the Modern Forms fans light. This includes brightness, and sleep timer services for the light.
The Modern Forms integration has support for the Modern Forms fans light. This includes brightness, and sleep timer actions for the light.
## Binary sensors
@ -60,29 +60,29 @@ The Modern Forms integration provides support for the following toggleable attri
- Away mode - to allow the fan simulate someone being home.
- Adaptive learning - for allow learning for away mode.
## Services
## Actions
### Service `modern_forms.clear_fan_sleep_timer`
### Action `modern_forms.clear_fan_sleep_timer`
This service will clear the sleep timer for the fan if it has been set. It will not turn off the fan when the timer is cleared.
This action will clear the sleep timer for the fan if it has been set. It will not turn off the fan when the timer is cleared.
### Service `modern_forms.clear_light_sleep_timer`
### Action `modern_forms.clear_light_sleep_timer`
This service will clear the sleep timer for the light if it has been set. It will not turn off the light when the timer is cleared.
This action will clear the sleep timer for the light if it has been set. It will not turn off the light when the timer is cleared.
### Service `modern_forms.set_fan_sleep_timer`
### Action `modern_forms.set_fan_sleep_timer`
This service will set a sleep timer for the fan. When the sleep timer is expired it will turn off the fan.
This action will set a sleep timer for the fan. When the sleep timer is expired it will turn off the fan.
| Service Data Attribute | Required | Description |
| Data attribute | Required | Description |
| ---------------------- | -------- | -------------------------------------------------- |
| `sleep_time` | yes | The amount of time in minutes to set the sleep timer for. This is time in minutes from 1 to 1440 (1 day). |
### Service `modern_forms.set_light_sleep_timer`
### Action `modern_forms.set_light_sleep_timer`
This service will set a sleep timer for the light. When the sleep timer is expired it will turn off the light.
This action will set a sleep timer for the light. When the sleep timer is expired it will turn off the light.
| Service Data Attribute | Required | Description |
| Data attribute | Required | Description |
| ---------------------- | -------- | -------------------------------------------------- |
| `sleep_time` | yes | The amount of time in minutes to set the sleep timer for. This is time in minutes from 1 to 1440 (1 day).|

10
source/_integrations/moehlenhoff_alpha2.markdown
View File

@ -42,15 +42,15 @@ Please note that after changing the temperature in Home Assistant,
it may take up to 10 minutes for your room control units to display these
changes.
### Integration services
### Actions
This integration supports the following services (see [Climate](/integrations/climate/)).
This integration supports the following actions (see [Climate](/integrations/climate/)).
- [`set_temperature`](/integrations/climate/#service-climateset_temperature)
- [`set_hvac_mode`](/integrations/climate/#service-climateset_hvac_mode)
- [`set_temperature`](/integrations/climate/#action-climateset_temperature)
- [`set_hvac_mode`](/integrations/climate/#action-climateset_hvac_mode)
- `heat` for heating mode
- `cool` for cooling mode
- [`set_preset_mode`](/integrations/climate/#service-climateset_preset_mode)
- [`set_preset_mode`](/integrations/climate/#action-climateset_preset_mode)
- `auto` enable schedule based operation
- `day` enable day mode
- `night` enable night mode

12
source/_integrations/monoprice.markdown
View File

@ -31,11 +31,11 @@ Sources can also be later edited from the integration options (gear icon in the
Devices and entities are created for each of the possible 18 zones, and can be enabled, disabled and renamed through regular Home Assistant methods.
By default, the first 6 zones (11..16) are enabled, and there's an attempt to automatically detect the 12 extension zones (21..26, and 31..36) on the first run.
## Services
## Actions
### Service `monoprice.snapshot`
### Action `monoprice.snapshot`
Take a snapshot of one or more zones' states. This service, and the following one are useful if you want to play a doorbell or notification sound and resume playback afterward. If `entity_id` is `all`, all zones are snapshotted.
Take a snapshot of one or more zones' states. This action, and the following one are useful if you want to play a doorbell or notification sound and resume playback afterward. If `entity_id` is `all`, all zones are snapshotted.
The following attributes are stored in a snapshot:
@ -44,14 +44,14 @@ The following attributes are stored in a snapshot:
- Volume level
- Source
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`s of zones.
### Service `monoprice.restore`
### Action `monoprice.restore`
Restore a previously taken snapshot of one or more speakers. If `entity_id` is `all`, all zones are restored.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`s of zones.

4
source/_integrations/monzo.markdown
View File

@ -41,9 +41,9 @@ The **Monzo** {% term integration %} allows you to connect your Monzo bank accou
1. To add a second Monzo account in Home Assistant, repeat the above process for creating an OAuth client.
2. Then, in Home Assistant, add the new credentials *before* trying to add the new entry.
- In the top right of **Devices & Services** page, select the three dot menu, open **Application Credentials**, and select **Add application credentials**
- In the top right of **Devices & services** page, select the three dot menu, open **Application Credentials**, and select **Add application credentials**
- It is recommended to include the person's name in the *Name* field so you can distinguish it later.
3. Once added, you can return to **Devices & Services** > **Monzo** > **Add Entry** to proceed with authentication.
3. Once added, you can return to **Devices & services** > **Monzo** > **Add Entry** to proceed with authentication.
## Sensor

12
source/_integrations/motion_blinds.markdown
View File

@ -133,13 +133,13 @@ Therefore it is recommended to use scripts or automations with the TDBU Combined
That will ensure the same absolute position with respect to the window is achieved without letting the Bottom or Top bar move to an absolute_position that is not allowed.
When the `motion_blinds.set_absolute_position` service is used with values that would move the Bottom or Top bar to positions that will make them collide, nothing will happen. An error will be logged telling that that position is not allowed and the TDBU blind will not move.
When the `motion_blinds.set_absolute_position` action is used with values that would move the Bottom or Top bar to positions that will make them collide, nothing will happen. An error will be logged telling that that position is not allowed and the TDBU blind will not move.
Therefore it is always safe to use any of the services in Home Assistant with the TDBU blinds.
Therefore it is always safe to use any of the actions in Home Assistant with the TDBU blinds.
## Service `motion_blinds.set_absolute_position`
## Action `motion_blinds.set_absolute_position`
For simple blinds the `motion_blinds.set_absolute_position` does the same as `cover.set_cover_position` service.
For simple blinds the `motion_blinds.set_absolute_position` does the same as `cover.set_cover_position` action.
### TDBU blinds
@ -150,7 +150,7 @@ The `cover.set_cover_position` will set the scaled position relative to the spac
For tilt capable blinds a new position and tilt can be specified and the blind will move to the new position and then adjust its tilt. If the normal `cover.set_cover_position` is issued and immediately after a `cover.set_cover_tilt_position` is issued, the blind will stop moving and start adjusting the tilt before it reaches the intended position.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------- |
| `entity_id` | yes | Name of the Motionblinds cover entity to control. For example `cover.TopDownBottomUp-Bottom-0001` |
| `absolute_position` | no | Absolute position to move to. For example 70 |
@ -192,7 +192,7 @@ The default update interval of the Motionblinds integration is every 10 minutes.
To increase the polling interval:
Go to Settings -> Integrations -> on the already set up Motionblinds integration click more options (three dots) and select "System options" -> disable "polling for updates".
Now create an automation with as trigger a time pattern and select your desired polling time.
As the action select "Call service" and select "Update entity", select one of the Motionblinds covers as entity.
As the action select **Perform action** and select **Update entity**, select one of the Motionblinds covers as entity.
You only have to create one automation with only one Motionblinds cover as entity, the rest will update at the same time.
Example YAML automation for custom polling interval (every minute):

4
source/_integrations/motionblinds_ble.markdown
View File

@ -53,9 +53,9 @@ The following entities are available for a Motionblinds Bluetooth device:
- Connection sensor: shows whether the blind is connected, disconnected, connecting, or disconnecting.
- Signal strength sensor: shows the signal strength in dBm.
## Services
## Actions
Since Motionblinds Bluetooth motors require a Bluetooth connection to control them, Home Assistant does not get automatic updates of the motor's state by default. Therefore, you can use the [homeassistant.update_entity](https://www.home-assistant.io/docs/scripts/service-calls/#homeassistant-services) service on any entity belonging to a Motionblinds Bluetooth device, which will connect to your Motionblinds Bluetooth motor and update the state of all entities belong to that device. However, be aware that doing so may impact battery life.
Since Motionblinds Bluetooth motors require a Bluetooth connection to control them, Home Assistant does not get automatic updates of the motor's state by default. Therefore, you can use the [homeassistant.update_entity](https://www.home-assistant.io/docs/scripts/service-calls/#homeassistant-actions) action on any entity belonging to a Motionblinds Bluetooth device, which will connect to your Motionblinds Bluetooth motor and update the state of all entities belong to that device. However, be aware that doing so may impact battery life.
This can also be automated using a YAML automation. For instance, the following automation connects to your Motionblind every 24 hours to update its state in Home Assistant:

10
source/_integrations/motioneye.markdown
View File

@ -69,7 +69,7 @@ Stream URL template:
| `sensor` | An "action sensor" that shows the number of configured [actions](https://github.com/ccrisan/motioneye/wiki/Action-Buttons) for this device. The names of the available actions are viewable in the `actions` attribute of the sensor entity. |
**Note**:
- If the video streaming switch is turned off, the camera entity, and services that operate on that camera, will become unavailable. The rest of the integration will continue to function.
- If the video streaming switch is turned off, the camera entity, and actions that operate on that camera, will become unavailable. The rest of the integration will continue to function.
- As cameras are added or removed to motionEye, devices/entities are automatically added or removed from Home Assistant.
@ -221,9 +221,9 @@ in automations (etc).
}
```
## Services
## Actions
All services accept either an `entity_id` or `device_id`.
All actions accept either an `entity_id` or `device_id`.
### motioneye.snapshot
@ -266,7 +266,7 @@ Parameters:
**Note**:
- Calling this service triggers a reset of the motionEye cameras which will pause the
- Calling this action triggers a reset of the motionEye cameras which will pause the
stream / recordings / motion detection (etc).
- Ensure the `Text Overlay` switch is turned on to actually display the configured text overlays.
@ -299,7 +299,7 @@ correctly associate media with the camera from which that media was captured.
## Example Dashboard Card
A dashboard card with icons that will call the `action` service to send action commands to motionEye.
A dashboard card with icons that will call the `action` action to send action commands to motionEye.
```yaml
- type: picture-glance

2
source/_integrations/mpd.markdown
View File

@ -16,7 +16,7 @@ related:
The Music Player Daemon {% term integration %} allows you to control a [Music Player Daemon](https://www.musicpd.org/) from Home Assistant. Unfortunately, it does not allow you to manipulate the playlist (add or delete songs) or add transitions between the songs.
Even though no playlist manipulation is possible, it is possible to use the play_media service to load an existing saved playlist as part of an automation or scene.
Even though no playlist manipulation is possible, it is possible to use the `play_media` action to load an existing saved playlist as part of an automation or scene.
{% include integrations/config_flow.md %}

26
source/_integrations/mqtt.markdown
View File

@ -136,7 +136,7 @@ MQTT broker settings are configured when the MQTT integration is first set up an
Add the MQTT integration, then provide your broker's hostname (or IP address) and port and (if required) the username and password that Home Assistant should use. To change the settings later, follow these steps:
1. Go to **{% my integrations title="Settings > Devices & Services" %}**.
1. Go to **{% my integrations title="Settings > Devices & services" %}**.
2. Select the MQTT integration.
3. Select **Configure**, then **Re-configure MQTT**.
@ -186,7 +186,7 @@ A configured client certificate will only be active if broker certificate valida
To change the settings, follow these steps:
1. Go to **{% my integrations title="Settings > Devices & Services" %}**.
1. Go to **{% my integrations title="Settings > Devices & services" %}**.
2. Select the MQTT integration.
3. Select **Configure**, then **Re-configure MQTT**.
4. To open the MQTT options page, select **Next**.
@ -212,9 +212,9 @@ The `mosquitto` broker package ships command line tools (often as `*-clients` pa
mosquitto_pub -h 127.0.0.1 -t homeassistant/switch/1/on -m "Switch is ON"
```
Another way to send MQTT messages manually is to use the **MQTT** integration in the frontend. Choose "Settings" on the left menu, click "Devices & Services", and choose "Configure" in the "Mosquitto broker" tile. Enter something similar to the example below into the "topic" field under "Publish a packet" and press "PUBLISH" .
Another way to send MQTT messages manually is to use the **MQTT** integration in the frontend. Choose "Settings" on the left menu, click "Devices & services", and choose "Configure" in the "Mosquitto broker" tile. Enter something similar to the example below into the "topic" field under "Publish a packet" and press "PUBLISH" .
1. Go to **{% my integrations title="Settings > Devices & Services" %}**.
1. Go to **{% my integrations title="Settings > Devices & services" %}**.
2. Select the Mosquitto broker integration, then select **Configure**.
3. Enter something similar to the example below into the **topic** field under **Publish a packet**. Select **Publish**.
@ -1029,9 +1029,9 @@ The MQTT integration supports templating. Read more [about using templates with
## MQTT Notifications
The MQTT notification support is different than for the other [notification](/integrations/notify/) integrations. It is a service. This means you need to provide more details when calling the service.
The MQTT notification support is different than for the other [notification](/integrations/notify/) integrations. It is an action. This means you need to provide more details when calling the action.
**Call Service** section from **Developer Tools** -> **Services** allows you to send MQTT messages. Choose *mqtt.publish* from the list of **Available services:** and enter something like the sample below into the **Service Data** field and hit **CALL SERVICE**.
**Perform action** section from **Developer Tools** -> **Actions** allows you to send MQTT messages. Choose *mqtt.publish* from the list of available actions, and enter something like the sample below into the **data** field and select **Perform action**.
```json
{
@ -1097,13 +1097,13 @@ script:
{% endraw %}
## Publish & Dump services
## Publish & Dump actions
The MQTT integration will register the service `mqtt.publish` which allows publishing messages to MQTT topics. There are two ways of specifying your payload. You can either use `payload` to hard-code a payload or use `payload_template` to specify a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) that will be rendered to generate the payload.
The MQTT integration will register the `mqtt.publish` action which allows publishing messages to MQTT topics. There are two ways of specifying your payload. You can either use `payload` to hard-code a payload or use `payload_template` to specify a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) that will be rendered to generate the payload.
### Service `mqtt.publish`
### Action `mqtt.publish`
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------ |
| `topic` | no | Topic to publish payload to. |
| `topic_template` | no | Template to render as topic to publish payload to. |
@ -1155,7 +1155,7 @@ you should take special care if `payload` contains template content.
Home Assistant will force you in to the YAML editor and will treat your
definition as a template. Make sure you escape the template blocks as like
in the example below. Home Assistant will convert the result to a string
and will pass it to the MQTT publish service.
and will pass it to the MQTT publish action.
The example below shows how to publish a temperature sensor 'Bathroom Temperature'.
The `device_class` is set, so it is not needed to set the "name" option. The entity
@ -1193,11 +1193,11 @@ qos: 2
retain: true
```
### Service `mqtt.dump`
### Action `mqtt.dump`
Listen to the specified topic matcher and dumps all received messages within a specific duration into the file `mqtt_dump.txt` in your configuration folder. This is useful when debugging a problem.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------------------------------- |
| `topic` | no | Topic to dump. Can contain a wildcard (`#` or `+`). |
| `duration` | yes | Duration in seconds that we will listen for messages. Default is 5 seconds. |

4
source/_integrations/msteams.markdown
View File

@ -32,7 +32,7 @@ notify:
{% configuration %}
name:
description: Setting this parameter allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
description: Setting this parameter allows multiple notifiers to be created. The notifier will bind to the `notify.NOTIFIER_NAME` action.
required: false
type: string
default: "notify"
@ -46,7 +46,7 @@ url:
The following attributes can be placed inside `data` for extended functionality.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------- |
| `image_url` | yes | Attach an image to the message. |

2
source/_integrations/mycroft.markdown
View File

@ -59,7 +59,7 @@ name:
## Examples
Send a message to Mycroft by calling `notify.mycroft` service:
Send a message to Mycroft by calling `notify.mycroft` action:
```yaml
message: "Hey Mycroft. Turn on the office light. "