jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 09:17:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename Services to Actions in integrations: B (#33785)

Browse Source 
* Rename Services to Actions in integrations: B

* Apply suggestions from code review

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
Franck Nijhof 2024-07-16 14:04:23 +02:00 committed by GitHub
parent 7d2b143fdd
commit 8658ace841
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
14 changed files with 88 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
source/_integrations/backup.markdown
View File

@ -25,19 +25,19 @@ The **Backup** {% term integration %} is used for {% term "Home Assistant Core"
Note: If you use {% term "Home Assistant Operating System" %} or {% term "Home Assistant Supervised" %} installation, this page is not for you. Instead, refer to the documentation on using the [built-in back up](/common-tasks/os/#backups).
## Services
## Actions
The **Backup** integration exposes a service that can be used to automate the backup
The **Backup** integration exposes an action that can be used to automate the backup
process.
### Service {% my developer_call_service service="backup.create" %}
### Action {% my developer_call_service service="backup.create" %}
The {% my developer_call_service service="backup.create" %} service can be used
The {% my developer_call_service service="backup.create" %} action can be used
to create a backup for your Home Assistant instance.
The service has no additional options or parameters.
The action has no additional options or parameters.
Example service call:
Example action:
```yaml
service: backup.create

8
source/_integrations/bang_olufsen.markdown
View File

@ -49,11 +49,11 @@ Device model:
{% endconfiguration_basic %}
## Services
## Actions
### play_media services
### play_media actions
The Bang & Olufsen integration supports different playback types in the `media_player.play_media` service: playback from URL, activating a favorite, playback from a local file, playing a radio station, activating a Deezer flow and Deezer playlists, albums, tracks, and playing files and text-to-speech (TTS) as an overlay.
The Bang & Olufsen integration supports different playback types in the `media_player.play_media` action: playback from URL, activating a favorite, playback from a local file, playing a radio station, activating a Deezer flow and Deezer playlists, albums, tracks, and playing files and text-to-speech (TTS) as an overlay.
#### play_media examples
@ -197,7 +197,7 @@ Bang & Olufsen Cloud TTS messages are limited to 100 unique messages a day and a
Extra keys available:
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ------------------------- | -------- | ------------------------------------------------------------------------------------------------- |
| `overlay_absolute_volume` | yes | Specify an absolute volume for the overlay. |
| `overlay_offset_volume` | yes | Specify a volume offset to be added to the current volume level. |

6
source/_integrations/blackbird.markdown
View File

@ -59,11 +59,11 @@ sources:
type: string
{% endconfiguration %}
### Service `blackbird.set_all_zones`
### Action `blackbird.set_all_zones`
Set all zones to the same input source. This service allows you to immediately synchronize all the TVs in your home. Regardless of `entity_id` provided, all zones will be updated.
Set all zones to the same input source. This action allows you to immediately synchronize all the TVs in your home. Regardless of `entity_id` provided, all zones will be updated.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------------------------------------------- |
| `entity_id` | yes | String that points at an `entity_id` of a zone. |
| `source` | no | String of source name to activate. |

24
source/_integrations/blink.markdown
View File

@ -54,13 +54,13 @@ Once Home Assistant starts and you authenticate access, the `blink` integration
- A `binary_sensor` motion detection, camera armed status, and battery status.
- A `switch` per camera to enable/disable motion detection
Since the cameras are battery operated, polling must be done with care so as to not drain the battery too quickly, or hammer Blink's servers with too many API requests. If an alternate polling rate is desired, disable the "enable poll for updates" option in the Blink integration system options and poll with `homeassistant.update_entity` service. The cameras can be also manually updated via the `trigger_camera` service. As a note, all of the camera-specific sensors are only polled when a new image is requested from the camera. This means that relying on any of these sensors to provide timely and accurate data is not recommended.
Since the cameras are battery operated, polling must be done with care so as to not drain the battery too quickly, or hammer Blink's servers with too many API requests. If an alternate polling rate is desired, disable the "enable poll for updates" option in the Blink integration system options and poll with `homeassistant.update_entity` action. The cameras can be also manually updated via the `trigger_camera` action. As a note, all of the camera-specific sensors are only polled when a new image is requested from the camera. This means that relying on any of these sensors to provide timely and accurate data is not recommended.
Please note that each camera reports two different states: one as `sensor.blink_<camera_name>_status` and the other as `binary_sensor.blink_<camera_name>_motion_enabled`. The `motion_enabled` property reports if the `camera` is ready to detect motion **regardless if the system is actually armed**.
## Services
## Actions
Any sequential calls to {% term services %} relating to blink should have a minimum of a 5 second delay in between them to prevent the calls from being throttled and ignored. The services that act on a camera needs a target parameter.
Any sequential calls to {% term actions %} relating to blink should have a minimum of a 5 second delay in between them to prevent the calls from being throttled and ignored. The actions that act on a camera needs a target parameter.
### `blink.record`
@ -74,7 +74,7 @@ Trigger a camera to take a new still image.
Save the last recorded video of a camera to a local file. Note that in most cases, Home Assistant will need to know that the directory is writable via the `allowlist_external_dirs` in your {% term "`configuration.yaml`" %} file (see example below).
| Service Data Attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------- |
| `filename` | no | Location of save file. |
@ -88,30 +88,30 @@ homeassistant:
Save the recent video clips of a camera to a local file in the pattern `%Y%m%d_%H%M%S_{name}.mp4`. Note that in most cases, Home Assistant will need to know that the directory is writable via the `allowlist_external_dirs` in your {% term "`configuration.yaml`" %} file.
| Service Data Attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------------------- |
| `file_path` | no | Location of save files. |
### `blink.send_pin`
Send a new pin to blink. Since Blink's 2FA implementation is new and changing, this is to allow the integration to continue to work with user intervention. The intent is to handle all of this behind the scenes, but until the login implementation is settled this was added. To use it, you simply call the service with the pin you receive from Blink as the payload (for a simple "Allow this Device" email, you may keep the `pin` value empty).
Send a new pin to blink. Since Blink's 2FA implementation is new and changing, this is to allow the integration to continue to work with user intervention. The intent is to handle all of this behind the scenes, but until the login implementation is settled this was added. To use it, perform the action with the pin you receive from Blink as the payload (for a simple "Allow this Device" email, you may keep the `pin` value empty).
| Service Data Attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------- |
| `config_entry_id` | no | Blink config to send pin to. |
| `pin` | no | 2FA Pin received from blink. |
### Other services
### Other actions
In addition to the services mentioned above, there are generic `camera`, `alarm_control_panel`, and `homeassistant` services available. The `camera.enable_motion_detection` and `camera.disable_motion_detection` services allow for individual cameras to be enabled and disabled, respectively, within the Blink system. The `alarm_control_panel.alarm_arm_away` and `alarm_control_panel.alarm_disarm` services allow for the whole system to be armed and disarmed, respectively. The `homeassistant.update_entity` service will force an update of the blink system. Blink Mini cameras linked to an existing sync module cannot be armed/disarmed individually via Home Assistant.
In addition to the actions mentioned above, there are generic `camera`, `alarm_control_panel`, and `homeassistant` actions available. The `camera.enable_motion_detection` and `camera.disable_motion_detection` actions allow for individual cameras to be enabled and disabled, respectively, within the Blink system. The `alarm_control_panel.alarm_arm_away` and `alarm_control_panel.alarm_disarm` actions allow for the whole system to be armed and disarmed, respectively. The `homeassistant.update_entity` action will force an update of the blink system. Blink Mini cameras linked to an existing sync module cannot be armed/disarmed individually via Home Assistant.
## Examples
The following are some examples showing how to correctly make service calls using Blink:
The following are some examples showing how to correctly perform an action using Blink:
### Snap picture and save locally
This example script shows how to take a picture with your camera, named `My Camera` in your Blink app (this is **not necessarily** the friendly name in Home Assistant). After snapping a picture, the image will then be saved to a local directory called `/tmp/my_image.jpg`. Note that this example makes use of services found in the [camera integration](/integrations/camera#service-snapshot)
This example script shows how to take a picture with your camera, named `My Camera` in your Blink app (this is **not necessarily** the friendly name in Home Assistant). After snapping a picture, the image will then be saved to a local directory called `/tmp/my_image.jpg`. Note that this example makes use of actions found in the [camera integration](/integrations/camera#action-snapshot)
```yaml
alias: "Blink Snap Picture"
@ -128,7 +128,7 @@ sequence:
### Arm Blink when away
This example automation will arm your blink sync module to detect motion on any of your blink cameras that have motion detection enabled. By default, Blink enables motion detection on all cameras so, unless you've changed anything in your app, you're all set. If you want to manually enable motion detection for individual cameras, you can utilize the [appropriate camera service](/integrations/camera#service-enable_motion_detection) but please note that motion will only be captured if the sync module is armed.
This example automation will arm your blink sync module to detect motion on any of your blink cameras that have motion detection enabled. By default, Blink enables motion detection on all cameras so, unless you've changed anything in your app, you're all set. If you want to manually enable motion detection for individual cameras, you can utilize the [appropriate camera action](/integrations/camera#action-enable_motion_detection) but please note that motion will only be captured if the sync module is armed.
Here, this example assumes your blink module is named `My Sync Module` and that you have [device trackers](/integrations/device_tracker) set up for presence detection.

16
source/_integrations/bluesound.markdown
View File

@ -63,36 +63,36 @@ media_player:
- host: 192.168.1.131
```
### Service `bluesound.join`
### Action `bluesound.join`
Group players together under a single master speaker. That will make a new group or join an existing group.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------------- |
| `master` | no | A single `entity_id` that will become/hold the master speaker. |
| `entity_id` | no | String or list of a single `entity_id` that will group to master speaker. |
### Service `bluesound.unjoin`
### Action `bluesound.unjoin`
Remove one or more speakers from a group of speakers. If no `entity_id` is provided, all speakers are unjoined.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | -------------------------------------------------------------------------------- |
| `entity_id` | yes | String or list of `entity_id`s that will be separated from their master speaker. |
### Service `bluesound.set_sleep_timer`
### Action `bluesound.set_sleep_timer`
Sets a timer that will turn off the speaker. For each time you call this it will increase the time by one step. The steps are (in minutes): 15, 30, 45, 60, 90, 0.
If you increase an ongoing timer of for example 13 minutes, it will increase it to 15. If the timer is set to 90, it will remove the time (hence the 0).
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------------------- |
| `entity_id` | no | String or list of `entity_id`s that will have their timers set. |
### Service `bluesound.clear_sleep_timer`
### Action `bluesound.clear_sleep_timer`
Clear the sleep timer on a speaker, if one is set.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------- |
| `entity_id` | no | String or list of `entity_id`s that will have their timers cleared. |

6
source/_integrations/bluetooth_tracker.markdown
View File

@ -47,10 +47,10 @@ device_id:
In some cases it can be that your device is not discovered. In that case let your phone scan for Bluetooth devices while you restart Home Assistant. Just hit `Scan` on your phone all the time (or keep the Bluetooth device view open on an iOS device) until Home Assistant is fully restarted and the device should appear in `known_devices.yaml`.
The integration will try to create an entity using the device name that is detected. If such an entity already exists (for example because you are already using the [Companion App](https://companion.home-assistant.io/) for this device) no entity will be created and the log file will show an error that the `The see service is not supported for this entity device_tracker.device` (as it is not a `device_tracker` entity). You can rename the other conflicting entity, next time the device is detected a new entity with the same name will be created.
The integration will try to create an entity using the device name that is detected. If such an entity already exists (for example because you are already using the [Companion App](https://companion.home-assistant.io/) for this device) no entity will be created and the log file will show an error that the `The see action is not supported for this entity device_tracker.device` (as it is not a `device_tracker` entity). You can rename the other conflicting entity, next time the device is detected a new entity with the same name will be created.
For additional configuration variables check the [Device tracker page](/integrations/device_tracker/).
## `bluetooth_tracker.update` service
## `bluetooth_tracker.update` action
The `bluetooth_tracker.update` service can be used to manually trigger a Bluetooth scan. An example of when this service can be useful is to trigger scans based on other events like doors being opened, beacons are in range or buttons are pressed.
The `bluetooth_tracker.update` action can be used to manually trigger a Bluetooth scan. An example of when this action can be useful is to trigger scans based on other events like doors being opened, beacons are in range or buttons are pressed.

24
source/_integrations/bmw_connected_drive.markdown
View File

@ -67,12 +67,12 @@ After connecting to your account, you can set the following settings in the inte
| Setting | Description |
|---------|-------------|
| Read-only | No execution of services to the vehicle. Still possible to send messages and POIs via `notify` and to request a status update via `bmw_connected_drive.update_state`.
| Read-only | No execution of actions to the vehicle. Still possible to send messages and POIs via `notify` and to request a status update via `bmw_connected_drive.update_state`.
## Notifications
The `bmw_connected_drive` integration offers a notification service. Using this service you can send Points of Interest (POI) to your vehicle. In your vehicle you can select this POI and the navigation will automatically start using the POI as a destination.
The name of the service is `notify.bmw_connected_drive_<your_vehicle>`.
The `bmw_connected_drive` integration offers a notification action. Using this action you can send Points of Interest (POI) to your vehicle. In your vehicle you can select this POI and the navigation will automatically start using the POI as a destination.
The name of the action is `notify.bmw_connected_drive_<your_vehicle>`.
### Send a Point of Interest to your vehicle
@ -98,15 +98,15 @@ The vehicle can be locked and unlocked via the lock integration that is created
## Buttons
The `bmw_connected_drive` integration offers several buttons to trigger actions in your car. The buttons are automatically created and can be pressed/executed from the UI or using the `button.press` service. Please see the [button documentation](/integrations/button/) for more information.
The `bmw_connected_drive` integration offers several buttons to trigger actions in your car. The buttons are automatically created and can be pressed/executed from the UI or using the `button.press` action. Please see the [button documentation](/integrations/button/) for more information.
Using these buttons will impact the state of your vehicle. So use these services with care!
Using these buttons will impact the state of your vehicle. So use these with care!
### Air conditioning
The air conditioning of the vehicle can be activated with the `button.<your_vehicle>_activate_air_conditioning` button.
What exactly is started here depends on the type of vehicle. It might range from just ventilation over auxiliary heating to real air conditioning. If your vehicle is equipped with auxiliary heating, only trigger this service if the vehicle is parked in a location where it is safe to use it (e.g., not in an underground parking or closed garage).
What exactly is started here depends on the type of vehicle. It might range from just ventilation over auxiliary heating to real air conditioning. If your vehicle is equipped with auxiliary heating, only trigger this action if the vehicle is parked in a location where it is safe to use it (e.g., not in an underground parking or closed garage).
### Sound the horn
@ -121,17 +121,17 @@ The `button.<your_vehicle>_light_flash` button flashes the lights of the vehicle
The `button.<your_vehicle>_find_vehicle` button requests the vehicle to update the GPS location. This can be used for older vehicles which don't automatically send the updated GPS location.
{% warning %}
Using this service will **send your Home Assistant location to BMW**, as this is required by the API (like sharing your mobile phone's location with the MyBMW app for vehicle tracking).
If you do not want this, trigger the `vehicle_finder` service from your phone and it should update in Home Assistant within 5 minutes.
Using this action will **send your Home Assistant location to BMW**, as this is required by the API (like sharing your mobile phone's location with the MyBMW app for vehicle tracking).
If you do not want this, trigger the `vehicle_finder` action from your phone and it should update in Home Assistant within 5 minutes.
{% endwarning %}
{% note %}
On some older cars (non i3/i8 series produced before 7/2014) this service will fail in getting your vehicles position, if the vehicle is more than 1.5 km away from the location of your Home Assistant instance. This is a limitation of the BMW API.
On some older cars (non i3/i8 series produced before 7/2014) this action will fail in getting your vehicles position, if the vehicle is more than 1.5 km away from the location of your Home Assistant instance. This is a limitation of the BMW API.
{% endnote %}
## Selects
If you have a (PH)EV, you can control the charging process through Home Assistant. The selects are created automatically depending on your vehicle's capabilities and can be pressed/executed from the UI or using the `select.select_option` service. For more information, please see the [select documentation](/integrations/select/).
If you have a (PH)EV, you can control the charging process through Home Assistant. The selects are created automatically depending on your vehicle's capabilities and can be pressed/executed from the UI or using the `select.select_option` action. For more information, please see the [select documentation](/integrations/select/).
Using these selects will impact the state of your vehicle. Use them with care!
@ -140,7 +140,7 @@ Using these selects will impact the state of your vehicle. Use them with care!
## Switches
If supported by your vehicle, you can display and toggle remote services with start/stop functionality.
If supported by your vehicle, you can display and toggle remote actions with start/stop functionality.
Using these selects will impact the state of your vehicle, use them with care!
@ -149,7 +149,7 @@ Using these selects will impact the state of your vehicle, use them with care!
## Numbers
If you have a (PH)EV, you can control the charging process through Home Assistant. The number entities are created automatically depending on your vehicle's capabilities and can be changed from the UI or using the `number.set_value` service. For more information, please see the [number documentation](/integrations/number/).
If you have a (PH)EV, you can control the charging process through Home Assistant. The number entities are created automatically depending on your vehicle's capabilities and can be changed from the UI or using the `number.set_value` action. For more information, please see the [number documentation](/integrations/number/).
Using these selects will impact the state of your vehicle, use them with care!

24
source/_integrations/bond.markdown
View File

@ -63,42 +63,42 @@ upgrade your firmware from Bond app before adding this integration.
Firmware version 2.10.8 or newer is required for push updates. The integration
will fallback to polling for 2.10.x versions lower than .8
### Service `bond.set_fan_speed_tracked_state`
### Action `bond.set_fan_speed_tracked_state`
Sets the tracked fan speed for a bond fan.
Calling this service will change the tracked speed of the fan but not transmit any signal to make the device change speed.
Calling this action will change the tracked speed of the fan but not transmit any signal to make the device change speed.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of strings of `entity_id`s.
| `speed` | no | Speed as a percentage.
### Service `bond.set_switch_power_tracked_state`
### Action `bond.set_switch_power_tracked_state`
Sets the tracked power state of a bond switch.
Calling this service will change the tracked power state of any bond switch but not transmit any signal to make the device change its state.
Calling this action will change the tracked power state of any bond switch but not transmit any signal to make the device change its state.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of strings of `entity_id`s.
| `power_state` | no | Boolean power state.
### Service `bond.set_light_power_tracked_state`
### Action `bond.set_light_power_tracked_state`
Sets the tracked power state of a bond light.
Calling this {% term service %} will change the tracked power state of any bond light but not transmit any signal to make the device change its state.
Calling this {% term action %} will change the tracked power state of any bond light but not transmit any signal to make the device change its state.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of strings of `entity_id`s.
| `power_state` | no | Boolean power state.
### Service `bond.set_light_brightness_tracked_state`
### Action `bond.set_light_brightness_tracked_state`
Sets the tracked brightness state of a bond light
Calling this {% term service %} will change the tracked brightness state of any bond light but not transmit any signal to make the device change its state.
Calling this {% term action %} will change the tracked brightness state of any bond light but not transmit any signal to make the device change its state.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | no | String or list of strings of `entity_id`s.
| `brightness` | no | brightness as an integer between 0 and 255

10
source/_integrations/braviatv.markdown
View File

@ -107,9 +107,9 @@ media_player:
{% enddetails %}
## Play media service
## Play media action
The `play_media` {% term service %} can be used in an {% term automation %} or {% term script %} to switch to a specified application or TV channel. It selects the best matching application or channel according to the `media_content_id`:
The `play_media` {% term action %} can be used in an {% term automation %} or {% term script %} to switch to a specified application or TV channel. It selects the best matching application or channel according to the `media_content_id`:
1. Channel number *(i.e., '1' or '6')*
2. Exact app or channel name *(i.e., 'Google Play' or 'CNN')*
@ -151,9 +151,9 @@ data:
## Remote
The {% term integration %} supports `remote` {% term platform %}. It allows you to send remote control commands to your TV with the `remote.send_command` service.
The {% term integration %} supports `remote` {% term platform %}. It allows you to send remote control commands to your TV with the `remote.send_command` action.
The commands that can be sent to the TV depend on the model of your TV. To display a list of supported commands for your TV, call the {% term service %} `remote.send_command` with non-valid command (e.g. `Test`). A list of available commands will be displayed in [Home Assistant System Logs](https://my.home-assistant.io/redirect/logs).
The commands that can be sent to the TV depend on the model of your TV. To display a list of supported commands for your TV, call the {% term action %} `remote.send_command` with non-valid command (e.g. `Test`). A list of available commands will be displayed in [Home Assistant System Logs](https://my.home-assistant.io/redirect/logs).
**Example to send `Down` key command:**
@ -216,7 +216,7 @@ See [Using with Google Cast](#using-with-google-cast) section for more details.
### Power consumption ~15 W when the TV in standby mode while integration is enabled
The Bravia TV is [local pulling integration](https://www.home-assistant.io/blog/2016/02/12/classifying-the-internet-of-things/#polling-the-local-device). Even if the TV is turned off, its status is constantly polled to determine the current state, so the TV's network interface remains enabled. This is normal behavior. If you are concerned about this, you can disable polling for updates in the integration **System options** menu, but the TV status will no longer update automatically and you will have to force the {% term entity %} update by calling `homeassistant.update_entity` {% term service %} manually.
The Bravia TV is [local pulling integration](https://www.home-assistant.io/blog/2016/02/12/classifying-the-internet-of-things/#polling-the-local-device). Even if the TV is turned off, its status is constantly polled to determine the current state, so the TV's network interface remains enabled. This is normal behavior. If you are concerned about this, you can disable polling for updates in the integration **System options** menu, but the TV status will no longer update automatically and you will have to force the {% term entity %} update by calling `homeassistant.update_entity` {% term action %} manually.
Please note that this behavior can be caused not only by the integration, but also by some applications installed on the TV.

8
source/_integrations/bring.markdown
View File

@ -30,15 +30,15 @@ For authentication, the integration requires the `email` and `password` you used
{% include integrations/config_flow.md %}
## Services
## Actions
You can use the services from the [to-do list](/integrations/todo/) to create, update, or delete items on your Bring! shopping lists.
You can use the actions from the [to-do list](/integrations/todo/) to create, update, or delete items on your Bring! shopping lists.
### Notifications
The **Bring** integration offers a service to send push notifications to the Bring! mobile apps of other members of a shared shopping list. The Bring! mobile app has 4 predefined notification types. Note: If you want to receive these notifications yourself, you need to use a dedicated account as mentioned above.
The **Bring** integration offers an action to send push notifications to the Bring! mobile apps of other members of a shared shopping list. The Bring! mobile app has 4 predefined notification types. Note: If you want to receive these notifications yourself, you need to use a dedicated account as mentioned above.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `target` | no | Target Bring! list(s) whose members should be notified. |
| `message` | no | Type of push notification to send to list members. See [Notification types](#available-notification-types). |

16
source/_integrations/broadlink.markdown
View File

@ -73,9 +73,9 @@ The `remote` {% term entities %} allow you to learn and send codes with universa
### Learning commands
Use `remote.learn_command` to learn IR and RF codes. These codes are grouped by device and stored as commands in the [storage folder](#learned-codes-storage-location). They can be sent with the `remote.send_command` service later.
Use `remote.learn_command` to learn IR and RF codes. These codes are grouped by device and stored as commands in the [storage folder](#learned-codes-storage-location). They can be sent with the `remote.send_command` action later.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------- |
| `entity_id` | no | ID of the remote. |
| `device` | no | Name of the device to be controlled. |
@ -126,7 +126,7 @@ When the LED blinks for the first time, press and hold the button to sweep the f
The codes will be stored in the same way as the IR codes. You don't need to specify `command_type` to send them because this information is stored in the first byte of the code.
_Tip:_ Click Notifications in the sidebar after calling the service and follow the instructions to make sure you are pressing the button at the right time.
_Tip:_ Click Notifications in the sidebar after using the action and follow the instructions to make sure you are pressing the button at the right time.
#### Learning a sequence of commands
@ -149,7 +149,7 @@ script:
- volume down
```
After calling this service, you will be prompted to press the buttons in the same order as provided. Check the notifications to stay on track and make sure you are pressing the right button at the right time.
After using this action, you will be prompted to press the buttons in the same order as provided. Check the notifications to stay on track and make sure you are pressing the right button at the right time.
#### Learning an alternative code
@ -181,9 +181,9 @@ The learned codes are stored in `/config/.storage/` in a JSON file called `broad
### Sending commands
After learning IR and RF codes with the `remote.learn_command` service, you can use `remote.send_command` to send them. You can also use this service to send base64 codes taken from elsewhere.
After learning IR and RF codes with the `remote.learn_command` action, you can use `remote.send_command` to send them. You can also use this action to send base64 codes taken from elsewhere.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------- |
| `entity_id` | no | ID of the remote. |
| `command` | no | Names of the commands to be sent or base64 codes prefixed with `b64:`. |
@ -300,9 +300,9 @@ script:
### Deleting commands
You can use `remote.delete_command` to remove commands that you've learned with the `remote.learn_command` service.
You can use `remote.delete_command` to remove commands that you've learned with the `remote.learn_command` action.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------ |
| `entity_id` | no | ID of the remote. |
| `device` | no | Name of the device. |

12
source/_integrations/browser.markdown
View File

@ -13,7 +13,7 @@ related:
title: Configuration file
---
The **Browser** {% term integration %} provides a service to open URLs in the default browser on the host machine.
The **Browser** {% term integration %} provides a action to open URLs in the default browser on the host machine.
## Configuration
@ -25,19 +25,19 @@ To load this integration, add the following lines to your {% term "`configuratio
browser:
```
### Services
### Actions
Once loaded, the `browser` platform will expose {% term services %} that can be called to perform various {% term actions %}.
Once loaded, the `browser` platform will expose {% term actions %} that can be called to perform various {% term actions %}.
Available services: `browser/browse_url`.
Available actions: `browser/browse_url`.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------- |
| `url` | no | The URL to open. |
### Usage
To use this {% term service %}, choose **Call Service** from the **Developer Tools**. Choose the service *browser/browse_url* from the list of **Available services:** and enter the URL into the **Service Data** field and hit **CALL SERVICE**.
To use this {% term action %}, select the **Actions** tab from the **Developer Tools**. Choose the action *browser/browse_url* from the list of **Actions:** and enter the URL into the **data** field and select **Perform action**.
```json
{"url": "http://www.google.com"}

8
source/_integrations/button.markdown
View File

@ -31,7 +31,7 @@ The button {% term entity %} is stateless, as in, it cannot have a state like th
Every button entity does keep track of the timestamp of when the last time
the button entity has been pressed in the Home Assistant UI or pressed via
a service call.
an action.
Because the {% term state %} of a button entity in Home Assistant is a timestamp, it
means we can use it in our automations. For example:
@ -46,11 +46,11 @@ action:
message: "My button has been pressed!"
```
## Services
## Actions
The button entities exposes a single {% term service %}: {% my developer_call_service service="button.press" %}
The button entities exposes a single {% term action %}: {% my developer_call_service service="button.press" %}
This service can be called to trigger a button press for that entity.
This action can be called to trigger a button press for that entity.
```yaml
- service: button.press

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

@ -8,7 +8,7 @@ ha_iot_class: Configurable
ha_domain: mqtt
---
The `mqtt` button platform lets you send an MQTT message when the button is pressed in the frontend or the button press service is called. This can be used to expose some service of a remote device, for example reboot.
The `mqtt` button platform lets you send an MQTT message when the button is pressed in the frontend or the button press action is called. This can be used to expose some service of a remote device, for example reboot.
## Configuration