MLISY Plugin
From Tallus LLC Wiki
Contents |
Headline text
About
ISY Plug-in for MainLobby is now available. This is a beta release with all the associated disclaimers.
Download:
http://www.bobsplace.com/mlisy/download.html
Features
Basic features include:
Device/Program Status display
Device/Program Control
Automatic creation and real-time updates of MLServer variables with device status
Device/Program control from with MLServer using the MLISY command
Requirements
To use this Plug-in you'll need:
An ISY with firmware 2.6.6 or later
MLServer version 500 or later
Microsoft .NET runtime 3.0 or later
Installation
Download the most recent install package. Shutdown MLServer. MLServer needs to be restarted to see the that the plug-in was added. Run the installer. It will prompt you for the location of your MLServer plug-ins with the default being C:\Program Files\MLServer\Plugins. Restart MLServer.
Setup
The first time you start MLServer after installing MLISY, it will pause while loading the MLISY plugin. It may pause for approximately 1 minute while the plug-in searches for an ISY on your network.
Once MLServer has finished loading, select the MLISY plug-in from the plug-in window. It will open a new window with the MLISY configuration screen.
Fill in the text boxes for the ISY username, password, and if it is empty, the IP address.
Click the "Apply" button. After a few seconds the screen should update with information about the ISY. The MLISY plug-in is now set up.
Commands
The command syntax is MLISY|<command>~<device>~<value>
Valid commands are:
On - (relays, dimmers, scenes, IO) Off - (relays, dimmers, scenes, IO) Bright - (dimmers, scenes) Dim - (dimmers, scenes) FastOn - (dimmers, scenes) FastOff - (dimmers, scenes) RunIf - (programs) RunThen - (programs) RunElse - (programs) Toggle - (relays, dimmers, scenes, IO) GroupOn - (scenes) GroupOff - (scenes) todo: Climate - (thermostats) The optional <value> is used for on commands to set the device to a specfic on level.
There are two ways to specify the device.
By name/address: Use the ISY's name or the ISY's address. By ID: Use MLISY's ID prefixed with 'mlisy_'.
For example: MLISY|Kitchen light~On MLISY|1 7 A1 1~On MLISY|mlisy_4~On
NOTE: The device name is not a unique identifier on the ISY!
Variables
On startup, MLISY will query the ISY for the device/scene/programs that are currently configured. During normal operation, the ISY will notify MLISY of any device status changes, adds, deletes, renames, and button presses. However, the ISY will not notify MLISY when a scene is activated. For each device/scene/program, MLISY will create a set of variables in MLServer. These variables can be used in MainLobby Scenes or used as triggers in automation rules.
mlisy_<ID>_id - The device's ISY address mlisy_<ID>_alias - The device's ISY name mlisy_<ID>_status - on/off/dim mlisy_<ID>_value - On level 0 - 100% mlisy_<ID>_raw - On level 0 - 255 mlisy_<ID>_room - The device's ISY location mlisy_<ID>_model - The device type mlisy_<ID>_ts - The time in ticks when mlisy last received an update from the device mlisy_<ID>_updated - The last time mlisy received an update from the device <ID> is an unique identifier assigned by MLISY to identify each device/scene/program.
Debugging To facilitate debugging of problems encountered while using MLISY, the verbosity of the messages written to the built in log can be increased. By default, only errors and warnings are written to the log. To turn on debugging messages, go to the "Log" tab in MLISY's window and change the log level to "Debug".
If you have encountered a problem, Set the log to Debug, cause the problem, and save the log file. Send the saved log file along with a detailed description of the problem and what steps are needed to reproduce it to mlisy@bobsplace.com
Known Issues
The first time the plug-in is started, it tries to auto-detect the ISY and can pause for up to a minute while this happens.
Change Log
Version 0.1.10 Beta - Nov. 22, 2008
Fixed a bug in ISY auto detect where it would only see the first device that responded, even if it wasn't an ISY.
Fixed a bug in the settings device control screen where using any of the control buttons on a device would result in a crash.
Fixed a bug with programs. If the admin console was used to save any changes to programs, MLISY would stop allowing control of programs.
Version 0.1.9 Beta - Nov. 9, 2008
Fixed communication issue where mlisy would overload the ISY.
Added timestamp variables.
Added support for button press triggers. Button presses will now update the sever variables (status and timestamps).
Added limited scene activate/deactvate support.
Version 0.1.8 Beta - Oct. 29, 2008
First public beta release.