245 lines
No EOL
9.8 KiB
HTML
245 lines
No EOL
9.8 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 Rollershutter - Home Assistant</title>
|
||
<meta name="author" content="Paulus Schoutsen">
|
||
<meta name="description" content="Instructions how to have rollershutters call command line commands.">
|
||
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/rollershutter.command_line/">
|
||
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Command line Rollershutter">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/rollershutter.command_line/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to have rollershutters call command line commands.">
|
||
<meta property="og:image" content="https://home-assistant.io/images/home-assistant-logo-2164x2164.png">
|
||
|
||
<meta name="twitter:card" content="summary">
|
||
<meta name="twitter:site" content="@home_assistant">
|
||
|
||
<meta name="twitter:title" content="Command line Rollershutter">
|
||
<meta name="twitter:description" content="Instructions how to have rollershutters call command line commands.">
|
||
<meta name="twitter:image" content="https://home-assistant.io/images/home-assistant-logo-2164x2164.png">
|
||
|
||
<link href="/stylesheets/screen.css" media="screen, projection" 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>
|
||
<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>Getting started <i class="icon icon-caret-down"></i></a>
|
||
<ul>
|
||
<li><a href='/getting-started/'>Installing Home Assistant</a></li>
|
||
<li><a href='/getting-started/configuration/'>Configuration Basics</a></li>
|
||
<li><a href='/getting-started/devices/'>Adding devices</a></li>
|
||
<li><a href='/getting-started/presence-detection/'>Presence Detection</a></li>
|
||
<li><a href='/getting-started/automation/'>Automation</a></li>
|
||
<li><a href='/topics/'>Advanced Topics</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href='/components/'>Components</a></li>
|
||
<li><a href='/cookbook'>Examples</a></li>
|
||
<li>
|
||
<a>Developers <i class="icon icon-caret-down"></i></a>
|
||
<ul>
|
||
<li><a href="/developers/">Setup Development</a></li>
|
||
<li><a href="/developers/architecture/">Architecture</a></li>
|
||
<li><a href="/developers/frontend/">Frontend Development</a></li>
|
||
<li><a href="/developers/creating_components/">
|
||
Creating Components
|
||
</a></li>
|
||
<li><a href="/developers/add_new_platform/">
|
||
Adding Platform Support
|
||
</a></li>
|
||
<li><a href="/developers/api/">API and SSE</a></li>
|
||
<li><a href="/developers/credits/">Credits</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="/blog/">Blog</a></li>
|
||
<li><a href="/help/">Need help?</a></li>
|
||
</ul>
|
||
</nav>
|
||
</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 Rollershutter
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
|
||
|
||
<p>A rollershutter platform that issues specific commands when it is moved up, down and stopped. This might very well become our most powerful platform as it allows anyone to integrate any type of rollershutter into Home Assistant that can be controlled from the command line, including calling other scripts!</p>
|
||
|
||
<p>To enable command_rollershutter in your installation, add the following to your <code>configuration.yaml</code> file:</p>
|
||
|
||
<div class="highlighter-coderay"><div class="CodeRay">
|
||
<div class="code"><pre><span class="comment"># Example configuration.yaml entry</span>
|
||
<span class="key">rollershutter</span>:
|
||
- <span class="string"><span class="content">platform: command_line</span></span>
|
||
<span class="key">rollershutters</span>:
|
||
<span class="key">Kitchen Rollershutter</span>:
|
||
<span class="key">upcmd</span>: <span class="string"><span class="content">move_command up kitchen</span></span>
|
||
<span class="key">downcmd</span>: <span class="string"><span class="content">move_command down kitchen</span></span>
|
||
<span class="key">stopcmd</span>: <span class="string"><span class="content">move_command stop kitchen</span></span>
|
||
<span class="key">statecmd</span>: <span class="string"><span class="content">state_command kitchen</span></span>
|
||
<span class="key">value_template</span>: <span class="string"><span class="content">'{{ value }}'</span></span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
|
||
<p>Configuration variables:</p>
|
||
|
||
<ul>
|
||
<li><strong>rollershutters</strong> (<em>Required</em>): The array that contains all command rollershutters.
|
||
<ul>
|
||
<li><strong>entry</strong> (<em>Required</em>): Name of the command rollershutter. Multiple entries are possible.
|
||
<ul>
|
||
<li><strong>upcmd</strong> (<em>Required</em>): The action to take for move up.</li>
|
||
<li><strong>downcmd</strong> (<em>Required</em>): The action to take for move down.</li>
|
||
<li><strong>stopcmd</strong> (<em>Required</em>): The action to take for stop.</li>
|
||
<li><strong>statecmd</strong> (<em>Optional</em>): If given, this command will be run. Returning a result code <code>0</code> will indicate that the rollershutter is fully closed, returning a result code <code>100</code> will indicate that the rollershutter is fully open.</li>
|
||
<li><strong>value_template</strong> (<em>Optional - default: ‘{{ value }}’</em>): If specified, statecmd will ignore the result code of the command but the template evaluating will indicate the position of the rollershutter.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
|
||
</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/balloob/home-assistant.io/tree/master/source/_components/rollershutter.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'>
|
||
This is a platform for
|
||
<a href='/components/rollershutter/'>the Rollershutters 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 Rollershutter</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
Command line Rollershutter
|
||
</li>
|
||
<li>
|
||
<a href='/components/rollershutter.mqtt/'>MQTT Rollershutter</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/scene.hunterdouglas_powerview/'>PowerView Scenes</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/rollershutter.scsgate/'>SCSGate Rollershutter</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://github.com/balloob/home-assistant'><i class="icon-github"></i></a>
|
||
|
||
<div class="credit">
|
||
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>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
|
||
<!--[if lt IE 7]>
|
||
<p class="chromeframe">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> or <a href="http://www.google.com/chromeframe/?redirect=true">activate Google Chrome Frame</a> to improve your experience.</p>
|
||
<![endif]-->
|
||
|
||
<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>
|
||
|
||
</body>
|
||
</html> |