296 lines
13 KiB
HTML
296 lines
13 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>Sun - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<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/">
|
||
<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/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to track the sun 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="Sun">
|
||
<meta name="twitter:description" content="Instructions how to track the sun within 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">
|
||
Sun
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>The sun 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="/getting-started/automation-trigger/#sun-trigger">a trigger with an optional offset to simulate dawn/dusk</a>.</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
||
<span class="s">sun</span><span class="pi">:</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Configuration variables:</p>
|
||
<ul>
|
||
<li><strong>elevation</strong> (<em>Optional</em>): The (physical) elevation of your location, in meters above sea level. Defaults to the <code class="highlighter-rouge">elevation</code> in <code class="highlighter-rouge">configuration.yaml</code>, which is retrieved from Google Maps if not set.</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 sun’s 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 ‘sun’, which service to call, which event (sunset or sunrise) and the offset.</p>
|
||
<div class="language-json highlighter-rouge"><pre class="highlight"><code><span class="p">{</span><span class="w">
|
||
</span><span class="nt">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"sun"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nt">"service"</span><span class="p">:</span><span class="w"> </span><span class="s2">"switch.turn_on"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nt">"event"</span><span class="p">:</span><span class="w"> </span><span class="s2">"sunset"</span><span class="p">,</span><span class="w">
|
||
</span><span class="nt">"offset"</span><span class="p">:</span><span class="w"> </span><span class="s2">"-01:00:00"</span><span class="w">
|
||
</span><span class="p">}</span><span class="w">
|
||
</span></code></pre>
|
||
</div>
|
||
<h4><a class="title-link" name="maintains-entity-sunsun" href="#maintains-entity-sunsun"></a> Maintains entity <code class="highlighter-rouge">sun.sun</code></h4>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Possible state</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">above_horizon</code></td>
|
||
<td>When the sun is above the horizon.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">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 class="highlighter-rouge">next_rising</code></td>
|
||
<td>Date and time of the next sun rising (in UTC).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">next_setting</code></td>
|
||
<td>Date and time of the next sun setting (in UTC).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">next_dawn</code></td>
|
||
<td>Date and time of the next dawn (in UTC).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">next_dusk</code></td>
|
||
<td>Date and time of the next dusk (in UTC).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">next_noon</code></td>
|
||
<td>Date and time of the next solar noon (in UTC).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">next_midnight</code></td>
|
||
<td>Date and time of the next solar midnight (in UTC).</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">elevation</code></td>
|
||
<td>Solar elevation. This is the angle between the sun and the horizon. Negative values mean the sun is below the horizon.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">azimuth</code></td>
|
||
<td>Solar azimuth. The angle is shown clockwise from north.</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='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/sun.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/home-assistant.png' />
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category Weather</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/weather.bom/'>BOM Australia</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.bom/'>BOM Australia Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.buienradar/'>Buienradar</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/weather.buienradar/'>Buienradar Weather</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.dwd_weather_warnings/'>DWD Weather warnings</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.darksky/'>Dark Sky</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/weather.metoffice/'>Met Office</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.metoffice/'>Met Office Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.moon/'>Moon Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.nest_weather/'>Nest Weather Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.netatmo/'>Netatmo Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/weather.openweathermap/'>OpenWeatherMap</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.openweathermap/'>OpenWeatherMap Sensor</a>
|
||
</li>
|
||
<li>
|
||
Sun
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.swiss_hydrological_data/'>Swiss Hydrological Data</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/binary_sensor.tapsaff/'>Taps Aff</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.wunderground/'>Weather Underground (WUnderground)</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.worldtidesinfo/'>World Tides</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.yr/'>YR</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/weather.yweather/'>Yahoo Weather</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.yweather/'>Yahoo Weather Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/sensor.zamg/'>ZAMG Sensor</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/weather.zamg/'>ZAMG Weather</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>
|