home-assistant.github.io/components/sensor.yweather/index.html
2017-11-05 14:24:39 +00:00

297 lines
15 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>Yahoo Weather Sensor - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate Yahoo Weather within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.yweather/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Yahoo Weather Sensor">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sensor.yweather/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate Yahoo Weather 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="Yahoo Weather Sensor">
<meta name="twitter:description" content="Instructions how to integrate Yahoo Weather 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">
Yahoo Weather Sensor
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">yweather</code> platform uses <a href="https://www.yahoo.com/news/weather/">Yahoo Weather</a> as an source for current meteorological data. The <code class="highlighter-rouge">forecast</code> will show you the condition for 5 days, 0 is the current day. You can use only <code class="highlighter-rouge">weather</code>, <code class="highlighter-rouge">temp_min</code>, and <code class="highlighter-rouge">temp_max</code> with forecast. Its important to note that a yweather sensor will only show ONE days forecast at a time so to show multiple days forecasts, you will need to use the name: option and give each sensor a unique name.</p>
<p class="note warning">
Use of the Yahoo Weather API should not exceed reasonable request volume. Access is limited to 2000 signed calls per day.
</p>
<p>The <code class="highlighter-rouge">woeid</code> (Where On Earth ID) for your location, as shown in the example below. You can find your WOEID by copying the numeric digits at the end of the URL for your location at <a href="https://www.yahoo.com/news/weather/">Yahoo Weather</a>. If you dont add a WOEID it generate it from Home Assistants latitude and longitude.</p>
<p>To add Yahoo Weather 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">yweather</span>
<span class="s">monitored_conditions</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">weather</span>
<span class="pi">-</span> <span class="s">weather_current</span>
<span class="pi">-</span> <span class="s">temp_min</span>
<span class="pi">-</span> <span class="s">temp_max</span>
<span class="pi">-</span> <span class="s">wind_speed</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">humidity</span>
<span class="pi">-</span> <span class="s">temperature</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>woeid</strong> (<em>Optional</em>): See above.</li>
<li><strong>forecast</strong> (<em>Optional</em>): Day of forecast. The default is the current day to display conditions.</li>
<li><strong>name</strong> (<em>Optional</em>): The name of the sensor. To easily recognize each sensor when adding more than one Yahoo weather sensor, it is recommended to use the name option. Defaults to <code class="highlighter-rouge">Yweather</code>.</li>
<li><strong>monitored_conditions</strong> array (<em>Required</em>): Conditions to display in the frontend.
<ul>
<li><strong>weather</strong>: A human-readable text summary with picture from yahoo.</li>
<li><strong>weather_current</strong>: A human-readable text summary with picture from yahoo from current condition.</li>
<li><strong>temperature</strong>: The current temperature.</li>
<li><strong>temp_min</strong>: The minimal temperature of this day.</li>
<li><strong>temp_max</strong>: The maximum temperature of this day.</li>
<li><strong>wind_speed</strong>: The wind speed.</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>
</ul>
</li>
</ul>
<p>Example of forecast using multiple days. In example, first sensor shows tomorrows forecast, second sensor shows the next day and so on:</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">yweather</span>
<span class="s">forecast</span><span class="pi">:</span> <span class="s">1</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">yw_day1</span>
<span class="s">monitored_conditions</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">weather</span>
<span class="pi">-</span> <span class="s">temp_min</span>
<span class="pi">-</span> <span class="s">temp_max</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">yweather</span>
<span class="s">forecast</span><span class="pi">:</span> <span class="s">2</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">yw_day2</span>
<span class="s">monitored_conditions</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">weather</span>
<span class="pi">-</span> <span class="s">temp_min</span>
<span class="pi">-</span> <span class="s">temp_max</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">yweather</span>
<span class="s">forecast</span><span class="pi">:</span> <span class="s">3</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">yw_day3</span>
<span class="s">monitored_conditions</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">weather</span>
<span class="pi">-</span> <span class="s">temp_min</span>
<span class="pi">-</span> <span class="s">temp_max</span>
</code></pre>
</div>
<p>Details about the API are available in the <a href="https://developer.yahoo.com/weather/">Yahoo! Developer Network</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.yweather.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/yahooweather.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.24
</div>
<div class='section'>
Source:
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/sensor/yweather.py'>sensor/yweather.py</a>
</div>
<div class='section'>
<h1 class='title delta'>Related components</h1>
<ul class='divided'>
<li><a href='/components/weather.yweather/'>
Yahoo Weather
</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/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>
<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>
Yahoo Weather Sensor
</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>