home-assistant.github.io/components/sensor.forecast/index.html
2016-02-08 06:43:13 +00:00

246 lines
No EOL
11 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>Forecast.io - Home Assistant</title>
<meta name="author" content="Paulus Schoutsen">
<meta name="description" content="Instructions how to integrate Forecast.io within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.forecast/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Forecast.io">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sensor.forecast/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate Forecast.io within Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/home-assistant-logo-2164x2164.png">
<meta name="twitter:card" content="summary">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="Forecast.io">
<meta name="twitter:description" content="Instructions how to integrate Forecast.io within Home Assistant.">
<meta name="twitter: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='/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>Getting started <i class="icon icon-caret-down"></i></a>
<ul>
<li><a href='/getting-started/'>Installing Home Assistant</a></li>
<li><a href='/getting-started/configuration/'>Configuration basics</a></li>
<li><a href='/getting-started/devices/'>Adding devices</a></li>
<li><a href='/getting-started/presence-detection/'>Presence detection</a></li>
<li><a href='/getting-started/automation/'>Automation</a></li>
<li><a href='/getting-started/templating/'>Templating</a></li>
</ul>
</li>
<li><a href='/components/'>Components</a></li>
<li><a href='/cookbook'>Examples</a></li>
<li>
<a>Developers <i class="icon icon-caret-down"></i></a>
<ul>
<li><a href="/developers/">Setup Development</a></li>
<li><a href="/developers/architecture/">Architecture</a></li>
<li><a href="/developers/frontend/">Frontend development</a></li>
<li><a href="/developers/creating_components/">
Creating components
</a></li>
<li><a href="/developers/add_new_platform/">
Adding platform support
</a></li>
<li><a href="/developers/api/">API</a></li>
<li><a href="/developers/credits/">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">
Forecast.io
</h1>
</header>
<hr class="divider">
<p>The <code>forecast</code> platform uses the <a href="https://forecast.io/">Forecast.io</a> web service as a source for meteorological data for your location. The location is based on the Longitude and Latitude cooridinates configured in <code>configuration.yaml</code>. The cooridinates are auto detected but to take advantage of the hyper-local weather reported by forecast.io, you can refine them down to your exact home address. GPS cooridinates can be found by using Google Maps and clicking on your home.</p>
<p>You need an API key which is free but requires a <a href="https://developer.forecast.io/register">registration</a>. You can make 1000 requests per day. This means that you could create one approximately every 1.4 minutes.</p>
<p>To add Forecast.io to your installation, add the following to your <code>configuration.yaml</code> file:</p>
<div class="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre><span class="comment"># Example configuration.yaml entry</span>
<span class="key">sensor</span>:
<span class="key">platform</span>: <span class="string"><span class="content">forecast</span></span>
<span class="key">api_key</span>: <span class="string"><span class="content">YOUR_APP_KEY</span></span>
<span class="key">monitored_conditions</span>:
- <span class="string"><span class="content">summary</span></span>
- <span class="string"><span class="content">icon</span></span>
- <span class="string"><span class="content">nearest_storm_distance</span></span>
- <span class="string"><span class="content">nearest_storm_bearing</span></span>
- <span class="string"><span class="content">precip_type</span></span>
- <span class="string"><span class="content">precip_intensity</span></span>
- <span class="string"><span class="content">precip_probability</span></span>
- <span class="string"><span class="content">temperature</span></span>
- <span class="string"><span class="content">apparent_temperature</span></span>
- <span class="string"><span class="content">dew_point</span></span>
- <span class="string"><span class="content">wind_speed</span></span>
- <span class="string"><span class="content">wind_bearing</span></span>
- <span class="string"><span class="content">cloud_cover</span></span>
- <span class="string"><span class="content">humidity</span></span>
- <span class="string"><span class="content">pressure</span></span>
- <span class="string"><span class="content">visibility</span></span>
- <span class="string"><span class="content">ozone</span></span>
</pre></div>
</div>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>api_key</strong> (<em>Required</em>): Your API key for http://forecast.io/.</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.</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>temperature</strong>: The current 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>
</ul>
</li>
<li><strong>units</strong> (<em>Optional</em>): Specify the unit system. Default to <code>si</code> or <code>us</code> based on the temperature preference in Home Assistant. Other options are <code>auto</code>, <code>us</code>, <code>si</code>, <code>ca</code>, and <code>uk2</code>.<br />
<code>auto</code> will let forecast.io decide the unit system based on location.</li>
</ul>
<p>Details about the API are available in the <a href="https://developer.forecast.io/docs/v2">Forecast.io 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/balloob/home-assistant.io/tree/master/source/_components/sensor.forecast.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/forecast.png' />
</div>
<div class='section'>
<h1 class="title delta">Category Weather</h1>
<ul class='divided'>
<li>
Forecast.io
</li>
<li>
<a href='/components/sensor.openweathermap/'>OpenWeatherMap</a>
</li>
<li>
<a href='/components/sun/'>Sun</a>
</li>
<li>
<a href='/components/sensor.yr/'>YR</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://github.com/balloob/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
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>
</div>
</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>