jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/sensor.wunderground/index.html
Travis CI 67179bf8fe Site updated at 2017-03-18 17:12:07 UTC
2017-03-18 17:12:07 +00:00

269 lines
16 KiB
HTML
Raw Blame History

<!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>Weather Underground (WUnderground) - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate Weather Underground (WUnderground) Weather within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.wunderground/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Weather Underground (WUnderground)">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sensor.wunderground/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate Weather Underground (WUnderground) 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="Weather Underground (WUnderground)">
<meta name="twitter:description" content="Instructions how to integrate Weather Underground (WUnderground) 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" 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="/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>
</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">
Weather Underground (WUnderground)
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">wunderground</code> platform uses <a href="http://www.wunderground.com">Weather Underground</a> as a source for current weather information.</p>
<p class="note warning">
Obtain a WUnderground API key <a href="https://www.wunderground.com/weather/api">here</a>. A free account allows 500 requests per day and also a maximum of 10 per minute. See details <a href="https://www.wunderground.com/weather/api/d/pricing.html">here</a>.
</p>
<p>To add Wunderground 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">wunderground</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">alerts</span>
<span class="pi">-</span> <span class="s">dewpoint_c</span>
<span class="pi">-</span> <span class="s">dewpoint_f</span>
<span class="pi">-</span> <span class="s">dewpoint_string</span>
<span class="pi">-</span> <span class="s">feelslike_c</span>
<span class="pi">-</span> <span class="s">feelslike_f</span>
<span class="pi">-</span> <span class="s">feelslike_string</span>
<span class="pi">-</span> <span class="s">heat_index_c</span>
<span class="pi">-</span> <span class="s">heat_index_f</span>
<span class="pi">-</span> <span class="s">heat_index_string</span>
<span class="pi">-</span> <span class="s">elevation</span>
<span class="pi">-</span> <span class="s">location</span>
<span class="pi">-</span> <span class="s">observation_time</span>
<span class="pi">-</span> <span class="s">precip_1hr_in</span>
<span class="pi">-</span> <span class="s">precip_1hr_metric</span>
<span class="pi">-</span> <span class="s">precip_1hr_string</span>
<span class="pi">-</span> <span class="s">precip_today_in</span>
<span class="pi">-</span> <span class="s">precip_today_metric</span>
<span class="pi">-</span> <span class="s">precip_today_string</span>
<span class="pi">-</span> <span class="s">pressure_in</span>
<span class="pi">-</span> <span class="s">pressure_mb</span>
<span class="pi">-</span> <span class="s">pressure_trend</span>
<span class="pi">-</span> <span class="s">relative_humidity</span>
<span class="pi">-</span> <span class="s">station_id</span>
<span class="pi">-</span> <span class="s">solarradiation</span>
<span class="pi">-</span> <span class="s">temperature_string</span>
<span class="pi">-</span> <span class="s">temp_c</span>
<span class="pi">-</span> <span class="s">temp_f</span>
<span class="pi">-</span> <span class="s">UV</span>
<span class="pi">-</span> <span class="s">visibility_km</span>
<span class="pi">-</span> <span class="s">visibility_mi</span>
<span class="pi">-</span> <span class="s">weather</span>
<span class="pi">-</span> <span class="s">wind_degrees</span>
<span class="pi">-</span> <span class="s">wind_dir</span>
<span class="pi">-</span> <span class="s">wind_gust_kph</span>
<span class="pi">-</span> <span class="s">wind_gust_mph</span>
<span class="pi">-</span> <span class="s">wind_kph</span>
<span class="pi">-</span> <span class="s">wind_mph</span>
<span class="pi">-</span> <span class="s">wind_string</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>api_key</strong> (Required): See above.</li>
<li><strong>pws_id</strong> (Optional): You can enter a Personal Weather Station ID. The current list of Wunderground PWS stations is available <a href="https://www.wunderground.com/weatherstation/ListStations.asp">here</a>. If you do not enter a PWS ID, the current location information (latitude and longitude) from your <code class="highlighter-rouge">configuration.yaml</code> will be used to display weather conditions.</li>
<li><strong>lang</strong> (Optional): Specify the language that the API returns. The current list of all Wunderground language codes is available <a href="https://www.wunderground.com/weather/api/d/docs?d=language-support">here</a>. If not specified, it defaults to English (EN).</li>
<li><strong>monitored_conditions</strong> array (<em>Required</em>): Conditions to display in the frontend. The following conditions can be monitored.
<ul>
<li><strong>alerts</strong>: Current severe weather advisories</li>
<li><strong>dewpoint_c</strong>: Temperature in Celsius below which water droplets begin to condense and dew can form</li>
<li><strong>dewpoint_f</strong>: Temperature in Fahrenheit below which water droplets begin to condense and dew can form</li>
<li><strong>dewpoint_string</strong>: Text summary of dew point</li>
<li><strong>feelslike_c</strong>: Feels like (or apparent) temperature in Celsius</li>
<li><strong>feelslike_f</strong>: Feels like (or apparent) temperature in Fahrenheit</li>
<li><strong>feelslike_string</strong>: Text summary of how the current temperature feels like</li>
<li><strong>heat_index_c</strong>: Heat index (combined effects of the temperature and humidity of the air) in Celsius</li>
<li><strong>heat_index_f</strong>: Heat index (combined effects of the temperature and humidity of the air) in Fahrenheit</li>
<li><strong>heat_index_string</strong>: Text summary of current heat index</li>
<li><strong>elevation</strong>: Elevation in feet</li>
<li><strong>location</strong>: City and State</li>
<li><strong>observation_time</strong>: Text summary of observation time</li>
<li><strong>precip_today_in</strong>: Total precipitation in inches</li>
<li><strong>precip_today_metric</strong>: Total precipitation in metric units</li>
<li><strong>precip_today_string</strong>: Text summary of precipitation today</li>
<li><strong>pressure_in</strong>: Atmospheric air pressure in inches</li>
<li><strong>pressure_mb</strong>: Atmospheric air pressure in millibars</li>
<li><strong>pressure_trend</strong>: Atmospheric air presure trend signal (+/-)</li>
<li><strong>relative_humidity</strong>: Relative humidity</li>
<li><strong>station_id</strong>: Your personal weather station (PWS) ID</li>
<li><strong>solarradiation</strong>: Current levels of solar radiation</li>
<li><strong>temperature_string</strong>: Temperature text combinding Fahrenheit and Celsius</li>
<li><strong>temp_c</strong>: Current temperature in Celsius</li>
<li><strong>temp_f</strong>: Current temperature in Fahrenheit</li>
<li><strong>UV</strong>: Current levels of UV radiation. See <a href="https://www.wunderground.com/resources/health/uvindex.asp">here</a> for explanation.</li>
<li><strong>visibility_km</strong>: Average visibility in km</li>
<li><strong>visibility_mi</strong>: Average visibility in miles</li>
<li><strong>weather</strong>: A human-readable text summary with picture from Wunderground.</li>
<li><strong>wind_degrees</strong>: Wind degrees</li>
<li><strong>wind_dir</strong>: Wind direction</li>
<li><strong>wind_gust_kph</strong>: Wind gusts speed in kph</li>
<li><strong>wind_gust_mph</strong>: Wind gusts speed in mph</li>
<li><strong>wind_kph</strong>: Current wind speed in kph</li>
<li><strong>wind_mph</strong>: Current wind speed in mph</li>
<li><strong>wind_string</strong>: Text summary of current wind conditions</li>
</ul>
</li>
</ul>
<p>All the conditions listed above will be updated each 5 minutes with exception of <code class="highlighter-rouge">alerts</code> that will be updated each 15 minutes by default.</p>
<p class="note warning">
Note: While the platform is called “wunderground” the sensors will show up in Home Assistant as “PWS” (eg: sensor.pws_weather).
</p>
<p>Additional details about the API are available <a href="https://www.wunderground.com/weather/api/d/docs">here</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.wunderground.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/wunderground.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.27
</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.darksky/'>Dark Sky</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>
Weather Underground (WUnderground)
</li>
<li>
<a href='/components/sensor.yr/'>YR</a>
</li>
<li>
<a href='/components/sensor.yweather/'>Yahoo Weather</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>.<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>
</body>
</html>
Reference in a new issue View git blame Copy permalink