291 lines
14 KiB
HTML
291 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>Raspberry Pi Cover - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to setup the Raspberry Pi covers within Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/cover.rpi_gpio/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Raspberry Pi Cover">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/cover.rpi_gpio/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to setup the Raspberry Pi covers within Home Assistant.">
|
||
<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="Raspberry Pi Cover">
|
||
<meta name="twitter:description" content="Instructions how to setup the Raspberry Pi covers within Home Assistant.">
|
||
<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">
|
||
Raspberry Pi Cover
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>The <code class="highlighter-rouge">rpi_gpio</code> cover platform allows you to use a Raspberry Pi to control your cover such as Garage doors.</p>
|
||
<p>It uses two pins on the Raspberry Pi.</p>
|
||
<ul>
|
||
<li>The <code class="highlighter-rouge">state_pin</code> will detect if the cover is closed, and</li>
|
||
<li>the <code class="highlighter-rouge">relay_pin</code> will trigger the cover to open or close.</li>
|
||
</ul>
|
||
<p>Although you do not need Andrews Hilliday’s software controller when you run Home Assistant, he has written clear instructions on how to hook your garage door and sensors up to your Raspberry Pi, which can be found <a href="https://github.com/andrewshilliday/garage-door-controller#hardware-setup">here</a>.</p>
|
||
<p>To enable Raspberry Pi Covers 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">rpi_gpio</span>
|
||
<span class="s">covers</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">relay_pin</span><span class="pi">:</span> <span class="s">10</span>
|
||
<span class="s">state_pin</span><span class="pi">:</span> <span class="s">11</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Configuration variables:</p>
|
||
<ul>
|
||
<li><strong>relay_time</strong> (<em>Optional</em>): The time that the relay will be on for in seconds. Default is 0.2 seconds.</li>
|
||
<li><strong>invert_relay</strong> (<em>Optional</em>): Invert the relay pin output so that it is active-high. Default is False (active-low).</li>
|
||
<li><strong>state_pull_mode</strong> (<em>Optional</em>): The direction the State pin is pulling. It can be UP or DOWN. Default is UP.</li>
|
||
<li><strong>invert_state</strong> (<em>Optional</em>): Invert the value of the State pin so that 0 means closed. Default is False.</li>
|
||
<li><strong>covers</strong> array (<em>Required</em>): List of your doors.
|
||
<ul>
|
||
<li><strong>relay_pin</strong> (<em>Required</em>): The pin of your Raspberry Pi where the relay is connected.</li>
|
||
<li><strong>state_pin</strong> (<em>Required</em>): The pin of your Raspberry Pi to retrieve the state.</li>
|
||
<li><strong>name</strong> (<em>Optional</em>): Name to use in the frontend.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<p>Full example:</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">rpi_gpio</span>
|
||
<span class="s">relay_time</span><span class="pi">:</span> <span class="s">0.2</span>
|
||
<span class="s">invert_relay</span><span class="pi">:</span> <span class="s">False</span>
|
||
<span class="s">state_pull_mode</span><span class="pi">:</span> <span class="s1">'</span><span class="s">UP'</span>
|
||
<span class="s">invert_state</span><span class="pi">:</span> <span class="s">True</span>
|
||
<span class="s">covers</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">relay_pin</span><span class="pi">:</span> <span class="s">10</span>
|
||
<span class="s">state_pin</span><span class="pi">:</span> <span class="s">11</span>
|
||
<span class="pi">-</span> <span class="s">relay_pin</span><span class="pi">:</span> <span class="s">12</span>
|
||
<span class="s">state_pin</span><span class="pi">:</span> <span class="s">13</span>
|
||
<span class="s">name</span><span class="pi">:</span> <span class="s1">'</span><span class="s">Right</span><span class="nv"> </span><span class="s">door'</span>
|
||
</code></pre>
|
||
</div>
|
||
<h2><a class="title-link" name="remote-raspberry-pi-cover" href="#remote-raspberry-pi-cover"></a> Remote Raspberry Pi Cover</h2>
|
||
<p>If you don’t have Home Assistant running on your Raspberry Pi and you want to use it as a remote cover instead, there is a project called <a href="https://github.com/Jerrkawz/GarageQTPi">GarageQTPi</a> that will work remotely with the <a href="/components/cover.mqtt/">MQTT Cover Component</a>. Follow the Github instructions to install and configure GarageQTPi and once configured follow the Home Assistant instructions to configure the MQTT Cover.</p>
|
||
</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.rpi_gpio.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/raspberry-pi.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 Push
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.23
|
||
</div>
|
||
<div class='section'>
|
||
Source:
|
||
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/cover/rpi_gpio.py'>cover/rpi_gpio.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/rpi_gpio/'>
|
||
Raspberry PI GPIO
|
||
</a></li>
|
||
<li><a href='/components/binary_sensor.rpi_gpio/'>
|
||
Raspberry PI GPIO Binary Sensor
|
||
</a></li>
|
||
<li><a href='/components/switch.rpi_gpio/'>
|
||
Raspberry PI GPIO 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>
|
||
<a href='/components/cover.command_line/'>Command Line Cover</a>
|
||
</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.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/scene.hunterdouglas_powerview/'>PowerView Scenes</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/cover.rflink/'>RFLink Cover</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/cover.rfxtrx/'>RFXtrx Cover</a>
|
||
</li>
|
||
<li>
|
||
Raspberry Pi Cover
|
||
</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/sensor.tahoma/'>Tahoma Sensor</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>
|