Codecore Logo
Quick Search
»
Advanced Search »

Onkyo Receiver

RSS
This is a driver for ONKYO receivers using the RS-232 two-way comm. While Onkyo publishes a single protocol, there are many variations within it by model. This has been tested with SR-805 and SR-705 models with slight quirks (e.g. AUX2/TAPE2 inputs do not exist on the 705 so trying to set them will produce no result).

Manufacturer: Onkyo Corporation

Primary Communications Port: Serial

Table of Contents [Hide/Show]


Configuration Settings
Events
   Dimmer Level Changed
   Sub Level Changed
   Zone Power State Changed
   Zone Mute State Changed
   Zone Volume Changed
   Zone Source Changed
   Listening Mode Changed
   Listening Mode Text Changed
   Tuner Preset Changed
   Tuner Frequency Changed
   Tuner Freqency Text Changed
   Ready State Changed
Instance Properties
   Connected
   DimmerLevel
   SubLevel
   ZonePowerStates
   ZoneMuteStates
   ZoneVolumes
   ZoneSources
   ZoneSourceNames
   ListeningMode
   ListeningModeText
   TunerPreset
   TunerFrequency
   TunerFrequencyText
   ZoneNames
   SourceNames
   DeviceDisplayName
   DeviceStartTime
   DeviceLifecycleStage
   DeviceIsRunningAndReady
Instance Methods
   SendRawCommand ( String )
   DimmerWrapAround
   SubLevelUp
   SubLevelDown
   SetZonePower ( Number, Boolean )
   TurnAllZonesOff
   ToggleZonePower ( Number )
   TurnZoneOn ( Number )
   TurnZoneOff ( Number )
   ToggleZoneMute ( Number )
   MuteZone ( Number )
   UnmuteZone ( Number )
   SetZoneVolume ( Number, Number )
   IncrementZoneVolume ( Number )
   DecrementZoneVolume ( Number )
   SetZoneSource ( Number, Number )
   CycleZoneSource ( Number )
   InputUp ( Number )
   InputDown ( Number )
   ListeningModeUp
   ListeningModeDown
   TunerPresetUp
   TunerPresetDown
   TunerTuneUp
   TunerTuneDown
   SetTunerBand ( Number )
   TunerToggleBand
   SetPropertyForDuration ( String, TimeSpan, Object, Object )
   SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )


Configuration Settings

  • Serial Port Name : The name of the serial port that the hardware is connected to. Ex. COM1
  • Custom Zone Names : (optional) Enter the name of each zone.

Events

Dimmer Level Changed

Occurs when the dimmer status changes.

Whenever Filter:

none

EventArgs:

  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Sub Level Changed

Occurs when the sub level changes.

Whenever Filter:

none

EventArgs:

  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Zone Power State Changed

Occurs when a zone's power state changes.

Whenever Filter:

  • PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

  • Number Index : The index within the property array.
  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Zone Mute State Changed

Occurs when a zone's mute state changes.

Whenever Filter:

  • PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

  • Number Index : The index within the property array.
  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Zone Volume Changed

Occurs when a zone's mute state changes.

Whenever Filter:

  • PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

  • Number Index : The index within the property array.
  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Zone Source Changed

Occurs when a zone's source changes.

Whenever Filter:

  • PropertyIndex : The index in the property's array. This is used for device properties that represent an array (or list) of values.

EventArgs:

  • Number Index : The index within the property array.
  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Listening Mode Changed

Occurs when the listeningMode changes.

Whenever Filter:

none

EventArgs:

  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Listening Mode Text Changed

Occurs when the listening mode changes.

Whenever Filter:

none

EventArgs:

  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Tuner Preset Changed

Occurs when the tuner preset changes.

Whenever Filter:

none

EventArgs:

  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Tuner Frequency Changed

Occurs when the tuner frequency changes.

Whenever Filter:

none

EventArgs:

  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Tuner Freqency Text Changed

Occurs when the tuner frequency changes.

Whenever Filter:

none

EventArgs:

  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Ready State Changed

The device's running and ready state changed.

Whenever Filter:

none

EventArgs:

  • Number NewValue : The new property value.
  • Number PreviousValue : The previous property value.

Instance Properties

Connected

Gets a value indicating if a connection is established with the Onkyo Receiver.

Accessibility : Read Only

Type: Boolean

DimmerLevel

Gets or sets the current dimmer setting.

Accessibility : Read / Write

Type: Number

SubLevel

Gets or sets the current sub level from -15 to +12db. Use a range of 0-27.

Accessibility : Read / Write

Type: Number

ZonePowerStates

Gets or sets all zone power states (on/off).

Accessibility : Read Only

Type: Array

ZoneMuteStates

Gets or sets all zone mute states (on/off).

Accessibility : Read Only

Type: Array

ZoneVolumes

Gets or sets all zone volume levels (0-100).

Accessibility : Read Only

Type: Array

ZoneSources

Gets or sets all zone inputs.

Accessibility : Read Only

Type: Array

ZoneSourceNames

Gets the current source name for all zones.

Accessibility : Read Only

Type: Array

ListeningMode

Gets or sets the current listing mode.

Accessibility : Read / Write

Type: Number

ListeningModeText

Gets or sets the listening mode.

Accessibility : Read Only

Type: String

TunerPreset

Gets or sets the preset value between 1 and 40.

Accessibility : Read / Write

Type: Number

TunerFrequency

Gets or sets the tuner frequency.

Accessibility : Read / Write

Type: Number

TunerFrequencyText

Gets or sets the formatted tuner frequency.

Accessibility : Read Only

Type: String

ZoneNames

An array containing the Name for each zone.

Accessibility : Read Only

Type: Array

SourceNames

Gets all the source names.

Accessibility : Read Only

Type: Array

DeviceDisplayName

The display name for this device.

Accessibility : Read Only

Type: String

DeviceStartTime

The date and time when this device was started.

Accessibility : Read Only

Type: DateTime

DeviceLifecycleStage

The current lifecycle stage of the device. The stages in order are: Pending Start, Starting, Running, Stopping

Accessibility : Read Only

Type: Number

DeviceIsRunningAndReady

Indicates if the device is ready for use, ie it is in the Running lifecycle stage and all properties are valid and all methods are ready to be used.

Accessibility : Read Only

Type: Boolean

Instance Methods

SendRawCommand ( String )

Sends a command that may otherwise not be supported by the driver.

Syntax

void SendRawCommand( String command )

Parameters

command : The command string to send. The driver will append the command with a carriage-return .

DimmerWrapAround

Sends a command that increases to next available dimmer level.

Syntax

void DimmerWrapAround( )

Parameters

none

SubLevelUp

Sends a command that increases to next available sublevel.

Syntax

void SubLevelUp( )

Parameters

none

SubLevelDown

Sends a command that decreases to next available sublevel.

Syntax

void SubLevelDown( )

Parameters

none

SetZonePower ( Number, Boolean )

Set Power On or Off for a specific zone.

Syntax

void SetZonePower( Number zone, Boolean state )

Parameters

zone : Zone: 1, 2 or 3
state : true for On and false for Off

TurnAllZonesOff

Turn all zones off.

Syntax

void TurnAllZonesOff( )

Parameters

none

ToggleZonePower ( Number )

Toggle the specified zone on and off. This is the same as pushing the PWR button on the DisplayPad.

Syntax

void ToggleZonePower( Number zoneNumber )

Parameters

zoneNumber : The zone number to toggle the power.

TurnZoneOn ( Number )

Turn the specified zone on if it is not already on.

Syntax

void TurnZoneOn( Number zoneNumber )

Parameters

zoneNumber : The zone number to power on. (1-3)

TurnZoneOff ( Number )

Turn the specified zone off if it is not already off.

Syntax

void TurnZoneOff( Number zoneNumber )

Parameters

zoneNumber : The zone number to power off. (1-3)

ToggleZoneMute ( Number )

Turns the mute on and off for a zone. This is the same as pushing the MUTE button on the DisplayPad.

Syntax

void ToggleZoneMute( Number zoneNumber )

Parameters

zoneNumber : The zone number to toggle muting. (1-3)

MuteZone ( Number )

Turn the mute on for a zone.

Syntax

void MuteZone( Number zoneNumber )

Parameters

zoneNumber : The zone number to mute. (1-3)

UnmuteZone ( Number )

Turn the mute off for a zone.

Syntax

void UnmuteZone( Number zoneNumber )

Parameters

zoneNumber : The zone number to unmute. (1-3)

SetZoneVolume ( Number, Number )

Set Volume level for a specific zone.

Syntax

void SetZoneVolume( Number zone, Number volume )

Parameters

zone : Zone: 1, 2 or 3
volume : Level: 0-100

IncrementZoneVolume ( Number )

Sends a command that increases to next available volume level.

Syntax

void IncrementZoneVolume( Number zone )

Parameters

zone : Zone: 1, 2 or 3

DecrementZoneVolume ( Number )

Sends a command that decreases to next available volume level.

Syntax

void DecrementZoneVolume( Number zone )

Parameters

zone : Zone: 1, 2 or 3

SetZoneSource ( Number, Number )

Set source for a specific zone.

Syntax

void SetZoneSource( Number zone, Number source )

Parameters

zone : Zone: 1, 2 or 3
source : Gets all zone sources.

1 = VCR
2 = CBL
3 = GAME
4 = AUX1
5 = AUX2
6 = DVD
7 = TAPE
8 = TAPE2
9 = PHONO
10 = CD
11 = FM
12 = AM
13 = TUNER
14 = XM
15 = SIRIUS

CycleZoneSource ( Number )

Cycles through each of the available sources for a zone. When the last source is reached, the next source is the first available source.

Syntax

void CycleZoneSource( Number zoneNumber )

Parameters

zoneNumber : The zone number. (1-3)

InputUp ( Number )

Sends a command that increases to next available source.

Syntax

void InputUp( Number zone )

Parameters

zone : Zone: 1, 2 or 3

InputDown ( Number )

Sends a command that decreases to next available source.

Syntax

void InputDown( Number zone )

Parameters

zone : Zone: 1, 2 or 3

ListeningModeUp

Sends a command that increases to next available listening mode.

Syntax

void ListeningModeUp( )

Parameters

none

ListeningModeDown

Sends a command that decreases to next available listening mode.

Syntax

void ListeningModeDown( )

Parameters

none

TunerPresetUp

Sends a command that increases to next available preset.

Syntax

void TunerPresetUp( )

Parameters

none

TunerPresetDown

Sends a command that decreases to next available preset.

Syntax

void TunerPresetDown( )

Parameters

none

TunerTuneUp

Sends a command that increases to next available channel.

Syntax

void TunerTuneUp( )

Parameters

none

TunerTuneDown

Sends a command that decreases to next available frequency.

Syntax

void TunerTuneDown( )

Parameters

none

SetTunerBand ( Number )

Set the tuner band to AM or FM.

Syntax

void SetTunerBand( Number band )

Parameters

band : The band (0=AM, 1=FM).

0 = AM
1 = FM

TunerToggleBand

Sends a command that toggles the tuner band.

Syntax

void TunerToggleBand( )

Parameters

none

SetPropertyForDuration ( String, TimeSpan, Object, Object )

Sets a property for a duration of time and then sets the property to a subequent value asynchronously. This action returns after setting the first value and the timer and subsequent property set run in the background. Subsequent sets of the same property will reset the timer if the subsequent value has not yet been set. This is an advanced feature, be sure to set the property name correctly.

Syntax

void SetPropertyForDuration( String propertyName, unknown duration, Object initialValue, Object finalValue )

Parameters

propertyName : The name of the property to set.
duration : The amount of time to wait after setting the initial value to set the subsequent value.
initialValue : The value to set the property to initially.
finalValue : The value to set the property to after the duration of time has passed.

SetPropertyForDuration ( String, Number, TimeSpan, Object, Object )

Sets a property for a duration of time and then sets the property to a subequent value asynchronously. This action returns after setting the first value and the timer and subsequent property set run in the background. Subsequent sets of the same property will reset the timer if the subsequent value has not yet been set. This is an advanced feature, be sure to set the property name correctly.

Syntax

void SetPropertyForDuration( String propertyName, Number arrayIndex, unknown duration, Object initialValue, Object finalValue )

Parameters

propertyName : The name of the property to set.
arrayIndex : The property's array index to set.
duration : The amount of time to wait after setting the initial value to set the subsequent value.
initialValue : The value to set the property to initially.
finalValue : The value to set the property to after the duration of time has passed.

Privacy Policy | Conditions Of Use

Copyright ©2014 Codecore Technologies, All rights reserved.