Welcome to the BLOnkyo Plug-In for HomeSeer

Overview

The BLOnkyo Plug-in for HomeSeer allows control of Onkyo A/V Receivers using an ethernet connection. This plugin is written in VB .Net 4.0 and requires Homeseer Version 4 or later.

You can view all Onkyo commands in the OnkyoCommands.xls file in your [HS root]\Data\BLOnkyo folder.

Maintain Receivers

This is the maintain receivers web page where receivers can be added and maintained in the plug-in.

Maintain Receiver Commands

This is the maintain receiver commands web page where receiver commands can be added and maintained in the plug-in.

Options

This is the Options web page where various configuration settings can be modified.

Receiver Properties

The following is a list of the receiver properties.

Property Name	Type	Description
Number	Integer	The receiver number
Name	String	The name of the receiver
IpAddress	String	The IP address of the receiver
Port	String	The port number of the receiver
MasterVolumeMax	Integer	The maximum volume for the receiver

Receiver Command Properties

The following is a list of the receiver command properties.

Property Name	Type	Description
Command	String	The receiver command
Description	String	The description of the command

Scripting Methods

Here is a list of the scripting methods that can be utilized with this plug-in.

Receivers Method

This method returns a Receiver object collection of all receivers.

VB.Net Scripting Example

	For Each r As Object In hs.PluginFunction("BLOnkyo", "", "Receivers", Nothing)
	hs.writelog("Info", "Name: " & r.Name & " is a receiver!")
	Next

Connect Method

This method connects a specific receiver.

VB.Net Scripting Example

theResponse = hs.PluginFunction("BLOnkyo", "", "Connect", New Object(){1})

Disconnect Method

This method disconnects a specific receiver.

VB.Net Scripting Example

theResponse = hs.PluginFunction("BLOnkyo", "", "Disconnect", New Object(){1})

SendReceiverCommand Method

This method sends a command configured in the plug-in to a receiver.

VB.Net Scripting Example

	Dim theResponse As String = ""
	theResponse = hs.PluginFunction("BLOnkyo", "", "SendReceiverCommand", New Object(){1,"PWR01"})
	hs.writelog("Info", "The response for the command is: " & theResponse)
	theResponse = Nothing

SendRawCommand Method

This method sends a raw command to a receiver.

VB.Net Scripting Example

	Dim theResponse As String = ""
	theResponse = hs.PluginFunction("BLOnkyo", "", "SendRawCommand", New Object(){1,"PWR00"})
	hs.writelog("Info", "The response for the command is: " & theResponse)
	theResponse = Nothing

SetMaxVolume Method

This method sets the maximum volume for a receiver.

VB.Net Scripting Example

theResponse = hs.PluginFunction("BLOnkyo", "", "SetMaxVolume", New Object(){1,40})

PowerOn Method

This method turns on power for a specific receiver and zone.

VB.Net Scripting Example

theResponse = hs.PluginFunction("BLOnkyo", "", "PowerOn", New Object(){1,0})

PowerOff Method

This method turns off power for a specific receiver and zone.

VB.Net Scripting Example

theResponse = hs.PluginFunction("BLOnkyo", "", "PowerOff", New Object(){1,0})

PowerToggle Method

This method toggles power for a specific receiver and zone.

VB.Net Scripting Example

theResponse = hs.PluginFunction("BLOnkyo", "", "PowerToggle", New Object(){1,0})

MuteOn Method

This method mutes a specific receiver and zone.

VB.Net Scripting Example

theResponse = hs.PluginFunction("BLOnkyo", "", "MuteOn", New Object(){1,0})

MuteOff Method

This method unmutes a specific receiver and zone.

VB.Net Scripting Example

theResponse = hs.PluginFunction("BLOnkyo", "", "MuteOff", New Object(){1,0})

MuteToggle Method

This method toggles mute for a specific receiver and zone.

VB.Net Scripting Example

theResponse = hs.PluginFunction("BLOnkyo", "", "MuteToggle", New Object(){1,0})

SetVolume Method

This method sets the volume level for a specific receiver and zone.

VB.Net Scripting Example

theResponse = hs.PluginFunction("BLOnkyo", "", "SetVolume", New Object(){1,0,50})

Support

For support, please use the HomeSeer Message Board