jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions
home-assistant.github.io/components/modbus/index.html
Travis CI 709c211c8f Site updated at 2016-09-29 04:44:35 UTC
2016-09-29 04:44:35 +00:00

326 lines
No EOL
12 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>Modbus - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions how to integrate Modbus within Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/modbus/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Modbus">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/modbus/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions how to integrate Modbus 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="Modbus">
<meta name="twitter:description" content="Instructions how to integrate Modbus 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='/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">
Modbus
</h1>
</header>
<hr class="divider">
<p><a href="http://www.modbus.org/">Modbus</a> is a serial communication protocol to control PLCs (Programmable logic controller). It currently supports sensors and switches which can be controlled over serial, TCP, and UDP connections.</p>
<p>To add modbus to your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<p>For a network connection:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry for a TCP connection</span>
<span class="s">modbus</span><span class="pi">:</span>
<span class="s">type</span><span class="pi">:</span> <span class="s">tcp</span>
<span class="s">host</span><span class="pi">:</span> <span class="s">IP_ADDRESS</span>
<span class="s">port</span><span class="pi">:</span> <span class="s">2020</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>type</strong> (<em>Required</em>): Type of the connection to Modbus.</li>
<li><strong>host</strong> (<em>Required</em>): The IP address of your router, eg. 192.168.1.1.</li>
<li><strong>port</strong> (<em>Required</em>): The port for the communication.</li>
</ul>
<p>For a serial connection:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry for a serial connection</span>
<span class="s">modbus</span><span class="pi">:</span>
<span class="s">type</span><span class="pi">:</span> <span class="s">serial</span>
<span class="s">method</span><span class="pi">:</span> <span class="s">rtu</span>
<span class="s">port</span><span class="pi">:</span> <span class="s">/dev/ttyUSB0</span>
<span class="s">baudrate</span><span class="pi">:</span> <span class="s">9600</span>
<span class="s">stopbits</span><span class="pi">:</span> <span class="s">1</span>
<span class="s">bytesize</span><span class="pi">:</span> <span class="s">8</span>
<span class="s">parity</span><span class="pi">:</span> <span class="s">N</span>
</code></pre>
</div>
<p>Configuration variables:</p>
<ul>
<li><strong>type</strong> (<em>Required</em>): Type of the connection to Modebus.</li>
<li><strong>method</strong> (<em>Required</em>): Method of the connection to Modbus.</li>
<li><strong>port</strong> (<em>Required</em>): The port where your Modbus device is connected to your Home Assistant host.</li>
<li><strong>baudrate</strong> (<em>Required</em>): The speed for the serial connection.</li>
<li><strong>stopbits</strong> (<em>Required</em>): The stopbits for the serial connection.</li>
<li><strong>bytesize</strong> (<em>Required</em>): The bytesize for the serial connection.</li>
<li><strong>parity</strong> (<em>Required</em>): The parity for the serial connection.</li>
</ul>
<h3><a class="title-link" name="services" href="#services"></a> Services</h3>
<table>
<thead>
<tr>
<th>Service</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>write_register</td>
<td>Write register. Requires <code class="highlighter-rouge">unit</code>, <code class="highlighter-rouge">address</code> and <code class="highlighter-rouge">value</code> fields. <code class="highlighter-rouge">value</code> can be either single value or an array</td>
</tr>
</tbody>
</table>
<h2><a class="title-link" name="building-on-top-of-modbus" href="#building-on-top-of-modbus"></a> Building on top of Modbus</h2>
<ul>
<li><a href="/components/binary_sensor.modbus/">Modbus Binary Sensor</a></li>
<li><a href="/components/sensor.modbus/">Modbus Sensor</a></li>
<li><a href="/components/switch.modbus/">Modbus Switch</a></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/modbus.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/modbus.png' />
</div>
<div class='section'>
Introduced in release: pre 0.7
</div>
<div class='section'>
<h1 class='title delta'>Related components</h1>
<ul class='divided'>
<li><a href='/components/binary_sensor.modbus/'>
Modbus Binary Sensor
</a></li>
<li><a href='/components/sensor.modbus/'>
Modbus Sensor
</a></li>
<li><a href='/components/switch.modbus/'>
Modbus Switch
</a></li>
</ul>
</div>
<div class='section'>
<h1 class="title delta">Category Hub</h1>
<ul class='divided'>
<li>
<a href='/components/apcupsd/'>APCUPSd</a>
</li>
<li>
<a href='/components/wemo/'>Belkin WeMo</a>
</li>
<li>
<a href='/components/bloomsky/'>BloomSky</a>
</li>
<li>
<a href='/components/emulated_hue/'>Emulated Hue Bridge</a>
</li>
<li>
<a href='/components/enocean/'>EnOcean</a>
</li>
<li>
<a href='/components/ffmpeg/'>FFmpeg</a>
</li>
<li>
<a href='/components/homematic/'>Homematic</a>
</li>
<li>
<a href='/components/isy994/'>ISY994 Controller</a>
</li>
<li>
<a href='/components/insteon_hub/'>Insteon Hub</a>
</li>
<li>
<a href='/components/joaoapps_join/'>Joaoapps Join</a>
</li>
<li>
<a href='/components/mqtt/'>MQTT</a>
</li>
<li>
Modbus
</li>
<li>
<a href='/components/mysensors/'>MySensors</a>
</li>
<li>
<a href='/components/nest/'>Nest</a>
</li>
<li>
<a href='/components/netatmo/'>Netatmo</a>
</li>
<li>
<a href='/components/nuimo_controller/'>Nuimo controller</a>
</li>
<li>
<a href='/components/octoprint/'>OctoPrint</a>
</li>
<li>
<a href='/components/pilight/'>Pilight</a>
</li>
<li>
<a href='/components/qwikswitch/'>QwikSwitch QSUSB Hub</a>
</li>
<li>
<a href='/components/rfxtrx/'>RFXtrx</a>
</li>
<li>
<a href='/components/scsgate/'>SCSGate</a>
</li>
<li>
<a href='/components/sleepiq/'>SleepIQ</a>
</li>
<li>
<a href='/components/tellstick/'>TellStick</a>
</li>
<li>
<a href='/components/tellduslive/'>Telldus Live</a>
</li>
<li>
<a href='/components/vera/'>Vera</a>
</li>
<li>
<a href='/components/verisure/'>Verisure</a>
</li>
<li>
<a href='/components/wink/'>Wink</a>
</li>
<li>
<a href='/components/zwave/'>Z-Wave</a>
</li>
<li>
<a href='/components/ecobee/'>ecobee</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>
</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