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

Add line breaks to services.yaml example (#1737)

Browse Source
This commit is contained in:
Erik Montnemery 2023-04-03 10:38:46 +02:00 committed by GitHub
parent ceb1a21633
commit 7c7f895419
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/dev_101_services.md
View File

@ -77,7 +77,14 @@ set_speed:
name: Set speed name: Set speed
# Description of the service # Description of the service
description: Sets fan speed. description: Sets fan speed.
# If the service accepts entity IDs, target allows the user to specify entities by entity, device, or area. If `target` is specified, `entity_id` should not be defined in the `fields` map. By default it shows only targets matching entities from the same domain as the service, but if further customization is required, target supports the entity, device, and area selectors (https://www.home-assistant.io/docs/blueprint/selectors/). Entity selector parameters will automatically be applied to device and area, and device selector parameters will automatically be applied to area. # If the service accepts entity IDs, target allows the user to specify entities by
# entity, device, or area. If `target` is specified, `entity_id` should not be
# defined in the `fields` map. By default it shows only targets matching entities
# from the same domain as the service, but if further customization is required,
# target supports the entity, device, and area selectors
# (https://www.home-assistant.io/docs/blueprint/selectors/). Entity selector
# parameters will automatically be applied to device and area, and device selector
# parameters will automatically be applied to area.
target: target:
# Different fields that your service accepts # Different fields that your service accepts
fields: fields:
@ -89,13 +96,15 @@ set_speed:
description: Speed setting description: Speed setting
# Whether or not field is required (default = false) # Whether or not field is required (default = false)
required: true required: true
# Advanced fields are only shown when the advanced mode is enabled for the user (default = false) # Advanced fields are only shown when the advanced mode is enabled for the user
# (default = false)
advanced: true advanced: true
# Example value that can be passed for this field # Example value that can be passed for this field
example: "low" example: "low"
# The default field value # The default field value
default: "high" default: "high"
# Selector (https://www.home-assistant.io/docs/blueprint/selectors/) to control the input UI for this field # Selector (https://www.home-assistant.io/docs/blueprint/selectors/) to control
# the input UI for this field
selector: selector:
select: select:
options: options: