MLISY Plug-in Documentation

Installation

  1. Download the most recent install package.
  2. Shutdown MLServer. MLServer needs to be restarted to see the that the plug-in was added.
  3. Run the installer. It will prompt you for the location of your MLServer plug-ins with the default being C:\Program Files\MLServer\Plugins.
  4. 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. NOTE: Some aspects of the plug-in may not work correctly until it has been restarted. It is recommended that you shut down MLServer and restart after the initial configuration.

Commands

The command syntax is MLISY|<device>~<command>~<value>

Valid commands are:

The optional <value> is used for on commands to set the device to a specfic on level. For dimmers and scenes, this is a numeric value representing the precentage to set (0 - 100%). Relay/io type devices are either 0 or 100.

Thermostats take specific values that are command dependent. The mode must be one of 0, 1, 2, 3, 5, 6, 7 which represent off, heat, cool, auto, program auto, program heat, program cool. The fan can be set to 0 or 1, representing off or auto. Setpoints are the temperatures to assign to the setpoint and humidity is the humidity target in percent. Thermostats also accept bright and dim commands to bump the current setpoint up and down.

There are two ways to specify the device.

  1. By name/address: Use the ISY's name or the ISY's address.
  2. 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~50

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.

<ID> is an unique identifier assigned by MLISY to identify each device/scene/program.

IR events generate a unique set of variables.

The mapping of MLISY ID to the actual ISY device is stored in the registry at HKLM/Software/Cinemar/MLISY. If you uninstall MLServer, it will delete this mapping. If you plan to uninstall and reinstall, you should make a copy of the mapping registry entries so that they can be restored.

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