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-21 16:27:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename Services to Actions in integrations: P (#33824)

Browse Source 
* Rename Services to Actions in integrations: P

* Update source/_integrations/python_script.markdown

---------

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

4
source/_integrations/panasonic_viera.markdown
View File

@ -63,7 +63,7 @@ turn_on_action:
type: list
{% endconfiguration %}
When you restart Home Assistant, make sure the TV is turned on and connected to your local network. If your TV needs to be paired, you'll need to go to **Settings > Devices & Services** to type the PIN code that will be displayed on it and finish the setup.
When you restart Home Assistant, make sure the TV is turned on and connected to your local network. If your TV needs to be paired, you'll need to go to **Settings > Devices & services** to type the PIN code that will be displayed on it and finish the setup.
### Example `turn_on_action`
@ -110,7 +110,7 @@ script:
### Remote
When the integration is configured, two entities will be created: a `media_player` and a `remote`. The remote allows you to send key commands to your TV with the `remote.send_command` service.
When the integration is configured, two entities will be created: a `media_player` and a `remote`. The remote allows you to send key commands to your TV with the `remote.send_command` action.
Some of the known valid key values are:

18
source/_integrations/persistent_notification.markdown
View File

@ -43,11 +43,11 @@ automation:
See [Automation Trigger Variables: Persistent Notification](/docs/automation/templating/#persistent-notification)
for additional trigger data available for conditions or actions.
### Service
### Action
The service `persistent_notification.create` takes in `message`, `title`, and `notification_id`.
The `persistent_notification.create` action takes in `message`, `title`, and `notification_id`.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `message` | no | Body of the notification. Accepts [templates](/docs/configuration/templating/).
| `title` | yes | Title of the notification. Accepts [templates](/docs/configuration/templating/).
@ -78,13 +78,13 @@ action:
{% endraw %}
The service `persistent_notification.dismiss` requires a `notification_id`.
The `persistent_notification.dismiss` action requires a `notification_id`.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `notification_id` | no | the `notification_id` is required to identify the notification that should be removed.
This service allows you to remove a notifications by script or automation.
This action allows you to remove a notifications by script or automation.
```yaml
action:
@ -93,7 +93,7 @@ action:
notification_id: "1234"
```
The service `persistent_notification.dismiss_all` allows you to remove all notifications.
The `persistent_notification.dismiss_all` action allows you to remove all notifications.
```yaml
action:
@ -120,7 +120,7 @@ The message attribute supports the [Markdown formatting syntax](https://daringfi
### Create a persistent notification
Choose the **{% my developer_services title="Services" %}** tab from the **Developer Tools** sidebar item, then select the {% my developer_services service="persistent_notification.create" title="`persistent_notification.create`" %} service from the "Service" dropdown. Enter something like the sample below into the **Service Data** field and press the **CALL SERVICE** button.
Choose the **{% my developer_services title="Actions" %}** tab from the **Developer Tools** sidebar item, then select the {% my developer_services service="persistent_notification.create" title="`persistent_notification.create`" %} action from the **Action** dropdown. Enter something like the sample below into the **data** field and press the **Perform action** button.
```json
{
@ -137,6 +137,6 @@ Persistent notifications can also be used as a pre-configured notifier for the [
The following attributes can be placed inside `data` for extended functionality.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `notification_id` | yes | If `notification_id` is given, it will overwrite the notification if there already was a notification with that ID. |

2
source/_integrations/person.markdown
View File

@ -89,7 +89,7 @@ person:
- device_tracker.beacon
```
If you change the YAML, you can reload it by calling the `person.reload` service.
If you change the YAML, you can reload it by calling the `person.reload` action.
### Customizing the picture for a person

2
source/_integrations/philips_js.markdown
View File

@ -59,7 +59,7 @@ The Philips TV does not always support turning on via the API. You can either tu
### Remote
The integration provides a remote entity for sending remote key presses directly to the TV. The following list of commands are available for use with the `remote.send_command` service.
The integration provides a remote entity for sending remote key presses directly to the TV. The following list of commands are available for use with the `remote.send_command` action.
| Command | Comment |
| ---------------- | ----------------------------------------- |

12
source/_integrations/pi_hole.markdown
View File

@ -39,23 +39,23 @@ The combined host, port and location should take you to the login page of Pi-Hol
If your Pi-hole web interface is password protected, an API key will be requested by Home Assistant after submitting the initial details above. You can get the API key by logging into your Pi-Hole and going to _from Settings > API_ and then the **Show API token** button.
## Services
## Actions
The platform provides the following services to interact with your Pi-hole. Use switch entities when calling the services.
The platform provides the following actions to interact with your Pi-hole. Use switch entities when calling the actions.
### Service `pi_hole.disable`
### Action `pi_hole.disable`
Disables configured Pi-hole(s) for the specified amount of time.
| Service data attribute | Required | Type | Description |
| Data attribute | Required | Type | Description |
| ---------------------- | -------- | -------- | ----------- |
| `entity_id` | `False` | string | Target switch entity. Use `all` to target all Pi-hole services |
| `duration` | `True` | timedelta | Time for which Pi-hole should be disabled |
Example service call:
Example action:
```yaml
# Example service call to disable Pi-Hole for 30 minutes
# Example action to disable Pi-Hole for 30 minutes
service: pi_hole.disable
data:
duration: '00:30'

12
source/_integrations/picnic.markdown
View File

@ -47,17 +47,17 @@ This integration provides the following sensors. Some sensors are disabled by de
This integration provides a list containing the content of your shopping cart. This list is provided as a [to-do list](/integrations/todo/) and can also be found in the to-do list dashboard in the main sidebar of your Home Assistant instance.
You can add products to your shopping cart by entering a name in the **Add item** field. Just like with the [`picnic.add_product`](#service-picnicadd_product) service, a search will be done and the first item found will be added.
You can add products to your shopping cart by entering a name in the **Add item** field. Just like with the [`picnic.add_product`](#action-picnicadd_product) action, a search will be done and the first item found will be added.
## Services
## Actions
### Service `picnic.add_product`
### Action `picnic.add_product`
Add a product to your cart using the `picnic.add_product` service, either using a product ID or a product name.
Add a product to your cart using the `picnic.add_product` action, either using a product ID or a product name.
A search will be done and the first result will be added to the cart when one adds a product using a product name.
The service call will fail when no product can be found, or when no `product_id` or `product_name` is specified.
The action will fail when no product can be found, or when no `product_id` or `product_name` is specified.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
|------------------------|----------|----------------------------------------------------------------------------------|
| `config_entry_id` | No | The Id of the Picnic service config entry. |
| `product_id` | yes | The Picnic product ID. |

2
source/_integrations/pilight.markdown
View File

@ -26,7 +26,7 @@ related:
This pilight hub connects to the [pilight-daemon](https://manual.pilight.org/programs/daemon.html) via a socket connection to receive and send codes. Thus Home Assistant does not have to run on the computer in charge of the RF communication.
The received and supported RF codes are put on the event bus of Home Assistant and are therefore directly usable by other integrations (e.g., automation). Additionally a send service is provided to send RF codes.
The received and supported RF codes are put on the event bus of Home Assistant and are therefore directly usable by other integrations (e.g., automation). Additionally a send action is provided to send RF codes.
There is currently support for the following device types within Home Assistant:

2
source/_integrations/ping.markdown
View File

@ -41,7 +41,7 @@ For more detailed steps on how to define a custom interval, follow the procedure
## Integration options
It is possible to change some behaviors through the integration options.
To change the settings, go to {% my integrations title="**Settings** > **Devices & Services**" %}. Select the **Ping** integration, then select **Configure**.
To change the settings, go to {% my integrations title="**Settings** > **Devices & services**" %}. Select the **Ping** integration, then select **Configure**.
- **Ping count**: Number of echo requests to send to the target. The default is 5.
- **Consider home**: Number of seconds that must elapse before considering a disconnected device "not at home". The default is 180 seconds (3 minutes).

22
source/_integrations/plex.markdown
View File

@ -102,7 +102,7 @@ The library sensors are disabled by default, but can be enabled via the Plex int
## Button
A `button.scan_clients` entity is available to discover new controllable Plex clients. This may be necessary in scripts or automations which control a Plex client app, but where the underlying device must be turned on first. This button is preferred over the legacy `plex.scan_for_clients` service.
A `button.scan_clients` entity is available to discover new controllable Plex clients. This may be necessary in scripts or automations which control a Plex client app, but where the underlying device must be turned on first. This button is preferred over the legacy `plex.scan_for_clients` action.
Example script:
@ -150,7 +150,7 @@ The Plex media player platform will create media player entities for each connec
By default, the Plex integration will create media player entities for all local, managed, and shared users on the Plex server. To customize which users or client types to monitor, adjust the "*Monitored users*", "*Ignore new managed/shared users*", and "*Ignore Plex Web clients*" options described under [Integration Options](#integration-options).
### Service `media_player.play_media`
### Action `media_player.play_media`
Play media hosted on a Plex server on a Plex client or other supported device.
@ -176,7 +176,7 @@ The integration must be configured with a token for playback commands to work. T
#### Music
| Service data attribute | Description |
| Data attribute | Description |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `entity_id` | `entity_id` of the client |
| `media_content_id` | Quoted JSON containing:<br/><ul><li>`library_name` (Required)</li><li>`artist_name` or `artist.title`</li><li>`album_name` or `album.title`</li><li>`track_name` or `track.title`</li><li>`track_number` or `track.index`</li><li>`shuffle` (0 or 1)</li><li>`allow_multiple` (0 or 1)</li></ul> |
@ -202,7 +202,7 @@ media_content_id: '{ "library_name": "Music", "artist_name": "Stevie Wonder", "s
#### Playlist
| Service data attribute | Description |
| Data attribute | Description |
| ---------------------- | --------------------------------------------------------------------------------------------------- |
| `entity_id` | `entity_id` of the client |
| `media_content_id` | Quoted JSON containing:<br/><ul><li>`playlist_name` (Required)</li><li>`shuffle` (0 or 1)</li></ul> |
@ -220,7 +220,7 @@ media_content_id: '{ "playlist_name": "The Best of Disco", "shuffle": "1" }'
#### TV episode
| Service data attribute | Description |
| Data attribute | Description |
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | `entity_id` of the client |
| `media_content_id` | Quoted JSON containing:<br/><ul><li>`library_name` (Required)</li><li>`show_name` or `show.title`</li><li>`season_number` or `season.index`</li><li>`episode_number` or `episode.index`</li><li>`shuffle` (0 or 1)</li><li>`resume` (0 or 1)</li><li>`offset` (in seconds)</li><li>`allow_multiple` (0 or 1)</li></ul> |
@ -254,7 +254,7 @@ media_content_id: '{ "library_name": "News TV", "show_name": "60 Minutes", "epis
#### Movie
| Service data attribute | Description |
| Data attribute | Description |
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | `entity_id` of the client |
| `media_content_id` | Quoted JSON containing:<br/><ul><li>`library_name` (Required)</li><li>`title`</li><li>`resume` (0 or 1)</li><li>`offset` (in seconds)</li></ul> |
@ -346,7 +346,7 @@ To play Plex music directly to Sonos speakers, the following requirements must b
2. Sonos speakers linked to your Plex account [(Instructions)](https://support.plex.tv/articles/control-sonos-playback-with-a-plex-app/).
3. [Sonos](/integrations/sonos/) integration configured.
Call the `media_player.play_media` service with the `entity_id` of a Sonos integration device and `media_content_type` prepended with `plex://`. Both [music](#music) and [playlist](#playlist) `media_content_type` values are supported.
Call the `media_player.play_media` action with the `entity_id` of a Sonos integration device and `media_content_type` prepended with `plex://`. Both [music](#music) and [playlist](#playlist) `media_content_type` values are supported.
### Examples:
@ -366,13 +366,13 @@ media_content_type: playlist
media_content_id: 'plex://{ "playlist_name": "Party Mix" }'
```
## Additional services
## Additional actions
### Service `plex.refresh_library`
### Action `plex.refresh_library`
Refresh a Plex library to scan for new and updated media.
| Service data attribute | Required | Description | Example |
| Data attribute | Required | Description | Example |
| ---------------------- | -------- | ---------------------------------------------------------- | ---------------- |
| `server_name` | No | Name of Plex server to use if multiple servers configured. | "My Plex Server" |
| `library_name` | Yes | Name of Plex library to update. | "TV Shows" |
@ -380,5 +380,5 @@ Refresh a Plex library to scan for new and updated media.
## Notes
- The Plex integration supports multiple Plex servers. Additional connections can be configured under **Settings** -> **Devices & Services**.
- The Plex integration supports multiple Plex servers. Additional connections can be configured under **Settings** -> **Devices & services**.
- Movies must be located under the 'Movies' section in a Plex library to properly view the 'playing' state.

6
source/_integrations/plugwise.markdown
View File

@ -69,11 +69,11 @@ For a thermostat, the active schedule can be deactivated or reactivated via the
Auto means the schedule is active, Heat means it's not active. The active thermostat schedule can be changed via the connected thermostat select-entity. Please note: that only schedules that have two or more schedule points will be shown as select options.
### Services
### Actions
#### Update Smile data
Forced update of data from your Smile can be triggered by calling the generic `homeassistant.update_entity` service with your Smile entity as the target.
Forced update of data from your Smile can be triggered by calling the generic `homeassistant.update_entity` action with your Smile entity as the target.
```yaml
# Example script change the temperature
@ -133,7 +133,7 @@ script:
Service: `climate.turn_off`, `climate.turn_on` (Adam only)
These services will switch the Adam regulation mode (= HVAC system mode) to off or on, affecting the operation of all connected thermostats.
These actions will switch the Adam regulation mode (= HVAC system mode) to off or on, affecting the operation of all connected thermostats.
`climate.turn_on` will activate the previously selected heating or cooling mode.
Example:

50
source/_integrations/profiler.markdown
View File

@ -16,13 +16,13 @@ The Profiler integration provides a profile which is a set of statistics that id
{% include integrations/config_flow.md %}
### Service profiler.start
### Action profiler.start
{% my developer_call_service badge service="profiler.start" %}
Start the profiler for the specified number of seconds.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------- |
| `seconds` | yes | The number of seconds to run the profile. Defaults to 60.0 |
@ -53,13 +53,13 @@ dot callgrind.dot -Tpng -o callgrind.png
gprof2dot -f pstats profile.1234567890123456.cprof | dot -Tsvg -o profile.svg
```
### Service profiler.memory
### Action profiler.memory
{% my developer_call_service badge service="profiler.memory" %}
Start the memory profiler for the specified number of seconds.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------- |
| `seconds` | yes | The number of seconds to run the profile. Defaults to 60.0 |
@ -73,58 +73,58 @@ from guppy import hpy
hpy().pb()
```
### Service profiler.start_log_objects
### Action profiler.start_log_objects
{% my developer_call_service badge service="profiler.start_log_objects" %}
Start logging the growth of objects in memory.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------------------------------------------------------- |
| `scan_interval` | yes | The the frequency between logging objects. Defaults to 30.0 |
Periodically log the growth of new objects in memory. This service's primary use case is finding memory leaks. This service can be run for long periods to find slow leaks. For finding fast leaks, `profiler.start_log_object_sources` is preferred; however, it is much more CPU intensive.
Periodically log the growth of new objects in memory. This action's primary use case is finding memory leaks. This action can be run for long periods to find slow leaks. For finding fast leaks, `profiler.start_log_object_sources` is preferred; however, it is much more CPU intensive.
See the [corresponding documentation for `growth()`](https://mg.pov.lt/objgraph/objgraph.html#objgraph.growth) regarding the format in which this data is logged.
### Service profiler.stop_log_objects
### Action profiler.stop_log_objects
{% my developer_call_service badge service="profiler.stop_log_objects" %}
Stop logging the growth of objects in memory.
### Service profiler.start_log_object_sources
### Action profiler.start_log_object_sources
{% my developer_call_service badge service="profiler.start_log_object_sources" %}
Start logging the growth of objects in memory and attempt to find the source of the new objects.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | -------------------------------------------------------------------------- |
| `scan_interval` | yes | The the frequency between logging objects. Defaults to 30.0 |
| `max_objects` | yes | The number of new objects to examine for source information. Defaults to 5 |
Periodically log the growth of new objects in memory. This service's primary use case is finding memory leaks.
Periodically log the growth of new objects in memory. This actions's primary use case is finding memory leaks.
This service is similar to `start_log_objects` except that it is much more CPU intensive since it will attempt to locate the source of each new object up to `max_objects` each time it logs.
This action is similar to `start_log_objects` except that it is much more CPU intensive since it will attempt to locate the source of each new object up to `max_objects` each time it logs.
### Service profiler.stop_log_object_sources
### Action profiler.stop_log_object_sources
{% my developer_call_service badge service="profiler.stop_log_object_sources" %}
Stop logging the growth of objects with sources in memory.
### Service profiler.dump_log_objects
### Action profiler.dump_log_objects
{% my developer_call_service badge service="profiler.dump_log_objects" %}
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | -------------------------------------- |
| `type` | no | The type of object to dump to the log. |
When `start_log_objects` highlights the growth of a collection of objects in memory, this service can help investigate. The `repr` of each object that matches `type` will be logged.
When `start_log_objects` highlights the growth of a collection of objects in memory, this action can help investigate. The `repr` of each object that matches `type` will be logged.
This service is useful for investigating the state of objects in memory. For example, if your system has templates that are rendering too frequently, the below example service calls shows how to find which templates are the source of the problem:
This action is useful for investigating the state of objects in memory. For example, if your system has templates that are rendering too frequently, the below example actions shows how to find which templates are the source of the problem:
```yaml
service: profiler.dump_log_objects
@ -137,11 +137,11 @@ data:
type: Template
```
### Service profiler.log_thread_frames
### Action profiler.log_thread_frames
{% my developer_call_service badge service="profiler.log_thread_frames" %}
To help discover run away threads, why the executor is overloaded, or other threading problems, the current frames for each running thread will be logged when this service is called.
To help discover run away threads, why the executor is overloaded, or other threading problems, the current frames for each running thread will be logged when this action is performed.
An example is below:
@ -174,7 +174,7 @@ An example is below:
sock.connect(address)
```
### Service profiler.log_event_loop_scheduled
### Action profiler.log_event_loop_scheduled
{% my developer_call_service badge service="profiler.log_event_loop_scheduled" %}
@ -184,27 +184,27 @@ Each upcoming scheduled item is logged similar to the below example:
`[homeassistant.components.profiler] Scheduled: <TimerHandle when=1528307.1818668307 async_track_point_in_utc_time.<locals>.run_action(<Job HassJobType.Coroutinefunction <bound method DataUpdateCoordinator._handle_refresh_interval of <homeassistant.components.screenlogic.ScreenlogicDataUpdateCoordinator object at 0x7f985d896d30>>>) at /usr/src/homeassistant/homeassistant/helpers/event.py:1175>`
### Service profiler.lru_stats
### Action profiler.lru_stats
{% my developer_call_service badge service="profiler.lru_stats" %}
Logs statistics from [lru_cache](https://docs.python.org/3/library/functools.html#functools.lru_cache) and [lru-dict](https://pypi.org/project/lru-dict/) to help tune Home Assistant and locate memory leaks.
### Service profiler.set_asyncio_debug
### Action profiler.set_asyncio_debug
{% my developer_call_service badge service="profiler.set_asyncio_debug" %}
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | -------------------------------------- |
| `enabled` | yes | Boolean to enable asyncio debug. |
When `set_asyncio_debug` is enabled, `asyncio` will run in [debug mode](https://docs.python.org/3/library/asyncio-dev.html#debug-mode). Use this service to help identify an integration that is blocking the event loop.
### Service profiler.log_current_tasks
### Action profiler.log_current_tasks
{% my developer_call_service badge service="profiler.log_current_tasks" %}
This service can help track down task leaks, or find tasks that are delaying startup.
This action can help track down task leaks, or find tasks that are delaying startup.
An example is below:

4
source/_integrations/prosegur.markdown
View File

@ -29,6 +29,6 @@ There is currently support for the following device types within Home Assistant:
{% include integrations/config_flow.md %}
### Service `camera.request_image`
### Action `camera.request_image`
This service will have Prosegur cloud service "Request image" from your local camera. This service should only be called seldom, as Prosegur tends to throttle this service for long periods of time, resulting in errors for both this integration and your Prosegur mobile application.
This action will have Prosegur cloud service "Request image" from your local camera. This action should only be called seldom, as Prosegur tends to throttle this action for long periods of time, resulting in errors for both this integration and your Prosegur mobile application.

6
source/_integrations/prowl.markdown
View File

@ -31,7 +31,7 @@ notify:
{% configuration %}
name:
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the `notify.NOTIFIER_NAME` action.
required: false
default: notify
type: string
@ -41,11 +41,11 @@ api_key:
type: string
{% endconfiguration %}
### Prowl service data
### Prowl action data
The following attributes can be placed `data` for extended functionality.
| Service data attribute | Optional | Default | Description |
| Data attribute | Optional | Default | Description |
| ---------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------- |
| `priority` | yes | 0 | Priority level, for more info refer to the [Prowl API documentation](https://www.prowlapp.com/api.php#add). |
| `url` | yes | n/a | URL to be attached, for more info refer to the [Prowl API documentation](https://www.prowlapp.com/api.php#add). |

10
source/_integrations/ps4.markdown
View File

@ -173,22 +173,22 @@ Backup a copy of your `.ps4-games.json` file before continuing. If there are err
To edit, simply open the file in a text editor, find the game or app you would like to edit, and edit the value(s) you wish to change and then save the file. The changes will appear the next time you play the game or app on your console.
## Services
## Actions
### Service `select_source`
### Action `select_source`
Opens new application/game and closes currently running application/game. The game/app must be in the entity's source list. Games will be added automatically when you open them normally.
| Service data attribute | Optional | Example | Description |
| Data attribute | Optional | Example | Description |
| ---------------------- | -------- | -------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `entity_id` | No | `media_player.ps4` | The entity id for your PlayStation 4. |
| `source` | No | `Some Game` or `CUSA00123` | The game/app you want to open. You can use the title or SKU ID. Using the SKU ID will be the most reliable. |
### Service `send_command`
### Action `send_command`
Emulate button press on PlayStation 4. This emulates the commands available for the PS4 Second Screen App. This is not to be confused with DualShock 4 controller buttons.
| Service data attribute | Optional | Example | Description |
| Data attribute | Optional | Example | Description |
| ---------------------- | -------- | ------------------ | ------------------------------------- |
| `entity_id` | No | `media_player.ps4` | The entity id for your PlayStation 4. |
| `command` | No | `ps` | The command you want to send. |

4
source/_integrations/pushbullet.markdown
View File

@ -56,7 +56,7 @@ The Pushbullet notification platform sends messages to [Pushbullet](https://www.
### Usage
Pushbullet is a notify platform and thus can be controlled by calling the notify service [as described here](/integrations/notify/). It will send a notification to all devices registered in the Pushbullet account. An optional **target** parameter can be given to Pushbullet to specify specific account's devices, contacts or channels.
Pushbullet is a notify platform and thus can be controlled by calling the notify action [as described here](/integrations/notify/). It will send a notification to all devices registered in the Pushbullet account. An optional **target** parameter can be given to Pushbullet to specify specific account's devices, contacts or channels.
| Type | Prefix | Suffix | Example |
| ------- | ---------- | ----------------------- | ------------------------- |
@ -67,7 +67,7 @@ Pushbullet is a notify platform and thus can be controlled by calling the notify
If using targets, your own account's email address functions as 'send to all devices'. All targets are verified (if exists) before sending, except email.
#### Example service payload
#### Example action payload
```yaml

2
source/_integrations/pushsafer.markdown
View File

@ -31,7 +31,7 @@ notify:
{% configuration %}
name:
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the `notify.NOTIFIER_NAME` action.
required: false
default: notify
type: string

16
source/_integrations/python_script.markdown
View File

@ -9,12 +9,12 @@ ha_domain: python_script
ha_integration_type: integration
---
This integration allows you to write Python scripts that are exposed as services in Home Assistant. Each Python file created in the `<config>/python_scripts/` folder will be exposed as a service. The content is not cached so you can easily develop: edit file, save changes, call service. The scripts are run in a sandboxed environment. The following variables are available in the sandbox:
This integration allows you to write Python scripts that are exposed as actions in Home Assistant. Each Python file created in the `<config>/python_scripts/` folder will be exposed as an action. The content is not cached so you can easily develop: edit file, save changes, perform action. The scripts are run in a sandboxed environment. The following variables are available in the sandbox:
| Name | Description |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `hass` | The Home Assistant object. Access is only allowed to call services, set/remove states and fire events. [API reference][hass-api] |
| `data` | The data passed to the Python Script service call. |
| `hass` | The Home Assistant object. Access is only allowed to perform actions, set/remove states and fire events. [API reference][hass-api] |
| `data` | The data passed to the Python Script action. |
| `logger` | A logger to allow you to log messages: `logger.info()`, `logger.warning()`, `logger.error()`. [API reference][logger-api] |
| `time` | The stdlib `time` available as limited access. |
| `datetime` | The stdlib `datetime` available as limited access. |
@ -55,7 +55,7 @@ logger.info("Hello {} at {}".format(name, time.time()))
```
- Start Home Assistant to reload the script configuration.
- Call your new {% my developer_call_service service="python_script.hello_world" %} service (with parameters) from the {% my developer_services %}, using the YAML mode.
- Call your new {% my developer_call_service service="python_script.hello_world" %} action (with parameters) from the {% my developer_services %}, using the YAML mode.
```yaml
service: python_script.hello_world
@ -178,11 +178,11 @@ turn_on_light:
For more examples, visit the [Scripts section](https://community.home-assistant.io/c/projects/scripts) in our forum.
## Services
## Actions
Available services: `reload`.
Available actions: `reload`.
### Service `python_script.reload`
### Action `python_script.reload`
Reload all available python_scripts from the `<config>/python_scripts` folder, as a quicker alternative to restarting Home Assistant.
@ -190,4 +190,4 @@ Use this when creating a new Python script, or after updating the `<config>/pyth
You don't have to call this service when you change an existing Python script.
This service takes no service data attributes.
This service takes no data attributes.