Difference between revisions of "ISY994i"

From LinuxMCE
Jump to: navigation, search
m (Added category: GSD)
 
(4 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
[[Category: Automation]]
 
[[Category: Automation]]
 
[[Category: Insteon]]
 
[[Category: Insteon]]
{{versioninfo|1004Status=In Development|1004UpdatedDate=6 December 2013|1004UpdatedBy=Michael Brown}}
+
[[Category: GSD]]
  
More info to come.  Like the driver itself, this page is a work in progress. Please stand by...
+
{{versioninfo|1004Status=Basic Functions Working|1004UpdatedDate=10 January 2014|1004UpdatedBy=Michael Brown|1204Status=Working, In Development|1204UpdatedDate=10 January 2014|1204UpdatedBy=Michael Brown}}
 +
 
 +
 
 +
More info to come.  Like the driver itself, this page is a work in progress. Please stand by...  Another update will hopefully land in January 2015.
  
 
The ISY994i is a home automation controller from Universal Devices.  It has an embedded processor, runs it's own real-time OS, is network connected, and manages the various home automation devices as a stand-alone controller. Configuring and administering the ISY is done via a Java application "console", which is used to manage devices, create programs and scheduled events, upgrade the device firmware, and add functionality via purchased license keys.  It exposes it's functionality via well-developed application programming interfaces (API's).   
 
The ISY994i is a home automation controller from Universal Devices.  It has an embedded processor, runs it's own real-time OS, is network connected, and manages the various home automation devices as a stand-alone controller. Configuring and administering the ISY is done via a Java application "console", which is used to manage devices, create programs and scheduled events, upgrade the device firmware, and add functionality via purchased license keys.  It exposes it's functionality via well-developed application programming interfaces (API's).   
Line 47: Line 50:
  
 
[http://www.universal-devices.com/residential/isy994i-series/ Manufacturer Web page at UniversalDevices.com]
 
[http://www.universal-devices.com/residential/isy994i-series/ Manufacturer Web page at UniversalDevices.com]
 
 
 
  
  
 
The LMCE driver utilizes template # 2276.   
 
The LMCE driver utilizes template # 2276.   
  
NOTE:  The Driver has a dependency on the libmysql-ruby and libmysql-ruby1.8 packages, which are not currently part of the driver's automatic installation.  For now, you will need to manually install the ruby-mysql packages using the command "sudo apt-get install libmysql-ruby1.8 libmysql-ruby" and then reload the router.
+
'''NOTE''':  The Driver has a dependency on the libmysql-ruby and libmysql-ruby1.8 packages, which are not currently part of the driver's automatic installation.  For now, you will need to manually install the ruby-mysql packages using the command "sudo apt-get install libmysql-ruby1.8 libmysql-ruby" and then reload the router.  This will be addressed in the next update of the driver, along with better scene controls and weather module integrations.
  
  
Line 103: Line 103:
 
|-
 
|-
 
| Climate Module
 
| Climate Module
| The ISY Weatherbug Climate Module
+
| The ISY HAMweather Climate Module
 
| In progress, pending 12.04
 
| In progress, pending 12.04
 
|-
 
|-
Line 119: Line 119:
 
|-
 
|-
 
| Irrigation Module
 
| Irrigation Module
| The irrigation module used in conjunction with the Climate (Weatherbug) module.
+
| The irrigation module used in conjunction with the Climate (HAMweather) module.
 
| N/A
 
| N/A
 
|-
 
|-
Line 150: Line 150:
  
 
'''Using the ISY Driver'''
 
'''Using the ISY Driver'''
The ISY driver is configured for auto-discovery using DHCP.  When it requests an IP addresses, LinuxMCE  will automatically  add the device template.  You will need to login to the LinuxMCE Administration Page, and change the username and password to match those configured in the ISY.  The template defaults to admin:admin.  Afterwards, you will need to reload the router.
+
The ISY driver is configured for auto-discovery using DHCP.  When the ISY requests an IP addresses, LinuxMCE  will automatically  add the device template.  You will need to login to the LinuxMCE Administration Page, and change the username and password to match those configured in the ISY.  The template defaults to admin:admin.  Afterwards, you will need to reload the router.
 +
 
 +
When the DCErouter reloads, the driver will establish a connection to the ISY.  It will create child devices of the ISY in LinuxMCE, by reading all configured /managed devices from the ISY, and creating a corresponding child in LMCE.  You will need to reload the router in order to use the devices from LMCE.  Similarly, scenes (groups) will be downloaded and appropriate child devices created.  After all devices and scenes have been recognized, you can then edit the devices in LMCE to set the room, floor plan ID (icons used in the Floor plan view in Orbiter), etc.  when you are complete, reload the router again.  Your devices and Insteon scenes  are now available to use in LMCE scenarios.
 +
 
 +
'''Troubleshooting'''
 +
 
 +
If you're having problems, the logs are the best place to look to see what's going on.  There are two logs: the <dev#>_Generic _Serial_Device.log has to do with LMCE's interaction with the driver, and <dev#>_ISY-994i-GSD.log, which logs the driver's interaction with the ISY.  Both are located in /var/log/pluto.
 +
 
 +
Mine are 189_Generic_Serial_Device.log and 189_ISY-994i-GSD.log (as an example).
  
When the DCErouter reloads, the driver will establish a connection to the ISY.  It will create child devices of the ISY in LinuxMCE, by reading all configured /managed devices from the ISY, and creating a corresponding child in LMCEYou will need to reload the router in order to use the devices from LMCESimilarly, scenes (groups) will be downloaded and appropriate child devices created.  After all devices and scenes have been recognized, you can then edit the devices in LMCE to set the room, floor plan ID (icons used in the Floor plan view in Orbiter), etcwhen you are complete, reload the router again.  Your devices and Insteon scenes  are now available to use in LMCE scenerios.
+
By default, the <dev#>_ISY-994i-GSD.log logs a minimal amount of the interaction between the driver and the ISY.  That could give you hints as to what is happening when.  To get more in-depth information as to what's going on, you'll need to enable Debug modeIn the WebAdmin, go to Generic Serial Devices, and check the box next to debug in the device info screenReload the router to restart the driver with verbose logging.

Latest revision as of 15:53, 11 July 2016


Version Status Date Updated Updated By
710 Unknown N/A N/A
810 Unknown N/A N/A
1004 Basic Functions Working 10 January 2014 Michael Brown
1204 Working, In Development 10 January 2014 Michael Brown
1404 Unknown N/A N/A
Usage Information


More info to come. Like the driver itself, this page is a work in progress. Please stand by... Another update will hopefully land in January 2015.

The ISY994i is a home automation controller from Universal Devices. It has an embedded processor, runs it's own real-time OS, is network connected, and manages the various home automation devices as a stand-alone controller. Configuring and administering the ISY is done via a Java application "console", which is used to manage devices, create programs and scheduled events, upgrade the device firmware, and add functionality via purchased license keys. It exposes it's functionality via well-developed application programming interfaces (API's).

The LMCE ISY driver is being written using the Ruby GSD Device interface, and leverages the ISY's API to expose the managed devices and controls to LMCE. The driver has been written with the assumption that the ISY "owns" the connected devices, and exposes them to LMCE for integration and control as an external controller. As the API's develop, some capabilities to configure the ISY from LMCE may be created. Until then, the expectation is that all home automation device configuration and management will occur using the Universal Devices Java admin console, and that the configuration and capabilities will be exposed to LMCE for use via it's capabilities.


ISY Models

Model IR Support Max. Devices/Scenes Max. Programs
ISY994i No 256 300
ISY994i/IR Yes 256 300
ISY994i PRO No 1024 1000
ISY994i/IR Yes 1024 1000

Zigbee devices have the 'Z' device suffix on the model number (e.g. ISY994iZ/IR PRO). The Z-wave device is has just passed the alpha testing phase, and will be going into beta testing soon. Support for the Z-wave radio will likely be added when it's released (and I have the opportunity to get one), as there's some pretty cool Z-wave sensors available...



Manufacturer Web page at UniversalDevices.com


The LMCE driver utilizes template # 2276.

NOTE: The Driver has a dependency on the libmysql-ruby and libmysql-ruby1.8 packages, which are not currently part of the driver's automatic installation. For now, you will need to manually install the ruby-mysql packages using the command "sudo apt-get install libmysql-ruby1.8 libmysql-ruby" and then reload the router. This will be addressed in the next update of the driver, along with better scene controls and weather module integrations.


ISY Hardware Interface support

Module Description Supported Features
Insteon Support for Insteon PLM's including X10 transmission/reception Working
UPB Support for UPB Modems N/A
Zigbee Support for the optional Zigbee model/radio. N/A
Z-wave Support for the optional Z-wave model/radio. N/A








The ISY series supports optional (paid) upgrades which can enable additional functionality in the ISY device. It allows home automation users to start off small, and add additional functionality later as their environment grows or their needs change. For example, a non-pro model can be upgraded by purchasing a Pro upgrade license key. Some hardware upgrades can be done in the field by purchasing the hardware directly from Universal Devices web store. The following table shows the LMCE driver support for the various add-on software modules. Features marked N/A have not been implemented yet.

ISY module support

Module Description Supported Features
Climate Module The ISY HAMweather Climate Module In progress, pending 12.04
Networking Module The ISY networking module N/A
X10 Module The ISY X10 module which incorporates X10 devices into the device tree. Note: if you want to be able to control X10 devices from LMCE or any Orbiter, or receive events for X10 devices, you will need this module license. Working, Tested
Electricity Module The ISY electricity monitoring module for Brultech devices N/A
Irrigation Module The irrigation module used in conjunction with the Climate (HAMweather) module. N/A
ELK Module The ISY <-> Elk M1 Security Panel interface module. N/A












Using the ISY Driver The ISY driver is configured for auto-discovery using DHCP. When the ISY requests an IP addresses, LinuxMCE will automatically add the device template. You will need to login to the LinuxMCE Administration Page, and change the username and password to match those configured in the ISY. The template defaults to admin:admin. Afterwards, you will need to reload the router.

When the DCErouter reloads, the driver will establish a connection to the ISY. It will create child devices of the ISY in LinuxMCE, by reading all configured /managed devices from the ISY, and creating a corresponding child in LMCE. You will need to reload the router in order to use the devices from LMCE. Similarly, scenes (groups) will be downloaded and appropriate child devices created. After all devices and scenes have been recognized, you can then edit the devices in LMCE to set the room, floor plan ID (icons used in the Floor plan view in Orbiter), etc. when you are complete, reload the router again. Your devices and Insteon scenes are now available to use in LMCE scenarios.

Troubleshooting

If you're having problems, the logs are the best place to look to see what's going on. There are two logs: the <dev#>_Generic _Serial_Device.log has to do with LMCE's interaction with the driver, and <dev#>_ISY-994i-GSD.log, which logs the driver's interaction with the ISY. Both are located in /var/log/pluto.

Mine are 189_Generic_Serial_Device.log and 189_ISY-994i-GSD.log (as an example).

By default, the <dev#>_ISY-994i-GSD.log logs a minimal amount of the interaction between the driver and the ISY. That could give you hints as to what is happening when. To get more in-depth information as to what's going on, you'll need to enable Debug mode. In the WebAdmin, go to Generic Serial Devices, and check the box next to debug in the device info screen. Reload the router to restart the driver with verbose logging.