diff --git a/source/_integrations/abode.markdown b/source/_integrations/abode.markdown index c33bb3a3bec..4f9b2c7b053 100644 --- a/source/_integrations/abode.markdown +++ b/source/_integrations/abode.markdown @@ -38,7 +38,7 @@ There is currently support for the following {% term device %} types within Home - **Alarm control panel**: Reports on the current alarm status and can be used to arm and disarm the system. - **Binary sensor**: Reports on `Quick Actions`, `Door Contacts`, `Connectivity` {% term sensors %} (remotes, keypads, and status indicators), `Moisture` sensors, and `Motion` or `Occupancy` sensors. -- **Camera**: Reports on `Camera` devices and will download and show the latest captured still image. Can be turned off and on using the [`camera.turn_off`](/integrations/camera/#service-turn_off) and [`camera.turn_on`](/integrations/camera/#service-turn_on) {% term services %}. +- **Camera**: Reports on `Camera` devices and will download and show the latest captured still image. Can be turned off and on using the [`camera.turn_off`](/integrations/camera/#action-turn_off) and [`camera.turn_on`](/integrations/camera/#action-turn_on) {% term actions %}. - **Cover**: Reports on `Secure Barriers` and can be used to open and close the cover. - **Lock**: Reports on `Door Locks` and can be used to lock and unlock the door. - **Light**: Reports on `Dimmer` lights and can be used to dim or turn the light on and off. @@ -86,33 +86,33 @@ There is a unique list of known event_codes are defined in and the inferred groups and their ranges of event codes are defined in [timeline.py](https://github.com/jaraco/jaraco.abode/blob/main/jaraco/abode/helpers/timeline.py). -## Services +## Actions -Available {% term services %}: `change_setting`, `capture_image`, `trigger_automation` +Available {% term actions %}: `change_setting`, `capture_image`, `trigger_automation` -### Service `change_setting` +### Action `change_setting` Change settings on your Abode system. For a full list of settings and valid values, consult the [`jaraco.abode` settings section](https://github.com/jaraco/jaraco.abode/blob/main/README.rst#settings). -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `setting` | No | The setting you wish to change. | | `value` | No | The value you wish to change the setting to. | -### Service `capture_image` +### Action `capture_image` Request a new still image from your Abode camera. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `entity_id` | No | String or list of strings that point at `entity_id`s of Abode cameras. | -### Service `trigger_automation` +### Action `trigger_automation` Trigger an automation on your Abode system. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `entity_id` | No | String or list of strings that point at `entity_id`s of switches that represent your Abode automations. | diff --git a/source/_integrations/adguard.markdown b/source/_integrations/adguard.markdown index 656c268afc6..dbb2537c60b 100644 --- a/source/_integrations/adguard.markdown +++ b/source/_integrations/adguard.markdown @@ -58,53 +58,53 @@ Turning off Query Log will result in all sensors not receiving updates anymore. AdGuard relies on Query Log to provide stats. {% endimportant %} -## Services +## Actions -These {% term services %} allow one to manage filter subscriptions in AdGuard Home. -Using these services in automations could be helpful to block certain +These {% term actions %} allow one to manage filter subscriptions in AdGuard Home. +Using these actions in automations could be helpful to block certain sites/domains at certain times. For example, you could create a custom filter list that blocks social media sites during the day and releases them during the evening. -### Service `add_url` +### Action `add_url` Add a new filter subscription to AdGuard Home. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ------------------------------------------------------------ | | `name` | No | The name of the filter subscription. | | `url` | No | The filter URL to subscribe to, containing the filter rules. | -### Service `remove_url` +### Action `remove_url` Removes a filter subscription from AdGuard Home. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | -------------------------------------- | | `url` | No | The filter subscription URL to remove. | -### Service `enable_url` +### Action `enable_url` Enables a filter subscription in AdGuard Home. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | -------------------------------------- | | `url` | No | The filter subscription URL to enable. | -### Service `disable_url` +### Action `disable_url` Disables a filter subscription in AdGuard Home. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | --------------------------------------- | | `url` | No | The filter subscription URL to disable. | -### Service `refresh` +### Action `refresh` Refresh all filter subscriptions in AdGuard Home. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ------------------------------------------------- | | `force` | Yes | Force update (bypasses AdGuard Home throttling). | diff --git a/source/_integrations/ads.markdown b/source/_integrations/ads.markdown index 772d7e61440..99cdeaf23e7 100644 --- a/source/_integrations/ads.markdown +++ b/source/_integrations/ads.markdown @@ -60,9 +60,9 @@ ip_address: type: string {% endconfiguration %} -## Service +## Action -The ADS integration will register the service `write_by_name` allowing you to write a value to a variable on your ADS device. +The ADS integration will register the `write_by_name` action allowing you to write a value to a variable on your ADS device. ```json { @@ -72,7 +72,7 @@ The ADS integration will register the service `write_by_name` allowing you to wr } ``` -Service parameters: +Action parameters: - **adsvar**: Name of the variable on the ADS device. To access global variables on *TwinCAT2* use a prepending dot `.myvariable`, for TwinCAT3 use `GBL.myvariable`. - **adstype**: Specify the type of the variable. Use one of the following: `int`, `byte`, `uint`, `bool` diff --git a/source/_integrations/advantage_air.markdown b/source/_integrations/advantage_air.markdown index 32c056c2bb2..33079df8502 100644 --- a/source/_integrations/advantage_air.markdown +++ b/source/_integrations/advantage_air.markdown @@ -59,7 +59,7 @@ With MyPlace, any blinds and/or garage doors will be created as cover entities. The integration will create sensor entities for a variety of aspects: - The air filter sensor shows if it needs to be replaced. -- Two sensor entities will be created for the 'time to on' and 'time to off' features. Use the `advantage_air.set_time_to` service to change these. +- Two sensor entities will be created for the 'time to on' and 'time to off' features. Use the `advantage_air.set_time_to` action to change these. - Each zone that is temperature-controlled will have a sensor to show the temperature (disabled by default), and how open the damper is. - Each zone with a wireless temperature or motion sensor will have a sensor that reports its wireless RSSI. @@ -85,13 +85,13 @@ The update platform shows if the controller app requires an update. With MyLights or MyPlace, light entities will be created for each light. -## Services +## Actions -### Service `advantage_air.set_time_to` +### Action `advantage_air.set_time_to` Set the On/Off Timer using the relevant sensor entity. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `entity_id` | yes | `sensor.[name]_time_to_on` or `sensor.[name]_time_to_off` | `minutes` | no | Number of minutes between `0` and `720`. diff --git a/source/_integrations/aftership.markdown b/source/_integrations/aftership.markdown index 847373c567c..da78091aabb 100644 --- a/source/_integrations/aftership.markdown +++ b/source/_integrations/aftership.markdown @@ -26,21 +26,21 @@ AfterShip removed the Tracking API functionality from the Forever Free plan, and {% include integrations/config_flow.md %} -## Service `add_tracking` +## Action `add_tracking` - You can use the service `aftership.add_tracking` to add trackings to AfterShip. + You can use the `aftership.add_tracking` action to add trackings to AfterShip. -| Service data attribute | Required | Type | Description | +| Data attribute | Required | Type | Description | | ---------------------- | -------- | -------- | ----------- | | `tracking_number` | `True` | string | Tracking number | `slug` | `False` | string | Carrier e.g., `fedex` | `title` | `False` | string | Friendly name of package -## Service `remove_tracking` +## Action `remove_tracking` - You can use the service `aftership.remove_tracking` to remove trackings from AfterShip. + You can use the `aftership.remove_tracking` action to remove trackings from AfterShip. -| Service data attribute | Required | Type | Description | +| Data attribute | Required | Type | Description | | ---------------------- | -------- | -------- | ----------- | | `tracking_number` | `True` | string | Tracking number | `slug` | `True` | string | Carrier e.g., `fedex` diff --git a/source/_integrations/agent_dvr.markdown b/source/_integrations/agent_dvr.markdown index 2b4131e19bd..4306cc0eccf 100644 --- a/source/_integrations/agent_dvr.markdown +++ b/source/_integrations/agent_dvr.markdown @@ -30,36 +30,36 @@ Please ensure you are using Agent DVR v2.6.1.0 + Reports on the current alarm status and can be used to arm and disarm the system. -## Services +## Actions -Once loaded, the `agent_dvr` integration will expose services that can be called to perform various actions. The `entity_id` service attribute can specify one or more specific cameras. +Once loaded, the `agent_dvr` integration will expose actions that can be used. The `entity_id` action attribute can specify one or more specific cameras. -Available services: +Available actions: `enable_alerts`, `disable_alerts`, `start_recording`, `stop_recording`, `turn_on`, `turn_off`, `toggle`, `enable_motion_detection`,`disable_motion_detection` -### Service `enable_alerts`/`disable_alerts` +### Action `enable_alerts`/`disable_alerts` -These services enable or disable the device's alert events within Agent DVR. +These actions enable or disable the device's alert events within Agent DVR. -Service data attribute | Optional | Description +Data attribute | Optional | Description -|-|- `entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. -### Service `start_recording`/`stop_recording` +### Action `start_recording`/`stop_recording` -These services start or stop the device recording. +These actions start or stop the device recording. -Service data attribute | Optional | Description +Data attribute | Optional | Description -|-|- `entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. -### Service `turn_on`/`turn_off`/`toggle` +### Action `turn_on`/`turn_off`/`toggle` -These services turn on, off or toggle the device enabled state within Agent DVR +These actions turn on, off or toggle the device enabled state within Agent DVR -Service data attribute | Optional | Description +Data attribute | Optional | Description -|-|- `entity_id` | no | Name(s) of entities, e.g., `camera.living_room_camera`. diff --git a/source/_integrations/airzone_cloud.markdown b/source/_integrations/airzone_cloud.markdown index 7cea8a724fe..382fe8c5379 100644 --- a/source/_integrations/airzone_cloud.markdown +++ b/source/_integrations/airzone_cloud.markdown @@ -37,7 +37,7 @@ These devices are Wi-Fi controllers that are normally connected to a single air These devices are connected to ducted air conditioners, motorized grilles, and individual thermostats for every room (zone). Therefore, with a single ducted air conditioning system, the user can turn on and off the air conditioner and set different desired temperatures in each room. -A typical Airzone HVAC system consists of a parent device (called *master zone* in Airzone terminology) and child devices (called *slave zones* in Airzone terminology). The [HVAC mode](https://www.home-assistant.io/integrations/climate/#service-climateset_hvac_mode) can only be changed on the parent device. On child devices, you can only enable or disable the HVAC and adjust the desired temperature for that specific device. +A typical Airzone HVAC system consists of a parent device (called *master zone* in Airzone terminology) and child devices (called *slave zones* in Airzone terminology). The [HVAC mode](https://www.home-assistant.io/integrations/climate/#action-climateset_hvac_mode) can only be changed on the parent device. On child devices, you can only enable or disable the HVAC and adjust the desired temperature for that specific device. Note that multiple HVAC systems can be connected to the same Airzone web server. In this case, there will be one *parent zone* per HVAC system and there may also be *child zones* for each HVAC system. diff --git a/source/_integrations/alarm_control_panel.ifttt.markdown b/source/_integrations/alarm_control_panel.ifttt.markdown index 6f79d20bfe3..6172286f5ce 100644 --- a/source/_integrations/alarm_control_panel.ifttt.markdown +++ b/source/_integrations/alarm_control_panel.ifttt.markdown @@ -89,7 +89,7 @@ It is strongly discouraged to use this platform when you don't use encryption; o Next, you will need to set up the required IFTTT applets as listed below. -This platform supports the services `alarm_disarm`, `alarm_arm_away`, `alarm_arm_home` and `alarm_arm_night`. For each of these services, an IFTTT webhook will be triggered. +This platform supports the `alarm_disarm`, `alarm_arm_away`, `alarm_arm_home` and `alarm_arm_night` actions. For each of these actions, an IFTTT webhook will be triggered. For this system to operate correctly, the following IFTTT applets have to be setup. Obviously, if your alarm device does not support some states, no applets have to be provided for those. diff --git a/source/_integrations/alarm_control_panel.markdown b/source/_integrations/alarm_control_panel.markdown index 93c83687121..ac002248f01 100644 --- a/source/_integrations/alarm_control_panel.markdown +++ b/source/_integrations/alarm_control_panel.markdown @@ -17,11 +17,11 @@ Please see [manual alarm](/integrations/manual) or [template alarm](/integration {% include integrations/building_block_integration.md %} -### Services +### Actions -Depending on features supported by a specific integration alarm may expose the following services: +Depending on features supported by a specific integration alarm may expose the following actions: -| Service | Data | Description | +| Action | Data | Description | | ------- | ---- | ----------- | | `alarm_arm_home` | `entity_id`
`code` (optional) | Arm the alarm in the home mode. | `alarm_arm_away` | `entity_id`
`code` (optional) | Arm the alarm in the away mode. diff --git a/source/_integrations/alarmdecoder.markdown b/source/_integrations/alarmdecoder.markdown index cbc5bc4614f..e5eb3f90396 100644 --- a/source/_integrations/alarmdecoder.markdown +++ b/source/_integrations/alarmdecoder.markdown @@ -87,7 +87,7 @@ The settings for {% term zone %} are described below: There are several attributes available on the alarm panel to give you more information about your alarm. - `ac_power`: Set to `true` if your system has AC power supplying it. -- `alarm_event_occurred`: Set to `true` if your system was recently triggered. When `alarm_event_occurred` is `true`, it must be cleared by entering your code + 1 (or calling the `alarm_control_panel.alarm_disarm` service) before attempting to arm your alarm. +- `alarm_event_occurred`: Set to `true` if your system was recently triggered. When `alarm_event_occurred` is `true`, it must be cleared by entering your code + 1 (or calling the `alarm_control_panel.alarm_disarm` action) before attempting to arm your alarm. - `backlight_on`: Set to `true` if your keypad's backlight is on. - `battery_low`: Set to `true` if your system's back-up battery is low. - `check_zone`: Set to `true` if your system detects a problem with a zone. @@ -98,9 +98,9 @@ There are several attributes available on the alarm panel to give you more infor - `zone_bypassed`: Set to `true` if your system is currently bypassing a zone. - `code_arm_required`: Set to the value specified in your AlarmDecoder options. -## Services +## Actions -The **Alarm Decoder** {% term integration %} gives you access to several {% term services %} for you to control your alarm with. +The **Alarm Decoder** {% term integration %} gives you access to several {% term actions %} for you to control your alarm with. - `alarm_arm_away`: Arms the alarm in away mode; all faults will trigger the alarm. - `alarm_arm_home`: Arms the alarm in stay mode; faults to the doors or windows will trigger the alarm. @@ -110,12 +110,12 @@ The **Alarm Decoder** {% term integration %} gives you access to several {% term - `alarmdecoder.alarm_toggle_chime`: Toggles the alarm's chime state. {% note %} -`alarm_arm_custom_bypass` and `alarm_trigger`, while available in the services list in Home Assistant, are not currently implemented in the Alarm Decoder platform. +`alarm_arm_custom_bypass` and `alarm_trigger`, while available in the actions list in Home Assistant, are not currently implemented in the Alarm Decoder platform. {% endnote %} ### Examples -Using a combination of the available {% term services %} and attributes, you can create switch templates. +Using a combination of the available {% term actions %} and attributes, you can create switch templates. ### Chime status and control diff --git a/source/_integrations/alexa.intent.markdown b/source/_integrations/alexa.intent.markdown index 549be1331e6..3a6cd09ec7c 100644 --- a/source/_integrations/alexa.intent.markdown +++ b/source/_integrations/alexa.intent.markdown @@ -12,7 +12,7 @@ related: ## I want to build custom commands to use with Echo -The built-in Alexa integration allows you to integrate Home Assistant into Alexa/Amazon Echo. This integration will allow you to query information and call services within Home Assistant by using your voice. Home Assistant offers no built-in sentences but offers a framework for you to define your own. +The built-in Alexa integration allows you to integrate Home Assistant into Alexa/Amazon Echo. This integration will allow you to query information and perform actions within Home Assistant by using your voice. Home Assistant offers no built-in sentences but offers a framework for you to define your own. diff --git a/source/_integrations/alexa.smart_home.markdown b/source/_integrations/alexa.smart_home.markdown index 3bd6d613d85..ef4282d9366 100644 --- a/source/_integrations/alexa.smart_home.markdown +++ b/source/_integrations/alexa.smart_home.markdown @@ -497,7 +497,7 @@ Users must opt-in to the disarm by voice feature in the Alexa App. Alexa will re To use the existing code configured for the alarm control panel the `code` must be 4 digits and the `code_format` attribute must be `number`. After discovery, the Alexa app will offer the ability to use the existing `code`, or create an additional 4 digit PIN to use with Alexa. -The existing code is never communicated to Alexa from Home Assistant. During disarming, Alexa will ask for a PIN. The PIN spoken to Alexa is relayed to Home Assistant and passed to the `alarm_control_panel.alarm_disarm` service. If the `alarm_control_panel.alarm_disarm` service fails for any reason, it is assumed the PIN was incorrect and reported to Alexa as an invalid PIN. +The existing code is never communicated to Alexa from Home Assistant. During disarming, Alexa will ask for a PIN. The PIN spoken to Alexa is relayed to Home Assistant and passed to the `alarm_control_panel.alarm_disarm` action. If the `alarm_control_panel.alarm_disarm` action fails for any reason, it is assumed the PIN was incorrect and reported to Alexa as an invalid PIN. ### Alert, Automation, Group diff --git a/source/_integrations/amcrest.markdown b/source/_integrations/amcrest.markdown index f097ff73f5e..3a729edae66 100644 --- a/source/_integrations/amcrest.markdown +++ b/source/_integrations/amcrest.markdown @@ -192,11 +192,11 @@ Once loaded, the Amcrest integration will generate (Home Assistant) {% term even The event code is sent by Amcrest or Dahua devices in the payload as a "Code" member. To ease event matching in automations, this code is replicated in a more top-level `event` member in `data`. -## Services +## Actions -Once loaded, the `amcrest` integration will expose {% term services %} that can be called to perform various actions. The `entity_id` service attribute can specify one or more specific cameras, or `all` can be used to specify all configured Amcrest cameras. +Once loaded, the `amcrest` integration will expose {% term actions %} that can be called to perform various actions. The `entity_id` action attribute can specify one or more specific cameras, or `all` can be used to specify all configured Amcrest cameras. -Available {% term services %}: +Available {% term actions %}: `enable_audio`, `disable_audio`, `enable_motion_recording`, `disable_motion_recording`, `enable_recording`, `disable_recording`, @@ -204,61 +204,61 @@ Available {% term services %}: `start_tour`, `stop_tour`, and `ptz_control` -### Service `enable_audio`/`disable_audio` +### Action `enable_audio`/`disable_audio` -These {% term services %} enable or disable the camera's audio stream. +These {% term actions %} enable or disable the camera's audio stream. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- | | `entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. | -### Service `enable_motion_recording`/`disable_motion_recording` +### Action `enable_motion_recording`/`disable_motion_recording` -These {% term services %} enable or disable the camera to record a clip to its configured storage location when motion is detected. +These {% term actions %} enable or disable the camera to record a clip to its configured storage location when motion is detected. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- | | `entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. | -### Service `enable_recording`/`disable_recording` +### Action `enable_recording`/`disable_recording` -These services enable or disable the camera to continuously record to its configured storage location. +These actions enable or disable the camera to continuously record to its configured storage location. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- | | `entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. | -### Service `goto_preset` +### Action `goto_preset` -This service will cause the camera to move to one of the PTZ locations configured within the camera. +This action will cause the camera to move to one of the PTZ locations configured within the camera. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- | | `entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. | | `preset` | no | Preset number, starting from 1. | -### Service `set_color_bw` +### Action `set_color_bw` -This service will set the color mode of the camera. +This action will set the color mode of the camera. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- | | `entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. | | `color_bw` | no | One of `auto`, `bw` or `color`. | -### Service `start_tour`/`stop_tour` +### Action `start_tour`/`stop_tour` -These services start or stop the camera's PTZ tour function. +These actions start or stop the camera's PTZ tour function. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------- | | `entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. | -### Service `ptz_control` +### Action `ptz_control` If your Amcrest or Dahua camera supports PTZ, you will be able to pan, tilt or zoom your camera. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | | `entity_id` | no | The entity ID of the camera to control. May be a list of multiple entity IDs. To target all cameras, set entity ID to `all`. | | `movement` | no | Direction of the movement. Allowed values: `zoom_in`, `zoom_out`, `up`, `down`, `left`, `right`, `right_up`, `right_down`, `left_up`, `left_down` | diff --git a/source/_integrations/androidtv.markdown b/source/_integrations/androidtv.markdown index 7a072159f44..9dd9847ee30 100644 --- a/source/_integrations/androidtv.markdown +++ b/source/_integrations/androidtv.markdown @@ -106,7 +106,7 @@ If the setup for your Android or Fire TV device fails, then there is probably an 7. If you are using the [Python ADB implementation](#1-python-adb-implementation) approach, as mentioned above, there may be some issues with newer devices. In this case, you should use the [ADB server](#2-adb-server) approach instead. -## Services +## Actions ### `media_player.select_source` @@ -132,9 +132,9 @@ stop_netflix: ### `androidtv.adb_command` -The service `androidtv.adb_command` allows you to send either keys or ADB shell commands to your Android / Fire TV device. If there is any output, it will be stored in the `'adb_response'` attribute (i.e., `state_attr('media_player.android_tv_living_room', 'adb_response')` in a template) and logged at the INFO level. +The `androidtv.adb_command` action allows you to send either keys or ADB shell commands to your Android / Fire TV device. If there is any output, it will be stored in the `'adb_response'` attribute (i.e., `state_attr('media_player.android_tv_living_room', 'adb_response')` in a template) and logged at the INFO level. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `entity_id` | no | Name(s) of Android / Fire TV entities. | `command` | no | Either a key command or an ADB shell command. @@ -171,17 +171,17 @@ A list of various intents can be found [here](https://gist.github.com/mcfrojd/9e ### `androidtv.learn_sendevent` (for faster ADB commands) -When sending commands like UP, DOWN, HOME, etc. via ADB, the device can be slow to respond. The problem isn't ADB, but rather the Android command `input` that is used to perform those actions. A faster way to send these commands is using the Android `sendevent` command. The challenge is that these commands are device-specific. To assist users in learning commands for their device, the Android debug bridge integration provides the `androidtv.learn_sendevent` service. Its usage is as follows: +When sending commands like UP, DOWN, HOME, etc. via ADB, the device can be slow to respond. The problem isn't ADB, but rather the Android command `input` that is used to perform those actions. A faster way to send these commands is using the Android `sendevent` command. The challenge is that these commands are device-specific. To assist users in learning commands for their device, the Android debug bridge integration provides the `androidtv.learn_sendevent` action. Its usage is as follows: -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `entity_id` | no | Name(s) of Android / Fire TV entities. -1. Call the `androidtv.learn_sendevent` service. +1. Perform the `androidtv.learn_sendevent` action. 2. Within 8 seconds, hit a single button on your Android / Fire TV remote. -3. After 8 seconds, a persistent notification will appear that contains the equivalent command that can be sent via the `androidtv.adb_command` service. This command can also be found in the `adb_response` attribute of the media player in Home Assistant, and it will be logged at the INFO level. +3. After 8 seconds, a persistent notification will appear that contains the equivalent command that can be sent via the `androidtv.adb_command` action. This command can also be found in the `adb_response` attribute of the media player in Home Assistant, and it will be logged at the INFO level. -As an example, a service call in a [script](/docs/scripts) could be changed from this: +As an example, an action in a [script](/docs/scripts) could be changed from this: ```yaml # Send the "UP" command (slow) @@ -205,17 +205,17 @@ to this: ### `androidtv.download` and `androidtv.upload` -You can use the `androidtv.download` service to download a file from your Android / Fire TV device to your Home Assistant instance. +You can use the `androidtv.download` action to download a file from your Android / Fire TV device to your Home Assistant instance. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `entity_id` | no | Name of Android / Fire TV entity. | `device_path` | no | The filepath on the Android / Fire TV device. | `local_path` | no | The filepath on your Home Assistant instance. -Similarly, you can use the `androidtv.upload` service to upload a file from Home Assistant instance to Android / Fire TV devices. +Similarly, you can use the `androidtv.upload` action to upload a file from Home Assistant instance to Android / Fire TV devices. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `entity_id` | no | Name(s) of Android / Fire TV entities. | `device_path` | no | The filepath on the Android / Fire TV device. @@ -236,11 +236,11 @@ The solution to this problem is the `state_detection_rules` configuration parame - `'media_session_state'` = try to use the `media_session_state` property to determine the state - `'audio_state'` = try to use the `audio_state` property to determine the state -To determine what these rules should be, you can use the `androidtv.adb_command` service with the command `GET_PROPERTIES`, as described in the [androidtv.adb_command](#androidtvadb_command) section. +To determine what these rules should be, you can use the `androidtv.adb_command` action with the command `GET_PROPERTIES`, as described in the [androidtv.adb_command](#androidtvadb_command) section. ## Remote -The integration supports the `remote` platform. The remote allows you to send commands to your device with the `remote.send_command` service. You can send either keys or ADB shell commands to your Android / Fire TV device. The supported keys vary between Android models and version. +The integration supports the `remote` platform. The remote allows you to send commands to your device with the `remote.send_command` action. You can send either keys or ADB shell commands to your Android / Fire TV device. The supported keys vary between Android models and version. {% details "Full keycodes list" %} diff --git a/source/_integrations/androidtv_remote.markdown b/source/_integrations/androidtv_remote.markdown index 101f1682abd..60dd1ad5f14 100644 --- a/source/_integrations/androidtv_remote.markdown +++ b/source/_integrations/androidtv_remote.markdown @@ -38,7 +38,7 @@ Configure Applications List: This {% term integration %} adds a `media_player` with basic playback and volume controls. The media player provides volume information and display name of current active app on the Android TV. Due to API limitations, the integration will not display the playback status. It is recommended to use this integration together with [Google Cast integration](/integrations/cast/). Two media players can be combined into one using the [Universal Media Player](/integrations/universal/) integration. See [Using with Google Cast](#using-with-google-cast) section for more details. -Using the `media_player.play_media` {% term service %}, you can launch applications, switch channels, and start activities via `Deep Links`. Only `app`, `url` and `channel` media types are supported. +Using the `media_player.play_media` {% term action %}, you can launch applications, switch channels, and start activities via `Deep Links`. Only `app`, `url` and `channel` media types are supported. ### Launching apps @@ -157,9 +157,9 @@ media_player: ## Remote -The remote allows you to send key commands to your Android TV device with the `remote.send_command` service. +The remote allows you to send key commands to your Android TV device with the `remote.send_command` action. The entity has the `current_activity` attribute that shows the current foreground app on the Android TV. -You can pass the application ID shown in this `current_activity` as `activity` in the `remote.turn_on` service to launch that app. +You can pass the application ID shown in this `current_activity` as `activity` in the `remote.turn_on` action to launch that app. {% details "List of the most common commands" %} @@ -245,7 +245,7 @@ Other: If `activity` is specified in `remote.turn_on` it will open the specified URL or the application with the given package name. See [Launching apps section](#launching-apps). -Examples of service calls: +Example actions: ```yaml # Open the currently selected item on the Android TV diff --git a/source/_integrations/aosmith.markdown b/source/_integrations/aosmith.markdown index 1ca9c57b701..bc5466086af 100644 --- a/source/_integrations/aosmith.markdown +++ b/source/_integrations/aosmith.markdown @@ -62,12 +62,12 @@ The water heater entity offers the following capabilities: This table shows the supported operation modes. The available modes will depend on your specific water heater model. -| Mode displayed in A. O. Smith app | Mode displayed in Home Assistant | Mode name for `water_heater.set_operation_mode` service | -| ---------------------------------- | -------------------------------- | ------------------------------------------------------- | -| Electric/Standard | Electric | `electric` | -| Hybrid | Eco | `eco` | -| Heat Pump | Heat Pump | `heat_pump` | -| Vacation | N/A - use away mode | N/A - use `water_heater.set_away_mode` | +| Mode displayed in A. O. Smith app | Mode displayed in Home Assistant | Mode name for `water_heater.set_operation_mode` action | +| ---------------------------------- | -------------------------------- | ------------------------------------------------------ | +| Electric/Standard | Electric | `electric` | +| Hybrid | Eco | `eco` | +| Heat Pump | Heat Pump | `heat_pump` | +| Vacation | N/A - use away mode | N/A - use `water_heater.set_away_mode` | ### Sensor diff --git a/source/_integrations/apple_tv.markdown b/source/_integrations/apple_tv.markdown index 406a388f334..867850067c5 100644 --- a/source/_integrations/apple_tv.markdown +++ b/source/_integrations/apple_tv.markdown @@ -35,10 +35,10 @@ This entity will display the active app and playback controls. ### Launching apps -You can launch apps using the `media_player.select_source` service, or using the +You can launch apps using the `media_player.select_source` action, or using the “Apps” folder in the media browser. -Using the `media_player.play_media` service, you can also use `Deep Links` to +Using the `media_player.play_media` action, you can also use `Deep Links` to launch specific content in applications. Examples of some `Deep Links` for popular applications: @@ -109,7 +109,7 @@ The following commands are currently available: **NOTE:** Not all commands are supported by all Apple TV versions. -### Service `send_command` +### Action `send_command` | Service data
attribute | Optional | Description | | ------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------- | diff --git a/source/_integrations/apprise.markdown b/source/_integrations/apprise.markdown index 2ce75ae4898..d5b52d97d95 100644 --- a/source/_integrations/apprise.markdown +++ b/source/_integrations/apprise.markdown @@ -55,7 +55,7 @@ notify: {% configuration %} name: - description: The notifier will bind to the service `notify.NAME`. + description: The notifier will bind to the action `notify.NAME`. required: false type: string default: notify @@ -69,7 +69,7 @@ config: type: string {% endconfiguration %} -## Example service call +## Example action ```yaml - service: notify.NOTIFIER_NAME diff --git a/source/_integrations/atag.markdown b/source/_integrations/atag.markdown index 96ed0bdf297..02de4dbedd3 100644 --- a/source/_integrations/atag.markdown +++ b/source/_integrations/atag.markdown @@ -42,15 +42,15 @@ port: The `Atag` climate platform provides current and target temperature information for the heating system, boiler status and HVAC mode. -### Integration services +### Integration 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 thermostat mode - `auto` for weather-based mode -- [`set_preset_mode`](/integrations/climate/#service-climateset_preset_mode) +- [`set_preset_mode`](/integrations/climate/#action-climateset_preset_mode) - `Manual` enable manual operation - `Auto` enable schedule based operation - `Extend` delay the next scheduled temperature update by the default extend period diff --git a/source/_integrations/aurora.markdown b/source/_integrations/aurora.markdown index 5718aaa0e34..e179185786a 100644 --- a/source/_integrations/aurora.markdown +++ b/source/_integrations/aurora.markdown @@ -15,7 +15,7 @@ ha_platforms: ha_integration_type: integration --- -The `aurora` platform uses the [NOAA Aurora Forecast](https://www.swpc.noaa.gov/products/aurora-30-minute-forecast) service to let you know if an aurora might be visible at your home location in the next 30 minutes, based off of current solar flare activity. +The `aurora` platform uses the [NOAA Aurora Forecast](https://www.swpc.noaa.gov/products/aurora-30-minute-forecast) action to let you know if an aurora might be visible at your home location in the next 30 minutes, based off of current solar flare activity. This service gives a number 0-100 representing the current likelihood of visible auroras at your latitude/longitude. By default this sensor is set up to trigger when the reported likelihood for your location is > 75. It updates every 5 minutes. diff --git a/source/_integrations/aws.markdown b/source/_integrations/aws.markdown index 9682f1b4be5..d6b0df57f1b 100644 --- a/source/_integrations/aws.markdown +++ b/source/_integrations/aws.markdown @@ -96,7 +96,7 @@ profile_name: required: false 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 @@ -108,9 +108,9 @@ context: ## Lambda notify usage -AWS Lambda is a notification platform and thus can be controlled by calling the `notify` service [as described here](/integrations/notify/). It will invoke a Lambda for all targets given in the notification payload. A target can be formatted as a function name, an entire ARN ([Amazon Resource Name](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html)) or a partial ARN. For more information, please see the [botocore documentation](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/lambda/client/invoke.html). +AWS Lambda is a notification platform and thus can be controlled by calling the `notify` action [as described here](/integrations/notify/). It will invoke a Lambda for all targets given in the notification payload. A target can be formatted as a function name, an entire ARN ([Amazon Resource Name](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html)) or a partial ARN. For more information, please see the [botocore documentation](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/lambda/client/invoke.html). -The Lambda event payload will contain everything passed in the service call payload. Here is an example payload that would be sent to Lambda: +The Lambda event payload will contain everything passed in the action payload. Here is an example payload that would be sent to Lambda: ```json { @@ -136,7 +136,7 @@ The context will look like this: ## SNS notify usage -AWS SNS is a notification platform and thus can be controlled by calling the `notify` service [as described here](/integrations/notify/). It will publish a message to all targets given in the notification payload. A target must be a SNS topic or endpoint ARN ([Amazon Resource Name](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html)). For more information, please see the [botocore documentation](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/sns/client/publish.html). +AWS SNS is a notification platform and thus can be controlled by calling the `notify` action [as described here](/integrations/notify/). It will publish a message to all targets given in the notification payload. A target must be a SNS topic or endpoint ARN ([Amazon Resource Name](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html)). For more information, please see the [botocore documentation](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/sns/client/publish.html). If one exists, the SNS Subject will be set to the title. All attributes from the payload, except the message, will be sent as stringified message attributes. @@ -162,9 +162,9 @@ If you do not download them, you will lose them and will have to recreate a new ## SQS Notify Usage -AWS SQS is a notification platform and thus can be controlled by calling the `notify` service [as described here](/integrations/notify/). It will publish a message to the queue for all targets given in the notification payload. A target must be a SQS topic URL. For more information, please see the [SQS documentation](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html) and [botocore documentation](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/sqs/client/send_message.html) +AWS SQS is a notification platform and thus can be controlled by calling the `notify` action [as described here](/integrations/notify/). It will publish a message to the queue for all targets given in the notification payload. A target must be a SQS topic URL. For more information, please see the [SQS documentation](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-queue-message-identifiers.html) and [botocore documentation](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/services/sqs/client/send_message.html) -The SQS event payload will contain everything passed in the service call payload. SQS payloads will be published as stringified JSON. All attributes from the payload, except message, will also be sent as stringified message attributes. Here is an example message that would be published to the SQS queue: +The SQS event payload will contain everything passed in the action payload. SQS payloads will be published as stringified JSON. All attributes from the payload, except message, will also be sent as stringified message attributes. Here is an example message that would be published to the SQS queue: ```json { @@ -178,11 +178,11 @@ The SQS event payload will contain everything passed in the service call payload ``` ## EventBridge Notify Usage -AWS EventBridge is a notification platform and thus can be controlled by calling the `notify` service [as described here](/integrations/notify/). It will publish a message to the event bus for all targets given in the notification payload. A target must be a name of an event bus accessible by the given credentials. A target is not required, and the default event bus will be used if none are specified. For more information, please see the [EventBridge documentation](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus.html) and [botocore documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/events/client/put_events.html) +AWS EventBridge is a notification platform and thus can be controlled by calling the `notify` action [as described here](/integrations/notify/). It will publish a message to the event bus for all targets given in the notification payload. A target must be a name of an event bus accessible by the given credentials. A target is not required, and the default event bus will be used if none are specified. For more information, please see the [EventBridge documentation](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-bus.html) and [botocore documentation](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/events/client/put_events.html) -There are two options for generating the event detail based on the service call payload. If the `detail` attribute is specified, then its value will be serialized as a JSON object and used for the event detail. If the attribute is not specified, then the value of the `message` attribute is serialized as a simple JSON object with a single key named `message` and the value of the message supplied to the service call. +There are two options for generating the event detail based on the action payload. If the `detail` attribute is specified, then its value will be serialized as a JSON object and used for the event detail. If the attribute is not specified, then the value of the `message` attribute is serialized as a simple JSON object with a single key named `message` and the value of the message supplied to the action. -Here are a couple of examples showing the service call input and corresponding API entry: +Here are a couple of examples showing the action input and corresponding API entry: ```jsonc // Service call payload diff --git a/source/_integrations/azure_service_bus.markdown b/source/_integrations/azure_service_bus.markdown index 4cf22321a51..e4710c2aa0f 100644 --- a/source/_integrations/azure_service_bus.markdown +++ b/source/_integrations/azure_service_bus.markdown @@ -50,7 +50,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 type: string default: notify