Quick Setup Guide. Compass Control System. Compass Control is the first fully integrated major control system

Transcription

1 Discover The Possibilities The Experts in Digital Video Technology and Solutions Compass Control System Quick Setup Guide Video Audio Automation Climate Lights Shades Web Security Key Digital, led by digital video pioneer Mike Tsinberg, develops and manufactures high quality, cutting-edge technology solutions for virtually all applications where high quality video imaging and control are important. Key Digital is at the forefront of the video industry for Home Theater Retailers, Custom Installers, System Integrators, Broadcasters, Consultants, Builders, Designers, Architects and Consumers. Compass Control is the first fully integrated major control system built from the ground up to use Apple s ios devices ipad, ipad mini, iphone, and ipod touch as its backbone. 521 East 3rd Street, Mount Vernon, NY Phone :: Fax :: Web :: The Experts in Digital Video Technology and Solutions Rev 2 Apr 2014

2 Table of Contents 1. Compass Control System Overview Getting Started Download the Software Package Download the App Register the Apple ios device Install the KD-MC2500 Master Controller Set-up the KD-MC2500; The Device Manager Run the Compass Navigator Software Open the Sample Template Project in Compass Navigator Upload the Sample Project to the Server Download a Project to the ipad The Compass Control System Database Managers...26 How to Contact Key Digital...30 Warranty Information...30 Installation Notes Compass Control System Overview a. System Overview The Compass Control System is comprised of 4 major parts. The hub of the system is the KD-MC2500 Master Controller. This component is connected to the Network and receives signals from the controllers and then routes IR, RS-232 and/or IP commands to the system source and display equipment. The second part of a Compass Control System is a Key Digital Matrix Switcher. This is the only part of the system that is not actually necessary for operation, but including this allows for A/V switching plus expands the control capabilities of the overall system. In order to perform any programming, the Compass Navigator Software is required. This third element of the Compass Control System is offered to all Key Digital Compass Control System dealers along with programming training via live and web classes. The fourth part of a Compass Control System is the user interfaces, the controllers. The Compass Control System uses Apple ios devices, the ipad, ipad mini, ipod Touch, or iphone and provides all the unique and advanced features inherent in these state-of-the-art products. b. Master Controller The KD-MC2500 Master Controller works as the control hub for the Compass Control System. It has a number of I/O ports that allow IR, RS-232 and sensor control of the system and peripheral A/V components. In addition, the KD-MC2500 allows IR learning and has two sets of switchable contacts for relay control of external equipment. KD-MC2500 Front Panel The front panel of the KD-MC2500 has 14 LED indicators to show the status of the unit. The power indicator is lit whenever the unit has power. The link indicator is lit when the unit is on an active LAN. The status indicator lights whenever the unit is receiving or sending a signal. The WiFi indicator is for future use. There are also indicators for the 8 IR/RS-232 ports and for the 2 relays each lighting whenever that port or relay is active. Additionally, there is an IR Learning window that allows IR signals to be captured and saved directly to IR Database Manager. It is recommended that a shield be placed above the unit and donor remote when learning IR signals to prevent any ambient IR interference from corrupting the signal. KD-MC2500 Front Plate 1. Power 2. LAN Link 3. Status 4. Active WiFi 5. IR Learning Window 6. I/O Port Indicators 7. Relay Indicators 2012 Key Digital, Inc. All rights reserved. 1

3 1) Power Indicator Power On (red) Accepting update from manager (blue) 2) LAN Link Indicator 3) Status Indicator Blinks whenever a signal is received 4) Active Internal WiFi Indicator Note: Reserved for future use. Not currently active. 5) IR Learning Window 6) I/O Port Indicators (1 8) Blinks when sending IR or RS-232 signals Lights when sensor is active 7) Relay Indicators Lights when Relay is active KD-MC2500 Back Panel The back of the KD-MC2500 has 2 Phoenix connectors for using the relays (each has Common, NO and NC contacts) and the 8 IR/RS-232 1/8 mini plug connectors. These ports can also be programmed to operate as sensors to determine the state of a piece of equipment. Next to these is a hole to access the reset button. Along the bottom of the back panel are the 1/8 main Serial IR port, the RJ-45 Network connector, a USB connector (for KD-MC2500 Setup), a DB-9 connector for the main serial RS-232 connection, and the power connector. KD-MC2500 Back Plate 1) Relay 1 & 2 connections 2) I/O Ports (1 8) 3) Reset switch 4) Main IR Out 5) RJ-45 LAN Connector 6) USB Port 7) Main RS-232 Connector (Bi-directional) 8) Power Supply Connector Each side of the KD-MC2500 has tapped holes for attaching the rack mount ears, vents for cooling, and the bottom has four removable rubber feet. c. Matrix Switchers Key Digital Matrix Switches have been industry standard products since entering the market in the late 1990 s. Besides offering superior Video switching capability, these products have developed to offer Audio routing as well as Control routing. In all applications where multiple A/V sources and displays are being used, adding a Key Digital Matrix Switcher to the system not only provides the A/V switching and routing, but also increases the control options. The current product mix allows the Matrix Switcher to be used to route the control signals, either IR or RS-232, to the remote sources or displays. These signals can even be sent through a choice of Baluns allowing the use of CAT6/STP wiring to deliver A/V and control signals remotely. The Compass Control System uses this capability and provides a simple method of routing these control signals while also switching the A/V sources to the proper displays. KD-HD8X8BT - 8 Inputs to 8 Outputs HDBT/HDMI/DVI via Single CAT6/STP Matrix Switcher with Audio Distribution System 1. Relay 1&2 Connections 2. I/O Ports (1-8) 3. Reset Switch 7. Main RS-232 Connector 4. Main IR Out 5. RJ45 LAN Connector 6. USB Port 8. Power Supply 2 3

4 d. Compass Navigator Apple ipad 2 with Key Digital Compass Control App Programming the Compass Control System requires the use of the PC Editor called Compass Navigator. This Key Digital exclusive program allows both a simple step-by-step operation to quickly get through the basic programming process, plus many more advanced programming capabilities using included tools to create unique and powerful custom control interfaces. Easily program for A/V distribution using the Key Digital Matrix Switchers, or just set up a simple control interface for controlling the client s existing system. The Compass Navigator Software allows great flexibility for both basic and complex programming. Key Digital Compass Navigator Software As a secondary controller option, the Compass Control System also supports the ipod Touch. This smaller device allows the same level of control as the ipad, but since it has a much smaller footprint, it is recommended that it be used as a secondary remote with the ipad as the main controller. The registration process is the same for the ipod as it is for the ipad. Apple ipod Touch with Key Digital Compass Control App e. Controllers The controller of choice for the Compass Control System is the Apple ipad. This device provides a 9.7 color touch screen which can be used in either portrait or landscape layout. The ipad offers many options that make the user experience very dynamic. And, many of these features have become expected by the end-users who have used ios devices in the past. These include a great graphics engine, the ability to embed images inside other images, quick navigation from page to page, and the flick option to choose between items, pages, graphics, etc. All of these features, and more, offered by the ipad are available for use when creating the user interface. 4 5

5 2. Getting Started Compass Navigator software is to be downloaded by Certified Programmers who have successfully completed the necessary online training curriculum. Compass Control is to be sold by Authorized Resellers that have gained authorization from Key Digital. Please follow the below instructions to ensure that your company is awarded the necessary programming certification and resale authorization status for Compass Control. Figure 1.2: The Key Digital Training Login Registration Page: a. Go to i. View the Compass Control Test Drive video to see a short introduction of the Compass Navigator Software b. Register with Key Digital i. Go to ii. Select Click Here to Sign Up. See figure 1.1 Figure 1.1: The Key Digital Training Login Page. Press Click Here to Sign Up to register with Key Digital iv. Submit your Registration. You will receive an from webmaster@keydigital.com within two business days confirming your approval. Please ensure that this address is not routed to your Junk folders. See figure 1.3 Figure 1.3: Registration Confirmation from Key Digital iii. Enter all information necessary information including where your company purchased Key Digital products (ie, Distributor, Direct Account, or Rep Firm). See figure

6 c. After receiving the approval from Key Digital, return to Dealer/Reseller portal: i. Enter your User ID and Password to access the Key Digital Dealer/Reseller portal ii. Press the Control System Online Training button to enter the Compass Control Online Training portal. See figure 1.4 Figure 1.4: The Key Digital Online Dealer Training Portal. Press the Control System Online Training button to begin the certification curriculum. d. Download the Compass Navigator software package 1. Go to 2. Select Compass Navigator Download. See figure Enter your User ID and Password to begin download Figure 1.5: The Compass Control Main Page on the Key Digital website. Press the Compass Navigator Download button to download the Compass Navigator software package. iii. Gain your Certification 1. Optional: View the Compass Control Overview video and take the exam to verify your understanding of Compass Control and components 2. Mandatory: View the C1 Training Video, which will introduce you to all steps necessary to program a simple, single zone project. Complete the Level C1 Exam with a passing grade to receive the Compass Control Certification. Continue to Section 3 Download the Software Package of the Compass Control System Quick Start Guide for further information on installing the software package, etc. 8 9

7 3. Download the Software Package Install the Compass Control Software Suite from the Key Digital website. When it installs, a Key Digital folder is created in the Programs tree, and there are five programs placed in this folder; Compass Navigator, the KD-MC2500 Device Manager, and the three Database Managers. An icon for each of these is created on the desktop for easy launching of these programs. When launching the Compass Navigator program, be sure to be in administrator mode. Note: If you encounter the following message when you open Compass on a computer running Windows 7/Vista, you will need to assign administrative privileges to the program. To assign administrative privileges, go to the C: drive, right click the Compass Control icon and select properties. Then, select the compatibility tab and select Run as an administrator. You will now be able to run the program from the program menu or shortcut icons without any issues. Follow the Install Wizard:

8 4. Download the App Use the ipad or other ios device to open the App Store. Or connect the ios device to the computer and open the App Store in itunes. Locate the Compass Control App by using the Search feature. It is listed as Compass Control. Then download it into the controller. Once it is installed, launch the App and select the Registration tab. Load the Demo System into the device. Once the blue Start tab becomes active, select this to launch the Demo file. Compass Control App on the ipad 5. Register the Apple ios device There are four steps required to load a file into one of the ios device controllers. Anyone wishing to upload configurations to an ipad or an ipod needs to be registered through our Dealer Only Registration Portal. Then, all ios devices must be registered and authorized. This entails first loading the Compass Control System App from the i-store onto the ios device as outlined in the previous section, then marrying the Registration code to the Device ID. After that, the file can be easily uploaded to the secure Key Digital server through the Compass Navigator Software, and then downloaded into the ios device via the Registration tab on the App. To become a registered dealer, go to This provides access to the password protected Dealer Only Registration site. Anyone not already registered needs to enter their personal data here, provide their address as the User ID, and select a Password. Once registered for the site, the dealer needs to log in to register the ios device. Key Digital Device Registration Log-in Portal Compass Control App at the App Store on the PC In order to allow an ipad to be used as a controller for the system, it needs to be registered. This process entails purchasing a registration license for each ipad to be installed, and then using the registration number to marry each ipad to this registration code. Once this is done, the ipad can be programmed for use in the system. The file is then generated in the Compass Navigator Software, and it is uploaded to the Key Digital server where it is stored and then sent to the ipad upon launching the App. This makes it easy to update the program by sending an edited program to the server, and having the App pull the new content whenever needed

9 Key Digital Compass Control Software Registration Card & the ipad Device ID Registering an ios device. Begin at There are two numbers that must be connected electronically in order to allow the ios device to receive the file. The first is the Registration License that can be found on the Registration Card. The second number is the Device ID which is found in the ios device itself. First, log in to the dealer-only registration site listed above. Then, enter the Registration Key where indicated, and hit the Register Device button. Make sure to use capital letters and include the hyphens. This brings up a screen where the ios device information is entered. The two really important fields are the Registration Key (simply make sure that this number is correct) and the Device ID number field. Find the Device ID on the ios device itself by launching the App. This brings up the Set-up screen. Hit the Registration button, and the Device ID is listed. Enter this number exactly as it appears in the Device ID field. The other fields are simply informational. However, it is a good idea to provide a unique name for the device, leaving no blank spaces, and use the same name, paying attention to the correct spelling, throughout the file. 3 4 Once this is completed, the ios device is ready to receive the project programmed in the Compass Navigator Software. Be sure to include the Device ID in the Properties window when generating the file in the Compass Navigator Software to ensure that the project will be linked to this device. See Section 9 Open the Sample Template Project in Compass Navigator

10 6. Install the KD-MC2500 Master Controller Connect the KD-MC2500 to the system components and Matrix Switcher. 1 6 Connect RS-232 Control Cables A/V Component Display Contents of KD-MC2500 Package 3.5mm to DB9 RS-232 Cable KD-MC2500 Power Supply 6V5A USB Type A to Mini B Cable x1 3-Pin Terminal Block for Relay x2 7 Wire Relay-Controlled Devices Ear Mount (long) IR Emitters x6 3.5mm RS-232 Data Cable x3 Ear Mount (short) Terminal Block Wiring Screen 2 Plug in the KD-MC Control a KD-HD8X8BT Matrix Switcher KD-HD8X8BT Power Cable Power LED Light RS-232 Cable 3 Connect to LAN LAN 9 Route IR through Matrix Switcher 3.5mm to 3.5mm cable WiFi CAT5 Wiring Link LED Light KD-HD8X8BT 4 Connect to Computer Launch KD-MC2500 Device Manager Source (or Display) CAT6/STP CAT5e/6 Extender Display (or Source) USB Setup KD-MC Connect IR Emitters Source IR Emitter IR Emitter Projector Display IR Emitters 16 17

11 7. Set-up the KD-MC2500; The Device Manager 10 Route RS-232 through Matrix Switcher KD-HD8X8BT 3.5mm to 3.5mm cable A/V Component 3.5mm to DB9 RS-232 Cable CAT6/STP CAT5e/6 Extender Display (or Source) The KD-MC2500 is configured using the KD-MC2500 Device Manager. This sub-program, included with the Compass Software Suite, allows the KD- MC2500 to be set up. This includes assigning a static IP Address, updating the internal firmware, setting the RS-232 protocol parameters for the Main RS-232 output, and configuring the I/O ports. Make sure that the KD-MC2500 and the PC are either connected via a USB cable or that both are connected to the same network, and launch the Device Manager. Update the firmware if needed, and then walk through the set-up steps. It is important to assign the 8 multifunction I/O ports. This will be as Port Mode, Video or Audio Sensor, Bi-level Sensor or Trigger. KD-MC2500 Device Manager Set Static IP Address 1 2 RS-232 Cable Set Main RS-232 Protocol Settings for I/O Ports used for IR

12 Set RS-232 Ports Sensor Port Settings Run the Compass Navigator Software Use the Compass Navigator Software to create a simple test project and upload it into the ipad. Section 2 in the Compass Control System Programming Manual details the process of generating a file using the step-by-step programming process. Here is an overview of the Compass Navigator program interface. The Compass Navigator Software uses the standard Windows structure. At the top left corner is the Quick Access toolbar. These functions are always available, and any command in any of the ribbons can be added to this section. Below that are several tabs called Ribbons that open horizontal menus of options. KD-MC2500 Status after Set-up 7 Workspace windows Below the Ribbons is the workspace. This area is comprised of several windows that allow programming of different features. These windows can be moved or closed at will to optimize the space for whichever aspect of the programming is being done. As noted in the discussion of the Window ribbon, these layouts can be saved. Any of the preconfigured workspace layouts can be accessed using the buttons at the bottom numbered 1-8. Also, the default layout can always be accessed. Compass Navigator Layout 20 21

13 There are several windows available for use in the workspace. The primary ones are: the Properties window which generally docks along the right side; Devices Library which houses the devices that are being used in the file; Control Library which allows devices to be imported from the databases; System Designer that provides the Tree View for system configuration; Controller and Page Designers that allow the graphics to be imported for the user interface. There are several other windows available, but these are used for specific functions that will be covered in programming discussion. All of these windows are presented during the proper time in the Program ribbon when using the step-by-step process. Any of these windows can be used in any of the user defined layouts. 3. Update the IP Address of your KD-MC2500 Master Controller 4. Select KD-MC2500 from Conference_Room_iPad in the System Designer Window, under the SampleTemplate1 Tree. Modify IP Address in the Properties Window. Refer to Section 6, Set-up the KD- MC2500; The Device Manager for information on your IP Address. 9. Open the Sample Template Project in Compass Navigator 1. Open Sample Template 1. C:\Program Files\Key Digital\Compass Control\SampleTemplates\SampleTemplate1.ksp 2. Select Conference_Room_iPad in the System Designer Window, under the SampleTemplate1 Tree. Modify Device ID in the Properties Window. Refer to Section 5, Register the Apple ios5 device for information on your Device ID. The entire Programming process is detailed in the Compass Navigator Programming Manual available on the Key Digital website

14 10. Upload the Sample Project to the Server Once the device is properly registered, the file can be uploaded to the server and then pulled into the device through the App. When the file is completed, or at a point where testing is required, go to the Communication ribbon and select Upload System Project. There will be a prompt to log in to the Registration site using the User Name and Password created earlier. Once entered, the file will begin uploading. Do not navigate away during this process. Once the upload is done, a completion window pops up. The file has now been successfully uploaded to the server. Back-up Project to Key Digital server 11. Download a Project to the ipad Once the file has been created and uploaded to the server, use the App on the ios device to pull the file into it. Launch the App and go to the Set-up page. Select Registration and hit Update Project. As soon as the blue Start button lights up, hit it to launch the project. Update Project Button on ipad

15 12. The Compass Control System Database Managers The Database Manager allows commands sets to be edited, refined or even developed from scratch for use in system configurations. There are three Database Managers for use with the Compass Control System; an IR Manager, an RS-232 Manager and a TCP/IP Manager. All of these offer functionality that provides very deep levels of customization. Each of the Managers allows the existing library to be edited. Components can be added, deleted or the actual code sets can be altered as needed to provide better operation. Codesets can even be imported from an existing project and edited. In this way, a set of commands that need to be tweaked for optimal control of a specific component, can be opened from the project file and edited. In addition, each Manager allows for the creation of a User Defined Library. Each programmer can develop their own subset of most often used devices, which then grants easier access to these components during the programming process. An overview of the three Databases follows here. A deeper discussion of their functionality is found in Section 3 of the Compass Control System Programming Manual. a. IR Database Manager The IR Database Manager allows programmers to oversee the IR Codesets in the database. This includes altering the actual codes and/or codesets themselves, adding devices, adding codes or codesets to the database, importing codes and/ or codesets, and creating new device codesets by learning the IR codes into the database or using Pronto Hex codes. The IR Database Manager also allows the set-up of the default settings for a particular codeset. Additionally, the Manager provides a method to test the codes through the KD-MC2500 to ensure that a particular code or full codeset operates the Device properly. The IR Database Manager b. RS-232 Database Manager The RS-232 Database manages these command protocols by allowing codes to be added, edited, deleted, and whole codesets generated. Additionally, any code can be tested through the database using the KD-MC2500 or the KD-Terminal Control Terminal. Commands can be written using ASCII, Decimal, or Hex, and suffixes can be automatically added to each command in a codeset such as Carriage Return and Form Feed. The RS-232 Database Manager c. TCP/IP Database Manager The TCP/IP Database Manager allows the programmer to manage the one-way IP commands in the Database in the same way as the RS-232 command sets in the RS-232 Database Manager. In fact, many of these commands will be the same in both codesets. Two-way IP communications require a two-way Device Driver to be generated for control and feedback. Creating and working with two-way drivers is covered in Section 4 of the Compass Control System Programming Manual

16 The TCP/IP Database Manager Important Product Warnings: 5. Test for proper operation before securing unit behind walls or in hard to access spaces. 6. If installing the unit into wall or mounting bracket into sheet-rock, provide proper screw support with bolts or sheet-rock anchors. Safety Instructions. Please be sure to follow these instructions for safe operation of your unit. 1. Read and follow all instructions. 2. Heed all warnings. 3. Do not use this device near water. 4. Clean only with dry cloth. 5. Install in accordance with the manufacturer s instructions. 6. Do not install near any heat sources such as radiators, heat registers, stoves, or other apparatus (including amplifiers) that produce heat. 7. Only use attachments/accessories specified by the manufacturer. 8. Refer all servicing to qualified service personnel. Servicing is required when the device has been damaged in any way including: Damage to the power supply or power plug Exposure to rain or moisture You MUST use the Power Supply provided with your unit or you VOID the Key Digital Warranty and risk damage to your unit and associated equipment

17 How to Contact Key Digital Installation Notes System Design Group (SDG) For system design questions please contact us at: Phone: Technical Support For technical questions about using Key Digital products, please contact us at: Phone: Repairs and Warranty Service Should your product require warranty service or repair, please obtain a Key Digital Return Material Authorization (RMA) number by contacting us at: Phone: rma@keydigital.com Feedback Please any comments/questions about the manual to: customersupport@keydigital.com Warranty Information All Key Digital products are built to high manufacturing standards and should provide years of trouble-free operation. They are backed by a limited two-year parts and labor warranty

18 Installation Notes Installation Notes