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-22 08:46:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename Services to Actions in integrations: L (#33820)

Browse Source 
* Rename Services to Actions in integrations: L

* Update source/_integrations/local_file.markdown

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

---------

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

22
source/_integrations/lametric.markdown
View File

@ -34,15 +34,15 @@ ha_quality_scale: platinum
{% include integrations/config_flow.md %}
## Services
## Actions
The LaMetric integration provides services to interact with your LaMetric
device(s). Those service can be called in, for example, automations.
The LaMetric integration provides actions to interact with your LaMetric
device(s). Those action can be used in, for example, automations.
### Service `lametric.chart`
### Action `lametric.chart`
The {% my developer_call_service service="lametric.chart" title="`lametric.chart`" %}
service allows you to display a little chart to your LaMetric.
action allows you to display a little chart to your LaMetric.
{% my developer_call_service badge service="lametric.chart" %}
@ -76,10 +76,10 @@ sound:
type: string
{% endconfiguration %}
### Service `lametric.message`
### Action `lametric.message`
The {% my developer_call_service service="lametric.message" title="`lametric.message`" %}
service allows you to send a message to your LaMetric. These
action allows you to send a message to your LaMetric. These
messages can be enrichted with icons and sounds.
{% my developer_call_service badge service="lametric.message" %}
@ -124,11 +124,11 @@ You can send notifications to your LaMetric device using
the [Notifications](/integrations/notify) integration.
Each LaMetric device added to your Home Assistant will have its own
`notify.` service. The service name matches the name of your device
`notify.` actions. The action name matches the name of your device
as shown in your LaMetric account. For example, if you have a device
called "My LaMetric", the service would become `notify.my_lametric`.
called "My LaMetric", the action would become `notify.my_lametric`.
The notification service call against an LaMetric device can take the
The notification performed action against an LaMetric device can take the
following, additional, optional parameters:
{% configuration "notification" %}
@ -184,7 +184,7 @@ To add a notification sound, icon, cycles, or priority override,
## List of notification sounds
The following notification sounds can be used with the `sound` parameter on
notify service calls:
notify action:
- `alarm1`
- `alarm10`

4
source/_integrations/lannouncer.markdown
View File

@ -29,7 +29,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
@ -56,7 +56,7 @@ More information can be found [here](https://web.archive.org/web/20200928053944/
Lannouncer supports two types of messages.
Spoken messages is the default method (`speak`). You just invoke the `notify` service with the following JSON and the device will speak out the specified message.
Spoken messages is the default method (`speak`). You just invoke the `notify` action with the following JSON and the device will speak out the specified message.
```json
{

18
source/_integrations/lawn_mower.markdown
View File

@ -15,32 +15,32 @@ The lawn mower integration allows the control of robotic lawn mowers to be refle
{% include integrations/building_block_integration.md %}
## Services
## Actions
Available services: `start_mowing`, `pause` and `dock`.
Available actions: `start_mowing`, `pause` and `dock`.
Before calling one of these services, make sure your lawn_mower platform supports it.
Before calling one of these actions, make sure your lawn_mower platform supports it.
### Service `lawn_mower.start_mowing`
### Action `lawn_mower.start_mowing`
Start or resume a mowing task.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------- |
| `entity_id` | yes | Only act on specific lawn_mower. Use `entity_id: all` to target all. |
### Service `lawn_mower.pause`
### Action `lawn_mower.pause`
Pause a mowing task.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------- |
| `entity_id` | yes | Only act on specific lawn_mower. Use `entity_id: all` to target all. |
### Service `lawn_mower.dock`
### Action `lawn_mower.dock`
Tell the lawn_mower to return to dock.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------- |
| `entity_id` | yes | Only act on specific lawn_mower. Use `entity_id: all` to target all. |

6
source/_integrations/lawn_mower.mqtt.markdown
View File

@ -121,7 +121,7 @@ dock_command_template:
required: false
type: template
dock_command_topic:
description: The MQTT topic that publishes commands when the service `lawn_mower.dock` service call is executed. The value `dock` is published when the service is called. Use a `dock_command_template` to publish a custom format.
description: The MQTT topic that publishes commands when the `lawn_mower.dock` action is performed. The value `dock` is published when the action is used. Use a `dock_command_template` to publish a custom format.
required: false
type: string
enabled_by_default:
@ -168,7 +168,7 @@ pause_command_template:
required: false
type: template
pause_command_topic:
description: The MQTT topic that publishes commands when the service `lawn_mower.pause` service call is executed. The value `pause` is published when the service is called. Use a `pause_command_template` to publish a custom format.
description: The MQTT topic that publishes commands when the `lawn_mower.pause` action is performed. The value `pause` is published when the action is used. Use a `pause_command_template` to publish a custom format.
required: false
type: string
qos:
@ -181,7 +181,7 @@ start_mowing_template:
required: false
type: template
start_mowing_command_topic:
description: The MQTT topic that publishes commands when the service `lawn_mower.start_mowing` service call is executed. The value `start_mowing` is published when the service is called. Use a `start_mowing_command_template` to publish a custom format.
description: The MQTT topic that publishes commands when the `lawn_mower.start_mowing` action is performed. The value `start_mowing` is published when the action used. Use a `start_mowing_command_template` to publish a custom format.
required: false
type: string
retain:

62
source/_integrations/lcn.markdown
View File

@ -43,7 +43,7 @@ There is currently support for the following device types within Home Assistant:
{% note %}
The implemented platforms do not cover the whole functionality of the LCN system.
Therefore the `lcn` integration offers a variety of [events](#events), [device triggers](#device-triggers) and [service calls](#services).
Therefore the `lcn` integration offers a variety of [events](#events), [device triggers](#device-triggers) and [actions](#actions).
They are ideal to be used in automation scripts or for the `template` platforms.
{% endnote %}
@ -364,7 +364,7 @@ Leading zeroes in the segment id or module/group id can be omitted. If the `conn
## LCN constants
The platforms and service calls use several predefined constants as parameters.
The platforms and actions use several predefined constants as parameters.
### Ports
@ -703,16 +703,16 @@ supposed to cause the event in the device list. You may select the trigger type
attributes. If an attribute is optional it is considered as a supplementary filter for the trigger.
For an explanation of the attributes refer to the corresponding [events](#events).
## Services
## Actions
In order to directly interact with the LCN system, and invoke commands which are not covered by the implemented platforms, the following service calls can be used.
Refer to the [Services Calls](/docs/scripts/service-calls) page for examples on how to use them.
In order to directly interact with the LCN system, and invoke commands which are not covered by the implemented platforms, the following actions can be used.
Refer to the [Performing actions](/docs/scripts/service-calls) page for examples on how to use them.
### Service: `output_abs`
### Action: `output_abs`
Set absolute brightness of output port in percent.
| Service data attribute | Optional | Description | Values |
| Data attribute | Optional | Description | Values |
| ---------------------- | -------- | --------------------------------- | --------------------- |
| `address` | No | [LCN address](#lcn-addresses) |
| `output` | No | Output port of module | [OUTPUT_PORT](#ports) |
@ -730,11 +730,11 @@ data:
transition: 0
```
### Service: `output_rel`
### Action: `output_rel`
Set relative brightness of output port in percent.
| Service data attribute | Optional | Description | Values |
| Data attribute | Optional | Description | Values |
| ---------------------- | -------- | --------------------------------- | --------------------- |
| `address` | No | [LCN address](#lcn-addresses) |
| `output` | No | Output port of module | [OUTPUT_PORT](#ports) |
@ -751,11 +751,11 @@ data:
brightness: 30
```
### Service: `output_toggle`
### Action: `output_toggle`
Toggle output port.
| Service data attribute | Optional | Description | Values |
| Data attribute | Optional | Description | Values |
| ---------------------- | -------- | --------------------------------- | --------------------- |
| `address` | No | [LCN address](#lcn-addresses) |
| `output` | No | Output port of module | [OUTPUT_PORT](#ports) |
@ -771,14 +771,14 @@ data:
transition: 0
```
### Service: `relays`
### Action: `relays`
Set the relays status. The relays states are defined as a string with eight characters.
Each character represents the state change of a relay (1=on, 0=off, t=toggle, -=nochange).
Example states: `t---001-`
| Service data attribute | Optional | Description | Values |
| Data attribute | Optional | Description | Values |
| ---------------------- | -------- | ----------------------------- | ------ |
| `address` | No | [LCN address](#lcn-addresses) |
| `state` | No | Relay states as string |
@ -792,11 +792,11 @@ data:
state: t---001-
```
### Service: `led`
### Action: `led`
Set the LED status.
| Service data attribute | Optional | Description | Values |
| Data attribute | Optional | Description | Values |
| ---------------------- | -------- | ----------------------------- | -------------------- |
| `address` | No | [LCN address](#lcn-addresses) |
| `state` | No | LED state as string | [LED_STATE](#states) |
@ -811,13 +811,13 @@ data:
state: blink
```
### Service: `var_abs`
### Action: `var_abs`
Set the absolute value of a variable or setpoint.
If `value` is not defined, it is assumed to be 0.
If `unit_of_measurement` is not defined, it is assumed to be `native`.
| Service data attribute | Optional | Description | Values |
| Data attribute | Optional | Description | Values |
| ---------------------- | -------- | ----------------------------- | ------------------------------------------------------------------ |
| `address` | No | [LCN address](#lcn-addresses) |
| `variable` | No | Variable name | [VARIABLE](#variables-and-units), [SETPOINT](#variables-and-units) |
@ -840,13 +840,13 @@ Ensure that the LCN module is configured properly to provide access to the defin
Otherwise the module might show unexpected behaviors or return error messages.
{% endimportant %}
### Service: `var_rel`
### Action: `var_rel`
Set the relative value of a variable or setpoint.
If `value` is not defined, it is assumed to be 0.
If `unit_of_measurement` is not defined, it is assumed to be `native`.
| Service data attribute | Optional | Description | Values |
| Data attribute | Optional | Description | Values |
| ---------------------- | -------- | ----------------------------- | ----------------------------------------------------------------------------------------------------- |
| `address` | No | [LCN address](#lcn-addresses) |
| `variable` | No | Variable name | [VARIABLE](#variables-and-units), [SETPOINT](#variables-and-units), [THRESHOLD](#variables-and-units) |
@ -869,11 +869,11 @@ Ensure that the LCN module is configured properly to provide access to the defin
Otherwise the module might show unexpected behavior or return error messages.
{% endimportant %}
### Service: `var_reset`
### Action: `var_reset`
Reset value of variable or setpoint.
| Service data attribute | Optional | Description | Values |
| Data attribute | Optional | Description | Values |
| ---------------------- | -------- | ----------------------------- | ------------------------------------------------------------------ |
| `address` | No | [LCN address](#lcn-addresses) |
| `variable` | No | Variable name | [VARIABLE](#variables-and-units), [SETPOINT](#variables-and-units) |
@ -892,12 +892,12 @@ Ensure that the LCN module is configured properly to provide access to the defin
Otherwise the module might show unexpected behavior or return error messages.
{% endimportant %}
### Service: `lock_regulator`
### Action: `lock_regulator`
Locks a regulator setpoint.
If `state` is not defined, it is assumed to be `False`.
| Service data attribute | Optional | Description | Values |
| Data attribute | Optional | Description | Values |
| ---------------------- | -------- | ----------------------------- | -------------------------------- |
| `address` | No | [LCN address](#lcn-addresses) |
| `setpoint` | No | Setpoint name | [SETPOINT](#variables-and-units) |
@ -913,7 +913,7 @@ data:
state: true
```
### Service: `send_keys`
### Action: `send_keys`
Send keys (which executes bound commands).
The keys attribute is a string with one or more key identifiers. Example: `a1a5d8`
@ -921,7 +921,7 @@ If `state` is not defined, it is assumed to be `hit`.
The command allows the sending of keys immediately or deferred. For a deferred sending the attributes `time` and `time_unit` have to be specified. For deferred sending, the only key state allowed is `hit`.
If `time_unit` is not defined, it is assumed to be `seconds`.
| Service data attribute | Optional | Description | Values |
| Data attribute | Optional | Description | Values |
| ---------------------- | -------- | ----------------------------- | --------------------------------- |
| `address` | No | [LCN address](#lcn-addresses) |
| `keys` | No | Keys string |
@ -950,7 +950,7 @@ data:
time_unit: s
```
### Service: `lock_keys`
### Action: `lock_keys`
Locks keys.
If the table is not defined, it is assumed to be table `a`.
@ -958,7 +958,7 @@ The key lock states are defined as a string with eight characters. Each characte
The command allows the locking of keys for a specified time period. For a time period, the attributes `time` and `time_unit` have to be specified. For a time period, only table `a` is allowed.
If `time_unit` is not defined, it is assumed to be `seconds`.
| Service data attribute | Optional | Description | Values |
| Data attribute | Optional | Description | Values |
| ---------------------- | -------- | ----------------------------- | --------------------------------- |
| `address` | No | [LCN address](#lcn-addresses) |
| `table` | Yes | Table with keys to lock |
@ -987,14 +987,14 @@ data:
time_unit: s
```
### Service: `dyn_text`
### Action: `dyn_text`
Send dynamic text to LCN-GTxD displays.
The displays support four rows for text messages.
Each row can be set independently and can store up to 60 characters (encoded in UTF-8).
| Service data attribute | Optional | Description | Values |
| Data attribute | Optional | Description | Values |
| ---------------------- | -------- | ---------------------------------- | ------ |
| `address` | No | [LCN address](#lcn-addresses) |
| `row` | No | Text row 1..4 |
@ -1010,11 +1010,11 @@ data:
text: "text in row 1"
```
### Service: `pck`
### Action: `pck`
Send arbitrary PCK command. Only the command part of the PCK command has to be specified in the `pck` string.
| Service data attribute | Optional | Description | Values |
| Data attribute | Optional | Description | Values |
| ---------------------- | -------- | ----------------------------- | ------ |
| `address` | No | [LCN address](#lcn-addresses) |
| `pck` | No | PCK command |

4
source/_integrations/lg_netcast.markdown
View File

@ -51,9 +51,9 @@ automation:
Any other [actions](/docs/automation/action/) to power on the device can be configured.
## Change channel through play_media service
## Change channel through play_media action
The `play_media` service can be used in a script to switch to the specified TV channel. It selects the major channel number according to the `media_content_id` parameter:
The `play_media` action can be used in a script to switch to the specified TV channel. It selects the major channel number according to the `media_content_id` parameter:
```yaml
# Example action entry in script to switch to channel number 15

54
source/_integrations/lifx.markdown
View File

@ -28,19 +28,19 @@ The LIFX integration automatically discovers [LIFX](https://www.lifx.com) lights
LIFX lights allow a change of color and brightness even when they are turned off. This way, you can control the light during the day, so its settings are correct when events for turning on are received, for example, from motion detectors or external buttons.
The normal `light.turn_on` call cannot be used for this because it always turns the power on. Thus, LIFX has its own `set_state` service that allows color changes without affecting the current power state.
The normal `light.turn_on` call cannot be used for this because it always turns the power on. Thus, LIFX has its own `set_state` action that allows color changes without affecting the current power state.
### Service `lifx.set_state`
### Action `lifx.set_state`
Change the light to a new state.
| Service data attribute | Description |
| Data attribute | Description |
| ---------------------- | ----------- |
| `entity_id` | String or list of strings that point at `entity_id`s of lights. Use `entity_id: all` to target all.
| `transition` | Duration (in seconds) for the light to fade to the new state.
| `zones` | List of integers for the zone numbers to affect. See **Calculating zones to affect** below for more detail.
| `power` | Turn the light on (`True`) or off (`False`). Leave out to keep the power as it is.
| `...` | Use `color_name`, `brightness` etc. from [`light.turn_on`](/integrations/light/#service-lightturn_on) to specify the new state.
| `...` | Use `color_name`, `brightness` etc. from [`light.turn_on`](/integrations/light/#action-lightturn_on) to specify the new state.
#### Calculating zones to affect
@ -48,17 +48,17 @@ The LIFX Z and LIFX Lightstrip each have eight (8) zones per segment. You can co
The LIFX Beam has ten (10) zones per segment and one (1) zone per corner piece. You can connect up to eight (8) segments and two (2) corner pieces to a single controller, which results in a maximum zone count of 82.
All devices start counting zones at zero (0), which means the zone numbers for the `zones` attribute of the `lifx.set_state` service range from 0 to 79 for the LIFX Z and Lightstrip and 0 to 81 for the LIFX Beam.
All devices start counting zones at zero (0), which means the zone numbers for the `zones` attribute of the `lifx.set_state` action range from 0 to 79 for the LIFX Z and Lightstrip and 0 to 81 for the LIFX Beam.
## Set HEV cycle state
You can control the HEV LEDs in LIFX Clean bulbs using the `set_hev_cycle_state` service. The service can start or stop a HEV (or "Clean") cycle either using the default duration configured on the bulb or for a custom duration specified when calling the service. Home Assistant will return or log an error if an incompatible bulb is specified when calling the service.
You can control the HEV LEDs in LIFX Clean bulbs using the `set_hev_cycle_state` action. The action can start or stop a HEV (or "Clean") cycle either using the default duration configured on the bulb or for a custom duration specified when performing the action. Home Assistant will return or log an error if an incompatible bulb is specified when performing the action.
To determine whether or not a HEV cycle is currently running, Home Assistant exposes a Clean Cycle binary sensor for all HEV-enabled bulbs. This sensor can be used to trigger automations to occur when a HEV cycle starts or stops. To reduce network load, HEV cycle status is only checked every 10 seconds so this sensor may not update instantaneously.
### Service `lifx.set_hev_cycle_state`
### Action `lifx.set_hev_cycle_state`
| Service data attribute | Description |
| Data attribute | Description |
| ---------------------- | ----------- |
| `entity_id` | String or list of strings that point at `entity_id`s of LIFX Clean bulbs.
| `power` | Start a HEV cycle (`True`) or stop a cycle (`False`).
@ -82,13 +82,13 @@ Home Assistant provides a collection of predefined themes for LIFX multizone lig
To apply a theme interactively, use the theme selection drop-down box found on the device configuration screen.
To apply a theme as part of an automation, use the `select.select_option` service call. You can also apply a theme when calling the `lifx.effect_move` service. See the **Light effects** section below for more details, including how to set a custom theme for that effect.
To apply a theme as part of an automation, use the `select.select_option` action call. You can also apply a theme when calling the `lifx.effect_move` action. See the **Light effects** section below for more details, including how to set a custom theme for that effect.
The following themes are available: `autumn`, `blissful`, `cheerful`, `dream`, `energizing`, `epic`, `exciting`, `focusing`, `halloween`, `hanukkah`, `holly`, `independence_day`, `intense`, `mellow`, `peaceful`, `powerful`, `relaxing`, `santa`, `serene`, `soothing`, `sports`, `spring`, `tranquil`, `warming`.
## Light effects
The LIFX platform supports several software-controlled light effects and one hardware based effect. You can start these effects with default options by using the `effect` attribute of the normal [`light.turn_on`](/integrations/light/#service-lightturn_on) service, for example like this:
The LIFX platform supports several software-controlled light effects and one hardware based effect. You can start these effects with default options by using the `effect` attribute of the normal [`light.turn_on`](/integrations/light/#action-lightturn_on) action, for example like this:
```yaml
automation:
@ -103,7 +103,7 @@ automation:
effect: lifx_effect_pulse
```
However, if you want to fully control a light effect, you have to use its dedicated service call, like this:
However, if you want to fully control a light effect, you have to use its dedicated action, like this:
```yaml
script:
@ -124,15 +124,15 @@ script:
The Flame (`lifx.effect_flame`), Morph (`lifx.effect_morph`), Sky (`lifx.effect_sky`), and Move (`lifx.effect_move`) effects are hardware-based and only work on specific LIFX devices. Flame and Morph are available on the LIFX Tile, Candle, Path, Spot, and Ceiling while the Sky effect is only available on the Ceiling. The Move effect requires a LIFX Z, Lightstrip, Beam, Neon, or String.
All hardware-based effects can be stopped and started regardless of the device's power state, but the default behavior for each service is to turn the device on when starting an effect. Set the `power_on` attribute of the service to `false` to override this default.
All hardware-based effects can be stopped and started regardless of the device's power state, but the default behavior for each action is to turn the device on when starting an effect. Set the `power_on` attribute of the action to `false` to override this default.
All the available light effects and their options are listed below.
### Service `lifx.effect_pulse`
### Action `lifx.effect_pulse`
Run a software-based flash effect by changing to a color and then back.
| Service data attribute | Description |
| Data attribute | Description |
| ---------------------- | ----------- |
| `entity_id` | String or list of strings that point at `entity_id`s of lights. Use `entity_id: all` to target all.
| `color_name` | A color name such as `red` or `green`.
@ -144,11 +144,11 @@ Run a software-based flash effect by changing to a color and then back.
| `mode` | The way to change between colors. Valid modes: `blink` (default - direct transition to new color for 'period' time with original color between cycles), `breathe` (color fade transition to new color and back to original), `ping` (short pulse of new color), `strobe` (light turns off between color changes), `solid`(light does not return to original color between cycles).
| `power_on` | Set this to False to skip the effect on lights that are turned off (defaults to True).
### Service `lifx.effect_colorloop`
### Action `lifx.effect_colorloop`
Run a software-based effect that continuously loops colors around the color wheel. All participating lights will coordinate to keep similar (but not identical) colors.
| Service data attribute | Description |
| Data attribute | Description |
| ---------------------- | ----------- |
| `entity_id` | String or list of strings that point at `entity_id`s of lights. Use `entity_id: all` to target all.
| `brightness` | Number between 1 and 255 indicating the brightness of the effect. Leave this out to maintain the current brightness of each participating light.
@ -161,17 +161,17 @@ Run a software-based effect that continuously loops colors around the color whee
| `spread` | Maximum color difference between participating lights, in degrees on a color wheel (ranges from 0 to 359).
| `power_on` | Set this to False to skip the effect on lights that are turned off (defaults to True).
### Service `lifx.effect_flame`
### Action `lifx.effect_flame`
Run a hardware-based effect on LIFX matrix devices that creates a flame effect on the device. The device will be powered on by default, but this can be overridden by setting `power_on` to `false`. The `speed` attribute controls the speed of the flames.
| Service data attribute | Description |
| Data attribute | Description |
| ---------------------- | ----------- |
| `entity_id` | String or list of strings that point at `entity_id`s of matrix lights.
| `speed` | Duration in seconds for the effect to travel the length of the device (min: 1s, max: 25s)
| `power_on` | Whether to turn the light on before starting the effect (optional, default: true)
### Service `lifx.effect_morph`
### Action `lifx.effect_morph`
Run a hardware-based effect on LIFX matrix devices that animates blobs of colors across the device. The `speed` attribute controls the speed of the movement.
@ -179,7 +179,7 @@ You must provide a `palette` or `theme` to use for the effect, but not both. The
The device will be powered on by default, but this can be overridden by setting `power_on` to `false`.
| Service data attribute | Description |
| Data attribute | Description |
| ---------------------- | ----------- |
| `entity_id` | String or list of strings that point at `entity_id`s of matrix lights.
| `speed` | Duration in seconds for the effect to travel the length of the device (min: 1s, max: 25s)
@ -187,12 +187,12 @@ The device will be powered on by default, but this can be overridden by setting
| `theme` | The theme to use for the effect. Must be one of: `autumn`, `blissful`, `cheerful`, `dream`, `energizing`, `epic`, `exciting`, `focusing`, `halloween`, `hanukkah`, `holly`, `independence` `day`, `intense`, `mellow`, `peaceful`, `powerful`, `relaxing`, `santa`, `serene`, `soothing`, `sports`, `spring`, `tranquil`, `warming`.
| `power_on` | Whether to turn the light on before starting the effect (optional, default: true)
### Service `lifx.effect_sky`
### Action `lifx.effect_sky`
Run a hardware-based effect on LIFX Ceiling devices that animates a sky scene across the device. The effect emulates three different types of sky: Sunrise, Sunset, and Clouds.
The default values and palette used by each sky type match those used by the LIFX smartphone app.
| Service data attribute | Description |
| Data attribute | Description |
| ---------------------- | ----------------------------------------------------------------------------------- |
| `entity_id` | String or list of strings containing the `entity_id` of one or more Ceiling devices |
| `speed` | Duration in seconds for the effect to complete (optional, min: 1s, max: 86400s, default: 50s) |
@ -232,13 +232,13 @@ data:
- [40, 0, 100, 6500] # Final sun: cool white
```
### Service `lifx.effect_move`
### Action `lifx.effect_move`
Run a hardware-based effect on LIFX multizone devices that move the current colors on the device in a particular direction. The direction and speed of the animation are controlled by the `speed` and `direction` attributes. You can change the effect's colors while running using the `lifx.set_state` service.
Run a hardware-based effect on LIFX multizone devices that move the current colors on the device in a particular direction. The direction and speed of the animation are controlled by the `speed` and `direction` attributes. You can change the effect's colors while running using the `lifx.set_state` action.
The effect will not be visible if all LEDs on the device are set to the same color and is ignored by unsupported devices.
| Service data attribute | Description |
| Data attribute | Description |
| ---------------------- | ----------- |
| `entity_id` | String or list of strings that point at `entity_id`s of multizone lights.
| `speed` | Duration in seconds for the effect to travel the length of the device (min: 0.1s, max: 60s)
@ -246,11 +246,11 @@ The effect will not be visible if all LEDs on the device are set to the same col
| `theme` | The name of a pre-defined theme to apply to the multizone device before starting the effect.
| `power_on` | Whether to turn the light on before starting the effect (optional, default: true)
### Service `lifx.effect_stop`
### Action `lifx.effect_stop`
Run an effect that does nothing, thereby stopping any software or hardware effect that might be running.
| Service data attribute | Description |
| Data attribute | Description |
| ---------------------- | ----------- |
| `entity_id` | String or list of strings that point at `entity_id`s of lights. Use `entity_id: all` to target all.

14
source/_integrations/light.markdown
View File

@ -30,16 +30,16 @@ The field transition is optional and can be omitted.
The `.default` suffix should be added to the entity identifier of each light to define a default value, e.g., for `light.ceiling_2` the `profile` field is `light.ceiling_2.default`. To define a default for all lights, the identifier `group.all_lights.default` can be used. Individual settings always supersede the `all_lights` default setting.
{% note %}
If a light entity is in the `on` state, the default profile brightness will only be applied if it is called in the service call data attribute `profile`, like any other named profile. The transition attribute will be applied for all `light.turn_on`, `light.toggle` and `light.turn_off` service calls, unless specified otherwise in the service call data.
If a light entity is in the `on` state, the default profile brightness will only be applied if it is called in the action data attribute `profile`, like any other named profile. The transition attribute will be applied for all `light.turn_on`, `light.toggle`, and `light.turn_off` actions, unless specified otherwise in the action data.
{% endnote %}
### Service `light.turn_on`
### Action `light.turn_on`
Turns one light on or multiple lights on using [groups](/integrations/group/).
Most lights do not support all attributes. You can check the integration documentation of your particular light for hints, but in general, you will have to try things out and see what works.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | String or list of strings that point at `entity_id`s of lights. To target all lights, set `entity_id` to `all`. |
| `transition` | yes | Number that represents the time (in seconds) the light should take to transition to the new state. |
@ -101,18 +101,18 @@ automation:
If no data is sent, and a default profile exists, the default profile will be applied.
{% endnote %}
### Service `light.turn_off`
### Action `light.turn_off`
Turns one or multiple lights off.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------- |
| `entity_id` | no | String or list of strings that point at `entity_id`s of lights. To target all lights, set `entity_id` to `all`. |
| `transition` | yes | Integer that represents the time the light should take to transition to the new state in seconds. |
| `flash` | yes | Tell light to flash, can be either value `short` or `long`. |
### Service `light.toggle`
### Action `light.toggle`
Toggles the state of one or multiple lights. Takes the same arguments as the [`light.turn_on`](#service-lightturn_on) service.
Toggles the state of one or multiple lights. Takes the same arguments as the [`light.turn_on`](#action-lightturn_on) action.
*Note*: If `light.toggle` is used for a group of lights, it will toggle the individual state of each light. If you want the lights to be treated as a single light, use [Light Groups](/integrations/group#binary-sensor-light-and-switch-groups) instead.

4
source/_integrations/light.template.markdown
View File

@ -19,7 +19,7 @@ related:
---
The `template` platform creates lights that combine integrations and provides the
ability to run scripts or invoke services for each of the on, off, and
ability to run scripts or invoke actions for each of the on, off, and
brightness commands of a light.
To enable Template Lights in your installation, add the following to your
@ -218,7 +218,7 @@ result:
{% raw %}`{{ is_state('switch.source', 'on') }}`{% endraw %}
Transition doesn't have its own script, it will instead be passed as a named parameter `transition` to the `turn_on`, `turn_off`, `brightness`, `color_temp`, `effect`, `hs_color`, `rgb_color`, `rgbw_color` or `rgbww_color` scripts.
Brightness will be passed as a named parameter `brightness` to either of `turn_on`, `color_temp`, `effect`, `hs_color`, `rgb_color`, `rgbw_color` or `rgbww_color` scripts if the corresponding parameter is also in the call. In this case, the brightness script (`set_level`) will not be called.
If only brightness is passed to `light.turn_on` service call then `set_level` script is called.
If only brightness is passed to `light.turn_on` action, then `set_level` script is called.
## Examples

2
source/_integrations/limitlessled.markdown
View File

@ -106,7 +106,7 @@ bridges:
LimitlessLED has a `night` effect that can be used to dim the lights below `brightness: 1`. This night mode is meant to temporarily turn the lights into a nightlight. This mode can be especially helpful when wall switches are also being used. For example, when a light is using the `night` effect one way to return it to its previous brightness level (other than using Home Assistant) is to switch the lights off and then back on from the wall switch.
Note that the `brightness`, `color` and `temperature` attributes cannot be used when using the `night` effect. You can turn on `night` effect by using the `effect` attribute of the normal `light.turn_on` service. Here is an example:
Note that the `brightness`, `color` and `temperature` attributes cannot be used when using the `night` effect. You can turn on `night` effect by using the `effect` attribute of the normal `light.turn_on` action. Here is an example:
```yaml
automation:

4
source/_integrations/litterrobot.markdown
View File

@ -77,9 +77,9 @@ Some entities have attributes in addition to the default ones that are available
| sleep_mode_enabled | boolean | Whether or not sleep mode is enabled. |
| power_status | string | Current power status of the unit. `AC` indicates normal power, `DC` indicates battery backup and `NC` indicates that the unit is not connected and/or powered off. |
## Services
## Actions
Services are utilized for additional functionality that is available in the Whisker (previously Litter-Robot) companion app. The following are currently available:
Actions are utilized for additional functionality that is available in the Whisker (previously Litter-Robot) companion app. The following are currently available:
### set_sleep_mode

2
source/_integrations/llamalab_automate.markdown
View File

@ -36,7 +36,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

8
source/_integrations/local_file.markdown
View File

@ -14,7 +14,7 @@ related:
title: Configuration file
---
The **Local file** camera {% term integration %} allows you to integrate an image file from disk into Home Assistant as a camera. If the image is updated on the file system the image displayed in Home Assistant will also be updated. The service `local_file.update_file_path` can be used to update the image using an automation.
The **Local file** camera {% term integration %} allows you to integrate an image file from disk into Home Assistant as a camera. If the image is updated on the file system, the image displayed in Home Assistant will also be updated. The `local_file.update_file_path` action can be used to update the image using an automation.
The `local_file` camera can for example be used with various camera platforms that save a temporary images locally. It can also be used to display a graph that you render periodically and will then be displayed in Home Assistant.
@ -41,11 +41,11 @@ name:
type: string
{% endconfiguration %}
### Service `local_file.update_file_path`
### Action `local_file.update_file_path`
Use this service to change the file displayed by the camera.
Use this action to change the file displayed by the camera.
| Service data attribute | Description |
| Data attribute | Description |
| ---------------------- | ---------------------------------------------------- |
| `entity_id` | String of the `entity_id` of the camera to update. |
| `file_path` | The full path to the new image file to be displayed. |

24
source/_integrations/lock.markdown
View File

@ -14,19 +14,19 @@ ha_integration_type: entity
Keeps track which locks are in your environment, their state and allows you to control them.
- Maintains a state per lock and a combined state `all_locks`.
- Registers services `lock.lock`, `lock.unlock` and `lock.open` (unlatch) to control locks.
- Registers actions `lock.lock`, `lock.unlock`, and `lock.open` (unlatch) to control locks.
{% include integrations/building_block_integration.md %}
### Services
### Actions
A lock integration provides the following services:
A lock integration provides the following actions:
#### Service `lock.lock`
#### Action `lock.lock`
Lock your door, the attribute should appear under a 'data' attribute for the service.
Lock your door, the attribute should appear under a 'data' attribute for the action.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------- |
| `entity_id` | no | Entity of the relevant lock. |
@ -39,11 +39,11 @@ action:
entity_id: lock.my_place
```
#### Service `lock.unlock`
#### Action `lock.unlock`
Unlock your door, the attribute should appear under a 'data' attribute for the service.
Unlock your door, the attribute should appear under a 'data' attribute for the action.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------- |
| `entity_id` | no | Entity of the relevant lock. |
@ -56,14 +56,14 @@ action:
entity_id: lock.my_place
```
### Use the services
### Use the actions
Go to the **Developer Tools**, then to **Call Service** in the frontend, and choose `lock.lock`, `lock.unlock` or `lock.open` from the list of available services (**Services:** on the left). Enter something like the sample below into the **Service Data** field and hit **CALL SERVICE**.
Go to the **Developer Tools**, then to **Actions** in the frontend, and choose `lock.lock`, `lock.unlock` or `lock.open` from the list of available actions. Enter something like the sample below into the **data** field and select **Perform action**.
```json
{"entity_id":"lock.front_door"}
```
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | -------------------------------------------------------------- |
| `entity_id` | yes | Only act on specific lock. Use `entity_id: all` to target all. |

4
source/_integrations/lock.mqtt.markdown
View File

@ -68,11 +68,11 @@ availability_topic:
required: false
type: string
code_format:
description: A regular expression to validate a supplied code when it is set during the service call to `open`, `lock` or `unlock` the MQTT lock.
description: A regular expression to validate a supplied code when it is set during the action to `open`, `lock` or `unlock` the MQTT lock.
required: false
type: string
command_template:
description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate the payload to send to `command_topic`. The lock command template accepts the parameters `value` and `code`. The `value` parameter will contain the configured value for either `payload_open`, `payload_lock` or `payload_unlock`. The `code` parameter is set during the service call to `open`, `lock` or `unlock` the MQTT lock and will be set `None` if no code was passed.
description: Defines a [template](/docs/configuration/templating/#using-templates-with-the-mqtt-integration) to generate the payload to send to `command_topic`. The lock command template accepts the parameters `value` and `code`. The `value` parameter will contain the configured value for either `payload_open`, `payload_lock` or `payload_unlock`. The `code` parameter is set during the action to `open`, `lock` or `unlock` the MQTT lock and will be set `None` if no code was passed.
required: false
type: template
command_topic:

2
source/_integrations/logbook.markdown
View File

@ -173,7 +173,7 @@ script:
{% important %}
When calling the `logbook.log` service without a `domain` or `entity_id`, entries will be added with the `logbook` domain. Ensure that the `logbook` domain is not filtered away if you want these entries to appear in your logbook.
When calling the `logbook.log` action without a `domain` or `entity_id`, entries will be added with the `logbook` domain. Ensure that the `logbook` domain is not filtered away if you want these entries to appear in your logbook.
{% endimportant %}
{% note %}

12
source/_integrations/logger.markdown
View File

@ -137,12 +137,12 @@ logger:
- "^Error handling request$"
```
## Services
## Actions
### Service `set_default_level`
### Action `set_default_level`
You can alter the default log level (for integrations without a specified log
level) using the service `logger.set_default_level`.
level) using the `logger.set_default_level` action.
An example call might look like this:
@ -152,10 +152,10 @@ data:
level: info
```
### Service `set_level`
### Action `set_level`
You can alter log level for one or several integrations using the service
`logger.set_level`. It accepts the same format as `logs` in the configuration.
You can alter log level for one or several integrations using the `logger.set_level` action.
It accepts the same format as `logs` in the configuration.
An example call might look like this:

4
source/_integrations/loqed.markdown
View File

@ -45,9 +45,9 @@ Home Assistant should automatically detect your lock when your Home Assistant ru
You can also set up a lock manually when for some reason, it is not automatically detected. In that case, you need to provide both the API Key from the previous step and the name of the Lock, as it is known in the LOQED companion app.
## Services
## Actions
Please see the default [lock integration page](/integrations/lock/) for the services available for the lock.
Please see the default [lock integration page](/integrations/lock/) for the actions available for the lock.
## De-installation in Loqed

4
source/_integrations/lutron.markdown
View File

@ -53,11 +53,11 @@ Keypad buttons actions are provided in event entities.
## Keypad LEDs
Each full-width button on a Lutron SeeTouch, Hybrid SeeTouch, and Tabletop SeeTouch Keypad has an LED that can be controlled by Home Assistant. A service call of switch.turn_off or switch.turn_on against the appropriate LED entity will control the keypad LED.
Each full-width button on a Lutron SeeTouch, Hybrid SeeTouch, and Tabletop SeeTouch Keypad has an LED that can be controlled by Home Assistant. Performing an action of `switch.turn_off` or `switch.turn_on` against the appropriate LED entity will control the keypad LED.
Keep in mind that the Lutron system will also control the LED state independent of Home Assistant, according to the programming of the RadioRA2 system. This also means you can query LED states to determine if a certain scene is active, since the LED will have been illuminated by the RadioRA2 repeaters. This includes the "phantom" LEDs of Main Repeater Keypad buttons; even though there is no physical button or LED, the RadioRA2 system tracks the scenes and will "light" the LED that can be queried.
If a button is not programmed to control any lights or other devices in the RadioRA2 system but is given a name in the programming software, it will be available to fire events in Home Assistant. However, since there is no way to have a scene "active" on a button with no devices associated, the Main Repeater will automatically extinguish the keypad LED a few seconds after the button press. If you wish to have Home Assistant light the keypad LED after a button press, you will need to delay your service call to light the LED for several seconds, so it arrives after the Main Repeater has sent the command to turn it off.
If a button is not programmed to control any lights or other devices in the RadioRA2 system but is given a name in the programming software, it will be available to fire events in Home Assistant. However, since there is no way to have a scene "active" on a button with no devices associated, the Main Repeater will automatically extinguish the keypad LED a few seconds after the button press. If you wish to have Home Assistant light the keypad LED after a button press, you will need to delay your action to light the LED for several seconds, so it arrives after the Main Repeater has sent the command to turn it off.
## Scene

4
source/_integrations/lutron_caseta.markdown
View File

@ -117,9 +117,9 @@ After setup, shades will appear in Home Assistant using an `entity_id` based on
For more information on working with shades in Home Assistant, see the [Covers integration](/integrations/cover/).
Available services: `cover.open_cover`, `cover.close_cover`, `cover.stop_cover` and `cover.set_cover_position`. Cover `position` ranges from `0` for fully closed to `100` for fully open.
Available actions: `cover.open_cover`, `cover.close_cover`, `cover.stop_cover` and `cover.set_cover_position`. Cover `position` ranges from `0` for fully closed to `100` for fully open.
Available services for tilt-only wood blinds: `cover.open_cover_tilt`, `cover.close_cover_tilt`, `cover.stop_cover_tilt`, `cover.toggle_tilt`. Cover `position` is `0` or `100` for fully closed and `50` for fully open.
Available actions for tilt-only wood blinds: `cover.open_cover_tilt`, `cover.close_cover_tilt`, `cover.stop_cover_tilt`, `cover.toggle_tilt`. Cover `position` is `0` or `100` for fully closed and `50` for fully open.
## Light