UltraPioneerAVR3 HSPI User s Guide A HomeSeer HS3 plug-in to enable control of Pioneer A/V Receivers that support the IP & RS232 control system. Copyright 2014 ultrajones@hotmail.com Revised 01/20/2014 This document contains proprietary and copyrighted information and may not be copied, reproduced, translated, or reduced to any electronic medium without prior consent, in writing, from ultrajones@hotmail.com.
Table of Contents Introduction... 4 Intended Audience... 4 UltraPioneerAVR3 HSPI Overview... 4 How It Works... 4 Features... 4 Requirements... 4 UltraPioneerAVR3 HSPI Installation... 4 Downloading the HomeSeer Plug-in... 4 UltraPioneerAVR3 HSPI Setup... 5 Initial Setup Checklist... 5 UltraPioneerAVR3 HSPI Configuration... 5 Web Page Layout... 5 Screenshot... 6 Options... 6 Receivers... 6 Screenshot... 7 Manually Adding a New Pioneer A/V Receiver... 7 Modifying a Pioneer A/V Receiver... 7 Deleting a Pioneer A/V Receiver... 7 AVR Devices... 8 Screenshot... 8 Connection Devices... 8 Other Supported HomeSeer Devices... 9 Adding a UltraPioneerAVR3 Device... 12 Screenshot... 13 Modifying an Existing UltraPioneerAVR3 Device... 13 Deleting an Existing UltraPioneerAVR3 Device... 13 Enable/Disable Pioneer A/V Receiver Feature... 14 Screenshot... 14 2
UltraPioneerAVR3 HSPI Triggers... 14 UltraPioneerAVR3 HSPI Trigger Actions... 14 UltraPioneerAVR3 HSPI Trigger Conditions... 14 3
Introduction UltraPioneerAVR3 is a HomeSeer plug-in (HSPI) that allows you to use HomeSeer to control Pioneer A/V Receivers that support the IP & RS232 control system. Intended Audience This document is intended for the HomeSeer user that has chosen to install and configure the UltraPioneerAVR3 HomeSeer Plug-in. UltraPioneerAVR3 HSPI Overview How It Works UltraPioneerAVR3 implements the Pioneer IP & RS232 control system allowing HomeSeer to control your 2010 through 2013 Pioneer A/V Receivers. UltraPioneerAVR3 uses a network discovery protocol to automatically detect the Pioneer A/V Receivers connected to your home network. You can control your receiver by simply creating a HomeSeer device for the desired function, then interacting with the HomeSeer device using the status web page, HomeSeer events, scripting or HomeSeer HSTouch. Features Multiple threading allows UltraPioneerAVR3 HSPI to communicate with the Pioneer A/V Receivers without disrupting the performance of HomeSeer. Support for up to 9 Pioneer A/V Receivers. Provides the ability to control over 100 functions available on your Pioneer A/V receiver. Create only the HomeSeer devices you need to control your Pioneer A/V receivers. Ability to disable features not supported by your Pioneer A/V receivers to reduce the power on initialization time. Error Try/Catch logic to ensure plug-in doesn't fail with an unhandled exception. Requirements Homeseer 3 or greater. At least one Pioneer A/V Receivers that support the 2010 though 2013 IP & RS232 control system. UltraPioneerAVR3 HSPI Installation Downloading the HomeSeer Plug-in 1. From your HomeSeer web page, select PLUG-INS > Manage. 4
2. Click the + icon next to Additional Interfaces to expand the list of available HomSeer3 plug-ins. 3. Click the + icon next to the Audio / Video and Infra-red (IR) Support category, then click the checkbox next to the UltraPioneerAVR3 (Pioneer Audio Video Receiver) package to mark the plug-in for installation. 4. Under Pending Updates/Installs, click the Download and Install button. 5. Once the installer finishes, find the UltraPioneerAVR3 plug-in under Installed Plug-Ins, then enable it. UltraPioneerAVR3 HSPI Setup Before you begin to configure the UltraPioneerAVR3 plug-in, you ll need to make sure you complete the network setup and input setup on each Pioneer A/V Receiver. Refer to the Pioneer A/V Receiver documentation for additional information. Initial Setup Checklist 1. Pioneer A/V Receiver Input Setup use the Pioneer Input Setup menu if want to change the input names to something more meaningful (Tivo, AppleTV, etc). 2. Pioneer A/V Receiver Network Setup Use the Pioneer Network Setup menu to ensure your Receiver s Network Standby is set to ON and the receiver is using a static IP address. 3. Start HomeSeer and wait about 30-90 seconds for the Pioneer A/V Receivers to be discovered. The Pioneer A/V Receivers that are automatically discovered will appear in the UltraPioneerAVR3 > Receivers web page as shown in the following screenshot: UltraPioneerAVR3 HSPI Configuration Web Page Layout The UltraPioneerAVR3 plug-in has four web pages that provide access to the available features of the plug-in. 5
Screenshot The available web pages are as follows: 1. Status Displays the UltraPioneerAVR3 HSPI version and status. 2. Options Displays and allows you to change the options associated with the plug-in. 3. Receivers Displays and allows you to add, modify and delete Pioneer A/V Receivers. 4. AVR Devices A web page that allows you to display the current status of all available Pioneer A/V Receiver functions and provides the ability to automatically create the desired HomeSeer devices and enable and disable supported features. Options All options are set from the Options web page. The following options are supported: 1. Attempts Per Command Specify the number of times to send a command until it is acknowledged by the Pioneer A/V Receiver. The default is 2. 2. Wait Time Per Command Specify the number of seconds to wait for a response to a command sent to the Pioneer A/V Receiver. The default is 2 seconds. 3. Authorized User Roles Specify the HomeSeer uses authorized to access the UltraPioneerAVR3 web page. 4. Logging Level Select logging level. Receivers The Receivers web page allows you to add, modify and delete Pioneer A/V Receivers. If your Pioneer A/V Receiver is connected to your home network, then it should automatically be discovered and added to the list. 6
Screenshot Manually Adding a New Pioneer A/V Receiver 1. Click on the UltraPioneerAVR3 > Receivers button. 2. Navigate to the bottom of the Pioneer A/V Receivers web page. 3. Complete the following form fields: a. Pioneer UUID: Enter the MAC address of your Pioneer A/V Receiver. The format must be 00-00-00-00-00-00. If you are defining a serial connection, then leave this field blank. b. Make: Enter Pioneer. c. Model Number: Enter the Pioneer A/V Receiver model number (e.g. VSX-1121). d. Revision: Enter 1.0.0. e. Connection Type: Select either Ethernet or Serial. f. Connection Address: If you are using a network connection, enter the IP address and port number using the format ipaddress:port (e.g. 192.168.1.10:23). If you are using a Serial connection, use the format COMx where x is the port number (e.g. COM1). g. Master Volume Limit: Select the maximum master volume that can be set. h. Zone2 Volume Limit: Select the maximum zone2 volume that can be set. i. Zone3 Volume Limit: Select the maximum zone3 volume that can be set. 4. Press the Add New icon to enter the Pioneer A/V Receiver. Modifying a Pioneer A/V Receiver 5. Click on the UltraPioneerAVR3 > Receiver button. 6. Find the Pioneer A/V Receiver you want to edit, and then click the Edit icon 7. Edit the fields that you want to change, then press the Save icon 8. To cancel the changes, simply press the Cancel icon Deleting a Pioneer A/V Receiver 1. Click on the UltraPioneerAVR3 > Receiver button. 2. Find the Pioneer A/V Receiver you want to delete, and then click the Delete icon 3. Confirm you want to delete the Receiver by pressing OK. 7
AVR Devices The UltraPioneerAVR3 HSPI controls your Pioneer A/V Receiver using HomeSeer devices. Simply create a HomeSeer device for the desired function, then interacting with the HomeSeer device using the status web page, HomeSeer events, scripting or HomeSeer HSTouch. Please note: Your receiver must be turned on before the plug-in will allow you to create a HomeSeer device. If your receiver is in the off position, you must first create the Power device, turn the receiver on, and then wait until the system refresh is complete before attempting to create the remaining devices. Screenshot Connection Devices This HomeSeer device is automatically created and manages the connection to the Pioneer A/V Receiver. If the plug-in happens to lose connection for whatever reason, you can force a connection by selecting reconnect from the Control options. You can also halt the watchdog reconnection functionality by selecting disconnect from the Control options. Note: Once the connection is established, a watchdog timer will maintain the connection to the Pioneer A/V Receiver. 8
Screenshot Other Supported HomeSeer Devices UltraPioneerAVR3 HSPI supports the ability to manually create over 115 HomeSeer devices per receiver. However, this doesn t mean you need to create that many devices. Review the list below and create just the devices you need to control and manage your Pioneer A/V Receiver from HomeSeer. Master Controls Power Volume Mute Input Listening Mode Listening Mode Setting Tone Control Bass Treble Turns the receiver on or off. Sets the listening volume. Mutes the sound or restores the sound if it has been muted. Changes the input to another source or connected device. Displays the current listening mode. Switches between supported listening modes. Applies the treble and bass tone controls to a source. Adjusts the amount of bass. Adjusts the amount of treble. Zone2 Controls Zone2 Power Zone2 Volume Zone2 Mute Zone2 Input Turns the zone on or off. Sets the zone listening volume. Mutes the zone sound or restores the sound if it has been muted. Changes the zone input to another source or connected device. Zone3 Controls Zone3 Power Zone3 Volume Zone3 Mute Zone3 Input Turns the zone on or off. Sets the zone listening volume. Mutes the zone sound or restores the sound if it has been muted. Changes the zone input to another source or connected device. Zone4 Controls Zone4 Power Zone4 Input Turns the zone on or off. Changes the zone input to another source or connected device. 9
Channel Level Front Left Front Right Center Surround Left Surround Right Surround Back Left Surround Back Right Subwoofer Front Height Left Front Height Right Front Wide Left Front Wide Right Audio Information Audio Input Signal Audio Input Frequency Audio Input Channel Format Audio Output Channel Video Information Input Terminal Input Resolution Input Aspect Input Color Format Input Bit (HDMI Only) Input Extended Color Space (HDMI Only) Output Resolution Output Aspect Output Color Format Output Bit (HDMI Only) Output Extended Color Space (HDMI Only) HDMI1 Monitor Recommended Resolution HDMI1 Monitor DeepColor HDMI1 Monitor Extended Color Space HDMI2 Monitor Recommended Resolution HDMI2 Monitor DeepColor HDMI2 Monitor Extended Color Space The audio input signal type. The frequency of the audio input signal The audio input channel format. The audio output channel format. The video input terminal (HDMI, Component, etc.). The video input resolution. The video input aspect ratio. The video input color format (HDMI only). The video input bit (HTML only). The video extended color space. The output video resolution. The output video aspect ratio. The output color format. The output bit (HTML only). The output extended color space (HDMI only). The HDMI1 monitor recommended resolution. HDMI1 monitor DeepColor. HDMI1 monitor extended color space. HDMI2 monitor recommended resolution. HDMI2 monitor DeepColor. HDMI2 monitor extended color space. Video Function Video Converter Converts video signals for output from the MONITOR OUT jacks. On 10
Video Resolution Specifies the output resolution of the video signal. Auto Pure Cinema Optimizes the operation of the progressive scanning circuit. Auto Progressive Motion Adjusts the motion and still picture quality. 0 Stream Smoother Improves elements that reduce picture quality in network connections. Advanced Video Adjust Sets the optimum picture quality for the type of monitor that is connected. Off YNR Reduces noise in the luminance (Y) signal. 0 CNR Reduces noise in the input's color (C) signal. 0 BNR Reduces block noise (block shaped distortion upon MPEG compression). 0 MNR Reduces mosquito noise (distortion contours upon MPEG compression). 0 Detail Adjusts how sharp edges appear. 0 Sharpness Adjusts the sharpness. 0 Brightness Adjusts the overall brightness. 0 Contrast Adjusts the contrast between light and dark. 0 Hue Adjusts the red/green balance. 0 Chroma Level Adjusts saturation from dull to bright. 0 Black Setup Sets the black level according to the video input signal. 7.5 Aspect Specifies the aspect ratio when the input signals are output at the HDMI output. Through DSP Function MCACC Memory Selects your favorite MCACC preset memory location. MEM1 SBCH Processing Switches on/off the SBch processing. Auto Phase Control Corrects phase shifting on certain discs. 6ms Virtual SB Allows you to hear virtual surround back channel though your surround Off speakers. Virtual HT Allows you to hear virtual height speakers though your front speakers. Off Virtual Wide When you re not using front wide speakers, selecting this mode allows you to Off hear a virtual front wide channel though your front speakers. Sound Retriever DSP processing is used to compensate for loss of audio data upon compression. Off Signal Select Used to select an input signal. Auto Analog Input ATT Attenuates the level of an analog input signal to prevent distortion. 0 db EQ Switches on/off the effects of the EQ Pro. On Standing Wave Switches on/off the effects of the Standing Wave Control. On Phase Control Plus Corrects phase shifting on certain discs. 6ms Sound Delay Adjusts sound delay to match the presentation of the video. 0 Digital Noise Reduction May improve the sound in a noisy source in 2-channel signal inputs. Off Dialog Enhancement Localizes dialog in the center channel to make It stand out. Off Hi-BIT Adjusts the Hi-BIT available on some Pioneer A/V Receivers. Off Dual Mono Specifies how dual mono encoded Dolby Digital soundtracks will be played. CH1 Fixed PCM Useful if there is a slight delay before OFF recognizes the PCM signal on a CD. Off DRC Adjusts level of dynamic range for movie soundtracks using Dolby Digital. You Auto many need to use this feature when listening to surround sound at low volumes. LEF ATT Sets the LEF attenuator to prevent ultra-low bass tones from distorting sound. 0dB SACD Gain Brings out detail in SACDs by maximizing dynamic range. 0dB 11
Auto Delay This feature automatically corrects the audio-to-video delay connected with Off HDMI. Center Width Provides ability to blend front channel speakers. 3 Panorama Enhances the front stereo image to include the surround speakers. Off Dimension Adjusts the depth of the surround sound balance from front to back. 0 Center Image/Gain Adjusts the center image to create a wider stereo affect with vocals. 3 Effect Sets the effect level for the Advanced Surround or ALC mode. 50 Height Gain Adjusts the output from the front height speakers when in Pro Logic II HEIGHT Mid Virtual Depth When selected, the sound field expands virtually behind the display. Off Digital Filter Adjusts the digital filter available on some Pioneer A/V Receivers. Slow Loudness Management Adjusts the level of dynamic range for movie soundtracks. You many need to use this feature when listening to surround sound at low volumes. Note: This can only be set when DRC is off and the input signal is a true Dolby TrueHD signal. Auto AMP Function Speakers Selects the speaker system settings. A+B HDMI Output Select Select which HDMI output. HDMI 1 HDMI Audio Selects the HDMI audio. AMP PQLS Enables the Precision Quartz Lock system. Auto Operation Mode Setting Selects the operation mode setting. Expert Sleep Sets the Pioneer A/V Receiver sleep time. Off AMP Tuner Function Tuner Frequency Tuner Band Tuner Preset Misc. Function Panel Display Panel Key Lock Remote Lock Adapter Port Internet Radio ipod/usb XM Channel Sirius Channel Sets the tuner frequency. Sets the tuner band. Selects the tuner preset. Shows the text available on the Pioneer A/V Receiver front panel. Option to disable the keys on the Pioneer A/V Receiver front panel. Option to disable the remote control function. Device to control the functions available via the adapter port. Device to control the functions available via the Internet Radio. Device to control the functions available via the ipod/usb port. Device to control the functions available via the XM radio option. Device to control the functions available via the Sirius radio option. Adding a UltraPioneerAVR3 Device You can add HomeSeer devices from the UltraPioneerAVR3 > AVR Devices web page. Simply select the Pioneer A/V Receiver from the drop down, and then select the Device Grouping drop down, then press the Update button. Once the desired Pioneer AVR Device Grouping is displayed, simply select the 12
checkbox for each HomeSeer device you want to create, then click the Save button. Repeat these steps until you have created all the HomeSeer devices you want to create. Screenshot Please note: Your receiver must be turned on before the plug-in will allow you to create a HomeSeer device. If your receiver is in the off position, you must first create the Power device, turn the receiver on, and then wait until the system refresh is complete before attempting to create the remaining devices. If the HomeSeer Device checkbox is still disabled after a refresh, then your Pioneer A/V Receiver did not respond to the status request for the feature listed. See Enable/Disable Pioneer A/V Receiver Feature listed below. Modifying an Existing UltraPioneerAVR3 Device You can modify an UltraPioneerAVR3 device the same way you modify any other HomeSeer device. Simply click on the device name from the HomeSeer device page, and then change the device properties as needed. Note: Once a HomeSeer device is created, the plug-in will not overwrite any of the device properties, so feel free to modify the name, location and location2 properties as you see fit. Deleting an Existing UltraPioneerAVR3 Device You can delete an UltraPioneerAVR3 device the same way you delete any other HomeSeer device. From the HomeSeer device web page, click the device name, then from the HomeSeer modify device web page, click the Delete button. 13
Enable/Disable Pioneer A/V Receiver Feature The UltraPioneerAVR3 HSPI supports the ability to enable or disable features supported by various Pioneer A/V Receivers. Disabling features not supported by your Pioneer A/V Receiver will greatly reduce the time it takes to refresh the status when your receiver is powered on. You can simply unselect the Feature Enabled checkbox so the UltraPioneerAVR3 receiver no longer attempts to determine the status of a feature not supported by your Pioneer A/V Receiver. Please note: Some features may only return a valid response depending on what inputs, outputs and listening modes are selected. Refer to your Pioneer A/V Receiver documenation for a list of supported features. Screenshot UltraPioneerAVR3 HSPI Triggers This plug-in does not have any HomeSeer triggers defined. UltraPioneerAVR3 HSPI Trigger Actions This plug-in does not have any HomeSeer trigger actions defined. UltraPioneerAVR3 HSPI Trigger Conditions This plug-in does not have any HomeSeer trigger conditions defined. 14