User manual AMX KPDESIGN KEYPAD DESIGN PROGRAM

instruction manual KPDesign Keypad Design Program So ftw are Software Warranty Agreement GRANT OF LICENSE. AMX Corporation grants to you the right to use the enclosed KPDesign software program (the SOFTWARE) on a single central processing unit (CPU). This license is for object code only and does not convey any rights to use of the source code. This Agreement does not authorize you to distribute the SOFTWARE. COPYRIGHT. The SOFTWARE is owned by AMX Corporation, and is protected by United States copyright laws and international treaty provisions. Therefore, you must treat the SOFTWARE like any other copyrighted material (e.g., a book or musical recording) except that you may either (a) make one copy of the SOFTWARE solely for backup or archival purposes, or (b) transfer the SOFTWARE to a single hard disk provided you keep the original solely for backup or archival purposes. You may not copy the written materials accompanying the SOFTWARE. OTHER RESTRICTIONS. You may not rent or lease the SOFTWARE, but you may transfer the SOFTWARE and accompanying written materials on a permanent basis provided you retain no copies and the recipient agrees to the terms of this Agreement. You may not reverse engineer, decompile, or disassemble the SOFTWARE. If the SOFTWARE is an update or has been updated, any transfer must include the most recent update and all prior versions. You may use only one version of the SOFTWARE at any time. You may not use the version of the SOFTWARE not being run on your CPU on any other CPU or loan, rent, lease or transfer them to another user whether with or without consideration. LIMITED WARRANTY LIMITED WARRANTY. AMX Corporation warrants that the SOFTWARE will perform substantially in accordance with the accompanying written materials for a period of ninety (90) days from the date of receipt. Any implied warranties on the SOFTWARE and hardware are limited to ninety (90) days and one (1) year, respectively. Some states/countries do not allow limitations on duration of an implied warranty, so the above limitation may not apply to you. CUSTOMER REMEDIES. AMX Corporation's entire liability and your exclusive remedy shall be, at AMX Corporation's option, either (a) return of the price paid, or (b) repair or replacement of the SOFTWARE that does not meet AMX Corporation's Limited Warranty and which is returned to AMX Corporation. This Limited Warranty is void if failure of the SOFTWARE or hardware has resulted from accident, abuse, or misapplication. Any replacement SOFTWARE will be warranted for the remainder of the original warranty period or thirty (30) days, whichever is longer. NO OTHER WARRANTIES. AMX Corporation disclaims all other warranties, either expressed or implied, including, but not limited to implied warranties of merchantability and fitness for a particular purpose, with regard to the SOFTWARE, the accompanying written materials, and any accompanying hardware. This limited warranty gives you specific legal rights. You may have others which vary from state/country to state/country. NO LIABILITY FOR CONSEQUENTIAL DAMAGES. In no event shall AMX Corporation be liable for any damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or any other pecuniary loss) arising out of the use of or inability to use this AMX Corporation product, even if AMX Corporation has been advised of the possibility of such damages. Because some states/countries do not allow the exclusion or limitation of liability for consequential or incidental damages, the above limitation may not apply to you. U.S. GOVERNMENT RESTRICTED RIGHTS The SOFTWARE and documentation are provided with RESTRICTED RIGHTS. Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of The Rights in Technical Data and Computer Software clause at DFARS 252.227-7013 or subparagraphs (c)(1) and (2) of the Commercial Computer Software--Restricted Rights at 48 CFR 52.227-19, as applicable. Manufacturer is AMX Corporation, 3000 Research Drive, Richardson, TX 75082. If you acquired this product in the United States, this Agreement is governed by the laws of the State of Texas. Should you have any questions concerning this Agreement, or if you desire to contact AMX for any reason, please write: AMX Corporation, 3000 Research Drive, Richardson, TX 75082. Table of Contents Table of Contents Introduction ...............................................................................................................1 Supported Operating Systems ................................................................................................. 1 Minimum PC requirements....................................................................................................... 2 Installing KPDesign ........................................................................................................... 2 The KPDesign Work Area ................................................................................................. 2 Menu Bar........................................................................................................................... 3 File menu ................................................................................................................................. 3 Edit menu ................................................................................................................................. 4 Panel menu .............................................................................................................................. 4 Page menu............................................................................................................................... 5 Item menu ................................................................................................................................ 5 View menu ............................................................................................................................... 5 Tools menu .............................................................................................................................. 5 Help menu................................................................................................................................ 5 Toolbar .............................................................................................................................. 6 Panel Navigator........................................................................................................................ 6 Graphical Navigator ................................................................................................................. 7 Editor Window .......................................................................................................................... 7 Using KPDesign ........................................................................................................9 Creating a New File........................................................................................................... 9 Setting Panel Properties.................................................................................................... 9 Adding a New Page......................................................................................................... 10 Adding an Item ................................................................................................................ 10 Saving the KPD File ........................................................................................................ 10 Importing Files to a Project.............................................................................................. 10 Exporting Files................................................................................................................. 11 Exporting All Pages and Items from a project file .................................................................. 11 Exporting Pages from a project file ........................................................................................ 12 Exporting Items from a project file.......................................................................................... 12 Exporting Pages with Items from a project file ....................................................................... 13 Copying and Pasting Page Items .................................................................................... 13 Using KPDesign Files in NetLinx Studio ......................................................................... 13 NetLinx Modules .................................................................................................................... 14 Minimum Support Requirements for NetLinx Modules........................................................... 14 Configuring NetLinx Source Code for KPD Files ................................................................... 14 Source Code Entry................................................................................................................. 15 KPDesign Keypad Design Program i Table of Contents Sample NetLinx Code ............................................................................................................ 15 Compiling the NetLinx Code .................................................................................................. 17 Downloading the Source Code File to the Master.................................................................. 17 Troubleshooting ..................................................................................................... 19 KPD file error ......................................................................................................................... 19 Page flip errors ...................................................................................................................... 19 Errors while downloading KPD files ...................................................................................... 19 Appendix ................................................................................................................. 21 Application Note: DMS/IMS on NetLinx .......................................................................... 21 Thresholds ............................................................................................................................. 21 Notes on Pages............................................................................................................... 22 IMS Main Page....................................................................................................................... 22 Bargraph Notes ...................................................................................................................... 23 Custom Text Notes ................................................................................................................ 23 Send Commands ............................................................................................................ 24 Embedded Text Codes ................................................................................................... 26 ii KPDesign Keypad Design Program Introduction Introduction The KPDesign software design program enables creation of user interface (UI) pages for the PLKDMS and PLK-IMS KeyPads. This design tool provides a method for programmers and system designers to create a set of pages, menus, and an associated output file. KPDesign generates KPD files that can be imported into a Project in the NetLinx Studio program. The NetLinx Studio compiler uses Modules (code blocks) to accommodate KPDesign files in the compiled Source Code file, and handles transferring the code to the Master, and to the keypad(s). Features: ! ! ! Set temperature display as Fahrenheit or Centigrade (default is Fahrenheit) Set temperature minimum and maximum limits Set display to large or small with right, center, or left justification with word wrapping (PLK-DMS only) Up, Down, Enter, Contact, Mic, and Temperature Compensation configuration for a selected keypad Channel maps of push channels, variable text Quick link simulation to associated pages Auto Assign push channels and/or variable text channels for one or more selected items. Keypad Simulation ! ! ! ! ! If you are familiar with TPDesign, you will find working similarities within the KPDesign program. Supported Operating Systems ! ! Windows 95®/98® (with at least 48 MB of installed memory). Windows NT 4.0® Workstation or Server (service pack 6B or greater, with at least 64 MB of installed memory). If you are installing KPDesign on a Windows NT or Windows 2000 machine, you must have Administrator rights to install and run all required System files. ! Windows 2000® Professional or Server (running on a Pentium 233 MHZ processor (minimum requirement); 300 MHZ or faster recommended, with 96 MB of installed memory). Windows ME® Professional or Server (running on a Pentium 233 MHZ processor (minimum requirement); 300 MHZ or faster recommended, with 96 MB of installed memory). ! KPDesign Keypad Design Program 1 Introduction Minimum PC requirements ! ! ! ! Windows-compatible CD-ROM drive. Windows-compatible mouse (or other pointing device). At least 75 MB of free disk space (150 MB recommended). VGA monitor, with a minimum screen resolution of 800x600. Installing KPDesign 1. Insert the AMX Control Disc into your CD-ROM drive. 2. In Explorer, double-click KPDesign.exe from the directory window for your CD-ROM drive. 3. After reading the License Agreement, select I Agree and Next to proceed. 4. The Welcome To KPDesign 1.0 Setup dialog appears, reminding you to close all Windows programs before going any further. Click Next to proceed. 5. The KPDesign 1.0 Read Me File dialog displays the README.TXT file for this release of KPDesign. This file contains useful information pertaining to this release. 6. In the Select KPDesign 1.0 Program Manager Group dialog, select the Program Manager group to add KPDesign icons to. 7. In the KPDesign 1.0 Shortcut Creation dialog, select whether to install shortcut icons for the installed components on your desktop. 8. Click Next in the Start KPDesign 1.0 Installation dialog to install the selected components. 9. The program prompts you to restart your system to complete the installation. The KPDesign Work Area When first opening KPDesign, the UI window initially provides two frames with a standard menu bar. Upon creating a new file, the UI provides three frames: ! The left frame is the Panel Navigator window containing a tree structure of the project pages. The center frame is the Graphic Keypad window that displays a graphic simulation of the keypad you are creating the program for. The right frame is the Editor Window. ! ! FIG. 1 shows the KPDesign work area. 2 KPDesign Keypad Design Program Introduction Panel Navigator Graphic Keypad Editor Window FIG. 1 KPDesign Work Area Menu Bar Each of the Menu Bar options are described below: File menu The File menu contains commands associated with file management: File Menu Options New Open Close Save Save As Save All Print Opens the Project Properties dialog. Opens an existing project file Closes and saves the current project file. Saves the current project file to disk. Saves the file using the filename created via the File/New option above or the previously saved filename, if the file has been saved under a new name. Saves the current project file with a specified filename. Saves all open project files. Opens the Print sub-menu, with two print options: Graphical: Prints the page in blocks of six buttons (up to 12 lines), on a graphical representation of a panel. This virtual panel is followed by multiple groups of 6 items until all items on a single page have been printed. Each new page/list starts on a new printed page. Description: Prints a button-by-button description, organized by page, for all buttons/list items defined for the Keypad. Print Preview Opens the Print Preview sub-menu, which the same options as the Print sub-menu, for previewing. Print Setup Enables the Printer Properties dialog box so changes to printer settings may be made. KPDesign Keypad Design Program 3 Introduction File Menu Options (Cont.) File Import Enables bringing in a previously created file. Displaying a list of CD titles or DSS channels that are stored in an external file. The imported list is selectable from a drop down menu, from a toolbar button, or on a right click menu. Exports the current project file to the selected location. The Export function will be a virtual mirror image of the Import function. Selecting Export List, a Save As window, requesting a filename input, is shown. Once filename is input, and you click OK, a wizard steps you through the exporting of pages and/or items. Enables the Properties dialog box for displaying or changing project properties. Lists the most recently worked project files. If a keypad file is created or opened, it is added to the Recent Files list. Selection of a keypad file in Recent File opens the associated keypad page window. Closes the current project file and the KPDesign program. File Export Properties Recent File Exit Edit menu The Edit menu contains commands associated with editing files and program perferences: Edit Menu Options Undo Cut Copy Append Cut Append Copy Paste Undoes typing changes within a file, deletions. or changes. Cuts the selected page or items to the clipboard. Copies the selected page or items to the clipboard. Cuts the selected page or items and appends it to the end of the clipboard contents (rather than overwriting them). Copies the selected page or items and appends it to the end of the clipboard contents (rather than overwriting them). Places the copied or cut list items at the spot of the cursor, or adds the saved page to the active keypad file. If the item being cut or copied is a list item or page, all associated properties are copied at the same time. If the same item is being pasted back into the same list or keypad file, then the old name is used along with the words, "copy of" at the beginning of the item. If entering programming details and you cut or copy the information, then the information is simply cut/copied to the clipboard. This same text can then be pasted into any text box or outside application as straight text. Delete Select All Find and Replace Preferences Removes the selected items or page. Click to select all items in the Items list. Opens the Find and Replace dialog to perform search/replace operations. Opens the Preferences dialog where you can set global program preferences. Panel menu The Panel menu contains commands associated with channels and panel properties: Panel Menu Options Channel Maps Properties Opens the Channel Map dialog, which provides a display of Push and Variable Text channels that have been assigned, Channel Range, and Channel Usage. Opens the Panel Properties dialog, which provides a display of Push and Variable Text channels that have been assigned, Channel Range, and Channel Usage. 4 KPDesign Keypad Design Program Introduction Page menu The Page menu contains commands associated with channels and panel properties: Page Menu Options Add Page Delete Page Rename Opens the Add Page dialog. Deletes the selected Page. Opens the Rename Page dialog. Item menu The Item menu contains commands associated with item management: Item Menu Options Add Item Insert Item Move Up Move Down Properties Opens the Add Item dialog. Opens the Insert Item dialog. Moves the selected items up one position in the Items list. Moves the selected items down one position in the Items list. Opens the Item Properties dialog. View menu The View menu contains options associated with the KPDesign work area: View Menu Options Toolbar Status Bar Split Enables showing or hiding the KPDesign general toolbar at the top of the window. Enables showing or hiding the status bar at the bottom of the program window. Enables horizontal resizing of the editing window frame. Tools menu The Tools menu contains the Power Assign option: Tools Menu Options Power Assign Opens the Power Assign dialog. This dialog allows automatic assignment of push channels and/or variable text channels en masse, rather than function by function. Use this option to assign channels to selected items in a page. Help menu The Help menu contains commands for viewing the on-line help program and the About KPDesign dialog: Help Menu Options Help Topics About KPDesign Opens this on-line help program. Displays version and copyright information about this release of KPDesign. KPDesign Keypad Design Program 5 Introduction Toolbar The Toolbar (FIG. 2) contains shortcuts to many of the main features of KPDesign. Save Open New Page Add Item Delete Page Add Page About Print Cut Copy Paste Delete FIG. 2 KPDesign toolbar Move Down Move Up Channel Maps Find The toolbar icons are described below: Toolbar Icons Icon Name New Page Open Save Cut Copy Paste Delete Add Page Delete Page Add Item Move Down Move Up Find Description Create a new document Open an existing document Save the active document Cut the selection to the clipboard Copy the selection to the clipboard Pastes the contents of the clipboard to the active file, at the cursor's position. Deletes the selected items Add a page to the current document Deletes the current document Add an item to the current page Move one or more items down Move one or more items up Find the specified text Channel Maps Channel Maps Print About Print the active document Display program information Panel Navigator All KPD files that are open are listed in the Panel Navigator (FIG. 1). If you double-click on the project name, or its associated icon, the branch expands to list the page names defined within the KPD file. By clicking on any one page, the associated Page Editor will open. For every KPD file created, there is always an associated Main Page. The Main Page cannot be deleted or renamed, and is the default page each keypad returns to upon a timeout, if a timeout is defined. Within the Panel Navigator, there are specific options available. For instance, if you select a page and then choose Cut or Copy, from the drop down or a right-click menus, the software cuts/copies 6 KPDesign Keypad Design Program Introduction this page from one KPD file. It can then be pasted into another KPD file, or simply duplicated within the same file. Graphical Navigator The Graphical Navigator contains a Keypad simulation and an editing window. The graphical keypad window is a simulation of the LCD and buttons but does not actually send Push Commands. When you click on the Up and Down menu buttons in the simulation, The LCD text scrolls Up or Down as in a real keypad. The Button Properties are the only part of the simulation that is editable. Editor Window The Editor window is located to the right of the Graphical Keypad window. It allows you to manipulate the button properties for a given page of a keypad project. KPDesign Keypad Design Program 7 Introduction 8 KPDesign Keypad Design Program Using KPDesign Using KPDesign Creating a New File Upon starting KPDesign, you are presented with the program UI and no information. Begin by choosing File > New to open the Project Properties dialog. 1. In the Project Properties dialog, input/select the following information: ! ! ! ! ! ! ! ! ! ! Job Name - The title to give this project. Designer - Person who worked on this project. Tool Name - Name of the application that was used to create this file. Sales Order # - A place to keep sales order information. Purchase Order # - A place to keep purchase order information. Comment - Any comments pertaining to the file. Panel Type - Type of panel this file is used with (for ease of discussion, select DMS). Creation Date - The date that the file was created. Revision Date - The date that the file was revised. Revision - A user defined number assigned as a revision. 2. Click OK. 3. The program now displays the Project file in the Panel Navigator on the left, the DMS (or IMS) graphic in the center, and the editing frame on the right. 4. Choose File > Save to save the new .KPD file to a specified directory. Setting Panel Properties 1. Select a Panel in the Panel Navigator, and choose Panel > Properties (or Properties in the Panel folder context menu) to open the Panel Properties dialog. 2. In the Configuration tab, in the Temperature box, select a radio button to display the temperature in either Celsius or Fahrenheit, and type in the desired Low and High range values. 3. Enter the Mic Gain (0-100), Menu Timeout, and Backlight Timeout values. 4. Select the Up Arrow tab and type in the Channel number or click Channel Assign. Then, using the dropdown menus, select the Page and Item to first be shown when the Up Arrow is pushed on the keypad panel. 5. Select the Down Arrow tab and perform the same process you did for the Up Arrow tab. 6. Select the DMS or IMS tab, depending on which type of panel is selected): a. For DMS keypads, use the DMS tab to set Menu and List font properties. b. For IMS keypads, use the IMS tab to set the functions of the pushbuttons. 7. Click OK to save and apply the changes to the panel. KPDesign Keypad Design Program 9 Using KPDesign Adding a New Page 1. Choose Page > Add Page to open the Add Page dialog. 2. Type in the name you want to associate with the page. 3. Highlight the type of page desired, and then click OK. ! The named page now appears in the left tree frame and the new page appears in the editing frame on the right. Clicking on any button on the panel graphic, or clicking Main Page in the tree frame flips the program back to the Main page. ! Adding an Item 1. Choose Item > Add, or select Add from the Editing Frame context menu to open the Add Item dialog. 2. Manually input the Push/Release and Variable Text channel numbers, or click the Channel Assign button to auto-assign channel numbers for each entry. 3. Select the function type from the Function dropdown list. For Custom items, enter the Text name to associate with this item in the Text field. 4. Use the Font and Justification radio buttons to specify text size and placement. Also, check the Auto Wrap box if the Text name is too long to fit, and you are already using small or auto font size. ! To set a flip to a different page when this item is selected, then select the name of the target page from the Page dropdown menu. To flip to a specific item on the target page, select that Item from the Select Item dropdown menu. If there are programming specifics that are required or desired, click the Programming Details button to open the Programming Details dialog. Enter any programming specifics and comments, and click OK. ! ! 5. Re-check the Item Properties entries, and when satisfied that all is correct, click OK. The Item Properties window closes and the Item name is shown in the Main Page's panel graphic and in the right editing frame. The item is associated with the first empty button shown for the keypad panel. Saving the KPD File All KPDesign files must have the extension .KPD and NetLinx Studio must be greater than Build 118 in order to recognize the file extension. Choose File > Save/Save As from the Main Menu to save the project file. Importing Files to a Project You can import .TXT files into the selected Project using the File > File Import option. Use this feature to import pages, page items, or just items (i.e. play lists). This option invokes an import file wizard that guides you through the process. 10 KPDesign Keypad Design Program Using KPDesign Note that you cannot import the Main page. 1. Choose File > File Import to open the Import File dialog. Select the desired file and click Open. 2. The first dialog to appear (titled Step 1) asks you to pick a delimiter type (Comma or Tab) from the drop-down menu, and to select what aspects of the file to import. ! ! Choose Items, and click Next to proceed to Step 2. Choose Pages, or Pages and Items, and click Next to go to Step 3. 3. In the Step 2 dialog (for importing items only), select the page that you want to import the items into. 4. In the Step 3 dialog, match the item (s) in the Field list on the left to the Record column on the right: ! The Fields list contains a list of available fields that can be assigned to the item(s) in the Record list. The Record column displays the first item that occurs in the selected (import) file. Each item in the file to be imported is treated as its own record. Use the forward and back arrow buttons (under the Record list) to flip through each record. This way you can perform a quick visual check on each of the items in the file, to verify that the delimiter is correct, spelling, etc. The Record list shows each item as it will appear on the display panel. If you find an error, or anything that you want to change in the Record, you'll have to fix it in the source file, and re-import the file. ! a. Select the fields that you want to include with the record items in the Fields list. For example, if you are importing a CD play list that includes artist names and song titles, you would probably select Artist Name and Song Title as the fields. b. Using the up and down arrows, move the selected fields to align with their associated text in the Records column. For example, move Artist Name into position next to the artist name as it appears in the Records column, and move Song Title next to the song title in the Records column. 5. Click Next to import the file, and proceed to the Summary dialog, where you can view a summary of the imported file (total number of pages and items imported). 6. Click Finish to exit the import file wizard. Exporting Files You can export KPD files using the File > File Export option. This option invokes an export file wizard that guides you through the process. The options in the wizard vary according to what aspect(s) of the file you want to export. Note that you cannot export the Main page. Exporting All Pages and Items from a project file 1. Choose File > File Export to open the Export File dialog. Select the desired file and click Open. KPDesign Keypad Design Program 11 Using KPDesign 2. The first dialog to appear (titled Step 1) asks you to pick the delimiter type (Comma or Tab) used in the selected file from the drop-down menu, and to select what aspects of the file to export. In this case, select All Pages and Items. 3. Click Next to invoke the Step 4 dialog, where you can select the fields and set the order for the fields to be exported. Use the checkboxes and Select All or Select None to select and de-select the field options. When exporting pages, you should always select Type (which differentiates types of pages), and if you are exporting Levels, always select Level Mode (which differentiates between types of levels). 4. Click Next to invoke the Summary dialog, which indicates the total number of Pages and Items that were exported. 5. Click Finish to exit the export file wizard. Exporting Pages from a project file 1. Choose File > File Export to open the Export File dialog. Select the desired file and click Open. 2. The first dialog to appear (titled Step 1) asks you to pick the delimiter type (Comma or Tab) used in the selected file from the drop-down menu, and to select what aspects of the file to export. In this case, select Pages. 3. Click Next to invoke the Step 2 dialog, where you can select the page(s) that you want to export. 4. Click Next to invoke the Step 4 dialog, where you can select the fields that you want to export, and place them in the desired order for the export (using the up and down arrows). 5. When exporting pages, you should always select Type (which differentiates types of pages), and if you are exporting Levels, always select Level Mode (which differentiates between types of levels). 6. Click Next to invoke the Summary dialog, which indicates the total number of Pages exported. 7. Click Finish to exit the export file wizard. Exporting Items from a project file 1. Choose File > File Export to open the Export File dialog. Select the desired file and click Open. 2. The first dialog to appear (titled Step 1) asks you to pick the delimiter type (Comma or Tab) used in the selected file from the drop-down menu, and to select what aspects of the file to export. In this case, select Items. 3. Click Next to invoke the Step 2 dialog, where you can select the page that contains the items you want to export. 4. Click Next to invoke the Step 3 dialog, where you can specify which items you want to export. 5. Click Next to invoke the Step 4 dialog, where you can select the fields that you want to export, and place them in the desired order for the export (using the up and down arrows). 12 KPDesign Keypad Design Program Using KPDesign 6. When exporting pages, you should always select Type (which differentiates types of pages), and if you are exporting Levels, always select Level Mode (which differentiates between types of levels). 7. Click Next to invoke the Summary dialog, which indicates the total number of Items exported. 8. Click Finish to exit the export file wizard. Exporting Pages with Items from a project file 1. Choose File > File Export to open the Export File dialog. Select the desired file and click Open. 2. The first dialog to appear (titled Step 1) asks you to pick the delimiter type (Comma or Tab) used in the selected file from the drop-down menu, and to select what aspects of the file to export. In this case, select Pages with Items. 3. Click Next to invoke the Step 2 dialog, where you can select the page that contains the items you want to export. 4. Click Next to invoke the Step 4 dialog, where you can select the fields that you want to export, and place them in the desired order for the export (using the up and down arrows). When exporting pages, you should always select Type (which differentiates types of pages), and if you are exporting Levels, always select Level Mode (which differentiates between types of levels). 5. Click Next to invoke the Summary dialog, which indicates the total number of Items exported. 6. Click Finish to exit the export file wizard. Copying and Pasting Page Items When a list page is displayed, you can select one or more items and cut/copy these items from one page and paste them onto a second page. For instance, in programming transport functions, you might want to link the same five transport functions (Play, Stop, Pause, FFWD, REW) with device specific functions like chapter, frame, display on/off, TV/VCR, etc. The Device specific options need to be added manually. However, the transport controls very likely are identical on all pages. KPDesign provides a means to define these once, and then copy the individual items (either one by one or in a group) from one page to another. Optionally, the software allows items to be cut/ copied from one KPD file to a second KPD file. Using KPDesign Files in NetLinx Studio A KPD KeyPad panel file can only be loaded into a NetLinx Master via the NetLinx Studio software program. NetLinx Studio transfers the KPD file directly to the NetLinx Master. In order to use KPDesign file with the appropriate keypads, the NetLinx code file must first be configured (in NetLinx Studio), the code must be compiled, and then downloaded to the NetLinx Master. Note that the KPD file is being downloaded to the master and not directly to the keypad. KPDesign Keypad Design Program 13 Using KPDesign NetLinx Modules The NetLinx module for PLK-DMS and PLK-IMS keypads is named DMS-IMSMod.tko (FG2404). In compiling and downloading NetLinx code for PLK-DMS and PLK-IMS keypads, there are two main components of code to consider: ! The DMS-IMS module, named DMS-IMSMod.tko (located in the Program Files\Common Files\AMXShare\TKOs directory). You'll have to copy this file into the directory containing the Source Code file for the sytem containing the keypad(s). The KeyPad Design file (.KPD) ! Minimum Support Requirements for NetLinx Modules The following panels, firmware versions and software versions represent the minimum support requirements for the KPDesign module: ! ! ! ! PLK-DMS Keypad, version 5.1 PLK-IMS Keypad, version 5.0 NetLinx Studio version 1.2 Netlinx Master version 2.0, build 65 Configuring NetLinx Source Code for KPD Files You need to configure your NetLinx code to accommodate using KPD files. Before beginning, either use or write a new program (in NetLinx Studio) that: ! ! ! Defines the Virtual devices Defines the Keypad devices Associates the KPD file with defined devices Once you have a program: 1. In the DEFINE DEVICE section of the code, verify that the dvDMS is set to any user-defined value within the range of 32768 - 36863. 2. In the REALS section of the program, re-write the dvDMS_R to equal the value of the new Device number set in the Device Addressing Tab of the Tools > NetLinx Diagnostics dialog box. An example is if the Changed Device number value is set to 6001, the dvDMS_R value would now read 6001:1:0. Each consecutive keypad device would become: dvDMS_R 6002, 6003, 6004 +. 3. In the STARTING CODE GOES HERE / CREATE FILE section of the program, the StrFILE_NAME must equal the exact name of the KPD file being used in the compile. This file is added to the project file in the UI system folder of the Panel Navigator. 4. Add the KPD file to the project by choosing File > File Import. 5. Browse for the KPD file. 6. Uncheck the Use System Generated File Names option (because you want to keep the file name identical to what you are using in the actual NetLinx Studio program - StrFILE_NAME). 14 KPDesign Keypad Design Program Using KPDesign 7. Select the Add as Link option (if you do not want to copy the file to your project folder). Source Code Entry To include a module into your program, use the following module line: DEFINE_MODULE 'DMS-IMSMod' Module_Name(Virtual_Dev, Real_Dev, strFileName, strVarTextArray) Where: Module_Name Virtual_Dev Real_Dev StrFileName DMS-IMSMod.tko A virtual device you define. The device number of the DMS or IMS panel. A string variable (CHAR array) containing the file name of the KPD file to run. should be the largest variable text number you want to use. The second dimension should be the maximum size of the string you want displayed (maximum is 40 characters). StrVarTextArray A two-dimensional array to store variable text in. The first dimension For example, a NetLinx module for a DMS keypad would look like: DEFINE_MODULE 'DMS-IMSMod' mdlDMS (dvDMS, dvDMS_R, strFILE_NAME, StrVartextArray) Where: DMS-IMSMod MdlDMS DvDMS DvDMS_R StrFILE_NAME The name of the compiled TKO file. The module name. The module ID device number (ex 32768). The device number of the keypad. Exact name of the KPD file. StrVarText Array Description of the parameters for the variable text buffer. Sample NetLinx Code To download a KPD file to a NetLinx Master, you must use the NetLinx DMS-IMS module, with the following DEFINE_MODULE entry in the Master Source Code: DEFINE_MODULE 'DMS-IMSMod' Module_Name(Virtual_Dev, Real_Dev, strFileName, strVarTextArray) Where: Module_Name is a unique name. For example: DEFINE_MODULE 'DMS-IMSMod' mdlDMS (... or DEFINE_MODULE 'DMS-IMSMod' mdlIMS (... For example: KPDesign Keypad Design Program 15 Using KPDesign (**********************************************) (* DEVICE NUMBER DEFINITIONS GO BELOW *) (**********************************************) DEFINE_DEVICE DvVIRT = 33001:1:0 DvDMS = 6020:1:0 (**********************************************) (* VARIABLE DEFINITIONS GO BELOW *) (**********************************************) DEFINE_VARIABLE CHAR strFileName[100] CHAR strVarTextArray[100][40] (**********************************************) (* DEFINE_START StrFileName = 'avcnt11.kpd' (**********************************************) (* DEVICE NUMBER DEFINITIONS GO BELOW *) (**********************************************) DEFINE_DEVICE dvVIRT = 33001:1:0 dvDMS = 10001:1:0 (**********************************************) (* VARIABLE DEFINITIONS GO BELOW *) (**********************************************) DEFINE_VARIABLE CHAR strFileName[100] CHAR strVarTextArray[100][40] (**********************************************) (* STARTUP CODE GOES BELOW *) (**********************************************) DEFINE_START strFileName = 'avcnt11.kpd' DEFINE_MODULE 'DMS-IMSMod' mdlKDP(dvVERT,dvDMS,strFileName,strVarTextArray) STARTUP CODE GOES BELOW *) (**********************************************) 16 KPDesign Keypad Design Program