Bob's Place Media Engineering's ISY Insteon Plug-in User Guide Version 4.0 Copyright © 2009 - 2012 Bob's Place Media Engineering. All Rights Reserved. The ISY Insteon Plug-in allows for bi-directional communication and control between a Universal Devices, Inc. ISY Insteon Controller and HomeSeer HS2 home automation software. Features • • • • • • • • • Support for ISY-26, ISY-99i series, and ISY-994i series. Able to control all devices, scenes, programs, and network resources configured by the ISY.
Table of Contents Installation and setup.................................................................................................................................3 Username/Password..............................................................................................................................6 Automatically add new devices to HomeSeer.......................................................................................6 Display Insteon type descriptions.................................
Installation and setup You must be running HomeSeer 2.3.0.0 or later. Using the HomeSeer updater, select the ISY Insteon Plug-in for installation. You should be running the updater from the machine with HomeSeer installed, not from a remote web browser. HomeSeer will download the installation files. Restart HomeSeer to install the plug-in. [Add screens shots and instructions on installation here.] After restarting HomeSeer the ISY Insteon Plug-in installation will start.
If you don't see the “Installation Options” window, it may have opened behind the progress window. Move the progress window out of the way to expose the “Installation Options” window. Once the installation is complete, select the SETUP page from the HomeSeer main screen. Go to the INTERFACES tab. From there you can register, enable, and configure the ISY Insteon Plug-in.
In the list of interfaces, you should find the row for the ISY Insteon plug-in. It should look similar to this. If you have purchased the ISY Insteon Plug-in, press the “Unregistered” button to start the registration process. If you have not yet purchased the plug-in, it will operate in trial mode for 30 days. If the “Online” registration fails, you can manually enter your license key and password (supplied by HomeSeer). Click the DISABLED button under the “Other” column in the ISY Insteon row.
If the ISY Insteon Plug-in was able to detect your ISY, the IP address fields will be populated with the IP address of your ISY. If not, you will have to enter it manually. Username/Password The Username and Password fields will be populated with the default values of “admin” and “admin” respectively. If you have changed the username and/or password, enter the new values.
Split Location/Name from ISY name using character The ISY Insteon Plug-in has the ability to parse the device/scene/program names from the ISY into the HomeSeer location, location 2 and name fields. If you want to utilize this feature, check “Parse locations from name” and enter a character to use as a delimiter in the text box.
ISY Insteon Plug-in Logging Level The log level defines how verbose the ISY Insteon Plug-in will be. The following levels are supported: 1. Errors Only – Only error messages will be written to the log. 2. Warnings – Error messages and warning messages will be written to the log. 3. Status – Errors, warnings, and device update status messages will be written to the log. 4. Notices – Errors, warnings, device status updates and additional informative messages will be written to the log. 5.
Status Message Filter All status messages are captured from the ISY by the ISY Insteon Plug-in and by default, displayed in the HomeSeer log. Some of these can generate a lot of log messages. The above filter table allows you to selectively filter out some (or all) of these status messages.
Device Filter The Device Filter section allows you to hide ISY devices from HomeSeer. Once the ISY devices have been enumerated, the configuration screen will have the device list with check boxes displayed. Using the buttons at the top of each column, you can change the sorting of the list. Pressing the button will sort the list alphabetically by the values in that column.
Devices that are filtered, are not visible to HomeSeer. The ISY Insteon Plug-in will not create a corresponding HomeSeer device and no status information will be available to other HomeSeer components. For any devices you want the ISY Insteon Plug-in to hide, simply un-check the check box next to that device and press the Apply Filter button. Note that this will remove the HomeSeer device associated with the ISY device.
ISY Insteon Plug-in Status Screen When the ISY Insteon Plug-in is installed it will add a plug-in status button to the HomeSeer web interface. The first section of the status display provides some basic information about the ISY Insteon Plugin. It also contains handy links to the configuration page and to the ISY's Admin Console. The Pause Plug-in button will disconnect the plug-in from the ISY. When resumed, the plug-in will re-establish the connection with the ISY.
Each Insteon Thermostat installed will have a section that displays the current status of that thermostat. This section is optional and will only be displayed if you have at least one thermostat installed. If the WeatherBug module is installed on the ISY, the current data for all the weather parameters will be displayed. If the Electricity module is installed on the ISY, the current parameters will be displayed.
ISY Insteon Plug-in Thermostat Control If you have one or more Insteon thermostats installed, the ISY Insteon Plug-in has multiple ways to access it. The thermostats are accessible from the main HomeSeer status page, via the HomeSeer thermostat API and from a ISY Insteon Plug-in Thermostat Status page. The Thermostat Status page will display a row for each thermostat installed. You can change the operating mode, fan mode, and set points from this screen.
Triggers Thermostat Heat/Cool Off, Heat, Cool Call Triggers Program Triggers Becomes True, Running True, Becomes False, Running False, Enabled, Disabled Weather Triggers All WeatherBug parameters Energy Monitor Triggers Utilization, Total Utilization, Polarized Utilization, Voltage, Current IR Triggers Press, Hold, Release, Double X10 Triggers On, Off, Dim, Bright ELK Triggers Disconnected, Connected, Disarmed, Armed Away, Armed Stay, Armed Stay Instant, Armed Night Instant, Armed Vacation FLEX
ISY X10 Command X10 Address On, Off ISY Network Resource Resource ID Run ISY Energy Management Device On, Off, Fast On, Fast Off Thermostat API The ISY Insteon Plug-in fully supports HomeSeer's Thermostat API for Insteon enabled thermostats. Scripts can make use of this API to query and control any Insteon thermostats connected to the ISY. For more information on the Thermostat API see the HomeSeer documentation.
Function Parameters Return Description then the setpoint is referred to as “Setpoint”. If the return is True, then the primary setpoint is referred to as HEAT and the secondary setpoint is COOL. SupportsDirect Thermostat Number Boolean Call SupportsDirect(x,y) for each Sensor Number SupportsStat=True to determine if the thermostat supports direct temperature setting. The return of False means that the thermostat supports setbacks rather than direct temperature setting.
Function Parameters Return Description Sensor Number GetHoldMode Thermostat Number Integer Sensor Number Current Thermostat Hold Mode Setting GetCurrentMode Thermostat Number Integer Sensor Number Current Thermostat Operating Mode. e.g.
ISY Insteon API The ISY Insteon Plug-in API provides a means for HomeSeer scripts to interact with the ISY Insteon Plug-in and the devices it controls. The API provides access to capabilities not exposed through the standard HomeSeer interfaces. string ActivateResource(string id) Takes a network resource ID as the only parameter and sends the command to the ISY to activate (run) that network resource. The string returned is the HTTP response from the ISY.
double EnergyMonitorTotalUtilization(int channel) Get the total energy utilization value for a channel. double EnergyMonitorPolarizedUtilization(int channel) Get the polarized energy utilization value for a channel. double EnergyMonitorVoltage(int channel) Get the voltage value for a channel. double EnergyMonitorCurrent(int channel) Get the current value for a channel (in amps). double EnergyMonitorValue(int channel, int key) Get a value from the energy monitor using a key. The key values are: 1.
Get the current value of variable identified by . void SetVariable(string id, int value) Set the variable identified by to the value specified.
Tips Start small. If you're new to the ISY, start by adding only a few devices and experiment with the ISY scenes and programs. Once you understand the basics, create a plan. Things will go a lot easier if you know ahead of time what scenes you want and how you want the devices to interact. Use a consistent device naming convention. When adding devices with the ISY, name them like this: "Location:Switch Name" For example, "Kitchen:Sink Lights" "Kitchen:Sink Lights Slave" Notes: 1.
Create a folder for each floor; Main, Upstairs, Basement. Create a folder for each room and put them in the appropriate floor folder so you end up with something like this: Upstairs Guest bedroom Master bedroom Main Kitchen Dinning Basement Game room This information can be imported into HomeSeer's device location fields. So Location 2 could be the floor and Location could be the room. ISY first. By using an ISY, you are putting it in charge of your INSTEON devices.
Error Messages The ISY Insteon Plug-in log output has a number of different levels of verbosity. In most cases, an “Error” message means that something has failed. In some cases this is fatal and the ISY Insteon Plugin will no longer be functioning properly. In other cases it means that the data received by the ISY Insteon plug-in was not correct. “Warning” messages indicate that something unexpected happened but it was not fatal.
ISY Insteon Plug-in Errors in incoming XML messages "ISY Message: XML is invalid." "ISY Message: XML does not contain a root node." "ISY Message: XML missing a required element." "ISY climate message: XML missing a required element." "ISY program message: XML missing program ID." "ISY information message: XML has unparsable EventInfo data: " "ISY update message: XML for , missing a required element." "ISY energy message: XML missing a required element.
ISY Insteon Plug-in Trigger Errors “ISY trigger parsing failed for ” ISY Insteon Plug-in Condition Errors “Condition format invalid: ” ISY Insteon Plug-in Program Resources Errors "ISY REST called with missing URL.
Warning Messages ISY Insteon Plug-in Initialization Warnings "ISY initialization Username or Password string to long. is greater than 10 characters." "ISY initialization Username or Password string contains an illegal character." "ISY initialization broadcast timeout." "ISY network configuration query found unknown element " "ISY configuration device info update failed: " "ISY configuration query attempt failed.
"ISY Message: received Weatherbug event but weather device not configured." "ISY Message: type is not supported." "ISY Message: XML node, , not known." "ISY Message: XML update event with unknown action: " “ISY Message: received energy monitor action, , which is unknown.” “ISY Message: received Energy Monitor event but no monitoring device configured.” "HomeSeer/ISY device name differ." "ISY trigger unknown conditional: ” “ISY trigger is not valid.
"ISY ButtonPress button is unsupported. ISY Insteon Plug-in Internal Bugs Warnings "ISY internal unknown node type: " "ISY internal unknown command: " "ISY internal device lookup with invalid index .
