home-assistant.github.io/components/sensor.luftdaten/index.html
2018-03-09 18:51:31 +00:00

245 lines
13 KiB
HTML
Raw Permalink 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>Luftdaten Sensor - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to setup Luftdaten sensor in Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.luftdaten/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Luftdaten Sensor">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sensor.luftdaten/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to setup Luftdaten sensor in 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="Luftdaten Sensor">
<meta name="twitter:description" content="Instructions how to setup Luftdaten sensor in 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">
Luftdaten Sensor
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">luftdaten</code> sensor platform will query the open data API of <a href="http://luftdaten.info">luftdaten.info</a> to monitor air quality and other weather data from a specific (self build) sensor station.</p>
<ul>
<li>To get the ID of a particle sensor you need to select it on the <a href="http://deutschland.maps.luftdaten.info/">Feinstaub map</a> and find it in the sidebar (Column “Sensor ID”).</li>
<li>To get the ID of a temperature/humidity sensor you need to find it on the map hosted on <a href="https://www.madavi.de/sensor/feinstaub-map-dht/">Madavi</a>.</li>
</ul>
<p>To enable this sensor, add the following lines 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">luftdaten</span>
<span class="s">sensorid</span><span class="pi">:</span> <span class="s">3123</span>
<span class="s">monitored_conditions</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">P1</span>
<span class="pi">-</span> <span class="s">P2</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">luftdaten</span>
<span class="s">sensorid</span><span class="pi">:</span> <span class="s">155</span>
<span class="s">monitored_conditions</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">temperature</span>
<span class="pi">-</span> <span class="s">humidity</span>
</code></pre>
</div>
<div class="config-vars">
<h3><a class="title-link" name="configuration-variables" href="#configuration-variables"></a> Configuration Variables</h3>
<dl class="">
<dt><a class="title-link" name="sensorid" href="#sensorid"></a> sensorid</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Required)</span><span class="description">The ID of the sensor.</span></p>
</dd>
<dt><a class="title-link" name="name" href="#name"></a> name</dt>
<dd>
<p class="desc"><span class="type">(<span class="string">string</span>)</span><span class="required">(Optional)</span><span class="description">Name of the sensor to use in the frontend.</span></p>
<p class="default">Default value: Luftdaten Sensor</p>
</dd>
<dt><a class="title-link" name="monitored_conditions" href="#monitored_conditions"></a> monitored_conditions</dt>
<dd>
<p class="desc"><span class="type">(<span class="list">list</span>)</span><span class="required">(Required)</span><span class="description">A list of conditions you want to monitor.</span></p>
</dd>
<dd>
<dl class="nested">
<dt><a class="title-link" name="p1" href="#p1"></a> P1</dt>
<dd>
<p class="desc"><span class="description">Show the particle sensors (particles 10 microns and below).</span></p>
</dd>
<dt><a class="title-link" name="p2" href="#p2"></a> P2</dt>
<dd>
<p class="desc"><span class="description">Show the particle sensors (particles 2.5 microns and below).</span></p>
</dd>
<dt><a class="title-link" name="temperature" href="#temperature"></a> temperature</dt>
<dd>
<p class="desc"><span class="description">Display the temperature from the sensor.</span></p>
</dd>
<dt><a class="title-link" name="humidity" href="#humidity"></a> humidity</dt>
<dd>
<p class="desc"><span class="description">Display the humidity from the sensor.</span></p>
</dd>
<dt><a class="title-link" name="pressure" href="#pressure"></a> pressure</dt>
<dd>
<p class="desc"><span class="description">Display the pressure from the sensor.</span></p>
</dd>
</dl>
</dd>
<dt><a class="title-link" name="show_on_map" href="#show_on_map"></a> show_on_map</dt>
<dd>
<p class="desc"><span class="type">(<span class="boolean">boolean</span>)</span><span class="required">(Optional)</span><span class="description">Option to show the position of the sensor on the map.</span></p>
<p class="default">Default value: false</p>
</dd>
</dl>
</div>
<p class="note warning">
If you set <code class="highlighter-rouge">show_on_map</code> to <code class="highlighter-rouge">True</code> then the location attributes are named <code class="highlighter-rouge">latitude</code> and <code class="highlighter-rouge">longitude</code>. The default name of the location attributes is <code class="highlighter-rouge">lat</code> and <code class="highlighter-rouge">long</code> to avoid showing them on the map.
</p>
<p>Not all sensors provide all conditions. Also, its possible that the sensor values are not available all the time. To check what a sensor is publishing use <code class="highlighter-rouge">curl</code>:</p>
<div class="language-bash highlighter-rouge"><pre class="highlight"><code><span class="gp">$ </span>curl https://api.luftdaten.info/v1/sensor/[sensorid]/
</code></pre>
</div>
</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.luftdaten.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/luftdaten.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.57
</div>
<div class='section'>
Source:
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/sensor/luftdaten.py'>sensor/luftdaten.py</a>
</div>
<div class='section'>
<h1 class="title delta">Category Health</h1>
<ul class='divided'>
<li>
<a href='/components/sensor.airvisual/'>AirVisual</a>
</li>
<li>
<a href='/components/sensor.fitbit/'>Fitbit</a>
</li>
<li>
<a href='/components/sensor.london_air/'>London Air Quality</a>
</li>
<li>
Luftdaten Sensor
</li>
<li>
<a href='/components/sensor.pollen/'>Pollen.com</a>
</li>
<li>
<a href='/components/sensor.waqi/'>World Air Quality Index</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>