MLKrellHTS Plugin

From Cinemar Wiki
Jump to: navigation, search

Introduction

The following paragraphs detail the installation, configuration and usage of the MainLobby / MLServer Krell HTS Pre-Amp Plug-In. Installation and Configuration

This plug-in is capable of supporting a total of four Krell HTS Pre-Amplifiers attached to a PC serial port or a Global Cache GC100 style serial port. Installation

Start the automated setup program by double clicking on the “Setup.exe” file.



The program will install both the documentation (Full Installation), the plugin only (Compact Installation) or you may choose which components you would like to install (Custom Installation). The automated setup will also register the plugin as a windows component.



You may de-install the plugin via the Windows Add/Delete Programs icon in the control panel. Configuration

This plug-in must be configured prior to using it in a Main Lobby scene. Highlight the MLKrellHTS plug-in in MLServer and click on the Settings button to bring up the Krell HTS plug-in configuration screen. You will be presented with a tabbed dialog box of configuration settings. The plugin must be configured to connect to the Pre-Amp via either a serial port or GlobalCache GC-100 device. Use the respective tabs to configure the connection to the Pre-Amp. 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 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 1.

The Serial Tab

Use this tab to configure the serial port(s) that will be used to control the various Pre-Amps. For each Pre-Amp that is attached to a PC serial port set the serial port data and then specify the Pre-Amp number to be associated with the Pre-Amp on the serial port. Pre-Amps should be numbered sequentially from 1 to 4. If there is no Pre-Amp attached to the serial port then set the Pre-Amp number to the default value of N/A. See Figure 2. The Global Cache Tab

The Global Cache Tab

Use this tab to configure the Global Cache serial port(s) that will be used to control the various Pre-Amps. For each Pre-Amp that is attached to a Global Cache serial port set the IP address and port number associated with the Pre-Amp. Pre-Amps should be numbered sequentially from 1 to 4. If there is no Pre-Amp attached to the Global Cache serial port then set the Pre-Amp number to the default value of N/A. See Figure 3.

The Options Tab

This tab is used to configure options for the plug-in. Options include the ability to change the Variable Prefix, renaming inputs, and limiting volume. The Variable Prefix affects what MLServer variables are created by the plugin. The Input Rename feature allows renaming devices with a more meaningful name, i.e. an HTPC is hooked up to Aux 1 could have HTPC entered into the Aux 1 box. Whenever Aux 1 is selected, the input variable would reflect HTPC instead of Aux1. See Figure 4.

The Zone Triggers Tabs

These tabs are used to configure triggers for specific zone commands. Each zone has triggers for four receivers. The commands entered into each box are run upon receipt of the specified command. Commands are entered with the syntax required by MLServe commands, i.e. "MLKrellHTS|DC1TrigCntrl~On" entered into the Power On box would send the command back to the plugin to turn the DC Trigger control on whenever a power on command is received for the Pre-Amp. See Figure 5.

MLServer Variables

This plug-in has the ability to collect status information from the Receivers and automatically create ML Server variables that reflect the status of each of the Pre-Amp.

The following are some of the ML Server variables that will be created during normal operation of the Pre-Amp, with example data:

krellhts_1_autostatus On

krellhts_1_backspeakers Enabled

krellhts_1_backtrim 0

krellhts_1_centerspeaker Enabled

krellhts_1_centertrim 0

krellhts_1_compression Max

krellhts_1_currentzone 1

krellhts_1_decodemode Pro-Logic II Movie + THX

krellhts_1_inputstream PCM Analog Input

krellhts_1_inputtrigger Off

krellhts_1_menumode Off

krellhts_1_modeled Mode 2

krellhts_1_roomeq Memory 1

krellhts_1_subtrim 0

krellhts_1_subwoofer Enabled

krellhts_1_surroundspeakers Enabled

krellhts_1_surroundtrim 0

krellhts_1_systemmute On

krellhts_1_trigger1 Off

krellhts_1_trigger2 Off

krellhts_1_trigger3 Off

krellhts_1_trigger4 Off

krellhts_1_z1balance Centered

krellhts_1_z1currentdevice Sat

krellhts_1_z1mute Of

krellhts_1_z1power On

krellhts_1_z1volume 9

krellhts_1_z2balance Centered

krellhts_1_z2currentdevice Sat

krellhts_1_z2mute Off

krellhts_1_z2only Off

krellhts_1_z2power Off

krellhts_1_z2volume 0

Where

x = Pre-Amp number 1..4


Commands

Sending Remote Commands

ML Server Command:

Command~Parameter~Pre-Amp



      Where

Command = (Zone1, Zone2, ZnPower, ZnVol, ZnMute, ZnInput, Power, Vol, Input,

              DCnTrigCntrl, AudioDecode, GUIKey, Status, RoomEQ, Compression,
              ZnBalance, Balance, Balance, CenterTrim, BackTrim, SurroundTrim, SubTrim )


      Where        z = 1, 2 or 3
                      x = 1 or 2
                      n = A or B



Pre-Amp = Pre-Amp number (1..4) (Optional)



Example:



MLKrellHTS|Z1Power~On~1

MLKrellHTS|Z1Input~Sat (Would operate on Pre-Amp #1)


Zone Commands

ML Server Command:

Zone1~Pre-Amp

Zone2~Pre-Amp



      Where

Pre-Amp = Pre-Amp number (1..4) optional



This command will set the current zone for subsequent operations.


Sending Power Commands

ML Server Command:

ZnPower~On/Off~Pre-Amp

Power~On/Off~Pre-Amp



      Where

n = Zone number (1/2) required

Pre-Amp = Pre-Amp number (1..4) optional



The second form of the command will operate on the currently selected zone.


Sending Volume Commands

ML Server Command:

ZnVol~Up/Down~Pre-Amp

ZnVol~###~Pre-Amp

Vol~Up/Down~Pre-Amp




      Where

n = Zone number (1..2) required

      1. = Direct volume setting (001-152) required

Pre-Amp = Pre-Amp number (1..4) optional






ML Server Command:

ZnMute~On/Off~Pre-Amp

Mute~Pre-Amp



      Where

n = Zone number (1..2) required

Pre-Amp = Pre-Amp number (1..4) optional



The versions of the command without a zone number included operate on the current zone.


Sending System Status Commands

ML Server Command:

Status~AutoEnable~Pre-Amp

Status~AutoDisable~Pre-Amp

Status~Get~Pre-Amp




      Where

Pre-Amp = Pre-Amp number (1..4) optional



The system is automatically put into automatic status reporting whenever it is powered on by the plugin. In order for status commands to be generated correctly, automatic reporting should remain on.


Sending Input Change Commands

ML Server Command:

ZnInput~Param~Pre-Amp

Input~Param~Pre-Amp



      Where

Param = Pre-Amp Input:

(DVD, LD, SAT, VCR, TV, CD, TUNER, AUX1, AUX2, TAPE)

n = Zone number (1..3) required

Pre-Amp = Pre-Amp number (1..4) optional



The versions of the command without a zone number included operate on the current zone.


Sending Digital Signal Processor (DSP) Mode Commands



ML Server Command:

AudioDecode~Param~Pre-Amp



      Where

Param = Mode1, Mode2, ProLogic, Stereo, PreAmp,THX,DD51,DD51THX, DD51THXEX,

                AC3Stereo, AC3PLIIMovie, AC3PLIIMusic, AC3PLIIMatrix, AC3PLIIEM, AC3PLIIMovieTHX,
              AC3PLIIEMTHX, DTS51Music, DTS51Movie, DTS51Matrix, DTS51MovieTHX, DTS51MatrixTHX,
              DTS51Discrete, DTS51DiscreteTHX, DTS51Force, StereoPass, PLIIMovie, PLIIMusic, PLIIMatrix,
              PLIIEM,PLIIEMTHX,PLIIMovieTHX, DTSNeo6Cin6, DTSNeo6Music, DTSNeoCin6THX, Party,
              GeneralAdmission,FrontRow, OnStage, Enhanced, Orchestra, Mezzanine, FullRangeSub,
              Monophonic, 2496Decode




Pre-Amp = Pre-Amp number (1..4) optional


Sending Compression Commands

ML Server Command:

Compression~Param~Pre-Amp



      Where

Param = Night, Normal, Max

Pre-Amp = Pre-Amp number (1..4) optional


Sending Room EQ Commands

ML Server Command:

RoomEQ~Param~Pre-Amp



      Where

Param = (1..4) Room Equalization Memory Setting

Pre-Amp = Pre-Amp number (1..4) optional


Sending DC Trigger Commands

ML Server Command:

DCxTrigCntrl~On/Off~Pre-Amp



      Where

x = DC Trigger number (1..4) required

Pre-Amp = Pre-Amp number (1..4) optional


Sending GUI Key Commands

ML Server Command:

GUIKey~Param~Receiver



      Where

Param = Previous, Enter, Menu, Up, Down, Right, Left required

Pre-Amp = Pre-Amp number (1..4) optional



These commands operate on the currently selected zone or menu operation.


Speaker Control Commands

ML Server Command:

ZnBalance~Up/Down~Pre-Amp

ZnBalance~###~Pre-Amp

Balance~Up/Down~Pre-Amp

Balance~###~Pre-Amp



      Where

n = Zone number (1..2) required

      1. = Direct trim setting (000-020) required

Pre-Amp = Pre-Amp number (1..4) optional



ML Server Command:

CenterTrim~Up/Down~Pre-Amp

CenterTrim~###~Pre-Amp



      Where
      1. = Direct trim setting (000-020) required

Pre-Amp = Pre-Amp number (1..4) optional



ML Server Command:

CenterTrim~Up/Down~Pre-Amp

CenterTrim~###~Pre-Amp



      Where
      1. = Direct trim setting (000-020) required

Pre-Amp = Pre-Amp number (1..4) optional




ML Server Command:

SubTrim~Up/Down~Pre-Amp

SubTrim~###~Pre-Amp



      Where
      1. = Direct trim setting (000-020) required

Pre-Amp = Pre-Amp number (1..4) optional




ML Server Command:

SurroundTrim~Up/Down~Pre-Amp

SurroundTrim~###~Pre-Amp



      Where
      1. = Direct trim setting (000-020) required

Pre-Amp = Pre-Amp number (1..4) optional



ML Server Command:

BackTrim~Up/Down~Pre-Amp

BackTrim~###~Pre-Amp



      Where
      1. = Direct volume setting (000-020) required

Pre-Amp = Pre-Amp number (1..4) optional