309 lines
16 KiB
HTML
309 lines
16 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>Dark Sky Sensor - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="How to integrate Dark Sky within Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/sensor.darksky/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Dark Sky Sensor">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/sensor.darksky/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="How to integrate Dark Sky 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="Dark Sky Sensor">
|
||
<meta name="twitter:description" content="How to integrate Dark Sky 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">
|
||
Dark Sky Sensor
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>The <code class="highlighter-rouge">darksky</code> platform uses the <a href="https://darksky.net/">Dark Sky</a> web service as a source for meteorological data for your location. The location is based on the <code class="highlighter-rouge">longitude</code> and <code class="highlighter-rouge">latitude</code> coordinates configured in your <code class="highlighter-rouge">configuration.yaml</code> file. The coordinates are auto-detected but to take advantage of the hyper-local weather reported by Dark Sky, you can refine them down to your exact home address. GPS coordinates can be found by using <a href="https://www.google.com/maps">Google Maps</a> and clicking on your home or <a href="http://www.openstreetmap.org/">Openstreetmap</a>.</p>
|
||
<p>You need an API key which is free but requires <a href="https://darksky.net/dev/register">registration</a>. You can make up to 1000 calls per day for free which means that you could make one approximately every 86 seconds.</p>
|
||
<p class="note warning">
|
||
<a href="https://darksky.net/dev/">Dark Sky</a> will charge you $0.0001 per API call if you enter your credit card details and create more than 1000 calls per day.
|
||
</p>
|
||
<p>To add Dark Sky to 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">sensor</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">darksky</span>
|
||
<span class="s">api_key</span><span class="pi">:</span> <span class="s">YOUR_API_KEY</span>
|
||
<span class="s">monitored_conditions</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">summary</span>
|
||
<span class="pi">-</span> <span class="s">icon</span>
|
||
<span class="pi">-</span> <span class="s">nearest_storm_distance</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Configuration variables:</p>
|
||
<ul>
|
||
<li><strong>api_key</strong> (<em>Required</em>): Your API key.</li>
|
||
<li><strong>name</strong> (<em>Optional</em>): Additional name for the sensors. Default to platform name.</li>
|
||
<li><strong>forecast</strong> array (<em>Optional</em>): List of days in the 7 day forecast you would like to receive data on, starting with tomorrow as day 1. Any <code class="highlighter-rouge">monitored_condition</code> with a daily forecast by DarkSky will generate a sensor tagged with <code class="highlighter-rouge">_<day></code>.</li>
|
||
<li><strong>latitude</strong> (<em>Optional</em>): Latitude coordinate to monitor weather of (required if <strong>longitude</strong> is specified), defaults to coordinates defined in your <code class="highlighter-rouge">configuration.yaml</code></li>
|
||
<li><strong>longitude</strong> (<em>Optional</em>): Longitude coordinate to monitor weather of (required if <strong>latitude</strong> is specified), defaults to coordinates defined in your <code class="highlighter-rouge">configuration.yaml</code></li>
|
||
<li><strong>monitored_conditions</strong> array (<em>Required</em>): Conditions to display in the frontend.
|
||
<ul>
|
||
<li><strong>summary</strong>: A human-readable text summary of the current conditions.</li>
|
||
<li><strong>precip_type</strong>: The type of precipitation occurring.</li>
|
||
<li><strong>precip_intensity</strong>: The average expected intensity of precipitation occurring.</li>
|
||
<li><strong>precip_probability</strong>: A value between 0 and 1 which is representing the probability of precipitation.</li>
|
||
<li><strong>temperature</strong>: The current temperature.</li>
|
||
<li><strong>apparent_temperature</strong>: A numerical value representing the apparent (or “feels like”) temperature.</li>
|
||
<li><strong>dew_point</strong>: The dew point.</li>
|
||
<li><strong>wind_speed</strong>: The wind speed.</li>
|
||
<li><strong>wind_bearing</strong>: Where the wind is coming from in degrees, with true north at 0° and progressing clockwise.</li>
|
||
<li><strong>cloud_cover</strong>: The percentage of sky occluded by clouds.</li>
|
||
<li><strong>humidity</strong>: The relative humidity.</li>
|
||
<li><strong>pressure</strong>: The sea-level air pressure in millibars.</li>
|
||
<li><strong>visibility</strong>: The average visibility.</li>
|
||
<li><strong>ozone</strong>: The columnar density of total atmospheric ozone in Dobson.</li>
|
||
<li><strong>minutely_summary</strong>: A human-readable text summary for the next hour.</li>
|
||
<li><strong>hourly_summary</strong>: A human-readable text summary for the next 24 hours.</li>
|
||
<li><strong>daily_summary</strong>: A human-readable text summary for the next 7 days.</li>
|
||
<li><strong>temperature_max</strong>: Today’s expected high temperature.</li>
|
||
<li><strong>temperature_min</strong>: Today’s expected low temperature.</li>
|
||
<li><strong>apparent_temperature_max</strong>: Today’s expected apparent high temperature.</li>
|
||
<li><strong>apparent_temperature_min</strong>: Today’s expected apparent low temperature.</li>
|
||
<li><strong>precip_intensity_max</strong>: Today’s expected maximum intensity of precipitation.</li>
|
||
<li><strong>uv_index</strong>: The current UV index.</li>
|
||
</ul>
|
||
</li>
|
||
<li><strong>units</strong> (<em>Optional</em>): Specify the unit system. Default to <code class="highlighter-rouge">si</code> or <code class="highlighter-rouge">us</code> based on the temperature preference in Home Assistant. Other options are <code class="highlighter-rouge">auto</code>, <code class="highlighter-rouge">us</code>, <code class="highlighter-rouge">si</code>, <code class="highlighter-rouge">ca</code>, <code class="highlighter-rouge">uk</code> and <code class="highlighter-rouge">uk2</code>.
|
||
<code class="highlighter-rouge">auto</code> will let Dark Sky decide the unit system based on location.</li>
|
||
<li><strong>update_interval</strong> (<em>Optional</em>): Minimum time interval between updates. Default is 2 minutes. Supported formats:
|
||
<ul>
|
||
<li><code class="highlighter-rouge">update_interval: 'HH:MM:SS'</code></li>
|
||
<li><code class="highlighter-rouge">update_interval: 'HH:MM'</code></li>
|
||
<li>Time period dictionary, e.g.:
|
||
<pre>update_interval:
|
||
# At least one of these must be specified:
|
||
days: 0
|
||
hours: 0
|
||
minutes: 3
|
||
seconds: 30
|
||
milliseconds: 0
|
||
</pre>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<p class="note warning">
|
||
While the platform is called “darksky” the sensors will show up in Home Assistant as “dark_sky” (eg: sensor.dark_sky_summary).
|
||
</p>
|
||
<p>Details about the API are available in the <a href="https://darksky.net/dev/docs">Dark Sky documentation</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/sensor.darksky.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/dark_sky.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>: Cloud Polling
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.3
|
||
</div>
|
||
<div class='section'>
|
||
Source:
|
||
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/sensor/darksky.py'>sensor/darksky.py</a>
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class='title delta'>Related components</h1>
|
||
<ul class='divided'>
|
||
<li><a href='/components/weather.darksky/'>
|
||
Dark Sky
|
||
</a></li>
|
||
</ul>
|
||
</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/weather.darksky/'>Dark Sky</a>
|
||
</li>
|
||
<li>
|
||
Dark Sky Sensor
|
||
</li>
|
||
<li>
|
||
<a href='/components/weather.ecobee/'>Ecobee Weather</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>
|
||
<a href='/components/sun/'>Sun</a>
|
||
</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>
|