MLElanS12 Plugin

From Cinemar Wiki
Jump to: navigation, search

Introduction

The following paragraphs detail the installation, configuration and usage of the MainLobby / MLServer ELAN System 12 Driver.

Installation and Configuration

This driver is capable of supporting an ELAN System 12 controller via a PC serial port or a Global Cache GC100 style serial port.


Installation

Run the MLELANS12-Setup.exe program and follow the prompts.

Configuration

This driver must be configured prior to using it in a MainLobby scene. Highlight the MLELANS12 driver in MLServer and click on the Settings button to bring up the ELAN System 12 configuration screen. You will be presented with a tabbed dialog box of configuration settings as shown in Figure 1.


The Events Tab

This tab is used to collect and view the status of the driver while is use. This is a diagnostic feature and is useful during the initial setup of the driver. Click on the Start Logging button to enable the display of driver events while the driver is in use. See Figure 2.


The Connections Tab

Use this tab to configure the serial port that will be used to control the ELAN System 12 controller. You can use either a PC serial port, a Global Cache serial port. If you use a Global Cache serial port make sure you configure the serial port using the Global Cache web interface. The interface that is currently enabled will be used to control the ELAN controller. Make sure that the baud rate set in this plug-in matches the baud rate you set on the ELAN controller. See Figure 3.


MLServer Variables

MLServer Two-Way Support

The ELAN System 12 controller will generate a feedback status message whenever a event is logged on the controller. This driver will automatically create MLServer variables based upon the reported data. The following variables will be created:



MLELANS12_ZoneXX_Bass = -18 .. +18

MLELANS12_ZoneXX_ComponentGroup = 0, 1

MLELANS12_ZoneXX_DND = 0, 1

MLELANS12_ZoneXX_DRC = 0, 1

MLELANS12_Doorbell = 0, 1

MLELANS12_ZoneXX_GroupYY = 0, 1

MLELANS12_ZoneXX_Mute = 0, 1

MLELANS12_Page = 0, 1

MLELANS12_ZoneXX_Power = 0, 1

MLELANS12_ZoneXX_Source = 0 .. 12

MLELANS12_SysOff = 0, 1

MLELANS12_ZoneXX_Treble = -18 .. +18

MLELANS12_ZoneXX_WHM = 0, 1

MLELANS12_ZoneXX_VidY = 0 .. 8

MLELANS12_ZoneXX_UnitY_OutputZZ = 0 .. 12

MLELANS12_UnitX_AudioY = 0, 1

MLELANS12_UnitX_LocalAudioY = 0, 1

MLELANS12_UnitX_Paqe = 0, 1

MLELANS12_UnitX_TriggerY = 0, 1

MLELANS12_UnitX_VideoY = 0, 1


Commands

Set Bass Level

BAS (Set Bass Level)

MLServer Command:

BAS~Zone~Level



Where

Zone = 1..32

Level = -18 .. +18



Example

MLServeCmd.MLELANS12|BAS~1~12


Component

CPN (Component)

MLServer Command:

CPN~Zone~Group



Where

Zone = 1..32

Group = 1..5, 0 = Track



Example

MLServeCmd.MLELANS12|CPN~1~2


Do Not Disturb

DND (Do Not Disturb)

MLServer Command:

DND~Zone~State



Where

Zone = 1..32

State = On, Off, Tog or 0, 1, 2



Example

MLServeCmd.MLELANS12|DND~1~Off


Dynamic Range Compression

DRC (Dynamic Range Compression)

MLServer Command:

DRC~Zone~State



Where

Zone = 1..32

State = Off, On, Tog or 0, 1, 2



Example

MLServeCmd.MLELANS12|DRC~1~On


Doorbell

DB (Doorbell)

MLServer Command:

DB~State



Where

State = Off, On, Tog or 0, 1, 2



Example

MLServeCmd.MLELKM1|DB~1


Group

GRP (Group)

MLServer Command:

GRP~Zone~State



Where

Zone = 1..32

State = 0, 1 or Off, On



Example

MLServeCmd.MLELANS12|GRP~3~On


Key

KEY (Key Press Event)

MLServer Command:

KEY~Zone~Key


Where

Zone = 1..32

Key = 0..201 One of the keys as shown below



Example

MLServeCmd.MLELANS12|KEY~5~12



These are the same commands as the S12 IR commands.

Key Codes

000 = SYS OFF

001 = ZONE OFF

002 = ZONE ON

003 = ZONE TOG

010 = DND OFF

011 = DND ON

012 = DND TOG

013 = WHM OFF

014 = WHM ON

015 = WHM TOG

016 = MUTE OFF

017 = MUTE ON

018 = MUTE TOG

022 = DRC OFF

023 = DRC ON

024 = DRC TOG

025 = EQ FLAT

032 = TREB DOWN

033 = TREB UP

034 = BASS DOWN

035 = BASS UP

036 = VOLUME DOWN

037 = VOLUME UP

040 = GRP 1/5/9/13 OFF

041 = GRP 2/6/10/14 OFF

042 = GRP 3/7/11/15 OFF

043 = GRP 4/8/12/16 OFF

044 = GRP 1/5/9/13 ON

045 = GRP 2/6/10/14 ON

046 = GRP 3/7/11/15 ON

047 = GRP 4/8/12/16 ON

048 = SOURCE 1

049 = SOURCE 2

050 = SOURCE 3

051 = SOURCE 4

052 = SOURCE 5

053 = SOURCE 6

054 = SOURCE 7

055 = SOURCE 8

056 = SOURCE 9

057 = SOURCE 10

058 = SOURCE 11

059 = SOURCE 12

060 = SOURCE LOCAL

064 = VIDEO1 1

065 = VIDEO1 2

066 = VIDEO1 3

067 = VIDEO1 4

068 = VIDEO1 5

069 = VIDEO1 6

070 = VIDEO1 7

071 = VIDEO1 8

072 = VIDEO1 9

073 = VIDEO1 10

074 = VIDEO1 11

075 = VIDEO1 12

076 = VIDEO1 13

077 = VIDEO1 14

078 = VIDEO1 15

079 = VIDEO1 16

149 = VIDEO1 TRACK

080 = VIDEO2 1

081 = VIDEO2 2

082 = VIDEO2 3

083 = VIDEO2 4

084 = VIDEO2 5

085 = VIDEO2 6

086 = VIDEO2 7

087 = VIDEO2 8

088 = VIDEO2 9

089 = VIDEO2 10

090 = VIDEO2 11

091 = VIDEO2 12

092 = VIDEO2 13

093 = VIDEO2 14

094 = VIDEO2 15

095 = VIDEO2 16

150 = VIDEO2 TRACK

096 = VIDEO3 1

097 = VIDEO3 2

098 = VIDEO3 3

099 = VIDEO3 4

100 = VIDEO3 5

101 = VIDEO3 6

102 = VIDEO3 7

103 = VIDEO3 8

104 = VIDEO3 9

105 = VIDEO3 10

106 = VIDEO3 11

107 = VIDEO3 12

108 = VIDEO3 13

109 = VIDEO3 14

110 = VIDEO3 15

111 = VIDEO3 16

151 = VIDEO3 TRACK

112 = VIDEO4 1

113 = VIDEO4 2

114 = VIDEO4 3

115 = VIDEO4 4

116 = VIDEO4 5

117 = VIDEO4 6

118 = VIDEO4 7

119 = VIDEO4 8

120 = VIDEO4 9

121 = VIDEO4 10

122 = VIDEO4 11

123 = VIDEO4 12

124 = VIDEO4 13

125 = VIDEO4 14

126 = VIDEO4 15

127 = VIDEO4 16

152 = VIDEO4 TRACK

128 = VIDEO5 1

129 = VIDEO5 2

130 = VIDEO5 3

131 = VIDEO5 4

132 = VIDEO5 5

133 = VIDEO5 6

134 = VIDEO5 7

135 = VIDEO5 8

136 = VIDEO5 9

137 = VIDEO5 10

138 = VIDEO5 11

139 = VIDEO5 12

140 = VIDEO5 13

141 = VIDEO5 14

142 = VIDEO5 15

143 = VIDEO5 16

153 = VIDEO5 TRACK

144 = COMPONENT A

145 = COMPONENT B

146 = COMPONENT C

147 = COMPONENT D

148 = COMPONENT E

154 = COMPONENT TRACK

160 = 16X16 VID OUT 01

161 = 16X16 VID OUT 02

162 = 16X16 VID OUT 03

163 = 16X16 VID OUT 04

164 = 16X16 VID OUT 05

165 = 16X16 VID OUT 06

166 = 16X16 VID OUT 07

167 = 16X16 VID OUT 08

168 = 16X16 VID OUT 09

169 = 16X16 VID OUT 10

170 = 16X16 VID OUT 11

171 = 16X16 VID OUT 12

172 = 16X16 VID OUT 13

173 = 16X16 VID OUT 14

174 = 16X16 VID OUT 15

175 = 16X16 VID OUT 16

176 = 16X16 VID IN 01

177 = 16X16 VID IN 02

178 = 16X16 VID IN 03

179 = 16X16 VID IN 04

180 = 16X16 VID IN 05

181 = 16X16 VID IN 06

182 = 16X16 VID IN 07

183 = 16X16 VID IN 08

184 = 16X16 VID IN 09

185 = 16X16 VID IN 10

186 = 16X16 VID IN 11

187 = 16X16 VID IN 12

188 = 16X16 VID IN 13

189 = 16X16 VID IN 14

190 = 16X16 VID IN 15

191 = 16X16 VID IN 16

192 = 16X16 CPN OUT A

193 = 16X16 CPN OUT B

194 = 16X16 CPN OUT C

195 = 16X16 CPN OUT D

196 = 16X16 CPN OUT E

197 = 16X16 CPN IN A

198 = 16X16 CPN IN B

199 = 16X16 CPN IN C

200 = 16X16 CPN IN D

201 = 16X16 CPN IN E

004 = PAGE OFF

005 = PAGE ON

006 = PAGE TOG

007 = DB OFF

008 = DB ON

009 = DB TOG


Mute

MUT (Mute)

MLServer Command:

MUT~Zone~State



Where

Zone = 1..32

State = On, Off, Tog or 0, 1, 2

Example

MLServeCmd.MLELANS12|MUT~2~On


Page

PG (Page)

MLServer Command:

PG~State



Where

State = Off, On, Tog or 0, 1, 2

Example

MLServeCmd.MLELANS12|PG~1


Power

PWR (Power)

MLServer Command:

PWR~Zone~State



Where

Zone = 1..32

State = Off, On, Tog ot 0, 1, 2



Example

MLServeCmd.MLELANS12|PWR~3~Off



Source

SRC (Source)

MLServer Command:

SRC~Zone~Source



Where

Zone = 1..32

Source = 1..13



Example

MLServeCmd.MLELANS12|SRC~2~12 SysOff

SYSOFF (System Off)

MLServer Command:

SYSOFF



Example

MLServeCmd.MLELANS12|SYSOFF



Set Treble

TRE (Set Treble)

MLServer Command:

TRE~Zone~Level



Where

Zone = 1..32

Level = -18 .. +18



Example

MLServeCmd.MLELANS12|TRE~4~+12


Whole House Music

WHM (Whole House Music)

MLServer Command:

WHM~Zone~State



Where

Zone = 1..32

State = Off, On, Tog or 0, 1, 2



Example

MLServeCmd.MLELANS12|WHM~1~On



Component Routing

COR (Component Routing)

MLServer Command:

COR~Unit~Output~Input


Where

Unit = 1..5

Output = 1..12

Input = 1..12



Example

MLServeCmd.MLELANS12|COR~1~8~5



Whole House Music

WHM (Whole House Music)

MLServer Command:

WHM~Zone~State



Where

Zone = 1..32

State = Off, On, Tog or 0, 1, 2



Example

MLServeCmd.MLELANS12|WHM~1~On


Component Routing

COR (Component Routing)

MLServer Command:

COR~Unit~Output~Input



Where

Unit = 1..5

Output = 1..12

Input = 1..12



Example

MLServeCmd.MLELANS12|COR~1~8~5


Video Panel

VID (Video Panel)

MLServer Command:

VID~Panel~Zone~Input



Where

Panel = 1..5

Zone = 1..32

Input = 1.12



Example

MLServeCmd.MLELANS12|VID~2~6~9



Video Routing

VOR (Video Routing)

MLServer Command:

VOR~Unit~Output~Input



Where

Unit = 1..5

Output = 1..12

Input = 1..12



Example

MLServeCmd.MLELANS12|VOR~2~9~4


Audio Signal Detect

ASD (Audio Signal Detect)

MLServer Command:

ASD~Unit



Where

Unit = 1..5



Example

MLServeCmd.MLELANS12|ASD~1



Local Signal Detect

LSD (Local Signal Detect)



MLServer Command:

LSD~Unit



Where

Unit = 1..5



Example

MLServeCmd.MLELANS12|LSD~1


Page Detect

PGD (Page Detect Query)

MLServer Command:

PGD~Unit



Where

Unit = 1..5



Example

MLServeCmd.MLELANS12|PGD~1


Sense Trigger Input

STI (Sense Trigger Input)



MLServer Command:

STI~Unit



Where

Unit = 1..5



Example

MLServeCmd.MLELANS12|STI~1



Video Signal Detect

VSD (Video Signal Detect)



MLServer Command:

VSD~Unit



Where

Unit = 1..5



Example

MLServeCmd.MLELANS12|VSD~1