AMX KEYPADBUILDER User Manual

Operation/Reference Guide
KeypadBuilder
v2.1
Keypad Device Design Software
Software
Document ID: 33-004-2942
Initial Release: / Last Revised: 06/7/2006
AMX Limited Warranty and Disclaimer
Electroluminescent and LCD Control Panels are warranted for three (3) years, except for the display and touch overlay components that are warranted for a period of one (1) year.
Disk drive mechanisms, pan/tilt heads, power supplies, and MX Series products are warranted for a period of one (1) year.
AMX Lighting products are guaranteed to switch on and off any load that is properly connected to our lighting products, as long as the AMX Lighting products are under warranty. AMX does guarantee the control of dimmable loads that are properly connected to our lighting products. The dimming performance or quality cannot be guaran­teed due to the random combinations of dimmers, lamps and ballasts or transformers.
Unless otherwise specified, OEM and custom products are warranted for a period of one (1) year.
AMX Software is warranted for a period of ninety (90) days.
Batteries and incandescent lamps are not covered under the warranty.
This warranty extends only to products purchased directly from AMX or an Authorized AMX Dealer.
All products returned to AMX require a Return Material Authorization (RMA) number. The RMA number is obtained from the AMX RMA Department. The RMA number must be clearly marked on the outside of each box. The RMA is valid for a 30-day period. After the 30-day period the RMA will be cancelled. Any shipments received not consistent with the RMA, or 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 products to perform. This includes any lost profits, lost savings, incidental damages, or consequential damages. AMX is not liable for any claim made by a third party or by an AMX Dealer for a third party.
This limitation of liability applies whether damages are sought, or a claim is made, under this warranty or as a tort claim (including negligence and strict product liability), a contract claim, or any other claim. This limitation of liability cannot be waived or amended by any person. This limitation of liability will be effective even if AMX or an authorized represen­tative of AMX has been advised of the possibility of any such damages. This limitation of liability, however, will not apply to claims for personal injury.
Some states do not allow a limitation of how long an implied warranty last. Some states do not allow the limitation or exclusion of incidental or consequential damages for consumer products. In such states, the limitation or exclusion of the Limited Warranty may not apply. This Limited Warranty gives the owner specific legal rights. The owner may also have other rights that vary from state to state. The owner is advised to consult applicable state laws for full determina­tion of rights.
EXCEPT AS EXPRESSLY SET FORTH IN THIS WARRANTY, AMX MAKES NO OTHER WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. AMX EXPRESSLY DISCLAIMS ALL WARRANTIES NOT STATED IN THIS LIMITED WARRANTY. ANY IMPLIED WARRANTIES THAT MAY BE IMPOSED BY LAW ARE LIMITED TO THE TERMS OF THIS LIMITED WARRANTY.
Software License and Warranty Agreement
LICENSE GRANT.
AMX grants to Licensee the non-exclusive right to use the AMX Software in the manner described in this License. The AMX Software is licensed, not sold. This license does not grant Licensee the right to create derivative works of the AMX Software. The AMX Software consists of generally available programming and development software, product documentation, sample applications, tools and utilities, and miscellaneous technical information. Please refer to the README.TXT file on the compact disc or download for further information regarding the components of the AMX Software. The AMX Software is subject to restrictions on distribution described in this License Agreement. LICENSEE MAY NOT SUBLICENSE, RENT, OR LEASE THE AMX SOFTWARE. Licensee may not reverse engineer, decompile, or disassemble the AMX Software.
INTELLECTUAL PROPERTY.
The AMX Software is owned by AMX and is protected by United States copyright laws, patent laws, international treaty provisions, and/or state of Texas trade secret laws. Licensee may make copies of the AMX Software solely for backup or archival purposes. Licensee may not copy the written materials accompanying the AMX Software.
TERMINATION.
AMX RESERVES THE RIGHT, IN ITS SOLE DISCRETION, TO TERMINATE THIS LICENSE FOR ANY REASON AND UPON WRITTEN NOTICE TO LICENSEE. In the event that AMX terminates this License, the Licensee shall return or destroy all originals and copies of the AMX Software to AMX and certify in writing that all originals and copies have been returned or destroyed.
PRE-RELEASE CODE.
Portions of the AMX Software may, from time to time, as identified in the AMX Software, include PRE-RELEASE CODE and such code may not be at the level of performance, compatibility and functionality of the final code. The PRE-RELEASE CODE may not operate correctly and may be substantially modified prior to final release or certain features may not be generally released. AMX is not obligated to make or support any PRE-RELEASE CODE. ALL PRE-RELEASE CODE IS PROVIDED "AS IS" WITH NO WARRANTIES.
LIMITED WARRANTY.
AMX warrants that the AMX Software will perform substantially in accordance with the accompanying written materials for a period of ninety (90) days from the date of receipt. AMX DISCLAIMS ALL OTHER WARRANTIES, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, WITH REGARD TO THE AMX SOFTWARE. THIS LIMITED WARRANTY GIVES LICENSEE SPECIFIC LEGAL RIGHTS. Any supplements or updates to the 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 warranty or condition, express, implied or statutory.
LICENSEE REMEDIES.
AMX's entire liability and Licensee's exclusive remedy shall be repair or replacement of the AMX Software that does not meet AMX's Limited Warranty and which is returned to AMX. This Limited Warranty is void if failure of the AMX Software has resulted from accident, abuse, or misapplication. Any replacement AMX Software will be warranted for the remainder of the original warranty period or thirty (30) days, whichever is longer. Outside the United States, these remedies may not available.
NO LIABILITY FOR CONSEQUENTIAL DAMAGES. IN NO EVENT SHALL AMX 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 SOFTWARE, EVEN IF AMX 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 LICENSEE.
U.S. GOVERNMENT RESTRICTED RIGHTS.
The AMX Software is provided with RESTRICTED RIGHTS. Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph ©(1)(ii) of The Rights in Technical Data and Computer Software clause at DFARS 252.227­7013 or subparagraphs ©(1) and (2) of the Commercial Computer Software Restricted Rights at 48 CFR 52.227-19, as applicable.
SOFTWARE AND OTHER MATERIALS FROM AMX.COM MAY BE SUBJECT TO EXPORT CONTROL.
The United States Export Control laws prohibit the export of certain technical data and software to certain territories. No software from this Site may be downloaded or exported (i) into (or to a national or resident of) Cuba, Iraq, Libya, North Korea, Iran, Syria, or any other country to which the United States has embargoed goods; or (ii) anyone on the United States Treasury Department's list of Specially Designated Nation­als or the U.S. Commerce Department's Table of Deny Orders. AMX does not authorize the downloading or exporting of any software or tech­nical data from this site to any jurisdiction prohibited by the United States Export Laws.
This Agreement replaces and supersedes all previous AMX Software License Agreements and is governed by the laws of the State of Tex as , and all disputes will be resolved in the courts in Collin County, Texas, USA. For any questions concerning this Agreement, or to contact AMX for any reason, please write: AMX, 3000 Research Drive, Richardson, TX 75082.
Table of Contents
Table of Contents
KeypadBuilder Overview ....................................................................................1
Welcome to KeypadBuilder ............................................................................................... 1
System Requirements ....................................................................................................... 1
The KeypadBuilder Work Area.......................................................................................... 2
KeypadBuilder Application Interface ........................................................................................ 2
File Menu ................................................................................................................................. 3
View Menu ............................................................................................................................... 3
Options Menu........................................................................................................................... 3
Help Menu............................................................................................................................... 4
Toolbar ..................................................................................................................................... 4
Tasks Pane .............................................................................................................................. 4
Installing MS Arial Unicode ............................................................................................... 5
In Microsoft Windows 2000 ...................................................................................................... 5
Basic Operations ................................................................................................7
Accessing A File via 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 Project File ......................................................................................................... 7
Sending A Configuration File to A Device ......................................................................... 8
Setting KeypadBuilder Application Preferences................................................................ 8
Toggling View Menu Items ................................................................................................ 8
Using Web Updates .......................................................................................................... 8
The Mio Modero KeypadBuilder Work Area ......................................................9
KeypadBuilder Application Interface ........................................................................................ 9
File Menu ................................................................................................................................. 9
View Menu ............................................................................................................................. 10
Navigation Menu .................................................................................................................... 10
Transfer Menu........................................................................................................................ 10
Options Menu......................................................................................................................... 11
Help Menu............................................................................................................................. 11
Toolbar ................................................................................................................................... 11
KeypadBuilder Project Navigation Pane ................................................................................ 12
KeypadBuilder v2.1
i
Table of Contents
Mio Modero Configuration Modules ................................................................13
Project Properties............................................................................................................ 13
Device Selection .................................................................................................................... 14
Button Configuration ....................................................................................................... 14
Keypad Device ....................................................................................................................... 14
Button Properties ................................................................................................................... 15
Configuration Options ............................................................................................................ 15
Display Channel Map ............................................................................................................. 15
Display Options ...................................................................................................................... 16
Engraving ........................................................................................................................ 16
Keypad Device ....................................................................................................................... 16
Text Engraving ....................................................................................................................... 17
Display Options ...................................................................................................................... 17
Export to DXF File.................................................................................................................. 17
LCD Configuration........................................................................................................... 18
LCD Display Resolution ......................................................................................................... 18
Dynamic Text ......................................................................................................................... 18
Align ....................................................................................................................................... 18
Select 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-Script Glyph? .......................................................................................... 26
Add/Edit Keypad Glyphs dialog window................................................................................. 27
Create/Modify Glyphs dialog window ..................................................................................... 28
Mio Modero Application Operations ................................................................29
Creating A New Project................................................................................................... 29
Setting The Project Configuration ................................................................................... 29
Setting The Button Configuration .................................................................................... 29
Creating The Engraving File ........................................................................................... 30
Setting The LCD Configuration ....................................................................................... 31
Display Options ...................................................................................................................... 31
Dynamic Text ......................................................................................................................... 31
Line Options ........................................................................................................................... 31
Sleep Screen Display Options ............................................................................................... 32
Setting The Fixed-Menu Configuration ........................................................................... 32
ii
KeypadBuilder v2.1
Table of Contents
Edit Menu Properties.............................................................................................................. 32
Add a Menu Item (Text) ......................................................................................................... 32
Add a Menu Item (Unicode) ................................................................................................... 33
Edit Sub-Menu Properties ...................................................................................................... 33
Add a Sub-Menu Item (Text) .................................................................................................. 34
Add a Sub-Menu Item (Unicode)............................................................................................ 34
Arranging Menu and Sub Menu items.................................................................................... 34
Creating Complex-Script Glyphs ..................................................................................... 35
Editing Glyphs ........................................................................................................................ 35
Deleting Glyphs...................................................................................................................... 35
The Mio R-1 KeypadBuilder Work Area ............................................................37
KeypadBuilder Application Interface ...................................................................................... 37
File 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 Selection .................................................................................................................... 42
Display Configuration ...................................................................................................... 42
Engraving ........................................................................................................................ 44
Remote Device:...................................................................................................................... 44
Text Engraving ....................................................................................................................... 45
Display Option........................................................................................................................ 45
Export to DXF File.................................................................................................................. 45
Mio R-1 Application Operations .......................................................................47
Creating A New Project ................................................................................................... 47
Setting The Project Configuration ................................................................................... 47
Setting The Display Configuration................................................................................... 47
Creating The Engraving File............................................................................................ 48
Creating Complex-Script Glyphs ..................................................................................... 49
Editing Glyphs ........................................................................................................................ 49
Deleting Glyphs...................................................................................................................... 49
Mio R-1 Add Edit Menu Item .................................................................................................. 50
KeypadBuilder v2.1
iii
Table of Contents
The Mio Attaché KeypadBuilder Work Area .....................................................51
KeypadBuilder Application Interface ...................................................................................... 51
File Menu ............................................................................................................................... 51
View Menu ............................................................................................................................. 52
Navigation Menu .................................................................................................................... 52
Transfer Menu........................................................................................................................ 52
Options Menu......................................................................................................................... 52
Help Menu............................................................................................................................. 53
Toolbar ................................................................................................................................... 53
KeypadBuilder Project Navigation Pane ................................................................................ 54
Mio Attaché Configuration Modules ................................................................55
Project Properties............................................................................................................ 55
Device Selection .................................................................................................................... 56
Button Configuration ....................................................................................................... 56
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 Configuration........................................................................................................... 60
LCD Display Resolution ......................................................................................................... 60
Dynamic Text ......................................................................................................................... 60
Align ....................................................................................................................................... 60
Select Display Line................................................................................................................. 61
Sleep Screen Display Options ............................................................................................... 61
Fixed-Menu Configuration............................................................................................... 61
Fixed Menu Edit ..................................................................................................................... 62
Edit Keypad Menu window..................................................................................................... 63
Add and Edit Menu Item window............................................................................................ 65
Complex-Script Glyphs ................................................................................................... 68
What is a Complex-Script Glyph? .......................................................................................... 68
Add/Edit Keypad Glyphs dialog window................................................................................. 69
Create/Modify Glyphs dialog window ..................................................................................... 70
iv
KeypadBuilder v2.1
Table of Contents
Mio Attaché Application Operations ................................................................71
Creating A New Project ................................................................................................... 71
Setting The Project Configuration ................................................................................... 71
Setting The Button Configuration .................................................................................... 72
Creating The Engraving File............................................................................................ 73
Setting The LCD Configuration ....................................................................................... 74
Display Options ...................................................................................................................... 74
Dynamic Text ......................................................................................................................... 74
Line Options ........................................................................................................................... 74
Sleep Screen Display Options ............................................................................................... 74
Setting The Fixed-Menu Configuration............................................................................ 75
Edit Menu Properties.............................................................................................................. 75
Add a Menu Item (Text) ......................................................................................................... 75
Add a Menu Item (Unicode) ................................................................................................... 75
Edit Sub-Menu Properties ...................................................................................................... 76
Add a Sub-Menu Item (Text) .................................................................................................. 76
Add a Sub-Menu Item (Unicode)............................................................................................ 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 .......................................................................... 79
Save As dialog window .......................................................................................................... 79
Channel Map dialog window .................................................................................................. 79
File Transfer Dialogs ....................................................................................................... 81
Send Configuration Files dialog window ................................................................................ 81
Communication Settings dialog window................................................................................. 82
Edit Settings dialog window ................................................................................................... 82
User Name and Password dialog window (for NetLinx Master)............................................. 82
Generate Project Report Dialog ...................................................................................... 83
Application Setup Dialog ................................................................................................. 84
Preferences dialog window .................................................................................................... 84
Engraving Dialogs ........................................................................................................... 85
Export DXF File dialog window .............................................................................................. 85
Engraving Template Preview dialog window.......................................................................... 85
LCD Configuration Dialogs.............................................................................................. 85
Import Splash Screen Icon File dialog window ...................................................................... 85
KeypadBuilder v2.1
v
Table of Contents
Remove dialog window .......................................................................................................... 85
The Mio DMS KeypadBuilder Work Area .........................................................87
Design View Window .................................................................................................... 87
Button Information Window ........................................................................................... 88
Page Navigation Window ................................................................................................ 88
Table Data Window ...................................................................................................... 89
Workspace Navigator Window........................................................................................ 90
Workspace Navigator - Pages Tab ........................................................................................ 90
Workspace Navigator - Function Maps Tab........................................................................... 90
Moving, Docking and Resizing Dockable Windows ........................................................ 91
Working With Dockable Windows .......................................................................................... 91
File Menu ........................................................................................................................ 91
View Menu ...................................................................................................................... 91
Project Menu ................................................................................................................... 92
Transfer Menu................................................................................................................. 92
Options Menu.................................................................................................................. 92
Help Menu....................................................................................................................... 93
Toolbar ............................................................................................................................ 93
Mio Modero 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 Start Up Page ......................................................................................................... 96
Setting an Inactive Page Flip ................................................................................................. 96
Working with Pages ........................................................................................................ 96
Creating a Page Flip .............................................................................................................. 96
Page Flip Actions ................................................................................................................... 97
Renaming Pages via the Workspace Navigator..................................................................... 97
Working with Buttons ...................................................................................................... 97
Setting List Button Properties................................................................................................. 97
Creating a List box Button...................................................................................................... 98
Creating a List box Navigation Button.................................................................................... 98
Editing Mio Modero DMS and DMS Pinnacle Button Properties............................................ 99
Working with List boxes .................................................................................................. 99
A Static List box Table ........................................................................................................... 99
A Dynamic List box Table ...................................................................................................... 99
Creating a List box Table ....................................................................................................... 99
Working with List boxes ......................................................................................................... 99
vi
KeypadBuilder v2.1
Table of Contents
Working With Function Codes....................................................................................... 100
Function Code Map.............................................................................................................. 100
Specify Port Allocation ......................................................................................................... 101
Specify Channel Allocation .................................................................................................. 101
Using Power Assign ............................................................................................................. 101
Begin Assignment At (Power Assign) .................................................................................. 102
Wrap Within Port ID (Power Assign) .................................................................................... 102
Ensure Contiguous Code Assignment (Power Assign)........................................................ 103
KeypadBuilder Mio Modero DMS & DMS Pinnacle Program Reference ...................... 104
Context Menus ..................................................................................................................... 104
Workspace Context Menu .................................................................................................... 104
Page Navigation Context Menu ........................................................................................... 104
Dialog Windows ................................................................................................................... 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 Dialog Window ................................................................................. 105
Edit List Table Dialog Window ............................................................................................. 106
Associate Data Table Dialog Window .................................................................................. 106
Project Properties Dialog Window - Setup Information Tab ................................................. 106
Confirm Delete List Table Dialog Window............................................................................ 107
Page Configuration Dialog Window ..................................................................................... 107
List box Button Properties Dialog Window ........................................................................... 108
Power Assignments Dialog Window .................................................................................... 109
Add New Page Dialog Window ............................................................................................ 110
Button Properties Dialog Window ........................................................................................ 111
Edit List-table Dialog Window .............................................................................................. 113
Send DMS Configuration Files Dialog Window .................................................................... 113
KeypadBuilder v2.1
vii
Table of Contents
viii
KeypadBuilder v2.1

KeypadBuilder Overview

Welcome to KeypadBuilder

KeypadBuilder gives functionality to AMX's latest keypad devices. Using KeypadBuilder you can:
Assign button arrangements - bridge buttons and assign blanks.
Define button functionality - assign button descriptions and channel codes.
Design button engraving - assign text or icons to the buttons.
Program the Fixed Menu System - created menus for navigation on LCD equipped units.
Define LCD characteristics - assign display options for LCD equipped units.
Conduct file Transfers - deliver KeypadBuilder files to devices and masters.
KeypadBuilder is intended for designing configuration files for the Mio Modero, Mio-R1 and Mio Attaché device 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 KeypadBuilder. You must have a valid copy of either MS Office 2000 or MS Office 2003 to acquire the font. See the Installing MS Arial Unicode section on page 5 for more information.
KeypadBuilder Overview
For both platforms, you must have Administrator rights to install and run all required System files.
Windows XP Professional (Service Pack 2 or greater)
OS supported in the following languages:
English
Spanish
French
German
Other PC requirements:
Pentium 233 MHZ processor (minimum requirement); 300 MHZ or faster recommended.
20 MB of free disk space (minimum requirement); 150 MB recommended.
128 MB of installed memory (RAM).
Minimum (VGA) screen resolution of 800x600
Windows-compatible CD-ROM drive.
Windows-compatible mouse (or other pointing device).
KeypadBuilder v2.1
1
KeypadBuilder Overview

The KeypadBuilder Work Area

Use KeypadBuilder to create files (*.KPB) that allow you to get the most out of AMX keypads and the devices they control.

KeypadBuilder Application Interface

The KeypadBuilder application breaks down as follows:
Menu Bar
KeypadBuilder Project
Navigation Pane
Toolbar
Tasks Pane
FIG. 1 KeypadBuilder Main Window
KeypadBuilder Application Interface
Menu Bar Contains the main menu options (File, View, Options and Help).
Tasks Pane Provides a quick link to opening other .KPB files including the Most
Toolbar A button-click option to the most regularly used file tools.
KeypadBuilder Project Navigation Pane When a project is open, a graphic representation of the keypad con-
2
Recently Updated.
figuration is displayed. The tools for designing keypad design are also available in this pane (Project Properties, Button Configuration, Engraving, LCD Configuration, Fixed-Menu Configuration).
KeypadBuilder v2.1
KeypadBuilder Overview

File Menu

The File menu serves as a location for file management.
File Menu
New Project • Mio Modero Keypad - Launches a new keypad project.
• Mio Modero-R1 - Launches a new remote project.
Launches the New Project dialog window. This will open a new keypad device project into the KeypadBuilder Project Navigation Pane.
Open Project Launches the Open Project dialog window. Opens a saved .KPB file into the
KeypadBuilder Project Navigation Pane
Close Project Closes the project currently open. An option to save will occur if the file has
not recently been saved.
Open Exported DXF File Launches the Viewing Exported 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 the project has not been previously saved it will
Save As Launches the Save As dialog window. This feature allows you to make new
The Most Recently Updated List A list of most recently opened KeypadBuilder files.
Exit Closes the KeypadBuilder application.
launch the Save As dialog window.
revision files.

View Menu

Contains options for configuring the KeypadBuilder work area.
View Menu
Toolbar Toggles the toolbar in and out of view.
Tasks Pane Toggles the tasks pane in and out of view.
Visual Styles Mouse-over to open the visual style sub-menu. The visual style is the look and
feel of the KeypadBuilder application. The styles emulate Windows themes:
• Default
•Office XP ®
• Office 2003 ®
• Windows XP ® Theme

Options Menu

The Options menu allows you to set application features and generate file reports.
Options Menu
Preferences... Launches the Preferences dialog. Preferences sets the default device features, project
view options and the number of files in the most recently updated files list.
KeypadBuilder v2.1
3
KeypadBuilder Overview

Help Menu

The Help menu contains features for updating the application and information on how to use KeypadBuilder.
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 containing information pertaining to version

Toolbar

The toolbar contains button shortcuts for the commonly used functions:
Toolbar
New Keypad Launches a new keypad project.
New Remote Launches a new remote project.
and copyright.
Open Project Launches the Open Project dialog window.
Tasks Pane Toggles the tasks pane in and out of view. Only available when a project is
User Preferences Launches the Preferences dialog window.
not currently open.

Tasks Pane

The Tasks Pane is s list of most recently updated KeypadBuilder files and a quick link to starting new KeypadBuilder projects. Additionally, you can open other KeypadBuilder files by clicking More Documents to launch the Open KeypadBuilder Project dialog window.
FIG. 2
KeypadBuilder Tasks Pane
You can start a 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.
4
KeypadBuilder v2.1
KeypadBuilder Overview

Installing MS Arial Unicode

Arial Unicode MS font is a full Unicode font. Unicode is a character encoding standard developed by the Unicode Consortium. By using more than one byte to represent each character, Unicode enables almost all of the written languages in the world to be represented by using a single character set. It contains all of the characters, ideographs, and symbols defined in the Unicode 2.1 standard.

In Microsoft Windows 2000

Quit all programs.
1.
2. In Control Panel, double-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, and then click Change.
If you installed your Office program individually, click the name of your program in the
Currently installed programs box, and then click Change.
4. In the Microsoft Office 2003 Setup dialog box, click Add or Remove Features, and then click
Next.
5. Select Choose advance customization of applications, and then click Next.
6. Next to Office Shared Features, click the plus sign (+).
7. Next to International Support, click the plus sign (+).
8. Click the icon next to Universal Font, and then select the installation option you want.
KeypadBuilder v2.1
5
KeypadBuilder Overview
6
KeypadBuilder v2.1

Basic Operations

Accessing A File via The Most Recently Updated List

KeypadBuilder has the option of tracking a set number of Most Recently Updated files. To open one of these files, go to the File Menu and select the .KPB file from the list. The file opens in the Navigation Pane.

Accessing KeypadBuilder Help

KeypadBuilder is context sensitive; hit the F1 key on your keyboard to view the help topic for the active area of KeypadBuilder. Otherwise, go to Help > Help to view the entire help file.

Closing A Project

To close a KeypadBuilder file currently open in the Navigation Pane, go to File > 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 have made unsaved changes to your file, you are prompted to save them at this time.
Basic Operations

Generating A Project Report

To view a detailed list of your KeypadBuilder project file, go to Options > Generate Report. This launches the Project Report dialog window.

Opening An Existing Project

To work with a previously saved KeypadBuilder file, go to File > Open and select the saved KeypadBuilder file.

Saving A Project File

To save a KeypadBuilder file currently open in the Navigation Pane, go to File > Save. If you have not previously saved the file, you are prompted with the Save As dialog where you must designate the file name and location.
KeypadBuilder v2.1
7
Basic Operations

Sending A Configuration File to A Device

To send the final configuration file to you master:
1. Go to Transfer > Send to Device.... This launches the Send Configuration Files dialog window.
2. Click Communication Settings... to confirm your settings are correct.
3. Enter the Device ID.
4. Under Send File Options, make sure Configuration File is checked. If you set the LCD Display
Resolutions in the LCD Configuration module to CJK fonts and this is your first file send, make sure Font File is checked in the Send File Options.
5. Click Send File. The Transfer Status is displayed below.
6. Upon successful transmission, click Done.
Sending an inappropriate configuration file, i.e., a double-style sent to a single-style, to a device will result in an overwrite of any file currently residing on the device, but the device will not work.

Setting KeypadBuilder Application Preferences

Go to Options > Preferences to launch the Preferences dialog window.
To set the Default device for new projects, select the device from the drop down menu.
Select the color for the default device in the Color Selection drop down menu.
To toggle items in and out of view of the Navigation Pane, place a check next to each value
you want displayed on the buttons.
Under General in the 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 or removed from view. To add or remove either the Toolbar or Tasks Pane, go to View > Toolbar/Tasks Pane. A check next to the item indicates the it is active.

Using Web Updates

The AMX WebUpdate program is a stand-alone application that communicates with the AMX website, allows a user to select from a list of available AMX Software programs to choose for updating, determines the latest version of the selected applications, returns a listing of available updates, allows a user to download the selected installation files, and upon request, launches the installation of those downloads.
The WebUpdate application is not installed by KeypadBuilder, and must be installed separately. If not found, KeypadBuilder prompts you to download the application from www.amx.com.
Select Help > Web Update to launch this application.
Refer to the WebUpdate on-line help for details and instructions.
8
KeypadBuilder v2.1

The Mio Modero KeypadBuilder Work Area

The Mio Modero KeypadBuilder Work Area
Use KeypadBuilder to create files (*.KPB) that allow you to get the most out of Mio Modero keypads and the devices they control.

KeypadBuilder Application Interface

The KeypadBuilder application breaks down as follows:
KeypadBuilder Application Interface
Menu Bar Contains the main menu options (File, Edit, View, Navigation, Trans-
Tasks Pane Provides a quick link to opening other .KPB files including the Most
Toolbar A button-click option to the most regularly used file tools.
KeypadBuilder Project Navigation Pane When a project is open, a graphic representation of the keypad con-

File Menu

fer, Options and Help).
Recently Updated.
figuration is displayed. The tools for designing keypad design are also available in this pane (Project Properties, Button Configuration, Engraving, LCD Configuration, Fixed-Menu Configuration).
The File menu serves as a location for file management.
File Menu
New Project • Mio Modero Keypad - Launches a new keypad project.
• Mio Modero-R1 - Launches a new remote project.
Launches the New Project dialog window. This will open a new keypad device project into the KeypadBuilder Project Navigation Pane.
Open Project Launches the Open Project dialog window. Opens a saved .KPB file into the
KeypadBuilder Project Navigation Pane
Close Project Closes the project currently open. An option to save will occur if the file has
not recently been saved.
Open Exported DXF File Launches the Viewing Exported 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 the project has not been previously saved it will
Save As Launches the Save As dialog window. This feature allows you to make new
The Most Recently Updated List A list of most recently opened KeypadBuilder files.
Exit Closes the KeypadBuilder application.
launch the Save As dialog window.
revision files.
KeypadBuilder v2.1
9
The Mio Modero KeypadBuilder Work Area

View Menu

Contains options for configuring the KeypadBuilder work area.
View Menu
Toolbar Toggles the toolbar in and out of view.
Tasks Pane Toggles the tasks pane in and out of view.
Visual Styles Mouse-over to open the visual style sub-menu. The visual style is the look and

Navigation Menu

Only available when a .KPB file is open, this menu is the crux of adding functionality to the keypad device. While viewing a graphic representation of your selected keypad device, you can do the following:
Navigation Menu
Project Configuration... Opens the Project Configuration dialog window. This is topical Project Informa-
Button Configuration... Opens the Button Configuration dialog window. Click to select buttons, and
Engraving... Opens the Engraving dialog window. Click to select buttons and create either
LCD Configuration... For keypad devices equipped with an LCD, the LCD Configuration dialog win-
Fixed Menu System... For keypad devices equipped with an LCD, the Fixed Menu Configuration dia-
Complex-Script Glyphs Launches the Add/Edit Keypad Glyphs dialog window. Create glyph renderings
feel of the KeypadBuilder application. The styles emulate Windows themes:
• Default
•Office XP ®
• Office 2003 ®
• Windows XP ® Theme
tion, Device Selection and Device Setup Information.
then assign button properties, Configuration Options and Display Options. The Channel Map can be accessed from this dialog.
text or icon engraving instructions. The engraving dialog develops a .DXF file that must be provided to AMX to create your custom engraved buttons. Keypad display options and export options are also available in this dialog.
dow sets up Display Options, the presence of Dynamic Text, and Line Options.
log window allows for the creation of Menu and one tier of sub-menus. The Main Menu can contain a maximum of 10 items. You can edit and add menu and sub-menu items.
of text and characters for menu/sub-menu items.
10

Transfer Menu

The Transfer Menu enables KeypadBuilder to send and receive configuration files.
Transfer Menu
Send to Device... Opens the Send Configuration Files dialog window. This function allows you to
send both the configuration file and the font file to the keypad device.
KeypadBuilder v2.1
The Mio Modero KeypadBuilder Work Area

Options Menu

The Options Menu allows you to set application features and generate file reports.
Options Menu
Generate Report... Launches the Generate Project Report dialog. The Project Report is a detailed list of
every configuration model except Engraving.
Preferences... Launches the Preferences dialog. Preferences sets the default device features, project
view options and the number of files in the most recently updated files list.

Help Menu

The Help menu contains features for updating the application and information on how to use KeypadBuilder.
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 containing information pertaining to version
and copyright.

Toolbar

The toolbar contains button shortcuts for the commonly used functions:
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 current project. If the project has not been previously saved it
will launch the Save As dialog window.
Tasks Pane Toggles the tasks pane in and out of view. Only available when a project is
not currently open.
File Transfer Launches the File Transfer dialog window. Only available when a project is
open.
KeypadBuilder v2.1
Generate Report Launches the Generate Project Report dialog window. Only available
when a project is open.
User Preferences Launches the Preferences dialog window.
11
The Mio Modero KeypadBuilder Work Area

KeypadBuilder Project Navigation Pane

The KeypadBuilder Project Navigation Pane is open when a project file is active. This is the main area for accessing the configuration modules in creating a keypad device file.
Project Properties
Configuration
Module
Button Configuration Module
Graphic representation of your keypad device
Engraving Configuration Module
LCD Configuration Module
Fixed-Menu Configuration Module
Complex-Script Glyphs Module
FIG. 3 KeypadBuilder Project Navigation Pane
Button Number
The Channel for this button is locked
Channel assigned to this button
Engraving information
Menu Action
Button Name
12
KeypadBuilder v2.1

Mio Modero Configuration Modules

Mio Modero Configuration Modules

Project Properties

The Project Properties module is Project Information, information to make the file unique and Device Selection, the type of keypad device to be programmed.
Project Information
Project Name The name of the keypad device project. This field is user defined 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.
Purchase Order This name will populate the file name of the .DXF in the engraving section.
Sales Order This name will populate the file name of the .DXF in the engraving section.
Comments Any additional comments or clarifications for the file. This field is user defined and optional.
KeypadBuilder v2.1
Project Properties Dialog Window
FIG. 4
Device Selection
Project Information
13
Mio Modero Configuration Modules

Device Selection

The Device Selection section contains a drop down list of all keypad devices capable of being programmed by KeypadBuilder. Select the keypad device you wish to design for, and the device appears in the window below. Assign the keypad device’s color at this time in the drop down list for Color Selection; the type of device will dictate what colors you can pick.
Changing the device selection clears any previous unsaved work.
Click OK to keep changes and exit the Project Properties module; otherwise, click Cancel and lose the changes.

Button Configuration

The Button Configuration module allows you to set the keypad button properties.
Graphic interface for keyp ad device
Button Properties
Configuration Options
Display Options
FIG. 5 Button Configuration Dialog Window

Keypad Device

The Keypad Device area is a graphic representation of your keypad device. Click on a button to select and assign properties.
14
KeypadBuilder v2.1
Mio Modero Configuration Modules

Button Properties

The button properties are as follows:
Button Properties
Number This 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 in
developing unique names.
Channel Code The channel code represents communication out of the panel to the master control-
ler. By default the channel code is the same as the button number. Clicking Auto Assign takes the next unassigned channel code.
Lock Channel Code for Menus and Sub Menus
Menu Action This option only applies to devices equipped with a displays. Assign a button to exe-
Update Confirms all changes and channel assignments for the selected button.
Placing a check in the box locks the selected channel code and prevents it from being assigned in any other menu or sub menu.
cute one of the following:
• Up - Navigate up the menu items.
• Down - Navigate down the menu items.
• Select - Activates the menu selection. The selection can lead to a sub menu or a channel code activation.
• Home - This button assignment will return the display menu to the top level.
• None - The button has no interaction with the menu system.

Configuration Options

Blank Buttons - Blank buttons contain no channel code assignment. It is important to assign
blank buttons before the engraving process as they are included in the order.
Combine Buttons - Click Combine Buttons to activate and deactivate. When in combine
button mode, click on a button you wish to combine. Always select the left of the two button you wish to combine. Combine Buttons takes the button information from the selected button and assigns it to the button directly to the right of it, thus treating two buttons as one. To uncombine a button, select the button again. The button on the right retains no information. Combining buttons adds double buttons to your custom engraving order.

Display Channel Map

Click Display Channel Map to view a listing of channel codes that have already been assigned within your active KeypadBuilder file.
Click on any channel code number to see its current allocation.
Channel Information
Channel Code The assigned channel code number.
Assigned To If used, the item and description of the button using the channel code.
KeypadBuilder v2.1
15
Mio Modero Configuration Modules

Display Options

These display options are for use within the Button Configuration window. Placing a check in any box activates its display.
Display Options
Show Button Numbers Displays all button numbers.
Show Button Names Displays the button name if set.
Show Channel Codes Displays set channel codes for the keypad device.
Show Menu Actions Displays the menu action value for the button.
Click OK to keep changes and exit the Button Configuration module; otherwise, click Cancel and lose the changes.

Engraving

The Engraving module allows you to create the .DXF file that AMX needs to create your device’s custom keypad.
Graphic interface for keyp ad device
Button configuration information
Tex t engraving information
Display Options
DXF export options
Engraving Dialog
FIG. 6

Keypad Device

The Keypad Device area is a graphic representation of your keypad device. Click on a button to select and assign properties.
16
KeypadBuilder v2.1
Mio Modero Configuration Modules

Text Engraving

The engraving information and options are as follow:
Text Engraving
Number This number is dictated by the selected device’s firmware and is intended to assist in navigat-
ing the keypad device file.
Name The button name is for use within KeypadBuilder only and is intended to assist in developing
unique names. The name is established in the Button Configuration module.
Menu Action If a menu action is assigned in the Button Configuration module, the action is displayed in this
field; otherwise, it is blank.
Text This is either the text or icon set to display on the button. The text is dictated by the font
selection. If you select Icon in the font selection, you could use letters to get the associated icon but the Symbols drop down list is a simpler approach. There is a limit of 10 characters per button.
Symbols 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 placed in the Te xt field. If you select more than one icon it will not replace the previous icon, but rather add it and display all selected icons.
Font Selection A drop down list of fonts supported by KeypadBuilder for use in engraving the buttons. Icons
Scale A ratio ranging from 0.5 to 1.5. The larger the ratio, the more area of the button the text or icon
Note: If your font selection or scale is greater than the area of the button that can be engraved, you will receive a warning in this field and KeypadBuilder will not create the .DXF file.
Update Confirms changes to the button engraving.
must be selected to use the Symbols drop down list.
fills.

Display Options

These display options are for use within the Engraving window. Placing a check in any box activates its display.
Display Options
Show Button Numbers Displays all button numbers.
Show Button Names Displays the button name if set.
Show Menu Actions Displays the menu action value for the button.
Show Channel Codes Displays set channel codes for the keypad device.
Show Bounding Box Displays the surface area of the button you can engrave.

Export to DXF File

KeypadBuilder creates the .DXF file that is applied to a jig in the engraving machine.
Export to DXF File
Export File... Opens the Export DXF File dialog window. This creates the .DXF file neces-
sary for engraving.
Preview... Opens the Engraving Template Preview dialog window. This is a graphic repre-
sentation of the jig used in engraving.
Click OK to keep changes and exit the Engraving module; otherwise, click Cancel and lose the changes.
KeypadBuilder v2.1
17
Mio Modero Configuration Modules

LCD Configuration

The LCD Configuration module controls what menu items are shown and how they are displayed in devices equipped with an LCD.
Display line selection
Line display justification
Dynamic line visibility and level assignment
Dynamic line level style
Sleep Screen
Dynamic line alignment
Dynamic text line allocation
LCD Display; number of lines and font type
Display Options
FIG. 7 LCD Configuration Dialog Window

LCD Display Resolution

The Display Resolution is the maximum number of lines and type of font family that can be displayed at one time on your selected device. Click on a font family to select. Only one font family can be used on a device. If you change the font, you need to include the font information when sending the configuration file. See the Send Configuration Files dialog window section on page 81.

Dynamic Text

Dynamic Text is information 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. All lines can be allocated for either menu or dynamic. Regardless of the display arrangement, the items must be contiguous; the menu items and dynamic items must be grouped together.

Align

The align feature allows you to decide which, menu or dynamic, items are displayed first. Top places the dynamic items at the top of the list and Bottom puts them at the bottom.
18
KeypadBuilder v2.1
Loading...
+ 96 hidden pages