Extend targets for entity component services (#50760)

This commit is contained in:
Franck Nijhof 2021-05-17 14:06:50 +02:00 committed by GitHub
parent ee4e14e45e
commit eccefd154a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
27 changed files with 276 additions and 16 deletions

View File

@ -4,6 +4,8 @@ alarm_disarm:
name: Disarm
description: Send the alarm the command for disarm.
target:
entity:
domain: alarm_control_panel
fields:
code:
name: Code
@ -16,11 +18,12 @@ alarm_arm_custom_bypass:
name: Arm with custom bypass
description: Send arm custom bypass command.
target:
entity:
domain: alarm_control_panel
fields:
code:
name: Code
description:
An optional code to arm custom bypass the alarm control panel with.
description: An optional code to arm custom bypass the alarm control panel with.
example: "1234"
selector:
text:
@ -29,6 +32,8 @@ alarm_arm_home:
name: Arm home
description: Send the alarm the command for arm home.
target:
entity:
domain: alarm_control_panel
fields:
code:
name: Code
@ -41,6 +46,8 @@ alarm_arm_away:
name: Arm away
description: Send the alarm the command for arm away.
target:
entity:
domain: alarm_control_panel
fields:
code:
name: Code
@ -53,6 +60,8 @@ alarm_arm_night:
name: Arm night
description: Send the alarm the command for arm night.
target:
entity:
domain: alarm_control_panel
fields:
code:
name: Code
@ -65,6 +74,8 @@ alarm_trigger:
name: Trigger
description: Send the alarm the command for trigger.
target:
entity:
domain: alarm_control_panel
fields:
code:
name: Code

View File

@ -2,13 +2,19 @@ toggle:
name: Toggle
description: Toggle alert's notifications.
target:
entity:
domain: alert
turn_off:
name: Turn off
description: Silence alert's notifications.
target:
entity:
domain: alert
turn_on:
name: Turn on
description: Reset alert's notifications.
target:
entity:
domain: alert

View File

@ -3,11 +3,15 @@ turn_on:
name: Turn on
description: Enable an automation.
target:
entity:
domain: automation
turn_off:
name: Turn off
description: Disable an automation.
target:
entity:
domain: automation
fields:
stop_actions:
name: Stop actions
@ -21,11 +25,15 @@ toggle:
name: Toggle
description: Toggle (enable / disable) an automation.
target:
entity:
domain: automation
trigger:
name: Trigger
description: Trigger the actions of an automation.
target:
entity:
domain: automation
fields:
skip_condition:
name: Skip conditions

View File

@ -4,26 +4,36 @@ turn_off:
name: Turn off
description: Turn off camera.
target:
entity:
domain: camera
turn_on:
name: Turn on
description: Turn on camera.
target:
entity:
domain: camera
enable_motion_detection:
name: Enable motion detection
description: Enable the motion detection in a camera.
target:
entity:
domain: camera
disable_motion_detection:
name: Disable motion detection
description: Disable the motion detection in a camera.
target:
entity:
domain: camera
snapshot:
name: Take snapshot
description: Take a snapshot from a camera.
target:
entity:
domain: camera
fields:
filename:
name: Filename
@ -37,6 +47,8 @@ play_stream:
name: Play stream
description: Play camera stream on supported media player.
target:
entity:
domain: camera
fields:
media_player:
name: Media Player
@ -60,6 +72,8 @@ record:
name: Record
description: Record live camera feed.
target:
entity:
domain: camera
fields:
filename:
name: Filename

View File

@ -4,6 +4,8 @@ set_aux_heat:
name: Turn on/off auxiliary heater
description: Turn auxiliary heater on/off for climate device.
target:
entity:
domain: climate
fields:
aux_heat:
name: Auxiliary heating
@ -17,6 +19,8 @@ set_preset_mode:
name: Set preset mode
description: Set preset mode for climate device.
target:
entity:
domain: climate
fields:
preset_mode:
name: Preset mode
@ -30,6 +34,8 @@ set_temperature:
name: Set temperature
description: Set target temperature of climate device.
target:
entity:
domain: climate
fields:
temperature:
name: Temperature
@ -82,6 +88,8 @@ set_humidity:
name: Set target humidity
description: Set target humidity of climate device.
target:
entity:
domain: climate
fields:
humidity:
name: Humidity
@ -100,6 +108,8 @@ set_fan_mode:
name: Set fan mode
description: Set fan operation for climate device.
target:
entity:
domain: climate
fields:
fan_mode:
name: Fan mode
@ -113,6 +123,8 @@ set_hvac_mode:
name: Set HVAC mode
description: Set HVAC operation mode for climate device.
target:
entity:
domain: climate
fields:
hvac_mode:
name: HVAC mode
@ -133,6 +145,8 @@ set_swing_mode:
name: Set swing mode
description: Set swing operation for climate device.
target:
entity:
domain: climate
fields:
swing_mode:
name: Swing mode
@ -146,8 +160,12 @@ turn_on:
name: Turn on
description: Turn climate device on.
target:
entity:
domain: climate
turn_off:
name: Turn off
description: Turn climate device off.
target:
entity:
domain: climate

View File

@ -4,6 +4,8 @@ turn_on:
Set the light RGB to the predominant color found in the image provided by
URL or file path.
target:
entity:
domain: light
fields:
color_extract_url:
name: URL

View File

@ -4,21 +4,29 @@ decrement:
name: Decrement
description: Decrement a counter.
target:
entity:
domain: counter
increment:
name: Increment
description: Increment a counter.
target:
entity:
domain: counter
reset:
name: Reset
description: Reset a counter.
target:
entity:
domain: counter
configure:
name: Configure
description: Change counter parameters.
target:
entity:
domain: counter
fields:
minimum:
name: Minimum

View File

@ -4,21 +4,29 @@ open_cover:
name: Open
description: Open all or specified cover.
target:
entity:
domain: cover
close_cover:
name: Close
description: Close all or specified cover.
target:
entity:
domain: cover
toggle:
name: Toggle
description: Toggle a cover open/closed.
target:
entity:
domain: cover
set_cover_position:
name: Set position
description: Move to specific position all or specified cover.
target:
entity:
domain: cover
fields:
position:
name: Position
@ -37,26 +45,36 @@ stop_cover:
name: Stop
description: Stop all or specified cover.
target:
entity:
domain: cover
open_cover_tilt:
name: Open tilt
description: Open all or specified cover tilt.
target:
entity:
domain: cover
close_cover_tilt:
name: Close tilt
description: Close all or specified cover tilt.
target:
entity:
domain: cover
toggle_cover_tilt:
name: Toggle tilt
description: Toggle a cover tilt open/closed.
target:
entity:
domain: cover
set_cover_tilt_position:
name: Set tilt position
description: Move to specific position all or specified cover tilt.
target:
entity:
domain: cover
fields:
tilt_position:
name: Tilt position
@ -75,3 +93,5 @@ stop_cover_tilt:
name: Stop tilt
description: Stop all or specified cover.
target:
entity:
domain: cover

View File

@ -3,6 +3,8 @@ set_speed:
name: Set speed
description: Set fan speed.
target:
entity:
domain: fan
fields:
speed:
name: Speed
@ -16,6 +18,8 @@ set_preset_mode:
name: Set preset mode
description: Set preset mode for a fan device.
target:
entity:
domain: fan
fields:
preset_mode:
name: Preset mode
@ -29,6 +33,8 @@ set_percentage:
name: Set speed percentage
description: Set fan speed percentage.
target:
entity:
domain: fan
fields:
percentage:
name: Percentage
@ -47,6 +53,8 @@ turn_on:
name: Turn on
description: Turn fan on.
target:
entity:
domain: fan
fields:
speed:
name: Speed
@ -74,11 +82,15 @@ turn_off:
name: Turn off
description: Turn fan off.
target:
entity:
domain: fan
oscillate:
name: Oscillate
description: Oscillate the fan.
target:
entity:
domain: fan
fields:
oscillating:
name: Oscillating
@ -92,11 +104,15 @@ toggle:
name: Toggle
description: Toggle the fan on/off.
target:
entity:
domain: fan
set_direction:
name: Set direction
description: Set the fan rotation.
target:
entity:
domain: fan
fields:
direction:
name: Direction
@ -113,6 +129,8 @@ increase_speed:
name: Increase speed
description: Increase the speed of the fan by one speed or a percentage_step.
target:
entity:
domain: fan
fields:
percentage_step:
advanced: true
@ -131,6 +149,8 @@ decrease_speed:
name: Decrease speed
description: Decrease the speed of the fan by one speed or a percentage_step.
target:
entity:
domain: fan
fields:
percentage_step:
advanced: true

View File

@ -2,16 +2,22 @@ toggle:
name: Toggle
description: Toggle an input boolean
target:
entity:
domain: input_boolean
turn_off:
name: Turn off
description: Turn off an input boolean
target:
entity:
domain: input_boolean
turn_on:
name: Turn on
description: Turn on an input boolean
target:
entity:
domain: input_boolean
reload:
name: Reload

View File

@ -2,6 +2,8 @@ set_datetime:
name: Set
description: This can be used to dynamically set the date and/or time.
target:
entity:
domain: input_datetime
fields:
date:
name: Date

View File

@ -2,16 +2,22 @@ decrement:
name: Decrement
description: Decrement the value of an input number entity by its stepping.
target:
entity:
domain: input_number
increment:
name: Increment
description: Increment the value of an input number entity by its stepping.
target:
entity:
domain: input_number
set_value:
name: Set
description: Set the value of an input number entity.
target:
entity:
domain: input_number
fields:
value:
name: Value

View File

@ -2,6 +2,8 @@ select_next:
name: Next
description: Select the next options of an input select entity.
target:
entity:
domain: input_select
fields:
cycle:
name: Cycle
@ -15,6 +17,8 @@ select_option:
name: Select
description: Select an option of an input select entity.
target:
entity:
domain: input_select
fields:
option:
name: Option
@ -28,6 +32,8 @@ select_previous:
name: Previous
description: Select the previous options of an input select entity.
target:
entity:
domain: input_select
fields:
cycle:
name: Cycle
@ -41,16 +47,22 @@ select_first:
name: First
description: Select the first option of an input select entity.
target:
entity:
domain: input_select
select_last:
name: Last
description: Select the last option of an input select entity.
target:
entity:
domain: input_select
set_options:
name: Set options
description: Set the options of an input select entity.
target:
entity:
domain: input_select
fields:
options:
name: Options

View File

@ -2,6 +2,8 @@ set_value:
name: Set
description: Set the value of an input text entity.
target:
entity:
domain: input_text
fields:
value:
name: Value

View File

@ -6,6 +6,8 @@ turn_on:
Turn on one or more lights and adjust properties of the light, even when
they are turned on already.
target:
entity:
domain: light
fields:
transition:
name: Transition
@ -198,8 +200,7 @@ turn_on:
- "yellowgreen"
hs_color:
name: Hue/Sat color
description:
Color for the light in hue/sat format. Hue is 0-360 and Sat is 0-100.
description: Color for the light in hue/sat format. Hue is 0-360 and Sat is 0-100.
advanced: true
example: "[300, 70]"
selector:
@ -276,8 +277,7 @@ turn_on:
mode: slider
brightness_step_pct:
name: Brightness step
description:
Change brightness by a percentage. Should be between -100..100.
description: Change brightness by a percentage. Should be between -100..100.
example: -10
selector:
number:
@ -320,6 +320,8 @@ turn_off:
name: Turn off
description: Turns off one or more lights.
target:
entity:
domain: light
fields:
transition:
name: Transition
@ -352,6 +354,8 @@ toggle:
Toggles one or more lights, from on to off, or, off to on, based on their
current state.
target:
entity:
domain: light
fields:
transition:
name: Transition
@ -530,8 +534,7 @@ toggle:
- "yellowgreen"
hs_color:
name: Hue/Sat color
description:
Color for the light in hue/sat format. Hue is 0-360 and Sat is 0-100.
description: Color for the light in hue/sat format. Hue is 0-360 and Sat is 0-100.
advanced: true
example: "[300, 70]"
selector:
@ -580,8 +583,7 @@ toggle:
mode: slider
brightness:
name: Brightness value
description:
Number indicating brightness, where 0 turns the light
description: Number indicating brightness, where 0 turns the light
off, 1 is the minimum brightness and 255 is the maximum brightness
supported by the light.
advanced: true

View File

@ -4,11 +4,15 @@ reset_waste_drawer:
name: Reset waste drawer
description: Reset the waste drawer level.
target:
entity:
integration: litterrobot
set_sleep_mode:
name: Set sleep mode
description: Set the sleep mode and start time.
target:
entity:
integration: litterrobot
fields:
enabled:
name: Enabled
@ -29,6 +33,8 @@ set_wait_time:
name: Set wait time
description: Set the wait time, in minutes, between when your cat uses the Litter-Robot and when the unit cycles automatically.
target:
entity:
integration: litterrobot
fields:
minutes:
name: Minutes

View File

@ -46,6 +46,8 @@ lock:
name: Lock
description: Lock all or specified locks.
target:
entity:
domain: lock
fields:
code:
name: Code
@ -58,6 +60,8 @@ open:
name: Open
description: Open all or specified locks.
target:
entity:
domain: lock
fields:
code:
name: Code
@ -95,6 +99,8 @@ unlock:
name: Unlock
description: Unlock all or specified locks.
target:
entity:
domain: lock
fields:
code:
name: Code

View File

@ -4,31 +4,43 @@ turn_on:
name: Turn on
description: Turn a media player power on.
target:
entity:
domain: media_player
turn_off:
name: Turn off
description: Turn a media player power off.
target:
entity:
domain: media_player
toggle:
name: Toggle
description: Toggles a media player power state.
target:
entity:
domain: media_player
volume_up:
name: Turn up volume
description: Turn a media player volume up.
target:
entity:
domain: media_player
volume_down:
name: Turn down volume
description: Turn a media player volume down.
target:
entity:
domain: media_player
volume_mute:
name: Mute volume
description: Mute a media player's volume.
target:
entity:
domain: media_player
fields:
is_volume_muted:
name: Muted
@ -42,6 +54,8 @@ volume_set:
name: Set volume
description: Set a media player's volume level.
target:
entity:
domain: media_player
fields:
volume_level:
name: Level
@ -59,37 +73,50 @@ media_play_pause:
name: Play/Pause
description: Toggle media player play/pause state.
target:
entity:
domain: media_player
media_play:
name: Play
description: Send the media player the command for play.
target:
entity:
domain: media_player
media_pause:
name: Pause
description: Send the media player the command for pause.
target:
entity:
domain: media_player
media_stop:
name: Stop
description: Send the media player the stop command.
target:
entity:
domain: media_player
media_next_track:
name: Next
description: Send the media player the command for next track.
target:
entity:
domain: media_player
media_previous_track:
name: Previous
description: Send the media player the command for previous track.
target:
entity:
domain: media_player
media_seek:
name: Seek
description:
Send the media player the command to seek in current playing media.
description: Send the media player the command to seek in current playing media.
target:
entity:
domain: media_player
fields:
seek_position:
name: Position
@ -107,6 +134,8 @@ play_media:
name: Play media
description: Send the media player the command for playing media.
target:
entity:
domain: media_player
fields:
media_content_id:
name: Content ID
@ -130,6 +159,8 @@ select_source:
name: Select source
description: Send the media player the command to change input source.
target:
entity:
domain: media_player
fields:
source:
name: Source
@ -143,6 +174,8 @@ select_sound_mode:
name: Select sound mode
description: Send the media player the command to change sound mode.
target:
entity:
domain: media_player
fields:
sound_mode:
name: Sound mode
@ -155,11 +188,15 @@ clear_playlist:
name: Clear playlist
description: Send the media player the command to clear players playlist.
target:
entity:
domain: media_player
shuffle_set:
name: Shuffle
description: Set shuffling state.
target:
entity:
domain: media_player
fields:
shuffle:
name: Shuffle
@ -173,6 +210,8 @@ repeat_set:
name: Repeat
description: Set repeat mode
target:
entity:
domain: media_player
fields:
repeat:
name: Repeat mode
@ -192,11 +231,12 @@ join:
Group players together. Only works on platforms with support for player
groups.
target:
entity:
domain: media_player
fields:
group_members:
name: Group members
description:
The players which will be synced with the target player.
description: The players which will be synced with the target player.
example:
- "media_player.multiroom_player2"
- "media_player.multiroom_player3"
@ -209,3 +249,5 @@ unjoin:
player groups.
name: Unjoin
target:
entity:
domain: media_player

View File

@ -4,6 +4,8 @@ set_value:
name: Set
description: Set the value of a Number entity.
target:
entity:
domain: number
fields:
value:
name: Value

View File

@ -4,6 +4,8 @@ turn_on:
name: Turn On
description: Sends the Power On Command.
target:
entity:
domain: remote
fields:
activity:
description: Activity ID or Activity Name to start.
@ -15,16 +17,22 @@ toggle:
name: Toggle
description: Toggles a device.
target:
entity:
domain: remote
turn_off:
name: Turn Off
description: Sends the Power Off Command.
target:
entity:
domain: remote
send_command:
name: Send Command
description: Sends a command or a list of commands to a device.
target:
entity:
domain: remote
fields:
device:
name: Device
@ -75,6 +83,8 @@ learn_command:
name: Learn Command
description: Learns a command or a list of commands from a device.
target:
entity:
domain: remote
fields:
device:
description: Device ID to learn command from.
@ -116,6 +126,8 @@ delete_command:
name: Delete Command
description: Deletes a command or a list of commands from the database.
target:
entity:
domain: remote
fields:
device:
description: Name of the device from which commands will be deleted.

View File

@ -4,6 +4,8 @@ turn_on:
name: Activate
description: Activate a scene.
target:
entity:
domain: scene
fields:
transition:
name: Transition

View File

@ -8,13 +8,19 @@ turn_on:
name: Turn on
description: Turn on script
target:
entity:
domain: script
turn_off:
name: Turn off
description: Turn off script
target:
entity:
domain: script
toggle:
name: Toggle
description: Toggle script
target:
entity:
domain: script

View File

@ -4,13 +4,19 @@ turn_on:
name: Turn on
description: Turn a switch on
target:
entity:
domain: switch
turn_off:
name: Turn off
description: Turn a switch off
target:
entity:
domain: switch
toggle:
name: Toggle
description: Toggles a switch state
target:
entity:
domain: switch

View File

@ -4,6 +4,8 @@ start:
name: Start
description: Start a timer
target:
entity:
domain: timer
fields:
duration:
description: Duration the timer requires to finish. [optional]
@ -16,13 +18,19 @@ pause:
name: Pause
description: Pause a timer.
target:
entity:
domain: timer
cancel:
name: Cancel
description: Cancel a timer.
target:
entity:
domain: timer
finish:
name: Finish
description: Finish a timer.
target:
entity:
domain: timer

View File

@ -4,16 +4,22 @@ reset:
name: Reset
description: Resets the counter of a utility meter.
target:
entity:
domain: utility_meter
next_tariff:
name: Next Tariff
description: Changes the tariff to the next one.
target:
entity:
domain: utility_meter
select_tariff:
name: Select Tariff
description: Selects the current tariff of a utility meter.
target:
entity:
domain: utility_meter
fields:
tariff:
name: Tariff
@ -37,4 +43,3 @@ calibrate:
required: true
selector:
text:

View File

@ -4,51 +4,71 @@ turn_on:
name: Turn on
description: Start a new cleaning task.
target:
entity:
domain: vacuum
turn_off:
name: Turn off
description: Stop the current cleaning task and return to home.
target:
entity:
domain: vacuum
stop:
name: Stop
description: Stop the current cleaning task.
target:
entity:
domain: vacuum
locate:
name: Locate
description: Locate the vacuum cleaner robot.
target:
entity:
domain: vacuum
start_pause:
name: Start/Pause
description: Start, pause, or resume the cleaning task.
target:
entity:
domain: vacuum
start:
name: Start
description: Start or resume the cleaning task.
target:
entity:
domain: vacuum
pause:
name: Pause
description: Pause the cleaning task.
target:
entity:
domain: vacuum
return_to_base:
name: Return to base
description: Tell the vacuum cleaner to return to its dock.
target:
entity:
domain: vacuum
clean_spot:
name: Clean spot
description: Tell the vacuum cleaner to do a spot clean-up.
target:
entity:
domain: vacuum
send_command:
name: Send command
description: Send a raw command to the vacuum cleaner.
target:
entity:
domain: vacuum
fields:
command:
name: Command
@ -68,6 +88,8 @@ set_fan_speed:
name: Set fan speed
description: Set the fan speed of the vacuum cleaner.
target:
entity:
domain: vacuum
fields:
fan_speed:
name: Fan speed

View File

@ -4,6 +4,8 @@ set_away_mode:
name: Set away mode
description: Turn away mode on/off for water_heater device.
target:
entity:
domain: water_heater
fields:
away_mode:
name: Away mode
@ -16,6 +18,8 @@ set_temperature:
name: Set temperature
description: Set target temperature of water_heater device.
target:
entity:
domain: water_heater
fields:
temperature:
name: Temperature
@ -26,7 +30,7 @@ set_temperature:
min: 0
max: 100
step: 0.5
unit_of_measurement: '°'
unit_of_measurement: "°"
operation_mode:
name: Operation mode
description: New value of operation mode.
@ -38,6 +42,8 @@ set_operation_mode:
name: Set operation mode
description: Set operation mode for water_heater device.
target:
entity:
domain: water_heater
fields:
operation_mode:
name: Operation mode