396 lines
No EOL
15 KiB
HTML
396 lines
No EOL
15 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>ISY994 Controller - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to setup the ISY994 controller within Home Assistant.">
|
||
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/isy994/">
|
||
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="ISY994 Controller">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/isy994/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to setup the ISY994 controller 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="ISY994 Controller">
|
||
<meta name="twitter:description" content="Instructions how to setup the ISY994 controller 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="/ecosystem/">Ecosystem</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">
|
||
ISY994 Controller
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
|
||
|
||
<p>The ISY994 is a home automation controller that is capable of controlling Insteon and X10 devices. Some models of the ISY994 can even control Z-Wave devices.
|
||
The ISY994 controller is manufactured by <a href="https://www.universal-devices.com/residential/isy994i-series/">Universal Devices</a>.</p>
|
||
|
||
<h3><a class="title-link" name="basic-configuration" href="#basic-configuration"></a> Basic Configuration</h3>
|
||
|
||
<p>Home Assistant is capable of communicating with any binary sensor, cover, fan, light, lock, sensor and switch that is configured on the controller. Using the programs on the controller, custom binary sensors, cover, fan, lock, and switches can also be created.</p>
|
||
|
||
<p>To integrate your ISY994 controller with Home Assistant, add the following section 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">isy994</span><span class="pi">:</span>
|
||
<span class="s">host</span><span class="pi">:</span> <span class="s">ISY_ADDRESS</span>
|
||
<span class="s">username</span><span class="pi">:</span> <span class="s">ISY_USERNAME</span>
|
||
<span class="s">password</span><span class="pi">:</span> <span class="s">ISY_PASSWORD</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Configuration variables:</p>
|
||
|
||
<ul>
|
||
<li><strong>host</strong> (<em>Required</em>): The host entry should be in full URL format, eg. http://192.168.10.100:80</li>
|
||
<li><strong>username</strong> (<em>Required</em>): The username that used to access the ISY interface.</li>
|
||
<li><strong>password</strong> (<em>Required</em>): The password that used to access the ISY interface.</li>
|
||
<li><strong>sensor_string</strong> (<em>Optional</em>): This is the string that is used to identify which devices are to be assumed to be sensors instead of lights of switches. By default, this string is ‘sensor’. If this string is found in the device name or folder, Home Assistant will assume it is as a sensor or binary sensor (if the device has on/off or true/false states).</li>
|
||
<li><strong>hidden_string</strong> (<em>Optional</em>): The HIDDEN_STRING is a string that is used to identify which devices are to be hidden on Home Assistant’s front page. This string will be stripped from the device’s name before being used. By default, this value is ‘{HIDE ME}’.</li>
|
||
<li><strong>tls</strong> (<em>Optional</em>): This entry should reflect the version of TLS that the ISY controller is using for HTTPS encryption. This value can be either 1.1 or 1.2. If this value is not set, it is assumed to be version 1.1. This is the default for most users. ISY994 Pro users may likely be using 1.2. When using HTTPS in the host entry, it is best practice to set this value.</li>
|
||
</ul>
|
||
|
||
<p>Once the ISY controller is configured, it will automatically import any binary sensors, covers, fans, lights, locks, sensors and switches it can locate.</p>
|
||
|
||
<h3><a class="title-link" name="creating-custom-devices" href="#creating-custom-devices"></a> Creating Custom Devices</h3>
|
||
|
||
<p>Using the Programs tab in the controller’s Administrative Console, custom devices can be created that will appear natively inside of Home Assistant. Home Assistant will scan the following folders and build the device to the associated domains:</p>
|
||
|
||
<div class="highlighter-rouge"><pre class="highlight"><code>My Programs
|
||
├── HA.binary_sensor
|
||
| ├── Movement In House
|
||
| | └── status
|
||
| └── Garage Open
|
||
| | └── status
|
||
├── HA.cover
|
||
| ├── Left Garage Door
|
||
| | ├── actions
|
||
| | └── status
|
||
| ├── Living Room Blinds
|
||
| | ├── actions
|
||
| | └── status
|
||
├── HA.fan
|
||
| ├── Desk Fan
|
||
| | ├── actions
|
||
| | └── status
|
||
| ├── Living Room Fan
|
||
| | ├── actions
|
||
| | └── status
|
||
├── HA.lock
|
||
| ├── Front Door
|
||
| | ├── actions
|
||
| | └── status
|
||
| ├── Back Door
|
||
| | ├── actions
|
||
| | └── status
|
||
├── HA.switch
|
||
| ├── Dining Lights
|
||
| | ├── actions
|
||
| | └── status
|
||
| ├── Sleep Mode
|
||
| | ├── actions
|
||
| | └── status
|
||
</code></pre>
|
||
</div>
|
||
|
||
<p>A device is created by creating a directory, with the name for the device, under any of the following root directories:</p>
|
||
<ul>
|
||
<li><em>HA.binary_sensor</em> will create a binary sensor (see <a href="https://home-assistant.io/getting-started/customizing-devices/">Customizing Devices</a> to set the sensor class)</li>
|
||
<li><em>HA.cover</em> will create a cover</li>
|
||
<li><em>HA.fan</em> will create a fan</li>
|
||
<li><em>HA.lock</em> will create a lock</li>
|
||
<li><em>HA.switch</em> will create a switch</li>
|
||
</ul>
|
||
|
||
<p>A program, named <em>status</em>, is required under the program device directory. A program, named <em>actions</em>, is required for all program devices except for binary_sensor. Any other programs in these device directories will be ignored.</p>
|
||
|
||
<p class="img">
|
||
<img src="/images/isy994/isy994_CoverhExample.png" />
|
||
</p>
|
||
|
||
<p>The <em>status</em> program in this directory is what indicates the state of the device:</p>
|
||
<ul>
|
||
<li><em>binary_sensor</em> on if the clause returns true, otherwise off</li>
|
||
<li><em>cover</em> closed if the clause returns true, otherwise open</li>
|
||
<li><em>fan</em> on if the clause returns true, otherwise off</li>
|
||
<li><em>lock</em> locked if the clause returns true, otherwise unlocked</li>
|
||
<li><em>switch</em> on if the clause returns true, otherwise off</li>
|
||
</ul>
|
||
|
||
<p class="img">
|
||
<img src="/images/isy994/isy994_SwitchStatusExample.png" />
|
||
</p>
|
||
|
||
<p>The <em>actions</em> program indicates what should be performed for the following device services:</p>
|
||
<ul>
|
||
<li><em>cover</em> the THEN clause is evaluated for the open_cover service, the ELSE clause is evaluated for the close_cover service</li>
|
||
<li><em>fan</em> the THEN clause is evaluated for the turn_on service, the ELSE clause is evaluated for the turn_off service</li>
|
||
<li><em>lock</em> the THEN clause is evaluated for the lock service, the ELSE clause is evaluated for the unlock service</li>
|
||
<li><em>switch</em> the THEN clause is evaluated for the turn_on service, the ELSE clause is evaluated for the turn_off service</li>
|
||
</ul>
|
||
|
||
<p class="img">
|
||
<img src="/images/isy994/isy994_SwitchActionsExample.png" />
|
||
</p>
|
||
|
||
<p>The example program above shows how to control a legacy X10 device from Home Assistant using an ISY controller.</p>
|
||
|
||
|
||
</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/isy994.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/universal_devices.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'>
|
||
Introduced in release: 0.28
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class='title delta'>Related components</h1>
|
||
<ul class='divided'>
|
||
<li><a href='/components/binary_sensor.isy994/'>
|
||
ISY994 Binary Sensor
|
||
</a></li>
|
||
<li><a href='/components/cover.isy994/'>
|
||
ISY994 Cover
|
||
</a></li>
|
||
<li><a href='/components/fan.isy994/'>
|
||
ISY994 Fan
|
||
</a></li>
|
||
<li><a href='/components/light.isy994/'>
|
||
ISY994 Light
|
||
</a></li>
|
||
<li><a href='/components/lock.isy994/'>
|
||
ISY994 Lock
|
||
</a></li>
|
||
<li><a href='/components/sensor.isy994/'>
|
||
ISY994 Sensor
|
||
</a></li>
|
||
<li><a href='/components/switch.isy994/'>
|
||
ISY994 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/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>
|
||
ISY994 Controller
|
||
</li>
|
||
<li>
|
||
<a href='/components/insteon_local/'>Insteon (local)</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/litejet/'>LiteJet</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/mqtt/'>MQTT</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/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> |