355 lines
15 KiB
HTML
355 lines
15 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>Hyperion - Home Assistant</title>
|
|
<meta name="author" content="Home Assistant">
|
|
<meta name="description" content="Instructions how to integrate Hyperion into Home Assistant.">
|
|
<meta name="viewport" content="width=device-width">
|
|
<link rel="canonical" href="https://home-assistant.io/components/light.hyperion/">
|
|
<meta property="fb:app_id" content="338291289691179">
|
|
<meta property="og:title" content="Hyperion">
|
|
<meta property="og:site_name" content="Home Assistant">
|
|
<meta property="og:url" content="https://home-assistant.io/components/light.hyperion/">
|
|
<meta property="og:type" content="article">
|
|
<meta property="og:description" content="Instructions how to integrate Hyperion into 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="Hyperion">
|
|
<meta name="twitter:description" content="Instructions how to integrate Hyperion into Home Assistant.">
|
|
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
|
<link href="/stylesheets/screen.css" media="screen, projection, print" 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 class='site-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>
|
|
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
|
|
</ul>
|
|
</nav>
|
|
<div class='search-container' style='display: none'>
|
|
<div class='search'>
|
|
<i class="icon-search"></i>
|
|
<input id='search' placeholder='Search the docs…'>
|
|
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
|
|
</div>
|
|
</div>
|
|
</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">
|
|
Hyperion
|
|
</h1>
|
|
</header>
|
|
<hr class="divider">
|
|
<p>The <code class="highlighter-rouge">hyperion</code> platform allows you to integrate your <a href="https://hyperion-project.org/wiki">Hyperion</a> into Home Assistant. Hyperion is an open source Ambilight implementation which runs on many platforms.</p>
|
|
<p>To use your Hyperion light in your installation, add the following 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">light</span><span class="pi">:</span>
|
|
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">hyperion</span>
|
|
<span class="s">host</span><span class="pi">:</span> <span class="s">IP_ADDRESS</span>
|
|
</code></pre>
|
|
</div>
|
|
<p>Configuration variables:</p>
|
|
<ul>
|
|
<li><strong>host</strong> (<em>Required</em>): The IP address of the device the Hyperion service is running on.</li>
|
|
<li><strong>port</strong> (<em>Optional</em>): The port used to communicate with the Hyperion service. Defaults to <code class="highlighter-rouge">19444</code>.</li>
|
|
<li><strong>name</strong> (<em>Optional</em>): The name of the device used in the frontend.</li>
|
|
<li><strong>priority</strong> (<em>Optional</em>): The priority of the Hyperion instance. Defaults to <code class="highlighter-rouge">128</code>.</li>
|
|
<li><strong>hdmi_priority</strong> (<em>Optional</em>): The priority of the HDMI grabber of this Hyperion instance, note that this priority must be higher than all other priorities used for correct behavior. Defaults to <code class="highlighter-rouge">880</code>.</li>
|
|
<li><strong>default_color</strong> (<em>Optional</em>): The color of the light. Defaults to <code class="highlighter-rouge">[255, 255, 255]</code>.</li>
|
|
<li><strong>effect_list</strong> (<em>Optional</em>): The list of effects that can be used. Defaults to <code class="highlighter-rouge">['HDMI', 'Cinema brighten lights', 'Cinema dim lights', 'Knight rider', 'Blue mood blobs', 'Cold mood blobs', 'Full color mood blobs', 'Green mood blobs', 'Red mood blobs', 'Warm mood blobs', 'Police Lights Single', 'Police Lights Solid', 'Rainbow mood', 'Rainbow swirl fast', 'Rainbow swirl', 'Random', 'Running dots', 'System Shutdown', 'Snake', 'Sparks Color', 'Sparks', 'Strobe blue', 'Strobe Raspbmc', 'Strobe white', 'Color traces', 'UDP multicast listener', 'UDP listener', 'X-Mas']</code>.</li>
|
|
</ul>
|
|
</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/light.hyperion.markdown'>Edit this page on GitHub</a></div>
|
|
<div class='brand-logo-container section'>
|
|
<img src='/images/supported_brands/hyperion.png' />
|
|
</div>
|
|
<div class='section'>
|
|
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Local Polling
|
|
</div>
|
|
<div class='section'>
|
|
Introduced in release: 0.7.6
|
|
</div>
|
|
<div class='section'>
|
|
Source:
|
|
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/light/hyperion.py'>light/hyperion.py</a>
|
|
</div>
|
|
<div class='section'>
|
|
This is a platform for
|
|
<a href='/components/light/'>the Lights component</a>.
|
|
</div>
|
|
<div class='section'>
|
|
<h1 class="title delta">Category Light</h1>
|
|
<ul class='divided'>
|
|
<li>
|
|
<a href='/components/light.ads/'>ADS Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.abode/'>Abode Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.avion/'>Avi-on</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.wemo/'>Belkin WeMo Lights</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.blinksticklight/'>Blinkstick</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.blinkt/'>Blinkt!</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.enocean/'>EnOcean Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.flux_led/'>Flux Led/MagicLight</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.greenwave/'>Greenwave Reality (TCP Connected) Lights</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.hive/'>Hive Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.homematic/'>Homematic Light</a>
|
|
</li>
|
|
<li>
|
|
Hyperion
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.ihc/'>IHC Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.tradfri/'>IKEA Trådfri lights</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.isy994/'>ISY994 Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.insteon_local/'>Insteon (Local) Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.insteon_hub/'>Insteon Hub Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.insteon_plm/'>Insteon PLM Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.knx/'>KNX Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.lifx/'>LIFX</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.decora/'>Leviton Decora</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.decora_wifi/'>Leviton Decora Wi-Fi</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.limitlessled/'>LimitlessLED</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.litejet/'>LiteJet Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.lutron_caseta/'>Lutron Caseta Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.lutron/'>Lutron Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.mqtt_json/'>MQTT JSON Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.mqtt/'>MQTT Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.mqtt_template/'>MQTT Template Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.mochad/'>Mochad Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.mysensors/'>MySensors Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.osramlightify/'>Osram Lightify</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.rpi_gpio_pwm/'>PWM LED</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.hue/'>Philips Hue Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.piglow/'>Piglow</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.qwikswitch/'>QwikSwitch Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.rflink/'>RFLink Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.rfxtrx/'>RFXtrx Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.scsgate/'>SCSGate Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.sensehat/'>Sense HAT Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.skybell/'>Skybell Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.tplink/'>TP-Link Bulb</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.tellstick/'>TellStick Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.template/'>Template Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.tikteck/'>Tikteck</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.velbus/'>Velbus lights</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.vera/'>Vera Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.wink/'>Wink Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.x10/'>X10</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.xiaomi_aqara/'>Xiaomi Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.xiaomi_miio/'>Xiaomi Philips Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.yeelightsunflower/'>Yeelight Sunflower Bulb</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.yeelight/'>Yeelight Wifi Bulb</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.zwave/'>Z-Wave Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.zengge/'>Zengge</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.zha/'>ZigBee Home Automation Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.zigbee/'>ZigBee Light</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.deconz/'>deCONZ lights</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.iglo/'>iGlo</a>
|
|
</li>
|
|
<li>
|
|
<a href='/components/light.mystrom/'>myStrom WiFi Bulb</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>
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
|
|
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
|
|
<script type="text/javascript">
|
|
docsearch({
|
|
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
|
|
indexName: 'home-assistant',
|
|
inputSelector: '#search',
|
|
debug: false // Set debug to true if you want to inspect the dropdown
|
|
});
|
|
document.querySelector('.search .close').addEventListener('click', function(ev) {
|
|
ev.preventDefault();
|
|
document.querySelector('.search-container').style.display = 'none';
|
|
});
|
|
document.querySelector('.show-search').addEventListener('click', function(ev) {
|
|
ev.preventDefault();
|
|
document.querySelector('.search-container').style.display = 'block';
|
|
document.getElementById('toggle').checked = false;
|
|
document.querySelector('.search-container input').focus();
|
|
});
|
|
</script>
|
|
</body>
|
|
</html>
|