From 3dcf4c126b4b5ad8b0ad332a2691369f4a361a8e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?MishManners=C2=AE=E2=84=A2?= <36594527+mishmanners@users.noreply.github.com> Date: Tue, 26 Oct 2021 22:04:46 +1100 Subject: [PATCH] Update config for scenes (#19605) Co-authored-by: Franck Nijhof --- source/_docs/scene.markdown | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/source/_docs/scene.markdown b/source/_docs/scene.markdown index c2ede2d14ca..5ecd08c9f1c 100644 --- a/source/_docs/scene.markdown +++ b/source/_docs/scene.markdown @@ -27,9 +27,19 @@ scene: state: "on" ``` +## How to configure your scene + +In the scene you define in your YAML files, please ensure you use +all required parameters as listed below. + +```yaml {% configuration %} -name: - description: Friendly name of scene. +name: + description: Friendly name of the scene. + required: true + type: string +description: + description: Description of the scene. required: true type: string entities: @@ -37,6 +47,7 @@ entities: required: true type: list {% endconfiguration %} +``` As you can see, there are two ways to define the states of each `entity_id`: