home-assistant.github.io/components/sensor.onewire/index.html
2017-10-23 14:40:29 +00:00

239 lines
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>One wire Sensor - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate One wire (1-wire) sensors into Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.onewire/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="One wire Sensor">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sensor.onewire/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate One wire (1-wire) sensors into 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="One wire Sensor">
<meta name="twitter:description" content="Instructions how to integrate One wire (1-wire) sensors into 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">
One wire Sensor
</h1>
</header>
<hr class="divider">
<p>The <code class="highlighter-rouge">onewire</code> platform supports sensors which are using the One wire (1-wire) bus for communication.</p>
<p>Supported devices:</p>
<ul>
<li><a href="https://datasheets.maximintegrated.com/en/ds/DS18B20.pdf">DS18B20</a></li>
<li><a href="https://www.maximintegrated.com/en/products/analog/sensors-and-sensor-interface/DS18S20.html">DS18S20</a></li>
<li><a href="https://datasheets.maximintegrated.com/en/ds/DS1822.pdf">DS1822</a></li>
<li><a href="https://datasheets.maximintegrated.com/en/ds/DS1825.pdf">DS1825</a></li>
<li><a href="https://datasheets.maximintegrated.com/en/ds/DS28EA00.pdf">DS28EA00</a> temperature sensors</li>
<li><a href="https://datasheets.maximintegrated.com/en/ds/DS2406.pdf">DS2406/TAI-8570</a> Temperature and pressure sensor made by AAG</li>
<li><a href="https://datasheets.maximintegrated.com/en/ds/DS2438.pdf">DS2438/B1-R1-A</a> Temperature, pressure and humidity sensor by AAG</li>
</ul>
<p>The 1-Wire bus can be connected directly to the IO pins of Raspberry Pi or using dedicated interface adapter (e.g <a href="https://datasheets.maximintegrated.com/en/ds/DS9490-DS9490R.pdf">DS9490R</a>).</p>
<h4>Raspberry Pi setup</h4>
<p>In order ot setup 1-Wire support on Raspberry Pi, youll need to edit <code class="highlighter-rouge">/boot/config.txt</code> following <a href="https://www.waveshare.com/wiki/Raspberry_Pi_Tutorial_Series:_1-Wire_DS18B20_Sensor#Enable_1-Wire">this documentation</a>. Dont use the <code class="highlighter-rouge">mount_dir</code> option.</p>
<h4>Interface adapter setup</h4>
<p>When an interface adapter is used, sensors can be accessed on Linux hosts via <a href="http://owfs.org/">owfs 1-Wire file system</a>. When using an interface adapter and the owfs, the <code class="highlighter-rouge">mount_dir</code> option must be configured to correspond a directory, where owfs device tree has been mounted.</p>
<p class="note warning">
This component has been modified to work with devices with multiple sensors which will cause a discontinuity in recorded values. Existing devices will receive a new ID and therefore show up as new devices.
If you wish to maintain continuity it can be resolved in the database by renaming the old devices to the new names.
Connect to your database using the instructions from <a href="https://home-assistant.io/docs/backend/database/">home-assistant.io/docs/backend/database/</a>. Check the names of sensors:<br />
<code class="highlighter-rouge">sql
SELECT entity_id, COUNT(*) as count FROM states GROUP BY entity_id ORDER BY count DESC LIMIT 10;
</code>
Alter the names of sensors using the following examples:<br />
<code class="highlighter-rouge">sql
UPDATE states SET entity_id='sensor.&lt;sensor_name&gt;_temperature' WHERE entity_id LIKE 'sensor.&lt;sensor_name&gt;%' AND attributes LIKE '%\u00b0C%';
UPDATE states SET entity_id='sensor.&lt;sensor_name&gt;_pressure' WHERE entity_id LIKE 'sensor.&lt;sensor_name&gt;%' AND attributes LIKE '%mb%';
UPDATE states SET entity_id='sensor.&lt;sensor_name&gt;_humidity' WHERE entity_id LIKE 'sensor.&lt;sensor_name&gt;%' AND attributes LIKE '%%%' ESCAPE '';
</code>
Remember to replace <code class="highlighter-rouge">&lt;sensor_name&gt;</code> with the actual name of the sensor as seen in the <code class="highlighter-rouge">SELECT</code> query.
</p>
<h4>Home Assistant setup</h4>
<p>To enable One wire sensors 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">onewire</span>
<span class="s">names</span><span class="pi">:</span>
<span class="s">some_id</span><span class="pi">:</span> <span class="s">your name</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>names</strong> array (<em>Optional</em>): ID and friendly name of your sensors.</li>
<li><strong>mount_dir</strong> (<em>Optional</em>): Location of device tree if owfs driver used.</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.onewire.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/onewire.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>: Local Polling
</div>
<div class='section'>
Introduced in release: 0.12
</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/sensor.eddystone_temperature/'>Eddystone Beacon</a>
</li>
<li>
<a href='/components/sensor.miflora/'>Mi Flora plant sensor</a>
</li>
<li>
One wire Sensor
</li>
<li>
<a href='/components/sensor.serial_pm/'>Particulate matter Sensor</a>
</li>
<li>
<a href='/components/rpi_pfio/'>PiFace Digital I/O</a>
</li>
<li>
<a href='/components/rpi_gpio/'>Raspberry PI GPIO</a>
</li>
<li>
<a href='/components/raspihats/'>Raspihats</a>
</li>
<li>
<a href='/components/sensor.skybeacon/'>Skybeacon sensor</a>
</li>
<li>
<a href='/components/sensor.worxlandroid/'>Worx Landroid</a>
</li>
<li>
<a href='/components/zigbee/'>ZigBee</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>