293 lines
14 KiB
HTML
293 lines
14 KiB
HTML
<!doctype html>
|
||
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
|
||
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
|
||
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||
<title>Command Line Cover - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="How to control a cover with the command line.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/cover.command_line/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Command Line Cover">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/cover.command_line/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="How to control a cover with the command line.">
|
||
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
|
||
<meta name="twitter:card" content="summary_large_image">
|
||
<meta name="twitter:site" content="@home_assistant">
|
||
<meta name="twitter:title" content="Command Line Cover">
|
||
<meta name="twitter:description" content="How to control a cover with the command line.">
|
||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||
<link href="/stylesheets/screen.css" media="screen, projection, print" rel="stylesheet">
|
||
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
|
||
<link rel='shortcut icon' href='/images/favicon.ico' />
|
||
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
|
||
</head>
|
||
<body >
|
||
<header class='site-header'>
|
||
<div class="grid-wrapper">
|
||
<div class="grid">
|
||
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
|
||
<a href="/" class="site-title">
|
||
<img width='40' src='/demo/favicon-192x192.png'>
|
||
<span>Home Assistant</span>
|
||
</a>
|
||
</div>
|
||
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
|
||
<nav>
|
||
<input type="checkbox" id="toggle">
|
||
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
|
||
<ul class="menu pull-right">
|
||
<li><a href="/getting-started/">Getting started</a></li>
|
||
<li><a href="/components/">Components</a></li>
|
||
<li><a href="/docs/">Docs</a></li>
|
||
<li><a href="/cookbook/">Examples</a></li>
|
||
<li><a href="/developers/">Developers</a></li>
|
||
<li><a href="/blog/">Blog</a></li>
|
||
<li><a href="/help/">Need help?</a></li>
|
||
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
|
||
</ul>
|
||
</nav>
|
||
<div class='search-container' style='display: none'>
|
||
<div class='search'>
|
||
<i class="icon-search"></i>
|
||
<input id='search' placeholder='Search the docs…'>
|
||
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</header>
|
||
<div class="grid-wrapper">
|
||
<div class="grid grid-center">
|
||
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
|
||
<article class="page">
|
||
<header>
|
||
<h1 class="title indent">
|
||
Command Line Cover
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>A <code class="highlighter-rouge">command_line</code>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.</p>
|
||
<p>To enable a command line cover in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
||
<span class="s">cover</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">command_line</span>
|
||
<span class="s">covers</span><span class="pi">:</span>
|
||
<span class="s">garage_door</span><span class="pi">:</span>
|
||
<span class="s">command_open</span><span class="pi">:</span> <span class="s">move_command up garage</span>
|
||
<span class="s">command_close</span><span class="pi">:</span> <span class="s">move_command down garage</span>
|
||
<span class="s">command_stop</span><span class="pi">:</span> <span class="s">move_command stop garage</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Configuration variables:</p>
|
||
<ul>
|
||
<li><strong>covers</strong> (<em>Required</em>): The array that contains all command line covers.
|
||
<ul>
|
||
<li><strong>identifier</strong> (<em>Required</em>): Name of the command line cover as slug. Multiple entries are possible.
|
||
<ul>
|
||
<li><strong>command_open</strong> (<em>Required</em>): The command to open the cover.</li>
|
||
<li><strong>command_close</strong> (<em>Required</em>): The action to close the cover.</li>
|
||
<li><strong>command_stop</strong> (<em>Required</em>): The action to stop the cover.</li>
|
||
<li><strong>command_state</strong> (<em>Optional</em>): 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 <code class="highlighter-rouge">0</code> the indicates the cover is fully closed, whereas a 100 indicates the cover is fully open.</li>
|
||
<li><strong>value_template</strong> (<em>optional - default: ‘{{ value }}’</em>): if specified, <code class="highlighter-rouge">command_state</code> will ignore the result code of the command but the template evaluating will indicate the position of the cover. For example, if your <code class="highlighter-rouge">command_state</code> returns a string “open”, using <code class="highlighter-rouge">value_template</code> as in the example config above will allow you to translate that into the valid state <code class="highlighter-rouge">100</code>.</li>
|
||
<li><strong>friendly_name</strong> (<em>Optional</em>): The name used to display the cover in the frontend.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2><a class="title-link" name="examples" href="#examples"></a> Examples</h2>
|
||
<p>In this section you find some real life examples of how to use this sensor.</p>
|
||
<h3><a class="title-link" name="full-configuration" href="#full-configuration"></a> Full configuration</h3>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
||
<span class="s">cover</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">command_line</span>
|
||
<span class="s">covers</span><span class="pi">:</span>
|
||
<span class="s">garage_door</span><span class="pi">:</span>
|
||
<span class="s">command_open</span><span class="pi">:</span> <span class="s">move_command up garage</span>
|
||
<span class="s">command_close</span><span class="pi">:</span> <span class="s">move_command down garage</span>
|
||
<span class="s">command_stop</span><span class="pi">:</span> <span class="s">move_command stop garage</span>
|
||
<span class="s">command_state</span><span class="pi">:</span> <span class="s">state_command garage</span>
|
||
<span class="s">value_template</span><span class="pi">:</span> <span class="pi">></span>
|
||
<span class="no">{% if value == 'open' %}</span>
|
||
<span class="no">100</span>
|
||
<span class="no">{% elif value == 'closed' %}</span>
|
||
<span class="no">0</span>
|
||
<span class="no">{% endif %}</span>
|
||
|
||
</code></pre>
|
||
</div>
|
||
</article>
|
||
</div>
|
||
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
|
||
<div class="grid">
|
||
<section class="aside-module grid__item one-whole lap-one-half">
|
||
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/cover.command_line.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/command_line.png' />
|
||
</div>
|
||
<div class='section'>
|
||
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Local Polling
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.14
|
||
</div>
|
||
<div class='section'>
|
||
Source:
|
||
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/cover/command_line.py'>cover/command_line.py</a>
|
||
</div>
|
||
<div class='section'>
|
||
This is a platform for
|
||
<a href='/components/cover/'>the Covers component</a>.
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class='title delta'>Related components</h1>
|
||
<ul class='divided'>
|
||
<li><a href='/components/binary_sensor.command_line/'>
|
||
Command line Binary Sensor
|
||
</a></li>
|
||
<li><a href='/components/notify.command_line/'>
|
||
Command line Notify
|
||
</a></li>
|
||
<li><a href='/components/sensor.command_line/'>
|
||
Command line Sensor
|
||
</a></li>
|
||
<li><a href='/components/switch.command_line/'>
|
||
Command line Switch
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category Cover</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/cover.abode/'>Abode Cover</a>
|
||
</li>
|
||
<li>
|
||
Command Line Cover
|
||
</li>
|
||
<li>
|
||
<a href='/components/cover.garadget/'>Garadget Cover</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/cover.homematic/'>Homematic Cover</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/cover.isy994/'>ISY994 Cover</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/cover.knx/'>KNX Cover</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/cover.lutron_caseta/'>Lutron Caseta Cover</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/cover.lutron/'>Lutron Cover</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/cover.mqtt/'>MQTT Cover</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/cover.myq/'>MyQ Cover</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/cover.mysensors/'>MySensors Cover</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/cover.opengarage/'>OpenGarage Cover</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/cover.rflink/'>RFLink Cover</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/cover.rfxtrx/'>RFXtrx Cover</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/cover.rpi_gpio/'>Raspberry Pi Cover</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/cover.scsgate/'>SCSGate Cover</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/cover.tahoma/'>Tahoma Cover</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/cover.tellstick/'>TellStick Cover</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/cover.template/'>Template Cover</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/cover.vera/'>Vera Cover</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/cover.wink/'>Wink Cover</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/cover.xiaomi_aqara/'>Xiaomi Cover</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/cover.zwave/'>Z-Wave Cover</a>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</aside>
|
||
</div>
|
||
</div>
|
||
<footer>
|
||
<div class="grid-wrapper">
|
||
<div class="grid">
|
||
<div class="grid__item">
|
||
<div class="copyright">
|
||
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
|
||
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
|
||
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
|
||
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
|
||
<div class="credit">
|
||
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a> (no support!).<br>
|
||
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
|
||
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
|
||
</div>
|
||
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
<script>
|
||
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
|
||
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
|
||
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
|
||
s.parentNode.insertBefore(g,s)}(document,'script'));
|
||
</script>
|
||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
|
||
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
|
||
<script type="text/javascript">
|
||
docsearch({
|
||
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
|
||
indexName: 'home-assistant',
|
||
inputSelector: '#search',
|
||
debug: false // Set debug to true if you want to inspect the dropdown
|
||
});
|
||
document.querySelector('.search .close').addEventListener('click', function(ev) {
|
||
ev.preventDefault();
|
||
document.querySelector('.search-container').style.display = 'none';
|
||
});
|
||
document.querySelector('.show-search').addEventListener('click', function(ev) {
|
||
ev.preventDefault();
|
||
document.querySelector('.search-container').style.display = 'block';
|
||
document.getElementById('toggle').checked = false;
|
||
document.querySelector('.search-container input').focus();
|
||
});
|
||
</script>
|
||
</body>
|
||
</html>
|