jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Site updated at 2017-07-02 00:58:35 UTC

Browse source
This commit is contained in:
Travis CI 2017-07-02 00:58:35 +00:00
parent af9e56ffa0
commit 00a0f63427
651 changed files with 11395 additions and 2155 deletions
Download patch file Download diff file Expand all files Collapse all files

37
components/upnp/index.html
View file

@ -8,7 +8,7 @@
<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="description" content="Internet Gateway Device (IGD) Protocol 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">
@ -16,12 +16,12 @@
<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:description" content="Internet Gateway Device (IGD) Protocol 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:description" content="Internet Gateway Device (IGD) Protocol 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">
@ -74,21 +74,21 @@
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">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>
<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="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>git clone https://github.com/miniupnp/miniupnp.git
<span class="gp">$ </span><span class="nb">cd </span>miniupnp/miniupnpc
<span class="gp">$ </span>make
<span class="gp">$ </span>make pythonmodule3
<span class="gp">$ </span>sudo make installpythonmodule3
</code></pre>
</div>
<p>The <code class="highlighter-rouge">upnp</code> component enables you to collect network statistics from your router such as bytes in/out and packets in/out. This information is provided by the Internet Gateway Device (IGD) Protocol if enabled on your router.</p>
<p>The IGD can also automatically create port forwarding mappings on your router for Home Assistant.</p>
<p>Please note that UPnP or NAT-PMP needs to be enabled on your router for this component to work.</p>
<p>To integrate this into Home Assistant, add the following section 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">upnp</span><span class="pi">:</span>
</code></pre>
</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>
<p>If you which to have the statistics without having port mapping done through IGD, add the option:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry with port mapping disabled </span>
<span class="s">upnp</span><span class="pi">:</span>
<span class="s">port_mapping</span><span class="pi">:</span> <span class="s">false</span>
</code></pre>
</div>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
@ -100,6 +100,14 @@
</div>
<div class='section'>
Introduced in release: 0.18
</div>
<div class='section'>
<h1 class='title delta'>Related components</h1>
<ul class='divided'>
<li><a href='/components/sensor.upnp/'>
UPNP Sensor
</a></li>
</ul>
</div>
<div class='section'>
<h1 class="title delta">Category Other</h1>
@ -129,7 +137,7 @@
<a href='/components/http/'>HTTP</a>
</li>
<li>
<a href='/components/ha/'>Home Assistant 0.47</a>
<a href='/components/ha/'>Home Assistant 0.48</a>
</li>
<li>
<a href='/components/introduction/'>Introduction</a>
@ -149,6 +157,9 @@
<li>
<a href='/components/plant/'>Plant monitor</a>
</li>
<li>
<a href='/components/sensor.upnp/'>UPNP Sensor</a>
</li>
<li>
UPnP
</li>