Lighting Drivers

From Cinemar Wiki
Jump to: navigation, search

About

Lighting Family Manager allows for management of one or more lighting controller drivers like UPB / Insteon / ZWave / RadioRA2 / etc. It allows for standarized MainLobby Client scene configuration that the Lighting then routes the commands to the appropriate lighting controller. This allows for scenes to be reusable across multiple lighting control technologies. It also allows for usage of multiple concurrant lighting controllers.


Software Requirements

Mainlobby Server 4


Appropriate Lighting compliant device driver (Insteon / UPB/ Zwave / RadioRA2 / etc.) - latest downloadable version from MLInstaller.


Installation

Hardware setup and Device driver for UPB Lighting

Plug in the UPB controller into the serial port of the MLServer PC. Load the UPStart software on that PC and configure the UPB devices as per the UPStart / UPB core installation instructions. Get all lights, devices and links working within UPStart before trying to use with MLServer 4. For more detailed infromation click the UPB link above.


Hardware setup and Device driver for Insteon Lighting

Plug in the SmartHome controller into an unused serial port of the MLServer PC. Load the HouseLinc software on that PC and configure the Insteon devices as per the Houselinc/ Insteon core installation instructions. Get all lights, devices and links working within HouseLinc before trying to use with MLServer 4. For more detailed infromation click the Insteon link above.


(More drivers coming soon)



Software installation

1) Shut down MLServer4

2) Download and run the appropriate lighting hardware driver.exe file on the primary MLServer4 PC that is physically connected to the lighting hardware.

3) Launch MLServer4 and go to the Family Manager. Select the Lighting and import your lighting file.(I.E.- Houselinc(*.xml)/ UPB(*.upe).)Devices and device type can be added manually but it is recommend to import the file.


Lighting.Family.jpg

Supported MainLobby4 Server Commands

On

{MLServeCmd}Script Usage


Lighting|Lighting#~On

Parameters
Lighting# = The Light or devices ID or Alias

(Literal)
Lighting|Lighting1~On
Lighting|1~On


Description

Turns the specified light on.


Off

{MLServeCmd}Script Usage

Lighting|Lighting#~Off

Parameters
Lighting# = The Light or devices ID or Alias

(Literal)
Lighting|Lighting1~Off
Lighting|1~Off


Description

Turns the specified light off.


Bright

{MLServeCmd}Script Usage

Lighting|Lighting#~Bright~Increment

Parameters
Lighting# = The Light or devices ID or Alias
Increment = >0...100< or default value in driver settings.

(Literal)
Lighting|Lighting1~Bright~5
Lighting|1~Bright


Description

Brightens the specified light by the increment specified or default increment set in driver.


Dim

{MLServeCmd}Script Usage

Lighting|Lighting#~Dim~Increment

Parameters
Lighting# = The Light or devices ID or Alias
Increment = >0...100< or default value in driver settings.

(Literal)
Lighting|Lighting1~Dim~5
Lighting|1~Dim


Description

Dims the specified light by the increment specified or default increment set in driver.


Toggle

{MLServeCmd}Script Usage

Lighting|Lighting#~Toggle

Parameters
Lighting# = The Light or devices ID or Alias

(Literal)
Lighting|Lighting1~Toggle
Lighting|1~Toggle


Description

Toggles the light on or off based on its current status.


Level

{MLServeCmd}Script Usage

Lighting|Lighting#~Level~Percentage

Parameters
Lighting# = The Light or devices ID or Alias
Percentage = >0...100<

(Literal)
Lighting|Lighting1~Level~50
Lighting|1~Level~50


Description

Dims the specified light on by the specified percentage level.


Link

{MLServeCmd}Script Usage

Lighting|Lighting#~Link~Command

Parameters
Lighting# = The Light or devices ID or Alias
Command = On, Off

(Literal)
Lighting|Lighting1~Link~On
Lighting|1~Link~On


Description

Turns the specified linked devices on or off.


Status

{MLServeCmd}Script Usage

Lighting|Lighting#~Status

Parameters
Lighting# = The Light or devices ID or Alias

(Literal)
Lighting|Lighting1~Status
Lighting|1~Status


Description

Gets the current status of the specified device.



MLServer Variables

Below are some of the varibles greated by this driver. For specific varblies look in the Lighting section of the Server Variables.

Lighting_{{Lighting#}}_Alias

Description: The alias of the device.

Values: The Lighting# of the device

Lighting_{{Lighting#}}_Model

Description: The model of the device.

Values: Switch, Dimmer, I/O, etc.

Lighting_{{Lighting#}}_Status

Description: The current status of the device.

Values: On, Off, Unkown

Lighting_{{Lighting#}}_Level

Description: The percentage value of the current status of the device.

Values: 0-100

Lighting_{{Lighting#}}_Descr

Description: The description of what the device does.

Values: Text- Text is defined in the lighting Family Manager.

Lighting_{{Lighting#}}_Zone

Description: The zone where the device is located.

Values: Text- Text is defined in the lighting Family Manager, it gets imported with configuration file or can be manually changed.