home-assistant.github.io/components/zeroconf/index.html
2017-04-08 23:38:08 +00:00

194 lines
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>Zeroconf/Avahi/Bonjour - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Exposes Home Assistant using the Zeroconf protocol.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/zeroconf/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Zeroconf/Avahi/Bonjour">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/zeroconf/">
<meta property="og:type" content="article">
<meta property="og:description" content="Exposes Home Assistant using the Zeroconf protocol.">
<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="Zeroconf/Avahi/Bonjour">
<meta name="twitter:description" content="Exposes Home Assistant using the Zeroconf protocol.">
<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">
Zeroconf/Avahi/Bonjour
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">zeroconf</code> component exposes your Home Assistant to the local network using <a href="https://en.wikipedia.org/wiki/Zero-configuration_networking">Zeroconf</a>. Zeroconf is also sometimes known as Bonjour, Rendezvous and Avahi.</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">zeroconf</span><span class="pi">:</span>
</code></pre>
</div>
<p>The registration will include metadata about the Home Assistant instance, including a base URL that can be used to access Home Assistant, the currently running Home Assistant version, and whether an API password is needed to access the instance. The examples below show two ways to retrieve the details for testing.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>avahi-browse -alr
+ eth0 IPv4 Home _home-assistant._tcp <span class="nb">local</span>
<span class="o">=</span> eth0 IPv4 Home _home-assistant._tcp <span class="nb">local
</span>hostname <span class="o">=</span> <span class="o">[</span>Home._home-assistant._tcp.local]
address <span class="o">=</span> <span class="o">[</span>192.168.0.70]
port <span class="o">=</span> <span class="o">[</span>8123]
txt <span class="o">=</span> <span class="o">[</span><span class="s2">"base_url=http://192.168.0.70:8123"</span> <span class="s2">"requires_api_password=true"</span> <span class="s2">"version=0.41.0"</span><span class="o">]</span>
</code></pre>
</div>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>avahi-discover
Browsing domain <span class="s1">'local'</span> on -1.-1 ...
Browsing <span class="k">for </span>services of <span class="nb">type</span> <span class="s1">'_home-assistant._tcp'</span> <span class="k">in </span>domain <span class="s1">'local'</span> on 4.0 ...
Found service <span class="s1">'Home'</span> of <span class="nb">type</span> <span class="s1">'_home-assistant._tcp'</span> <span class="k">in </span>domain <span class="s1">'local'</span> on 4.0.
Service data <span class="k">for </span>service <span class="s1">'Home'</span> of <span class="nb">type</span> <span class="s1">'_home-assistant._tcp'</span> <span class="k">in </span>domain <span class="s1">'local'</span> on 4.0:
Host Home._home-assistant._tcp.local <span class="o">(</span>192.168.0.70<span class="o">)</span>, port 8123, TXT data:
<span class="o">[</span><span class="s1">'requires_api_password=true'</span>, <span class="s1">'base_url=http://192.168.0.70:8123'</span>, <span class="s1">'version=0.41.0'</span><span class="o">]</span>
</code></pre>
</div>
</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/zeroconf.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/avahi.png' />
</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/config/'>Config</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/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.42</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/upnp/'>UPnP</a>
</li>
<li>
<a href='/components/updater/'>Updater</a>
</li>
<li>
Zeroconf/Avahi/Bonjour
</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>
<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>