HDAnywhere MHUB RTI Driver

Revision: 20180508

Date: 2018/10/10

Author(s): Richard Mullins

Overview 4

Installation 5

Add the driver 5

Driver Configuration 7

Device Configuration 7

Driver Variables 8

System State 8

Power [boolean] 8

Output State 8

<Output Name> [integer] 8

Zone State 8

<Zone Name> [integer] 8

Driver Commands 9

Control Commands 9

Switch Output 9

Switch Zone 9

Send IR System Code 9

Send IR Hex Code 9

Audio Commands 10

Set Volume 10

Set Mute 10

Set Zone Volume 10

Set Zone Mute 10

System Commands 10

Reboot 10

Restart 10

Power ON 11

Power OFF 11

Driver State 11

Get State 11

Overview

The HDAnywhere MHUB RTI driver allows for control of the HDAnywhere range of Video and Audio distribution products. The driver allows for direct switching of inputs to outputs, the ability to switch preconfigured zones, control of audio levels (volume, mute, etc) and the ability to send IR codes as well as being able to reboot or restart the system.

Installation

The zip file that included this documentation has the rtidriver file you will need to add. The first step is to download and extract the driver from the zip file. It doesn’t matter where you store the file but we advise keeping them together.

The default location is Documents\Integration Designer\Control Drivers

Select your processor from the System Workplace sidebar and select the Drivers tab at the bottom of the window (If you are using a KX3 in control mode then you might need to select ‘Switch UI / Control Processor Mode‘ from the Device menu).

Add the driver

Click the Add button at the top of the driver window. The driver is now ready to configure or use.

Find the rtidriver file that you extracted from the zip file above. Click on Open when you have found the correct file.

The driver is now ready to use.

Driver Configuration

The driver requires you to specify the number of outputs, the number of inputs and also the number of zones you have configured. Changing these values will open up the Zone Names section and allow you to label the zones to make macro creation easier.

Device Configuration

The only setting you need to enter for control of the device is the IP address, in the IP Address field in HD Anywhere Settings.

Driver Variables

System State

Power [boolean]

The variables provides the current power state for the MHUB unit.

Output State

<Output Name> [integer]

The Output name will be inserted dynamically based on your config options. The current input that is associated with this output will be available through this variable.

Zone State

<Zone Name> [integer]

The Zone name will be inserted dynamically based on your config options. The current input that is associated with this zone will be available through this variable.

Driver Commands

Control Commands

Switch Output

This command requires two parameters. The output parameter is a drop down list that lets you select the name of the output you wish to select. The names match the ones set during the configuration stage. The second required parameter is the input that you wish to change the selected output to. The input names are set during the configuration stage.

Switch Zone

This command requires two parameters. The zone parameter is the zone number that you have previously configured. The value is just the number itself. The second required parameter is the input that you wish to change the selected output to. The input names are set during the configuration stage.

Send IR System Code

This command requires two parameters. The Port parameter is the port number that you wish to send the code from, for example port 3 would simply require the number 3. The code is the system programmed IR code, stored in the MHUB device.

Send IR Hex Code

This command requires two parameters. The Port parameter is the port number that you wish to send the code from, for example port 3 would simply require the number 3. The code is a string of hex numbers separated by commas. The following is an example of an LG TV power code

0000,006d,0026,0000,0155,00aa,0016,0015,0016,0015,0016,0040,0016,0015,0016,0015,0016,0015,0016,0014,0016,0015,0016,0040,0016,0040,0016,0015,0016,0040,0016,0040,0016,0040,0016,0040,0016,0040,0016,0015,0016,0015,0016,0040,0016,0015,0016,0015,0016,0015,0016,0040,0016,0040,0016,0040,0016,0040,0016,0015,0016,0040,0016,0040,0016,0040,0016,0014,0016,0015,0016,060b,0155,0055,0016,0e58,0155,0055,0016,00aa

Audio Commands

Set Volume

This command allows you to set the volume of a specified output and requires two parameters. The output parameter is a drop down list that lets you select the name of the output you wish to select. The names match the ones set during the configuration stage. The second parameter is the volume level which is a number between 1 and 100.

Set Mute

This command allows you to set the volume of a specified output and requires two parameters. The output parameter is a drop down list that lets you select the name of the output you wish to select. The names match the ones set during the configuration stage. The second parameter the mute state, either ON or OFF.

Set Zone Volume

This command allows you to set the volume of a specified output and requires two parameters. The zone parameter is the zone number that you have previously configured. The value is just the number itself. The second parameter is the volume level which is a number between 1 and 100.

Set Zone Mute

This command allows you to set the volume of a specified output and requires two parameters. The zone parameter is the zone number that you have previously configured. The value is just the number itself. The second parameter the mute state, either ON or OFF.

System Commands

Reboot

The reboot command can be used to reboot the system. This will perform a full hardware and software shutdown.

Restart

The restart command can be used to restart the system software. This will perform software restart without affecting the hardware.

Power ON

This command will turn the system on if it is off. If the system is already on the command will have no effect.

Power OFF

This command will turn the system off if it is on. If the system is already off the command will have no effect.

Driver State

Get State

The command allows you to immediately refresh the state of the encoder and decoder list. This update will happen automatically at the time period specified by the poll rate (detailed in the config section above) but using this command will cause the state to be updated immediately.