jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-24 21:57:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add targets and selectors for services (L-M) (#50543)

Browse Source
This commit is contained in:
tkdrob 2021-05-15 05:06:34 -04:00 committed by GitHub
parent 5d6f4068d3
commit a9660d5788
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
21 changed files with 945 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

464
homeassistant/components/lcn/services.yaml
View File

@ -1,200 +1,612 @@
# Describes the format for available LCN services # Describes the format for available LCN services
output_abs: output_abs:
name: Output absolute brightness
description: Set absolute brightness of output port in percent. description: Set absolute brightness of output port in percent.
fields: fields:
address: address:
name: Address
description: Module address description: Module address
required: true
example: "myhome.s0.m7" example: "myhome.s0.m7"
selector:
text:
output: output:
name: Output
description: Output port description: Output port
required: true
example: "output1" example: "output1"
selector:
select:
options:
- 'OUTPUT1'
- 'OUTPUT2'
- 'OUTPUT3'
- 'OUTPUT4'
brightness: brightness:
description: Absolute brightness in percent (0..100) name: Brightness
description: Absolute brightness in percent.
required: true
example: 50 example: 50
selector:
number:
min: 0
max: 100
transition: transition:
description: Transition time in seconds name: Transition
description: Transition time.
example: 5 example: 5
default: 0
selector:
number:
min: 0
max: 486
step: 0.1
unit_of_measurement: seconds
output_rel: output_rel:
name: Output relative brightness
description: Set relative brightness of output port in percent. description: Set relative brightness of output port in percent.
fields: fields:
address: address:
name: Address
description: Module address description: Module address
required: true
example: "myhome.s0.m7" example: "myhome.s0.m7"
selector:
text:
output: output:
name: Output
description: Output port description: Output port
required: true
example: "output1" example: "output1"
selector:
select:
options:
- 'OUTPUT1'
- 'OUTPUT2'
- 'OUTPUT3'
- 'OUTPUT4'
brightness: brightness:
description: Relative brightness in percent (-100..100) name: Brightness
description: Relative brightness in percent.
required: true
example: 50 example: 50
transition: selector:
description: Transition time in seconds number:
example: 5 min: -100
max: 100
unit_of_measurement: '%'
output_toggle: output_toggle:
name: Toggle output
description: Toggle output port. description: Toggle output port.
fields: fields:
address: address:
name: Address
description: Module address description: Module address
required: true
example: "myhome.s0.m7" example: "myhome.s0.m7"
selector:
text:
output: output:
name: Output
description: Output port description: Output port
required: true
example: "output1" example: "output1"
selector:
select:
options:
- 'OUTPUT1'
- 'OUTPUT2'
- 'OUTPUT3'
- 'OUTPUT4'
transition: transition:
description: Transition time in seconds name: Transition
description: Transition time.
example: 5 example: 5
default: 0
selector:
number:
min: 0
max: 486
step: 0.1
unit_of_measurement: seconds
relays: relays:
name: Relays
description: Set the relays status. description: Set the relays status.
fields: fields:
address: address:
name: Address
description: Module address description: Module address
required: true
example: "myhome.s0.m7" example: "myhome.s0.m7"
selector:
text:
state: state:
name: State
description: Relays states as string (1=on, 2=off, t=toggle, -=nochange) description: Relays states as string (1=on, 2=off, t=toggle, -=nochange)
required: true
example: "t---001-" example: "t---001-"
selector:
text:
led: led:
name: LED
description: Set the led state. description: Set the led state.
fields: fields:
address: address:
name: Address
description: Module address description: Module address
required: true
example: "myhome.s0.m7" example: "myhome.s0.m7"
selector:
text:
led: led:
name: LED
description: Led description: Led
required: true
example: "led6" example: "led6"
selector:
select:
options:
- 'LED1'
- 'LED2'
- 'LED3'
- 'LED4'
- 'LED5'
- 'LED6'
- 'LED7'
- 'LED8'
- 'LED9'
- 'LED10'
- 'LED11'
- 'LED12'
state: state:
name: State
description: Led state description: Led state
required: true
example: "blink" example: "blink"
values: selector:
- "on" select:
- "off" options:
- blink - 'blink'
- flicker - 'flicker'
- 'off'
- 'on'
var_abs: var_abs:
name: Set absolute variable
description: Set absolute value of a variable or setpoint. description: Set absolute value of a variable or setpoint.
fields: fields:
address: address:
name: Address
description: Module address description: Module address
required: true
example: "myhome.s0.m7" example: "myhome.s0.m7"
selector:
text:
variable: variable:
name: Variable
description: Variable or setpoint name description: Variable or setpoint name
required: true
example: "var1" example: "var1"
default: NATIVE
selector:
select:
options:
- 'R1VAR'
- 'R2VAR'
- 'R1VARSETPOINT'
- 'R2VARSETPOINT'
- 'TVAR'
- 'VAR1ORTVAR'
- 'VAR2ORR1VAR'
- 'VAR3ORR2VAR'
- 'VAR1'
- 'VAR2'
- 'VAR3'
- 'VAR4'
- 'VAR5'
- 'VAR6'
- 'VAR7'
- 'VAR8'
- 'VAR9'
- 'VAR10'
- 'VAR11'
- 'VAR12'
value: value:
name: Value
description: Value to set description: Value to set
example: "50" example: "50"
default: 0
selector:
number:
min: 0
max: 100000
unit_of_measurement: unit_of_measurement:
name: Unit of measurement
description: Unit of value description: Unit of value
example: "celsius" example: "celsius"
selector:
select:
options:
- ''
- '%'
- '°'
- '°C'
- '°F'
- 'AMPERE'
- 'AMP'
- 'A'
- 'DEGREE'
- 'NATIVE'
- 'K'
- 'LCN'
- 'LUX_T'
- 'LX_T'
- 'LUX_I'
- 'LUX'
- 'LX'
- 'M/S'
- 'METERPERSECOND'
- 'PERCENT'
- 'PPM'
- 'V'
- 'VOLT'
var_reset: var_reset:
name: Reset variable
description: Reset value of variable or setpoint. description: Reset value of variable or setpoint.
fields: fields:
address: address:
name: Address
description: Module address description: Module address
required: true
example: "myhome.s0.m7" example: "myhome.s0.m7"
variable: variable:
name: Variable
description: Variable or setpoint name description: Variable or setpoint name
required: true
example: "var1" example: "var1"
selector:
select:
options:
- 'R1VAR'
- 'R2VAR'
- 'R1VARSETPOINT'
- 'R2VARSETPOINT'
- 'TVAR'
- 'VAR1ORTVAR'
- 'VAR2ORR1VAR'
- 'VAR3ORR2VAR'
- 'VAR1'
- 'VAR2'
- 'VAR3'
- 'VAR4'
- 'VAR5'
- 'VAR6'
- 'VAR7'
- 'VAR8'
- 'VAR9'
- 'VAR10'
- 'VAR11'
- 'VAR12'
var_rel: var_rel:
name: Shift variable
description: Shift value of a variable, setpoint or threshold. description: Shift value of a variable, setpoint or threshold.
fields: fields:
address: address:
name: Address
description: Module address description: Module address
required: true
example: "myhome.s0.m7" example: "myhome.s0.m7"
selector:
text:
variable: variable:
name: Variable
description: Variable or setpoint name description: Variable or setpoint name
required: true
example: "var1" example: "var1"
selector:
select:
options:
- 'R1VAR'
- 'R2VAR'
- 'R1VARSETPOINT'
- 'R2VARSETPOINT'
- 'THRS1'
- 'THRS2'
- 'THRS3'
- 'THRS4'
- 'THRS5'
- 'THRS2_1'
- 'THRS2_2'
- 'THRS2_3'
- 'THRS2_4'
- 'THRS3_1'
- 'THRS3_2'
- 'THRS3_3'
- 'THRS3_4'
- 'THRS4_1'
- 'THRS4_2'
- 'THRS4_3'
- 'THRS4_4'
- 'TVAR'
- 'VAR1ORTVAR'
- 'VAR2ORR1VAR'
- 'VAR3ORR2VAR'
- 'VAR1'
- 'VAR2'
- 'VAR3'
- 'VAR4'
- 'VAR5'
- 'VAR6'
- 'VAR7'
- 'VAR8'
- 'VAR9'
- 'VAR10'
- 'VAR11'
- 'VAR12'
value: value:
name: Value
description: Shift value description: Shift value
example: "50" example: "50"
default: 0
selector:
number:
min: 0
max: 100000
unit_of_measurement: unit_of_measurement:
name: Unit of measurement
description: Unit of value description: Unit of value
example: "celsius" example: "celsius"
default: NATIVE
selector:
select:
options:
- ''
- '%'
- '°'
- '°C'
- '°F'
- 'AMPERE'
- 'AMP'
- 'A'
- 'DEGREE'
- 'NATIVE'
- 'K'
- 'LCN'
- 'LUX_T'
- 'LX_T'
- 'LUX_I'
- 'LUX'
- 'LX'
- 'M/S'
- 'METERPERSECOND'
- 'PERCENT'
- 'PPM'
- 'V'
- 'VOLT'
value_reference: value_reference:
description: Reference value (current or programmed) for setpoint and threshold name: Reference value
description: Reference value for setpoint and threshold
example: "current" example: "current"
values: default: CURRENT
- current selector:
- prog select:
options:
- 'CURRENT'
- 'PROG'
lock_regulator: lock_regulator:
name: Lock regulator
description: Lock a regulator setpoint. description: Lock a regulator setpoint.
fields: fields:
address: address:
name: Address
description: Module address description: Module address
required: true
example: "myhome.s0.m7" example: "myhome.s0.m7"
selector:
text:
setpoint: setpoint:
name: Setpoint
description: Setpoint name description: Setpoint name
required: true
example: "r1varsetpoint" example: "r1varsetpoint"
selector:
select:
options:
- 'THRS1'
- 'THRS2'
- 'THRS3'
- 'THRS4'
- 'THRS5'
- 'THRS2_1'
- 'THRS2_2'
- 'THRS2_3'
- 'THRS2_4'
- 'THRS3_1'
- 'THRS3_2'
- 'THRS3_3'
- 'THRS3_4'
- 'THRS4_1'
- 'THRS4_2'
- 'THRS4_3'
- 'THRS4_4'
state: state:
name: State
description: New setpoint state description: New setpoint state
example: true example: true
default: false
selector:
boolean:
send_keys: send_keys:
name: Send keys
description: Send keys (which executes bound commands). description: Send keys (which executes bound commands).
fields: fields:
address: address:
name: Address
description: Module address description: Module address
required: true
example: "myhome.s0.m7" example: "myhome.s0.m7"
selector:
text:
keys: keys:
name: Keys
description: Keys to send description: Keys to send
required: true
example: "a1a5d8" example: "a1a5d8"
selector:
text:
state: state:
name: State
description: "Key state upon sending (optional, must be hit for deferred)" description: "Key state upon sending (optional, must be hit for deferred)"
example: "hit" example: "hit"
values: default: HIT
- hit selector:
- make select:
- break options:
- 'HIT'
- 'MAKE'
- 'BREAK'
- 'DONTSEND'
time: time:
description: Send delay (optional) name: Time
description: Send delay.
example: 10 example: 10
default: 0
selector:
number:
min: 0
max: 60
time_unit: time_unit:
description: Time unit of send delay (optional) name: Time unit
description: Time unit of send delay.
example: "s" example: "s"
default: S
selector:
select:
options:
- 'D'
- 'DAY'
- 'DAYS'
- 'H'
- 'HOUR'
- 'HOURS'
- 'M'
- 'MIN'
- 'MINUTE'
- 'MINUTES'
- 'S'
- 'SEC'
- 'SECOND'
- 'SECONDS'
lock_keys: lock_keys:
name: Lock keys
description: Lock keys. description: Lock keys.
fields: fields:
address: address:
name: Address
description: Module address description: Module address
required: true
example: "myhome.s0.m7" example: "myhome.s0.m7"
selector:
text:
table: table:
description: "Table with keys to lock (optional, must be A for interval)." name: Table
description: "Table with keys to lock (must be A for interval)."
example: "A5" example: "A5"
default: A
selector:
text:
state: state:
name: State
description: Key lock states as string (1=on, 2=off, T=toggle, -=nochange) description: Key lock states as string (1=on, 2=off, T=toggle, -=nochange)
required: true
example: "1---t0--" example: "1---t0--"
selector:
text:
time: time:
description: Lock interval (optional) name: Time
description: Lock interval.
example: 10 example: 10
default: 0
selector:
number:
min: 0
max: 60
time_unit: time_unit:
description: Time unit of lock interval (optional) name: Time unit
description: Time unit of lock interval.
example: "s" example: "s"
default: S
selector:
select:
options:
- 'D'
- 'DAY'
- 'DAYS'
- 'H'
- 'HOUR'
- 'HOURS'
- 'M'
- 'MIN'
- 'MINUTE'
- 'MINUTES'
- 'S'
- 'SEC'
- 'SECOND'
- 'SECONDS'
dyn_text: dyn_text:
name: Dynamic text
description: Send dynamic text to LCN-GTxD displays. description: Send dynamic text to LCN-GTxD displays.
fields: fields:
address: address:
name: Address
description: Module address description: Module address
required: true
example: "myhome.s0.m7" example: "myhome.s0.m7"
selector:
text:
row: row:
description: Text row 1..4 (support of 4 independent text rows) name: Row
description: Text row.
required: true
example: 1 example: 1
selector:
number:
min: 1
max: 4
text: text:
name: Text
description: Text to send (up to 60 characters encoded as UTF-8) description: Text to send (up to 60 characters encoded as UTF-8)
required: true
example: "text up to 60 characters" example: "text up to 60 characters"
selector:
text:
pck: pck:
name: PCK
description: Send arbitrary PCK command. description: Send arbitrary PCK command.
fields: fields:
address: address:
name: Address
description: Module address description: Module address
required: true
example: "myhome.s0.m7" example: "myhome.s0.m7"
selector:
text:
pck: pck:
name: PCK
description: PCK command (without address header) description: PCK command (without address header)
required: true
example: "PIN4" example: "PIN4"
selector:
text:

149
homeassistant/components/lifx/services.yaml
View File

@ -1,77 +1,168 @@
set_state: set_state:
description: Set a color/brightness and possibliy turn the light on/off. name: Set State
description: Set a color/brightness and possibly turn the light on/off.
target:
entity:
integration: lifx
domain: light
fields: fields:
entity_id:
description: Name(s) of entities to set a state on.
example: "light.garage"
"...":
description: All turn_on parameters can be used to specify a color.
infrared: infrared:
description: Automatic infrared level (0..255) when light brightness is low. name: infrared
description: Automatic infrared level when light brightness is low.
example: 255 example: 255
selector:
number:
min: 0
max: 255
zones: zones:
name: Zones
description: List of zone numbers to affect (8 per LIFX Z, starts at 0). description: List of zone numbers to affect (8 per LIFX Z, starts at 0).
example: "[0,5]" example: "[0,5]"
selector:
object:
transition: transition:
description: Duration in seconds it takes to get to the final state. name: Transition
description: Duration it takes to get to the final state.
example: 10 example: 10
selector:
number:
min: 0
max: 3600
unit_of_measurement: seconds
power: power:
description: Turn the light on (True) or off (False). Leave out to keep the power as it is. name: Power
description: Turn the light on or off. Leave out to keep the power as it is.
example: false example: false
selector:
boolean:
effect_pulse: effect_pulse:
name: Pulse effect
description: Run a flash effect by changing to a color and back. description: Run a flash effect by changing to a color and back.
target:
entity:
integration: lifx
domain: light
fields: fields:
entity_id:
description: Name(s) of entities to run the effect on.
example: "light.kitchen"
mode: mode:
description: "Decides how colors are changed. Possible values: blink, breathe, ping, strobe, solid." name: Mode
description: "Decides how colors are changed."
example: strobe example: strobe
selector:
select:
options:
- 'blink'
- 'breathe'
- 'ping'
- 'strobe'
- 'solid'
brightness: brightness:
description: Number between 0..255 indicating brightness of the temporary color. name: Brightness
description: Number indicating brightness of the temporary color.
example: 120 example: 120
selector:
number:
min: 0
max: 255
color_name: color_name:
name: Color name
description: A human readable color name. description: A human readable color name.
example: "red" example: "red"
selector:
text:
rgb_color: rgb_color:
name: RGB color
description: The temporary color in RGB-format. description: The temporary color in RGB-format.
example: "[255, 100, 100]" example: "[255, 100, 100]"
selector:
object:
period: period:
description: Duration of the effect in seconds (default 1.0). name: Period
description: Duration of the effect.
example: 3 example: 3
default: 1.0
selector:
number:
min: 0.05
max: 60.00
step: 0.05
unit_of_measurement: seconds
cycles: cycles:
description: Number of times the effect should run (default 1.0). name: Cycles
description: Number of times the effect should run.
example: 2 example: 2
default: 1
selector:
number:
min: 1
max: 10000
power_on: power_on:
description: Powered off lights are temporarily turned on during the effect (default True). name: Power on
description: Powered off lights are temporarily turned on during the effect.
example: false example: false
default: true
selector:
boolean:
effect_colorloop: effect_colorloop:
name: Color loop effect
description: Run an effect with looping colors. description: Run an effect with looping colors.
target:
entity:
integration: lifx
domain: light
fields: fields:
entity_id:
description: Name(s) of entities to run the effect on.
example: "light.disco1, light.disco2, light.disco3"
brightness: brightness:
description: Number between 0 and 255 indicating brightness of the effect. Leave this out to maintain the current brightness of each participating light. name: Brightness
description: Number indicating brightness of the effect. Leave this out to maintain the current brightness of each participating light.
example: 120 example: 120
selector:
number:
min: 0
max: 255
period: period:
description: Duration (in seconds) between color changes (default 60). name: Period
description: Duration between color changes.
example: 180 example: 180
default: 60
selector:
number:
min: 0.05
max: 3600.00
step: 0.05
unit_of_measurement: seconds
change: change:
description: Hue movement per period, in degrees on a color wheel (ranges from 0 to 360, default 20). name: Change
description: Hue movement per period, in degrees on a color wheel.
example: 45 example: 45
default: 20
selector:
number:
min: 0
max: 360
unit_of_measurement: '°'
spread: spread:
description: Maximum hue difference between participating lights, in degrees on a color wheel (ranges from 0 to 360, default 30). name: Spread
description: Maximum hue difference between participating lights, in degrees on a color wheel.
example: 0 example: 0
default: 30
selector:
number:
min: 0
max: 360
unit_of_measurement: '°'
power_on: power_on:
description: Powered off lights are temporarily turned on during the effect (default True). name: Power on
description: Powered off lights are temporarily turned on during the effect.
example: false example: false
default: true
selector:
boolean:
effect_stop: effect_stop:
name: Stop effect
description: Stop a running effect. description: Stop a running effect.
fields: target:
entity_id: entity:
description: Name(s) of entities to stop effects on. Leave out to stop effects everywhere. integration: lifx
example: "light.bedroom" domain: light

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

@ -569,7 +569,7 @@ toggle:
mode: slider mode: slider
white_value: white_value:
name: White level name: White level
description: Number between 0..255 indicating level of white. description: Number indicating level of white.
advanced: true advanced: true
example: "250" example: "250"
selector: selector:
@ -581,7 +581,7 @@ toggle:
brightness: brightness:
name: Brightness value name: Brightness value
description: description:
Number between 0..255 indicating brightness, where 0 turns the light Number indicating brightness, where 0 turns the light
off, 1 is the minimum brightness and 255 is the maximum brightness off, 1 is the minimum brightness and 255 is the maximum brightness
supported by the light. supported by the light.
advanced: true advanced: true

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

@ -1,9 +1,19 @@
update_file_path: update_file_path:
name: Update file path
description: Use this service to change the file displayed by the camera. description: Use this service to change the file displayed by the camera.
fields: fields:
entity_id: entity_id:
name: Entity
description: Name of the entity_id of the camera to update. description: Name of the entity_id of the camera to update.
required: true
example: "camera.local_file" example: "camera.local_file"
selector:
entity:
domain: camera
file_path: file_path:
name: file path
description: The full path to the new image file to be displayed. description: The full path to the new image file to be displayed.
required: true
example: "/config/www/images/image.jpg" example: "/config/www/images/image.jpg"
selector:
text:

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

@ -1,24 +1,46 @@
# Describes the format for available lock services # Describes the format for available lock services
clear_usercode: clear_usercode:
name: Clear usercode
description: Clear a usercode from lock. description: Clear a usercode from lock.
fields: fields:
node_id: node_id:
name: Node ID
description: Node id of the lock. description: Node id of the lock.
example: 18 example: 18
selector:
number:
min: 1
max: 255
code_slot: code_slot:
name: Code slot
description: Code slot to clear code from. description: Code slot to clear code from.
example: 1 example: 1
selector:
number:
min: 1
max: 255
get_usercode: get_usercode:
name: Get usercode
description: Retrieve a usercode from lock. description: Retrieve a usercode from lock.
fields: fields:
node_id: node_id:
name: Node ID
description: Node id of the lock. description: Node id of the lock.
example: 18 example: 18
selector:
number:
min: 1
max: 255
code_slot: code_slot:
name: Code slot
description: Code slot to retrieve a code from. description: Code slot to retrieve a code from.
example: 1 example: 1
selector:
number:
min: 1
max: 255
lock: lock:
name: Lock name: Lock
@ -51,12 +73,23 @@ set_usercode:
node_id: node_id:
description: Node id of the lock. description: Node id of the lock.
example: 18 example: 18
selector:
number:
min: 1
max: 255
code_slot: code_slot:
description: Code slot to set the code. description: Code slot to set the code.
example: 1 example: 1
selector:
number:
min: 1
max: 255
usercode: usercode:
description: Code to set. description: Code to set.
required: true
example: 1234 example: 1234
selector:
text:
unlock: unlock:
name: Unlock name: Unlock

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

@ -1,29 +1,30 @@
log: log:
description: Create a custom entry in your logbook name: Log
description: Create a custom entry in your logbook.
fields: fields:
name: name:
name: Name name: Name
description: Custom name for an entity, can be referenced with entity_id description: Custom name for an entity, can be referenced with entity_id.
required: true required: true
example: "Kitchen" example: "Kitchen"
selector: selector:
text: text:
message: message:
name: Message name: Message
description: Message of the custom logbook entry description: Message of the custom logbook entry.
required: true required: true
example: "is being used" example: "is being used"
selector: selector:
text: text:
entity_id: entity_id:
name: Entity ID name: Entity ID
description: Entity to reference in custom logbook entry [Optional] description: Entity to reference in custom logbook entry.
example: "light.kitchen" example: "light.kitchen"
selector: selector:
entity: entity:
domain: domain:
name: Domain name: Domain
description: Icon of domain to display in custom logbook entry [Optional] description: Icon of domain to display in custom logbook entry.
example: "light" example: "light"
selector: selector:
text: text:

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

@ -21,23 +21,63 @@ set_level:
description: Set log level for integrations. description: Set log level for integrations.
fields: fields:
homeassistant.core: homeassistant.core:
name: Home Assistant 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
integrations. Possible values are debug, info, warn, warning, error, integrations."
fatal, critical."
example: debug example: debug
selector:
select:
options:
- 'debug'
- 'critical'
- 'error'
- 'fatal'
- 'info'
- 'warn'
- 'warning'
homeassistant.components.mqtt: homeassistant.components.mqtt:
name: Home Assistant 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."
values are debug, info, warn, warning, error, fatal, critical."
example: warning example: warning
selector:
select:
options:
- 'debug'
- 'critical'
- 'error'
- 'fatal'
- 'info'
- 'warn'
- 'warning'
custom_components.my_integration: custom_components.my_integration:
name: Custom components "my_integation"
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."
example: debug example: debug
selector:
select:
options:
- 'debug'
- 'critical'
- 'error'
- 'fatal'
- 'info'
- 'warn'
- 'warning'
aiohttp: aiohttp:
name: 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."
example: error example: error
selector:
select:
options:
- 'debug'
- 'critical'
- 'error'
- 'fatal'
- 'info'
- 'warn'
- 'warning'

48
homeassistant/components/logi_circle/services.yaml
View File

@ -1,37 +1,81 @@
# Describes the format for available Logi Circle services # Describes the format for available Logi Circle services
set_config: set_config:
name: Set config
description: Set a configuration property. description: Set a configuration property.
fields: fields:
entity_id: entity_id:
name: Entity
description: Name(s) of entities to apply the operation mode to. description: Name(s) of entities to apply the operation mode to.
example: "camera.living_room_camera" example: "camera.living_room_camera"
selector:
entity:
integration: logi_circle
domain: camera
mode: mode:
name: Mode
description: "Operation mode. Allowed values: LED, RECORDING_MODE." description: "Operation mode. Allowed values: LED, RECORDING_MODE."
required: true
example: "RECORDING_MODE" example: "RECORDING_MODE"
selector:
select:
options:
- 'LED'
- 'RECORDING_MODE'
value: value:
description: "Operation value. Allowed values: true, false" name: Value
description: "Operation value."
required: true
example: true example: true
selector:
boolean:
livestream_snapshot: livestream_snapshot:
name: Livestream snapshot
description: Take a snapshot from the camera's livestream. Will wake the camera from sleep if required. description: Take a snapshot from the camera's livestream. Will wake the camera from sleep if required.
fields: fields:
entity_id: entity_id:
name: Entity
description: Name(s) of entities to create snapshots from. description: Name(s) of entities to create snapshots from.
example: "camera.living_room_camera" example: "camera.living_room_camera"
selector:
entity:
integration: logi_circle
domain: camera
filename: filename:
name: File name
description: Template of a Filename. Variable is entity_id. description: Template of a Filename. Variable is entity_id.
required: true
example: "/tmp/snapshot_{{ entity_id }}.jpg" example: "/tmp/snapshot_{{ entity_id }}.jpg"
selector:
text:
livestream_record: livestream_record:
name: Livestream record
description: Take a video recording from the camera's livestream. description: Take a video recording from the camera's livestream.
fields: fields:
entity_id: entity_id:
name: Entity
description: Name(s) of entities to create recordings from. description: Name(s) of entities to create recordings from.
example: "camera.living_room_camera" example: "camera.living_room_camera"
selector:
entity:
integration: logi_circle
domain: camera
filename: filename:
name: File name
description: Template of a Filename. Variable is entity_id. description: Template of a Filename. Variable is entity_id.
required: true
example: "/tmp/snapshot_{{ entity_id }}.mp4" example: "/tmp/snapshot_{{ entity_id }}.mp4"
selector:
text:
duration: duration:
description: Recording duration in seconds. name: Duration
description: Recording duration.
required: true
example: 60 example: 60
selector:
number:
min: 1
max: 3600
unit_of_measurement: seconds

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

@ -1,4 +1,5 @@
# Describes the format for available lovelace services # Describes the format for available lovelace services
reload_resources: reload_resources:
name: Reload resources
description: Reload Lovelace resources from YAML configuration description: Reload Lovelace resources from YAML configuration

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

@ -1,12 +1,24 @@
send_message: send_message:
name: Send message
description: Send message to target room(s) description: Send message to target room(s)
fields: fields:
message: message:
name: Message
description: The message to be sent. description: The message to be sent.
required: true
example: This is a message I am sending to matrix example: This is a message I am sending to matrix
selector:
text:
target: target:
name: Target
description: A list of room(s) to send the message to. description: A list of room(s) to send the message to.
required: true
example: "#hasstest:matrix.org" example: "#hasstest:matrix.org"
selector:
text:
data: data:
name: Data
description: Extended information of notification. Supports list of images. Optional. description: Extended information of notification. Supports list of images. Optional.
example: "{'images': ['/tmp/test.jpg']}" example: "{'images': ['/tmp/test.jpg']}"
selector:
text:

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

@ -1,12 +1,28 @@
play_media: play_media:
name: Play media
description: Downloads file from given URL. description: Downloads file from given URL.
target:
entity:
domain: media_player
fields: fields:
entity_id:
description: Name(s) of entities to play media on.
example: "media_player.living_room_chromecast"
media_content_id: media_content_id:
name: Media content ID
description: The ID of the content to play. Platform dependent. description: The ID of the content to play. Platform dependent.
required: true
example: "https://soundcloud.com/bruttoband/brutto-11" example: "https://soundcloud.com/bruttoband/brutto-11"
selector:
text:
media_content_type: media_content_type:
name: Media content type
description: The type of the content to play. Must be one of MUSIC, TVSHOW, VIDEO, EPISODE, CHANNEL or PLAYLIST MUSIC. description: The type of the content to play. Must be one of MUSIC, TVSHOW, VIDEO, EPISODE, CHANNEL or PLAYLIST MUSIC.
required: true
example: "music" example: "music"
selector:
select:
options:
- 'CHANNEL'
- 'EPISODE'
- 'PLAYLIST MUSIC'
- 'MUSIC'
- 'TVSHOW'
- 'VIDEO'

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

@ -176,7 +176,7 @@ repeat_set:
fields: fields:
repeat: repeat:
name: Repeat mode name: Repeat mode
description: Repeat mode to set (off, all, one). description: Repeat mode to set.
required: true required: true
example: "off" example: "off"
selector: selector:
@ -187,18 +187,21 @@ repeat_set:
- "one" - "one"
join: join:
name: Join
description: description:
Group players together. Only works on platforms with support for player Group players together. Only works on platforms with support for player
groups. groups.
name: Join
target: target:
fields: fields:
group_members: group_members:
name: Group members
description: description:
The players which will be synced with the target player. The players which will be synced with the target player.
example: example:
- "media_player.multiroom_player2" - "media_player.multiroom_player2"
- "media_player.multiroom_player3" - "media_player.multiroom_player3"
selector:
object:
unjoin: unjoin:
description: description:

24
homeassistant/components/melcloud/services.yaml
View File

@ -1,23 +1,35 @@
set_vane_horizontal: set_vane_horizontal:
name: Set vane horizontal
description: Sets horizontal vane position. description: Sets horizontal vane position.
target:
entity:
integration: melcloud
domain: climate
fields: fields:
entity_id:
description: Name of the target entity
example: "climate.ac_1"
position: position:
name: Position
description: > description: >
Horizontal vane position. Possible options can be found in the Horizontal vane position. Possible options can be found in the
vane_horizontal_positions state attribute. vane_horizontal_positions state attribute.
required: true
example: "auto" example: "auto"
selector:
text:
set_vane_vertical: set_vane_vertical:
name: Set vane vertical
description: Sets vertical vane position. description: Sets vertical vane position.
target:
entity:
integration: melcloud
domain: climate
fields: fields:
entity_id:
description: Name of the target entity
example: "climate.ac_1"
position: position:
name: Position
description: > description: >
Vertical vane position. Possible options can be found in the Vertical vane position. Possible options can be found in the
vane_vertical_positions state attribute. vane_vertical_positions state attribute.
required: true
example: "auto" example: "auto"
selector:
text:

46
homeassistant/components/microsoft_face/services.yaml
View File

@ -1,48 +1,94 @@
create_group: create_group:
name: Create group
description: Create a new person group. description: Create a new person group.
fields: fields:
name: name:
name: Name
description: Name of the group. description: Name of the group.
required: true
example: family example: family
selector:
text:
create_person: create_person:
name: Create person
description: Create a new person in the group. description: Create a new person in the group.
fields: fields:
group: group:
name: Group
description: Name of the group description: Name of the group
required: true
example: family example: family
selector:
text:
name: name:
name: Name
description: Name of the person description: Name of the person
required: true
example: Hans example: Hans
selector:
text:
delete_group: delete_group:
name: Delete group
description: Delete a new person group. description: Delete a new person group.
fields: fields:
name: name:
name: Name
description: Name of the group. description: Name of the group.
required: true
example: family example: family
selector:
text:
delete_person: delete_person:
name: Delete person
description: Delete a person in the group. description: Delete a person in the group.
fields: fields:
group: group:
name: Group
description: Name of the group. description: Name of the group.
required: true
example: family example: family
selector:
text:
name: name:
name: Name
description: Name of the person. description: Name of the person.
required: true
example: Hans example: Hans
selector:
text:
face_person: face_person:
name: Face person
description: Add a new picture to a person. description: Add a new picture to a person.
fields: fields:
camera_entity: camera_entity:
name: Camera entity
description: Camera to take a picture. description: Camera to take a picture.
required: true
example: camera.door example: camera.door
selector:
text:
group: group:
name: Group
description: Name of the group. description: Name of the group.
required: true
example: family example: family
selector:
text:
person: person:
name: Person
description: Name of the person. description: Name of the person.
required: true
example: Hans example: Hans
selector:
text:
train_group: train_group:
name: Train group
description: Train a person group. description: Train a person group.
fields: fields:
group: group:
name: Group
description: Name of the group description: Name of the group
required: true
example: family example: family
selector:
text:

23
homeassistant/components/mill/services.yaml
View File

@ -1,15 +1,38 @@
set_room_temperature: set_room_temperature:
name: Set room temperature
description: Set Mill room temperatures. description: Set Mill room temperatures.
fields: fields:
room_name: room_name:
name: Room name
description: Name of room to change. description: Name of room to change.
required: true
example: "kitchen" example: "kitchen"
selector:
text:
away_temp: away_temp:
name: Away temperature
description: Away temp. description: Away temp.
example: 12 example: 12
selector:
number:
min: 0
max: 100
unit_of_measurement: '°'
comfort_temp: comfort_temp:
name: Comfort temperature
description: Comfort temp. description: Comfort temp.
example: 22 example: 22
selector:
number:
min: 0
max: 100
unit_of_measurement: '°'
sleep_temp: sleep_temp:
name: Sleep temperature
description: Sleep temp. description: Sleep temp.
example: 17 example: 17
selector:
number:
min: 0
max: 100
unit_of_measurement: '°'

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

@ -1,2 +1,3 @@
reload: reload:
name: Reload
description: Reload all min_max entities. description: Reload all min_max entities.

35
homeassistant/components/minio/services.yaml
View File

@ -1,35 +1,70 @@
get: get:
name: Get
description: Download file from Minio. description: Download file from Minio.
fields: fields:
bucket: bucket:
name: Bucket
description: Bucket to use. description: Bucket to use.
required: true
example: camera-files example: camera-files
selector:
text:
key: key:
name: Kay
description: Object key of the file. description: Object key of the file.
required: true
example: front_camera/2018/01/02/snapshot_12512514.jpg example: front_camera/2018/01/02/snapshot_12512514.jpg
selector:
text:
file_path: file_path:
name: File path
description: File path on local filesystem. description: File path on local filesystem.
required: true
example: /data/camera_files/snapshot.jpg example: /data/camera_files/snapshot.jpg
selector:
text:
put: put:
name: Put
description: Upload file to Minio. description: Upload file to Minio.
fields: fields:
bucket: bucket:
name: Bucket
description: Bucket to use. description: Bucket to use.
required: true
example: camera-files example: camera-files
selector:
text:
key: key:
name: Key
description: Object key of the file. description: Object key of the file.
required: true
example: front_camera/2018/01/02/snapshot_12512514.jpg example: front_camera/2018/01/02/snapshot_12512514.jpg
selector:
text:
file_path: file_path:
name: File path
description: File path on local filesystem. description: File path on local filesystem.
required: true
example: /data/camera_files/snapshot.jpg example: /data/camera_files/snapshot.jpg
selector:
text:
remove: remove:
name: Remove
description: Delete file from Minio. description: Delete file from Minio.
fields: fields:
bucket: bucket:
name: Bucket
description: Bucket to use. description: Bucket to use.
required: true
example: camera-files example: camera-files
selector:
text:
key: key:
name: Key
description: Object key of the file. description: Object key of the file.
required: true
example: front_camera/2018/01/02/snapshot_12512514.jpg example: front_camera/2018/01/02/snapshot_12512514.jpg
selector:
text:

46
homeassistant/components/modbus/services.yaml
View File

@ -1,30 +1,72 @@
write_coil: write_coil:
name: Write coil
description: Write to a modbus coil. description: Write to a modbus coil.
fields: fields:
address: address:
name: Address
description: Address of the register to write to. description: Address of the register to write to.
required: true
example: 0 example: 0
selector:
number:
min: 1
max: 255
state: state:
name: State
description: State to write. description: State to write.
required: true
example: false example: false
selector:
object:
unit: unit:
name: Unit
description: Address of the modbus unit. description: Address of the modbus unit.
required: true
example: 21 example: 21
selector:
number:
min: 1
max: 255
hub: hub:
description: Optional Modbus hub name. A hub with the name 'default' is used if not specified. name: Hub
description: Modbus hub name.
example: "hub1" example: "hub1"
default: "modbus_hub"
selector:
text:
write_register: write_register:
name: Write register
description: Write to a modbus holding register. description: Write to a modbus holding register.
fields: fields:
address: address:
name: Address
description: Address of the holding register to write to. description: Address of the holding register to write to.
required: true
example: 0 example: 0
selector:
number:
min: 1
max: 255
unit: unit:
name: Unit
description: Address of the modbus unit. description: Address of the modbus unit.
required: true
example: 21 example: 21
selector:
number:
min: 1
max: 255
value: value:
name: Value
description: Value (single value or array) to write. description: Value (single value or array) to write.
required: true
example: "0 or [4,0]" example: "0 or [4,0]"
selector:
object:
hub: hub:
description: Optional Modbus hub name. A hub with the name 'default' is used if not specified. name: Hub
description: Modbus hub name.
example: "hub1" example: "hub1"
default: "modbus_hub"
selector:
text:

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

@ -1,13 +1,15 @@
snapshot: snapshot:
name: Snapshot
description: Take a snapshot of the media player zone. description: Take a snapshot of the media player zone.
fields: target:
entity_id: entity:
description: Name(s) of entities that will be snapshot. Platform dependent. integration: monoprice
example: "media_player.living_room" domain: media_player
restore: restore:
name: Restore
description: Restore a snapshot of the media player zone. description: Restore a snapshot of the media player zone.
fields: target:
entity_id: entity:
description: Name(s) of entities that will be restored. Platform dependent. integration: monoprice
example: "media_player.living_room" domain: media_player

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

@ -1,14 +1,27 @@
# Describes the format for available motion blinds services # Describes the format for available motion blinds services
set_absolute_position: set_absolute_position:
name: Set absolute position
description: "Set the absolute position of the cover." description: "Set the absolute position of the cover."
target:
entity:
integration: motion_blinds
domain: cover
fields: fields:
entity_id:
description: Name of the motion blind cover entity to control.
example: "cover.TopDownBottomUp-Bottom-0001"
absolute_position: absolute_position:
name: Absolute position
description: Absolute position to move to. description: Absolute position to move to.
required: true
example: 70 example: 70
selector:
number:
min: 1
max: 100
width: width:
description: Optionally specify the width that is covered, only for TDBU Combined entities. name: Width
description: Specify the width that is covered, only for TDBU Combined entities.
example: 30 example: 30
selector:
number:
min: 1
max: 100

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

@ -1,9 +1,19 @@
send_ir_code: send_ir_code:
name: Send IR code
description: Set an IR code as a state attribute for a MySensors IR device switch and turn the switch on. description: Set an IR code as a state attribute for a MySensors IR device switch and turn the switch on.
fields: fields:
entity_id: entity_id:
description: Name(s) of entities that should have the IR code set and be turned on. Platform dependent. name: Entity
description: Name of entity that should have the IR code set and be turned on. Platform dependent.
example: "switch.living_room_1_1" example: "switch.living_room_1_1"
selector:
entity:
integration: mysensors
domain: switch
V_IR_SEND: V_IR_SEND:
name: IR send
description: IR code to send. description: IR code to send.
required: true
example: "0xC284" example: "0xC284"
selector:
text: