UltraHTDAudio3 HSPI User s Guide A HomeSeer HS3 plug-in to control the Home Theater Direct (HTD) Whole-House Audio System.

Transcription

1 UltraHTDAudio3 HSPI User s Guide A HomeSeer HS3 plug-in to control the Home Theater Direct (HTD) Whole-House Audio System. Copyright 2016 ultrajones@hotmail.com Revised 08/17/2016 This document contains proprietary and copyrighted information and may not be copied, reproduced, translated, or reduced to any electronic medium without prior consent, in writing, from ultrajones@hotmail.com.

2 Table of Contents Introduction... 4 Intended Audience... 4 UltraHTDAudio3 HSPI Overview... 4 How It Works... 4 Features... 4 Requirements... 4 UltraHTDAudio3 HSPI Installation... 5 Downloading the HomeSeer Plug-in... 5 UltraHTDAudio3 HSPI Setup... 5 Test Your HTD System... 5 Connect your HTD System to HomeSeer... 5 Information Needed to Add an HTD Whole-House Audio System... 5 UltraHTDAudio3 HSPI Configuration... 6 Web Page Layout... 6 UltraHTDAudio3 HSPI Options... 6 Screenshot... 7 UltraHTDAudio3 HSPI Audio Controllers... 7 Screenshot... 7 UltraHTDAudio3 HSPI Audio Zone Devices... 7 Screenshot... 8 Adding HTD Audio Zone Devices... 8 Zone Master Controls... 8 Zone Audio Controls... 9 Screenshot Modifying an Existing UltraHTDAudio3 Device Deleting an Existing UltraHTDAudio3 Device UltraHTDAudio3 HSPI Audio Zone Sources Screenshots UltraHTDAudio3 HSPI Triggers

3 UltraHTDAudio3 HSPI Trigger Actions UltraHTDAudio3 HSPI Trigger Conditions UltraHTDAudio3 HSPI API Reference

4 Introduction UltraHTDAudio3 is a HomeSeer3 plug-in that allows you to use HomeSeer to control your HTD Whole- House Audio System. The plug-in supports up to 9 HTD Whole-House Audio System controllers to accommodate any size home. Intended Audience This document is intended for the HomeSeer user that has chosen to install and configure the UltraHTDAudio3 HomeSeer Plug-in. UltraHTDAudio3 HSPI Overview How It Works The UltraHTDAudio3 HSPI uses the HTD protocol to integrate HomeSeer with the HTD Whole- House Audio System. This plug-in allows you to conveniently control your entire HTD Whole-House Audio System by either interacting with HomeSeer devices or by creating events to automatically set zone power, inputs, bass, treble, balance, loudness, etc. Features Create just the devices you need to control your HTD Whole-House Audio System. Changes using a zone keypad will automatically updated the associated HomeSeer device in real-time. The plug-in supports up to 9 HTD Whole-House Audio System controllers to accommodate any size home. Multiple threading allows UltraHTDAudio3 to query the HTD Whole-House Audio Controller without disrupting the performance of HomeSeer. Error Try/Catch logic to ensure plug-in doesn't fail with an unhandled exception. Requirements Homeseer3 version 3.0 or greater. One or more HTD Whole-House Audio System. The model number supported are Lync6, Lync12, MCA-66 and MC-66. 4

5 UltraHTDAudio3 HSPI Installation Downloading the HomeSeer Plug-in 1. From your HomeSeer web page, select PLUG-INS > Manage. 2. Click the + icon next to Additional Interfaces to expand the list of available HomSeer3 plug-ins. 3. Click the + icon next to the Audio / Video and Infra-red (IR) category, then click the checkbox next to the UltraHTDAudio3 (HTD Audio Controller) package to mark the plug-in for installation. 4. Under Pending Updates/Installs, click the Download and Install button. 5. Once the installer finishes, find the UltraHTDAudio3 plug-in under Installed Plug-Ins, then enable it. UltraHTDAudio3 HSPI Setup Before you begin to configure the UltraHTDAudio3 plug-in, you ll need to make sure your HTD Audio Controllers have been properly setup. Please fully test your HTD Audio Controllers using each zone keypad to make sure zone power, volume and inputs are fully functional before attempting to configure this plug-in. Test Your HTD System Locate your HTD controller and note the model number and the number of total audio zones supported by the controller. Walk to each HTD zone keypad and do the following: 1. Make a note of the zone number and zone name. 2. Turn the zone on, set the volume and change to a valid input to make sure the zone is operational. Connect your HTD System to HomeSeer If your system is not already connected to HomeSeer via a serial connection, then you ll need to either install a serial cable or install a network to serial adapter like the Global Cache itach WF2SL or IP2SL or the Global Cache itach Flex. Once installed, you ll need to note either the com port number or the IP address of the network to serial adapter. If you are running HomeSeer on a Linux system, then you ll need to use a network to serial adapter. Information Needed to Add an HTD Whole-House Audio System 1. The HTD controller unique name (e.g. HTD Lync12 - Basement) 2. The HTD controller unique serial number. If you cannot locate the serial number, then enter any unique string. 3. The HTD controller model number (e.g. Lync6, Lync12, MC-66, MCA-66). 5

6 4. The type of connection between your HomeSeer system and your HTD controller (e.g. Ethernet or Serial). 5. The connection address (e.g :4999 or COM:3). UltraHTDAudio3 HSPI Configuration Web Page Layout The UltraHTDAudio3 plug-in has seven web pages that provide access the available features of the plugin. The available web pages are as follows: 1. Status Displays the plug-in status. 2. Options Displays and allows you to change the options associated with the plug-in. 3. Audio Controllers Allows you to manage the list of HTD Audio Whole-House Controllers that are configured to communicate with the plug-in. 4. Audio Zone Devices Allows you to add HomeSeer devices to control the HTD Audio Whole- House audio zones. UltraHTDAudio3 HSPI Options All options are set from the Options web page. The following options are supported: 1. Authorized User Roles This option allows you to specify which type of HomeSeer user has access to view and configured the plug-in options. 2. Logging Level Specifies the desired plug-in logging level. 6

7 Screenshot UltraHTDAudio3 HSPI Audio Controllers The Audio Controllers web page allows you to add, modify and delete HTD Audio Controllers. To add a new controller, simply click the New button. To edit or delete an existing controller, click the Edit or Delete link under the Action column. Screenshot UltraHTDAudio3 HSPI Audio Zone Devices The UltraHTDAudio3 plug-in allows you create just the devices you need to control your HTD Whole- House Audio System. Once the devices are created, you can control your HTD Whole-House Audio Controller from the HomeSeer Device Management web page or using HomeSeer Events. 7

8 Screenshot Adding HTD Audio Zone Devices The UltraHTDAudio3 plug-in allows you to create just the devices you need to control your HTD Whole- House Audio System. Zone Master Controls Power The Power HomeSeer device allows you to view the current audio zone power state and turn on and off an audio zone. Note: The HTD zone keypad displays will automatically update for changes to this device. Source The Source HomeSeer device allows you to view the current audio zone selected source input and to change the source input. 8

9 Note: The HTD zone keypad displays will automatically update for changes to this device. Party Mode The Party Mode HomeSeer device allows you to view the current audio zone party mode status and enable or disable the party mode. Note: This device is read-only. Do Not Disturb (DND) The Do Not Disturb HomeSeer device allows you to view the current audio zone DND status and enable or disable the DND mode. Note: The HTD zone keypad displays will automatically update for changes to this device. Zone Audio Controls Volume The Volume HomeSeer device allows you to view or change the current audio zone volume level. Note: The HTD zone keypad displays will automatically update for changes to this device. Mute The Mute HomeSeer device allows you to view or change the current audio zone volume mute setting. Note: The HTD zone keypad displays will automatically update for changes to this device. Bass The Bass HomeSeer device allows you to view or change the current audio zone bass level. Note: The HTD zone keypad displays will not automatically update for changes to this device. Treble The Treble HomeSeer device allows you to view or change the current audio zone treble level. Note: The HTD zone keypad displays will not automatically update for changes to this device. Balance The Balance HomeSeer device allows you to view or change the current audio zone balance level. Note: The HTD zone keypad displays will not automatically update for changes to zone balance. 9

10 Screenshot 10

11 Modifying an Existing UltraHTDAudio3 Device You can modify an UltraHTDAudio3 device the same way you modify any other HomeSeer device. Simply click on the device name from the HomeSeer device page, and then change the device properties as needed. Note: Once a HomeSeer device is created, the plug-in will not overwrite any of the device properties, so feel free to modify the name, location and location2 properties as you see fit. Deleting an Existing UltraHTDAudio3 Device You can delete an UltraHTDAudio3 device the same way you delete any other HomeSeer device. From the HomeSeer device web page, click the device name, then from the HomeSeer modify device web page, click the Delete button. UltraHTDAudio3 HSPI Audio Zone Sources The UltraHTDAudio3 plug-in allows you modify the Audio Zone Sources for each HTD Whole-House Audio Controller. Simply select the Audio Device, then edit the source names for each connected source. If you are not using a source, you can disable it to hide it from the HomeSeer Source Device. 11

12 Screenshots 12

13 UltraHTDAudio3 HSPI Triggers This plug-in does not have any HomeSeer triggers defined. However, you can still create an event trigger using the HTD HomeSeer device. As an example, you can trigger a HomeSeer event whenever you turn an audio zone on at the keypad by using A Device s Value is as a trigger. UltraHTDAudio3 HSPI Trigger Actions This plug-in does not have any HomeSeer trigger actions defined. However, you can still control your HTD Audio Controller by using a Control a Device action. As an example, you can automatically turn on audio zones, set the source to your HomeSeer system to speak announcements. 13

14 UltraHTDAudio3 HSPI Trigger Conditions UltraHTDAudio3 HSPI conditions allow you to specify that certain conditions must exist before a HomeSeer event will run. The plug-in does not currently have any conditions configured. UltraHTDAudio3 HSPI API Reference To be determined 14