mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-17 23:56:49 +00:00
48 lines
2.0 KiB
Markdown
48 lines
2.0 KiB
Markdown
---
|
|
layout: page
|
|
title: "Command Line Cover"
|
|
description: "How to control a cover with the command line."
|
|
date: 2016-06-28 17:30
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: command_line.png
|
|
ha_category: Cover
|
|
ha_release: 0.14
|
|
ha_iot_class: "Local Polling"
|
|
---
|
|
|
|
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.
|
|
|
|
To enable a command line cover in your installation, add the following to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
cover:
|
|
- platform: command_line
|
|
covers:
|
|
Garage door:
|
|
opencmd: move_command up kitchen
|
|
closecmd: move_command down kitchen
|
|
stopcmd: move_command stop kitchen
|
|
statecmd: state_command kitchen
|
|
value_template: {% raw %}>
|
|
{% if value == 'open' %}
|
|
100
|
|
{% elif value == 'closed' %}
|
|
0
|
|
{% endif %}
|
|
{% endraw %}
|
|
```
|
|
|
|
Configuration variables:
|
|
|
|
- **covers** (*Required*): The array that contains all command line covers.
|
|
- **entry** (*Required*): Name of the command line cover. Multiple entries are possible.
|
|
- **opencmd** (*Required*): The command to open the cover.
|
|
- **closecmd** (*Required*): The action to close the cover.
|
|
- **stopcmd** (*Required*): The action to stop the cover.
|
|
- **statecmd** (*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.
|
|
- **value_template** (*optional - default: '{% raw %}{{ value }}{% endraw%}'*): if specified, `statecmd` will ignore the result code of the command but the template evaluating will indicate the position of the cover. For example, if your `statecmd` returns a string "open", using `value_template` as in the example config above will allow you to translate that into the valid state `100`.
|