MLPioneerVSX Plugin

From Cinemar Wiki
Jump to: navigation, search

Pioneer Elite VSX Plug-In User’s Guide


Introduction

Overview

The following guide details the installation, configuration and usage of the MLServer Pioneer Elite VSX Plug-In.

Users have tested it with VSX-92TXH and VSX56TXi with good success. It may work on others. Please advise by editing this document if you have success or failures with other RS232 Pioneer receivers.

Plugin written by Kurt (geislerk)


Installation and Configuration

This plug-in is capable of supporting up to four Pioneer Elite VSX receivers attached to a PC’s RS-232 Serial port or a Global Cache GC100 RS-232 Serial port.

Installation

1. Copy the MLPioneerVSX.dll file to the MLServer Plugins folder. This is typically located in the C:\Program Files\MLServer\Plugins folder.

2. After copying the plug-in file to the folder you must register the plug-in with Windows. Click on your Windows Start menu and select Run.

3. On the Open: command line, type the following to register the plug-in: RegSvr32 “C:\Program Files\MLServer\Plugins\MLPioneerVSX.dll”

4. Select OK and you should see a pop-up window displaying confirmation that the plug-in is now registered.

Configuration

This plug-in must first be configured prior to using it.

1. Launch MLServer.

2. If your plug-in’s are not displayed, select View and Plug-ins from the main menu.

3. Highlight the MLPioneerVSX plug-in and click on the Settings button to bring up the configuration screen. You will be presented with a tabbed dialog box of configuration settings as shown in Figure 1. Pioneer Elite VSX Plug-In User’s Guide

One user recommended setting the baud rate to 9600 as what worked for his VSX-94TXH.


The Event Log Tab

This tab is used to collect and view the status of the plug-in while in 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 Receivers Tab

Use this tab to configure the RS-232 Serial port that will be used to control the Pioneer Elite VSX receiver. You can control up to four Pioneer Elite receivers with this plug-in. You can use either a PC RS-232 Serial port or a Global Cache Serial port. If you use a Global Cache Serial port, make sure you configure the port using the Global Cache web interface. The Serial port that is currently enabled will be used to control the receiver. See Figure 2.

The Triggers Tab

Use this tab to define MLServer commands that are to be executed whenever one of the specified variables changes. Also, you can limit the maximum volume allowed by specifying a value in the Limit field. The default maximum value is 89. See Figure 3.


Supported Commands

Command Syntax: MLServeCmd.MLPioneerVSX|<<device#>>~<<command>>[~<<parms>>]

Example #1:

To turn receiver #1’s power on you would type the following MLServeCmd: MLServeCmd.MLPioneerVSX|1~PowerOn

Example #2:

To set receiver #1’s volume to 40 you would type the following MLServeCmd: MLServeCmd.MLPioneerVSX|1~SetVolume~40


Command List

General Receiver

Command Description

POWERON POWER ON

POWEROFF POWER OFF

MUTEON MUTE ON

MUTEOFF MUTE OFF

VOLUMEUP VOLUME UP

VOLUMEDOWN VOLUME DOWN

INPUTUP INPUT UP – CYCLES THROUGH INPUTS

PHONO SELECTS PHONO INPUT

CD SELECTS CD INPUT

TUNER SELECTS TUNER INPUT

CDR SELECTS CDR INPUT

DVD SELECTS DVD INPUT

TV SELECTS TV INPUT

SAT SELECTS SAT INPUT

VIDEO1 SELECTS VIDEO1 INPUT

MULTICH SELECTS MULTI CHANNEL INPUT

VIDEO2 SELECTS VIDEO2 INPUT

DVR SELECTS DVR INPUT

DVR2 SELECTS DVR2 INPUT

IPOD SELECTS IPOD INPUT

XM SELECTS XM RADIO INPUT

HDMI1 SELECTS HDMI1 INPUT

HDMI2 SELECTS HDMI2 INPUT

GETVOLUME GETS CURRENT VOLUME STATUS FROM RECEIVER

GETMUTE GETS MUTE STATUS

GETFUNCTION GETS FUNCTION MODE STATUS

GETSTATUS GETS ALL STATUS

GETTONE GETS TONE STATUS

GETBASS GETS BASE STATUS

GETTREBLE GETS TREBLE STATUS

GETTUNERPRESET GETS STATUS OF CURRENT TUNER PRESET

Pioneer Elite VSX Plug-In User’s Guide

GETTUNERFREQ GETS STATUS OF CURRENT TUNER FREQUENCY

GETPOWERZONE2 GETS POWER STATUS OF ZONE2

GETPOWERZONE3 GETS POWER STATUS OF ZONE3

GETFUNCTIONZONE2 GETS FUNCTION MODE STATUS OF ZONE2

GETFUNCTIONZONE3 GETS FUNCTION MODE STATUS OF ZONE3

GETVOLUMEZONE2 GETS VOLUME STATUS OF ZONE2

GETXMCHANNEL GETS STATUS OF CURRENT XM CHANNEL

SETVOLUME ALLOWS YOU TO SET A SPECIFIC VOLUME LEVEL (0-98)

SETVOLUMESCALED SET THE VOLUME SCALED TO 100 FOR USE WITH SLIDERS

SETLM ALLOWS YOU TO SET A SPECIFIC LISTENING MODE

TONETOGGLE TOGGLE TONE CONTROL ON OR OFF

BASSUP INCREASE BASS LEVEL

BASSDOWN DECREASE BASS LEVEL

TREBLEUP INCREASE TREBLE LEVEL

TREBLEDOWN DECREASE TREBLE LEVEL

TUNERBANDTOGGLE TOGGLE TUNER BAND AM/FM

TUNERPRESET ALLOWS YOU TO SET A SPECIFIC TUNER PRESET

TUNERCLASS

TUNERPRESETUP CYCLE UP THROUGH TUNER PRESETS

TUNERPRESETDOWN CYCLE DOWN THROUGH TUNER PRESETS

TUNERFREQUP TUNER FREQUENCY UP

TUNERFREQDOWN TUNER FREQUENCY DOWN

TUNERPRESET ALLOWS YOU TO SET A SPECIFIC TUNERPRESET

VOLUMEUPZONE2 ZONE2 VOLUME UP

VOLUMEDOWNZONE2 ZONE2 VOLUME DOWN

SETVOLUMEZONE2 ALLOWS YOU TO SET A SPECIFIC VOLUME LEVEL FOR ZONE2

SETVOLUMEZONE2SCALED SET VOLUME SCALED TO 100 FOR USE WITH SLIDERS ZONE2

VOLUMEONZONE2 TURNS VOLUME IN ZONE2 ON

VOLUMEOFFZONE2 TURNS VOLUME IN ZONE2 OFF

VOLUMEONZONE3 TURNS VOLUME IN ZONE3 ON

VOLUMEOFFZONE3 TURNS VOLUME IN ZONE3 OFF

STATUSDISPLAYTOGGLE TOGGLES STATUS DISPLAY ON/OFF

XMCMD USED WHEN SPECIFYING XM RADIO COMMANDS


Command Syntax

MLServeCmd.MLPioneerVSX|1~XMCMD~CHANNELUP

IPODCMD USED WHEN SPECIFYING IPOD COMMANDS

Command Syntax:

MLServeCmd.MLPioneerVSX|1~IPODCMD~PLAY

CMD USED WHEN SPECIFYING AN RS-232 COMMAND

Command Syntax:

MLServeCmd.MLPioneerVSX|1~CMD~VU<CR>

Note: VU<CR> is the Pioneer RS-232 command for Volume Up

Example
To send the command for HDMI3 is "21FN"

MLServeCmd.MLPioneerVSX|1~CMD~21FN


iPod (IPODCMD)

Command Description

PLAY USED TO NAVIGATE OSD

PAUSE USED TO NAVIGATE OSD

STOP USED TO NAVIGATE OSD

PREV USED TO NAVIGATE OSD

NEXT USED TO NAVIGATE OSD

REV USED TO NAVIGATE OSD

Pioneer Elite VSX Plug-In User’s Guide

FWD USED TO NAVIGATE OSD

REPEAT USED TO NAVIGATE OSD

SHUFFLE USED TO NAVIGATE OSD

DISPLAY USED TO NAVIGATE OSD

OSD USED TO NAVIGATE OSD

VOLUMEUP USED TO NAVIGATE OSD

VOLUMEDOWN USED TO NAVIGATE OSD

CURSORUP USED TO NAVIGATE OSD

CURSORDOWN USED TO NAVIGATE OSD

CURSORRIGHT USED TO NAVIGATE OSD

CURSORLEFT USED TO NAVIGATE OSD

ENTER USED TO NAVIGATE OSD

RETURN USED TO NAVIGATE OSD

CATEGORY USED TO NAVIGATE OSD


XM Radio (XMCMD)

Command Description

STATION1 USED TO NAVIGATE OSD

STATION2 USED TO NAVIGATE OSD

STATION3 USED TO NAVIGATE OSD

STATION4 USED TO NAVIGATE OSD

STATION5 USED TO NAVIGATE OSD

STATION6 USED TO NAVIGATE OSD

STATION7 USED TO NAVIGATE OSD

STATION8 USED TO NAVIGATE OSD

STATION9 USED TO NAVIGATE OSD

STATION10 USED TO NAVIGATE OSD

CHANNELUP USED TO NAVIGATE OSD

CHANNELDOWN USED TO NAVIGATE OSD

PRESETUP USED TO NAVIGATE OSD

PRESETDOWN USED TO NAVIGATE OSD

DISPLAY USED TO NAVIGATE OSD

PRESET USED TO NAVIGATE OSD

CLASS USED TO NAVIGATE OSD

DIRECT USED TO NAVIGATE OSD

MEMORY USED TO NAVIGATE OSD

MENU USED TO NAVIGATE OSD

CLEAR USED TO NAVIGATE OSD

ENTER USED TO NAVIGATE OSD

RETURN USED TO NAVIGATE OSD

CATEGORY USED TO NAVIGATE OSD

  • OSD = On Screen Display


Contributed by bjdraw:

Auto

MLServeCmd.MLPioneerVSX|1~setlm~6

Direct

MLServeCmd.MLPioneerVSX|1~setlm~7

Pure Direct

MLServeCmd.MLPioneerVSX|1~setlm~8

Stereo

MLServeCmd.MLPioneerVSX|1~setlm~9



MLServer Two-Way Status Support

The Pioneer Elite VSX receiver will generate a feedback status message whenever a command is sent to the receiver. This plug-in will automatically create MLServer variables based upon the reported data.

The following variables will be created where x is the receiver number (1-4).

Variable Description

MLPioneerVSX_x_PowerStatus DISPLAYS POWER LEVEL

MLPioneerVSX_x_MuteStatus DISPLAYS MUTE STATUS (ON/OFF)

MLPioneerVSX_x_VolumeLevel DISPLAYS VOLUME LEVEL (0..93)

MLPioneerVSX_x_VolumeLevelScaled DISPLAYS VOLUME LEVEL (0..100)

MLPioneerVSX_x_FunctionMode DISPLAYS FUNCTION MODE

MLPioneerVSX_x_FunctionMode_Desc DISPLAYS DESCRIPTION OF CURRENT

FUNCTION MODE

MLPioneerVSX_x_ListeningMode DISPLAYS LISTENING MODE

MLPioneerVSX_x_ListeningMode_Desc DISPLAYS DESCRIPTION OF CURRENT

LISTENING MODE

MLPioneerVSX_x_LMSetting DISPLAYS LM SETTING

MLPioneerVSX_x_LMSetting_Desc DISPLAYS DESCRIPTION OF LM SETTING

MLPioneerVSX_x_Tone DISPLAYS TONE STATUS (ON/OFF)

MLPioneerVSX_x_Tone_Desc DISPLAYS TONE DESCRIPTION

MLPioneerVSX_x_Bass DISPLAYS BASS LEVEL

MLPioneerVSX_x_Bass_Desc DISPLAYS BASS DESCRIPTION

MLPioneerVSX_x_Treble DISPLAYS TREBLE LEVEL

MLPioneerVSX_x_Treble_Desc DISPLAYS TREBLE DESCRIPTION

MLPioneerVSX_x_Preset DISPLAYS TUNER PRESET

MLPioneerVSX_x_Preset_Desc DISPLAYS TUNER PRESET DESCRIPTION

MLPioneerVSX_x_Freq DISPLAYS TUNER FREQUENCY

MLPioneerVSX_x_Freq_Desc DISPLAYS TUNER FREQUENCY DESCRIPTION

MLPioneerVSX_x_PowerStatus_Zone2 DISPLAYS POWER STATUS OF ZONE2

MLPioneerVSX_x_PowerStatus_Zone3 DISPLAYS POWER STATUS OF ZONE3

MLPioneerVSX_x_FunctionMode_Zone2 DISPLAYS FUNCTION MODE STATUS OF ZONE2

MLPioneerVSX_x_FunctionMode_Desc_Zone2 DISPLAYS FUNCTION MODE DESC OF ZONE2

MLPioneerVSX_x_FunctionMode_Zone3 DISPLAYS FUNCTION MODE STATUS OF ZONE3

MLPioneerVSX_x_FunctionMode_Desc_Zone3 DISPLAYS FUNCTION MODE DESC OF ZONE3

MLPioneerVSX_x_VolumeLevel_Zone2 DISPLAYS VOLUME LEVEL OF ZONE2

MLPioneerVSX_x_VolumeLevelScaled_Zone2 DISPLAYS VOLUME LEVEL OF ZONE2 SCALED