MLCav66 Plugin

From Cinemar Wiki
Jump to: navigation, search

About

Plugin to control Russound Cav 6.6

SoftwareRequirements

  • MLServer 3
  • MainLobby 3

SupportedHardware

  • Russound CAV 6.6
  • Russound CAM 6.6
  • Russound CAA 6.6
  • Russound CAS44
  • Russound CA4
  • Russound MCA-C5

Installation

Configuration

This plug-in must be configured prior to using it in a MainLobby scene. Highlight the MLCAV66 plug-in in MLServer and click on the Settings button to bring up the CAV 6.6 configuration screen. You will be presented with a tabbed dialog box of configuration settings as shown in Figure 1.

CAVFig1.jpg

Figure 1.

The Events Tab

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

CAVFig1.jpg

Figure 2.

The Configuration Tab

Use this tab to configure the various CAVs that you have connected to the system. In this section you will configure all the parameters required to establish connectivity to your CAV controllers and associate MLServer command triggers to certain CAV events. See Figure 3.

CAVFig3.jpg

Figure 3.

CAV Configuration

All of the configuration options are optional with the exception of the configuration of the CAV controller itself. For each controller in your setup you must assign unique property values for proper operation. To configure your CAV controller click on the CAV in the list (Primary CAV in this example). This will bring up the CAV editing dialog as shown in Figure 4.

CAVFig4a.jpg

CAVFig4b.jpg

Figure 4.

CAV Fields

CAV ID: This is the unique value used to identify this CAV. This should be a number between 1 and 6.

Alias: The friendly name for this CAV controller.

Comment: Description of this CAV for documentation.

Initialize MLServer Variables on Load: Check this box to enable the pre-loading of all CAV MLserver variables when the plug-in loads.

Zone and Source Configuration

For each Zone in your CAV you can assign Zone Alias names and descriptions to help document and identify the you configuration. To change the Zone and Source information click on the Zone or Source in question to bring up the appropriate editing tab. See Figures 5 and 6.

CAVFig5a.jpg

CAVFig5b.jpg

Figure 5.

CAVFig6.jpg

Figure 6.

Trigger Configuration

For each Zone Source you have the ability to define MLServer commands that will be fired when you press a key on an Uno keypad or press a button on the CAV remote. Locate the event trigger for the particular source in the zone in interest and click on the button that you want to assign an event trigger to. See Figure 7.

CAVFig7a.jpg

CAVFig7b.jpg

Figure 7.

ReleaseNotes

Supported Commands

Adjust Backround Color

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|AdjBgClr~Controller~Zone~Command


(Literal)

MLServeCmd.MLCAV66|AdjBgClr~1~2~Up


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)
Command = (Up, Down)


Description

Adjusts Keypad background color.


Adjust Balance

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|AdjBalance~Controller~Zone~Command


(Literal)

MLServeCmd.MLCAV66|AdjBalance~1~2~Up


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)
Command = (Up, Down)


Description

Adjusts Left and Right balance.


Adjust Bass Level

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|AdjBass~Controller~Zone~Command


(Literal)

MLServeCmd.MLCAV66|AdjBgClr~1~2~Down


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)
Command = (Up, Down)


Description

Adjusts Zone Bass level.


Adjust Party Mode

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|AdjPartyMode~Controller~Zone~Command


(Literal)

MLServeCmd.MLCAV66|AdjPartyMode~1~2~Up


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)
Command = (Up, Down)


Description

Adjusts Party Mode.


Adjust Trebel Level

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|AdjTrebleLevel~Controller~Zone~Command


(Literal)

MLServeCmd.MLCAV66|AdjTrebleLevel~1~2~Up


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)
Command = (Up, Down)


Description

Adjusts treble level.


Adjust Turn On Volume

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|AdjTOV~Controller~Zone~Command


(Literal)

MLServeCmd.MLCAV66|AdjTOV~1~2~Up


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)
Command = (Up, Down)


Description

Adjusts turn on volume level.


Adjust Zone Parameters

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|AdjZone~Controller~Zone~Parameter~Value


(Literal)

MLServeCmd.MLCAV66|AdjZone~1~2~Bass~Up


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)
Parameter = (Bass, Treble, Loudness, Balance, TOV, BgColor, DND, Party, FAV)
Value = (Up, Down)


Description

Adjusts Zone Setting.


Get Background Color

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|GetBgClr~Controller~Zone


(Literal)

MLServeCmd.MLCAV66|GetBgClr~1~2


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)


Description

Returns keypad background color to a variable.


Get Balance

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|GetBalance~Controller~Zone


(Literal)

MLServeCmd.MLCAV66|GetBalance~1~2


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)


Description

Returns balance to a variable.


Get Bass Level

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|GetBass~Controller~Zone


(Literal)

MLServeCmd.MLCAV66|GetBass~1~2


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)


Description

Returns bass level to a variable.


Get Do Not Disturb

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|GetDND~Controller~Zone


(Literal)

MLServeCmd.MLCAV66|GetDND~1~2


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)


Description

Returns do not disturb settings to variables.


Get Loudness

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|GetLoudness~Controller~Zone


(Literal)

MLServeCmd.MLCAV66|GetLoudness~1~2


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)


Description

Returns loudness setting to a variable.


Get Party Mode

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|GetPartyMode~Controller~Zone


(Literal)

MLServeCmd.MLCAV66|GetPartyMode~1~2


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)


Description

Returns party mode settings to a variable.


Get Treble Level

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|GetTreble~Controller~Zone


(Literal)

MLServeCmd.MLCAV66|GetTreble~1~2


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)


Description

Returns treble level for each zone to a variable.


Get Turn On Volume

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|GetTOV~Controller~Zone


(Literal)

MLServeCmd.MLCAV66|GetTOV~1~2


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)


Description

Returns turn on volume levels for each zone to a variable.


Get Zone Power

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|GetZonePower~Controller~Zone


(Literal)

MLServeCmd.MLCAV66|GetZonePower~1~2


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)


Description

Returns the power status of the specified zone to a variable.


Get Zone Source

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|GetZoneSource~Controller~Zone


(Literal)

MLServeCmd.MLCAV66|GetZoneSource~1~2


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)


Description

Returns the specified zones source setting to a variable.


Get Zone Status

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|GetZone~Controller~Zone


(Literal)

MLServeCmd.MLCAV66|GetZone~1~3


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)


Description

Returns zone status variables.


Get Zone Volume

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|GetVolume~Controller~Zone


(Literal)

MLServeCmd.MLCAV66|GetVolume~1~2


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)


Description

Returns the volume level for the specified zone to a variable.


Sending a Message to All Keypads

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|MessageAll~Controller~Message~Alignment~Time


(Literal)

MLServeCmd.MLCAV66|MessageAll~1~Hello World~Left~10


Parameters
Controller = CAV 6.6 Controller (1..6)
Message = Keypad message (truncates at 31 characters maximum)
Alignment = (Left, Center)
Time = Seconds to display message. If "0" or not set, the message is displayed indefinitely.


Description

Sends a message to all connected Russound keypads.


Sending a Message to Keypads with a Selected Source

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|SrcMessage~Controller~Message~Source~Time


(Literal)

MLServeCmd.MLCAV66|SrcMessage~1~Hello World~2~10


Parameters
Controller = CAV 6.6 Controller (1..6)
Message = Keypad message (truncates at 31 characters maximum)
Source = (1..6)
Time = Seconds to display message. If "0" or not set, the message is displayed indefinitely.


Description

Sends a message to all connected Russound keypads with the specified source.


Sending a Message to a Keypad

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|Message~Controller~Zone~Keypad~Message~Alignment~Time


(Literal)

MLServeCmd.MLCAV66|Message~1~2~3~Hello World~Left~10


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)
Keypad = Keypad Number (1..6)
Message = Keypad message (truncates at 31 characters maximum)
Alignment = (Left, Center)
Time = Seconds to display message. If "0" or not set, the message is displayed indefinitely.


Description

Sends a message to all specified Russound keypad.


Sending IR Commands

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|IR~Controller~Zone~Command


(Literal)

MLServeCmd.MLCAV66|IR~1~2~Mute


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)
Command = (Btn1, Btn2, Btn3, Btn4, Btn5, Btn6, Btn7, Btn8, Btn9, Btn0, VolUp, VolDown, Mute, ChanUp, ChanDown, Power, Enter, PrevChan, TVVideo, TVVCR, AB, TVDVD, TVLD, Input, TVDSS, Play, Stop, SrchFwd, SrchRew, Pause, Record, Menu, MenuUp, MenuDown, MenuLeft, MenuRight, Select, Exit, Display, Guide, PageUp, PageDown, Disk, Plus10, OpenClose, Random, TrackFwd, TrackRev, Surround, SurroundMode, SurroundUp, SurroundDown, PIP, PIPMove, PIPSwap, Program, Sleep, On, Off, 11, 12, 13, 14, 15, 16, Bright, Dim, Close, Open, Stop2, AMFM, Cue, DiskUp, DiskDown, Info)


Description

Sends an IR remote command.


Sending Keypad Commands

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|Keypad~Controller~Zone~Command


(Literal)

MLServeCmd.MLCAV66|Keypad~1~5~Pause


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)
Command = (Setup, Previous, Next, Plus, Minus, SourceStep, PowerToggle, Stop, Pause, Fav1, Fav2, Play, VolUp, VolDown)


Description

Sends a keypad command.


All Power

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|AllPower~Command


(Literal)

MLServeCmd.MLCAV66|AllPower~On


Parameters
Command = (On, Off)


Description

Sends a power command to all Russound Zones on all controllers.


CAV Power

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|CAVPower~Controller~Command


(Literal)

MLServeCmd.MLCAV66|CAVPower~1~On


Parameters
Controller = CAV 6.6 Controller (1..6)
Command = (On, Off)


Description

Sends a power command to a specified Russound Controller.


Set Zone Power

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|ZonePower~Controller~Zone~Command


(Literal)

MLServeCmd.MLCAV66|ZonePower~1~1~On


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)
Command = (On, Off)


Description

Sets a specified zones power.


Set Zone Source

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|ZoneSource~Controller~Zone~Source


(Literal)

MLServeCmd.MLCAV66|ZoneSource~1~2~4


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)
Source = Source Number (1..6)


Description

Sets the source number for a specified zone.


Set Volume

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|SetVolume~Controller~Zone~Volume


(Literal)

MLServeCmd.MLCAV66|SetVolume~1~2~88


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)
Volume = Volume Level (0..100)


Description

Sets the volume level for the specified zone.


Set Zone

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|SetZone~Controller~Zone~Parameter~Value


(Literal)

MLServeCmd.MLCAV66|SetZone~1~2~Bass~56


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)
Param/Value = (Bass/(0..100), Treble/(0..100), Loudness/(On,Off), Balance/(0..100), TOV/(0..100), BgColor/(Off,Amber,Green), DND/(Off,On), Party/(On,Off,Master), FAV/(On,Off))


Description

Sets a zone parameter.


Set Bass Level

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|SetBass~Controller~Zone~Command


(Literal)

MLServeCmd.MLCAV66|SetBass~1~2~50


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)
Command = Bass Level (0..100)


Description

Sets bass level.


Set Background Color

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|SetBgClr~Controller~Zone~Command


(Literal)

MLServeCmd.MLCAV66|SetBgClr~1~2~Amber


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)
Command = Color (Off, Amber, Green)


Description

Sets Russound keypad Background Color.


Set Balance

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|SetBalance~Controller~Zone~Command


(Literal)

MLServeCmd.MLCAV66|SetBalance~1~2~52


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)
Command = Balance Level (0..100)


Description

Sets balance level.


Set Do Not Disturb

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|SetDND~Controller~Zone~Command


(Literal)

MLServeCmd.MLCAV66|SetBass~1~2~Off


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)
Command = (Off, On)


Description

Turn Do Not Disturb mode on or off for the specified zone.


Set Loudness Level

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|SetLoudness~Controller~Zone~Command


(Literal)

MLServeCmd.MLCAV66|SetLoudness~1~2~On


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)
Command = Loudness (On, Off)


Description

Turns loudness On or Off for the specified zone.


Set Party Mode

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|SetPartyMode~Controller~Zone~Command


(Literal)

MLServeCmd.MLCAV66|SetPartyMode~1~2~On


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)
Command = Party Mode (Off, On, Master)


Description

Sets party mode.


Set Treble Level

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|SetTreble~Controller~Zone~Command


(Literal)

MLServeCmd.MLCAV66|SetTreble~1~2~43


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)
Command = Treble Level (0..100)


Description

Sets treble level.


Set Turn On Volume Level

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|SetTOV~Controller~Zone~Command


(Literal)

MLServeCmd.MLCAV66|SetTOV~1~2~30


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)
Command = Volume Level (0..100)


Description

Sets turn on volume level.


Toggle Do Not Disturb

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|ToggleDND~Controller~Zone


(Literal)

MLServeCmd.MLCAV66|ToggleDND~1~2


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)


Description

Toggle do not disturb on the specified zone.


Toggle Loudness

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|ToggleLoudness~Controller~Zone


(Literal)

MLServeCmd.MLCAV66|ToggleLoudness~1~2


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)


Description

Toggle loudness for the specified zone.


Toggle Party Mode

{MLServeCmd}Script Usage

MLServeCmd.MLCAV66|TogglePartyMode~Controller~Zone


(Literal)

MLServeCmd.MLCAV66|TogglePartyMode~1~2


Parameters
Controller = CAV 6.6 Controller (1..6)
Zone = Zone Number (1..6)


Description

Toggle party mode for the specified zone.


MLServer Variables

cav66_c{{RSController}}z{{RSZone}}_state

Description:

Values: On,Off

cav66_c{{RSController}}z{{RSZone}}_source

Description:

Values: 1,2,3,4,5,6

cav66_c{{RSController}}z{{RSZone}}_sourcename

Description:

Values: Text

cav66_c{{RSController}}z{{RSZone}}_zonename

Description:

Values: Text

cav66_c{{RSController}}z{{RSZone}}_volume

Description:

Values: A number 0 to 100

cav66_c{{RSController}}z{{RSZone}}_tov

Description:

Values: A number 0 to 100

cav66_c{{RSController}}z{{RSZone}}_bass

Description:

Values: A number -20 to 20

cav66_c{{RSController}}z{{RSZone}}_bassrel

Description:

Values: A number 0 to 100

cav66_c{{RSController}}z{{RSZone}}_treble

Description:

Values: A number -20 to 20

cav66_c{{RSController}}z{{RSZone}}_treblerel

Description:

Values: A number 0 to 100

cav66_c{{RSController}}z{{RSZone}}_balance

Description:

Values: A number -20 to 20

cav66_c{{RSController}}z{{RSZone}}_balancerel

Description:

Values: A number 0 - 100

cav66_c{{RSController}}z{{RSZone}}_loudness

Description:

Values: On, Off

cav66_c{{RSController}}z{{RSZone}}_systemstate

Description:

Values: 0,1

cav66_c{{RSController}}z{{RSZone}}_party

Description:

Values: On, Off

cav66_c{{RSController}}z{{RSZone}}_partymaster

Description:

Values: On, Off

cav66_c{{RSController}}z{{RSZone}}_dnd

Description:

Values: On, Off

cav66_c{{RSController}}z{{RSZone}}_artist

Description:

Values: Artist name

cav66_c{{RSController}}z{{RSZone}}_album

Description:

Values: Album name

cav66_c{{RSController}}z{{RSZone}}_title

Description:

Values: Song title name