[[Image(front_med.jpg)]]

= Onkyo Receiver (AVR) Plugin=

The Onkyo Audio Video Receiver is a networked receiver that is capable of being controlled through the eISCP protocol.

This plugin can be used to trigger scenes on your Vera device automatically when the device is turned on. This plugin will also allow you to control most of its features which include: 
* Power 
* Volume 
* Mute 
* Input 
* Surround Type 
* Navigation 
* Playback Control 
* HDMI Out 
* Macros - Automated commands

Link to company page ​http://www.onkyousa.com \\ 
Relevant forum thread ​http://forum.micasaverde.com/index.php/topic,17811.msg139582.html \\
Advanced Users Page: [[Advanced Users]] - includes the Macro Guide. \\
Version Log: [[Version Log]] 

== Installation Instructions==

You can install the plugin from http://apps.mios.com/plugin.php?id=5176 or within Vera UI.  The plugin name is Onkyo Receiver (AVR).

After installing the plugin a device will automatically be created.  
* Go to the advanced tab of that device and add IP address of your receiver (I recommend setting a static IP address on your receiver).  
    * Click save, reload, and refresh the page a couple of times for the buttons to show up.
* Set the Number of Zones in the Config tab.  By default it is set to 2.
* You will have basic control from the dashboard.  
* Note: You must have "network standby" enabled for this plugin to turn the receiver on and off.

Known Working Models:
* TX-NR515
* TX-NR579
* TX-NR616
* TX-NR717
* TX-NR818
* TX-NR3008
* Integra DHC-9.9, after disabling the Onkyo !EventGhost plugin
* Many others that aren't tested. If it connects via ethernet it will probably work.

Untested Compatible Models:
* TX-NR414 (Ether), TX-NR509 (Ether), TX-NR579 (Ether), TX-NR609 (Ether), TX-NR709, TX-NR809, TX-NR1009, TX-NR1010, TX-NR3009, TX-NR3010, TX-NR5009, TX-NR5010
* DTR-20.3, DTR-20.4, DTR-30.3, DTR-30.4, DTR-40.3, DTR-40.4, DTR-50.3, DTR-50.4, DTR-70.3, DTR-70.4, DTR-80.3
* DHC-80.3
* PR-SC5509
* Many other models.

== Configuration==

||Parameter||Description||
|--
||IP Address||(Required) This is the IP address of the Onkyo Receiver.||
||zoneCount||(Default 3) This correlates how many zones that your receiver supports. The main zone counts as 1.||
||DEBUGMODE||(Default 0 or Off) Value of 1 or On enables debugging. This sets the flag to allow logging of plugin tasks and functions.||
||LOGLEVEL||(Default 1) Allowed values 0-4. The higher the value the more data is logged.||

== Notifications==

The following notification triggers can be used in your scenes. 

||Status||Description||
|----
||On||Is the zone on.||
||Off||Is the zone off||
|--
||TBA||More coming in later versions.  Suggestions please.||

== Service Variables==
Below are the services and the associated variables.

urn:onkyo-com:serviceId:Receiver1

* !NetService - Hex value representing Net Service application.  "00" DLNA, "04" Pandora, and etc.  Applies to input NET which has different applications to choose from.  Such as Spotify and Pandora.
* !NetServiceName - The readable name that correlates to the !NetService value.
* !NetServiceTarget - Target of !NetService
* !InputName - The readable name that correlates to the Input value.
* Surround - Hex value representing Listening Mode.  "00" Stereo, "0C" All Ch stereo, etc. The type of surround setting.  IE: Stereo, Mono, THX.
* !SurroundTarget - Target of Surround.
* HDMIOut - Hex value with "01" Main and "02" Sub. The HDMI output variable.  Main or Sub.
* HDMIOutTarget - Target of HDMIOut.
* zoneCount - The number of zones the receiver has. (not automatically set) Default value 2.
* DEBUGMODE - On = 1 and Off = 0. Setting to enable or disable advanced logging.
* LOGLEVEL - Numeric value 0 to 4.Setting to tell what to log.
* !MacroInput(1 or 2) - Macro variable to select a specific input.  
* !MacroNetService(1 or 2) - Macro variable to select a specific Netservice.
* !MacroNetIndex(1 or 2) - Macro variable CSV list of index values of listed content or menu commands.
* !LastChange - Unformated Timestamp of when any time or track information is updated.
* !PlayStatus - PLAYING,PAUSED, or STOPPED
* !RepeatStatus - REPEAT_OFF or REPEAT_ON
* !ShuffleStatus - SHUFFLE_OFF or SHUFFLE_ON

urn:upnp-org:serviceId:SwitchPower1
* Target
* Status

urn:micasaverde-com:serviceId:InputSelection1
* Input
* !InputTarget
* Video

urn:micasaverde-com:serviceId:Volume1
* Volume
* !VolumeTarget
* Mute

urn:upnp-org:serviceId:RenderingControl
* Volume
* Mute

urn:micasaverde-com:serviceId:HaDevice1
* Commfailure

urn:upnp-org:serviceId:AVTransport (Beta)
* AVTransportURI - 
* AVTransportURIMetaData - 
* !CurrentAlbum - 
* !CurrentAlbumArt - 
* !CurrentArtist - 
* !CurrentCrossfadeMode - 
* !CurrentDetails - 
* !CurrentMediaDuration - 
* !CurrentPlayMode - 
* !CurrentStatus - 
* !CurrentTitle - 
* !CurrentTrack - 
* !CurrentTrackDuration - 
* !CurrentTrackMetaData - 
* CurrentTrackURI - 
* !CurrentTransportActions - 
* !NumberOfTracks - 
* !RelativeTimePosition 
* !TransportPlaySpeed - 
* !TransportState - 
* !TransportStatus -