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

Rename Services to Actions in integrations: H (#33815)

Browse Source 
* Rename Services to Actions in integrations: H

* Apply suggestions from code review

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* fix typo

* Update source/_integrations/heos.markdown

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Franck Nijhof 2024-07-17 06:10:51 +02:00 committed by GitHub
parent eeb63debc4
commit 69ee74fd82
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
20 changed files with 139 additions and 139 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
source/_integrations/habitica.markdown
View File

@ -63,23 +63,23 @@ If you are hosting your own instance of Habitica, you can specify a URL to it in
### API Service Parameters ### API Service Parameters
The API is exposed to Home Assistant as a service called `habitica.api_call`. To call it you should specify this keys in service data: The API is exposed to Home Assistant as an action called `habitica.api_call`. To call it, you should specify these keys in the data:
| Service data attribute | Required | Type | Description | | Data attribute | Required | Type | Description |
| ---------------------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------- | | ---------------------- | -------- | -------- | ----------------------------------------------------------------------------------------------------------------- |
| `name` | yes | string | Habitica's username as per `configuration.yaml` entry. | | `name` | yes | string | Habitica's username as per `configuration.yaml` entry. |
| `path` | yes | [string] | Items from API URL in form of an array with method attached at the end. See the example below. | | `path` | yes | [string] | Items from API URL in form of an array with method attached at the end. See the example below. |
| `args` | no | map | Any additional JSON or URL parameter arguments. See the example below and [apidoc](https://habitica.com/apidoc/). | | `args` | no | map | Any additional JSON or URL parameter arguments. See the example below and [apidoc](https://habitica.com/apidoc/). |
A successful call to this service will fire an event `habitica_api_call_success`. A successful run of this action will fire an event `habitica_api_call_success`.
| Event data attribute | Type | Description | | Event data attribute | Type | Description |
| -------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | -------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `name` | string | Copied from service data attribute. | | `name` | string | Copied from the data attribute. |
| `path` | [string] | Copied from service data attribute. | | `path` | [string] | Copied from the data attribute. |
| `data` | map | Deserialized `data` field of JSON object Habitica's server returned in response to API call. For more info see the [API documentation](https://habitica.com/apidoc/). | | `data` | map | Deserialized `data` field of JSON object Habitica's server returned in response to API call. For more info see the [API documentation](https://habitica.com/apidoc/). |
#### Let's consider some examples on how to call the service. #### Let's consider some examples on how to use the action
For example, let's say that there is a configured `habitica` platform for user `xxxNotAValidNickxxx` with their respective `api_user` and `api_key`. For example, let's say that there is a configured `habitica` platform for user `xxxNotAValidNickxxx` with their respective `api_user` and `api_key`.
Let's create a new task (a todo) for this user via Home Assistant. There is an [API call](https://habitica.com/apidoc/#api-Task-CreateUserTasks) for this purpose. Let's create a new task (a todo) for this user via Home Assistant. There is an [API call](https://habitica.com/apidoc/#api-Task-CreateUserTasks) for this purpose.

28
source/_integrations/harmony.markdown
View File

@ -33,7 +33,7 @@ Supported units:
**Note:** Depending on the firmware, you may need to enable XMPP for this integration to work. From your Harmony app, go to: **Menu** > **Harmony Setup** > **Add/Edit Devices & Activities** > **Remote & Hub** > **Enable XMPP**. **Note:** Depending on the firmware, you may need to enable XMPP for this integration to work. From your Harmony app, go to: **Menu** > **Harmony Setup** > **Add/Edit Devices & Activities** > **Remote & Hub** > **Enable XMPP**.
Once the Logitech Harmony Hub has been configured, the default activity and duration in seconds between sending commands to a device can be adjusted in the settings via **Settings** -> **Devices & Services** >> **Your Logitech Harmony Hub** Once the Logitech Harmony Hub has been configured, the default activity and duration in seconds between sending commands to a device can be adjusted in the settings via **Settings** -> **Devices & services** >> **Your Logitech Harmony Hub**
### Configuration file ### Configuration file
@ -45,19 +45,19 @@ Upon startup one file will be written to your Home Assistant configuration direc
This file will be overwritten whenever the Harmony HUB has a new configuration, there is no need to restart Home Assistant. This file will be overwritten whenever the Harmony HUB has a new configuration, there is no need to restart Home Assistant.
### Service `remote.turn_off` ### Action `remote.turn_off`
Turn off all devices that were switched on from the start of the current activity. Turn off all devices that were switched on from the start of the current activity.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | -------------------- | | ---------------------- | -------- | -------------------- |
| `entity_id` | no | Entity ID to target. | | `entity_id` | no | Entity ID to target. |
### Service `remote.turn_on` ### Action `remote.turn_on`
Start an activity. Will start the default `activity` from {% term "`configuration.yaml`" %} if no activity is specified. The specified activity can either be the activity name or the activity ID from the configuration file written to your [Home Assistant configuration directory](/docs/configuration/). Start an activity. Will start the default `activity` from {% term "`configuration.yaml`" %} if no activity is specified. The specified activity can either be the activity name or the activity ID from the configuration file written to your [Home Assistant configuration directory](/docs/configuration/).
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | -------------------------------------- | | ---------------------- | -------- | -------------------------------------- |
| `entity_id` | no | Entity ID to target. | | `entity_id` | no | Entity ID to target. |
| `activity` | yes | Activity ID or Activity Name to start. | | `activity` | yes | Activity ID or Activity Name to start. |
@ -77,7 +77,7 @@ In the file 'harmony_REMOTENAME.conf' you can find the available activities, for
} }
``` ```
Using the activity name 'Watch TV', you can call a service via automation to switch this activity on: Using the activity name 'Watch TV', you can perform an action via automation to switch this activity on:
```yaml ```yaml
action: action:
@ -88,11 +88,11 @@ action:
activity: "Watch TV" activity: "Watch TV"
``` ```
### Service `remote.send_command` ### Action `remote.send_command`
Send a single command or a set of commands to one device, device ID and available commands are written to the configuration file at startup. You can optionally specify the number of times you wish to repeat the command(s) and delay you want between repeated command(s). Send a single command or a set of commands to one device, device ID and available commands are written to the configuration file at startup. You can optionally specify the number of times you wish to repeat the command(s) and delay you want between repeated command(s).
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------- | | ---------------------- | -------- | --------------------------------------------------- |
| `entity_id` | no | Entity ID to target. | | `entity_id` | no | Entity ID to target. |
| `device` | no | Device ID or Device Name to send the command to. | | `device` | no | Device ID or Device Name to send the command to. |
@ -126,7 +126,7 @@ In the file 'harmony_REMOTENAME.conf' you can find the available devices and com
} }
``` ```
A typical service call for sending several button presses looks like this: A typical action for sending several button presses looks like this:
```yaml ```yaml
service: remote.send_command service: remote.send_command
@ -152,16 +152,16 @@ data:
delay_secs: 0.6 delay_secs: 0.6
``` ```
### Service `harmony.change_channel` ### Action `harmony.change_channel`
Sends the change channel command to the Harmony HUB Sends the change channel command to the Harmony HUB
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------- | | ---------------------- | -------- | --------------------------- |
| `entity_id` | no | Entity ID to target. | | `entity_id` | no | Entity ID to target. |
| `channel` | no | Channel number to change to | | `channel` | no | Channel number to change to |
A typical service call for changing the channel would be:: A typical action for changing the channel would be::
```yaml ```yaml
service: harmony.change_channel service: harmony.change_channel
@ -171,11 +171,11 @@ data:
channel: 200 channel: 200
``` ```
### Service `harmony.sync` ### Action `harmony.sync`
Force synchronization between the Harmony device and the Harmony cloud. Force synchronization between the Harmony device and the Harmony cloud.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | -------------------- | | ---------------------- | -------- | -------------------- |
| `entity_id` | no | Entity ID to target. | | `entity_id` | no | Entity ID to target. |

2
source/_integrations/hassio.markdown
View File

@ -122,7 +122,7 @@ Write data to add-on stdin.
### Action hassio.addon_update ### Action hassio.addon_update
Update add-on. This service should be used with caution since add-on updates can contain backward-incompatible changes. It is highly recommended that you review release notes/change logs before updating an add-on. Update add-on. This action should be used with caution since add-on updates can contain backward-incompatible changes. It is highly recommended that you review release notes/change logs before updating an add-on.
| Data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |

12
source/_integrations/hdmi_cec.markdown
View File

@ -14,7 +14,7 @@ ha_codeowners:
- '@inytar' - '@inytar'
--- ---
The `hdmi_cec` integration provides services that allow selecting the active device, powering on all devices, setting all devices to standby and creates switch entities for HDMI devices. Devices are defined in the configuration file by associating HDMI port number and a device name. Connected devices that provide further HDMI ports, such as sound-bars and AVRs are also supported. Devices are listed from the perspective of the CEC-enabled Home Assistant device. Any connected device can be listed, regardless of whether it supports CEC. Ideally the HDMI port number on your device will map correctly the CEC physical address. If it does not, use `cec-client` (part of the `libcec` package) to listen to traffic on the CEC bus and discover the correct numbers. The `hdmi_cec` integration provides actions that allow selecting the active device, powering on all devices, setting all devices to standby and creates switch entities for HDMI devices. Devices are defined in the configuration file by associating HDMI port number and a device name. Connected devices that provide further HDMI ports, such as sound-bars and AVRs are also supported. Devices are listed from the perspective of the CEC-enabled Home Assistant device. Any connected device can be listed, regardless of whether it supports CEC. Ideally the HDMI port number on your device will map correctly the CEC physical address. If it does not, use `cec-client` (part of the `libcec` package) to listen to traffic on the CEC bus and discover the correct numbers.
## CEC Setup ## CEC Setup
@ -149,11 +149,11 @@ hdmi_cec:
host: 192.168.1.3 host: 192.168.1.3
``` ```
## Services ## Actions
### Select Device ### Select Device
Call the `hdmi_cec.select_device` service with the name of the device from configuration or entity_id or physical address"to select it, for example: Use the `hdmi_cec.select_device` action with the name of the device from configuration or entity_id or physical address"to select it, for example:
```json ```json
{"device": "Chromecast"} {"device": "Chromecast"}
@ -178,7 +178,7 @@ action:
### Power On ### Power On
Call the `hdmi_cec.power_on` service (no arguments) to power on any devices that support this function. Use the `hdmi_cec.power_on` action (no arguments) to power on any devices that support this function.
An Automation action using the example above would look something like this. An Automation action using the example above would look something like this.
@ -189,7 +189,7 @@ action:
### Standby ### Standby
Call the `hdmi_cec.standby` service (no arguments) to place in standby any devices that support this function. Use the `hdmi_cec.standby` action (no arguments) to place in standby any devices that support this function.
An Automation action using the example above would look something like this. An Automation action using the example above would look something like this.
@ -200,7 +200,7 @@ action:
### Change volume level ### Change volume level
Call the `hdmi_cec.volume` service with one of following commands: Use the `hdmi_cec.volume` action with one of following commands:
#### Volume up #### Volume up

48
source/_integrations/heos.markdown
View File

@ -30,11 +30,11 @@ The HEOS integration adds support for [HEOS](https://www.denon.com/en-gb/categor
A connection to a single device enables control for all devices on the network. If you have multiple HEOS devices, enter the host of one that is connected to the LAN via wire or has the strongest wireless signal. A connection to a single device enables control for all devices on the network. If you have multiple HEOS devices, enter the host of one that is connected to the LAN via wire or has the strongest wireless signal.
{% endnote %} {% endnote %}
## Services ## Actions
### Service `heos.sign_in` ### Action `heos.sign_in`
Use the sign-in service (go to Developer Tools -> Services and then run the `heos.sign_in` with your username and password. Use the "Fill example data" first, then change it with your data. Check the logs right after, there you should see if the sign-in was successful or not) to sign the connected controller into a HEOS account so that it can retrieve and play HEOS favorites and playlists. An error message is logged if sign-in is unsuccessful. Example service data payload: Use the sign-in action (go to **Developer Tools** > **Actions** and then run the `heos.sign_in` with your username and password. Use the "Fill example data" first, then change it with your data. Check the logs right after, there you should see if the sign-in was successful or not) to sign the connected controller into a HEOS account so that it can retrieve and play HEOS favorites and playlists. An error message is logged if sign-in is unsuccessful. Example action data payload:
```yaml ```yaml
service: heos.sign_in service: heos.sign_in
@ -43,20 +43,20 @@ data:
password: "password" password: "password"
``` ```
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------ | | ---------------------- | -------- | ------------------------------------------ |
| `username` | no | The username or email of the HEOS account. | | `username` | no | The username or email of the HEOS account. |
| `password` | no | The password of the HEOS account. | | `password` | no | The password of the HEOS account. |
### Service `heos.sign_out` ### Action `heos.sign_out`
Use the sign-out service to sign the connected controller out of a HEOS account. An error message is logged if sign-out is unsuccessful. There are no parameters to this service. Use the sign-out action to sign the connected controller out of a HEOS account. An error message is logged if sign-out is unsuccessful. There are no parameters to this action.
### Service `media_player.play_media` ### Action `media_player.play_media`
#### Play favorite #### Play favorite
You can play a HEOS favorite by number or name with the `media_player.play_media` service. Example service data payload: You can play a HEOS favorite by number or name with the `media_player.play_media` action. Example action data payload:
```yaml ```yaml
service: media_player.play_media service: media_player.play_media
@ -66,7 +66,7 @@ data:
media_content_id: "1" media_content_id: "1"
``` ```
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------- | | ---------------------- | -------- | ------------------------------------------------------------------- |
| `entity_id` | yes | `entity_id` of the player(s) | | `entity_id` | yes | `entity_id` of the player(s) |
| `media_content_type` | no | Set to the value `favorite` | | `media_content_type` | no | Set to the value `favorite` |
@ -74,7 +74,7 @@ data:
#### Play playlist #### Play playlist
You can play a HEOS playlist with the `media_player.play_media` service. Example service data payload: You can play a HEOS playlist with the `media_player.play_media` action. Example action data payload:
```yaml ```yaml
service: media_player.play_media service: media_player.play_media
@ -84,7 +84,7 @@ data:
media_content_id: "Awesome Music" media_content_id: "Awesome Music"
``` ```
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------------------------- | | ---------------------- | -------- | ----------------------------- |
| `entity_id` | yes | `entity_id` of the player(s) | | `entity_id` | yes | `entity_id` of the player(s) |
| `media_content_type` | no | Set to the value `playlist` | | `media_content_type` | no | Set to the value `playlist` |
@ -92,7 +92,7 @@ data:
#### Play Quick Select #### Play Quick Select
You can play a HEOS Quick Select by number or name with the `media_player.play_media` service. Example service data payload: You can play a HEOS Quick Select by number or name with the `media_player.play_media` action. Example action data payload:
```yaml ```yaml
service: media_player.play_media service: media_player.play_media
@ -102,7 +102,7 @@ data:
media_content_id": "1" media_content_id": "1"
``` ```
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | -------------------------------------------------------------------- | | ---------------------- | -------- | -------------------------------------------------------------------- |
| `entity_id` | yes | `entity_id` of the player(s) | | `entity_id` | yes | `entity_id` of the player(s) |
| `media_content_type` | no | Set to the value `quick_select` | | `media_content_type` | no | Set to the value `quick_select` |
@ -110,7 +110,7 @@ data:
#### Play URL #### Play URL
You can play a URL through a HEOS media player using the `media_player.play_media` service. The HEOS player must be able to reach the URL. Example service data payload: You can play a URL through a HEOS media player using the `media_player.play_media` action. The HEOS player must be able to reach the URL. Example action data payload:
```yaml ```yaml
service: media_player.play_media service: media_player.play_media
@ -120,15 +120,15 @@ data:
media_content_id: "http://path.to/stream.mp3" media_content_id: "http://path.to/stream.mp3"
``` ```
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | -------------------------------------------- | | ---------------------- | -------- | -------------------------------------------- |
| `entity_id` | yes | `entity_id` of the player(s) to play the URL | | `entity_id` | yes | `entity_id` of the player(s) to play the URL |
| `media_content_type` | no | Set to the value `url` | | `media_content_type` | no | Set to the value `url` |
| `media_content_id` | no | The full URL to the stream | | `media_content_id` | no | The full URL to the stream |
### Service `media_player.join` ### Action `media_player.join`
For grouping HEOS media players together for synchronous playback you can use the `media_player.join` service. With the example service data payload down below you'll expand playback of `media_player.office` to the `media_player.kitchen` and `media_player.bathroom` players. Please note that all of the media players need to be HEOS players. For grouping HEOS media players together for synchronous playback you can use the `media_player.join` action. With the example action data payload down below you'll expand playback of `media_player.office` to the `media_player.kitchen` and `media_player.bathroom` players. Please note that all of the media players need to be HEOS players.
```yaml ```yaml
service: media_player.join service: media_player.join
@ -139,15 +139,15 @@ data:
- media_player.bathroom - media_player.bathroom
``` ```
| 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`. | | `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`. | | `group_members` | no | The player entities which will be synced with the playback from `entity_id`. |
### Service `media_player.unjoin` ### Action `media_player.unjoin`
For removing a HEOS player from a group you can use the `media_player.unjoin` service. For removing a HEOS player from a group you can use the `media_player.unjoin` action.
```yaml ```yaml
service: media_player.unjoin service: media_player.unjoin
@ -155,7 +155,7 @@ data:
entity_id: media_player.office entity_id: media_player.office
``` ```
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------ | | ---------------------- | -------- | ------------------------------------------------ |
| `entity_id` | yes | Unjoin this media player from any player groups. | | `entity_id` | yes | Unjoin this media player from any player groups. |
@ -180,7 +180,7 @@ logger:
### Missing Favorites ### Missing Favorites
If the HEOS controller is not signed in to a HEOS account, HEOS favorites will not be populated in the media player source selection and the service `media_player.play_media` for `favorite` and `playlist` will fail. Additionally, the following warning will be logged at startup: If the HEOS controller is not signed in to a HEOS account, HEOS favorites will not be populated in the media player source selection and the `media_player.play_media` action for `favorite` and `playlist` will fail. Additionally, the following warning will be logged at startup:
> IP_ADDRESS is not logged in to a HEOS account and will be unable to retrieve HEOS favorites: Use the 'heos.sign_in' service to sign-in to a HEOS account > IP_ADDRESS is not logged in to a HEOS account and will be unable to retrieve HEOS favorites: Use the 'heos.sign_in' action to sign-in to a HEOS account
To resolve this issue, use the `heos.sign_in` service to sign the controller into an account as documented above. This only needs to be performed once, as the controller will remain signed in while the account credentials are valid. To resolve this issue, use the `heos.sign_in` action to sign the controller into an account as documented above. This only needs to be performed once, as the controller will remain signed in while the account credentials are valid.

2
source/_integrations/here_travel_time.markdown
View File

@ -64,7 +64,7 @@ input_select:
## Updating sensors on-demand using Automation ## Updating sensors on-demand using Automation
You can also use the `homeassistant.update_entity` service to update the sensor on-demand. For example, if you want to update `sensor.morning_commute` every 2 minutes on weekday mornings, you can use the following automation: You can also use the `homeassistant.update_entity` action to update the sensor on-demand. For example, if you want to update `sensor.morning_commute` every 2 minutes on weekday mornings, you can use the following automation:
```yaml ```yaml
automation: automation:

20
source/_integrations/hive.markdown
View File

@ -47,13 +47,13 @@ Menu: *Configuration* > *Integrations* > *Select your new integration* > *Press
- **Scan Interval**: Update the scan interval allowing the integration to poll for data more frequently (Cannot be set lower than 30 seconds). - **Scan Interval**: Update the scan interval allowing the integration to poll for data more frequently (Cannot be set lower than 30 seconds).
## Services ## Actions
### Service `hive.boost_heating_on` ### Action `hive.boost_heating_on`
You can use the service `hive.boost_heating_on` to set your heating to boost for a period of time at a certain target temperature". Individual TRVs can also be boosted in the same way, using this service. You can use the action `hive.boost_heating_on` to set your heating to boost for a period of time at a certain target temperature". Individual TRVs can also be boosted in the same way, using this action.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------- | | ---------------------- | -------- | ---------------------------------------------------------------------- |
| `entity_id` | no | String, Name of entity e.g., `climate.heating` | | `entity_id` | no | String, Name of entity e.g., `climate.heating` |
| `time_period` | no | Time Period, Period of time the boost should last for e.g., `01:30:00` | | `time_period` | no | Time Period, Period of time the boost should last for e.g., `01:30:00` |
@ -74,11 +74,11 @@ script:
temperature: "20.5" temperature: "20.5"
``` ```
### Service `hive.boost_heating_off` ### Action `hive.boost_heating_off`
You can use the service `hive.boost_heating_off` to turn your heating boost off. You can use the `hive.boost_heating_off` action to turn your heating boost off.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------- | | ---------------------- | -------- | ---------------------------------------------- |
| `entity_id` | no | String, Name of entity e.g., `climate.heating` | | `entity_id` | no | String, Name of entity e.g., `climate.heating` |
@ -94,11 +94,11 @@ script:
entity_id: "climate.heating" entity_id: "climate.heating"
``` ```
### Service `hive.boost_hot_water` ### Action `hive.boost_hot_water`
You can use the service `hive.boost_hot_water` to set your hot water to boost for a period of time. You can use the `hive.boost_hot_water` action to set your hot water to boost for a period of time.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------------------------------------------------------------------- | | ---------------------- | -------- | ----------------------------------------------------------------------- |
| `entity_id` | no | String, Name of entity e.g., `water_heater.hot_water` | | `entity_id` | no | String, Name of entity e.g., `water_heater.hot_water` |
| `time_period` | yes | Time Period, Period of time the boost should last for e.g., `01:30:00`. | | `time_period` | yes | Time Period, Period of time the boost should last for e.g., `01:30:00`. |

34
source/_integrations/home_connect.markdown
View File

@ -68,54 +68,54 @@ Internal examples: `http://192.168.0.2:8123/auth/external/callback`, `http://hom
The integration configuration will ask for the *Client ID* and *Client Secret* created above. See [Application Credentials](/integrations/application_credentials) for more details. The integration configuration will ask for the *Client ID* and *Client Secret* created above. See [Application Credentials](/integrations/application_credentials) for more details.
## Services ## Actions
The Home Connect integration makes various services available. The Home Connect integration makes various actions available.
Available services: `set_option_active`, `set_option_selected`, `pause_program`, `resume_program`, `select_program`, `start_program` and `change_setting` Available actions: `set_option_active`, `set_option_selected`, `pause_program`, `resume_program`, `select_program`, `start_program` and `change_setting`
### Service `home_connect.set_option_active` ### Action `home_connect.set_option_active`
Sets an option for the active program. Sets an option for the active program.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
|---------------------------|----------|--------------------------------------------------| |---------------------------|----------|--------------------------------------------------|
| `device_id` | no | Id of a device associated with the home appliance. | | `device_id` | no | Id of a device associated with the home appliance. |
| `key` | no | Key of the option. | | `key` | no | Key of the option. |
| `value` | no | Value of the option. | | `value` | no | Value of the option. |
| `unit` | yes | Unit for the option. | | `unit` | yes | Unit for the option. |
### Service `home_connect.set_option_selected` ### Action `home_connect.set_option_selected`
Sets an option for the selected program. Sets an option for the selected program.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
|---------------------------|----------|--------------------------------------------------| |---------------------------|----------|--------------------------------------------------|
| `device_id` | no | Id of a device associated with the home appliance. | | `device_id` | no | Id of a device associated with the home appliance. |
| `key` | no | Key of the option. | | `key` | no | Key of the option. |
| `value` | no | Value of the option. | | `value` | no | Value of the option. |
| `unit` | yes | Unit for the option. | | `unit` | yes | Unit for the option. |
### Service `home_connect.pause_program` ### Action `home_connect.pause_program`
Pauses the current running program. Pauses the current running program.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
|---------------------------|----------|--------------------------------------------------| |---------------------------|----------|--------------------------------------------------|
| `device_id` | no | Id of a device associated with the home appliance. | | `device_id` | no | Id of a device associated with the home appliance. |
### Service `home_connect.resume_program` ### Action `home_connect.resume_program`
Resumes a paused program. Resumes a paused program.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
|---------------------------|----------|--------------------------------------------------| |---------------------------|----------|--------------------------------------------------|
| `device_id` | no | Id of a device associated with the home appliance. | | `device_id` | no | Id of a device associated with the home appliance. |
### Service `home_connect.select_program` ### Action `home_connect.select_program`
Selects a program without starting it. Selects a program without starting it.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
|---------------------------|----------|--------------------------------------------------| |---------------------------|----------|--------------------------------------------------|
| `device_id` | no | Id of a device associated with the home appliance. | | `device_id` | no | Id of a device associated with the home appliance. |
| `program` | no | Program to select. | | `program` | no | Program to select. |
@ -123,11 +123,11 @@ Selects a program without starting it.
| `value` | yes | Value of the option. | | `value` | yes | Value of the option. |
| `unit` | yes | Unit for the option. | | `unit` | yes | Unit for the option. |
### Service `home_connect.start_program` ### Action `home_connect.start_program`
Selects a program and starts it. Selects a program and starts it.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
|---------------------------|----------|--------------------------------------------------| |---------------------------|----------|--------------------------------------------------|
| `device_id` | no | Id of a device associated with the home appliance. | | `device_id` | no | Id of a device associated with the home appliance. |
| `program` | no | Program to select. | | `program` | no | Program to select. |
@ -135,11 +135,11 @@ Selects a program and starts it.
| `value` | yes | Value of the option. | | `value` | yes | Value of the option. |
| `unit` | yes | Unit for the option. | | `unit` | yes | Unit for the option. |
### Service `home_connect.change_setting` ### Action `home_connect.change_setting`
Changes a setting. Changes a setting.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
|---------------------------|----------|--------------------------------------------------| |---------------------------|----------|--------------------------------------------------|
| `device_id` | no | Id of a device associated with the home appliance. | | `device_id` | no | Id of a device associated with the home appliance. |
| `key` | no | Key of the setting. | | `key` | no | Key of the setting. |

16
source/_integrations/homekit.markdown
View File

@ -330,7 +330,7 @@ The HomeKit Accessory Protocol Specification only allows a maximum of 150 unique
### Multiple HomeKit instances ### Multiple HomeKit instances
If you create a HomeKit integration via the UI (i.e., **Settings** > **Devices & Services**), it must be configured via the UI **only**. While the UI only offers limited configuration options at the moment, any attempt to configure a HomeKit instance created in the UI via the {% term "`configuration.yaml`" %} file will result in another instance of HomeKit running on a different port. If you create a HomeKit integration via the UI (i.e., **Settings** > **Devices & services**), it must be configured via the UI **only**. While the UI currently offers limited configuration options, any attempt to configure a HomeKit instance created in the UI via the {% term "`configuration.yaml`" %} file will result in another instance of HomeKit running on a different port.
It is recommended to only edit a HomeKit instance in the UI that was created in the UI, and likewise, only edit a HomeKit instance in YAML that was created in YAML. It is recommended to only edit a HomeKit instance in the UI that was created in the UI, and likewise, only edit a HomeKit instance in YAML that was created in YAML.
@ -340,7 +340,7 @@ When exposing a Camera, Activity based remote (a `remote` that supports activiti
To quickly add all accessory mode entities in the UI: To quickly add all accessory mode entities in the UI:
1. Create a new bridge via the UI (i.e., **{% my config_flow_start title="Settings > Devices & Services" domain=page.ha_domain %}**). 1. Create a new bridge via the UI (i.e., **{% my config_flow_start title="Settings > Devices & services" domain=page.ha_domain %}**).
2. Select `media_player`, `remote`, `lock`, and `camera` domains. 2. Select `media_player`, `remote`, `lock`, and `camera` domains.
3. Complete the flow as normal. 3. Complete the flow as normal.
4. Additional HomeKit entries for each entity that must operate in accessory mode will be created for each entity that does not already have one. 4. Additional HomeKit entries for each entity that must operate in accessory mode will be created for each entity that does not already have one.
@ -349,7 +349,7 @@ To quickly add all accessory mode entities in the UI:
To add a single entity in accessory mode: To add a single entity in accessory mode:
1. Create a new bridge via the UI (i.e., **{% my config_flow_start title="Settings > Devices & Services" domain=page.ha_domain %}**) 1. Create a new bridge via the UI (i.e., **{% my config_flow_start title="Settings > Devices & services" domain=page.ha_domain %}**)
2. Before pairing the bridge, access the options for the bridge. 2. Before pairing the bridge, access the options for the bridge.
3. Change the mode to `accessory` 3. Change the mode to `accessory`
4. Select the entity. 4. Select the entity.
@ -438,7 +438,7 @@ The following integrations are currently supported:
# Device triggers # Device triggers
Devices that support triggers can be added to the bridge by accessing options for the bridge in **{% my integrations title="Settings > Devices & Services" %}**. To use this feature, Advanced Mode must be enabled in your user profile. Devices that support triggers can be added to the bridge by accessing options for the bridge in **{% my integrations title="Settings > Devices & services" %}**. To use this feature, Advanced Mode must be enabled in your user profile.
Bridged device triggers are represented as a single press button on stateless programmable switches. This allows a HomeKit automation to run when a device trigger fires. Because the Apple Home app currently only shows the number of the button and not the name, users may find it easier to identify the name of the button in the `Eve for HomeKit` app. Bridged device triggers are represented as a single press button on stateless programmable switches. This allows a HomeKit automation to run when a device trigger fires. Because the Apple Home app currently only shows the number of the button and not the name, users may find it easier to identify the name of the button in the `Eve for HomeKit` app.
@ -447,7 +447,7 @@ Bridged device triggers are represented as a single press button on stateless pr
Entities exposed as `TelevisionMediaPlayer` and `ReceiverMediaPlayer` are controllable within the Apple Remote widget in Entities exposed as `TelevisionMediaPlayer` and `ReceiverMediaPlayer` are controllable within the Apple Remote widget in
Control Center. Play, pause, volume up and volume down should work out of the box depending on the `supported_features` Control Center. Play, pause, volume up and volume down should work out of the box depending on the `supported_features`
of the entity. However, if your television can be controlled in other ways outside of the `media_player` entity, (e.g., of the entity. However, if your television can be controlled in other ways outside of the `media_player` entity, (e.g.,
service calls to an IR blaster), it is possible to build an automation to take advantage of these events. performing actions to an IR blaster), it is possible to build an automation to take advantage of these events.
When a key is pressed within the Control Center Remote widget, the event `homekit_tv_remote_key_pressed` will be fired. When a key is pressed within the Control Center Remote widget, the event `homekit_tv_remote_key_pressed` will be fired.
The key name will be available in the event data in the `key_name` field. Example: The key name will be available in the event data in the `key_name` field. Example:
@ -640,7 +640,7 @@ Ensure that the [`ffmpeg`](/integrations/ffmpeg) integration is configured corre
#### Camera streaming is unstable or slow #### Camera streaming is unstable or slow
If your camera supports native H.264 streams, Home Assistant can avoid converting the video stream, which is an expensive operation. To enable native H.264 streaming when configured via YAML, change the `video_codec` to `copy`. To allow native H.264 streaming when setting up HomeKit via the UI, go to **Settings** > **Devices & Services** in the UI, click **Options** for your HomeKit Bridge, and check the box for your camera on the `Cameras that support native H.264 streams` screen. If your camera supports native H.264 streams, Home Assistant can avoid converting the video stream, which is an expensive operation. To enable native H.264 streaming when configured via YAML, change the `video_codec` to `copy`. To allow native H.264 streaming when setting up HomeKit via the UI, go to **Settings** > **Devices & services** in the UI, click **Options** for your HomeKit Bridge, and check the box for your camera on the `Cameras that support native H.264 streams` screen.
#### Multiple camera streams #### Multiple camera streams
@ -664,7 +664,7 @@ HomeKit camera snapshots tie up the HomeKit connection during snapshots. To avoi
#### Resetting accessories #### Resetting accessories
You may use the service `homekit.reset_accessory` with one or more entity IDs to reset accessories whose configuration may have changed. This can be useful when changing a media player's device class to `tv`, linking a battery, or whenever Home Assistant adds support for new HomeKit features to existing entities. You may use the `homekit.reset_accessory` action with one or more entity IDs to reset accessories whose configuration may have changed. This can be useful when changing a media player's device class to `tv`, linking a battery, or whenever Home Assistant adds support for new HomeKit features to existing entities.
On earlier versions of Home Assistant, you can reset accessories by removing the entity from HomeKit (via [filter](#configure-filter)) and then re-adding the accessory. On earlier versions of Home Assistant, you can reset accessories by removing the entity from HomeKit (via [filter](#configure-filter)) and then re-adding the accessory.
@ -672,7 +672,7 @@ With either strategy, the accessory will behave as if it's the first time the ac
#### Unpairing and Re-pairing #### Unpairing and Re-pairing
The HomeKit integration remembers a public key for each paired device. Occasionally the public key for a device pairing will be missing because of pairing failures. Suppose one or more devices show the accessory as unavailable. In that case, it may be necessary to unpair and re-pair the device to ensure the integration has the public key for each paired client. The `homekit.unpair` service will forcefully remove all pairings and allow re-pairing with the accessory. When setting up HomeKit from the UI, this avoids the sometimes time-consuming process of deleting and create a new instance. The HomeKit integration remembers a public key for each paired device. Occasionally, the public key for a device pairing will be missing because of pairing failures. Suppose one or more devices show the accessory as unavailable. In that case, it may be necessary to unpair and re-pair the device to ensure the integration has the public key for each paired client. The `homekit.unpair` action will forcefully remove all pairings and allow re-pairing with the accessory. When setting up HomeKit from the UI, this avoids the sometimes time-consuming process of deleting and create a new instance.
The accessory will behave as if it's the first time the accessory has been set up, so you will need to restore the name, group, room, scene, and/or automation settings. The accessory will behave as if it's the first time the accessory has been set up, so you will need to restore the name, group, room, scene, and/or automation settings.

6
source/_integrations/homekit_controller.markdown
View File

@ -79,7 +79,7 @@ The HomeKit Device integration automatically detects HomeKit [compatible devices
### To add a HomeKit device via Ethernet or Wi-Fi ### To add a HomeKit device via Ethernet or Wi-Fi
1. The device should have been discovered under **{% my integrations title="Settings > Devices & Services" %}**. 1. The device should have been discovered under **{% my integrations title="Settings > Devices & services" %}**.
2. On the HomeKit Device integration, select **Configure**. 2. On the HomeKit Device integration, select **Configure**.
![HomeKit integration](/images/integrations/homekit_controller/homekit_controller_add_01.png) ![HomeKit integration](/images/integrations/homekit_controller/homekit_controller_add_01.png)
@ -105,7 +105,7 @@ You can add a HomeKit [compatible device](#supported-devices) to Home Assistant
### To add a HomeKit device through Bluetooth ### To add a HomeKit device through Bluetooth
1. Power up your HomeKit device. 1. Power up your HomeKit device.
- If you have Bluetooth enabled, the device should be discovered under **{% my integrations title="Settings > Devices & Services" %}**. - If you have Bluetooth enabled, the device should be discovered under **{% my integrations title="Settings > Devices & services" %}**.
2. On the HomeKit Bridge integration, select **Configure**. 2. On the HomeKit Bridge integration, select **Configure**.
![HomeKit integration](/images/integrations/homekit_controller/homekit_controller_add_01.png) ![HomeKit integration](/images/integrations/homekit_controller/homekit_controller_add_01.png)
@ -174,7 +174,7 @@ This section describes how to add a HomeKit [compatible device](#supported-devic
- This leaves the {% term Thread %} network details on the HomeKit device. - This leaves the {% term Thread %} network details on the HomeKit device.
- The device will be automatically discovered by the HomeKit controller integration in Home Assistant. - The device will be automatically discovered by the HomeKit controller integration in Home Assistant.
- It will appear as a discovered device over {% term Thread %}. - It will appear as a discovered device over {% term Thread %}.
2. Under **{% my integrations title="Settings > Devices & Services" %}**, on the HomeKit integration, select **Configure**. 2. Under **{% my integrations title="Settings > Devices & services" %}**, on the HomeKit integration, select **Configure**.
![HomeKit integration](/images/integrations/homekit_controller/homekit_controller_add_01.png) ![HomeKit integration](/images/integrations/homekit_controller/homekit_controller_add_01.png)

10
source/_integrations/homematic.markdown
View File

@ -211,7 +211,7 @@ Resolving names can take some time. So when you start Home Assistant you won't s
### Multiple hosts ### Multiple hosts
In order to allow communication with multiple hosts or different protocols in parallel (wireless, wired and IP), multiple connections will be established, each to the configured destination. The name you choose for the host has to be unique and limited to ASCII letters. In order to allow communication with multiple hosts or different protocols in parallel (wireless, wired and IP), multiple connections will be established, each to the configured destination. The name you choose for the host has to be unique and limited to ASCII letters.
Using multiple hosts has the drawback, that the services (explained below) may not work as expected. Only one connection can be used for services, which limits the devices/variables a service can use to the scope/protocol of the host. Using multiple hosts has the drawback, that the actions (explained below) may not work as expected. Only one connection can be used for actions, which limits the devices/variables an action can use to the scope/protocol of the host.
This does *not* affect the entities in Home Assistant. They all use their own connection and work as expected. This does *not* affect the entities in Home Assistant. They all use their own connection and work as expected.
### Reading attributes of entities ### Reading attributes of entities
@ -292,7 +292,7 @@ To get the `homematic.keypress` event for some Homematic IP devices like WRC2 /
8. When your channel is working now, you can edit it to select the other channels one by one 8. When your channel is working now, you can edit it to select the other channels one by one
9. At the end, you can delete this program from the CCU 9. At the end, you can delete this program from the CCU
### Services ### Actions
- *homematic.virtualkey*: Simulate a keypress (or other valid action) on CCU/Homegear with device or virtual keys. - *homematic.virtualkey*: Simulate a keypress (or other valid action) on CCU/Homegear with device or virtual keys.
- *homematic.reconnect*: Reconnect to CCU/Homegear without restarting Home Assistant (useful when CCU has been restarted) - *homematic.reconnect*: Reconnect to CCU/Homegear without restarting Home Assistant (useful when CCU has been restarted)
@ -342,7 +342,7 @@ action:
#### Advanced examples #### Advanced examples
If you are familiar with the internals of Homematic devices, you can manually set values on the devices. This can serve as a workaround if support for a device is currently not available, or only limited functionality has been implemented. If you are familiar with the internals of Homematic devices, you can manually set values on the devices. This can serve as a workaround if support for a device is currently not available, or only limited functionality has been implemented.
Using this service provides you direct access to the setValue-method of the primary connection. If you have multiple hosts, you may select the one hosting a specific device by providing the proxy-parameter with a value equivalent to the name you have chosen. In the example configuration from above `rf`, `wired` and `ip` would be valid values. Using this action provides you direct access to the setValue-method of the primary connection. If you have multiple hosts, you may select the one hosting a specific device by providing the proxy-parameter with a value equivalent to the name you have chosen. In the example configuration from above, `rf`, `wired`, and `ip` would be valid values.
Manually turn on a switch actor: Manually turn on a switch actor:
@ -585,7 +585,7 @@ value:
### Usage ### Usage
`homematic` is a notify platform and can be controlled by calling the notify service [as described here](/integrations/notify/). `homematic` is a notify platform and can be controlled by calling the notify action [as described here](/integrations/notify/).
Only the `data` part of the event payload is processed. This part can specify or override the value given as configuration variable: Only the `data` part of the event payload is processed. This part can specify or override the value given as configuration variable:
@ -643,4 +643,4 @@ alert:
{% endraw %} {% endraw %}
Please note that the first `data` element belongs to the service `my_hm`, while the second one belongs to the event payload. Please note that the first `data` element belongs to the `my_hm` action, while the second one belongs to the event payload.

8
source/_integrations/homematicip_cloud.markdown
View File

@ -203,14 +203,14 @@ Within this delay the device registration should be completed in the App, otherw
In order for a device to be integrated into Home Assistant, it must first be implemented in the upstream library. A dump of your configuration is required for this, which is then attached to a new issue in the [upstream lib's](https://github.com/hahn-th/homematicip-rest-api) GitHub repository. In order for a device to be integrated into Home Assistant, it must first be implemented in the upstream library. A dump of your configuration is required for this, which is then attached to a new issue in the [upstream lib's](https://github.com/hahn-th/homematicip-rest-api) GitHub repository.
1. Create a dump of your access point configuration in Home Assistant: 1. Create a dump of your access point configuration in Home Assistant:
Developer Tools -> Services -> Select `homematicip_cloud.dump_hap_config` -> Execute. **Developer Tools** -> **Actions** -> Select `homematicip_cloud.dump_hap_config` -> Execute.
The default dump is anonymized and is written to your configuration directory (`hmip_config_XXXX.json`). The default dump is anonymized and is written to your configuration directory (`hmip_config_XXXX.json`).
2. Create a [new issue](https://github.com/hahn-th/homematicip-rest-api/issues/new) at this GitHub repository and attach the created dump file. 2. Create a [new issue](https://github.com/hahn-th/homematicip-rest-api/issues/new) at this GitHub repository and attach the created dump file.
Please be patient, wait for the implementation and a new release of the upstream library. Please be patient, wait for the implementation and a new release of the upstream library.
Afterward, this device can be implemented into Home Assistant. Afterward, this device can be implemented into Home Assistant.
## Services ## Actions
Executable by all users: Executable by all users:
- `homematicip_cloud.activate_eco_mode_with_duration`: Activate eco mode with duration. - `homematicip_cloud.activate_eco_mode_with_duration`: Activate eco mode with duration.
@ -224,9 +224,9 @@ Executable by administrators or within the context of an automation:
- `homematicip_cloud.dump_hap_config`: Dump the configuration of the Homematic IP Access Point(s). - `homematicip_cloud.dump_hap_config`: Dump the configuration of the Homematic IP Access Point(s).
- `homematicip_cloud.reset_energy_counter`: Reset energy counter of measuring actuators. - `homematicip_cloud.reset_energy_counter`: Reset energy counter of measuring actuators.
### Service examples ### Action examples
`accesspoint_id` (SGTIN) is optional for all services and only relevant if you have multiple Homematic IP Accesspoints connected to HA. If empty, service will be called for all configured Homematic IP Access Points. `accesspoint_id` (SGTIN) is optional for all actions and only relevant if you have multiple Homematic IP Accesspoints connected to HA. If empty, the action will be performed for all configured Homematic IP Access Points.
The `accesspoint_id` (SGTIN) can be found on top of the integration page, or on the back of your Homematic IP Accesspoint. The `accesspoint_id` (SGTIN) can be found on top of the integration page, or on the back of your Homematic IP Accesspoint.
Activate eco mode with duration. Activate eco mode with duration.

6
source/_integrations/homeworks.markdown
View File

@ -29,13 +29,13 @@ Homeworks keypad buttons are momentary switches. The button is pressed and rele
The protocol for automatically extracting device information from the controller isn't documented. Lights and keypads need to be added manually. This is done by configuring the integration after it has been added. The protocol for automatically extracting device information from the controller isn't documented. Lights and keypads need to be added manually. This is done by configuring the integration after it has been added.
## Services ## Actions
### Service `send_command` ### Action `send_command`
Send a custom command to the Lutron Homeworks controller. Send a custom command to the Lutron Homeworks controller.
| Service data attribute | Optional | Example | Description | | Data attribute | Optional | Example | Description |
| ---------------------- | -------- | ----------------------- | --------------------------------------------------- | | ---------------------- | -------- | ----------------------- | --------------------------------------------------- |
| `controller_id` | No | `homeworks` | The controller to which the command should be sent to. | | `controller_id` | No | `homeworks` | The controller to which the command should be sent to. |
| `command` | No | `KBP, [02:08:02:01], 1` | The command you want to send. This can either be a single command or a list of commands. In addition to the [commands supported by the controller](https://assets.lutron.com/a/documents/hwi%20rs232%20protocol.pdf), the special command `DELAY <ms>` is supported, where ms is the number of milliseconds to sleep. | | `command` | No | `KBP, [02:08:02:01], 1` | The command you want to send. This can either be a single command or a list of commands. In addition to the [commands supported by the controller](https://assets.lutron.com/a/documents/hwi%20rs232%20protocol.pdf), the special command `DELAY <ms>` is supported, where ms is the number of milliseconds to sleep. |

4
source/_integrations/honeywell.markdown
View File

@ -48,9 +48,9 @@ Other devices like Security systems are not currently supported by this integrat
The climate platform integrates Honeywell US-based thermostats into Home Assistant, allowing control of the thermostat through the user interface. The current inside temperature, operating mode, and fan state are also displayed on the thermostat card. The climate platform integrates Honeywell US-based thermostats into Home Assistant, allowing control of the thermostat through the user interface. The current inside temperature, operating mode, and fan state are also displayed on the thermostat card.
All [climate services](/integrations/climate) are supported except set_swing_mode. All [climate actions](/integrations/climate) are supported except set_swing_mode.
Due to the instability of the Honeywell total connect system, service calls within automations should repeat until success similar to the following example: Due to the instability of the Honeywell total connect system, actions within automations should repeat until success similar to the following example:
```yaml ```yaml
alias: "No one home" alias: "No one home"

8
source/_integrations/html5.markdown
View File

@ -89,9 +89,9 @@ Assuming the previous test completed successfully and your browser was registere
{% my developer_services badge %} {% my developer_services badge %}
1. Click on the My button above, or open Home Assistant in Chrome or Firefox, open the sidebar and click the Services button at the bottom (shaped like a remote control), located below the Developer Tools. 1. Click on the My button above.
2. From the Services dropdown, search for your HTML5 notify service (notify.html5) and select it. 2. From the **Actions** dropdown, search for your HTML5 notify action (`notify.html5`) and select it.
3. In the Service Data text box enter: `{"message":"hello world"}`, then press the CALL SERVICE button. 3. In the data text box enter: `{"message":"hello world"}`, then select the **Perform action** button.
4. If everything worked you should see a popup notification. 4. If everything worked you should see a popup notification.
### Usage ### Usage
@ -208,7 +208,7 @@ data:
### Dismiss ### Dismiss
You can dismiss notifications by using service html5.dismiss like so: You can dismiss notifications by using `html5.dismiss` action like so:
```yaml ```yaml
target: ['my phone'] target: ['my phone']

14
source/_integrations/huawei_lte.markdown
View File

@ -78,25 +78,25 @@ entities varies by device model and firmware version.
Unauthenticated mode and default list of notification recipient phone Unauthenticated mode and default list of notification recipient phone
numbers can be set using the integration's configuration options. numbers can be set using the integration's configuration options.
## Services ## Actions
The following router action services are available. When invoked by a user, administrator access is required. The following router action actions are available. When invoked by a user, administrator access is required.
### Service `huawei_lte.suspend_integration` ### Action `huawei_lte.suspend_integration`
Suspend integration. Suspending logs the integration out from the router, and stops accessing it. Suspend integration. Suspending logs the integration out from the router, and stops accessing it.
Useful e.g., if accessing the router web interface from another source such as a web browser is temporarily required. Useful e.g., if accessing the router web interface from another source such as a web browser is temporarily required.
Invoke the `huawei_lte.resume_integration` service to resume. Invoke the `huawei_lte.resume_integration` action to resume.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `url` | yes, if only one router configured | Router URL. | | `url` | yes, if only one router configured | Router URL. |
### Service `huawei_lte.resume_integration` ### Action `huawei_lte.resume_integration`
Resume suspended integration. Resume suspended integration.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `url` | yes, if only one router configured | Router URL. | | `url` | yes, if only one router configured | Router URL. |

10
source/_integrations/hue.markdown
View File

@ -49,11 +49,11 @@ In the Hue concept you can create (dynamic) scenes for the lights within rooms a
It is advised to use Hue scenes for controlling multiple lights at once for a smooth experience. If you individually control multiple lights and/or use Home Assistant scenes, each light command will be sent to each light one by one which doesn't give a very good user experience, while using a Hue scene sends commands to all lights at once in an optimized way, resulting in a smooth experience. It is advised to use Hue scenes for controlling multiple lights at once for a smooth experience. If you individually control multiple lights and/or use Home Assistant scenes, each light command will be sent to each light one by one which doesn't give a very good user experience, while using a Hue scene sends commands to all lights at once in an optimized way, resulting in a smooth experience.
### Service `hue.activate_scene` ### Action `hue.activate_scene`
To have more control over Hue scenes we've implemented a secondary, more advanced service to activate a Hue scene and set some properties at the same time, such as the Dynamic mode and/or brightness. To have more control over Hue scenes we've implemented a secondary, more advanced action to activate a Hue scene and set some properties at the same time, such as the Dynamic mode and/or brightness.
| Service Data Attribute | Required | Description | | Data attribute | Required | Description |
| ---------------------- | -------- | --------------------------------------------------------------------------------------------- | | ---------------------- | -------- | --------------------------------------------------------------------------------------------- |
| `entity_id` | yes | Entity ID of the Hue Scene entity you want to activate. | | `entity_id` | yes | Entity ID of the Hue Scene entity you want to activate. |
| `transition` | no | Transition duration (in seconds) it takes to bring devices to the state defined in the scene. | | `transition` | no | Transition duration (in seconds) it takes to bring devices to the state defined in the scene. |
@ -61,7 +61,7 @@ To have more control over Hue scenes we've implemented a secondary, more advance
| `speed` | no | Set the speed (of the dynamic palette) for this scene. | | `speed` | no | Set the speed (of the dynamic palette) for this scene. |
| `brightness` | no | Set the brightness for this scene. | | `brightness` | no | Set the brightness for this scene. |
You can use this service for example if you'd like to start/stop Dynamic Mode. You can use this action for example if you'd like to start/stop Dynamic Mode.
## Hue remotes and switches ## Hue remotes and switches
@ -75,6 +75,6 @@ At the time of writing, there's a limitation on the Hue API that each device can
Philips/Signify released a new version of their Hue bridge (square shape) and their legacy/V1 bridge (round shape) is now end of life and no longer supported by them. Home Assistant will continue to support the V1 Hue bridge as long as it is technically possible, although with a few limitations: Philips/Signify released a new version of their Hue bridge (square shape) and their legacy/V1 bridge (round shape) is now end of life and no longer supported by them. Home Assistant will continue to support the V1 Hue bridge as long as it is technically possible, although with a few limitations:
- Scene entities are not automatically created for V1 bridges. To call a Hue scene on a V1 bridge from Home Assistant we provide a service call to call a Hue scene by name. - Scene entities are not automatically created for V1 bridges. To activate a Hue scene on a V1 bridge from Home Assistant we provide an action to active it the Hue scene by name.
- State updates for devices/entities on a V1 bridges are not received instantly but polled on interval. - State updates for devices/entities on a V1 bridges are not received instantly but polled on interval.
- Light entities for Hue rooms are not automatically created for V1 bridges, you can opt-in for creating entities for rooms within the Integration's options. - Light entities for Hue rooms are not automatically created for V1 bridges, you can opt-in for creating entities for rooms within the Integration's options.

30
source/_integrations/humidifier.markdown
View File

@ -37,21 +37,21 @@ The following device classes are supported for humidifiers:
- **Humidifier**: Adds humidity to the air around it. - **Humidifier**: Adds humidity to the air around it.
- **Dehumidifier**: Removes humidity from the air around it. - **Dehumidifier**: Removes humidity from the air around it.
## Services ## Actions
### Humidifier services ### Humidifier actions
Available services: `humidifier.set_mode`, `humidifier.set_humidity`, `humidifier.turn_on`, `humidifier.turn_off`, `humidifier.toggle` Available actions: `humidifier.set_mode`, `humidifier.set_humidity`, `humidifier.turn_on`, `humidifier.turn_off`, `humidifier.toggle`
{% tip %} {% tip %}
Not all humidifier services may be available for your platform. Be sure to check the available services Home Assistant has enabled by checking the Services page in the [Developer Tools](/docs/tools/dev-tools/). Not all humidifier actions may be available for your platform. Be sure to check the available actions Home Assistant has enabled by checking the **Actions** page in the [Developer Tools](/docs/tools/dev-tools/).
{% endtip %} {% endtip %}
### Service `humidifier.set_mode` ### Action `humidifier.set_mode`
Set mode for the humidifier device. This service is only available if the device supports operating in several working modes. The list of available modes and the device functionality in every mode depend on the device itself. Set mode for the humidifier device. This action is only available if the device supports operating in several working modes. The list of available modes and the device functionality in every mode depend on the device itself.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of humidifier devices to control. | `entity_id` | yes | String or list of strings that point at `entity_id`'s of humidifier devices to control.
| `mode` | no | New mode. | `mode` | no | New mode.
@ -71,11 +71,11 @@ automation:
mode: "eco" mode: "eco"
``` ```
### Service `humidifier.set_humidity` ### Action `humidifier.set_humidity`
Set target humidity of the humidifier device Set target humidity of the humidifier 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 humidifier devices to control. | `entity_id` | yes | String or list of strings that point at `entity_id`'s of humidifier devices to control.
| `humidity` | no | New target humidity for humidifier device | `humidity` | no | New target humidity for humidifier device
@ -95,26 +95,26 @@ automation:
humidity: 60 humidity: 60
``` ```
### Service `humidifier.turn_on` ### Action `humidifier.turn_on`
Turn the humidifier device on. Turn the humidifier device on.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of humidifier devices to control. | `entity_id` | yes | String or list of strings that point at `entity_id`'s of humidifier devices to control.
### Service `humidifier.turn_off` ### Action `humidifier.turn_off`
Turn the humidifier device off. Turn the humidifier device off.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of humidifier devices to control. | `entity_id` | yes | String or list of strings that point at `entity_id`'s of humidifier devices to control.
### Service `humidifier.toggle` ### Action `humidifier.toggle`
Toggle the humidifier device on/off. Toggle the humidifier device on/off.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of humidifier devices to control. | `entity_id` | yes | String or list of strings that point at `entity_id`'s of humidifier devices to control.

2
source/_integrations/hunterdouglas_powerview.markdown
View File

@ -54,7 +54,7 @@ Generation 1 and 2 Pebble remotes use proprietary Bluetooth Low Energy (PLE) and
This will result in the shade positioning displayed within Home Assistant being incorrect. This will result in the shade positioning displayed within Home Assistant being incorrect.
{% note %} {% note %}
Calling the update entity service (`homeassistant.update_entity`) on a shade entity will trigger the hub to awaken a shade and report its current position. Calling the update entity action (`homeassistant.update_entity`) on a shade entity will trigger the hub to awaken a shade and report its current position.
[An example automation is available](#force-update-shade-position) below for mains powered shades. While the automation will work for battery-powered shades, it will quickly drain the batteries for these devices. [An example automation is available](#force-update-shade-position) below for mains powered shades. While the automation will work for battery-powered shades, it will quickly drain the batteries for these devices.
{% endnote %} {% endnote %}

6
source/_integrations/husqvarna_automower.markdown
View File

@ -165,13 +165,13 @@ The integration will create a switch for each stay-out zone defined for your mow
The integration will create a switch to enable or disable the schedule of the mower. If the switch is on, the mower will mow according to the schedule. If the switch is off the mower will return to the dock and park until further notice. The integration will create a switch to enable or disable the schedule of the mower. If the switch is on, the mower will mow according to the schedule. If the switch is off the mower will return to the dock and park until further notice.
## Services ## Actions
The integration offers the following services: The integration offers the following actions:
### Override schedule ### Override schedule
With this service, you can let your mower mow or park for a given time. You can select the override mode with the `override_mode´ attribute. This will override all your schedules during this time. The duration can be given in days, hours and/or minutes. The values for the duration have to be between 1 minute and 42 days. Seconds will be ignored. With this action, you can let your mower mow or park for a given time. You can select the override mode with the `override_mode´ attribute. This will override all your schedules during this time. The duration can be given in days, hours and/or minutes. The values for the duration have to be between 1 minute and 42 days. Seconds will be ignored.
```yaml ```yaml
# Replace <name> with the name of your mower. # Replace <name> with the name of your mower.