MLHomeWorks Plugin

From Cinemar Wiki
Jump to: navigation, search

About

The MLHomeWorks Plugin is used to control a Lutron Homeworks Controller via a network connection.

Installation

MLHomeworks.dll

Plugin that communicates with the Lutron Controller.

With MLServer shutdown, run the MLHomeworks_Plugin_Setup.exe. This will install MLHomeworks plugin to the MLServer Plugins directory. It is recommended to accept all installation defaults.


Settings

Configure the IP Address and port number for the main Lutron controller. You will also have to specify the username and password for the Lutron controller. The default username/password is lutron/integrator.

You must then define the Lutron devices on your network or optionally you can import the file that was exported by the Lutron homeworks software.

MLServeCmds for Dimmers and Switches

On

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~On

Parameters
DeviceID = The unique device ID to control

(Literal)
MLHomeworks|1~On

Description

Turns the specified device on.


Off

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~Off

Parameters
DeviceID = The unique device ID to control

(Literal)
MLHomeworks|1~Off

Description

Turns the specified device off.


Toggle

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~Toggle

Parameters
DeviceID = The unique device ID to control

(Literal)
MLHomeworks|1~Toggle

Description

Toggles the state of the specified device on.


Dim

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~Dim~Level~FadeTime~DelayTime

Parameters
DeviceID = The unique device ID to control
Level = The level to dim to 0..100
FadeTime = Optional - The amount of seconds to dim
Delaytime = Optional - Number of seconds before dimming

(Literal)
MLHomeworks|1~Dim~50

Description

Dims the specified device.


Flash

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~Flash~Level~FlashTime

Parameters
DeviceID = The unique device ID to control
Level = The level to dim to 0..100
FlashTime = Optional - The amount of seconds to flash

(Literal)
MLHomeworks|1~Flash~100~50

Description

Flash the specified device.


StopFlash

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~StopFlash

Parameters
DeviceID = The unique device ID to control

(Literal)
MLHomeworks|1~StopFlash

Description

Stops flashing the specified device.


Raise

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~Raise

Parameters
DeviceID = The unique device ID to control

(Literal)
MLHomeworks|1~Raise

Description

Begin raising the specified device.


Lower

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~Lower

Parameters
DeviceID = The unique device ID to control

(Literal)
MLHomeworks|1~Lower

Description

Begings lowering the specified device.


Stop

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~Stop

Parameters
DeviceID = The unique device ID to control

(Literal)
MLHomeworks|1~Stop

Description

Stops a Raise or lower commands on the specified device.


Press

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~Press~Button#

Parameters
DeviceID = The unique device ID to control
Button# = The desired button number

(Literal)
MLHomeworks|1~Press~2

Description

Simulates a button press on the specified device.


DoubleTap

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~DoubleTap~Button#

Parameters
DeviceID = The unique device ID to control
Button# = The desired button number

(Literal)
MLHomeworks|1~DoubleTap~5

Description

Simulates a double-Tap on the specified device.


Status

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~Status

Parameters
DeviceID = The unique device ID to control

(Literal)
MLHomeworks|1~Status

Description

Requests device status.


MLServeCmds for Keypads

Press

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~Press~Button#

Parameters
DeviceID = The unique device ID to control
Button# = The desired button number

(Literal)
MLHomeworks|1~Press~5

Description

Simulates a button press on the specified device.


Release

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~Release~Button#

Parameters
DeviceID = The unique device ID to control
Button# = The desired button number

(Literal)
MLHomeworks|1~Release~5

Description

Simulated a button release on the specified device.


Hold

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~Hold~Button#

Parameters
DeviceID = The unique device ID to control
Button# = The desired button number

(Literal)
MLHomeworks|1~Hold~3

Description

Simulates a button Hold on the specified device.


DoubleTap

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~DoubleTap~Button#

Parameters
DeviceID = The unique device ID to control
Button# = The desired button number

(Literal)
MLHomeworks|1~DoubleTap~6

Description

Simulates a button Double-Tap on the specified device.


Enable

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~Enable

Parameters
DeviceID = The unique device ID to control

(Literal)
MLHomeworks|1~Enable

Description

Enables the specified device.


Disable

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~Disable

Parameters
DeviceID = The unique device ID to control

(Literal)
MLHomeworks|1~Disable

Description

Disables the specified device.


Status

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~Status

Parameters
DeviceID = The unique device ID to control

(Literal)
MLHomeworks|1~Status

Description

Requests status from the specified device.


SetLED

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~SetLED~LED#~State

Parameters
DeviceID = The unique device ID to control
LED# = The desired LED number
State = On,Off

(Literal)
MLHomeworks|1~SetLED~5~On

Description

Turns the specified LED on or off on the specified device.


LEDStatus

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~LEDStatus

Parameters
DeviceID = The unique device ID to control

(Literal)
MLHomeworks|1~LEDStatus

Description

Requests LED status from the specified device.


MLServeCmds for QES Shades

Preset1

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~Preset1

Parameters
DeviceID = The unique device ID to control

(Literal)
MLHomeworks|1~Preset1

Description

Moves the shade to its Preset 1 position.


Preset2

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~Preset2

Parameters
DeviceID = The unique device ID to control

(Literal)
MLHomeworks|1~Preset2

Description

Moves the shade to its Preset 2 position.


Preset3

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~Preset3

Parameters
DeviceID = The unique device ID to control

(Literal)
MLHomeworks|1~Preset3

Description

Moves the shade to its Preset 3 position.


Raise

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~Raise

Parameters
DeviceID = The unique device ID to control

(Literal)
MLHomeworks|1~Raise

Description

Begin raising the specified device.


Lower

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~Lower

Parameters
DeviceID = The unique device ID to control

(Literal)
MLHomeworks|1~Lower

Description

Beging lowering the specified device.


Close

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~Close

Parameters
DeviceID = The unique device ID to control

(Literal)
MLHomeworks|1~Close

Description

Closes the specified device.


Open

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~Open

Parameters
DeviceID = The unique device ID to control

(Literal)
MLHomeworks|1~Open

Description

Opens the specified device.


Stop

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~Stop

Parameters
DeviceID = The unique device ID to control

(Literal)
MLHomeworks|1~Stop

Description

Stops a raise or lower command on the specified device.


Status

{MLServeCmd}Script Usage

MLHomeworks|DeviceID~Status

Parameters
DeviceID = The unique device ID to control

(Literal)
MLHomeworks|1~Status

Description

Requests Shade status on the specified device.


MLServer Variables

All the Server Variables for this plugin begin with the prefix MLHOMEWORKS_