jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/sun.html
Paulus Schoutsen adcde053bb Site updated at 2015-10-27 04:59:24 UTC
2015-10-26 21:59:24 -07:00

2338 lines
No EOL
20 KiB
HTML
Raw Blame History

<!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>Sun - Home Assistant</title>
<meta name="author" content="Paulus Schoutsen">
<meta name="description" content="Instructions how to track the sun within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sun.html">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Sun">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sun.html/">
<meta property="og:type" content="website">
<meta property="og:description" content="Instructions how to track the sun within Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/home-assistant-logo-2164x2164.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='/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>
<ul>
<li><a href='/getting-started/'>Installing Home Assistant</a></li>
<li><a href='/getting-started/configuration.html'>Configuration basics</a></li>
<li><a href='/getting-started/devices.html'>Adding devices</a></li>
<li><a href='/getting-started/presence-detection.html'>Presence detection</a></li>
<li><a href='/getting-started/automation.html'>Automation</a></li>
<li><a href='/cookbook'>Configuration cookbook</a></li>
</ul>
</li>
<li><a href='/components/'>Components</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">API</a></li>
<li><a href="/developers/credits.html">Credits</a></li>
</ul>
</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">
Sun
</h1>
</header>
<hr class="divider">
<p>The <code>sun</code> component will use your current location to track if the sun is above or below the horizon.
The sun can be used within automation as <a href="/components/automation.html#sun-trigger">a trigger with an optional offset to simulate dawn/dusk</a>.</p>
<pre><code class="yaml"># Example configuration.yaml entry
homeassistant:
latitude: 32.87336
longitude: -117.22743
sun:
elevation: 123
</code></pre>
<p>Configuration variables:</p>
<ul>
<li><strong>elevation</strong> (<em>Optional</em>): The solar elevation angle is the altitude of the sun. If ommitted will be retrieved from Google Maps.</li>
</ul>
<p class='img'>
<img src='/images/screenshots/more-info-dialog-sun.png' />
</p>
<h3><a class='title-link' name='implementation-details' href='#implementation-details'></a> Implementation Details</h3>
<p>The suns event listener will call the service when the sun rises or sets with an offset.</p>
<p>The sun event need to have the type &lsquo;sun&rsquo;, which service to call, which event (sunset or sunrise) and the offset.</p>
<pre><code class="json">{
"type": "sun",
"service": "switch.turn_on",
"event": "sunset",
"offset": "-01:00:00"
}
</code></pre>
<h4><a class='title-link' name='maintains-entity-sunsun' href='#maintains-entity-sunsun'></a> Maintains entity <code>sun.sun</code></h4>
<table>
<thead>
<tr>
<th> Possible state </th>
<th> Description </th>
</tr>
</thead>
<tbody>
<tr>
<td> <code>above_horizon</code> </td>
<td> When the sun is above the horizon.</td>
</tr>
<tr>
<td> <code>below_horizon</code> </td>
<td> When the sun is below the horizon.</td>
</tr>
</tbody>
</table>
<table>
<thead>
<tr>
<th> State Attributes </th>
<th> Description </th>
</tr>
</thead>
<tbody>
<tr>
<td> <code>next_rising</code> </td>
<td> Date and time of the next sun rising</td>
</tr>
<tr>
<td> <code>next_setting</code> </td>
<td> Date and time of the next sun setting</td>
</tr>
</tbody>
</table>
</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='brand-logo-container section'>
</div>
<div class='section'>
<h1 class="title delta">Category Weather</h1>
<ul class='divided'>
<li>
<a href='/components/sensor.forecast.html'>Forecast.io</a>
</li>
<li>
<a href='/components/sensor.openweathermap.html'>OpenWeatherMap</a>
</li>
<li>
Sun
</li>
</ul>
</div>
</section>
</div>
</aside>
</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>
Reference in a new issue View git blame Copy permalink