jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/discovery/index.html
Travis CI 933563f0be Site updated at 2017-06-17 20:00:42 UTC
2017-06-17 20:00:42 +00:00

238 lines
12 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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>Discovery - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to setup Home Assistant to discover new devices.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/discovery/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Discovery">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/discovery/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to setup Home Assistant to discover new devices.">
<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="Discovery">
<meta name="twitter:description" content="Instructions how to setup Home Assistant to discover new devices.">
<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="/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>
</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">
Discovery
</h1>
</header>
<hr class="divider">
<p>Home Assistant can discover and automatically configure zeroconf/mDNS and uPnP devices on your network. Currently the <code class="highlighter-rouge">discovery</code> component can detect:</p>
<ul>
<li>Google Chromecast</li>
<li>Belkin WeMo switches</li>
<li>Philips Hue</li>
<li>Netgear routers</li>
<li>Plex media server</li>
<li>Panasonic Viera</li>
<li>Roku media player</li>
<li>Sonos Speakers</li>
<li>Yamaha media player</li>
<li>Logitech media server (Squeezebox)</li>
<li>DirecTV</li>
<li>Apple TV</li>
<li>Yeelight Sunflower Bulb</li>
<li>Flux Led/MagicLight</li>
<li>Linn / Openhome</li>
<li>Denon Network Receivers</li>
<li>Bose Soundtouch speakers</li>
<li>Axis Communications security devices</li>
<li>IKEA Trådfri (Tradfri)</li>
</ul>
<p>It will be able to add Google Chromecasts and Belkin WeMo switches automatically, for Philips Hue it will require some configuration from the user.</p>
<p>To load this component, add the following lines to your <code class="highlighter-rouge">configuration.yaml</code>:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">discovery</span><span class="pi">:</span>
<span class="s">ignore</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">sonos</span>
<span class="pi">-</span> <span class="s">samsung_tv</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>ignore</strong> (<em>Optional</em>): A list of platforms that never will be automatically configured by <code class="highlighter-rouge">discovery</code>.</li>
</ul>
<p>Valid values for ignore are:</p>
<ul>
<li><code class="highlighter-rouge">apple_tv</code>: Apple TV</li>
<li><code class="highlighter-rouge">axis</code>: (Axis Communications security devices)</li>
<li><code class="highlighter-rouge">denonavr</code>: Denon Network Receivers</li>
<li><code class="highlighter-rouge">directv</code>: DirecTV</li>
<li><code class="highlighter-rouge">flux_led</code>: Flux Led/MagicLight</li>
<li><code class="highlighter-rouge">google_cast</code>: Google Chromecast</li>
<li><code class="highlighter-rouge">ikea_tradfri</code>: IKEA Trådfri</li>
<li><code class="highlighter-rouge">logitech_mediaserver</code>: Logitech media server - Squeezebox player</li>
<li><code class="highlighter-rouge">openhome</code>: Linn / Openhome</li>
<li><code class="highlighter-rouge">panasonic_viera</code>: Panasonic Viera</li>
<li><code class="highlighter-rouge">philips_hue</code>: Philips Hue</li>
<li><code class="highlighter-rouge">plex_mediaserver</code>: Plex media server</li>
<li><code class="highlighter-rouge">roku</code>: Roku media player</li>
<li><code class="highlighter-rouge">samsung_tv</code>: (Samsung TV</li>
<li><code class="highlighter-rouge">sonos</code>: Sonos Speakers</li>
<li><code class="highlighter-rouge">yamaha</code>: Yamaha media player</li>
<li><code class="highlighter-rouge">yeelight</code>: Yeelight Sunflower Bulb</li>
</ul>
<p class="note">
Home Assistant must be on the same network as the devices for uPnP discovery to work.
If running Home Assistant in a Docker container use switch <code class="highlighter-rouge">--net=host</code> to put it on the host’s network.
</p>
<p>If you are developing a new platform, please read <a href="/developers/add_new_platform/#discovery">how to make your platform discoverable</a>.</p>
<p class="note warning">
There is currently a <a href="https://bitbucket.org/al45tair/netifaces/issues/17/dll-fails-to-load-windows-81-64bit">known issue</a> with running this platform on a 64-bit version of Python and Windows.
</p>
<p class="note">
If you are on Windows and you’re using Python 3.5, download the Netifaces dependency <a href="http://www.lfd.uci.edu/~gohlke/pythonlibs/#netifaces">here</a>.
</p>
<p class="note">
If you see <code class="highlighter-rouge">Not initializing discovery because could not install dependency netdisco==0.6.1</code> in the logs, you will need to install the <code class="highlighter-rouge">python3-dev</code> or <code class="highlighter-rouge">python3-devel</code> package on your system manually (eg. <code class="highlighter-rouge">sudo apt-get install python3-dev</code> or <code class="highlighter-rouge">sudo dnf -y install python3-devel</code>). On the next restart of home-assistant, discovery should work. If you still get an error, check if you have a compiler (<code class="highlighter-rouge">gcc</code>) available on your system.
</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/discovery.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/home-assistant.png' />
</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/config/'>Config</a>
</li>
<li>
<a href='/components/configurator/'>Configurator</a>
</li>
<li>
<a href='/components/demo/'>Demo platforms</a>
</li>
<li>
Discovery
</li>
<li>
<a href='/components/feedreader/'>Feedreader</a>
</li>
<li>
<a href='/components/frontend/'>Frontend</a>
</li>
<li>
<a href='/components/http/'>HTTP</a>
</li>
<li>
<a href='/components/ha/'>Home Assistant 0.47</a>
</li>
<li>
<a href='/components/introduction/'>Introduction</a>
</li>
<li>
<a href='/components/keyboard_remote/'>Keyboard Remote</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>
<a href='/components/plant/'>Plant monitor</a>
</li>
<li>
<a href='/components/upnp/'>UPnP</a>
</li>
<li>
<a href='/components/updater/'>Updater</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> (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>
</body>
</html>
Reference in a new issue View git blame Copy permalink