home-assistant.github.io/components/sensor.knx/index.html
2017-03-11 22:26:12 +00:00

284 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>KNX Sensor - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions on how to use the KNX Sensor with Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.knx/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="KNX Sensor">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sensor.knx/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions on how to use the KNX Sensor with 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="KNX Sensor">
<meta name="twitter:description" content="Instructions on how to use the KNX Sensor with 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">
KNX Sensor
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">knx</code> sensor platform allows you to monitor <a href="http://www.knx.org">KNX</a> sensors.</p>
<p>The <code class="highlighter-rouge">knx</code> component must be configured correctly, see <a href="/components/knx">KNX Component</a>.</p>
<p>There is currently support for the following KNX data point types:</p>
<table>
<thead>
<tr>
<th style="text-align: left">Condition</th>
<th style="text-align: left">KNX Datapoint Type</th>
<th style="text-align: left">Unit of measurement</th>
<th style="text-align: left">Data type</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left">Temperature</td>
<td style="text-align: left">9.001</td>
<td style="text-align: left">°C</td>
<td style="text-align: left">2 Byte Float</td>
</tr>
<tr>
<td style="text-align: left">Speed (Wind speed)</td>
<td style="text-align: left">9.005</td>
<td style="text-align: left">m/s</td>
<td style="text-align: left">2 Byte Float</td>
</tr>
<tr>
<td style="text-align: left">Illuminance (Lux)</td>
<td style="text-align: left">9.004</td>
<td style="text-align: left">Lux</td>
<td style="text-align: left">2 Byte Float</td>
</tr>
</tbody>
</table>
<p>To use your KNX sensor in 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">knx</span>
<span class="s">type</span><span class="pi">:</span> <span class="s">temperature</span>
<span class="s">address</span><span class="pi">:</span> <span class="s">1/0/3</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">knx</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Wind speed</span>
<span class="s">type</span><span class="pi">:</span> <span class="s">speed_ms</span>
<span class="s">address</span><span class="pi">:</span> <span class="s">1/0/0</span>
<span class="pi">-</span> <span class="s">platform</span><span class="pi">:</span> <span class="s">knx</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Lux</span>
<span class="s">type</span><span class="pi">:</span> <span class="s">illuminance</span>
<span class="s">address</span><span class="pi">:</span> <span class="s">1/0/1</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>type</strong> (<em>Required</em>): The type of the sensor. See table above for available options.</li>
<li><strong>address</strong> (<em>Required</em>): The address of the sensor on the bus.</li>
<li><strong>name</strong> (<em>Optional</em>): The name to use in the frontend.</li>
<li><strong>minimum</strong> (<em>Optional</em>): Minimum sensor value who gets processed. Defaults to a hardcoded default values.</li>
<li><strong>maximum</strong> (<em>Optional</em>): Maximum sensor value who gets processed. Defaults to a hardcoded default.</li>
</ul>
</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.knx.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/knx.png' />
</div>
<div class='section'>
Introduced in release: 0.29
</div>
<div class='section'>
<h1 class='title delta'>Related components</h1>
<ul class='divided'>
<li><a href='/components/knx/'>
KNX
</a></li>
<li><a href='/components/binary_sensor.knx/'>
KNX Binary Sensor
</a></li>
<li><a href='/components/switch.knx/'>
KNX Switch
</a></li>
<li><a href='/components/climate.knx/'>
KNX Thermostat
</a></li>
</ul>
</div>
<div class='section'>
<h1 class="title delta">Category DIY</h1>
<ul class='divided'>
<li>
<a href='/components/arduino/'>Arduino</a>
</li>
<li>
<a href='/components/sensor.arduino/'>Arduino Sensor</a>
</li>
<li>
<a href='/components/switch.arduino/'>Arduino Switch</a>
</li>
<li>
<a href='/components/bbb_gpio/'>BeagleBone Black GPIO</a>
</li>
<li>
<a href='/components/sensor.dht/'>DHT Sensor</a>
</li>
<li>
<a href='/components/knx/'>KNX</a>
</li>
<li>
KNX Sensor
</li>
<li>
<a href='/components/switch.knx/'>KNX Switch</a>
</li>
<li>
<a href='/components/climate.knx/'>KNX Thermostat</a>
</li>
<li>
<a href='/components/sensor.miflora/'>Mi Flora plant sensor</a>
</li>
<li>
<a href='/components/sensor.serial_pm/'>Particulate matter Sensor</a>
</li>
<li>
<a href='/components/rpi_gpio/'>Raspberry PI GPIO</a>
</li>
<li>
<a href='/components/sensor.skybeacon/'>Skybeacon sensor</a>
</li>
<li>
<a href='/components/zigbee/'>ZigBee</a>
</li>
<li>
<a href='/components/maxcube/'>eQ-3 MAX! Cube</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>