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

Template: cover: add description and type (#38785)

Browse Source
This commit is contained in:
c0ffeeca7 2025-04-28 15:52:49 +02:00 committed by GitHub
parent 9777a7e106
commit 67229a02f0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 49 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
source/_integrations/template.markdown
View File

@ -296,52 +296,55 @@ button:
required: true required: true
type: action type: action
cover: cover:
state: description: Characteristics of a cover
description: Defines a template to get the state of the cover. Valid output values from the template are `open`, `opening`, `closing` and `closed` which are directly mapped to the corresponding states. In addition, `true` is valid as a synonym to `open` and `false` as a synonym to `closed`. If [both a `value_template` and a `position_template`](#combining-value_template-and-position_template) are specified, only `opening` and `closing` are set from the `value_template`. If the template produces a `None` value the state will be set to `unknown`. type: map
required: false keys:
type: template state:
position: description: Defines a template to get the state of the cover. Valid output values from the template are `open`, `opening`, `closing` and `closed` which are directly mapped to the corresponding states. In addition, `true` is valid as a synonym to `open` and `false` as a synonym to `closed`. If [both a `value_template` and a `position_template`](#combining-value_template-and-position_template) are specified, only `opening` and `closing` are set from the `value_template`. If the template produces a `None` value the state will be set to `unknown`.
description: Defines a template to get the position of the cover. Legal values are numbers between `0` (closed) and `100` (open). If the template produces a `None` value the current position will be set to `unknown`. required: false
required: false type: template
type: template position:
device_class: description: Defines a template to get the position of the cover. Legal values are numbers between `0` (closed) and `100` (open). If the template produces a `None` value the current position will be set to `unknown`.
description: Sets the [class of the device](/integrations/cover/), changing the device state and icon that is displayed on the frontend. required: false
required: false type: template
type: string device_class:
open_cover: description: Sets the [class of the device](/integrations/cover/), changing the device state and icon that is displayed on the frontend.
description: Defines an action to open the cover. If [`open_cover`](#open_cover) is specified, [`close_cover`](#close_cover) must also be specified. At least one of [`open_cover`](#open_cover) and [`set_cover_position`](#set_cover_position) must be specified. required: false
required: inclusive type: string
type: action open_cover:
close_cover: description: Defines an action to open the cover. If [`open_cover`](#open_cover) is specified, [`close_cover`](#close_cover) must also be specified. At least one of [`open_cover`](#open_cover) and [`set_cover_position`](#set_cover_position) must be specified.
description: Defines an action to close the cover. required: inclusive
required: inclusive type: action
type: action close_cover:
stop_cover: description: Defines an action to close the cover.
description: Defines an action to stop the cover. required: inclusive
required: false type: action
type: action stop_cover:
set_cover_position: description: Defines an action to stop the cover.
description: Defines an action to set to a cover position (between `0` and `100`). The variable `position` will contain the entity's set position. required: false
required: false type: action
type: action set_cover_position:
set_cover_tilt_position: description: Defines an action to set to a cover position (between `0` and `100`). The variable `position` will contain the entity's set position.
description: Defines an action to set the tilt of a cover (between `0` and `100`). The variable `tilt` will contain the entity's set tilt position. required: false
required: false type: action
type: action set_cover_tilt_position:
optimistic: description: Defines an action to set the tilt of a cover (between `0` and `100`). The variable `tilt` will contain the entity's set tilt position.
description: Force cover position to use [optimistic mode](#optimistic-mode). required: false
required: false type: action
type: boolean optimistic:
default: false description: Force cover position to use [optimistic mode](#optimistic-mode).
tilt_optimistic: required: false
description: Force cover tilt position to use [optimistic mode](#optimistic-mode). type: boolean
required: false default: false
type: boolean tilt_optimistic:
default: false description: Force cover tilt position to use [optimistic mode](#optimistic-mode).
tilt: required: false
description: Defines a template to get the tilt state of the cover. Legal values are numbers between `0` (closed) and `100` (open). If the template produces a `None` value, the current tilt state will be set to `unknown`. type: boolean
required: false default: false
type: template tilt:
description: Defines a template to get the tilt state of the cover. Legal values are numbers between `0` (closed) and `100` (open). If the template produces a `None` value, the current tilt state will be set to `unknown`.
required: false
type: template
image: image:
description: List of images description: List of images
required: true required: true