Pioneer Receiver  

Developer: Nathan Sheldon Software     Like this plugin? Show your appreciation!
Category: A/V and IR Equipment
Assistance: Get help!   
Plugin ID: com.nathansheldon.indigoplugin.PioneerReceiver
Latest release: v1.0.8 released on Nov. 24, 2017
Requires: Indigo v5.0.0 or higher
  Download latest release

(FREE Indigo plugin)

The main highlights of the Pioneer Receiver plugin are:

  • Full Featured Status Information: Most parameters published by Pioneer have a corresponding device state or property within each Indigo device created using the plugin. This allows for virtually unlimited Indigo triggering and control page options based on receiver changes.
  • Basic & Advanced Actions: Both basic and advanced Indigo actions are included in the plugin, from toggling power, setting volume, and selecting input sources to selecting MCACC Memory settings and sending raw commands to the receiver.
  • Non-Interference: Using the plugin will not interfere with Pioneer's iOS apps. Changes made to the receiver from the IR remote, front panel and iOS apps* are reflected in the Pioneer Receiver plugin device states and vice-versa.
  • Virtual Volume Controller: Create any number of "Virtual Volume Controller" devices which appear as native dimmer devices in Indigo. Virtual Volume Controllers can be assigned to control either Zone 1 or Zone 2 volume levels. Use the ON and OFF conditions to control muting in a zone and the brightness level to control volume.

Pioneer Receiver supports the VSX-1021-K, VSX-1022-K, VSX-1122-K, VSX-1123-K and SC-75. Other receivers may also work.

'* Not including the VSX-1022-K. iOS app connections to the VSX-1022-K are not possible when using the Pioneer Receiver.

Installation

Download the latest version (link above) to the computer on which Indigo server is installed. If the zip file did not automatically expand, double-click on it to unzip it. Double-click the resulting "Pioneer Receiver.indigoPlugin" file. The Indigo client will open and prompt you to install the plugin. Click the option to install and enable it. You'll then be prompted to configure the plugin. The only configuration option is to enable debugging, which you won't want to do unless troubleshooting a problem, so just click the Save button. All done!

Usage

Creating a VSX-1021-K, VSX-1022-K, VSX-1122-K, VSX-1123-K, or SC-75 Device

In order to create a receiver device in Indigo, there are a few requirements. First, the receiver will need to have "Network Standby" enabled in the "Network Setup" menu (accessible through the HOME MENU button on the receiver's IR remote). Second, you'll need to be sure that the receiver's IP address does not change, otherwise the device in Indigo will stop working. If you're receiver's IP address is assigned automatically by your router (most likely the case), you'll need to either configure the receiver to use a manually assigned IP address or configure your router to always assign the same IP address to the receiver. You can configure the receiver for a manually assigned IP address in the "Network Settings" menu and can find the current IP address of the receiver in the "Network Information" menu on the receiver. Finally, the Pioneer Receiver plugin has only been tested with one VSX-1021-K and one VSX-1122-K receivers. There's also support for the VSX-1022-K, VSX-1123-K, and SC-75, though I haven't tested those models. Other models are not yet supported. Other models way work using one of the 4 supported models when configuring the Indigo device. To add a VSX-1021-K, VSX-1022-K, VSX-1122-K, VSX-1123-K or SC-75 device to Indigo...

  1. Open the Indigo client and select "Devices" from the "View" menu. Click the "New..." tool bar button to add a new device.
  2. Make the following changes to the dialog settings. 2.1. Give the device a name and optional description. 2.2. Indigo 5: Select "Plugin" as the device Type. Indigo 6 and later: Select "Pioneer Receiver" as the device Type. 2.3. Indigo 5 only: Select "Pioneer Receiver" as the Plugin. 2.4. Select "VSX-1021-K", "VSX-1022-K", "VSX-1122-K" or "VSX-1123-K" as the Model. 2.5. A configuration dialog will appear.
  3. Enter the IP address of the receiver in the "Receiver IP Address" field.
  4. If you use multiple MCACC memory settings for different listening positions in the room, you can optionally enter labels for each of the 6 MCACC Memory settings. These labels are for display purposes only and have no effect on the operation of the receiver or plugin.
  5. Click the "Save" button then the "OK" button to create the Receiver Device in Indigo.
  6. Pioneer Receiver will immediately attempt to connect to the receiver and gather all of it's status information.

A Note About VSX-1022-K Support: The VSX-1022-K was not designed by Pioneer for use with custom installation and home automation systems like the VSX-1021-K, VSX-1122-K, and VSX-1123-K were, thus the Pioneer Plugin must connect to the 1022 using the same network port as the Pioneer-provided iControl iOS app. This means that if you use the Pioneer Receiver plugin, you cannot use the iOS app at all. The only way to use the iOS app if you've configured Pioneer Receiver is to either disable the VSX-1022-K device in Indigo before trying to use the iOS app, disabling the Pioneer Receiver plugin, or deleting the VSX-1022-K device from Indigo altogether.

Creating a Virtual Volume Controller Device

Virtual Volume Controllers can be used to view and change the volume of any Zone for any Pioneer Receiver device. The advantage of a Virtual Volume Controller is that it shows up in Indigo as a dimmer and can be treated as such in control pages, in Indigo Touch, through AppleScript, and in built-in "Control Light / Appliance" Indigo actions. When the volume of the connected receiver zone changes, the "brightness" of the Virtual Volume Controller changes. When the "brightness" of a Virtual Volume Controller is changed, the volume of the connected receiver zone is adjusted to match. Telling a Virtual Volume Controller to "turn off" mutes the connected receiver zone and telling the Virtual Volume Controller to "turn on" un-mutes the zone, returning to the most recent volume setting. Creating a Virtual Volume Controller is simple.

  1. Open the Indigo client and select "Devices" from the "View" menu. Click the "New..." tool bar button to add a new device.
  2. Make the following changes to the dialog settings. 2.1. Give the Virtual Volume Controller device a name and optional description. 2.2. Indigo 5: Select "Plugin" as the device Type. Indigo 6 and newer: Select "Pioneer Receiver" as the device Type. 2.3. Indigo 5 only: Select "Pioneer Receiver" as the Plugin. 2.4. Select "Virtual Volume Controller" as the Model. 2.5. A configuration dialog will appear.
  3. Select the existing VSX-1021-K, VSX-1022-K, VSX-1122-K, or VSX-1123-K receiver device from the Receiver menu in the dialog box.
  4. Select the volume for the zone you wish to control from the Volume Level to Control menu. NOTE: Due to how the VSX receivers are designed, Zone 2 volume is only controllable if Zone 2 is being powered by the internal amp. If Zone 2 is not powered by the internal amplifier, volume and mute messages to the receiver will be ignored by the receiver.
  5. Click "Save" then click "OK".

Creating VSX-1021-K, VSX-1022-K, VSX-1122-K, VSX-1123-K, or SC-75 Actions

Changing most settings on the VSX-1021-K, VSX-1022-K, VSX-1122-K, VSX-1123-K, and SC-75 can be done using Indigo actions, configurable from the Actions tab of any Trigger, Schedule or Control Page action and from any Action Group dialog. Some actions have additional setting requirements (such as selecting a specific input source or setting a zone to a specific volume level). Some actions have no special settings (such as turning the receiver on or off, or toggling mute for a zone). The general process for creating an action is as follows.

  1. From within any Trigger, Schedule, Control Page action, or Action Group dialog box, make the following changes to the dialog settings. 2.1. Give the action a Name and optional Description. 2.2. Indigo 5: Select "Plugin" as the action Type. Indigo 6 and newer: Select "Pioneer Receiver Actions", go to any of the category sub-menus and select the action you wish to execute. 2.3. Indigo 5 only: Select "Pioneer Receiver" as the Plugin. 2.4. Indigo 5 only: Select the action you wish to take on the receiver device from the Action menu. 2.5. Select the VSX-1021-K, VSX-1022-K, VSX-1122-K, VSX-1123-K or SC-75 receiver to control from the Device menu. 2.6. If the selected Action requires additional configuration, click the "Edit Action Settings..." button. A configuration dialog will appear.
  2. Set action-specifc settings within the configuration dialog. Most settings are self-explanatory. Settings that have special requirements or conditions include descriptive text within the configuration dialog.
  3. Click "Save" to save the action settings. If done adding actions to the Actions tab or dialog, click the "OK" button to save all actions.
Release details
Released on: Nov. 24, 2017
Requires: Indigo v5.0.0+
Changes in this release

Fixed another bug that caused the plugin to crash when communicating with the VSX-1123-K.