jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/upnp/index.html
Travis CI b8845607d4 Site updated at 2016-07-30 21:23:25 UTC
2016-07-30 21:23:25 +00:00

222 lines
No EOL
7.3 KiB
HTML
Raw Blame History

<!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>UPnP - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Automatically creates port mappings on your router for Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/upnp/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="UPnP">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/upnp/">
<meta property="og:type" content="article">
<meta property="og:description" content="Automatically creates port mappings on your router for 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="UPnP">
<meta name="twitter:description" content="Automatically creates port mappings on your router for Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.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 href='/getting-started/'>Getting started</a></li>
<li><a href='/components/'>Components</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>
</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">
UPnP
</h1>
</header>
<hr class="divider">
<p>The <code>upnp</code> component automatically creates port forwarding mappings on your router for Home Assistant. UPnP or NAT-PMP needs to be enabled on your router for this component to work.</p>
<h1>Installation</h1>
<p>You need to install <a href="https://github.com/miniupnp/miniupnp/tree/master/miniupnpc">miniupnpc</a> before using the UPnP component:</p>
<div class="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre>$ git clone https://github.com/miniupnp/miniupnp.git
$ cd miniupnp/miniupnpc
$ make
$ make pythonmodule3
$ sudo make installpythonmodule3
</pre></div>
</div>
</div>
<h1>Configuration</h1>
<div class="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre><span class="comment"># Example configuration.yaml entry</span>
<span class="key">upnp</span>:
</pre></div>
</div>
</div>
<p>A port mapping will be created using the IP address and port that Home Assistant is running on. The mapping will never automatically expire. Upon stopping Home Assistant, the mapping will be removed from your router.</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.io/tree/master/source/_components/upnp.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
</div>
<div class='section'>
Introduced in release: 0.18
</div>
<div class='section'>
<h1 class="title delta">Category Other</h1>
<ul class='divided'>
<li>
<a href='/components/browser/'>Browser</a>
</li>
<li>
<a href='/components/configurator/'>Configurator</a>
</li>
<li>
<a href='/components/demo/'>Demo platforms</a>
</li>
<li>
<a href='/components/discovery/'>Discovery</a>
</li>
<li>
<a href='/components/downloader/'>Downloader</a>
</li>
<li>
<a href='/components/feedreader/'>Feedreader</a>
</li>
<li>
<a href='/components/http/'>HTTP</a>
</li>
<li>
<a href='/components/introduction/'>Introduction</a>
</li>
<li>
<a href='/components/logger/'>Logger</a>
</li>
<li>
<a href='/components/mqtt_eventstream/'>MQTT Eventstream</a>
</li>
<li>
<a href='/components/persistent_notification/'>Persistent notification</a>
</li>
<li>
UPnP
</li>
<li>
<a href='/components/updater/'>Updater</a>
</li>
<li>
<a href='/components/weblink/'>Weblink</a>
</li>
<li>
<a href='/components/zeroconf/'>Zeroconf/Avahi/Bonjour</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>.<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>
</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>
</body>
</html>
Reference in a new issue View git blame Copy permalink