You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/_components/cover.command_line.markdown
+7-17Lines changed: 7 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -9,13 +9,12 @@ sharing: true
9
9
footer: true
10
10
logo: command_line.png
11
11
ha_category: Cover
12
+
ha_release: 0.14
12
13
---
13
-
A cover platform that issues specific commands when it is moved up, down and
14
-
stopped. It allows anyone to integrate any type of cover into Home Assistant
15
-
that can be controlled from the command line.
16
14
17
-
To enable a command line cover in your installation, add the following to your
18
-
`configuration.yaml` file:
15
+
A `command_line`cover platform that issues specific commands when it is moved up, down and stopped. It allows anyone to integrate any type of cover into Home Assistant that can be controlled from the command line.
16
+
17
+
To enable a command line cover in your installation, add the following to your `configuration.yaml` file:
19
18
20
19
```yaml
21
20
# Example configuration.yaml entry
@@ -39,18 +38,9 @@ cover:
39
38
Configuration variables:
40
39
41
40
- **covers** (*Required*): The array that contains all command line covers.
42
-
- **entry** (*Required*): Name of the command line cover. Multiple entries
43
-
are possible.
41
+
- **entry** (*Required*): Name of the command line cover. Multiple entries are possible.
44
42
- **open_cmd** (*Required*): The command to open the cover.
45
43
- **close_cmd** (*Required*): The action to close the cover.
46
44
- **stop_cmd** (*Required*): The action to stop the cover.
47
-
- **state_cmd** (*Optional*): If given, this will act as a sensor that runs
48
-
in the background and updates the state of the cover. If the command
49
-
returns a `0` the indicates the cover is fully closed, whereas a 100
50
-
indicates the cover is fully open.
51
-
- **value_template** (*optional - default: '{% raw %}{{ value }}{% endraw
52
-
%}'*): if specified, `state_cmd` will ignore the result code of the
53
-
command but the template evaluating will indicate the position of the
54
-
cover. For example, if your `state_cmd` returns a string "open",
55
-
using `value_template` as in the example config above will allow you to
56
-
translate that into the valid state `100`.
45
+
- **state_cmd** (*Optional*): If given, this will act as a sensor that runs in the background and updates the state of the cover. If the command returns a `0` the indicates the cover is fully closed, whereas a 100 indicates the cover is fully open.
46
+
- **value_template** (*optional - default: '{% raw %}{{ value }}{% endraw%}'*): if specified, `state_cmd` will ignore the result code of the command but the template evaluating will indicate the position of the cover. For example, if your `state_cmd` returns a string "open", using `value_template` as in the example config above will allow you to translate that into the valid state `100`.
0 commit comments