319 lines
14 KiB
HTML
319 lines
14 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>Insteon PLM - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to setup an Insteon USB PLM locally within Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/insteon_plm/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="Insteon PLM">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/insteon_plm/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to setup an Insteon USB PLM locally 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="Insteon PLM">
|
||
<meta name="twitter:description" content="Instructions how to setup an Insteon USB PLM locally 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">
|
||
Insteon PLM
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>This component adds “local push” support for INSTEON PowerLinc Modems allowing
|
||
linked INSTEON devices to be used within Home Assistant as lights, switches,
|
||
and binary sensors. Device support is provided by the underlying <a href="https://github.com/nugget/python-insteonplm">insteonplm</a>
|
||
package. It is known to work with both the <a href="https://www.insteon.com/powerlinc-modem-usb">2413U</a> USB and <a href="https://www.insteon.com/powerlinc-modem-serial">2412S</a>
|
||
RS242 flavors of PLM. This component does not work with the IP-based hub
|
||
products. For that, you’ll want the “Insteon (Local)” component instead.</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># insteon_plm supported configuration variables</span>
|
||
<span class="s">insteon_plm</span><span class="pi">:</span>
|
||
<span class="s">port</span><span class="pi">:</span> <span class="s">SERIAL_PORT</span>
|
||
<span class="s">device_override</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">address</span><span class="pi">:</span> <span class="s">INSTEON_ADDRESS</span>
|
||
<span class="s">platform</span><span class="pi">:</span> <span class="s">DEVICE_PLATFORM</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Configuration variables:</p>
|
||
<ul>
|
||
<li><strong>port</strong> (<em>Required</em>): The port for your device, e.g. <code class="highlighter-rouge">/dev/ttyUSB0</code></li>
|
||
<li><strong>device_override</strong> (<em>Optional</em>): Override the default device platform</li>
|
||
</ul>
|
||
<h3><a class="title-link" name="customization" href="#customization"></a> Customization</h3>
|
||
<p>The only configuration item that is absolutely necessary is the port so that
|
||
Home Assistant can connect to the PLM. This will expose all the supported INSTEON
|
||
devices which exist in the modem’s ALL-Link database. However, devices will
|
||
only be shown by their INSTEON hex address (e.g. “1A.2B.3C”) which can be a bit
|
||
unwieldy. As you link and unlink devices using the ‘Set’ buttons, they’ll be
|
||
added and removed from Home Assistant automatically.</p>
|
||
<p>You can use the normal Home Assistant <a href="/getting-started/customizing-devices/">device customization</a> section of your
|
||
configuration to assign friendly names and special icons to your devices. This
|
||
is especially useful for setting device_class on your binary_sensor INSTEON
|
||
devices.</p>
|
||
<h3><a class="title-link" name="device-overrides" href="#device-overrides"></a> Device Overrides</h3>
|
||
<p>INSTEON devices are added to Home Assistant using the platform(s) that make the
|
||
most sense given the model and features of the hardware. In most cases this is
|
||
unambiguous, but sometimes the component will not be able to guess the actual
|
||
usage of the device. For example, there might be a table lamp plugged into an
|
||
INSTEON appliance relay module. By default, this will show as a ‘switch’
|
||
device in Home Assistant, but it really should be a ‘light’ device. For
|
||
exceptions like this, the component supports a device plaform override. You
|
||
can set any device (by address) to explicitly use a specific platform if the
|
||
default is not correct.</p>
|
||
<h3><a class="title-link" name="example-configuration-with-options" href="#example-configuration-with-options"></a> Example Configuration with Options</h3>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Full example of insteon_plm configuration with customizations and overrides</span>
|
||
|
||
<span class="s">homeassistant</span><span class="pi">:</span>
|
||
<span class="s">customize</span><span class="pi">:</span>
|
||
<span class="s">light.a1b2c3</span><span class="pi">:</span>
|
||
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s">Bedside Lamp</span>
|
||
<span class="s">binary_sensor.a2b3c4</span><span class="pi">:</span>
|
||
<span class="s">friendly_name</span><span class="pi">:</span> <span class="s">Garage Door</span>
|
||
<span class="s">device_class</span><span class="pi">:</span> <span class="s">opening</span>
|
||
|
||
<span class="s">insteon_plm</span><span class="pi">:</span>
|
||
<span class="s">port</span><span class="pi">:</span> <span class="s">/dev/ttyUSB0</span>
|
||
<span class="s">device_override</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">address</span><span class="pi">:</span> <span class="s">a1b2c3</span> <span class="c1"># Icon Appliance Module for bedside lamp</span>
|
||
<span class="s">platform</span><span class="pi">:</span> <span class="s">light</span> <span class="c1"># make it a light instead of a switch</span>
|
||
</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/insteon_plm.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/insteon.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 Push
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class='title delta'>Related components</h1>
|
||
<ul class='divided'>
|
||
<li><a href='/components/binary_sensor.insteon_plm/'>
|
||
Insteon PLM Binary Sensor
|
||
</a></li>
|
||
<li><a href='/components/light.insteon_plm/'>
|
||
Insteon PLM Light
|
||
</a></li>
|
||
<li><a href='/components/switch.insteon_plm/'>
|
||
Insteon PLM 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/android_ip_webcam/'>Android IP Webcam</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/wemo/'>Belkin WeMo</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/blink/'>Blink</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/bloomsky/'>BloomSky</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/digital_ocean/'>Digital Ocean</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_local/'>Insteon (local)</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/insteon_hub/'>Insteon Hub</a>
|
||
</li>
|
||
<li>
|
||
Insteon PLM
|
||
</li>
|
||
<li>
|
||
<a href='/components/joaoapps_join/'>Joaoapps Join</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/litejet/'>LiteJet</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/lutron/'>Lutron</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/mqtt/'>MQTT</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/microsoft_face/'>Microsoft Face</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/mochad/'>Mochad</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/modbus/'>Modbus</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/mysensors/'>MySensors</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/neato/'>Neato Robotics</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/rflink/'>RFLink</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/twilio/'>Twilio</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/vera/'>Vera</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/verisure/'>Verisure</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/volvooncall/'>Volvo On Call</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/wink/'>Wink</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/zwave/'>Z-Wave</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/zoneminder/'>ZoneMinder</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>
|
||
<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>
|