background image

O p e r a t i o n / R e f e r e n c e   G u i d e

S of t w ar e

KeypadBuilder

v2.1

Keypad Device Design Software

D o c u m e n t   I D :   3 3 - 0 0 4 - 2 9 4 2

I n i t i a l   R e l e a s e :   /   L a s t   R e v i s e d :   0 6 / 7 / 2 0 0 6

Summary of Contents for KEYPADBUILDER

Page 1: ...Operation Reference Guide Software KeypadBuilder v2 1 Keypad Device Design Software Document ID 33 004 2942 Initial Release Last Revised 06 7 2006...

Page 2: ...r after the RMA is cancelled will be refused AMX is not responsible for products returned without a valid RMA number AMX is not liable for any damages caused by its products or for the failure of its...

Page 3: ...he AMX SOFTWARE including without limitation any if any service packs or hot fixes provided to Licensee after the expiration of the ninety 90 day Limited Warranty period are not covered by any warrant...

Page 4: ......

Page 5: ...a The Most Recently Updated List 7 Accessing KeypadBuilder Help 7 Closing A Project 7 Exiting The KeypadBuilder Application 7 Generating A Project Report 7 Opening An Existing Project 7 Saving A Proje...

Page 6: ...Display Line 19 Sleep Screen Display Options 19 Fixed Menu Configuration 20 Fixed Menu Edit 20 Edit Keypad Menu window 21 Add and Edit Menu Item window 23 Complex Script Glyphs 26 What is a Complex Sc...

Page 7: ...Menu 37 View Menu 38 Navigation Menu 38 Transfer Menu 38 Options Menu 38 Help Menu 39 Toolbar 39 KeypadBuilder Project Navigation Pane 40 Mio R 1 Configuration Modules 41 Project Properties 41 Device...

Page 8: ...Keypad Device 56 Button Properties 57 Configuration Options 57 Display Channel Map 57 Display Options 58 Engraving 58 Keypad Device 58 Text Engraving 59 Display Options 59 Export to DXF File 59 LCD C...

Page 9: ...de 77 Arranging Menu and Sub Menu items 77 Creating Complex Script Glyphs 77 Editing Glyphs 78 Deleting Glyphs 78 Program Reference 79 Basic Usage Dialogs 79 Open KeypadBuilder Project dialog window 7...

Page 10: ...odero DMS Application Operations 95 Creating a New Mio Modero DMS Pinnacle Project File 95 Creating a New Mio Modero DMS Project File 95 Maximum Text Sizes 95 Working with Project Files 96 Setting a S...

Page 11: ...dows 104 Choose Font Dialog Window 104 Button Page Flip Actions Dialog Window 104 Add Button Dialog Window 105 Project Properties Dialog Window Project Information Tab 105 Add Edit List box Item Dialo...

Page 12: ...viii KeypadBuilder v2 1 Table of Contents...

Page 13: ...ce families System Requirements KeypadBuilder supports the following platforms Windows 2000 Service Pack 4 or greater Windows 2000 does not come equipped with MS Arial Unicode the required font for Ke...

Page 14: ...main menu options File View Options and Help Tasks Pane Provides a quick link to opening other KPB files including the Most Recently Updated Toolbar A button click option to the most regularly used f...

Page 15: ...ted DXF window this window is a representa tion of the DXF created by KeypadBuilder It is useful to ensure your engrav ing file is exactly as you had envisioned it Save Saves the current project If th...

Page 16: ...new project by clicking New Mio Modero Keypad to start a new Mio Modero project or select New Mio Modero R1 to start a new remote project Help Menu Help Launches the KeypadBuilder help file Web Update...

Page 17: ...click the Add Remove Programs icon 3 Do one of the following If you installed your Microsoft Office program as part of an Office package click Microsoft Office in the Currently installed programs box...

Page 18: ...KeypadBuilder Overview 6 KeypadBuilder v2 1...

Page 19: ...ile Close If you have made unsaved changes to your file you are prompted to save them at this time Exiting The KeypadBuilder Application To exit the KeypadBuilder application go to File Exit If you ha...

Page 20: ...Recent File List Size type the number of most recently updated files you KeypadBuilder to track the maximum is 9 Toggling View Menu Items The KeypadBuilder application area has items that are added o...

Page 21: ...nfiguration Engraving LCD Configuration Fixed Menu Configuration File Menu New Project Mio Modero Keypad Launches a new keypad project Mio Modero R1 Launches a new remote project Launches the New Proj...

Page 22: ...Click to select buttons and then assign button properties Configuration Options and Display Options The Channel Map can be accessed from this dialog Engraving Opens the Engraving dialog window Click...

Page 23: ...list Help Menu Help Launches the KeypadBuilder help file Web Update Launches the AMX Web Update utility Internet connection is necessary About KeypadBuilder Displays the about KeypadBuilder dialog con...

Page 24: ...s in creating a keypad device file FIG 3 KeypadBuilder Project Navigation Pane Project Properties Configuration Module Button Configuration Module Engraving Configuration Module LCD Configuration Modu...

Page 25: ...ed and optional Designer The designer name creating the KeypadBuilder file This field is user defined and optional Dealer Dealer name providing the keypad file This field is user defined and optional...

Page 26: ...device will dictate what colors you can pick Click OK to keep changes and exit the Project Properties module otherwise click Cancel and lose the changes Button Configuration The Button Configuration m...

Page 27: ...number is dictated by the selected device s firmware and is intended to assist in navigating the keypad device file Name The button name is for use within KeypadBuilder only and is intended to assist...

Page 28: ...eds to create your device s custom keypad Keypad Device The Keypad Device area is a graphic representation of your keypad device Click on a button to select and assign properties Display Options Show...

Page 29: ...s The Symbols drop down list is available when you select AMX Icon in the font selection list The list is a collection of icons created by AMX When you select an icon the corresponding letter is place...

Page 30: ...sent from the master and displayed on the device i e time or temperature Selecting No Lines for line allocation will cause the device to have lines of displayed menu text and no dynamic information A...

Page 31: ...le for dynamic items Level Styles When the Level box is checked the display can be on of the styles listed Click on one to select Sleep Screen Display Options The Sleep Screen Display is an optional g...

Page 32: ...the Edit Keypad Menu window Edit sub menu properties and channel assignments for the keypad menu You can set the sub menu properties to either Text Unicode or Complex Script Add Sub Menu Item Either...

Page 33: ...graphic Beneath the button number is a list of active button number and their names Channel Channel assignment for selected menu or sub menu item Auto Assign Takes the next unassigned channel code Cha...

Page 34: ...IG 9 Edit Keypad Menu Dialog Window Menu Type display items are either Text Unicode or Complex Script Button number button is selected either through the graphic or list Button channel assignment This...

Page 35: ...to make it active there is no need for a select button Return to Main After menu or sub menu item is selected the display returns to the device s main menu Channel Code The assigned channel of either...

Page 36: ...ive there is no need for a select button Return to Main After menu or sub menu item is selected the display returns to the device s main menu Channel Code The assigned channel of either the menu or su...

Page 37: ...line counts as one of the device s allocated display lines Select Active only active in main menu items Navigating and releasing on a menu item is the only necessary action to make it active there is...

Page 38: ...r language support KeypadBuilder creates a graphic image from predefined text and then load the graphic to your device This is useful for rendering conditional script languages displaying proprietary...

Page 39: ...list of available glyphs Click on a glyph to select Create new glyph Launches the Create Modify Glyphs dialog window to create new glyph entries Edit existing glyph Launches the Create Modify Glyphs...

Page 40: ...e glyph can be no larger than 96x24 Format font selection Launches the Windows font format dialog window Select the family format and size of the font Clear character entry field Clears all typed info...

Page 41: ...Button Configuration With a new KeypadBuilder project file open click Button Configuration in the Navigation Pane 1 By clicking on a button in the Keypad Device area select a button you wish to config...

Page 42: ...d device selected If you have already set the Button Configuration module the Name and Menu Action fields are populated 2 In the Font Selection drop down menu select between placing a symbol AMX Icon...

Page 43: ...amic the rest are allocated to menu items It is possible to have either all or no dynamic lines If you established dynamic items select to display the dynamic items at the Top or Bottom under Align Th...

Page 44: ...ither clicking on them in the Button list or selecting the button on the graphic keypad device If not already set you can assign channels at this time You can either Type the channel number in the fie...

Page 45: ...u plan to use Unicode you must set it before adding any sub menu items You can only edit and add sub menu properties when they have been assigned to menu items 1 In the Fixed Menu Edit dialog window s...

Page 46: ...t Menu Item dialog window 3 Enter the Unicode text in the Menu Caption field The corresponding Unicode Send Command Value is displayed beneath the text box 4 Click OK to return to the Add Edit Menu It...

Page 47: ...he navigation pane 2 Select from the list the glyph you intend to edit 3 Click Edit Glyph in the Add Edit Keypad Glyphs dialog window Select from the following steps to edit your glyph Change the font...

Page 48: ...Mio Modero Application Operations 36 KeypadBuilder v2 1...

Page 49: ...operties Display Configu ration and Engraving File Menu New Project Mio Modero Keypad Launches a new keypad project Mio R 1 Launches a new remote project Launches the New Project dialog window This wi...

Page 50: ...is is topical Project Information Device Selection and Device Setup Information Display Configuration Opens the Display Configuration dialog window Click to select buttons and then assign button prope...

Page 51: ...ation pertaining to version and copyright Toolbar New Keypad Launches a new keypad project New Remote Launches a new remote project Open Project Launches the Open Project dialog window Save Saves the...

Page 52: ...ane is open when a project file is active This is the main area for accessing the configuration modules in creating a keypad device file FIG 15 KeypadBuilder Mio R1 Project Navigation Pane Project Pro...

Page 53: ...and optional Designer The designer name creating the KeypadBuilder file This field is user defined and optional Dealer Dealer name providing the keypad file This field is user defined and optional Pur...

Page 54: ...vice will dictate what colors you can pick Click OK to keep changes and exit the Project Properties module otherwise click Cancel and lose the changes Display Configuration Click to select buttons and...

Page 55: ...splay type click on a button and select Remove Glyph to clear any display glyphs associated to that button Graphic interface for remote device A graphic thumbnail of how your menu item displays upon b...

Page 56: ...s to create your device s custom keypad Remote Device The Remote Device area is a graphic representation of your remote device Click on a button to select and assign properties FIG 18 Engraving Dialog...

Page 57: ...mbols drop down list is available when you select AMX Icon in the font selection list The list is a collection of icons created by AMX When you select an icon the corresponding letter is placed in the...

Page 58: ...Mio R 1 Configuration Modules 46 KeypadBuilder v2 1...

Page 59: ...ad device from the drop down menu 3 Select the color of your keypad device from the drop down list Color Selection 4 Click OK to confirm the changes or Cancel to exit and drop all changes Setting The...

Page 60: ...select in a range from 0 5 to 1 5 4 Click Update 5 To preview the DXF file as it appears to the engraver click Preview 6 Click Export DXF File to create the DXF file 7 Within the Export DXF File dialo...

Page 61: ...n pane 2 Click Edit Glyph in the Display Configuration dialog window 3 Click Edit Glyph in the Add Edit Keypad Glyphs dialog window Select from the following steps to edit your glyph Change the font f...

Page 62: ...displayed within the LCD Glyph A sample of the graphic as it appears within the LCD Glyph ID Number An ID number KeypadBuilder associates with all glyphs within the project to ensure unique values It...

Page 63: ...Configuration Engraving LCD Configuration Fixed Menu Configuration File Menu New Project Mio Modero Keypad Launches a new keypad project Mio Modero R 1 Launches a new remote project Launches the New...

Page 64: ...can be accessed from this dialog Engraving Opens the Engraving dialog window Click to select buttons and create either text or icon engraving instructions The engraving dialog develops a DXF file that...

Page 65: ...mation pertaining to version and copyright Toolbar New Keypad Launches a new keypad project New Remote Launches a new remote project Open Project Launches the Open Project dialog window Save Saves the...

Page 66: ...keypad device file FIG 20 KeypadBuilder Project Navigation Pane Engraving Configuration Module Graphic representation of your keypad device Button Number The Channel for this button is locked Channel...

Page 67: ...ed and optional Designer The designer name creating the KeypadBuilder file This field is user defined and optional Dealer Dealer name providing the keypad file This field is user defined and optional...

Page 68: ...evice will dictate what colors you can pick Click OK to keep changes and exit the Project Properties module otherwise click Cancel and lose the changes Button Configuration The Button Configuration mo...

Page 69: ...s number is dictated by the selected device s firmware and is intended to assist in navigating the keypad device file Name The button name is for use within KeypadBuilder only and is intended to assis...

Page 70: ...eds to create your device s custom keypad Keypad Device The Keypad Device area is a graphic representation of your keypad device Click on a button to select and assign properties Display Options Show...

Page 71: ...ls The Symbols drop down list is available when you select AMX Icon in the font selection list The list is a collection of icons created by AMX When you select an icon the corresponding letter is plac...

Page 72: ...sent from the master and displayed on the device i e time or temperature Selecting No Lines for line allocation will cause the device to have lines of displayed menu text and no dynamic information A...

Page 73: ...he display can be on of the styles listed Click on one to select Sleep Screen Display Options The Sleep Screen Display is an optional graphic you can set to display on the LCD when the device is not i...

Page 74: ...l assignments for the keypad menu You can set the sub menu properties to either Text Unicode or Complex Script Add Sub Menu Item Either double click on Add Sub Menu Item or select it and click Add Ite...

Page 75: ...graphic Beneath the button number is a list of active button number and their names Channel Channel assignment for selected menu or sub menu item Auto Assign Takes the next unassigned channel code Ch...

Page 76: ...G 26 Edit Keypad Menu Dialog Window Menu Type display items are either Text Unicode or Complex Script Button number button is selected either through the graphic or list Button channel assignment This...

Page 77: ...to make it active there is no need for a select button Return to Main After menu or sub menu item is selected the display returns to the device s main menu Channel Code The assigned channel of either...

Page 78: ...ive there is no need for a select button Return to Main After menu or sub menu item is selected the display returns to the device s main menu Channel Code The assigned channel of either the menu or su...

Page 79: ...line counts as one of the device s allocated display lines Select Active only active in main menu items Navigating and releasing on a menu item is the only necessary action to make it active there is...

Page 80: ...r language support KeypadBuilder creates a graphic image from predefined text and then load the graphic to your device This is useful for rendering conditional script languages displaying proprietary...

Page 81: ...list of available glyphs Click on a glyph to select Create new glyph Launches the Create Modify Glyphs dialog window to create new glyph entries Edit existing glyph Launches the Create Modify Glyphs...

Page 82: ...e glyph can be no larger than 96x24 Format font selection Launches the Windows font format dialog window Select the family format and size of the font Clear character entry field Clears all typed info...

Page 83: ...e name of the keypad project designer in this field Dealer Type the name of the Dealer providing the keypad project file Project Order If the keypad project has a project order number type it in this...

Page 84: ...the navigation item in the menu system Home returns the navigation back to the main menu system 5 Click Update to set the values for your selected button Clicking on another button before clicking Up...

Page 85: ...lect in a range from 0 5 to 1 5 4 Click Update 5 To preview the DXF file as it appears to the engraver click Preview 6 Click Export DXF File to create the DXF file 7 Within the Export DXF File dialog...

Page 86: ...n menu and dynamic items Click the radio button next to either Top or Bottom Line Options Based on your selection in the Dynamic Text section the Line Options section could be populated with all menu...

Page 87: ...ain as to what channels have been assigned where click Channel Map to see 4 Click Update after you make changes to each button 5 Click OK after you are done Add a Menu Item Text 1 In the Fixed Menu Ed...

Page 88: ...ht of Button displays the currently selected button number You can select buttons by either clicking on them in the Button list or selecting the button on the graphic keypad device If the buttons are...

Page 89: ...LCD To move an item 1 Select the menu item from the list 2 Click either Up or Down to move the item within the list To remove an item 1 Select the menu item from the list 2 Click Delete To undo the de...

Page 90: ...to use Your operating system must support this or you must use a keyboard language interface Change the characters in the glyph Place your cursor in the Text field and type what you wish to make a gl...

Page 91: ...file Save As dialog window The Save As dialog window is available either when it is the file s first instance of save or when you want to save under a separate version in order to keep the previous f...

Page 92: ...log Window Channel Information Channel Code The assigned channel code number Assigned To If used the item and description of the button using the channel code Channel numbers Currently selected channe...

Page 93: ...his is the file that sets the button functionality channel assignments and menu behaviors Font File If the font used in menu display is not already loaded on the device it is necessary to include this...

Page 94: ...ers are COM Port Data Bits Parity Baud Rate Stop Bits and Flow control If you selected TCP IP the parameters are IP Address DNS Name and IP Port The IP Port should always be set to 1319 default Do not...

Page 95: ...ation Information LCD Configuration Information Fixed Menu System Configuration Information and Channel Map Information In the Options section you can click Copy to Clipboard or Save to File The Copy...

Page 96: ...own list All new projects will start with this device type by default The available colors are dictated by the device selected Show Button Names When checked the button names are displayed in the Navi...

Page 97: ...mal Returns the view area to the default Click on the preview area and hold to drag the image You can also use your mouse wheel to zoom in and out of the preview area Click Done to close the Preview d...

Page 98: ...Program Reference 86 KeypadBuilder v2 1...

Page 99: ...of either your currently selected page or list table You can select a page or table in the Workspace Navigator Pages Tab You can select pages and list box tables to edit or in the event it is associat...

Page 100: ...og Window General Button The General buttons are the basic buttons in both the button select Mio Modero DMS and touch select Mio Modero DMS Pinnacle General buttons can serve as page flips list box na...

Page 101: ...ject file and the table is selected in the Page Navigation The title block indicates the name of the selected table and the Port and Address associated with the table The list is comprised of each ite...

Page 102: ...the Workspace Navigator to view open and rename keypad pages Note that the Project folder contains two folders Pages and List box Tables Click the symbol next to the folders or double click on the fol...

Page 103: ...inside the window s title bar File Menu The File menu serves as a location for file management New Project Mio Modero Keypad Launches a new keypad project Mio Modero R 1 Launches a new remote project...

Page 104: ...arameters Edit Table This feature is available if you have a table selected via the Workspace Navigator Pages Tab This menu item launches the Add Edit List box Items Dialog Window Delete Table This fe...

Page 105: ...ton shortcuts for the commonly used functions from left to right on the Toolbar New Keypad Launches a new keypad project New Remote Launches a new remote project New DMS Keypad Launches a new DMS or D...

Page 106: ...The Mio DMS KeypadBuilder Work Area 94 KeypadBuilder v2 1...

Page 107: ...ay already be a Mio Modero DMS shown in the Design View Window 3 If the project file is not a Mio Modero DMS go to Project Project Properties to launch the Project Properties Dialog Window Project Inf...

Page 108: ...a Page Flip A basic keypad page design concept is the Page Flip A page flip is a button attribute that allows the user to press a button to flip through different keypad pages A basic example would b...

Page 109: ...etting List Button Properties 1 Select the list box button in the Page Navigation Window 2 Go to Project Button Item Properties to launch the List box Button Properties Dialog Window 3 In the text fie...

Page 110: ...ng Tab 2 In the text field Name type a unique name for the list box navigation button For the purpose of this example call it Single Up 3 Use the Description field to further explain the function of t...

Page 111: ...avigation buttons have been set for the list box and properties have been established for the list box it is time to create A Static List box Table 1 Select the list box button in the Page Navigation...

Page 112: ...dow to view the Function Code Map The Function Code Map is a representation of the Channel codes Address codes Level codes String Outputs and Command Outputs utilized in the keypad file displayed in a...

Page 113: ...g time eating factors of creating a keypad is correctly setting up the channel address and level function codes for any given button and other properties that depend on button type Use Power Assign to...

Page 114: ...es However things like SYSTEM_CALLS are based upon all the channels coming from a single device And if the channels are split across ports the feedback part of the System Call won t work Another thing...

Page 115: ...Type and click Assign again If you didn t require both the push channel and address to match you re done If they need to match watch for an error in either of the assignment operations If this is the...

Page 116: ...nformation Tab Project Properties Dialog Window Setup Information Tab Page Configuration Launches the Page Configuration Dialog Window Power Assign Codes Launches the Power Assignments Dialog Window D...

Page 117: ...ted with this project Designer This editable field displays the current Designer associated with this project Dealer This editable field displays the current Dealer associated with this project Purcha...

Page 118: ...one line Move Down Move the selected list box item down one line OK Confirm changes and exit Cancel Close window without making changes Associate Data Table Dialog Window After a page has been assigne...

Page 119: ...e when it comes to editing the page configuration of keypad pages within a project file To launch the Page Configuration dialog window go to Project Page Configuration The dialog breaks down as follow...

Page 120: ...ater date Addressing The addressing for the selected button Set the Port and Code for both the Address and Channel Font The font is the currently selected font style and point size Clicking on the lau...

Page 121: ...bers if you select the Function Code Action Assign option Function Code Assignment Options Begin Assignment At Power Assign Sets the button group s starting device and channel numbers if you select th...

Page 122: ...de 0 See Working With Function Codes for the importance of these function codes Page Layout The Page Layout is the graphic representation of the keypad page A cross hair cursor allows you to select bu...

Page 123: ...d button Set the Port and Code for both the Address and Channel If a list box button is present on the selected keypad page the checkbox List box Navigation Button is active List box Navigation Button...

Page 124: ...ck the radio button next to the desired selection to select Copy to On State When checked all settings used for the Off sate are duplicated to the On state This feature only works one way and any chan...

Page 125: ...ble Items List edit the information via the Add Edit List box Item Dialog Window Delete Delete the list box items selected in the Table Items List Move Up Move the selected list box item up one line M...

Page 126: ...are registered trademarks of AMX AMX reserves the right to alter specifications without notice at any time It s Your World Take Control 3000 RESEARCH DRIVE RICHARDSON TX 75082 USA 800 222 0193 469 62...

Reviews: