jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/sensor.forecast/index.html
Travis CI d8f8521198 Site updated at 2016-12-06 08:23:42 UTC
2016-12-06 08:23:42 +00:00

254 lines
No EOL
12 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Home Assistant">
<meta name="description" content="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="How to integrate Forecast.io 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="Forecast.io">
<meta name="twitter:description" content="How to integrate Forecast.io within Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.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 href="/getting-started/">Getting started</a></li>
<li><a href="/components/">Components</a></li>
<li><a href="/ecosystem/">Ecosystem</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>
</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 class="note warning">
<strong>This platform has been deprecated in favor of the “<a href="/components/sensor.darksky/">darksky</a>” platform and will be removed in the future. Please use the “darksky” platform.</strong>
</p>
<p>The <code class="highlighter-rouge">forecast</code> platform uses the <a href="https://forecast.io/">Forecast.io</a> web service as a source of 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 forecast.io, 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://developer.forecast.io/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://forecast.io/">Forecast.io</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 Forecast.io 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">forecast</span>
<span class="s">api_key</span><span class="pi">:</span> <span class="s">YOUR_APP_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>
<span class="pi">-</span> <span class="s">nearest_storm_bearing</span>
<span class="pi">-</span> <span class="s">precip_type</span>
<span class="pi">-</span> <span class="s">precip_intensity</span>
<span class="pi">-</span> <span class="s">precip_probability</span>
<span class="pi">-</span> <span class="s">temperature</span>
<span class="pi">-</span> <span class="s">apparent_temperature</span>
<span class="pi">-</span> <span class="s">dew_point</span>
<span class="pi">-</span> <span class="s">wind_speed</span>
<span class="pi">-</span> <span class="s">wind_bearing</span>
<span class="pi">-</span> <span class="s">cloud_cover</span>
<span class="pi">-</span> <span class="s">humidity</span>
<span class="pi">-</span> <span class="s">pressure</span>
<span class="pi">-</span> <span class="s">visibility</span>
<span class="pi">-</span> <span class="s">ozone</span>
<span class="pi">-</span> <span class="s">minutely_summary</span>
<span class="pi">-</span> <span class="s">hourly_summary</span>
<span class="pi">-</span> <span class="s">daily_summary</span>
<span class="pi">-</span> <span class="s">temperature_max</span>
<span class="pi">-</span> <span class="s">temperature_min</span>
<span class="pi">-</span> <span class="s">apparent_temperature_max</span>
<span class="pi">-</span> <span class="s">apparent_temperature_min</span>
<span class="pi">-</span> <span class="s">precip_intensity_max</span>
</code></pre>
</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 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>
</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>, and <code class="highlighter-rouge">uk2</code>.
<code class="highlighter-rouge">auto</code> will let forecast.io decide the unit system based on location.</li>
<li><strong>update_inverval</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.:</li>
</ul>
</li>
</ul>
<pre>update_interval:
# At least one of these must be specified:
days: 0
hours: 0
minutes: 3
seconds: 30
milliseconds: 0
</pre>
<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/home-assistant/home-assistant.github.io/tree/current/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'>
Introduced in release: pre 0.7
</div>
<div class='section'>
<h1 class="title delta">Category Deprecated</h1>
<ul class='divided'>
<li>
Forecast.io
</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>.<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>
</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>
</body>
</html>
Reference in a new issue View git blame Copy permalink