From ea4bbd771f165f7a55014c6fe620600601a20315 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Tue, 23 Feb 2021 14:10:13 +0100 Subject: [PATCH] Add service names to previously enriched services (#46929) Co-authored-by: Tobias Sauerwein --- .../alarm_control_panel/services.yaml | 18 ++++-- homeassistant/components/alert/services.yaml | 9 ++- .../components/automation/services.yaml | 15 +++-- .../components/browser/services.yaml | 3 +- homeassistant/components/camera/services.yaml | 21 ++++--- .../components/climate/services.yaml | 27 ++++++--- .../components/color_extractor/services.yaml | 3 +- .../components/conversation/services.yaml | 3 +- .../components/counter/services.yaml | 12 ++-- homeassistant/components/cover/services.yaml | 30 ++++++---- .../components/downloader/services.yaml | 3 +- homeassistant/components/fan/services.yaml | 30 ++++++---- .../components/homeassistant/services.yaml | 12 ++-- homeassistant/components/hue/services.yaml | 3 +- .../components/input_datetime/services.yaml | 6 +- .../components/input_number/services.yaml | 11 +++- .../components/input_select/services.yaml | 19 ++++-- .../components/input_text/services.yaml | 4 +- homeassistant/components/light/services.yaml | 6 +- homeassistant/components/lock/services.yaml | 12 ++-- homeassistant/components/logger/services.yaml | 22 +++---- .../components/media_player/services.yaml | 58 +++++++++++++------ homeassistant/components/mqtt/services.yaml | 11 ++-- .../components/netatmo/services.yaml | 13 ++++- homeassistant/components/number/services.yaml | 3 +- .../components/recorder/services.yaml | 3 +- homeassistant/components/scene/services.yaml | 12 ++-- .../components/shopping_list/services.yaml | 6 +- homeassistant/components/sonos/services.yaml | 16 ++++- .../components/system_log/services.yaml | 6 +- homeassistant/components/timer/services.yaml | 10 +++- homeassistant/components/toon/services.yaml | 1 + .../components/twentemilieu/services.yaml | 1 + homeassistant/components/vacuum/services.yaml | 34 +++++++---- homeassistant/components/vizio/services.yaml | 10 +++- homeassistant/components/wled/services.yaml | 6 +- 36 files changed, 308 insertions(+), 151 deletions(-) diff --git a/homeassistant/components/alarm_control_panel/services.yaml b/homeassistant/components/alarm_control_panel/services.yaml index a6151c58db0..b18f1cfb782 100644 --- a/homeassistant/components/alarm_control_panel/services.yaml +++ b/homeassistant/components/alarm_control_panel/services.yaml @@ -1,7 +1,8 @@ # Describes the format for available alarm control panel services alarm_disarm: - description: Send the alarm the command for disarm + name: Disarm + description: Send the alarm the command for disarm. target: fields: code: @@ -12,7 +13,8 @@ alarm_disarm: text: alarm_arm_custom_bypass: - description: Send arm custom bypass command + name: Arm with custom bypass + description: Send arm custom bypass command. target: fields: code: @@ -24,7 +26,8 @@ alarm_arm_custom_bypass: text: alarm_arm_home: - description: Send the alarm the command for arm home + name: Arm home + description: Send the alarm the command for arm home. target: fields: code: @@ -35,7 +38,8 @@ alarm_arm_home: text: alarm_arm_away: - description: Send the alarm the command for arm away + name: Arm away + description: Send the alarm the command for arm away. target: fields: code: @@ -46,7 +50,8 @@ alarm_arm_away: text: alarm_arm_night: - description: Send the alarm the command for arm night + name: Arm night + description: Send the alarm the command for arm night. target: fields: code: @@ -57,7 +62,8 @@ alarm_arm_night: text: alarm_trigger: - description: Send the alarm the command for trigger + name: Trigger + description: Send the alarm the command for trigger. target: fields: code: diff --git a/homeassistant/components/alert/services.yaml b/homeassistant/components/alert/services.yaml index c8c1d5d814a..5800d642b93 100644 --- a/homeassistant/components/alert/services.yaml +++ b/homeassistant/components/alert/services.yaml @@ -1,11 +1,14 @@ toggle: - description: Toggle alert's notifications + name: Toggle + description: Toggle alert's notifications. target: turn_off: - description: Silence alert's notifications + name: Turn off + description: Silence alert's notifications. target: turn_on: - description: Reset alert's notifications + name: Turn on + description: Reset alert's notifications. target: diff --git a/homeassistant/components/automation/services.yaml b/homeassistant/components/automation/services.yaml index 95f2057f5ee..5d399fb253e 100644 --- a/homeassistant/components/automation/services.yaml +++ b/homeassistant/components/automation/services.yaml @@ -1,10 +1,12 @@ # Describes the format for available automation services turn_on: - description: Enable an automation + name: Turn on + description: Enable an automation. target: turn_off: - description: Disable an automation + name: Turn off + description: Disable an automation. target: fields: stop_actions: @@ -16,11 +18,13 @@ turn_off: boolean: toggle: - description: Toggle (enable / disable) an automation + name: Toggle + description: Toggle (enable / disable) an automation. target: trigger: - description: Trigger the actions of an automation + name: Trigger + description: Trigger the actions of an automation. target: fields: skip_condition: @@ -32,4 +36,5 @@ trigger: boolean: reload: - description: Reload the automation configuration + name: Reload + description: Reload the automation configuration. diff --git a/homeassistant/components/browser/services.yaml b/homeassistant/components/browser/services.yaml index f6c5e7c90e1..1014e50db21 100644 --- a/homeassistant/components/browser/services.yaml +++ b/homeassistant/components/browser/services.yaml @@ -1,6 +1,7 @@ browse_url: + name: Browse description: - Open a URL in the default browser on the host machine of Home Assistant + Open a URL in the default browser on the host machine of Home Assistant. fields: url: name: URL diff --git a/homeassistant/components/camera/services.yaml b/homeassistant/components/camera/services.yaml index 3ae5b650304..3c8e99f001b 100644 --- a/homeassistant/components/camera/services.yaml +++ b/homeassistant/components/camera/services.yaml @@ -1,23 +1,28 @@ # Describes the format for available camera services turn_off: - description: Turn off camera + name: Turn off + description: Turn off camera. target: turn_on: - description: Turn on camera + name: Turn on + description: Turn on camera. target: enable_motion_detection: - description: Enable the motion detection in a camera + name: Enable motion detection + description: Enable the motion detection in a camera. target: disable_motion_detection: - description: Disable the motion detection in a camera + name: Disable motion detection + description: Disable the motion detection in a camera. target: snapshot: - description: Take a snapshot from a camera + name: Take snapshot + description: Take a snapshot from a camera. target: fields: filename: @@ -29,7 +34,8 @@ snapshot: text: play_stream: - description: Play camera stream on supported media player + name: Play stream + description: Play camera stream on supported media player. target: fields: media_player: @@ -51,7 +57,8 @@ play_stream: - "hls" record: - description: Record live camera feed + name: Record + description: Record live camera feed. target: fields: filename: diff --git a/homeassistant/components/climate/services.yaml b/homeassistant/components/climate/services.yaml index d333260202f..ca88896c6c2 100644 --- a/homeassistant/components/climate/services.yaml +++ b/homeassistant/components/climate/services.yaml @@ -1,7 +1,8 @@ # Describes the format for available climate services set_aux_heat: - description: Turn auxiliary heater on/off for climate device + name: Turn on/off auxiliary heater + description: Turn auxiliary heater on/off for climate device. target: fields: aux_heat: @@ -13,7 +14,8 @@ set_aux_heat: boolean: set_preset_mode: - description: Set preset mode for climate device + name: Set preset mode + description: Set preset mode for climate device. target: fields: preset_mode: @@ -25,7 +27,8 @@ set_preset_mode: text: set_temperature: - description: Set target temperature of climate device + name: Set temperature + description: Set target temperature of climate device. target: fields: temperature: @@ -76,7 +79,8 @@ set_temperature: - "heat" set_humidity: - description: Set target humidity of climate device + name: Set target humidity + description: Set target humidity of climate device. target: fields: humidity: @@ -93,7 +97,8 @@ set_humidity: mode: slider set_fan_mode: - description: Set fan operation for climate device + name: Set fan mode + description: Set fan operation for climate device. target: fields: fan_mode: @@ -105,7 +110,8 @@ set_fan_mode: text: set_hvac_mode: - description: Set HVAC operation mode for climate device + name: Set HVAC mode + description: Set HVAC operation mode for climate device. target: fields: hvac_mode: @@ -124,7 +130,8 @@ set_hvac_mode: - "heat" set_swing_mode: - description: Set swing operation for climate device + name: Set swing mode + description: Set swing operation for climate device. target: fields: swing_mode: @@ -136,9 +143,11 @@ set_swing_mode: text: turn_on: - description: Turn climate device on + name: Turn on + description: Turn climate device on. target: turn_off: - description: Turn climate device off + name: Turn off + description: Turn climate device off. target: diff --git a/homeassistant/components/color_extractor/services.yaml b/homeassistant/components/color_extractor/services.yaml index 671a2a2ebb9..00438dc9aa1 100644 --- a/homeassistant/components/color_extractor/services.yaml +++ b/homeassistant/components/color_extractor/services.yaml @@ -1,7 +1,8 @@ turn_on: + name: Turn on description: Set the light RGB to the predominant color found in the image provided by - URL or file path + URL or file path. target: fields: color_extract_url: diff --git a/homeassistant/components/conversation/services.yaml b/homeassistant/components/conversation/services.yaml index 5c85de7c187..edba9ffb0b9 100644 --- a/homeassistant/components/conversation/services.yaml +++ b/homeassistant/components/conversation/services.yaml @@ -1,6 +1,7 @@ # Describes the format for available component services process: - description: Launch a conversation from a transcribed text + name: Process + description: Launch a conversation from a transcribed text. fields: text: name: Text diff --git a/homeassistant/components/counter/services.yaml b/homeassistant/components/counter/services.yaml index 16010f6e2f4..4dd427c1fa1 100644 --- a/homeassistant/components/counter/services.yaml +++ b/homeassistant/components/counter/services.yaml @@ -1,19 +1,23 @@ # Describes the format for available counter services decrement: - description: Decrement a counter + name: Decrement + description: Decrement a counter. target: increment: - description: Increment a counter + name: Increment + description: Increment a counter. target: reset: - description: Reset a counter + name: Reset + description: Reset a counter. target: configure: - description: Change counter parameters + name: Configure + description: Change counter parameters. target: fields: minimum: diff --git a/homeassistant/components/cover/services.yaml b/homeassistant/components/cover/services.yaml index 173674193cb..1419a5f48ed 100644 --- a/homeassistant/components/cover/services.yaml +++ b/homeassistant/components/cover/services.yaml @@ -1,19 +1,23 @@ # Describes the format for available cover services open_cover: - description: Open all or specified cover + name: Open + description: Open all or specified cover. target: close_cover: - description: Close all or specified cover + name: Close + description: Close all or specified cover. target: toggle: - description: Toggles a cover open/closed + name: Toggle + description: Toggle a cover open/closed. target: set_cover_position: - description: Move to specific position all or specified cover + name: Set position + description: Move to specific position all or specified cover. target: fields: position: @@ -30,23 +34,28 @@ set_cover_position: mode: slider stop_cover: - description: Stop all or specified cover + name: Stop + description: Stop all or specified cover. target: open_cover_tilt: - description: Open all or specified cover tilt + name: Open tilt + description: Open all or specified cover tilt. target: close_cover_tilt: - description: Close all or specified cover tilt + name: Close tilt + description: Close all or specified cover tilt. target: toggle_cover_tilt: - description: Toggle a cover tilt open/closed + name: Toggle tilt + description: Toggle a cover tilt open/closed. target: set_cover_tilt_position: - description: Move to specific position all or specified cover tilt + name: Set tilt position + description: Move to specific position all or specified cover tilt. target: fields: tilt_position: @@ -63,5 +72,6 @@ set_cover_tilt_position: mode: slider stop_cover_tilt: - description: Stop all or specified cover + name: Stop tilt + description: Stop all or specified cover. target: diff --git a/homeassistant/components/downloader/services.yaml b/homeassistant/components/downloader/services.yaml index 5ac383fc4f6..cecb3804227 100644 --- a/homeassistant/components/downloader/services.yaml +++ b/homeassistant/components/downloader/services.yaml @@ -1,5 +1,6 @@ download_file: - description: Downloads a file to the download location + name: Download file + description: Download a file to the download location. fields: url: name: URL diff --git a/homeassistant/components/fan/services.yaml b/homeassistant/components/fan/services.yaml index ad513b84e8f..3c8eb2d0761 100644 --- a/homeassistant/components/fan/services.yaml +++ b/homeassistant/components/fan/services.yaml @@ -1,6 +1,7 @@ # Describes the format for available fan services set_speed: - description: Set fan speed + name: Set speed + description: Set fan speed. target: fields: speed: @@ -12,7 +13,8 @@ set_speed: text: set_preset_mode: - description: Set preset mode for a fan device + name: Set preset mode + description: Set preset mode for a fan device. target: fields: preset_mode: @@ -24,7 +26,8 @@ set_preset_mode: text: set_percentage: - description: Set fan speed percentage + name: Set speed percentage + description: Set fan speed percentage. target: fields: percentage: @@ -41,7 +44,8 @@ set_percentage: mode: slider turn_on: - description: Turn fan on + name: Turn on + description: Turn fan on. target: fields: speed: @@ -67,11 +71,13 @@ turn_on: text: turn_off: - description: Turn fan off + name: Turn off + description: Turn fan off. target: oscillate: - description: Oscillate the fan + name: Oscillate + description: Oscillate the fan. target: fields: oscillating: @@ -83,11 +89,13 @@ oscillate: boolean: toggle: - description: Toggle the fan on/off + name: Toggle + description: Toggle the fan on/off. target: set_direction: - description: Set the fan rotation + name: Set direction + description: Set the fan rotation. target: fields: direction: @@ -102,6 +110,7 @@ set_direction: - "reverse" increase_speed: + name: Increase speed description: Increase the speed of the fan by one speed or a percentage_step. fields: entity_id: @@ -110,7 +119,7 @@ increase_speed: percentage_step: advanced: true required: false - description: Increase speed by a percentage. Should be between 0..100. [optional] + description: Increase speed by a percentage. example: 50 selector: number: @@ -121,6 +130,7 @@ increase_speed: mode: slider decrease_speed: + name: Decrease speed description: Decrease the speed of the fan by one speed or a percentage_step. fields: entity_id: @@ -129,7 +139,7 @@ decrease_speed: percentage_step: advanced: true required: false - description: Decrease speed by a percentage. Should be between 0..100. [optional] + description: Decrease speed by a percentage. example: 50 selector: number: diff --git a/homeassistant/components/homeassistant/services.yaml b/homeassistant/components/homeassistant/services.yaml index d23bdfdba72..6bd0a0852ed 100644 --- a/homeassistant/components/homeassistant/services.yaml +++ b/homeassistant/components/homeassistant/services.yaml @@ -1,16 +1,20 @@ check_config: + name: Check configuration description: Check the Home Assistant configuration files for errors. Errors will be - displayed in the Home Assistant log + displayed in the Home Assistant log. reload_core_config: - description: Reload the core configuration + name: Reload core configuration + description: Reload the core configuration. restart: - description: Restart the Home Assistant service + name: Restart + description: Restart the Home Assistant service. set_location: - description: Update the Home Assistant location + name: Set location + description: Update the Home Assistant location. fields: latitude: name: Latitude diff --git a/homeassistant/components/hue/services.yaml b/homeassistant/components/hue/services.yaml index 80ca25007bc..07eeca6fa0f 100644 --- a/homeassistant/components/hue/services.yaml +++ b/homeassistant/components/hue/services.yaml @@ -1,7 +1,8 @@ # Describes the format for available hue services hue_activate_scene: - description: Activate a hue scene stored in the hue hub + name: Activate scene + description: Activate a hue scene stored in the hue hub. fields: group_name: name: Group diff --git a/homeassistant/components/input_datetime/services.yaml b/homeassistant/components/input_datetime/services.yaml index ef4cb9556c8..0243ca9f67d 100644 --- a/homeassistant/components/input_datetime/services.yaml +++ b/homeassistant/components/input_datetime/services.yaml @@ -1,5 +1,6 @@ set_datetime: - description: This can be used to dynamically set the date and/or time + name: Set + description: This can be used to dynamically set the date and/or time. target: fields: date: @@ -33,4 +34,5 @@ set_datetime: mode: box reload: - description: Reload the input_datetime configuration + name: Reload + description: Reload the input_datetime configuration. diff --git a/homeassistant/components/input_number/services.yaml b/homeassistant/components/input_number/services.yaml index 700a2c28144..7d388238022 100644 --- a/homeassistant/components/input_number/services.yaml +++ b/homeassistant/components/input_number/services.yaml @@ -1,13 +1,16 @@ decrement: - description: Decrement the value of an input number entity by its stepping + name: Decrement + description: Decrement the value of an input number entity by its stepping. target: increment: - description: Increment the value of an input number entity by its stepping + name: Increment + description: Increment the value of an input number entity by its stepping. target: set_value: - description: Set the value of an input number entity + name: Set + description: Set the value of an input number entity. target: fields: value: @@ -21,5 +24,7 @@ set_value: max: 9223372036854775807 step: 0.001 mode: box + reload: + name: Reload description: Reload the input_number configuration. diff --git a/homeassistant/components/input_select/services.yaml b/homeassistant/components/input_select/services.yaml index bf1b9e81033..f8fbe158aab 100644 --- a/homeassistant/components/input_select/services.yaml +++ b/homeassistant/components/input_select/services.yaml @@ -1,5 +1,6 @@ select_next: - description: Select the next options of an input select entity + name: Next + description: Select the next options of an input select entity. target: fields: cycle: @@ -11,7 +12,8 @@ select_next: boolean: select_option: - description: Select an option of an input select entity + name: Select + description: Select an option of an input select entity. target: fields: option: @@ -23,7 +25,8 @@ select_option: text: select_previous: - description: Select the previous options of an input select entity + name: Previous + description: Select the previous options of an input select entity. target: fields: cycle: @@ -35,15 +38,18 @@ select_previous: boolean: select_first: - description: Select the first option of an input select entity + name: First + description: Select the first option of an input select entity. target: select_last: - description: Select the last option of an input select entity + name: Last + description: Select the last option of an input select entity. target: set_options: - description: Set the options of an input select entity + name: Set options + description: Set the options of an input select entity. target: fields: options: @@ -55,4 +61,5 @@ set_options: object: reload: + name: Reload description: Reload the input_select configuration. diff --git a/homeassistant/components/input_text/services.yaml b/homeassistant/components/input_text/services.yaml index b5ac97f837a..5983683ec6d 100644 --- a/homeassistant/components/input_text/services.yaml +++ b/homeassistant/components/input_text/services.yaml @@ -1,5 +1,6 @@ set_value: - description: Set the value of an input text entity + name: Set + description: Set the value of an input text entity. target: fields: value: @@ -11,4 +12,5 @@ set_value: text: reload: + name: Reload description: Reload the input_text configuration. diff --git a/homeassistant/components/light/services.yaml b/homeassistant/components/light/services.yaml index 4f5d74cbbbb..fe96f3a6777 100644 --- a/homeassistant/components/light/services.yaml +++ b/homeassistant/components/light/services.yaml @@ -1,7 +1,7 @@ # Describes the format for available light services turn_on: - name: Turn on lights + name: Turn on description: > Turn on one or more lights and adjust properties of the light, even when they are turned on already. @@ -314,7 +314,7 @@ turn_on: text: turn_off: - name: Turn off lights + name: Turn off description: Turns off one or more lights. target: fields: @@ -344,7 +344,7 @@ turn_off: - short toggle: - name: Toggle lights + name: Toggle description: > Toggles one or more lights, from on to off, or, off to on, based on their current state. diff --git a/homeassistant/components/lock/services.yaml b/homeassistant/components/lock/services.yaml index 22af0ab97cf..f5f6077ddc1 100644 --- a/homeassistant/components/lock/services.yaml +++ b/homeassistant/components/lock/services.yaml @@ -21,7 +21,8 @@ get_usercode: example: 1 lock: - description: Lock all or specified locks + name: Lock + description: Lock all or specified locks. target: fields: code: @@ -32,7 +33,8 @@ lock: text: open: - description: Open all or specified locks + name: Open + description: Open all or specified locks. target: fields: code: @@ -43,7 +45,8 @@ open: text: set_usercode: - description: Set a usercode to lock + name: Set usercode + description: Set a usercode to lock. fields: node_id: description: Node id of the lock. @@ -56,7 +59,8 @@ set_usercode: example: 1234 unlock: - description: Unlock all or specified locks + name: Unlock + description: Unlock all or specified locks. target: fields: code: diff --git a/homeassistant/components/logger/services.yaml b/homeassistant/components/logger/services.yaml index 4bd46b4b01e..39c0bcfdfe1 100644 --- a/homeassistant/components/logger/services.yaml +++ b/homeassistant/components/logger/services.yaml @@ -1,11 +1,10 @@ set_default_level: - description: Set the default log level for components + name: Set default level + description: Set the default log level for integrations. fields: level: name: Level - description: - "Default severity level. Possible values are debug, info, warn, warning, - error, fatal, critical" + description: Default severity level for all integrations. example: debug selector: select: @@ -18,26 +17,27 @@ set_default_level: - critical set_level: - description: Set log level for components + name: Set level + description: Set log level for integrations. fields: homeassistant.core: description: - "Example on how to change the logging level for a Home Assistant core - components. Possible values are debug, info, warn, warning, error, - fatal, critical" + "Example on how to change the logging level for a Home Assistant Core + integrations. Possible values are debug, info, warn, warning, error, + fatal, critical." example: debug homeassistant.components.mqtt: description: "Example on how to change the logging level for an Integration. Possible - values are debug, info, warn, warning, error, fatal, critical" + values are debug, info, warn, warning, error, fatal, critical." example: warning custom_components.my_integration: description: "Example on how to change the logging level for a Custom Integration. - Possible values are debug, info, warn, warning, error, fatal, critical" + Possible values are debug, info, warn, warning, error, fatal, critical." example: debug aiohttp: description: "Example on how to change the logging level for a Python module. - Possible values are debug, info, warn, warning, error, fatal, critical" + Possible values are debug, info, warn, warning, error, fatal, critical." example: error diff --git a/homeassistant/components/media_player/services.yaml b/homeassistant/components/media_player/services.yaml index f85e0658426..03084f0f1a1 100644 --- a/homeassistant/components/media_player/services.yaml +++ b/homeassistant/components/media_player/services.yaml @@ -1,27 +1,33 @@ # Describes the format for available media player services turn_on: - description: Turn a media player power on + name: Turn on + description: Turn a media player power on. target: turn_off: - description: Turn a media player power off + name: Turn off + description: Turn a media player power off. target: toggle: - description: Toggles a media player power state + name: Toggle + description: Toggles a media player power state. target: volume_up: - description: Turn a media player volume up + name: Turn up volume + description: Turn a media player volume up. target: volume_down: - description: Turn a media player volume down + name: Turn down volume + description: Turn a media player volume down. target: volume_mute: - description: Mute a media player's volume + name: Mute volume + description: Mute a media player's volume. target: fields: is_volume_muted: @@ -33,7 +39,8 @@ volume_mute: boolean: volume_set: - description: Set a media player's volume level + name: Set volume + description: Set a media player's volume level. target: fields: volume_level: @@ -49,32 +56,39 @@ volume_set: mode: slider media_play_pause: - description: Toggle media player play/pause state + name: Play/Pause + description: Toggle media player play/pause state. target: media_play: - description: Send the media player the command for play + name: Play + description: Send the media player the command for play. target: media_pause: - description: Send the media player the command for pause + name: Pause + description: Send the media player the command for pause. target: media_stop: - description: Send the media player the stop command + name: Stop + description: Send the media player the stop command. target: media_next_track: - description: Send the media player the command for next track + name: Next + description: Send the media player the command for next track. target: media_previous_track: - description: Send the media player the command for previous track + name: Previous + description: Send the media player the command for previous track. target: media_seek: + name: Seek description: - Send the media player the command to seek in current playing media + Send the media player the command to seek in current playing media. fields: seek_position: name: Position @@ -89,7 +103,8 @@ media_seek: mode: box play_media: - description: Send the media player the command for playing media + name: Play media + description: Send the media player the command for playing media. target: fields: media_content_id: @@ -111,7 +126,8 @@ play_media: text: select_source: - description: Send the media player the command to change input source + name: Select source + description: Send the media player the command to change input source. target: fields: source: @@ -123,7 +139,8 @@ select_source: text: select_sound_mode: - description: Send the media player the command to change sound mode + name: Select sound mode + description: Send the media player the command to change sound mode. target: fields: sound_mode: @@ -134,11 +151,13 @@ select_sound_mode: text: clear_playlist: - description: Send the media player the command to clear players playlist + name: Clear playlist + description: Send the media player the command to clear players playlist. target: shuffle_set: - description: Set shuffling state + name: Shuffle + description: Set shuffling state. target: fields: shuffle: @@ -150,6 +169,7 @@ shuffle_set: boolean: repeat_set: + name: Repeat description: Set repeat mode target: fields: diff --git a/homeassistant/components/mqtt/services.yaml b/homeassistant/components/mqtt/services.yaml index c6c3014362f..21d3915628a 100644 --- a/homeassistant/components/mqtt/services.yaml +++ b/homeassistant/components/mqtt/services.yaml @@ -1,7 +1,8 @@ # Describes the format for available MQTT services publish: - description: Publish a message to an MQTT topic + name: Publish + description: Publish a message to an MQTT topic. fields: topic: name: Topic @@ -49,9 +50,10 @@ publish: boolean: dump: + name: Dump description: - Dump messages on a topic selector to the 'mqtt_dump.txt' file in your config - folder + Dump messages on a topic selector to the 'mqtt_dump.txt' file in your + configuration folder. fields: topic: name: Topic @@ -73,4 +75,5 @@ dump: mode: slider reload: - description: Reload all MQTT entities from YAML + name: Reload + description: Reload all MQTT entities from YAML. diff --git a/homeassistant/components/netatmo/services.yaml b/homeassistant/components/netatmo/services.yaml index 7005d26c326..06f56d084c6 100644 --- a/homeassistant/components/netatmo/services.yaml +++ b/homeassistant/components/netatmo/services.yaml @@ -21,7 +21,9 @@ set_camera_light: set_schedule: name: Set heating schedule - description: Set the heating schedule for Netatmo climate device. The schedule name must match a schedule configured at Netatmo. + description: + Set the heating schedule for Netatmo climate device. The schedule name must + match a schedule configured at Netatmo. target: entity: integration: netatmo @@ -36,7 +38,9 @@ set_schedule: set_persons_home: name: Set persons at home - description: Set a list of persons as at home. Person's name must match a name known by the Netatmo Indoor (Welcome) Camera. + description: + Set a list of persons as at home. Person's name must match a name known by + the Netatmo Indoor (Welcome) Camera. target: entity: integration: netatmo @@ -51,7 +55,10 @@ set_persons_home: set_person_away: name: Set person away - description: Set a person as away. If no person is set the home will be marked as empty. Person's name must match a name known by the Netatmo Indoor (Welcome) Camera. + description: + Set a person as away. If no person is set the home will be marked as empty. + Person's name must match a name known by the Netatmo Indoor (Welcome) + Camera. target: entity: integration: netatmo diff --git a/homeassistant/components/number/services.yaml b/homeassistant/components/number/services.yaml index 4cb0cf09829..a684fef7d5d 100644 --- a/homeassistant/components/number/services.yaml +++ b/homeassistant/components/number/services.yaml @@ -1,7 +1,8 @@ # Describes the format for available Number entity services set_value: - description: Set the value of a Number entity + name: Set + description: Set the value of a Number entity. target: fields: value: diff --git a/homeassistant/components/recorder/services.yaml b/homeassistant/components/recorder/services.yaml index cad1925080f..e3dea47f4f8 100644 --- a/homeassistant/components/recorder/services.yaml +++ b/homeassistant/components/recorder/services.yaml @@ -1,7 +1,8 @@ # Describes the format for available recorder services purge: - description: Start purge task - to clean up old data from your database + name: Purge + description: Start purge task - to clean up old data from your database. fields: keep_days: name: Days to keep diff --git a/homeassistant/components/scene/services.yaml b/homeassistant/components/scene/services.yaml index dc9e9e07ab4..9d07460379c 100644 --- a/homeassistant/components/scene/services.yaml +++ b/homeassistant/components/scene/services.yaml @@ -1,7 +1,8 @@ # Describes the format for available scene services turn_on: - description: Activate a scene + name: Activate + description: Activate a scene. target: fields: transition: @@ -19,10 +20,12 @@ turn_on: mode: slider reload: - description: Reload the scene configuration + name: Reload + description: Reload the scene configuration. apply: - description: Activate a scene with configuration + name: Apply + description: Activate a scene with configuration. fields: entities: name: Entities state @@ -50,7 +53,8 @@ apply: mode: slider create: - description: Creates a new scene + name: Create + description: Creates a new scene. fields: scene_id: name: Scene entity ID diff --git a/homeassistant/components/shopping_list/services.yaml b/homeassistant/components/shopping_list/services.yaml index 961fb867aa7..2a1e89b9786 100644 --- a/homeassistant/components/shopping_list/services.yaml +++ b/homeassistant/components/shopping_list/services.yaml @@ -1,5 +1,6 @@ add_item: - description: Adds an item to the shopping list + name: Add item + description: Add an item to the shopping list. fields: name: name: Name @@ -10,7 +11,8 @@ add_item: text: complete_item: - description: Marks an item as completed in the shopping list. + name: Complete item + description: Mark an item as completed in the shopping list. fields: name: name: Name diff --git a/homeassistant/components/sonos/services.yaml b/homeassistant/components/sonos/services.yaml index 04a46940d6a..99b430e4680 100644 --- a/homeassistant/components/sonos/services.yaml +++ b/homeassistant/components/sonos/services.yaml @@ -1,8 +1,10 @@ join: + name: Join group description: Group player together. fields: master: - description: Entity ID of the player that should become the coordinator of the group. + description: + Entity ID of the player that should become the coordinator of the group. example: "media_player.living_room_sonos" selector: entity: @@ -17,6 +19,7 @@ join: domain: media_player unjoin: + name: Unjoin group description: Unjoin the player from a group. fields: entity_id: @@ -28,6 +31,7 @@ unjoin: domain: media_player snapshot: + name: Snapshot description: Take a snapshot of the media player. fields: entity_id: @@ -42,6 +46,7 @@ snapshot: example: "true" restore: + name: Restore description: Restore a snapshot of the media player. fields: entity_id: @@ -56,6 +61,7 @@ restore: example: "true" set_sleep_timer: + name: Set timer description: Set a Sonos timer. fields: entity_id: @@ -75,7 +81,9 @@ set_sleep_timer: step: 1 unit_of_measurement: seconds mode: slider + clear_sleep_timer: + name: Clear timer description: Clear a Sonos timer. fields: entity_id: @@ -87,6 +95,7 @@ clear_sleep_timer: domain: media_player set_option: + name: Set option description: Set Sonos sound options. fields: entity_id: @@ -113,7 +122,8 @@ set_option: boolean: play_queue: - description: Starts playing the queue from the first item. + name: Play queue + description: Start playing the queue from the first item. fields: entity_id: description: Name(s) of entities that will start playing. @@ -132,6 +142,7 @@ play_queue: mode: box remove_from_queue: + name: Remove from queue description: Removes an item from the queue. fields: entity_id: @@ -151,6 +162,7 @@ remove_from_queue: mode: box update_alarm: + name: Update alarm description: Updates an alarm with new time and volume settings. fields: alarm_id: diff --git a/homeassistant/components/system_log/services.yaml b/homeassistant/components/system_log/services.yaml index e07aea9c2a1..a762c31f205 100644 --- a/homeassistant/components/system_log/services.yaml +++ b/homeassistant/components/system_log/services.yaml @@ -1,8 +1,10 @@ clear: - description: Clear all log entries + name: Clear all + description: Clear all log entries. write: - description: Write log entry + name: Write + description: Write log entry. fields: message: name: Message diff --git a/homeassistant/components/timer/services.yaml b/homeassistant/components/timer/services.yaml index fcde11cd47f..54175de3cf7 100644 --- a/homeassistant/components/timer/services.yaml +++ b/homeassistant/components/timer/services.yaml @@ -1,6 +1,7 @@ # Describes the format for available timer services start: + name: Start description: Start a timer target: fields: @@ -12,13 +13,16 @@ start: text: pause: - description: Pause a timer + name: Pause + description: Pause a timer. target: cancel: - description: Cancel a timer + name: Cancel + description: Cancel a timer. target: finish: - description: Finish a timer + name: Finish + description: Finish a timer. target: diff --git a/homeassistant/components/toon/services.yaml b/homeassistant/components/toon/services.yaml index 3e06e6d3f9f..909018f820b 100644 --- a/homeassistant/components/toon/services.yaml +++ b/homeassistant/components/toon/services.yaml @@ -1,4 +1,5 @@ update: + name: Update description: Update all entities with fresh data from Toon fields: display: diff --git a/homeassistant/components/twentemilieu/services.yaml b/homeassistant/components/twentemilieu/services.yaml index 7a6a16f33ad..6227bad1b6d 100644 --- a/homeassistant/components/twentemilieu/services.yaml +++ b/homeassistant/components/twentemilieu/services.yaml @@ -1,4 +1,5 @@ update: + name: Update description: Update all entities with fresh data from Twente Milieu fields: id: diff --git a/homeassistant/components/vacuum/services.yaml b/homeassistant/components/vacuum/services.yaml index a60ce9ee658..e0064bc475b 100644 --- a/homeassistant/components/vacuum/services.yaml +++ b/homeassistant/components/vacuum/services.yaml @@ -1,43 +1,53 @@ # Describes the format for available vacuum services turn_on: - description: Start a new cleaning task + name: Turn on + description: Start a new cleaning task. target: turn_off: - description: Stop the current cleaning task and return to home + name: Turn off + description: Stop the current cleaning task and return to home. target: stop: - description: Stop the current cleaning task + name: Stop + description: Stop the current cleaning task. target: locate: - description: Locate the vacuum cleaner robot + name: Locate + description: Locate the vacuum cleaner robot. target: start_pause: - description: Start, pause, or resume the cleaning task + name: Start/Pause + description: Start, pause, or resume the cleaning task. target: start: - description: Start or resume the cleaning task + name: Start + description: Start or resume the cleaning task. target: pause: - description: Pause the cleaning task + name: Pause + description: Pause the cleaning task. target: return_to_base: - description: Tell the vacuum cleaner to return to its dock + name: Return to base + description: Tell the vacuum cleaner to return to its dock. target: clean_spot: - description: Tell the vacuum cleaner to do a spot clean-up + name: Clean spot + description: Tell the vacuum cleaner to do a spot clean-up. target: send_command: - description: Send a raw command to the vacuum cleaner + name: Send command + description: Send a raw command to the vacuum cleaner. target: fields: command: @@ -47,7 +57,6 @@ send_command: example: "set_dnd_timer" selector: text: - params: name: Parameters description: Parameters for the command. @@ -56,7 +65,8 @@ send_command: object: set_fan_speed: - description: Set the fan speed of the vacuum cleaner + name: Set fan speed + description: Set the fan speed of the vacuum cleaner. target: fields: fan_speed: diff --git a/homeassistant/components/vizio/services.yaml b/homeassistant/components/vizio/services.yaml index a2981fa32ad..7a2ea859b7d 100644 --- a/homeassistant/components/vizio/services.yaml +++ b/homeassistant/components/vizio/services.yaml @@ -1,5 +1,5 @@ update_setting: - name: Update a Vizio media player setting + name: Update setting description: Update the value of a setting on a Vizio media player device. target: entity: @@ -8,14 +8,18 @@ update_setting: fields: setting_type: name: Setting type - description: The type of setting to be changed. Available types are listed in the 'setting_types' property. + description: + The type of setting to be changed. Available types are listed in the + 'setting_types' property. required: true example: "audio" selector: text: setting_name: name: Setting name - description: The name of the setting to be changed. Available settings for a given setting_type are listed in the '_settings' property. + description: + The name of the setting to be changed. Available settings for a given + setting_type are listed in the '_settings' property. required: true example: "eq" selector: diff --git a/homeassistant/components/wled/services.yaml b/homeassistant/components/wled/services.yaml index 827e8b5fb36..d6927610a47 100644 --- a/homeassistant/components/wled/services.yaml +++ b/homeassistant/components/wled/services.yaml @@ -1,5 +1,6 @@ effect: - description: Controls the effect settings of WLED + name: Set effect + description: Control the effect settings of WLED. target: fields: effect: @@ -44,7 +45,8 @@ effect: boolean: preset: - description: Calls a preset on the WLED device + name: Set preset + description: Set a preset for the WLED device. target: fields: preset: