From 38489d3719ed5a66c385eb2abd2f80b385eaba7b Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Wed, 17 Jul 2024 07:16:04 +0200 Subject: [PATCH] Rename Services to Actions in integrations: W (#33832) * Rename Services to Actions in integrations: W * Update source/_integrations/wemo.markdown * Update source/_integrations/wilight.markdown * Update source/_integrations/water_heater.markdown --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> --- source/_integrations/wake_on_lan.markdown | 16 ++++---- source/_integrations/water_heater.markdown | 20 +++++----- .../_integrations/water_heater.mqtt.markdown | 2 +- .../_integrations/waze_travel_time.markdown | 6 +-- source/_integrations/weather.markdown | 8 ++-- source/_integrations/webostv.markdown | 20 +++++----- source/_integrations/wemo.markdown | 18 ++++----- source/_integrations/whirlpool.markdown | 12 +++--- source/_integrations/wilight.markdown | 38 +++++++++---------- source/_integrations/wled.markdown | 8 ++-- source/_integrations/workday.markdown | 6 +-- 11 files changed, 77 insertions(+), 77 deletions(-) diff --git a/source/_integrations/wake_on_lan.markdown b/source/_integrations/wake_on_lan.markdown index 44f71468418..f45759c148d 100644 --- a/source/_integrations/wake_on_lan.markdown +++ b/source/_integrations/wake_on_lan.markdown @@ -33,21 +33,21 @@ To use this {% term integration %} in your installation, add the following to yo wake_on_lan: ``` -### Integration services +### Actions -Available services: `send_magic_packet`. +Available actions: `send_magic_packet`. -#### Service `wake_on_lan.send_magic_packet` +#### Action `wake_on_lan.send_magic_packet` Send a _magic packet_ to wake up a device with 'Wake on LAN' capabilities. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------------------------------------------------- | | `mac` | no | MAC address of the device to wake up. | | `broadcast_address` | yes | Optional broadcast IP where to send the magic packet. | | `broadcast_port` | yes | Optional port where to send the magic packet. | -Sample service data: +Sample action data: ```json { @@ -57,7 +57,7 @@ Sample service data: {% note %} This usually only works if the target device is connected to the same network. Routing the magic packet to a different subnet requires a special configuration on your router or may not be possible. -The service to route the packet is most likely named "IP Helper". It may support Wake on LAN, but not all routers support this. +The action to route the packet is most likely named "IP Helper". It may support Wake on LAN, but not all routers support this. {% endnote %} ## Switch @@ -143,7 +143,7 @@ shell_command: A switch defined with the `wake_on_lan` platform will render in the UI with both 'on' and 'off' clickable actions. If you don't intend to use the `turn_off` functionality, then using a virtual button & automation will look cleaner and less confusing. It will only have one action. 1. First, define a new helper button. - - Go to **{% my helpers title="Settings > Devices & Services > Helpers" %}** and select the **+ Create helper** button. Choose **Button** and give it a name. A button named "Wake PC" will render like this: + - Go to **{% my helpers title="Settings > Devices & services > Helpers" %}** and select the **+ Create helper** button. Choose **Button** and give it a name. A button named "Wake PC" will render like this: ![image](https://github.com/home-assistant/home-assistant.io/assets/252209/10e468a0-45c8-4ee7-b69d-596db3845b14) @@ -157,7 +157,7 @@ A switch defined with the `wake_on_lan` platform will render in the UI with both - input_button.wake_pc ``` -3. For the action, select **Call service** and choose **Wake on LAN: Send magic packet**. +3. For the action, select **Perform action** and choose **Wake on LAN: Send magic packet**. 4. Type in the target MAC address. - Do not change the broadcast port unless you've configured your device to listen to a different port. - Continuing our example, the action YAML looks like this: diff --git a/source/_integrations/water_heater.markdown b/source/_integrations/water_heater.markdown index f58071ad053..e0fa0cc490a 100644 --- a/source/_integrations/water_heater.markdown +++ b/source/_integrations/water_heater.markdown @@ -20,21 +20,21 @@ water_heater: platform: demo ``` -## Services +## Actions -### Water heater control services +### Water heater control actions -Available services: `water_heater.set_temperature`, `water_heater.turn_away_mode_on`, `water_heater.turn_away_mode_off`, `water_heater.set_operation_mode` +Available actions: `water_heater.set_temperature`, `water_heater.turn_away_mode_on`, `water_heater.turn_away_mode_off`, `water_heater.set_operation_mode` {% tip %} -Not all water heater services may be available for your platform. Be sure to check the available services Home Assistant has enabled by checking **Developer Tools** -> **Services**. +Not all water heater actions may be available for your platform. Be sure to check the available actions Home Assistant has enabled by checking **Developer Tools** > **Actions**. {% endtip %} -### Service `water_heater.set_temperature` +### Action `water_heater.set_temperature` Sets target temperature of water heater device. -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `entity_id` | yes | String or list of strings that point at the `entity_id` of water heater devices to control. Use `entity_id: all` to target all. | `temperature` | no | New target temperature for water heater @@ -56,11 +56,11 @@ automation: operation_mode: eco ``` -### Service `water_heater.set_operation_mode` +### Action `water_heater.set_operation_mode` Set operation mode for water heater device -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `entity_id` | yes | String or list of strings that point at the `entity_id` of water heater devices to control. Use `entity_id: all` to target all. | `operation_mode` | no | New value of operation mode. For a list of possible modes, refer to the integration documentation. @@ -80,11 +80,11 @@ automation: operation_mode: eco ``` -### Service `water_heater.set_away_mode` +### Action `water_heater.set_away_mode` Turn away mode on or off for water heater device -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ----------- | | `entity_id` | yes | String or list of strings that point at the `entity_id` of water heater devices to control. Use `entity_id: all` to target all. | `away_mode` | no | New value of away mode. 'on'/'off' or True/False diff --git a/source/_integrations/water_heater.mqtt.markdown b/source/_integrations/water_heater.mqtt.markdown index 884c1252c18..2ca78692316 100644 --- a/source/_integrations/water_heater.mqtt.markdown +++ b/source/_integrations/water_heater.mqtt.markdown @@ -214,7 +214,7 @@ power_command_template: required: false type: template power_command_topic: - description: The MQTT topic to publish commands to change the water heater power state. Sends the payload configured with `payload_on` if the water heater is turned on via the `water_heater.turn_on`, or the payload configured with `payload_off` if the water heater is turned off via the `water_heater.turn_off` service. Note that `optimistic` mode is not supported through `water_heater.turn_on` and `water_heater.turn_off` services. When called, these services will send a power command to the device but will not optimistically update the state of the water heater. The water heater device should report its state back via `mode_state_topic`. + description: The MQTT topic to publish commands to change the water heater power state. Sends the payload configured with `payload_on` if the water heater is turned on via the `water_heater.turn_on`, or the payload configured with `payload_off` if the water heater is turned off via the `water_heater.turn_off` action. Note that `optimistic` mode is not supported through `water_heater.turn_on` and `water_heater.turn_off` actions. When called, these actions will send a power command to the device but will not optimistically update the state of the water heater. The water heater device should report its state back via `mode_state_topic`. required: false type: string precision: diff --git a/source/_integrations/waze_travel_time.markdown b/source/_integrations/waze_travel_time.markdown index 7f67081ae28..9961d70d43a 100644 --- a/source/_integrations/waze_travel_time.markdown +++ b/source/_integrations/waze_travel_time.markdown @@ -25,12 +25,12 @@ Notes: - The string inputs for `Substring *` allow you to force the {% term integration %} to use a particular route or avoid a particular route in its time travel calculation. These inputs are case insensitive and matched against the description of the route. - When using the `Avoid Toll Roads?`, `Avoid Subscription Roads?` and `Avoid Ferries?` options, be aware that Waze will sometimes still route you over toll roads or ferries if a valid vignette/subscription is assumed. Default behavior is that Waze will route you over roads having subscription options. It is therefor best is to set both `Avoid Toll Roads?` and `Avoid Subscription Roads?` or `Avoid Ferries?` if needed and experiment to ensure the desired outcome. -## Service `waze_travel_time.get_travel_times` +## Action `waze_travel_time.get_travel_times` This service populates [response data](/docs/scripts/service-calls#use-templates-to-handle-response-data) with route alternatives and travel times between two locations. -| Service data attribute | Optional | Description | Example | +| Data attribute | Optional | Description | Example | | ---------------------- | -------- | ----------- | --------| | `origin` | no | The origin of the route | "51.330436, 3.802043" | | `destination` | no | The destination of the route | "51.330436, 3.802043" | @@ -53,7 +53,7 @@ data: response_variable: routes ``` -{% details "Example service response" %} +{% details "Example action response" %} ```yaml waze_travel_time.get_travel_times: diff --git a/source/_integrations/weather.markdown b/source/_integrations/weather.markdown index a589f9c0b0e..86b1fe5e58d 100644 --- a/source/_integrations/weather.markdown +++ b/source/_integrations/weather.markdown @@ -68,12 +68,12 @@ wind_speed: 35.17 wind_speed_unit: km/h ``` -## Service `weather.get_forecasts` +## Action `weather.get_forecasts` -This service populates [response data](/docs/scripts/service-calls#use-templates-to-handle-response-data) +This action populates [response data](/docs/scripts/service-calls#use-templates-to-handle-response-data) with a mapping of weather services and their associated forecasts. -| Service data attribute | Optional | Description | Example | +| Data attribute | Optional | Description | Example | | ---------------------- | -------- | ----------- | --------| | `type` | no | The type of forecast, must be one of `daily`, `twice_daily`, or `hourly`. The default is `daily`. | daily @@ -144,7 +144,7 @@ template: {% enddetails %} -{% details "Example service response" %} +{% details "Example action response" %} ```yaml weather.tomorrow_io_home_nowcast: diff --git a/source/_integrations/webostv.markdown b/source/_integrations/webostv.markdown index 3421c30261b..95365bbd38c 100644 --- a/source/_integrations/webostv.markdown +++ b/source/_integrations/webostv.markdown @@ -66,9 +66,9 @@ Any other [actions](/docs/automation/action/) to power on the device can be conf It is possible to select which sources will be available to the media player. When the TV is powered on press the **CONFIGURE** button in the {% term integration %} card and select the sources to enable. If you don't select any source the media player will offer all of the sources of the TV. -## 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 best matching channel 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 best matching channel according to the `media_content_id` parameter: 1. Channel number *(i.e., '1' or '6')* 2. Exact channel name *(i.e., 'France 2' or 'CNN')* @@ -102,29 +102,29 @@ The behavior of the next and previous buttons is different depending on the acti ### Sound output The current sound output of the TV can be found under the state attributes. -To change the sound output, the following service is available: +To change the sound output, the following action is available: -#### Service `webostv.select_sound_output` +#### Action `webostv.select_sound_output` -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | --------------------------------------- | | `entity_id` | no | Target a specific webostv media player. | | `sound_output` | no | Name of the sound output to switch to. | ### Generic commands and buttons -Available services: `button`, `command` +Available actions: `button`, `command` -### Service `webostv.button` +### Action `webostv.button` -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `entity_id` | no | Target a specific webostv media player. | | `button` | no | Name of the button. Known possible values are `LEFT`, `RIGHT`, `DOWN`, `UP`, `HOME`, `MENU`, `BACK`, `ENTER`, `DASH`, `INFO`, `ASTERISK`, `CC`, `EXIT`, `MUTE`, `RED`, `GREEN`, `BLUE`, `YELLOW`, `VOLUMEUP`, `VOLUMEDOWN`, `CHANNELUP`, `CHANNELDOWN`, `PLAY`, `PAUSE`, `NETFLIX`, `GUIDE`, `AMAZON`, `0`, `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9` | -### Service `webostv.command` +### Action `webostv.command` -| Service data attribute | Optional | Description | +| Data attribute | Optional | Description | | ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `entity_id` | no | Target a specific webostv media player. | | `command` | no | Endpoint for the command, e.g., `system.launcher/open`. The full list of known endpoints is available at | diff --git a/source/_integrations/wemo.markdown b/source/_integrations/wemo.markdown index 20642c35cbd..ab342fcdd27 100644 --- a/source/_integrations/wemo.markdown +++ b/source/_integrations/wemo.markdown @@ -122,18 +122,18 @@ There are several attributes which can be used for automations and templates: | `target_humidity` | An integer that indicates the desired relative humidity percentage (this is constrained to the humidity settings of the device, which are 45, 50, 55, 60, and 100). | `water level` | String that indicates whether the water level is Good, Low, or Empty. -### Services +### Actions -There are several services which can be used for automations and control of the humidifier: +There are several actions which can be used for automations and control of the humidifier: -| Service | Description | +| Action | Description | | --------- | ----------- | -| `set_speed` | Calling this service sets the fan speed (entity_id and speed are required parameters, and speed must be one of the following: off, low, medium, or high). When selecting low for the speed, this will map to the WeMo humidifier speed of minimum. When selecting high for the speed, this will map to the WeMo humidifier speed of maximum. The WeMo humidifier speeds of low and high are unused due to constraints on which fan speeds Home Assistant supports. -| `toggle` | Calling this service will toggle the humidifier between on and off states. -| `turn_off` | Calling this service will turn the humidifier off (entity_id is required). -| `turn_on` | Calling this service will turn the humidifier on and set the speed to the last used speed (defaults to medium, entity_id is required). -| `wemo.set_humidity` | Calling this service will set the desired relative humidity setting on the device (entity_id is a required list of 1 or more entities to set humidity on, and target_humidity is a required float value between 0 and 100 (this value will be rounded down and mapped to one of the valid desired humidity settings of 45, 50, 55, 60, or 100 that are supported by the WeMo humidifier)). -| `wemo.reset_filter_life` | Calling this service will reset the humdifier's filter lifetime back to 100% (entity_id is a required list of 1 or more entities to reset the filter lifetime on). Call this service when you change the filter on your humidifier. +| `set_speed` | Performing this action sets the fan speed (entity_id and speed are required parameters, and speed must be one of the following: off, low, medium, or high). When selecting low for the speed, this will map to the WeMo humidifier speed of minimum. When selecting high for the speed, this will map to the WeMo humidifier speed of maximum. The WeMo humidifier speeds of low and high are unused due to constraints on which fan speeds Home Assistant supports. +| `toggle` | Performing this action will toggle the humidifier between on and off states. +| `turn_off` | Performing this action will turn the humidifier off (entity_id is required). +| `turn_on` | Performing this action will turn the humidifier on and set the speed to the last used speed (defaults to medium, entity_id is required). +| `wemo.set_humidity` | Performing this action will set the desired relative humidity setting on the device (entity_id is a required list of 1 or more entities to set humidity on, and target_humidity is a required float value between 0 and 100 (this value will be rounded down and mapped to one of the valid desired humidity settings of 45, 50, 55, 60, or 100 that are supported by the WeMo humidifier)). +| `wemo.reset_filter_life` | Performing this action will reset the humdifier's filter lifetime back to 100% (entity_id is a required list of 1 or more entities to reset the filter lifetime on). Call this action when you change the filter on your humidifier. ## Long press events and triggers diff --git a/source/_integrations/whirlpool.markdown b/source/_integrations/whirlpool.markdown index 2c0dd6cfb73..43649191833 100644 --- a/source/_integrations/whirlpool.markdown +++ b/source/_integrations/whirlpool.markdown @@ -55,10 +55,10 @@ The `whirlpool` sensor platform integrates Whirlpool Washer and Dryer systems in The `whirlpool` climate platform integrates Whirlpool air conditioning systems into Home Assistant, allowing control of the appliance trough the user interface. The current inside temperature is also displayed on the thermostat card. -The following services are also available: +The following actions are also available: -- [**set_hvac_mode**](/integrations/climate/#service-climateset_hvac_mode) (`off`, `heat`, `cool`, `fan_only`) -- [**target temperature**](/integrations/climate#service-climateset_temperature) -- [**turn on/off**](/integrations/climate#service-climateturn_on) -- [**fan mode**](/integrations/climate#service-climateset_fan_mode) (`low`, `medium`, `high`) -- [**swing mode**](/integrations/climate#service-climateset_swing_mode) (`off`, `horizontal`) +- [**set_hvac_mode**](/integrations/climate/#action-climateset_hvac_mode) (`off`, `heat`, `cool`, `fan_only`) +- [**target temperature**](/integrations/climate#action-climateset_temperature) +- [**turn on/off**](/integrations/climate#action-climateturn_on) +- [**fan mode**](/integrations/climate#action-climateset_fan_mode) (`low`, `medium`, `high`) +- [**swing mode**](/integrations/climate#action-climateset_swing_mode) (`off`, `horizontal`) diff --git a/source/_integrations/wilight.markdown b/source/_integrations/wilight.markdown index eff11b3a57b..4271a0abf16 100644 --- a/source/_integrations/wilight.markdown +++ b/source/_integrations/wilight.markdown @@ -38,17 +38,17 @@ There is currently support for the following device types within Home Assistant: The **WiLight** {% term integration %} allows you to control your Fans from within Home Assistant. -### Fan services +### Fan actions -There are several services which can be used for automations and control of the fan: +There are several actions which can be used for automations and control of the fan: -| Service | Description | +| Action | Description | | --------- | ----------- | -| `set_percentage` | Calling this service sets the fan speed (`entity_id` and `percentage` are required parameters). Percentage must be in the range 0-100, percentage = 0 turns off the fan. There are three speed levels 33%, 66% and 100%. Adjusting to intermediate levels goes to the next higher level. -| `set_direction` | Calling this service will set the fan direction (`entity_id` and `direction` are required parameters, and direction must be one of the following: forward or reverse). Calling this service will turn the fan on. -| `toggle` | Calling this service will toggle the fan between on and off states (`entity_id` is required). -| `turn_off` | Calling this service will turn the fan off (`entity_id` is required). -| `turn_on` | Calling this service will turn the fan on and set the speed and direction to the last used ones (defaults to high and forward, `entity_id` is required). +| `set_percentage` | Calling this action sets the fan speed (`entity_id` and `percentage` are required parameters). Percentage must be in the range 0-100, percentage = 0 turns off the fan. There are three speed levels 33%, 66% and 100%. Adjusting to intermediate levels goes to the next higher level. +| `set_direction` | Calling this action will set the fan direction (`entity_id` and `direction` are required parameters, and direction must be one of the following: forward or reverse). Calling this action will turn the fan on. +| `toggle` | Calling this action will toggle the fan between on and off states (`entity_id` is required). +| `turn_off` | Calling this action will turn the fan off (`entity_id` is required). +| `turn_on` | Calling this action will turn the fan on and set the speed and direction to the last used ones (defaults to high and forward, `entity_id` is required). ## Irrigation @@ -57,26 +57,26 @@ There are two switch types for Irrigation: `watering switch` and `pause switch`. A `watering switch` can turn on and off the irrigation valve, while the `pause switch` can disable / enable the action of a `watering switch`. `Triggers` activate (turn on) the `watering switch` (irrigation valve) at the programmed time. The trigger can be set to run on a day of the week or only once (today). -### Irrigation services +### Irrigation actions -There are several services which can be used for automations and control of the Irrigation: +There are several actions which can be used for automations and control of the Irrigation: - For `watering switch`: -| Service | Description | +| Action | Description | | --------- | ----------- | -| `turn_off` | Calling this service will turn the irrigation valve off (`entity_id` is required). -| `turn_on` | Calling this service will turn the irrigation valve on (`entity_id` is required). -| `set_watering_time` | Calling this service sets the watering time (`entity_id` and `watering_time` are required parameters), `watering_time` must be in the range 1-1800 seconds. -| `set_trigger` | Calling this service sets the trigger_1, trigger_2, trigger_3 or trigger_4 (`entity_id`, `trigger_index` and `trigger` are required parameters), `trigger_index` must be between 1 and 4 and `trigger` must be according Trigger rules (see below). +| `turn_off` | Calling this action will turn the irrigation valve off (`entity_id` is required). +| `turn_on` | Calling this action will turn the irrigation valve on (`entity_id` is required). +| `set_watering_time` | Calling this action sets the watering time (`entity_id` and `watering_time` are required parameters), `watering_time` must be in the range 1-1800 seconds. +| `set_trigger` | Calling this action sets the trigger_1, trigger_2, trigger_3 or trigger_4 (`entity_id`, `trigger_index` and `trigger` are required parameters), `trigger_index` must be between 1 and 4 and `trigger` must be according Trigger rules (see below). - For `pause switch`: -| Service | Description | +| Action | Description | | --------- | ----------- | -| `turn_off` | Calling this service will turn the pause switch off, enabling watering switch (`entity_id` is required). -| `turn_on` | Calling this service will turn the pause switch on, disabling watering switch (`entity_id` is required). -| `set_pause_time` | Calling this service sets the pause time (`entity_id` and `pause_time` are required parameters), `pause_time` must be in the range 1-24 hours. +| `turn_off` | Performing this action will turn the pause switch off, enabling watering switch (`entity_id` is required). +| `turn_on` | Performing this action will turn the pause switch on, disabling watering switch (`entity_id` is required). +| `set_pause_time` | Performing this action sets the pause time (`entity_id` and `pause_time` are required parameters), `pause_time` must be in the range 1-24 hours. Trigger rules: - String with 8 decimal characters ("0" to "9"). diff --git a/source/_integrations/wled.markdown b/source/_integrations/wled.markdown index f35d7b8447f..76c6c4f7b98 100644 --- a/source/_integrations/wled.markdown +++ b/source/_integrations/wled.markdown @@ -129,7 +129,7 @@ Keep Master Light: ### Activating random effect -You can automate changing the effect using a service call like this: +You can automate changing the effect using an action like this: {% raw %} @@ -164,7 +164,7 @@ data: ### Activating a preset Activating a preset is an easy way to set a WLED light to a specific -configuration. Here is an example service call to set a WLED light +configuration. Here is an example action to set a WLED light to a preset called My Preset: ```yaml @@ -182,8 +182,8 @@ to a preset called My Preset: An automation to turn on a WLED light and select a specific palette and set intensity, and speed can be created by first calling the `light.turn_on` -service, then calling the `select.select_option` service to select the -palette, then call the `number.set_value` service to set the intensity +service, then calling the `select.select_option` action to select the +palette, then call the `number.set_value` action to set the intensity and again to set the speed. Here is an example of all of these put together into an automation: diff --git a/source/_integrations/workday.markdown b/source/_integrations/workday.markdown index 9b42586b410..13fabe530e4 100644 --- a/source/_integrations/workday.markdown +++ b/source/_integrations/workday.markdown @@ -47,12 +47,12 @@ Remove holidays will take dates formatted with `YYYY-MM-DD`, a date range format The offset can be used to see if future days are workdays. For example, put `1` to see if tomorrow is a workday. -## Service `workday.check_date` +## Action `workday.check_date` -This service populates [Response Data](/docs/scripts/service-calls#use-templates-to-handle-response-data) +This action populates [Response Data](/docs/scripts/service-calls#use-templates-to-handle-response-data) providing feedback if the date is a workday or not. -| Service data attribute | Required | Description | Example | +| Data attribute | Required | Description | Example | | ---------------------- | -------- | ----------- | --------| | `check_date` | yes | Date to test if workday or not. | 2022-03-10