277 lines
No EOL
9.2 KiB
HTML
277 lines
No EOL
9.2 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>Components - Home Assistant</title>
|
|
<meta name="author" content="Paulus Schoutsen">
|
|
|
|
<meta name="description" content="List of the built-in components of Home Assistant.">
|
|
|
|
<meta name="viewport" content="width=device-width">
|
|
<link rel="canonical" href="https://home-assistant.io">
|
|
|
|
<meta property="fb:app_id" content="338291289691179">
|
|
<meta property="og:title" content="Components">
|
|
<meta property="og:site_name" content="Home Assistant">
|
|
<meta property="og:url" content="https://home-assistant.io/components/">
|
|
<meta property="og:type" content="website">
|
|
<meta property="og:description" content="List of the built-in components of Home Assistant.">
|
|
|
|
|
|
|
|
<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='/images/favicon-192x192.png'> Home Assistant
|
|
</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="/developers/">Developers</a>
|
|
<ul>
|
|
<li><a href="/developers/architecture.html">Architecture</a></li>
|
|
<li><a href="/developers/frontend.html">Frontend development</a></li>
|
|
<li><a href="/developers/creating_components.html">
|
|
Creating components
|
|
</a></li>
|
|
<li><a href="/developers/add_new_platform.html">
|
|
Adding platform support
|
|
</a></li>
|
|
<li><a href="/developers/api.html">Rest API</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="/blog/">Blog</a></li>
|
|
<li><a href="https://groups.google.com/forum/#!forum/home-assistant-dev">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">
|
|
Components
|
|
</h1>
|
|
</header>
|
|
<hr class="divider">
|
|
|
|
|
|
<h3>sun</h3>
|
|
|
|
<p>Tracks the state of the sun and when the next sun rising and setting will occur.</p>
|
|
|
|
<p>Depends on: config variables common/latitude and common/longitude</p>
|
|
|
|
<ul>
|
|
<li>Maintains state of <code>weather.sun</code> including attributes <code>next_rising</code> and <code>next_setting</code></li>
|
|
</ul>
|
|
|
|
|
|
<h3>device_tracker</h3>
|
|
|
|
<p>Keeps track of which devices are currently home.</p>
|
|
|
|
<ul>
|
|
<li>Sets the state per device and maintains a combined state called <code>all_devices</code>.</li>
|
|
<li>Keeps track of known devices in the file <code>config/known_devices.csv</code>.</li>
|
|
</ul>
|
|
|
|
|
|
<p>Supported platforms:</p>
|
|
|
|
<ul>
|
|
<li><code>netgear</code> for Netgear routers that support their SOAP API</li>
|
|
<li><code>luci</code> for routers running OpenWRT</li>
|
|
<li><code>tomato</code> for routers running Tomato</li>
|
|
<li><code>nmap</code> for using nmap to scan IP ranges on the network</li>
|
|
</ul>
|
|
|
|
|
|
<h3>light</h3>
|
|
|
|
<p>Keeps track which lights are turned on and can control the lights. It has <a href="https://github.com/balloob/home-assistant/blob/master/homeassistant/components/light/light_profiles.csv">4 built-in light profiles</a> which you’re able to extend by putting a light_profiles.csv file in your config dir.</p>
|
|
|
|
<ul>
|
|
<li>Maintains a state per light and a combined state <code>all_light</code>.</li>
|
|
<li>Registers services <code>light/turn_on</code> and <code>light/turn_off</code> to control the lights.</li>
|
|
</ul>
|
|
|
|
|
|
<p>Optional service data:</p>
|
|
|
|
<ul>
|
|
<li><code>entity_id</code> - only act on specified lights. Else targets all.</li>
|
|
<li><code>transition_seconds</code> - seconds to take to switch to new state.</li>
|
|
<li><code>profile</code> - which light profile to use.</li>
|
|
<li><code>xy_color</code> - two comma seperated floats that represent the color in XY</li>
|
|
<li><code>rgb_color</code> - three comma seperated integers that represent the color in RGB</li>
|
|
<li><code>brightness</code> - integer between 0 and 255 for how bright the color should be</li>
|
|
<li><code>flash</code> - tell light to flash, can be either value <code>short</code> or <code>long</code></li>
|
|
</ul>
|
|
|
|
|
|
<p>Supported platforms:</p>
|
|
|
|
<ul>
|
|
<li><code>hue</code> for Philips Hue</li>
|
|
</ul>
|
|
|
|
|
|
<h3>switch</h3>
|
|
|
|
<p>Keeps track which switches are in the network, their state and allows you to control them.</p>
|
|
|
|
<ul>
|
|
<li>Maintains a state per switch and a combined state <code>all_switches</code>.</li>
|
|
<li>Registers services <code>switch/turn_on</code> and <code>switch/turn_off</code> to control switches.</li>
|
|
</ul>
|
|
|
|
|
|
<p>Optional service data:</p>
|
|
|
|
<ul>
|
|
<li><code>entity_id</code> - only act on specific switch. Else targets all.</li>
|
|
</ul>
|
|
|
|
|
|
<p>Supported platforms:</p>
|
|
|
|
<ul>
|
|
<li><code>wemo</code> for Belkin WeMo switches</li>
|
|
<li><code>tellstick</code> for Tellstick switches</li>
|
|
</ul>
|
|
|
|
|
|
<h3>device_sun_light_trigger</h3>
|
|
|
|
<p>Turns lights on or off using a light control component based on state of the sun and devices that are home.</p>
|
|
|
|
<p>Depends on: light control, track_sun, device_tracker</p>
|
|
|
|
<ul>
|
|
<li>Turns lights off when all devices leave home.</li>
|
|
<li>Turns lights on when a device is home while sun is setting.</li>
|
|
<li>Turns lights on when a device gets home after sun set.</li>
|
|
</ul>
|
|
|
|
|
|
<h3>chromecast</h3>
|
|
|
|
<p>Registers 7 services to control playback on a Chromecast: <code>turn_off</code>, <code>volume_up</code>, <code>volume_down</code>, <code>media_play_pause</code>, <code>media_play</code>, <code>media_pause</code>, <code>media_next_track</code>.</p>
|
|
|
|
<p>Registers three services to start playing YouTube video’s on the ChromeCast.</p>
|
|
|
|
<p>Service <code>chromecast/play_youtube_video</code> starts playing the specified video on the YouTube app on the ChromeCast. Specify video using <code>video</code> in service_data.</p>
|
|
|
|
<p>Service <code>chromecast/start_fireplace</code> will start a YouTube movie simulating a fireplace and the <code>chromecast/start_epic_sax</code> service will start playing Epic Sax Guy 10h version.</p>
|
|
|
|
<h3>keyboard</h3>
|
|
|
|
<p>Registers services that will simulate key presses on the keyboard. It currently offers the following Buttons as a Service (BaaS): <code>keyboard/volume_up</code>, <code>keyboard/volume_down</code> and <code>keyboard/media_play_pause</code>
|
|
This actor depends on: PyUserInput</p>
|
|
|
|
<h3>downloader</h3>
|
|
|
|
<p>Registers service <code>downloader/download_file</code> that will download files. File to download is specified in the <code>url</code> field in the service data.</p>
|
|
|
|
<h3>browser</h3>
|
|
|
|
<p>Registers service <code>browser/browse_url</code> that opens <code>url</code> as specified in event_data in the system default browser.</p>
|
|
|
|
<h3>tellstick_sensor</h3>
|
|
|
|
<p>Shows the values of that sensors that is connected to your Tellstick.</p>
|
|
|
|
<h3>simple_alarm</h3>
|
|
|
|
<p>Will provide simple alarm functionality. Will flash a light shortly if a known device comes home. Will flash the lights red if the lights turn on while no one is home.</p>
|
|
|
|
<p>Depends on device_tracker, light.</p>
|
|
|
|
<p>Config options:
|
|
known_light: entity id of the light/light group to target to flash when a known device comes home
|
|
unknown_light: entity if of the light/light group to target when a light is turned on while no one is at home.</p>
|
|
|
|
|
|
</article>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="grid-wrapper">
|
|
<div class="grid">
|
|
<div class="grid__item">
|
|
<p class="copyright">
|
|
<span class="credit">Powered by <a href="http://octopress.org">Octopress</a>, <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>. Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.</span>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</footer>
|
|
|
|
<!--[if lt IE 7]>
|
|
<p class="chromeframe">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> or <a href="http://www.google.com/chromeframe/?redirect=true">activate Google Chrome Frame</a> to improve your experience.</p>
|
|
<![endif]-->
|
|
|
|
|
|
|
|
|
|
<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> |