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: K (#33819)

Browse Source 
* Rename Services to Actions in integrations: K

* Another fix

* Apply suggestions from code review

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

* tiny tweak

* name link target

* Tiny tweaks

---------

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

4
source/_integrations/kaleidescape.markdown
View File

@ -40,7 +40,7 @@ The Kaleidescape media player platform will create a [media player](/integration
## Remote
The Kaleidescape remote platform will create a [Remote](/integrations/remote/) entity for the device. This entity allows you to send the following commands via the [remote.send_command](/integrations/remote/) service.
The Kaleidescape remote platform will create a [Remote](/integrations/remote/) entity for the device. This entity allows you to send the following commands via the [remote.send_command](/integrations/remote/) action.
- `select`
- `up`
@ -54,7 +54,7 @@ The Kaleidescape remote platform will create a [Remote](/integrations/remote/) e
- `go_movie_covers`
- `menu_toggle`
A typical service call might look like the example below, which sends a command to the device to _select_ the currently highlighted item.
A typical action might look like the example below, which sends a command to the device to _select_ the currently highlighted item.
```yaml
service: remote.send_command

24
source/_integrations/keba.markdown
View File

@ -29,7 +29,7 @@ This {% term integration %} provides the following platforms:
- Binary sensors: Online state, plug state, charging state and failsafe mode state.
- Lock: Authorization (like with the RFID card).
- Sensors: current set by the user, target energy set by the user, charging power, charged energy of the current session and total energy charged.
- Services: authorize, deauthorize, set energy target, set the maximum allowed current and manually update the states. More details can be found [here](/integrations/keba/#services).
- Actions: authorize, deauthorize, set energy target, set the maximum allowed current and manually update the states. More details can be found in the [actions](#actions) section.
- Notify: Show a text on chargers with a built-in LED display.
## Configuration
@ -64,7 +64,7 @@ keba:
type: boolean
default: false
failsafe_timeout:
description: Timeout of the failsafe mode in seconds. Allowed values are between 10 seconds and 600 seconds (this parameter is only used if failsafe mode is enabled). Make sure to call the `keba.set_curr` service regularly within this timeout period!
description: Timeout of the failsafe mode in seconds. Allowed values are between 10 seconds and 600 seconds (this parameter is only used if failsafe mode is enabled). Make sure to call the `keba.set_curr` action regularly within this timeout period!
required: false
type: integer
default: 30
@ -85,21 +85,21 @@ keba:
default: 5
{% endconfiguration %}
## Services
## Actions
The `keba` integration offers several services. Using these services will change the state of your charging station. So use these services with care!
The Keba integration offers several actions. Using these actions will change the state of your charging station. So use these actions with care!
### Authorizing and Deauthorizing `keba.authorize` and `keba.deauthorize`
The charging station can be authorized and deauthorized via service calls (`keba.authorize` and `keba.deauthorize`) or via the lock integration that is created automatically for the charging station. In both cases the RFID tag from the configuration is used.
The charging station can be authorized and deauthorized using actions (`keba.authorize` and `keba.deauthorize`) or via the lock integration that is created automatically for the charging station. In both cases the RFID tag from the configuration is used.
### Start and Stop `keba.start` and `keba.stop`
The service `keba.start` and `keba.stop` controls the charging process if the car is already authorized. Technically it sends `ena 1` or `ena 0` commands to the charging station.
The `keba.start` and `keba.stop` actions control the charging process if the car is already authorized. Technically it sends `ena 1` or `ena 0` commands to the charging station.
### Set Target Energy `keba.set_energy`
The service `keba.set_energy` sets the target energy for the current session to the given energy attribute in kWh. Payload example:
The action `keba.set_energy` sets the target energy for the current session to the given energy attribute in kWh. Payload example:
```json
{
@ -109,7 +109,7 @@ The service `keba.set_energy` sets the target energy for the current session to
### Maximum Current `keba.set_curr`
The service `keba.set_curr` sets the maximum current to the given current attribute in Ampere. Payload example:
The `keba.set_curr` action sets the maximum current to the given current attribute in Ampere. Payload example:
```json
{
@ -119,11 +119,11 @@ The service `keba.set_curr` sets the maximum current to the given current attrib
### Request New Data `keba.request_data`
The service `keba.request_data` sends data update requests to the charging station.
The `keba.request_data` action sends data update requests to the charging station.
### Request New Data `keba.set_failsafe`
The service `keba.set_failsafe` sets the failsafe mode of the charging station. Payload example:
The `keba.set_failsafe` action sets the failsafe mode of the charging station. Payload example:
```json
{
@ -148,7 +148,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
@ -156,7 +156,7 @@ name:
### Usage
The use of the notify service is [described here](/integrations/notify/).
The use of the notify action is [described here](/integrations/notify/).
The `message` part of the event payload is shown on the display. Scrolling is performed if needed. A maximum of 23 characters can be shown.

2
source/_integrations/keenetic_ndms2.markdown
View File

@ -21,4 +21,4 @@ Router running NDMS firmware versions 2.05 and up. It uses telnet connection so
## Configuration
To add Keenetic router to your installation, go to **Settings** -> **Devices & Services** in the UI, click the button with `+` sign and from the list of integrations select **Keenetic NDMS2 Router**.
To add a Keenetic router to your installation, go to **Settings** > **Devices & services** in the UI, click the button with `+` sign, and from the list of integrations, select **Keenetic NDMS2 Router**.

36
source/_integrations/kef.markdown
View File

@ -94,26 +94,26 @@ media_player:
volume_step: 0.05
```
## Services
## Actions
Just like in the KEF Control app, we can change the digital signal processing (DSP) settings.
The speaker's current DSP settings are updated automatically each hour and after each service call.
The speaker's current DSP settings are updated automatically each hour and after each action.
To update the settings manually, use `kef.update_dsp`.
### Service `kef.update_dsp`
### Action `kef.update_dsp`
Update all DSP settings.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------- |
| entity_id | No | The entity_id of the KEF speaker. |
### Service `kef.set_mode`
### Action `kef.set_mode`
Set the mode of the speaker. When optional attributes are left out, the setting will be unchanged.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------- |
| entity_id | No | The entity_id of the KEF speaker. |
| desk_mode | Yes | "Desk mode" (`true` or `false`) |
@ -123,56 +123,56 @@ Set the mode of the speaker. When optional attributes are left out, the setting
| sub_polarity | Yes | "Sub polarity" (`-` or `+`) |
| bass_extension | Yes | "Bass extension" selector (`Less`, `Standard`, or `Extra`) |
### Service `kef.set_desk_db`
### Action `kef.set_desk_db`
Set the "Desk mode" slider of the speaker in dB.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------------------------------------------- |
| entity_id | No | The entity_id of the KEF speaker. |
| db_value | No | Value of the slider (-6 to 0 with steps of 0.5) |
### Service `kef.set_wall_db`
### Action `kef.set_wall_db`
Set the "Wall mode" slider of the speaker in dB.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------------------------------------------- |
| entity_id | No | The entity_id of the KEF speaker. |
| db_value | No | Value of the slider (-6 to 0 with steps of 0.5) |
### Service `kef.set_treble_db`
### Action `kef.set_treble_db`
Set desk the "Treble trim" slider of the speaker in dB.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------------------------------------------- |
| entity_id | No | The entity_id of the KEF speaker. |
| db_value | No | Value of the slider (-2 to 2 with steps of 0.5) |
### Service `kef.set_high_hz`
### Action `kef.set_high_hz`
Set the "High-pass mode" slider of the speaker in Hz.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------------------------------------------- |
| entity_id | No | The entity_id of the KEF speaker. |
| hz_value | No | Value of the slider (50 to 120 with steps of 5) |
### Service `kef.set_low_hz`
### Action `kef.set_low_hz`
Set the "Sub out low-pass frequency" slider of the speaker in Hz.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------------------------------------------- |
| entity_id | No | The entity_id of the KEF speaker. |
| hz_value | No | Value of the slider (40 to 250 with steps of 5) |
### Service `kef.set_sub_db`
### Action `kef.set_sub_db`
Set the "Sub gain" slider of the speaker in dB.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------------------------------------------- |
| entity_id | No | The entity_id of the KEF speaker. |
| db_value | No | Value of the slider (-10 to 10 with steps of 1) |

8
source/_integrations/keymitt_ble.markdown
View File

@ -33,13 +33,13 @@ Please note, that the devices cannot remain paired to the MicroBot application f
This Integration is for the MicroBot Push only. The Keymitt lock is not supported.
### Service `keymitt_ble.calibrate`
### Action `keymitt_ble.calibrate`
The Calibration service will locally set the MicroBot Push depth, duration, and mode.
The Calibration action will locally set the MicroBot Push depth, duration, and mode.
Please note: The push arm will extend or retract (depending on the mode defined) after the service call is invoked. The mode and depth will be demonstrated, but not the duration. The setting is, however, stored and can be confirmed by manually operating the device.
Please note: The push arm will extend or retract (depending on the mode defined) after the action is performed. The mode and depth will be demonstrated, but not the duration. The setting is, however, stored and can be confirmed by manually operating the device.
| Service Data Attribute | Required | Description |
| Data attribute | Required | Description |
| ---------------------- | -------- | --------------------------------------------------------------------------------------------- |
| `depth` | yes | How far (in percent) to extend the push arm. |
| `duration` | yes | Duration (in seconds) to hold the arm extended. |

30
source/_integrations/knx.markdown
View File

@ -320,16 +320,16 @@ Every telegram that matches an address pattern with its destination field will b
- `telegramtype` the APCI service of the telegram. "GroupValueWrite", "GroupValueRead" or "GroupValueResponse" generate a knx_event.
- `value` contains the decoded payload value if `type` is configured for the address. Will be `None` for "GroupValueRead" telegrams.
## Services
## Actions
In order to directly interact with the KNX bus, you can use the following services:
In order to directly interact with the KNX bus, you can use the following actions:
### Send
```txt
Domain: knx
Service: send
Service Data: {"address": "1/0/15", "payload": 0, "type": "temperature"}
Action: send
Data: {"address": "1/0/15", "payload": 0, "type": "temperature"}
```
{% configuration %}
@ -350,13 +350,13 @@ response:
### Read
You can use the `homeassistant.update_entity` service call to issue GroupValueRead requests for all `*state_address` of an entity.
To manually send GroupValueRead requests, use the `knx.read` service. The response can be used in automations by the `knx.telegram` trigger and it will be processed in KNX entities.
You can use the `homeassistant.update_entity` action call to issue GroupValueRead requests for all `*state_address` of an entity.
To manually send GroupValueRead requests, use the `knx.read` action. The response can be used in automations by the `knx.telegram` trigger and it will be processed in KNX entities.
```txt
Domain: knx
Service: read
Service Data: {"address": "1/0/15"}
Action: read
Data: {"address": "1/0/15"}
```
{% configuration %}
@ -392,7 +392,7 @@ automation:
### Register event
The `knx.event_register` service can be used to register (or unregister) group addresses to fire `knx_event` Events. Events for group addresses configured in the `event` key in `configuration.yaml` cannot be unregistered. See [knx_event](#events)
The `knx.event_register` action can be used to register (or unregister) group addresses to fire `knx_event` Events. Events for group addresses configured in the `event` key in `configuration.yaml` cannot be unregistered. See [knx_event](#events)
{% configuration %}
address:
@ -412,7 +412,7 @@ type:
### Register exposure
The `knx.exposure_register` service can be used to register (or unregister) exposures to the KNX bus. Exposures defined in `configuration.yaml` can not be unregistered. Per address only one exposure can be registered. See [expose](#exposing-entity-states-entity-attributes-or-time-to-knx-bus)
The `knx.exposure_register` action can be used to register (or unregister) exposures to the KNX bus. Exposures defined in `configuration.yaml` can not be unregistered. Per address only one exposure can be registered. See [expose](#exposing-entity-states-entity-attributes-or-time-to-knx-bus)
{% configuration %}
remove:
@ -428,7 +428,7 @@ KNX integration is able to expose entity states or attributes to KNX bus. The in
It is also possible to expose the current time and date. These are sent to the bus every hour.
{% tip %}
Expose is only triggered on state changes. If you need periodical telegrams, use an automation with the `knx.send` service to send the value to the bus.
Expose is only triggered on state changes. If you need periodical telegrams, use an automation with the `knx.send` action to send the value to the bus.
{% endtip %}
{% raw %}
@ -648,7 +648,7 @@ action:
## Button
The KNX button platform allows to send concurrent predefined values via the frontend or a platform service. When a user presses the button, the assigned generic raw payload is sent to the KNX bus.
The KNX button platform allows to send concurrent predefined values via the frontend or an action. When a user presses the button, the assigned generic raw payload is sent to the KNX bus.
{% tip %}
Telegrams received on the KNX bus for the group address of a button are not reflected in a new button state. Use the `knx.telegram` trigger if you want to automate on a specific payload received on a group address.
@ -1505,7 +1505,7 @@ entity_category:
default: None
{% endconfiguration %}
### Example service call
### Example action
```yaml
service: notify.send_message
@ -1729,7 +1729,7 @@ entity_category:
The KNX sensor platform allows you to monitor [KNX](https://www.knx.org/) sensors.
Sensors are read-only. To write to the KNX bus configure a [Number](#number), an exposure [KNX Integration Expose](/integrations/knx/#exposing-entity-states-entity-attributes-or-time-to-knx-bus) or use the `knx.send` service.
Sensors are read-only. To write to the KNX bus configure a [Number](#number), an exposure [KNX Integration Expose](/integrations/knx/#exposing-entity-states-entity-attributes-or-time-to-knx-bus) or use the `knx.send` action.
```yaml
# Example configuration.yaml entry
@ -2296,7 +2296,7 @@ logger:
xknx.state_updater: warning # provides information about the state updater
```
You can use the service `logger.set_level` to change the log level of a handler on a running instance.
You can use the `logger.set_level` action to change the log level of a handler on a running instance.
{% my developer_call_service badge service="logger.set_level" %}
### Group address can not be read

20
source/_integrations/kodi.markdown
View File

@ -66,13 +66,13 @@ automation:
- service: script.kodi_turn_off
```
### Services
### Actions
#### Service `kodi.add_to_playlist`
#### Action `kodi.add_to_playlist`
Add music to the default playlist (i.e., playlistid=0).
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | Name(s) of the Kodi entities where to add the media. |
| `media_type` | yes | Media type identifier. It must be one of SONG or ALBUM. |
@ -80,11 +80,11 @@ Add music to the default playlist (i.e., playlistid=0).
| `media_name` | no | Optional media name for filtering media. Can be 'ALL' when `media_type` is 'ALBUM' and `artist_name` is specified, to add all songs from one artist. |
| `artist_name` | no | Optional artist name for filtering media. |
#### Service `kodi.call_method`
#### Action `kodi.call_method`
Call a [Kodi JSON-RPC API](https://kodi.wiki/?title=JSON-RPC_API) method with optional parameters. Results of the Kodi API call will be redirected in a Home Assistant event: `kodi_call_method_result`.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------------- |
| `entity_id` | no | Name(s) of the Kodi entities where to run the API method. |
| `method` | yes | Name of the Kodi JSON-RPC API method to be called. |
@ -92,12 +92,12 @@ Call a [Kodi JSON-RPC API](https://kodi.wiki/?title=JSON-RPC_API) method with op
### Event triggering
When calling the `kodi.call_method` service, if the Kodi JSON-RPC API returns data, when received by Home Assistant it will fire a `kodi_call_method_result` event on the event bus with the following `event_data`:
When calling the `kodi.call_method` action, if the Kodi JSON-RPC API returns data, when received by Home Assistant it will fire a `kodi_call_method_result` event on the event bus with the following `event_data`:
```yaml
entity_id: "<Kodi media_player entity_id>"
result_ok: <boolean>
input: <input parameters of the service call>
input: <input parameters of the action>
result: <data received from the Kodi API>
```
@ -107,7 +107,7 @@ The following scripts can be used in automations for turning on/off your Kodi in
#### Turn on Kodi with Wake on LAN
With this configuration, when calling `media_player/turn_on` on the Kodi device, a _magic packet_ will be sent to the specified MAC address. To use this service, first you need to configuration the [`wake_on_lan`](/integrations/wake_on_lan) integration in Home Assistant, which is achieved simply by adding `wake_on_lan:` to your {% term "`configuration.yaml`" %}.
With this configuration, when calling `media_player/turn_on` on the Kodi device, a _magic packet_ will be sent to the specified MAC address. To use this action, first you need to configure the [`wake_on_lan`](/integrations/wake_on_lan) integration in Home Assistant, which is achieved simply by adding `wake_on_lan:` to your {% term "`configuration.yaml`" %}.
```yaml
script:
@ -224,7 +224,7 @@ script:
This example and the following requires to have the [script.json-cec](https://github.com/joshjowen/script.json-cec) plugin installed on your Kodi player. It'll also expose the endpoints standby, toggle and activate without authentication on your Kodi player. Use this with caution.
{% endimportant %}
### Kodi services samples
### Kodi action samples
#### Simple script to turn on the PVR in some channel as a time function
@ -317,7 +317,7 @@ notify:
{% configuration %}
name:
description: Name displayed in the frontend. The notifier will bind to the service `notify.NOTIFIER_NAME`.
description: Name displayed in the frontend. The notifier will bind to the `notify.NOTIFIER_NAME` action.
required: false
type: string
host:

10
source/_integrations/konnected.markdown
View File

@ -49,21 +49,21 @@ Konnected devices communicate with Home Assistant over your local LAN -- there i
### Web Interface
Starting with 0.106.0 Home Assistant requires UI based configuration of Konnected via **Settings** -> **Devices & Services** in the Home Assistant (web) frontend. If you have Konnected Alarm Panels on your LAN, or in your configuration.yaml, you will see one or more **Konnected.io** entries appear in the **Discovered** integrations list.
Starting with 0.106.0 Home Assistant requires UI-based configuration of Konnected via **Settings** > **Devices & services** in the Home Assistant (web) frontend. If you have Konnected Alarm Panels on your LAN, or in your configuration.yaml, you will see one or more **Konnected.io** entries appear in the **Discovered** integrations list.
Selecting one of these discovered panels will guide you through connecting and configuring the panel. If your panel was discovered via SSDP, you shouldn't need any information to complete configuration - simply confirm that the information displayed is correct. If the UI prompts you for IP/Port, you'll need to enter it. IP/Port info can be found using the Konnected mobile app.
{% note %}
If you have an existing `configuration.yaml` completing the UI configuration will do a one time import of the settings contained in `configuration.yaml`. Once the import creates a **Configured** integration the Konnected section of the `configuration.yaml` is no longer used - it is recommended to remove the `konnected` section of `configuration.yaml` and after the import occurs. Any future changes to settings should occur via the settings provided in the Home Assistant web interface.
If you want to retain `configuration.yaml` and need to re-import any changes or updates you will need to delete the entry in **Settings** -> **Devices & Services** -> **Configured** and repeat the UI configuration for that device.
If you want to retain `configuration.yaml` and need to re-import any changes or updates, you will need to delete the entry in **Settings** > **Devices & services** > **Configured** and repeat the UI configuration for that device.
{% endnote %}
Once configuration is completed you'll see a Konnected.io entry in **Settings** -> **Devices & Services** -> **Configured**. If you imported settings from `configuration.yaml` you are now done! If you are setting up a new Konnected Alarm Panel or modifying settings, you'll need to utilize the settings UI to configure zone behavior.
Once configuration is completed, you'll see a Konnected.io entry in **Settings** > **Devices & services** > **Configured**. If you imported settings from `configuration.yaml`, you are now done! If you are setting up a new Konnected Alarm Panel or modifying settings, you'll need to utilize the settings UI to configure zone behavior.
#### Using Settings UI to Configure Zone Behavior
The settings for each panel can be accessed by selecting the entry in **Settings** -> **Devices & Services** -> **Configured** and then clicking on the gear icon in the upper right corner. You can reconfigure these settings at any time and once completed the settings will be immediately applied.
The settings for each panel can be accessed by selecting the entry in **Settings** > **Devices & services** > **Configured** and then clicking on the gear icon in the upper right corner. You can reconfigure these settings at any time, and once completed, the settings will be immediately applied.
The settings UI starts by having you configure the general behavior of each zone. You need to specify `Disabled`, `Binary Sensor`, `Digital Sensor`, or `Switchable Output` for each zone. After that, you'll be prompted, for each zone that is not disabled, to configure details of the zones' behavior. All zones will allow entry of a Name. Additional fields depend on how you configured the general behavior of the zone.
**Note some zones do not support all behaviors. The UI will reflect specific options available to each zone.**
@ -309,7 +309,7 @@ konnected:
## Unique IDs and the Entity Registry
Beginning in Home Assistant release 0.90, unique IDs are generated for each sensor or switch entity. This enables end users to modify the entity names and entity IDs through the Home Assistant UI at **Settings** -> **Devices & Services** -> **Entities**.
Beginning in Home Assistant release 0.90, unique IDs are generated for each sensor or switch entity. This enables end users to modify the entity names and entity IDs through the Home Assistant UI at **Settings** -> **Devices & services** -> **Entities**.
Unique IDs are internally generated as follows: