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

Site updated at 2017-03-18 17:12:07 UTC

Browse source
This commit is contained in:
Travis CI 2017-03-18 17:12:07 +00:00
parent 7573fcba68
commit 67179bf8fe
994 changed files with 1768 additions and 68252 deletions
Download patch file Download diff file Expand all files Collapse all files

62
components/emulated_hue/index.html
View file

@ -3,17 +3,14 @@
<!--[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>Emulated Hue Bridge - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to emulated Hue Bridge within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/emulated_hue/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Emulated Hue Bridge">
<meta property="og:site_name" content="Home Assistant">
@ -21,39 +18,31 @@
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to emulated Hue Bridge 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="Emulated Hue Bridge">
<meta name="twitter:description" content="Instructions how to emulated Hue Bridge within 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="/docs/">Docs</a></li>
@ -64,49 +53,31 @@
</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">
Emulated Hue Bridge
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">emulated_hue</code> component provides a virtual Philips Hue bridge, written entirely in software, that allows services that work with the Hue API to interact with Home Assistant
entities. The driving use case behind this functionality is to allow Home Assistant to work with an Amazon Echo or Google Home with no set up cost outside of configuration changes.
The virtual bridge has the ability to turn entities on or off, or change the brightness of dimmable lights. The volume level of media players can be controlled as brightness.</p>
<p class="note">
It is recommended to assign a static IP address to the computer running Home Assistant. This is because the Amazon Echo discovers devices by IP addresses, and if the IP changes, the Echo won’t be able to control it. This is easiest done from your router, see your router’s manual for details.
</p>
<h3><a class="title-link" name="configuration" href="#configuration"></a> Configuration</h3>
<p>To enable the emulated Hue bridge, add one of the following configs to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Amazon Echo example configuration.yaml entry</span>
<span class="s">emulated_hue</span><span class="pi">:</span>
</code></pre>
</div>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Google Home example configuration.yaml entry</span>
<span class="s">emulated_hue</span><span class="pi">:</span>
<span class="s">type</span><span class="pi">:</span> <span class="s">google_home</span>
@ -114,9 +85,7 @@ The virtual bridge has the ability to turn entities on or off, or change the bri
<span class="s">listen_port</span><span class="pi">:</span> <span class="s">80</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>type</strong> (<em>Optional</em>): The type of assistant who we are emulated for. Either <code class="highlighter-rouge">alexa</code> or <code class="highlighter-rouge">google_home</code>, defaults to <code class="highlighter-rouge">alexa</code>.</li>
<li><strong>host_ip</strong> (<em>Optional</em>): The IP address that your Home Assistant installation is running on. If you do not specify this option, the component will attempt to determine the IP address on its own.</li>
@ -132,11 +101,8 @@ The virtual bridge has the ability to turn entities on or off, or change the bri
</li>
<li>
<p><strong>off_maps_to_on_domains</strong> (<em>Optional</em>): The domains that maps an “off” command to an “on” command.</p>
<p>For example, if <code class="highlighter-rouge">script</code> is included in the list, and you ask Alexa to “turn off the <em>water plants</em> script,” the command will be handled as if you asked her to turn on the script.</p>
<p>If not specified, this defaults to the following list:</p>
<ul>
<li><code class="highlighter-rouge">script</code></li>
<li><code class="highlighter-rouge">scene</code></li>
@ -156,9 +122,7 @@ The virtual bridge has the ability to turn entities on or off, or change the bri
</ul>
</li>
</ul>
<p>A full configuration sample looks like the one below.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">emulated_hue</span><span class="pi">:</span>
<span class="s">host_ip</span><span class="pi">:</span> <span class="s">192.168.1.186</span>
@ -173,9 +137,7 @@ The virtual bridge has the ability to turn entities on or off, or change the bri
<span class="pi">-</span> <span class="s">light</span>
</code></pre>
</div>
<p>With additional customization you will be able to specify the behaviour of the existing entities.</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example customization</span>
<span class="s">homeassistant</span><span class="pi">:</span>
<span class="s">customize</span><span class="pi">:</span>
@ -187,44 +149,27 @@ The virtual bridge has the ability to turn entities on or off, or change the bri
<span class="s">emulated_hue_name</span><span class="pi">:</span> <span class="s2">"</span><span class="s">back</span><span class="nv"> </span><span class="s">office</span><span class="nv"> </span><span class="s">light"</span>
</code></pre>
</div>
<p>The following are attributes that can be applied in the <code class="highlighter-rouge">customize</code> section:</p>
<ul>
<li><strong>emulated_hue</strong> (<em>Optional</em>): Whether or not the entity should be exposed by the emulated Hue bridge. The default value for this attribute is controlled by the <code class="highlighter-rouge">expose_by_default</code> option.</li>
<li><strong>emulated_hue_name</strong> (<em>Optional</em>): The name that the emulated Hue will use. The default for this is the entity’s friendly name.</li>
</ul>
<h3><a class="title-link" name="troubleshooting" href="#troubleshooting"></a> Troubleshooting</h3>
<p>You can verify that the <code class="highlighter-rouge">emulated_hue</code> component has been loaded and is responding by pointing a local browser to the following URL:</p>
<ul>
<li><code class="highlighter-rouge">http://&lt;HA IP Address&gt;:8300/description.xml</code> - This URL should return a descriptor file in the form of an XML file.</li>
<li><code class="highlighter-rouge">http://&lt;HA IP Address&gt;:8300/api/pi/lights</code> - This will return a list of devices, lights, scenes, groups, etc.. that <code class="highlighter-rouge">emulated_hue</code> is exposing to Alexa.</li>
</ul>
<p>An additional step is required to run Home Assistant as non-root user and use port 80 when using the AiO script. Execute the following command to allow <code class="highlighter-rouge">emulated_hue</code> to use port 80 as non-root user.</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code>sudo setcap <span class="s1">'cap_net_bind_service=+ep'</span> /srv/homeassistant/homeassistant_venv/bin/python3
</code></pre>
</div>
<h3><a class="title-link" name="license" href="#license"></a> License</h3>
<p>Much of this code is based on work done by Bruce Locke on his <a href="https://github.com/blocke/ha-local-echo">ha-local-echo</a> project, originally released under the MIT License. The license is located <a href="https://github.com/blocke/ha-local-echo/blob/b9bf5dcaae6d8e305e2283179ffba64bde9ed29e/LICENSE">here</a>.</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/emulated_hue.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
@ -367,13 +312,10 @@ The virtual bridge has the ability to turn entities on or off, or change the bri
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
@ -383,7 +325,6 @@ The virtual bridge has the ability to turn entities on or off, or change the bri
<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 />
@ -395,7 +336,6 @@ The virtual bridge has the ability to turn entities on or off, or change the bri
</div>
</div>
</footer>
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
@ -403,4 +343,4 @@ The virtual bridge has the ability to turn entities on or off, or change the bri
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
</body>
</html>
</html>