evlli/hass-core
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update services.yaml files (#10229)

Browse source 
* Add period to the description

* Update abbreviation
This commit is contained in:
Fabian Affolter 2017-10-30 21:39:12 +01:00 • committed by GitHub
parent c9c102815a
commit cc293db5ab
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
26 changed files with 336 additions and 699 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
homeassistant/components/alarm_control_panel/services.yaml
View file

@ -1,65 +1,61 @@
alarm_disarm:
description: Send the alarm the command for disarm
# Describes the format for available alarm control panel services
alarm_disarm:
description: Send the alarm the command for disarm.
fields:
entity_id:
description: Name of alarm control panel to disarm
description: Name of alarm control panel to disarm.
example: 'alarm_control_panel.downstairs'
code:
description: An optional code to disarm the alarm control panel with
description: An optional code to disarm the alarm control panel with.
example: 1234
alarm_arm_home:
description: Send the alarm the command for arm home
description: Send the alarm the command for arm home.
fields:
entity_id:
description: Name of alarm control panel to arm home
description: Name of alarm control panel to arm home.
example: 'alarm_control_panel.downstairs'
code:
description: An optional code to arm home the alarm control panel with
description: An optional code to arm home the alarm control panel with.
example: 1234
alarm_arm_away:
description: Send the alarm the command for arm away
description: Send the alarm the command for arm away.
fields:
entity_id:
description: Name of alarm control panel to arm away
description: Name of alarm control panel to arm away.
example: 'alarm_control_panel.downstairs'
code:
description: An optional code to arm away the alarm control panel with
description: An optional code to arm away the alarm control panel with.
example: 1234
alarm_arm_night:
description: Send the alarm the command for arm night
description: Send the alarm the command for arm night.
fields:
entity_id:
description: Name of alarm control panel to arm night
description: Name of alarm control panel to arm night.
example: 'alarm_control_panel.downstairs'
code:
description: An optional code to arm night the alarm control panel with
description: An optional code to arm night the alarm control panel with.
example: 1234
alarm_trigger:
description: Send the alarm the command for trigger
description: Send the alarm the command for trigger.
fields:
entity_id:
description: Name of alarm control panel to trigger
description: Name of alarm control panel to trigger.
example: 'alarm_control_panel.downstairs'
code:
description: An optional code to trigger the alarm control panel with
description: An optional code to trigger the alarm control panel with.
example: 1234
envisalink_alarm_keypress:
description: Send custom keypresses to the alarm
description: Send custom keypresses to the alarm.
fields:
entity_id:
description: Name of the alarm control panel to trigger
description: Name of the alarm control panel to trigger.
example: 'alarm_control_panel.downstairs'
keypress:
description: 'String to send to the alarm panel (1-6 characters)'
description: 'String to send to the alarm panel (1-6 characters).'
example: '*71'

6
homeassistant/components/automation/services.yaml
View file

@ -1,6 +1,7 @@
# Describes the format for available automation services
turn_on:
description: Enable an automation.
fields:
entity_id:
description: Name of the automation to turn on.
@ -8,7 +9,6 @@ turn_on:
turn_off:
description: Disable an automation.
fields:
entity_id:
description: Name of the automation to turn off.
@ -16,7 +16,6 @@ turn_off:
toggle:
description: Toggle an automation.
fields:
entity_id:
description: Name of the automation to toggle on/off.
@ -24,7 +23,6 @@ toggle:
trigger:
description: Trigger the action of an automation.
fields:
entity_id:
description: Name of the automation to trigger.

12
homeassistant/components/calendar/services.yaml
View file

@ -1,19 +1,21 @@
# Describes the format for available calendar services
todoist:
new_task:
description: Create a new task and add it to a project.
fields:
content:
description: The name of the task. [Required]
description: The name of the task (Required).
example: Pick up the mail
project:
description: The name of the project this task should belong to. Defaults to Inbox. [Optional]
description: The name of the project this task should belong to. Defaults to Inbox (Optional).
example: Errands
labels:
description: Any labels that you want to apply to this task, separated by a comma. [Optional]
description: Any labels that you want to apply to this task, separated by a comma (Optional).
example: Chores,Deliveries
priority:
description: The priority of this task, from 1 (normal) to 4 (urgent). [Optional]
description: The priority of this task, from 1 (normal) to 4 (urgent) (Optional).
example: 2
due_date:
description: The day this task is due, in format YYYY-MM-DD. [Optional]
description: The day this task is due, in format YYYY-MM-DD (Optional).
example: "2018-04-01"

18
homeassistant/components/camera/services.yaml
View file

@ -1,29 +1,25 @@
# Describes the format for available camera services
enable_motion_detection:
description: Enable the motion detection in a camera
description: Enable the motion detection in a camera.
fields:
entity_id:
description: Name(s) of entities to enable motion detection
description: Name(s) of entities to enable motion detection.
example: 'camera.living_room_camera'
disable_motion_detection:
description: Disable the motion detection in a camera
description: Disable the motion detection in a camera.
fields:
entity_id:
description: Name(s) of entities to disable motion detection
description: Name(s) of entities to disable motion detection.
example: 'camera.living_room_camera'
snapshot:
description: Take a snapshot from a camera
description: Take a snapshot from a camera.
fields:
entity_id:
description: Name(s) of entities to disable motion detection
description: Name(s) of entities to create snapshots from.
example: 'camera.living_room_camera'
filename:
description: Template of a Filename. Variable is entity_id
description: Template of a Filename. Variable is entity_id.
example: '/tmp/snapshot_{{ entity_id }}'

94
homeassistant/components/climate/services.yaml
View file

@ -1,132 +1,102 @@
# Describes the format for available climate services
set_aux_heat:
description: Turn auxiliary heater on/off for climate device
description: Turn auxiliary heater on/off for climate device.
fields:
entity_id:
description: Name(s) of entities to change
description: Name(s) of entities to change.
example: 'climate.kitchen'
aux_heat:
description: New value of axillary heater
description: New value of axillary heater.
example: true
set_away_mode:
description: Turn away mode on/off for climate device
description: Turn away mode on/off for climate device.
fields:
entity_id:
description: Name(s) of entities to change
description: Name(s) of entities to change.
example: 'climate.kitchen'
away_mode:
description: New value of away mode
description: New value of away mode.
example: true
set_hold_mode:
description: Turn hold mode for climate device
description: Turn hold mode for climate device.
fields:
entity_id:
description: Name(s) of entities to change
description: Name(s) of entities to change.
example: 'climate.kitchen'
hold_mode:
description: New value of hold mode
example: 'away'
set_temperature:
description: Set target temperature of climate device
description: Set target temperature of climate device.
fields:
entity_id:
description: Name(s) of entities to change
description: Name(s) of entities to change.
example: 'climate.kitchen'
temperature:
description: New target temperature for hvac
description: New target temperature for HVAC.
example: 25
target_temp_high:
description: New target high tempereature for hvac
description: New target high tempereature for HVAC.
example: 26
target_temp_low:
description: New target low temperature for hvac
description: New target low temperature for HVAC.
example: 20
operation_mode:
description: Operation mode to set temperature to. This defaults to current_operation mode if not set, or set incorrectly.
example: 'Heat'
set_humidity:
description: Set target humidity of climate device
description: Set target humidity of climate device.
fields:
entity_id:
description: Name(s) of entities to change
description: Name(s) of entities to change.
example: 'climate.kitchen'
humidity:
description: New target humidity for climate device
description: New target humidity for climate device.
example: 60
set_fan_mode:
description: Set fan operation for climate device
description: Set fan operation for climate device.
fields:
entity_id:
description: Name(s) of entities to change
description: Name(s) of entities to change.
example: 'climate.nest'
fan_mode:
description: New value of fan mode
description: New value of fan mode.
example: On Low
set_operation_mode:
description: Set operation mode for climate device
description: Set operation mode for climate device.
fields:
entity_id:
description: Name(s) of entities to change
description: Name(s) of entities to change.
example: 'climate.nest'
operation_mode:
description: New value of operation mode
description: New value of operation mode.
example: Heat
set_swing_mode:
description: Set swing operation for climate device
description: Set swing operation for climate device.
fields:
entity_id:
description: Name(s) of entities to change
description: Name(s) of entities to change.
example: 'climate.nest'
swing_mode:
description: New value of swing mode
description: New value of swing mode.
example: 1
ecobee_set_fan_min_on_time:
description: Set the minimum fan on time
description: Set the minimum fan on time.
fields:
entity_id:
description: Name(s) of entities to change
description: Name(s) of entities to change.
example: 'climate.kitchen'
fan_min_on_time:
description: New value of fan min on time
description: New value of fan min on time.
example: 5
ecobee_resume_program:
description: Resume the programmed schedule
description: Resume the programmed schedule.
fields:
entity_id:
description: Name(s) of entities to change
description: Name(s) of entities to change.
example: 'climate.kitchen'
resume_all:
description: Resume all events and return to the scheduled program. This default to false which removes only the top event.
example: true

48
homeassistant/components/cover/services.yaml
View file

@ -1,71 +1,63 @@
open_cover:
description: Open all or specified cover
# Describes the format for available cover services
open_cover:
description: Open all or specified cover.
fields:
entity_id:
description: Name(s) of cover(s) to open
description: Name(s) of cover(s) to open.
example: 'cover.living_room'
close_cover:
description: Close all or specified cover
description: Close all or specified cover.
fields:
entity_id:
description: Name(s) of cover(s) to close
description: Name(s) of cover(s) to close.
example: 'cover.living_room'
set_cover_position:
description: Move to specific position all or specified cover
description: Move to specific position all or specified cover.
fields:
entity_id:
description: Name(s) of cover(s) to set cover position
description: Name(s) of cover(s) to set cover position.
example: 'cover.living_room'
position:
description: Position of the cover (0 to 100)
description: Position of the cover (0 to 100).
example: 30
stop_cover:
description: Stop all or specified cover
description: Stop all or specified cover.
fields:
entity_id:
description: Name(s) of cover(s) to stop
description: Name(s) of cover(s) to stop.
example: 'cover.living_room'
open_cover_tilt:
description: Open all or specified cover tilt
description: Open all or specified cover tilt.
fields:
entity_id:
description: Name(s) of cover(s) tilt to open
description: Name(s) of cover(s) tilt to open.
example: 'cover.living_room'
close_cover_tilt:
description: Close all or specified cover tilt
description: Close all or specified cover tilt.
fields:
entity_id:
description: Name(s) of cover(s) to close tilt
description: Name(s) of cover(s) to close tilt.
example: 'cover.living_room'
set_cover_tilt_position:
description: Move to specific position all or specified cover tilt
description: Move to specific position all or specified cover tilt.
fields:
entity_id:
description: Name(s) of cover(s) to set cover tilt position
description: Name(s) of cover(s) to set cover tilt position.
example: 'cover.living_room'
position:
description: Position of the cover (0 to 100)
description: Position of the cover (0 to 100).
example: 30
stop_cover_tilt:
description: Stop all or specified cover
description: Stop all or specified cover.
fields:
entity_id:
description: Name(s) of cover(s) to stop
description: Name(s) of cover(s) to stop.
example: 'cover.living_room'

30
homeassistant/components/device_tracker/services.yaml
View file

@ -1,41 +1,33 @@
# Describes the format for available device tracker services
see:
description: Control tracked device
description: Control tracked device.
fields:
mac:
description: MAC address of device
example: 'FF:FF:FF:FF:FF:FF'
dev_id:
description: Id of device (find id in known_devices.yaml)
description: Id of device (find id in known_devices.yaml).
example: 'phonedave'
host_name:
description: Hostname of device
example: 'Dave'
location_name:
description: Name of location where device is located (not_home is away)
description: Name of location where device is located (not_home is away).
example: 'home'
gps:
description: GPS coordinates where device is located (latitude, longitude)
description: GPS coordinates where device is located (latitude, longitude).
example: '[51.509802, -0.086692]'
gps_accuracy:
description: Accuracy of GPS coordinates
description: Accuracy of GPS coordinates.
example: '80'
battery:
description: Battery level of device
description: Battery level of device.
example: '100'
icloud:
icloud_lost_iphone:
description: Service to play the lost iphone sound on an iDevice
description: Service to play the lost iphone sound on an iDevice.
fields:
account_name:
description: Name of the account in the config that will be used to look for the device. This is optional, if it isn't given it will use all accounts.
@ -43,10 +35,8 @@ icloud:
device_name:
description: Name of the device that will play the sound. This is optional, if it isn't given it will play on all devices for the given account.
example: 'iphonebart'
icloud_set_interval:
description: Service to set the interval of an iDevice
description: Service to set the interval of an iDevice.
fields:
account_name:
description: Name of the account in the config that will be used to look for the device. This is optional, if it isn't given it will use all accounts.
@ -57,10 +47,8 @@ icloud:
interval:
description: The interval (in minutes) that the iDevice will have until the according device_tracker entity changes from zone or until this service is used again. This is optional, if it isn't given the interval of the device will revert back to the original interval based on the current state.
example: 1
icloud_update:
description: Service to ask for an update of an iDevice.
fields:
account_name:
description: Name of the account in the config that will be used to look for the device. This is optional, if it isn't given it will use all accounts.
@ -68,10 +56,8 @@ icloud:
device_name:
description: Name of the device that will be updated. This is optional, if it isn't given it will update all devices for the given account.
example: 'iphonebart'
icloud_reset_account:
description: Service to restart an iCloud account. Helpful when not all devices are found after initializing or when you add a new device.
fields:
account_name:
description: Name of the account in the config that will be restarted. This is optional, if it isn't given it will restart all accounts.

24
homeassistant/components/fan/services.yaml
View file

@ -1,60 +1,51 @@
# Describes the format for available fan services
set_speed:
description: Sets fan speed
description: Sets fan speed.
fields:
entity_id:
description: Name(s) of the entities to set
example: 'fan.living_room'
speed:
description: Speed setting
example: 'low'
turn_on:
description: Turns fan on
description: Turns fan on.
fields:
entity_id:
description: Names(s) of the entities to turn on
example: 'fan.living_room'
speed:
description: Speed setting
example: 'high'
turn_off:
description: Turns fan off
description: Turns fan off.
fields:
entity_id:
description: Names(s) of the entities to turn off
example: 'fan.living_room'
oscillate:
description: Oscillates the fan
description: Oscillates the fan.
fields:
entity_id:
description: Name(s) of the entities to oscillate
example: 'fan.desk_fan'
oscillating:
description: Flag to turn on/off oscillation
example: True
toggle:
description: Toggle the fan on/off
description: Toggle the fan on/off.
fields:
entity_id:
description: Name(s) of the entities to toggle
exampl: 'fan.living_room'
set_direction:
description: Set the fan rotation direction
description: Set the fan rotation.
fields:
entity_id:
description: Name(s) of the entities to toggle
@ -64,8 +55,7 @@ set_direction:
example: 'left'
dyson_set_night_mode:
description: Set the fan in night mode
description: Set the fan in night mode.
fields:
entity_id:
description: Name(s) of the entities to enable/disable night mode

2
homeassistant/components/frontend/services.yaml
View file

@ -8,4 +8,4 @@ set_theme:
example: 'light'
reload_themes:
description: Reload themes from yaml config.
description: Reload themes from yaml configuration.

37
homeassistant/components/group/services.yaml
View file

@ -1,59 +1,50 @@
# Describes the format for available group services
reload:
description: "Reload group configuration."
description: Reload group configuration.
set_visibility:
description: Hide or show a group
description: Hide or show a group.
fields:
entity_id:
description: Name(s) of entities to set value
description: Name(s) of entities to set value.
example: 'group.travel'
visible:
description: True if group should be shown or False if it should be hidden.
example: True
set:
description: Create/Update a user group
description: Create/Update a user group.
fields:
object_id:
description: Group id and part of entity id
description: Group id and part of entity id.
example: 'test_group'
name:
description: Name of group
example: 'My test group'
view:
description: Boolean for if the group is a view
description: Boolean for if the group is a view.
example: True
icon:
description: Name of icon for the group
description: Name of icon for the group.
example: 'mdi:camera'
control:
description: Value for control the group control
description: Value for control the group control.
example: 'hidden'
visible:
description: If the group is visible on UI
description: If the group is visible on UI.
example: True
entities:
description: List of all members in the group. Not compatible with 'delta'
description: List of all members in the group. Not compatible with 'delta'.
example: domain.entity_id1, domain.entity_id2
add_entities:
description: List of members they will change on group listening.
example: domain.entity_id1, domain.entity_id2
remove:
description: Remove a user group
description: Remove a user group.
fields:
object_id:
description: Group id and part of entity id
description: Group id and part of entity id.
example: 'test_group'

7
homeassistant/components/image_processing/services.yaml
View file

@ -1,9 +1,8 @@
# Describes the format for available image_processing services
# Describes the format for available image processing services
scan:
description: Process an image immediately
description: Process an image immediately.
fields:
entity_id:
description: Name(s) of entities to scan immediately
description: Name(s) of entities to scan immediately.
example: 'image_processing.alpr_garage'

125
homeassistant/components/light/services.yaml
View file

@ -1,201 +1,160 @@
# Describes the format for available light services
turn_on:
description: Turn a light on
description: Turn a light on.
fields:
entity_id:
description: Name(s) of entities to turn on
example: 'light.kitchen'
transition:
description: Duration in seconds it takes to get to next state
example: 60
rgb_color:
description: Color for the light in RGB-format
description: Color for the light in RGB-format.
example: '[255, 100, 100]'
color_name:
description: A human readable color name
description: A human readable color name.
example: 'red'
xy_color:
description: Color for the light in XY-format
description: Color for the light in XY-format.
example: '[0.52, 0.43]'
color_temp:
description: Color temperature for the light in mireds
description: Color temperature for the light in mireds.
example: 250
kelvin:
description: Color temperature for the light in Kelvin
description: Color temperature for the light in Kelvin.
example: 4000
white_value:
description: Number between 0..255 indicating level of white
description: Number between 0..255 indicating level of white.
example: '250'
brightness:
description: Number between 0..255 indicating brightness
description: Number between 0..255 indicating brightness.
example: 120
brightness_pct:
description: Number between 0..100 indicating percentage of full brightness
description: Number between 0..100 indicating percentage of full brightness.
example: 47
profile:
description: Name of a light profile to use
description: Name of a light profile to use.
example: relax
flash:
description: If the light should flash
description: If the light should flash.
values:
- short
- long
effect:
description: Light effect
description: Light effect.
values:
- colorloop
- random
turn_off:
description: Turn a light off
description: Turn a light off.
fields:
entity_id:
description: Name(s) of entities to turn off
description: Name(s) of entities to turn off.
example: 'light.kitchen'
transition:
description: Duration in seconds it takes to get to next state
description: Duration in seconds it takes to get to next state.
example: 60
flash:
description: If the light should flash
description: If the light should flash.
values:
- short
- long
toggle:
description: Toggles a light
description: Toggles a light.
fields:
entity_id:
description: Name(s) of entities to toggle
description: Name(s) of entities to toggle.
example: 'light.kitchen'
transition:
description: Duration in seconds it takes to get to next state
description: Duration in seconds it takes to get to next state.
example: 60
hue_activate_scene:
description: Activate a hue scene stored in the hue hub
description: Activate a hue scene stored in the hue hub.
fields:
group_name:
description: Name of hue group/room from the hue app
description: Name of hue group/room from the hue app.
example: "Living Room"
scene_name:
description: Name of hue scene from the hue app
description: Name of hue scene from the hue app.
example: "Energize"
lifx_set_state:
description: Set a color/brightness and possibliy turn the light on/off
description: Set a color/brightness and possibliy turn the light on/off.
fields:
entity_id:
description: Name(s) of entities to set a state on
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
description: All turn_on parameters can be used to specify a color.
infrared:
description: Automatic infrared level (0..255) when light brightness is low
description: Automatic infrared level (0..255) when light brightness is low.
example: 255
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]'
transition:
description: Duration in seconds it takes to get to the final state
description: Duration in seconds it takes to get to the final state.
example: 10
power:
description: Turn the light on (True) or off (False). Leave out to keep the power as it is.
example: True
lifx_effect_pulse:
description: Run a flash effect by changing to a color and back.
fields:
entity_id:
description: Name(s) of entities to run the effect on
description: Name(s) of entities to run the effect on.
example: 'light.kitchen'
mode:
description: 'Decides how colors are changed. Possible values: blink, breathe, ping, strobe, solid'
description: 'Decides how colors are changed. Possible values: blink, breathe, ping, strobe, solid.'
example: strobe
brightness:
description: Number between 0..255 indicating brightness of the temporary color
description: Number between 0..255 indicating brightness of the temporary color.
example: 120
color_name:
description: A human readable color name
description: A human readable color name.
example: 'red'
rgb_color:
description: The temporary color in RGB-format
description: The temporary color in RGB-format.
example: '[255, 100, 100]'
period:
description: Duration of the effect in seconds (default 1.0)
description: Duration of the effect in seconds (default 1.0).
example: 3
cycles:
description: Number of times the effect should run (default 1.0)
description: Number of times the effect should run (default 1.0).
example: 2
power_on:
description: Powered off lights are temporarily turned on during the effect (default True)
description: Powered off lights are temporarily turned on during the effect (default True).
example: False
lifx_effect_colorloop:
description: Run an effect with looping colors.
fields:
entity_id:
description: Name(s) of entities to run the effect on
description: Name(s) of entities to run the effect on.
example: 'light.disco1, light.disco2, light.disco3'
brightness:
description: Number between 0 and 255 indicating brightness of the effect. Leave this out to maintain the current brightness of each participating light
description: Number between 0 and 255 indicating brightness of the effect. Leave this out to maintain the current brightness of each participating light.
example: 120
period:
description: Duration (in seconds) between color changes (default 60)
description: Duration (in seconds) between color changes (default 60).
example: 180
change:
description: Hue movement per period, in degrees on a color wheel (ranges from 0 to 360, default 20)
description: Hue movement per period, in degrees on a color wheel (ranges from 0 to 360, default 20).
example: 45
spread:
description: Maximum hue difference between participating lights, in degrees on a color wheel (ranges from 0 to 360, default 30)
description: Maximum hue difference between participating lights, in degrees on a color wheel (ranges from 0 to 360, default 30).
example: 0
power_on:
description: Powered off lights are temporarily turned on during the effect (default True)
description: Powered off lights are temporarily turned on during the effect (default True).
example: False
lifx_effect_stop:
description: Stop a running effect.
fields:
entity_id:
description: Name(s) of entities to stop effects on. Leave out to stop effects everywhere.

73
homeassistant/components/lock/services.yaml
View file

@ -1,86 +1,80 @@
clear_usercode:
description: Clear a usercode from lock
# Describes the format for available lock services
clear_usercode:
description: Clear a usercode from lock.
fields:
node_id:
description: Node id of the lock
description: Node id of the lock.
example: 18
code_slot:
description: Code slot to clear code from
description: Code slot to clear code from.
example: 1
get_usercode:
description: Retrieve a usercode from lock
description: Retrieve a usercode from lock.
fields:
node_id:
description: Node id of the lock
description: Node id of the lock.
example: 18
code_slot:
description: Code slot to retrieve a code from
description: Code slot to retrieve a code from.
example: 1
nuki_lock_n_go:
description: "Lock 'n' Go"
description: "Nuki Lock 'n' Go"
fields:
entity_id:
description: Entity id of the Nuki lock
description: Entity id of the Nuki lock.
example: 'lock.front_door'
unlatch:
description: Whether to unlatch the lock
description: Whether to unlatch the lock.
example: false
nuki_unlatch:
description: "Unlatch"
description: Nuki unlatch.
fields:
entity_id:
description: Entity id of the Nuki lock
description: Entity id of the Nuki lock.
example: 'lock.front_door'
lock:
description: Lock all or specified locks
description: Lock all or specified locks.
fields:
entity_id:
description: Name of lock to lock
description: Name of lock to lock.
example: 'lock.front_door'
code:
description: An optional code to lock the lock with
description: An optional code to lock the lock with.
example: 1234
set_usercode:
description: Set a usercode to lock
description: Set a usercode to lock.
fields:
node_id:
description: Node id of the lock
description: Node id of the lock.
example: 18
code_slot:
description: Code slot to set the code
description: Code slot to set the code.
example: 1
usercode:
description: Code to set
description: Code to set.
example: 1234
unlock:
description: Unlock all or specified locks
description: Unlock all or specified locks.
fields:
entity_id:
description: Name of lock to unlock
description: Name of lock to unlock.
example: 'lock.front_door'
code:
description: An optional code to unlock the lock with
description: An optional code to unlock the lock with.
example: 1234
wink_set_lock_vacation_mode:
description: Set vacation mode for all or specified locks. Disables all user codes.
fields:
entity_id:
description: Name of lock to unlock
description: Name of lock to unlock.
example: 'lock.front_door'
enabled:
description: enable or disable. true or false.
@ -88,32 +82,29 @@ wink_set_lock_vacation_mode:
wink_set_lock_alarm_mode:
description: Set alarm mode for all or specified locks.
fields:
entity_id:
description: Name of lock to unlock
description: Name of lock to unlock.
example: 'lock.front_door'
mode:
description: One of tamper, activity, or forced_entry
description: One of tamper, activity, or forced_entry.
example: tamper
wink_set_lock_alarm_sensitivity:
description: Set alarm sensitivity for all or specified locks.
fields:
entity_id:
description: Name of lock to unlock
description: Name of lock to unlock.
example: 'lock.front_door'
sensitivity:
description: One of low, medium_low, medium, medium_high, high
description: One of low, medium_low, medium, medium_high, high.
example: medium
wink_set_lock_alarm_state:
description: Set alarm state.
fields:
entity_id:
description: Name of lock to unlock
description: Name of lock to unlock.
example: 'lock.front_door'
enabled:
description: enable or disable. true or false.
@ -121,10 +112,9 @@ wink_set_lock_alarm_state:
wink_set_lock_beeper_state:
description: Set beeper state.
fields:
entity_id:
description: Name of lock to unlock
description: Name of lock to unlock.
example: 'lock.front_door'
enabled:
description: enable or disable. true or false.
@ -132,10 +122,9 @@ wink_set_lock_beeper_state:
wink_add_new_lock_key_code:
description: Add a new user key code.
fields:
entity_id:
description: Name of lock to unlock
description: Name of lock to unlock.
example: 'lock.front_door'
name:
description: name of the new key code.

115
homeassistant/components/media_player/services.yaml
View file

@ -1,121 +1,107 @@
# Describes the format for available media_player services
# Describes the format for available media player services
turn_on:
description: Turn a media player power on
description: Turn a media player power on.
fields:
entity_id:
description: Name(s) of entities to turn on
description: Name(s) of entities to turn on.
example: 'media_player.living_room_chromecast'
turn_off:
description: Turn a media player power off
description: Turn a media player power off.
fields:
entity_id:
description: Name(s) of entities to turn off
description: Name(s) of entities to turn off.
example: 'media_player.living_room_chromecast'
toggle:
description: Toggles a media player power state
description: Toggles a media player power state.
fields:
entity_id:
description: Name(s) of entities to toggle
description: Name(s) of entities to toggle.
example: 'media_player.living_room_chromecast'
volume_up:
description: Turn a media player volume up
description: Turn a media player volume up.
fields:
entity_id:
description: Name(s) of entities to turn volume up on
description: Name(s) of entities to turn volume up on.
example: 'media_player.living_room_sonos'
volume_down:
description: Turn a media player volume down
description: Turn a media player volume down.
fields:
entity_id:
description: Name(s) of entities to turn volume down on
description: Name(s) of entities to turn volume down on.
example: 'media_player.living_room_sonos'
volume_mute:
description: Mute a media player's volume
description: Mute a media player's volume.
fields:
entity_id:
description: Name(s) of entities to mute
description: Name(s) of entities to mute.
example: 'media_player.living_room_sonos'
is_volume_muted:
description: True/false for mute/unmute
description: True/false for mute/unmute.
example: true
volume_set:
description: Set a media player's volume level
description: Set a media player's volume level.
fields:
entity_id:
description: Name(s) of entities to set volume level on
description: Name(s) of entities to set volume level on.
example: 'media_player.living_room_sonos'
volume_level:
description: Volume level to set as float
description: Volume level to set as float.
example: 0.6
media_play_pause:
description: Toggle media player play/pause state
description: Toggle media player play/pause state.
fields:
entity_id:
description: Name(s) of entities to toggle play/pause state on
description: Name(s) of entities to toggle play/pause state on.
example: 'media_player.living_room_sonos'
media_play:
description: Send the media player the command for play.
fields:
entity_id:
description: Name(s) of entities to play on
description: Name(s) of entities to play on.
example: 'media_player.living_room_sonos'
media_pause:
description: Send the media player the command for pause.
fields:
entity_id:
description: Name(s) of entities to pause on
description: Name(s) of entities to pause on.
example: 'media_player.living_room_sonos'
media_stop:
description: Send the media player the stop command.
fields:
entity_id:
description: Name(s) of entities to stop on
description: Name(s) of entities to stop on.
example: 'media_player.living_room_sonos'
media_next_track:
description: Send the media player the command for next track.
fields:
entity_id:
description: Name(s) of entities to send next track command to
description: Name(s) of entities to send next track command to.
example: 'media_player.living_room_sonos'
media_previous_track:
description: Send the media player the command for previous track.
fields:
entity_id:
description: Name(s) of entities to send previous track command to
description: Name(s) of entities to send previous track command to.
example: 'media_player.living_room_sonos'
media_seek:
description: Send the media player the command to seek in current playing media.
fields:
entity_id:
description: Name(s) of entities to seek media on
description: Name(s) of entities to seek media on.
example: 'media_player.living_room_chromecast'
seek_position:
description: Position to seek to. The format is platform dependent.
@ -123,7 +109,6 @@ media_seek:
play_media:
description: Send the media player the command for playing media.
fields:
entity_id:
description: Name(s) of entities to seek media on
@ -137,10 +122,9 @@ play_media:
select_source:
description: Send the media player the command to change input source.
fields:
entity_id:
description: Name(s) of entities to change source on
description: Name(s) of entities to change source on.
example: 'media_player.media_player.txnr535_0009b0d81f82'
source:
description: Name of the source to switch to. Platform dependent.
@ -148,26 +132,23 @@ select_source:
clear_playlist:
description: Send the media player the command to clear players playlist.
fields:
entity_id:
description: Name(s) of entities to change source on
description: Name(s) of entities to change source on.
example: 'media_player.living_room_chromecast'
shuffle_set:
description: Set shuffling state
description: Set shuffling state.
fields:
entity_id:
description: Name(s) of entities to set
description: Name(s) of entities to set.
example: 'media_player.spotify'
shuffle:
description: True/false for enabling/disabling shuffle
description: True/false for enabling/disabling shuffle.
example: true
snapcast_snapshot:
description: Take a snapshot of the media player.
fields:
entity_id:
description: Name(s) of entities that will be snapshotted. Platform dependent.
@ -175,7 +156,6 @@ snapcast_snapshot:
snapcast_restore:
description: Restore a snapshot of the media player.
fields:
entity_id:
description: Name(s) of entities that will be restored. Platform dependent.
@ -183,19 +163,16 @@ snapcast_restore:
sonos_join:
description: Group player together.
fields:
master:
description: Entity ID of the player that should become the coordinator of the group.
example: 'media_player.living_room_sonos'
entity_id:
description: Name(s) of entities that will coordinate the grouping. Platform dependent.
example: 'media_player.living_room_sonos'
sonos_unjoin:
description: Unjoin the player from a group.
fields:
entity_id:
description: Name(s) of entities that will be unjoined from their group. Platform dependent.
@ -203,42 +180,36 @@ sonos_unjoin:
sonos_snapshot:
description: Take a snapshot of the media player.
fields:
entity_id:
description: Name(s) of entities that will be snapshot. Platform dependent.
example: 'media_player.living_room_sonos'
with_group:
description: True (default) or False. Snapshot with all group attributes.
example: 'true'
sonos_restore:
description: Restore a snapshot of the media player.
fields:
entity_id:
description: Name(s) of entities that will be restored. Platform dependent.
example: 'media_player.living_room_sonos'
with_group:
description: True (default) or False. Restore with all group attributes.
example: 'true'
sonos_set_sleep_timer:
description: Set a Sonos timer
description: Set a Sonos timer.
fields:
entity_id:
description: Name(s) of entities that will have a timer set.
example: 'media_player.living_room_sonos'
sleep_time:
description: Number of seconds to set the timer
description: Number of seconds to set the timer.
example: '900'
sonos_clear_sleep_timer:
description: Clear a Sonos timer
description: Clear a Sonos timer.
fields:
entity_id:
description: Name(s) of entities that will have the timer cleared.
@ -246,49 +217,44 @@ sonos_clear_sleep_timer:
soundtouch_play_everywhere:
description: Play on all Bose Soundtouch devices
description: Play on all Bose Soundtouch devices.
fields:
master:
description: Name of the master entity that will coordinate the grouping. Platform dependent. It is a shortcut for creating a multi-room zone with all devices
example: 'media_player.soundtouch_home'
soundtouch_create_zone:
description: Create a multi-room zone
description: Create a Sountouch multi-room zone.
fields:
master:
description: Name of the master entity that will coordinate the multi-room zone. Platform dependent.
example: 'media_player.soundtouch_home'
slaves:
description: Name of slaves entities to add to the new zone
description: Name of slaves entities to add to the new zone.
example: 'media_player.soundtouch_bedroom'
soundtouch_add_zone_slave:
description: Add a slave to a multi-room zone
description: Add a slave to a Sountouch multi-room zone.
fields:
master:
description: Name of the master entity that is coordinating the multi-room zone. Platform dependent.
example: 'media_player.soundtouch_home'
slaves:
description: Name of slaves entities to add to the existing zone
description: Name of slaves entities to add to the existing zone.
example: 'media_player.soundtouch_bedroom'
soundtouch_remove_zone_slave:
description: Remove a slave from the multi-room zone
description: Remove a slave from the Sounttouch multi-room zone.
fields:
master:
description: Name of the master entity that is coordinating the multi-room zone. Platform dependent.
example: 'media_player.soundtouch_home'
slaves:
description: Name of slaves entities to remove from the existing zone
description: Name of slaves entities to remove from the existing zone.
example: 'media_player.soundtouch_bedroom'
kodi_add_to_playlist:
description: Add music to the default playlist (i.e. playlistid=0).
fields:
entity_id:
description: Name(s) of the Kodi entities where to add the media.
@ -308,7 +274,6 @@ kodi_add_to_playlist:
kodi_call_method:
description: 'Call a Kodi JSONRPC API method with optional parameters. Results of the Kodi API call will be redirected in a Home Assistant event: `kodi_call_method_result`.'
fields:
entity_id:
description: Name(s) of the Kodi entities where to run the API method.

15
homeassistant/components/mqtt/services.yaml
View file

@ -1,28 +1,25 @@
publish:
description: Publish a message to an MQTT topic
# Describes the format for available MQTT services
publish:
description: Publish a message to an MQTT topic.
fields:
topic:
description: Topic to publish payload
description: Topic to publish payload.
example: /homeassistant/hello
payload:
description: Payload to publish
description: Payload to publish.
example: This is great
payload_template:
description: Template to render as payload value. Ignored if payload given.
example: "{{ states('sensor.temperature') }}"
qos:
description: Quality of Service
description: Quality of Service to use.
example: 2
values:
- 0
- 1
- 2
default: 0
retain:
description: If message should have the retain flag set.
example: true

10
homeassistant/components/notify/services.yaml
View file

@ -1,31 +1,27 @@
notify:
description: Send a notification
# Describes the format for available notification services
notify:
description: Send a notification.
fields:
message:
description: Message body of the notification.
example: The garage door has been open for 10 minutes.
title:
description: Optional title for your notification.
example: 'Your Garage Door Friend'
target:
description: An array of targets to send the notification to. Optional depending on the platform.
example: platform specific
data:
description: Extended information for notification. Optional depending on the platform.
example: platform specific
apns_register:
description: Registers a device to receive push notifications.
fields:
push_id:
description: The device token, a 64 character hex string (256 bits). The device token is provided to you by your client app, which receives the token after registering itself with the remote notification service.
example: '72f2a8633655c5ce574fdc9b2b34ff8abdfc3b739b6ceb7a9ff06c1cbbf99f62'
name:
description: A friendly name for the device (optional).
example: 'Sam''s iPhone'

8
homeassistant/components/persistent_notification/services.yaml
View file

@ -1,22 +1,18 @@
create:
description: Show a notification in the frontend
description: Show a notification in the frontend.
fields:
message:
description: Message body of the notification. [Templates accepted]
example: Please check your configuration.yaml.
title:
description: Optional title for your notification. [Optional, Templates accepted]
example: Test notification
notification_id:
description: Target ID of the notification, will replace a notification with the same Id. [Optional]
example: 1234
dismiss:
description: Remove a notification from the frontend
description: Remove a notification from the frontend.
fields:
notification_id:
description: Target ID of the notification, which should be removed. [Required]

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

@ -2,8 +2,7 @@
purge:
description: Start purge task - delete events and states older than x days, according to keep_days service data.
fields:
keep_days:
description: Number of history days to keep in database after purge. Value >= 0
description: Number of history days to keep in database after purge. Value >= 0.
example: 2

33
homeassistant/components/remote/services.yaml
View file

@ -1,56 +1,51 @@
# Describes the format for available remote services
turn_on:
description: Sends the Power On Command
description: Sends the Power On Command.
fields:
entity_id:
description: Name(s) of entities to turn on
description: Name(s) of entities to turn on.
example: 'remote.family_room'
activity:
description: Activity ID or Activity Name to start
description: Activity ID or Activity Name to start.
example: 'BedroomTV'
toggle:
description: Toggles a device
description: Toggles a device.
fields:
entity_id:
description: Name(s) of entities to toggle
description: Name(s) of entities to toggle.
example: 'remote.family_room'
turn_off:
description: Sends the Power Off Command
description: Sends the Power Off Command.
fields:
entity_id:
description: Name(s) of entities to turn off
description: Name(s) of entities to turn off.
example: 'remote.family_room'
send_command:
description: Sends a single command to a single device
description: Sends a single command to a single device.
fields:
entity_id:
description: Name(s) of entities to send command from
description: Name(s) of entities to send command from.
example: 'remote.family_room'
device:
description: Device ID to send command to
description: Device ID to send command to.
example: '32756745'
command:
description: A single command or a list of commands to send.
example: 'Play'
num_repeats:
description: An optional value that specifies the number of times you want to repeat the command(s). If not specified, the command(s) will not be repeated
description: An optional value that specifies the number of times you want to repeat the command(s). If not specified, the command(s) will not be repeated.
example: '5'
delay_secs:
description: An optional value that specifies that number of seconds you want to wait in between repeated commands. If not specified, the default of 0.4 seconds will be used
description: An optional value that specifies that number of seconds you want to wait in between repeated commands. If not specified, the default of 0.4 seconds will be used.
example: '0.75'
harmony_sync:
description: Syncs the remote's configuration
description: Syncs the remote's configuration.
fields:
entity_id:
description: Name(s) of entities to sync
description: Name(s) of entities to sync.
example: 'remote.family_room'

185
homeassistant/components/services.yaml
View file

@ -1,179 +1,139 @@
# Describes the format for available component services
foursquare:
checkin:
description: Check a user into a Foursquare venue
description: Check a user into a Foursquare venue.
fields:
venueId:
description: The Foursquare venue where the user is checking in. [Required]
example: IHR8THISVNU
eventId:
description: The event the user is checking in to. [Optional]
example: UHR8THISVNT
shout:
description: A message about your check-in. The maximum length of this field is 140 characters. [Optional]
example: There are crayons! Crayons!
mentions:
description: Mentions in your check-in. This parameter is a semicolon-delimited list of mentions. A single mention is of the form "start,end,userid", where start is the index of the first character in the shout representing the mention, end is the index of the first character in the shout after the mention, and userid is the userid of the user being mentioned. If userid is prefixed with "fbu-", this indicates a Facebook userid that is being mention. Character indices in shouts are 0-based. [Optional]
example: 5,10,HZXXY3Y;15,20,GZYYZ3Z;25,30,fbu-GZXY13Y
broadcast:
description: "Who to broadcast this check-in to. Accepts a comma-delimited list of values: private (off the grid) or public (share with friends), facebook share on facebook, twitter share on twitter, followers share with followers (celebrity mode users only), If no valid value is found, the default is public. [Optional]"
example: public,twitter
ll:
description: Latitude and longitude of the user's location. Only specify this field if you have a GPS or other device reported location for the user at the time of check-in. [Optional]
example: 33.7,44.2
llAcc:
description: Accuracy of the user's latitude and longitude, in meters. [Optional]
example: 1
alt:
description: Altitude of the user's location, in meters. [Optional]
example: 0
altAcc:
description: Vertical accuracy of the user's location, in meters.
example: 1
homematic:
virtualkey:
description: Press a virtual key from CCU/Homegear or simulate keypress
description: Press a virtual key from CCU/Homegear or simulate keypress.
fields:
address:
description: Address of homematic device or BidCoS-RF for virtual remote
description: Address of homematic device or BidCoS-RF for virtual remote.
example: BidCoS-RF
channel:
description: Channel for calling a keypress
description: Channel for calling a keypress.
example: 1
param:
description: Event to send i.e. PRESS_LONG, PRESS_SHORT
description: Event to send i.e. PRESS_LONG, PRESS_SHORT.
example: PRESS_LONG
proxy:
description: (Optional) for set a hosts value
description: (Optional) for set a hosts value.
example: Hosts name from config
set_var_value:
description: Set the name of a node.
fields:
entity_id:
description: Name(s) of homematic central to set value
description: Name(s) of homematic central to set value.
example: 'homematic.ccu2'
name:
description: Name of the variable to set
description: Name of the variable to set.
example: 'testvariable'
value:
description: New value
example: 1
set_dev_value:
description: Set a device property on RPC XML interface.
fields:
address:
description: Address of homematic device or BidCoS-RF for virtual remote
example: BidCoS-RF
channel:
description: Channel for calling a keypress
example: 1
param:
description: Event to send i.e. PRESS_LONG, PRESS_SHORT
example: PRESS_LONG
proxy:
description: (Optional) for set a hosts value
example: Hosts name from config
value:
description: New value
example: 1
reconnect:
description: Reconnect to all Homematic Hubs.
microsoft_face:
create_group:
description: Create a new person group.
fields:
name:
description: Name of the group
description: Name of the group.
example: 'family'
delete_group:
description: Delete a new person group.
fields:
name:
description: Name of the group
description: Name of the group.
example: 'family'
train_group:
description: Train a person group.
fields:
group:
description: Name of the group
example: 'family'
create_person:
description: Create a new person in the group.
fields:
name:
description: Name of the person
example: 'Hans'
group:
description: Name of the group
example: 'family'
delete_person:
description: Delete a person in the group.
fields:
name:
description: Name of the person
description: Name of the person.
example: 'Hans'
group:
description: Name of the group
description: Name of the group.
example: 'family'
face_person:
description: Add a new picture to a person.
fields:
person:
description: Name of the person
description: Name of the person.
example: 'Hans'
group:
description: Name of the group
description: Name of the group.
example: 'family'
camera_entity:
description: Camera to take a picture
description: Camera to take a picture.
example: camera.door
verisure:
capture_smartcam:
description: Capture a new image from a smartcam.
fields:
device_serial:
description: The serial number of the smartcam you want to capture an image from.
@ -182,23 +142,18 @@ verisure:
alert:
turn_off:
description: Silence alert's notifications.
fields:
entity_id:
description: Name of the alert to silence.
example: 'alert.garage_door_open'
turn_on:
description: Reset alert's notifications.
fields:
entity_id:
description: Name of the alert to reset.
example: 'alert.garage_door_open'
toggle:
description: Toggle alert's notifications.
fields:
entity_id:
description: Name of the alert to toggle.
@ -207,34 +162,26 @@ alert:
hdmi_cec:
send_command:
description: Sends CEC command into HDMI CEC capable adapter.
fields:
raw:
description: 'Raw CEC command in format "00:00:00:00" where first two digits are source and destination, second byte is command and optional other bytes are command parameters. If raw command specified, other params are ignored.'
example: '"10:36"'
src:
desctiption: 'Source of command. Could be decimal number or string with hexadeximal notation: "0x10".'
example: '12 or "0xc"'
dst:
description: 'Destination for command. Could be decimal number or string with hexadeximal notation: "0x10".'
example: '5 or "0x5"'
cmd:
description: 'Command itself. Could be decimal number or string with hexadeximal notation: "0x10".'
example: '144 or "0x90"'
att:
description: Optional parameters.
example: [0, 2]
update:
description: Update devices state from network.
volume:
description: Increase or decrease volume of system.
fields:
up:
description: Increases volume x levels.
@ -245,17 +192,14 @@ hdmi_cec:
mute:
description: Mutes audio system. Value should be on, off or toggle.
example: "toggle"
select_device:
description: Select HDMI device.
fields:
device:
description: Address of device to select. Can be entity_id, physical address or alias from confuguration.
example: '"switch.hdmi_1" or "1.1.0.0" or "01:10"'
power_on:
description: Power on all devices which supports it.
standby:
description: Standby all devices which supports it.
@ -266,14 +210,12 @@ ffmpeg:
entity_id:
description: Name(s) of entities that will start. Platform dependent.
example: 'binary_sensor.ffmpeg_noise'
stop:
description: Send a stop command to a ffmpeg based sensor.
fields:
entity_id:
description: Name(s) of entities that will stop. Platform dependent.
example: 'binary_sensor.ffmpeg_noise'
restart:
description: Send a restart command to a ffmpeg based sensor.
fields:
@ -288,34 +230,28 @@ logger:
hassio:
host_reboot:
description: Reboot host computer.
host_shutdown:
description: Poweroff host computer.
host_update:
description: Update host computer.
fields:
version:
description: Optional or it will be use the latest version.
example: '0.3'
supervisor_update:
description: Update HassIO supervisor.
fields:
version:
description: Optional or it will be use the latest version.
example: '0.3'
supervisor_reload:
description: Reload HassIO supervisor addons/updates/configs.
homeassistant_update:
description: Update HomeAssistant docker image.
fields:
version:
description: Optional or it will be use the latest version.
example: '0.40.1'
addon_install:
description: Install a HassIO docker addon.
fields:
@ -325,14 +261,12 @@ hassio:
version:
description: Optional or it will be use the latest version.
example: '0.2'
addon_uninstall:
description: Uninstall a HassIO docker addon.
fields:
addon:
description: Name of addon.
example: 'smb_config'
addon_update:
description: Update a HassIO docker addon.
fields:
@ -342,14 +276,12 @@ hassio:
version:
description: Optional or it will be use the latest version.
example: '0.2'
addon_start:
description: Start a HassIO docker addon.
fields:
addon:
description: Name of addon.
example: 'smb_config'
addon_stop:
description: Stop a HassIO docker addon.
fields:
@ -391,45 +323,42 @@ axis:
apple_tv:
apple_tv_authenticate:
description: Start AirPlay device authentication.
fields:
entity_id:
description: Name(s) of entities to authenticate with.
example: 'media_player.apple_tv'
apple_tv_scan:
description: Scan for Apple TV devices.
modbus:
write_register:
description: Write to a modbus holding register
description: Write to a modbus holding register.
fields:
unit:
description: Address of the modbus unit
description: Address of the modbus unit.
example: 21
address:
description: Address of the holding register to write to
description: Address of the holding register to write to.
example: 0
value:
description: Value to write
description: Value to write.
example: 0
write_coil:
description: Write to a modbus coil
description: Write to a modbus coil.
fields:
unit:
description: Address of the modbus unit
description: Address of the modbus unit.
example: 21
address:
description: Address of the register to read
description: Address of the register to read.
example: 0
state:
description: State to write
description: State to write.
example: false
wake_on_lan:
send_magic_packet:
description: Send a 'magic packet' to wake up a device with 'Wake-On-LAN' capabilities.
fields:
mac:
description: MAC address of the device to wake up.
@ -440,50 +369,42 @@ wake_on_lan:
knx:
group_write:
description: Turn a light on
description: Turn a light on.
fields:
address:
description: Group address(es) to write to
description: Group address(es) to write to.
example: '1/1/0'
data:
description: KNX data to send
description: KNX data to send.
example: 1
rflink:
send_command:
description: Send device command through RFLink
description: Send device command through RFLink.
fields:
device_id:
description: RFLink device ID
description: RFLink device ID.
example: 'newkaku_0000c6c2_1'
command:
description: The command to be sent
description: The command to be sent.
example: 'on'
counter:
decrement:
description: Decrement a counter.
fields:
entity_id:
description: Entity id of the counter to decrement.
example: 'counter.count0'
increment:
description: Increment a counter.
fields:
entity_id:
description: Entity id of the counter to increment.
example: 'counter.count0'
reset:
description: Reset a counter.
fields:
entity_id:
description: Entity id of the counter to reset.
@ -492,27 +413,21 @@ counter:
abode:
change_setting:
description: Change an Abode system setting.
fields:
setting:
description: Setting to change.
example: 'beeper_mute'
value:
description: Value of the setting.
example: '1'
capture_image:
description: Request a new image capture from a camera device.
fields:
entity_id:
description: Entity id of the camera to request an image.
example: 'camera.downstairs_motion_camera'
trigger_quick_action:
description: Trigger an Abode quick action.
fields:
entity_id:
description: Entity id of the quick action to trigger.
@ -520,55 +435,45 @@ abode:
input_boolean:
toggle:
description: Toggles an input boolean
description: Toggles an input boolean.
fields:
entity_id:
description: Entity id of the input boolean to toggle
description: Entity id of the input boolean to toggle.
example: 'input_boolean.notify_alerts'
turn_off:
description: Turns OFF an input boolean
description: Turns off an input boolean
fields:
entity_id:
description: Entity id of the input boolean to turn off
description: Entity id of the input boolean to turn off.
example: 'input_boolean.notify_alerts'
turn_on:
description: Turns ON an input boolean
description: Turns on an input boolean.
fields:
entity_id:
description: Entity id of the input boolean to turn on
description: Entity id of the input boolean to turn on.
example: 'input_boolean.notify_alerts'
input_number:
set_value:
description: Set the value of an input_number entity.
description: Set the value of an input number entity.
fields:
entity_id:
description: Entity id of the input_number to set the new value.
description: Entity id of the input number to set the new value.
example: 'input_number.threshold'
value:
description: The target value the entity should be set to.
example: 42
increment:
description: Increment the value of an input_number entity by its stepping.
description: Increment the value of an input number entity by its stepping.
fields:
entity_id:
description: Entity id of the input_number the should be incremented.
description: Entity id of the input number the should be incremented.
example: 'input_number.threshold'
decrement:
description: Decrement the value of an input_number entity by its stepping.
description: Decrement the value of an input number entity by its stepping.
fields:
entity_id:
description: Entity id of the input_number the should be decremented.
description: Entity id of the input number the should be decremented.
example: 'input_number.threshold'
homeassistant:
@ -584,17 +489,17 @@ homeassistant:
description: Generic service to toggle devices on/off under any domain. Same usage as the light.turn_on, switch.turn_on, etc. services.
fields:
entity_id:
description: The entity_id of the device to toggle on/off
description: The entity_id of the device to toggle on/off.
example: light.living_room
turn_on:
description: Generic service to turn devices on under any domain. Same usage as the light.turn_on, switch.turn_on, etc. services.
fields:
entity_id:
description: The entity_id of the device to turn on
description: The entity_id of the device to turn on.
example: light.living_room
turn_off:
description: Generic service to turn devices off under any domain. Same usage as the light.turn_on, switch.turn_on, etc. services.
fields:
entity_id:
description: The entity_id of the device to turn off
description: The entity_id of the device to turn off.
example: light.living_room

17
homeassistant/components/switch/services.yaml
View file

@ -1,37 +1,32 @@
# Describes the format for available switch services
turn_on:
description: Turn a switch on
description: Turn a switch on.
fields:
entity_id:
description: Name(s) of entities to turn on
example: 'switch.living_room'
turn_off:
description: Turn a switch off
description: Turn a switch off.
fields:
entity_id:
description: Name(s) of entities to turn off
description: Name(s) of entities to turn off.
example: 'switch.living_room'
toggle:
description: Toggles a switch state
description: Toggles a switch state.
fields:
entity_id:
description: Name(s) of entities to toggle
description: Name(s) of entities to toggle.
example: 'switch.living_room'
mysensors_send_ir_code:
description: Set an IR code as a state attribute for a MySensors IR device switch and turn the switch on.
fields:
entity_id:
description: Name(s) of entities that should have the IR code set and be turned on. Platform dependent.
example: 'switch.living_room_1_1'
V_IR_SEND:
description: IR code to send
description: IR code to send.
example: '0xC284'

61
homeassistant/components/telegram_bot/services.yaml
View file

@ -1,239 +1,190 @@
send_message:
description: Send a notification
# Describes the format for available Telegram bot services
send_message:
description: Send a notification.
fields:
message:
description: Message body of the notification.
example: The garage door has been open for 10 minutes.
title:
description: Optional title for your notification. Will be composed as '%title\n%message'
example: 'Your Garage Door Friend'
target:
description: An array of pre-authorized chat_ids to send the notification to. If not present, first allowed chat_id is the default.
example: '[12345, 67890] or 12345'
parse_mode:
description: "Parser for the message text: `html` or `markdown`."
example: 'html'
disable_notification:
description: Sends the message silently. iOS users and Web users will not receive a notification, Android users will receive a notification with no sound.
example: true
disable_web_page_preview:
description: Disables link previews for links in the message.
example: true
keyboard:
description: List of rows of commands, comma-separated, to make a custom keyboard.
example: '["/command1, /command2", "/command3"]'
inline_keyboard:
description: List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with asociated callback data.
example: '["/button1, /button2", "/button3"] or ["Text button1:/button1, Text button2:/button2", "Text button3:/button3"] or [[["Text button1", "/button1"], ["Text button2", "/button2"]], [["Text button3", "/button3"]]]'
send_photo:
description: Send a photo
description: Send a photo.
fields:
url:
description: Remote path to an image.
example: 'http://example.org/path/to/the/image.png'
file:
description: Local path to an image.
example: '/path/to/the/image.png'
caption:
description: The title of the image.
example: 'My image'
username:
description: Username for a URL which require HTTP basic authentication.
example: myuser
password:
description: Password for a URL which require HTTP basic authentication.
example: myuser_pwd
target:
description: An array of pre-authorized chat_ids to send the document to. If not present, first allowed chat_id is the default.
example: '[12345, 67890] or 12345'
disable_notification:
description: Sends the message silently. iOS users and Web users will not receive a notification, Android users will receive a notification with no sound.
example: true
keyboard:
description: List of rows of commands, comma-separated, to make a custom keyboard.
example: '["/command1, /command2", "/command3"]'
inline_keyboard:
description: List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with asociated callback data.
example: '["/button1, /button2", "/button3"] or [[["Text button1", "/button1"], ["Text button2", "/button2"]], [["Text button3", "/button3"]]]'
send_document:
description: Send a document
description: Send a document.
fields:
url:
description: Remote path to a document.
example: 'http://example.org/path/to/the/document.odf'
file:
description: Local path to a document.
example: '/tmp/whatever.odf'
caption:
description: The title of the document.
example: Document Title xy
username:
description: Username for a URL which require HTTP basic authentication.
example: myuser
password:
description: Password for a URL which require HTTP basic authentication.
example: myuser_pwd
target:
description: An array of pre-authorized chat_ids to send the document to. If not present, first allowed chat_id is the default.
example: '[12345, 67890] or 12345'
disable_notification:
description: Sends the message silently. iOS users and Web users will not receive a notification, Android users will receive a notification with no sound.
example: true
keyboard:
description: List of rows of commands, comma-separated, to make a custom keyboard.
example: '["/command1, /command2", "/command3"]'
inline_keyboard:
description: List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with asociated callback data.
example: '["/button1, /button2", "/button3"] or [[["Text button1", "/button1"], ["Text button2", "/button2"]], [["Text button3", "/button3"]]]'
send_location:
description: Send a location
description: Send a location.
fields:
latitude:
description: The latitude to send.
example: -15.123
longitude:
description: The longitude to send.
example: 38.123
target:
description: An array of pre-authorized chat_ids to send the location to. If not present, first allowed chat_id is the default.
example: '[12345, 67890] or 12345'
disable_notification:
description: Sends the message silently. iOS users and Web users will not receive a notification, Android users will receive a notification with no sound.
example: true
keyboard:
description: List of rows of commands, comma-separated, to make a custom keyboard.
example: '["/command1, /command2", "/command3"]'
inline_keyboard:
description: List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with asociated callback data.
example: '["/button1, /button2", "/button3"] or [[["Text button1", "/button1"], ["Text button2", "/button2"]], [["Text button3", "/button3"]]]'
edit_message:
description: Edit a previusly sent message.
fields:
message_id:
description: id of the message to edit.
example: '{{ trigger.event.data.message.message_id }}'
chat_id:
description: The chat_id where to edit the message.
example: 12345
message:
description: Message body of the notification.
example: The garage door has been open for 10 minutes.
title:
description: Optional title for your notification. Will be composed as '%title\n%message'
example: 'Your Garage Door Friend'
parse_mode:
description: "Parser for the message text: `html` or `markdown`."
example: 'html'
disable_web_page_preview:
description: Disables link previews for links in the message.
example: true
inline_keyboard:
description: List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with asociated callback data.
example: '["/button1, /button2", "/button3"] or [[["Text button1", "/button1"], ["Text button2", "/button2"]], [["Text button3", "/button3"]]]'
edit_caption:
description: Edit the caption of a previusly sent message.
fields:
message_id:
description: id of the message to edit.
example: '{{ trigger.event.data.message.message_id }}'
chat_id:
description: The chat_id where to edit the caption.
example: 12345
caption:
description: Message body of the notification.
example: The garage door has been open for 10 minutes.
inline_keyboard:
description: List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with asociated callback data.
example: '["/button1, /button2", "/button3"] or [[["Text button1", "/button1"], ["Text button2", "/button2"]], [["Text button3", "/button3"]]]'
edit_replymarkup:
description: Edit the inline keyboard of a previusly sent message.
fields:
message_id:
description: id of the message to edit.
example: '{{ trigger.event.data.message.message_id }}'
chat_id:
description: The chat_id where to edit the reply_markup.
example: 12345
inline_keyboard:
description: List of rows of commands, comma-separated, to make a custom inline keyboard with buttons with asociated callback data.
example: '["/button1, /button2", "/button3"] or [[["Text button1", "/button1"], ["Text button2", "/button2"]], [["Text button3", "/button3"]]]'
answer_callback_query:
description: Respond to a callback query originated by clicking on an online keyboard button. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert.
fields:
message:
description: Unformatted text message body of the notification.
example: "OK, I'm listening"
callback_query_id:
description: Unique id of the callback response.
example: '{{ trigger.event.data.id }}'
show_alert:
description: Show a permanent notification.
example: true
delete_message:
description: Delete a previously sent message.


fields:
message_id:
description: id of the message to delete.
example: '{{ trigger.event.data.message.message_id }}'


chat_id:
description: The chat_id where to delete the message.
example: 12345

7
homeassistant/components/tts/services.yaml
View file

@ -1,23 +1,20 @@
# Describes the format for available TTS services
say:
description: Say some things on a media player.
fields:
entity_id:
description: Name(s) of media player entities.
example: 'media_player.floor'
message:
description: Text to speak on devices.
example: 'My name is hanna'
cache:
description: Control file cache of this message.
example: 'true'
language:
description: Language to use for speech generation.
example: 'ru'
options:
description: A dictionary containing platform-specific options. Optional depending on the platform.
example: platform specific

28
homeassistant/components/vacuum/services.yaml
View file

@ -1,6 +1,7 @@
# Describes the format for available vacuum services
turn_on:
description: Start a new cleaning task.
fields:
entity_id:
description: Name of the botvac entity.
@ -8,7 +9,6 @@ turn_on:
turn_off:
description: Stop the current cleaning task and return to home.
fields:
entity_id:
description: Name of the botvac entity.
@ -16,7 +16,6 @@ turn_off:
stop:
description: Stop the current cleaning task.
fields:
entity_id:
description: Name of the botvac entity.
@ -24,7 +23,6 @@ stop:
locate:
description: Locate the vacuum cleaner robot.
fields:
entity_id:
description: Name of the botvac entity.
@ -32,7 +30,6 @@ locate:
start_pause:
description: Start, pause, or resume the cleaning task.
fields:
entity_id:
description: Name of the botvac entity.
@ -40,7 +37,6 @@ start_pause:
return_to_base:
description: Tell the vacuum cleaner to return to its dock.
fields:
entity_id:
description: Name of the botvac entity.
@ -48,7 +44,6 @@ return_to_base:
clean_spot:
description: Tell the vacuum cleaner to do a spot clean-up.
fields:
entity_id:
description: Name of the botvac entity.
@ -56,35 +51,29 @@ clean_spot:
send_command:
description: Send a raw command to the vacuum cleaner.
fields:
entity_id:
description: Name of the botvac entity.
example: 'vacuum.xiaomi_vacuum_cleaner'
command:
description: Command to execute.
example: 'set_dnd_timer'
params:
description: Parameters for the command.
example: '[22,0,6,0]'
set_fan_speed:
description: Set the fan speed of the vacuum cleaner.
fields:
entity_id:
description: Name of the botvac entity.
example: 'vacuum.xiaomi_vacuum_cleaner'
fan_speed:
description: Platform dependent vacuum cleaner fan speed, with speed steps, like 'medium', or by percentage, between 0 and 100.
example: 'low'
xiaomi_remote_control_start:
description: Start remote control of the vacuum cleaner. You can then move it with `remote_control_move`, when done call `remote_control_stop`.
fields:
entity_id:
description: Name of the botvac entity.
@ -92,7 +81,6 @@ xiaomi_remote_control_start:
xiaomi_remote_control_stop:
description: Stop remote control mode of the vacuum cleaner.
fields:
entity_id:
description: Name of the botvac entity.
@ -100,40 +88,32 @@ xiaomi_remote_control_stop:
xiaomi_remote_control_move:
description: Remote control the vacuum cleaner, make sure you first set it in remote control mode with `remote_control_start`.
fields:
entity_id:
description: Name of the botvac entity.
example: 'vacuum.xiaomi_vacuum_cleaner'
velocity:
description: Speed, between -0.29 and 0.29.
example: '0.2'
rotation:
description: Rotation, between -179 degrees and 179 degrees.
example: '90'
duration:
description: Duration of the movement?
description: Duration of the movement.
example: '1500'
xiaomi_remote_control_move_step:
description: Remote control the vacuum cleaner, only makes one move and then stops.
fields:
entity_id:
description: Name of the botvac entity.
example: 'vacuum.xiaomi_vacuum_cleaner'
velocity:
description: Speed, between -0.29 and 0.29.
example: '0.2'
rotation:
description: Rotation, between -179 degrees and 179 degrees.
example: '90'
duration:
description: Duration of the movement?
description: Duration of the movement.
example: '1500'

31
homeassistant/components/wink/services.yaml
View file

@ -1,12 +1,13 @@
# Describes the format for available Wink services
pair_new_device:
description: Pair a new device to a Wink Hub.
fields:
hub_name:
description: The name of the hub to pair a new device to.
example: 'My hub'
pairing_mode:
description: One of ["zigbee", "zwave", "zwave_exclusion", "zwave_network_rediscovery", "lutron", "bluetooth", "kidde"]
description: One of ["zigbee", "zwave", "zwave_exclusion", "zwave_network_rediscovery", "lutron", "bluetooth", "kidde"].
example: 'zigbee'
kidde_radio_code:
description: 'A string of 8 1s and 0s one for each dip switch on the kidde device left --> right = 1 --> 8'
@ -14,7 +15,6 @@ pair_new_device:
rename_wink_device:
description: Rename the provided device.
fields:
entity_id:
description: The entity_id of the device to rename.
@ -25,7 +25,6 @@ rename_wink_device:
delete_wink_device:
description: Remove/unpair device from Wink.
fields:
entity_id:
description: The entity_id of the device to delete.
@ -38,21 +37,19 @@ refresh_state_from_wink:
set_siren_volume:
description: Set the volume of the siren for a Dome siren/chime.
fields:
entity_id:
description: Name(s) of the entities to set
description: Name(s) of the entities to set.
example: 'switch.dome_siren'
volume:
description: Volume level. One of ["low", "medium", "high"]
description: Volume level. One of ["low", "medium", "high"].
example: "high"
enable_chime:
description: Enable the chime of a Dome siren with the provided sound.
fields:
entity_id:
description: Name(s) of the entities to set
description: Name(s) of the entities to set.
example: 'switch.dome_siren'
tone:
description: The tone to use for the chime. One of ["doorbell", "fur_elise", "doorbell_extended", "alert", "william_tell", "rondo_alla_turca", "police_siren", "evacuation", "beep_beep", "beep", "inactive"]
@ -60,10 +57,9 @@ enable_chime:
set_siren_tone:
description: Set the sound to use when the siren is enabled. (This doesn't enable the siren)
fields:
entity_id:
description: Name(s) of the entities to set
description: Name(s) of the entities to set.
example: 'switch.dome_siren'
tone:
description: The tone to use for the chime. One of ["doorbell", "fur_elise", "doorbell_extended", "alert", "william_tell", "rondo_alla_turca", "police_siren", "evacuation", "beep_beep", "beep", "inactive"]
@ -71,10 +67,9 @@ set_siren_tone:
siren_set_auto_shutoff:
description: How long to sound the siren before turning off.
fields:
entity_id:
description: Name(s) of the entities to set
description: Name(s) of the entities to set.
example: 'switch.dome_siren'
auto_shutoff:
description: The time in seconds to sound the siren. One of [None, -1, 30, 60, 120] (None and -1 are forever. Use None for gocontrol, and -1 for Dome)
@ -82,27 +77,24 @@ siren_set_auto_shutoff:
set_siren_strobe_enabled:
description: Enable or disable the strobe light when the siren is sounding.
fields:
entity_id:
description: Name(s) of the entities to set
description: Name(s) of the entities to set.
example: 'switch.dome_siren'
enabled:
description: "True or False"
set_chime_strobe_enabled:
description: Enable or disable the strobe light when the chime is sounding.
fields:
entity_id:
description: Name(s) of the entities to set
description: Name(s) of the entities to set.
example: 'switch.dome_siren'
enabled:
description: "True or False"
enable_siren:
description: Enable/disable the siren.
fields:
entity_id:
description: Name(s) of the entities to set
@ -112,10 +104,9 @@ enable_siren:
set_chime_volume:
description: Set the volume of the chime for a Dome siren/chime.
fields:
entity_id:
description: Name(s) of the entities to set
description: Name(s) of the entities to set.
example: 'switch.dome_siren'
volume:
description: Volume level. One of ["low", "medium", "high"]

2
homeassistant/components/zwave/services.yaml
View file

@ -1,3 +1,5 @@
# Describes the format for available Z-Wave services
change_association:
description: Change an association in the Z-Wave network.
fields: