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.
Table of Contents Table of Contents Introduction ...............................................................................................................1 Supported Operating Systems ................................................................................................. 1 Minimum PC requirements....................................................................................................... 2 Installing KPDesign .......................................................................
Table of Contents Sample NetLinx Code ............................................................................................................ 15 Compiling the NetLinx Code .................................................................................................. 17 Downloading the Source Code File to the Master.................................................................. 17 Troubleshooting ...................................................................................................
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.
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.
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 Opens the Project Properties dialog. Open Opens an existing project file Close Closes and saves the current project file. Save Saves the current project file to disk.
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. File Export Exports the current project file to the selected location. The Export function will be a virtual mirror image of the Import function.
Introduction Page menu The Page menu contains commands associated with channels and panel properties: Page Menu Options Add Page Opens the Add Page dialog. Delete Page Deletes the selected Page. Rename Opens the Rename Page dialog. Item menu The Item menu contains commands associated with item management: Item Menu Options Add Item Opens the Add Item dialog. Insert Item Opens the Insert Item dialog. Move Up Moves the selected items up one position in the Items list.
Introduction Toolbar The Toolbar (FIG. 2) contains shortcuts to many of the main features of KPDesign. Add Item Delete Page Add Page Save Open New Page Cut Copy Paste Delete About Print Move Down Move Up Channel Maps Find FIG.
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.
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.
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.
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.
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.
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.
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 (.
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 DMS-IMSMod.tko Virtual_Dev A virtual device you define. Real_Dev The device number of the DMS or IMS panel.
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] (**********************************************) (* STARTUP CODE GOES BELOW *) (****************
Using KPDesign Where: DVVirt an arbitrary Virtual Device number you define (range for keypad panels = 32768 -36863). DvDMS the real device number of the DMS or IMS panel. StrFileName a string variable (CHAR array) containing the file name of the KPD file to download or run. StrVarTextArray a two-dimensional array to store variable text in. The first dimension should be the largest variable text string number you want to use.
Using KPDesign 18 KPDesign Keypad Design Program
Troubleshooting Troubleshooting This section provides product solutions to common problems. KPD file error File Error Problem Solution: This error shows up on the display of • Remember that Landmark devices do not have any usable storage memory in them. They emulate all of their functions as they run on the keypad after the download and the master, using the virtual devices, which the modules require the reboot. It typically reflects a file name programmers to define in the code.
Troubleshooting 20 KPDesign Keypad Design Program
Appendix Appendix Application Note: DMS/IMS on NetLinx This application note applies to: ! DMS and IMS keypads ! NetLinx ! DMS-IMSMod.tko Using the DMS-IMSMod.tko module, you can connect the DMS and IMS keypads to a NetLinx system. Using the KPDesign program, you can design the pages to be displayed on these keypads. But how many keypads can you run on a single system? AMX has tested 48 DMS keypads, along with 8 NXI's, on a single master and found the the system requires some modification.
Appendix ! Current Lontalk Threshold = 50 ! Enter new Lontalk Threshold (Between 1 and 2000) (Default=50): 300 ! Current IP Threshold = 200 ! Enter new IP Threshold (Between 1 and 2000) (Default=200): 200 ! Setting Thresholds to: Interpreter 200 ! Lontalk= 300 ! IP= 200 Reboot and the new settings will take affect. Notes on Pages ! The bottom bar retains the same function for all pages. ! The three IMS buttons (not Enter, Up and Down) always retain the same functions for all pages.
Appendix Bargraph Notes ! Each bargraph can be Bargraph (Vertical on DMS, Horizontal on IMS) ! ! Temperature bargraph (Number with degree symbol with Inside temperature displayed) or Text mode (Number only) ! Sending 0 and 0 for limits on "Set Temperature" Mode uses Panel Property defaults. ! Sending 0 and 0 for limits on "Set Bargraph" Mode uses 0 to 255 step 1 for defaults. ! Sending 0 and 0 for limits on "Set Text" Mode uses 0 to 255 step 1 for defaults.
Appendix Send Commands The following Send Commands work with the DMS and IMS keypads. Send Commands "'TIME'" Set Backlight Timeout (0=Off, 1=Use Internal, 2-255 = Number of seconds) T# = Time value, In Seconds. "'PAGE-'" Page name to a given page name. Page Name is case sensitive "'TPAGEON'" Page tracking on. Returns page as string when changed. Example String Return: "'PAGE-My Page'," "'TPAGEOFF'" Page tracking off "'PACKON'" Pack unused variable text items.
Appendix Send Commands (Cont.) "'MICG'" Goto Mic Gain Adjust. Allows you to adjust mic gain interactively.
Appendix Embedded Text Codes Field Replaced Text: Embedded Text Codes 26 Embedded Text Code Description Keypad Type %JC Center Justify DMS & IMS %JR Right Justify DMS & IMS %JL Left Justify DMS & IMS %LF Large Font DMS Only %SF Small Font DMS Only %AF Auto Font DMS Only %WW Word Wrap DMS Only %TEMP Indoor, Outdoor Temperatures DMS Only %ITEMP Indoor Temperature DMS Only %OTEMP Outdoor Temperature DMS Only %TIME Time (12 hour Format Only) DMS Only %DATE Date with 2 digi
Appendix KPDesign Keypad Design Program 27
033-004-2456 5/04 ©2004 AMX Corporation. All rights reserved. AMX, the AMX logo, the building icon, the home icon, and the light bulb icon are all trademarks of AMX Corporation. AMX reserves the right to alter specifications without notice at any time. *In Canada doing business as Panja Inc. AMX reserves the right to alter specifications without notice at any time.
