jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-23 13:17:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add service names to previously enriched services (#46929)

Browse Source 
Co-authored-by: Tobias Sauerwein <cgtobi@users.noreply.github.com>
This commit is contained in:
Franck Nijhof 2021-02-23 14:10:13 +01:00 committed by GitHub
parent 593e7aea5a
commit ea4bbd771f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
36 changed files with 308 additions and 151 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
homeassistant/components/alarm_control_panel/services.yaml
View File

@ -1,7 +1,8 @@
# Describes the format for available alarm control panel services # Describes the format for available alarm control panel services
alarm_disarm: alarm_disarm:
description: Send the alarm the command for disarm name: Disarm
description: Send the alarm the command for disarm.
target: target:
fields: fields:
code: code:
@ -12,7 +13,8 @@ alarm_disarm:
text: text:
alarm_arm_custom_bypass: alarm_arm_custom_bypass:
description: Send arm custom bypass command name: Arm with custom bypass
description: Send arm custom bypass command.
target: target:
fields: fields:
code: code:
@ -24,7 +26,8 @@ alarm_arm_custom_bypass:
text: text:
alarm_arm_home: 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: target:
fields: fields:
code: code:
@ -35,7 +38,8 @@ alarm_arm_home:
text: text:
alarm_arm_away: 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: target:
fields: fields:
code: code:
@ -46,7 +50,8 @@ alarm_arm_away:
text: text:
alarm_arm_night: 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: target:
fields: fields:
code: code:
@ -57,7 +62,8 @@ alarm_arm_night:
text: text:
alarm_trigger: alarm_trigger:
description: Send the alarm the command for trigger name: Trigger
description: Send the alarm the command for trigger.
target: target:
fields: fields:
code: code:

9
homeassistant/components/alert/services.yaml
View File

@ -1,11 +1,14 @@
toggle: toggle:
description: Toggle alert's notifications name: Toggle
description: Toggle alert's notifications.
target: target:
turn_off: turn_off:
description: Silence alert's notifications name: Turn off
description: Silence alert's notifications.
target: target:
turn_on: turn_on:
description: Reset alert's notifications name: Turn on
description: Reset alert's notifications.
target: target:

15
homeassistant/components/automation/services.yaml
View File

@ -1,10 +1,12 @@
# Describes the format for available automation services # Describes the format for available automation services
turn_on: turn_on:
description: Enable an automation name: Turn on
description: Enable an automation.
target: target:
turn_off: turn_off:
description: Disable an automation name: Turn off
description: Disable an automation.
target: target:
fields: fields:
stop_actions: stop_actions:
@ -16,11 +18,13 @@ turn_off:
boolean: boolean:
toggle: toggle:
description: Toggle (enable / disable) an automation name: Toggle
description: Toggle (enable / disable) an automation.
target: target:
trigger: trigger:
description: Trigger the actions of an automation name: Trigger
description: Trigger the actions of an automation.
target: target:
fields: fields:
skip_condition: skip_condition:
@ -32,4 +36,5 @@ trigger:
boolean: boolean:
reload: reload:
description: Reload the automation configuration name: Reload
description: Reload the automation configuration.

3
homeassistant/components/browser/services.yaml
View File

@ -1,6 +1,7 @@
browse_url: browse_url:
name: Browse
description: 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: fields:
url: url:
name: URL name: URL

21
homeassistant/components/camera/services.yaml
View File

@ -1,23 +1,28 @@
# Describes the format for available camera services # Describes the format for available camera services
turn_off: turn_off:
description: Turn off camera name: Turn off
description: Turn off camera.
target: target:
turn_on: turn_on:
description: Turn on camera name: Turn on
description: Turn on camera.
target: target:
enable_motion_detection: enable_motion_detection:
description: Enable the motion detection in a camera name: Enable motion detection
description: Enable the motion detection in a camera.
target: target:
disable_motion_detection: disable_motion_detection:
description: Disable the motion detection in a camera name: Disable motion detection
description: Disable the motion detection in a camera.
target: target:
snapshot: snapshot:
description: Take a snapshot from a camera name: Take snapshot
description: Take a snapshot from a camera.
target: target:
fields: fields:
filename: filename:
@ -29,7 +34,8 @@ snapshot:
text: text:
play_stream: play_stream:
description: Play camera stream on supported media player name: Play stream
description: Play camera stream on supported media player.
target: target:
fields: fields:
media_player: media_player:
@ -51,7 +57,8 @@ play_stream:
- "hls" - "hls"
record: record:
description: Record live camera feed name: Record
description: Record live camera feed.
target: target:
fields: fields:
filename: filename:

27
homeassistant/components/climate/services.yaml
View File

@ -1,7 +1,8 @@
# Describes the format for available climate services # Describes the format for available climate services
set_aux_heat: 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: target:
fields: fields:
aux_heat: aux_heat:
@ -13,7 +14,8 @@ set_aux_heat:
boolean: boolean:
set_preset_mode: set_preset_mode:
description: Set preset mode for climate device name: Set preset mode
description: Set preset mode for climate device.
target: target:
fields: fields:
preset_mode: preset_mode:
@ -25,7 +27,8 @@ set_preset_mode:
text: text:
set_temperature: set_temperature:
description: Set target temperature of climate device name: Set temperature
description: Set target temperature of climate device.
target: target:
fields: fields:
temperature: temperature:
@ -76,7 +79,8 @@ set_temperature:
- "heat" - "heat"
set_humidity: set_humidity:
description: Set target humidity of climate device name: Set target humidity
description: Set target humidity of climate device.
target: target:
fields: fields:
humidity: humidity:
@ -93,7 +97,8 @@ set_humidity:
mode: slider mode: slider
set_fan_mode: set_fan_mode:
description: Set fan operation for climate device name: Set fan mode
description: Set fan operation for climate device.
target: target:
fields: fields:
fan_mode: fan_mode:
@ -105,7 +110,8 @@ set_fan_mode:
text: text:
set_hvac_mode: set_hvac_mode:
description: Set HVAC operation mode for climate device name: Set HVAC mode
description: Set HVAC operation mode for climate device.
target: target:
fields: fields:
hvac_mode: hvac_mode:
@ -124,7 +130,8 @@ set_hvac_mode:
- "heat" - "heat"
set_swing_mode: set_swing_mode:
description: Set swing operation for climate device name: Set swing mode
description: Set swing operation for climate device.
target: target:
fields: fields:
swing_mode: swing_mode:
@ -136,9 +143,11 @@ set_swing_mode:
text: text:
turn_on: turn_on:
description: Turn climate device on name: Turn on
description: Turn climate device on.
target: target:
turn_off: turn_off:
description: Turn climate device off name: Turn off
description: Turn climate device off.
target: target:

3
homeassistant/components/color_extractor/services.yaml
View File

@ -1,7 +1,8 @@
turn_on: turn_on:
name: Turn on
description: description:
Set the light RGB to the predominant color found in the image provided by Set the light RGB to the predominant color found in the image provided by
URL or file path URL or file path.
target: target:
fields: fields:
color_extract_url: color_extract_url:

3
homeassistant/components/conversation/services.yaml
View File

@ -1,6 +1,7 @@
# Describes the format for available component services # Describes the format for available component services
process: process:
description: Launch a conversation from a transcribed text name: Process
description: Launch a conversation from a transcribed text.
fields: fields:
text: text:
name: Text name: Text

12
homeassistant/components/counter/services.yaml
View File

@ -1,19 +1,23 @@
# Describes the format for available counter services # Describes the format for available counter services
decrement: decrement:
description: Decrement a counter name: Decrement
description: Decrement a counter.
target: target:
increment: increment:
description: Increment a counter name: Increment
description: Increment a counter.
target: target:
reset: reset:
description: Reset a counter name: Reset
description: Reset a counter.
target: target:
configure: configure:
description: Change counter parameters name: Configure
description: Change counter parameters.
target: target:
fields: fields:
minimum: minimum:

30
homeassistant/components/cover/services.yaml
View File

@ -1,19 +1,23 @@
# Describes the format for available cover services # Describes the format for available cover services
open_cover: open_cover:
description: Open all or specified cover name: Open
description: Open all or specified cover.
target: target:
close_cover: close_cover:
description: Close all or specified cover name: Close
description: Close all or specified cover.
target: target:
toggle: toggle:
description: Toggles a cover open/closed name: Toggle
description: Toggle a cover open/closed.
target: target:
set_cover_position: 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: target:
fields: fields:
position: position:
@ -30,23 +34,28 @@ set_cover_position:
mode: slider mode: slider
stop_cover: stop_cover:
description: Stop all or specified cover name: Stop
description: Stop all or specified cover.
target: target:
open_cover_tilt: open_cover_tilt:
description: Open all or specified cover tilt name: Open tilt
description: Open all or specified cover tilt.
target: target:
close_cover_tilt: close_cover_tilt:
description: Close all or specified cover tilt name: Close tilt
description: Close all or specified cover tilt.
target: target:
toggle_cover_tilt: toggle_cover_tilt:
description: Toggle a cover tilt open/closed name: Toggle tilt
description: Toggle a cover tilt open/closed.
target: target:
set_cover_tilt_position: 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: target:
fields: fields:
tilt_position: tilt_position:
@ -63,5 +72,6 @@ set_cover_tilt_position:
mode: slider mode: slider
stop_cover_tilt: stop_cover_tilt:
description: Stop all or specified cover name: Stop tilt
description: Stop all or specified cover.
target: target:

3
homeassistant/components/downloader/services.yaml
View File

@ -1,5 +1,6 @@
download_file: download_file:
description: Downloads a file to the download location name: Download file
description: Download a file to the download location.
fields: fields:
url: url:
name: URL name: URL

30
homeassistant/components/fan/services.yaml
View File

@ -1,6 +1,7 @@
# Describes the format for available fan services # Describes the format for available fan services
set_speed: set_speed:
description: Set fan speed name: Set speed
description: Set fan speed.
target: target:
fields: fields:
speed: speed:
@ -12,7 +13,8 @@ set_speed:
text: text:
set_preset_mode: set_preset_mode:
description: Set preset mode for a fan device name: Set preset mode
description: Set preset mode for a fan device.
target: target:
fields: fields:
preset_mode: preset_mode:
@ -24,7 +26,8 @@ set_preset_mode:
text: text:
set_percentage: set_percentage:
description: Set fan speed percentage name: Set speed percentage
description: Set fan speed percentage.
target: target:
fields: fields:
percentage: percentage:
@ -41,7 +44,8 @@ set_percentage:
mode: slider mode: slider
turn_on: turn_on:
description: Turn fan on name: Turn on
description: Turn fan on.
target: target:
fields: fields:
speed: speed:
@ -67,11 +71,13 @@ turn_on:
text: text:
turn_off: turn_off:
description: Turn fan off name: Turn off
description: Turn fan off.
target: target:
oscillate: oscillate:
description: Oscillate the fan name: Oscillate
description: Oscillate the fan.
target: target:
fields: fields:
oscillating: oscillating:
@ -83,11 +89,13 @@ oscillate:
boolean: boolean:
toggle: toggle:
description: Toggle the fan on/off name: Toggle
description: Toggle the fan on/off.
target: target:
set_direction: set_direction:
description: Set the fan rotation name: Set direction
description: Set the fan rotation.
target: target:
fields: fields:
direction: direction:
@ -102,6 +110,7 @@ set_direction:
- "reverse" - "reverse"
increase_speed: increase_speed:
name: Increase speed
description: Increase the speed of the fan by one speed or a percentage_step. description: Increase the speed of the fan by one speed or a percentage_step.
fields: fields:
entity_id: entity_id:
@ -110,7 +119,7 @@ increase_speed:
percentage_step: percentage_step:
advanced: true advanced: true
required: false required: false
description: Increase speed by a percentage. Should be between 0..100. [optional] description: Increase speed by a percentage.
example: 50 example: 50
selector: selector:
number: number:
@ -121,6 +130,7 @@ increase_speed:
mode: slider mode: slider
decrease_speed: decrease_speed:
name: Decrease speed
description: Decrease the speed of the fan by one speed or a percentage_step. description: Decrease the speed of the fan by one speed or a percentage_step.
fields: fields:
entity_id: entity_id:
@ -129,7 +139,7 @@ decrease_speed:
percentage_step: percentage_step:
advanced: true advanced: true
required: false required: false
description: Decrease speed by a percentage. Should be between 0..100. [optional] description: Decrease speed by a percentage.
example: 50 example: 50
selector: selector:
number: number:

12
homeassistant/components/homeassistant/services.yaml
View File

@ -1,16 +1,20 @@
check_config: check_config:
name: Check configuration
description: description:
Check the Home Assistant configuration files for errors. Errors will be 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: reload_core_config:
description: Reload the core configuration name: Reload core configuration
description: Reload the core configuration.
restart: restart:
description: Restart the Home Assistant service name: Restart
description: Restart the Home Assistant service.
set_location: set_location:
description: Update the Home Assistant location name: Set location
description: Update the Home Assistant location.
fields: fields:
latitude: latitude:
name: Latitude name: Latitude

3
homeassistant/components/hue/services.yaml
View File

@ -1,7 +1,8 @@
# Describes the format for available hue services # Describes the format for available hue services
hue_activate_scene: 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: fields:
group_name: group_name:
name: Group name: Group

6
homeassistant/components/input_datetime/services.yaml
View File

@ -1,5 +1,6 @@
set_datetime: 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: target:
fields: fields:
date: date:
@ -33,4 +34,5 @@ set_datetime:
mode: box mode: box
reload: reload:
description: Reload the input_datetime configuration name: Reload
description: Reload the input_datetime configuration.

11
homeassistant/components/input_number/services.yaml
View File

@ -1,13 +1,16 @@
decrement: 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: target:
increment: 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: target:
set_value: set_value:
description: Set the value of an input number entity name: Set
description: Set the value of an input number entity.
target: target:
fields: fields:
value: value:
@ -21,5 +24,7 @@ set_value:
max: 9223372036854775807 max: 9223372036854775807
step: 0.001 step: 0.001
mode: box mode: box
reload: reload:
name: Reload
description: Reload the input_number configuration. description: Reload the input_number configuration.

19
homeassistant/components/input_select/services.yaml
View File

@ -1,5 +1,6 @@
select_next: 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: target:
fields: fields:
cycle: cycle:
@ -11,7 +12,8 @@ select_next:
boolean: boolean:
select_option: select_option:
description: Select an option of an input select entity name: Select
description: Select an option of an input select entity.
target: target:
fields: fields:
option: option:
@ -23,7 +25,8 @@ select_option:
text: text:
select_previous: 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: target:
fields: fields:
cycle: cycle:
@ -35,15 +38,18 @@ select_previous:
boolean: boolean:
select_first: 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: target:
select_last: 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: target:
set_options: set_options:
description: Set the options of an input select entity name: Set options
description: Set the options of an input select entity.
target: target:
fields: fields:
options: options:
@ -55,4 +61,5 @@ set_options:
object: object:
reload: reload:
name: Reload
description: Reload the input_select configuration. description: Reload the input_select configuration.

4
homeassistant/components/input_text/services.yaml
View File

@ -1,5 +1,6 @@
set_value: set_value:
description: Set the value of an input text entity name: Set
description: Set the value of an input text entity.
target: target:
fields: fields:
value: value:
@ -11,4 +12,5 @@ set_value:
text: text:
reload: reload:
name: Reload
description: Reload the input_text configuration. description: Reload the input_text configuration.

6
homeassistant/components/light/services.yaml
View File

@ -1,7 +1,7 @@
# Describes the format for available light services # Describes the format for available light services
turn_on: turn_on:
name: Turn on lights name: Turn on
description: > description: >
Turn on one or more lights and adjust properties of the light, even when Turn on one or more lights and adjust properties of the light, even when
they are turned on already. they are turned on already.
@ -314,7 +314,7 @@ turn_on:
text: text:
turn_off: turn_off:
name: Turn off lights name: Turn off
description: Turns off one or more lights. description: Turns off one or more lights.
target: target:
fields: fields:
@ -344,7 +344,7 @@ turn_off:
- short - short
toggle: toggle:
name: Toggle lights name: Toggle
description: > description: >
Toggles one or more lights, from on to off, or, off to on, based on their Toggles one or more lights, from on to off, or, off to on, based on their
current state. current state.

12
homeassistant/components/lock/services.yaml
View File

@ -21,7 +21,8 @@ get_usercode:
example: 1 example: 1
lock: lock:
description: Lock all or specified locks name: Lock
description: Lock all or specified locks.
target: target:
fields: fields:
code: code:
@ -32,7 +33,8 @@ lock:
text: text:
open: open:
description: Open all or specified locks name: Open
description: Open all or specified locks.
target: target:
fields: fields:
code: code:
@ -43,7 +45,8 @@ open:
text: text:
set_usercode: set_usercode:
description: Set a usercode to lock name: Set usercode
description: Set a usercode to lock.
fields: fields:
node_id: node_id:
description: Node id of the lock. description: Node id of the lock.
@ -56,7 +59,8 @@ set_usercode:
example: 1234 example: 1234
unlock: unlock:
description: Unlock all or specified locks name: Unlock
description: Unlock all or specified locks.
target: target:
fields: fields:
code: code:

22
homeassistant/components/logger/services.yaml
View File

@ -1,11 +1,10 @@
set_default_level: set_default_level:
description: Set the default log level for components name: Set default level
description: Set the default log level for integrations.
fields: fields:
level: level:
name: Level name: Level
description: description: Default severity level for all integrations.
"Default severity level. Possible values are debug, info, warn, warning,
error, fatal, critical"
example: debug example: debug
selector: selector:
select: select:
@ -18,26 +17,27 @@ set_default_level:
- critical - critical
set_level: set_level:
description: Set log level for components name: Set level
description: Set log level for integrations.
fields: fields:
homeassistant.core: homeassistant.core:
description: description:
"Example on how to change the logging level for a Home Assistant core "Example on how to change the logging level for a Home Assistant Core
components. Possible values are debug, info, warn, warning, error, integrations. Possible values are debug, info, warn, warning, error,
fatal, critical" fatal, critical."
example: debug example: debug
homeassistant.components.mqtt: homeassistant.components.mqtt:
description: description:
"Example on how to change the logging level for an Integration. Possible "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 example: warning
custom_components.my_integration: custom_components.my_integration:
description: description:
"Example on how to change the logging level for a Custom Integration. "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 example: debug
aiohttp: aiohttp:
description: description:
"Example on how to change the logging level for a Python module. "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 example: error

58
homeassistant/components/media_player/services.yaml
View File

@ -1,27 +1,33 @@
# Describes the format for available media player services # Describes the format for available media player services
turn_on: turn_on:
description: Turn a media player power on name: Turn on
description: Turn a media player power on.
target: target:
turn_off: turn_off:
description: Turn a media player power off name: Turn off
description: Turn a media player power off.
target: target:
toggle: toggle:
description: Toggles a media player power state name: Toggle
description: Toggles a media player power state.
target: target:
volume_up: volume_up:
description: Turn a media player volume up name: Turn up volume
description: Turn a media player volume up.
target: target:
volume_down: volume_down:
description: Turn a media player volume down name: Turn down volume
description: Turn a media player volume down.
target: target:
volume_mute: volume_mute:
description: Mute a media player's volume name: Mute volume
description: Mute a media player's volume.
target: target:
fields: fields:
is_volume_muted: is_volume_muted:
@ -33,7 +39,8 @@ volume_mute:
boolean: boolean:
volume_set: volume_set:
description: Set a media player's volume level name: Set volume
description: Set a media player's volume level.
target: target:
fields: fields:
volume_level: volume_level:
@ -49,32 +56,39 @@ volume_set:
mode: slider mode: slider
media_play_pause: media_play_pause:
description: Toggle media player play/pause state name: Play/Pause
description: Toggle media player play/pause state.
target: target:
media_play: media_play:
description: Send the media player the command for play name: Play
description: Send the media player the command for play.
target: target:
media_pause: media_pause:
description: Send the media player the command for pause name: Pause
description: Send the media player the command for pause.
target: target:
media_stop: media_stop:
description: Send the media player the stop command name: Stop
description: Send the media player the stop command.
target: target:
media_next_track: 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: target:
media_previous_track: 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: target:
media_seek: media_seek:
name: Seek
description: 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: fields:
seek_position: seek_position:
name: Position name: Position
@ -89,7 +103,8 @@ media_seek:
mode: box mode: box
play_media: 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: target:
fields: fields:
media_content_id: media_content_id:
@ -111,7 +126,8 @@ play_media:
text: text:
select_source: 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: target:
fields: fields:
source: source:
@ -123,7 +139,8 @@ select_source:
text: text:
select_sound_mode: 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: target:
fields: fields:
sound_mode: sound_mode:
@ -134,11 +151,13 @@ select_sound_mode:
text: text:
clear_playlist: 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: target:
shuffle_set: shuffle_set:
description: Set shuffling state name: Shuffle
description: Set shuffling state.
target: target:
fields: fields:
shuffle: shuffle:
@ -150,6 +169,7 @@ shuffle_set:
boolean: boolean:
repeat_set: repeat_set:
name: Repeat
description: Set repeat mode description: Set repeat mode
target: target:
fields: fields:

11
homeassistant/components/mqtt/services.yaml
View File

@ -1,7 +1,8 @@
# Describes the format for available MQTT services # Describes the format for available MQTT services
publish: publish:
description: Publish a message to an MQTT topic name: Publish
description: Publish a message to an MQTT topic.
fields: fields:
topic: topic:
name: Topic name: Topic
@ -49,9 +50,10 @@ publish:
boolean: boolean:
dump: dump:
name: Dump
description: description:
Dump messages on a topic selector to the 'mqtt_dump.txt' file in your config Dump messages on a topic selector to the 'mqtt_dump.txt' file in your
folder configuration folder.
fields: fields:
topic: topic:
name: Topic name: Topic
@ -73,4 +75,5 @@ dump:
mode: slider mode: slider
reload: reload:
description: Reload all MQTT entities from YAML name: Reload
description: Reload all MQTT entities from YAML.

13
homeassistant/components/netatmo/services.yaml
View File

@ -21,7 +21,9 @@ set_camera_light:
set_schedule: set_schedule:
name: Set heating 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: target:
entity: entity:
integration: netatmo integration: netatmo
@ -36,7 +38,9 @@ set_schedule:
set_persons_home: set_persons_home:
name: Set persons at 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: target:
entity: entity:
integration: netatmo integration: netatmo
@ -51,7 +55,10 @@ set_persons_home:
set_person_away: set_person_away:
name: 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: target:
entity: entity:
integration: netatmo integration: netatmo

3
homeassistant/components/number/services.yaml
View File

@ -1,7 +1,8 @@
# Describes the format for available Number entity services # Describes the format for available Number entity services
set_value: set_value:
description: Set the value of a Number entity name: Set
description: Set the value of a Number entity.
target: target:
fields: fields:
value: value:

3
homeassistant/components/recorder/services.yaml
View File

@ -1,7 +1,8 @@
# Describes the format for available recorder services # Describes the format for available recorder services
purge: 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: fields:
keep_days: keep_days:
name: Days to keep name: Days to keep

12
homeassistant/components/scene/services.yaml
View File

@ -1,7 +1,8 @@
# Describes the format for available scene services # Describes the format for available scene services
turn_on: turn_on:
description: Activate a scene name: Activate
description: Activate a scene.
target: target:
fields: fields:
transition: transition:
@ -19,10 +20,12 @@ turn_on:
mode: slider mode: slider
reload: reload:
description: Reload the scene configuration name: Reload
description: Reload the scene configuration.
apply: apply:
description: Activate a scene with configuration name: Apply
description: Activate a scene with configuration.
fields: fields:
entities: entities:
name: Entities state name: Entities state
@ -50,7 +53,8 @@ apply:
mode: slider mode: slider
create: create:
description: Creates a new scene name: Create
description: Creates a new scene.
fields: fields:
scene_id: scene_id:
name: Scene entity ID name: Scene entity ID

6
homeassistant/components/shopping_list/services.yaml
View File

@ -1,5 +1,6 @@
add_item: add_item:
description: Adds an item to the shopping list name: Add item
description: Add an item to the shopping list.
fields: fields:
name: name:
name: Name name: Name
@ -10,7 +11,8 @@ add_item:
text: text:
complete_item: 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: fields:
name: name:
name: Name name: Name

16
homeassistant/components/sonos/services.yaml
View File

@ -1,8 +1,10 @@
join: join:
name: Join group
description: Group player together. description: Group player together.
fields: fields:
master: 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" example: "media_player.living_room_sonos"
selector: selector:
entity: entity:
@ -17,6 +19,7 @@ join:
domain: media_player domain: media_player
unjoin: unjoin:
name: Unjoin group
description: Unjoin the player from a group. description: Unjoin the player from a group.
fields: fields:
entity_id: entity_id:
@ -28,6 +31,7 @@ unjoin:
domain: media_player domain: media_player
snapshot: snapshot:
name: Snapshot
description: Take a snapshot of the media player. description: Take a snapshot of the media player.
fields: fields:
entity_id: entity_id:
@ -42,6 +46,7 @@ snapshot:
example: "true" example: "true"
restore: restore:
name: Restore
description: Restore a snapshot of the media player. description: Restore a snapshot of the media player.
fields: fields:
entity_id: entity_id:
@ -56,6 +61,7 @@ restore:
example: "true" example: "true"
set_sleep_timer: set_sleep_timer:
name: Set timer
description: Set a Sonos timer. description: Set a Sonos timer.
fields: fields:
entity_id: entity_id:
@ -75,7 +81,9 @@ set_sleep_timer:
step: 1 step: 1
unit_of_measurement: seconds unit_of_measurement: seconds
mode: slider mode: slider
clear_sleep_timer: clear_sleep_timer:
name: Clear timer
description: Clear a Sonos timer. description: Clear a Sonos timer.
fields: fields:
entity_id: entity_id:
@ -87,6 +95,7 @@ clear_sleep_timer:
domain: media_player domain: media_player
set_option: set_option:
name: Set option
description: Set Sonos sound options. description: Set Sonos sound options.
fields: fields:
entity_id: entity_id:
@ -113,7 +122,8 @@ set_option:
boolean: boolean:
play_queue: play_queue:
description: Starts playing the queue from the first item. name: Play queue
description: Start playing the queue from the first item.
fields: fields:
entity_id: entity_id:
description: Name(s) of entities that will start playing. description: Name(s) of entities that will start playing.
@ -132,6 +142,7 @@ play_queue:
mode: box mode: box
remove_from_queue: remove_from_queue:
name: Remove from queue
description: Removes an item from the queue. description: Removes an item from the queue.
fields: fields:
entity_id: entity_id:
@ -151,6 +162,7 @@ remove_from_queue:
mode: box mode: box
update_alarm: update_alarm:
name: Update alarm
description: Updates an alarm with new time and volume settings. description: Updates an alarm with new time and volume settings.
fields: fields:
alarm_id: alarm_id:

6
homeassistant/components/system_log/services.yaml
View File

@ -1,8 +1,10 @@
clear: clear:
description: Clear all log entries name: Clear all
description: Clear all log entries.
write: write:
description: Write log entry name: Write
description: Write log entry.
fields: fields:
message: message:
name: Message name: Message

10
homeassistant/components/timer/services.yaml
View File

@ -1,6 +1,7 @@
# Describes the format for available timer services # Describes the format for available timer services
start: start:
name: Start
description: Start a timer description: Start a timer
target: target:
fields: fields:
@ -12,13 +13,16 @@ start:
text: text:
pause: pause:
description: Pause a timer name: Pause
description: Pause a timer.
target: target:
cancel: cancel:
description: Cancel a timer name: Cancel
description: Cancel a timer.
target: target:
finish: finish:
description: Finish a timer name: Finish
description: Finish a timer.
target: target:

1
homeassistant/components/toon/services.yaml
View File

@ -1,4 +1,5 @@
update: update:
name: Update
description: Update all entities with fresh data from Toon description: Update all entities with fresh data from Toon
fields: fields:
display: display:

1
homeassistant/components/twentemilieu/services.yaml
View File

@ -1,4 +1,5 @@
update: update:
name: Update
description: Update all entities with fresh data from Twente Milieu description: Update all entities with fresh data from Twente Milieu
fields: fields:
id: id:

34
homeassistant/components/vacuum/services.yaml
View File

@ -1,43 +1,53 @@
# Describes the format for available vacuum services # Describes the format for available vacuum services
turn_on: turn_on:
description: Start a new cleaning task name: Turn on
description: Start a new cleaning task.
target: target:
turn_off: 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: target:
stop: stop:
description: Stop the current cleaning task name: Stop
description: Stop the current cleaning task.
target: target:
locate: locate:
description: Locate the vacuum cleaner robot name: Locate
description: Locate the vacuum cleaner robot.
target: target:
start_pause: start_pause:
description: Start, pause, or resume the cleaning task name: Start/Pause
description: Start, pause, or resume the cleaning task.
target: target:
start: start:
description: Start or resume the cleaning task name: Start
description: Start or resume the cleaning task.
target: target:
pause: pause:
description: Pause the cleaning task name: Pause
description: Pause the cleaning task.
target: target:
return_to_base: 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: target:
clean_spot: 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: target:
send_command: send_command:
description: Send a raw command to the vacuum cleaner name: Send command
description: Send a raw command to the vacuum cleaner.
target: target:
fields: fields:
command: command:
@ -47,7 +57,6 @@ send_command:
example: "set_dnd_timer" example: "set_dnd_timer"
selector: selector:
text: text:
params: params:
name: Parameters name: Parameters
description: Parameters for the command. description: Parameters for the command.
@ -56,7 +65,8 @@ send_command:
object: object:
set_fan_speed: 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: target:
fields: fields:
fan_speed: fan_speed:

10
homeassistant/components/vizio/services.yaml
View File

@ -1,5 +1,5 @@
update_setting: 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. description: Update the value of a setting on a Vizio media player device.
target: target:
entity: entity:
@ -8,14 +8,18 @@ update_setting:
fields: fields:
setting_type: setting_type:
name: 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 required: true
example: "audio" example: "audio"
selector: selector:
text: text:
setting_name: setting_name:
name: 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 '<setting_type>_settings' property. description:
The name of the setting to be changed. Available settings for a given
setting_type are listed in the '<setting_type>_settings' property.
required: true required: true
example: "eq" example: "eq"
selector: selector:

6
homeassistant/components/wled/services.yaml
View File

@ -1,5 +1,6 @@
effect: effect:
description: Controls the effect settings of WLED name: Set effect
description: Control the effect settings of WLED.
target: target:
fields: fields:
effect: effect:
@ -44,7 +45,8 @@ effect:
boolean: boolean:
preset: preset:
description: Calls a preset on the WLED device name: Set preset
description: Set a preset for the WLED device.
target: target:
fields: fields:
preset: preset: