User manual AMX IREDIT V1.2

instruction manual IREdit v1.2 So ftw are 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. 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. YOU MAY NOT LICENSE, RENT, OR LEASE THE AMX SOFTWARE. You 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, then Licensee shall return all copies of the AMX Software to AMX and certify in writing that all copies have been 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 YOU SPECIFIC LEGAL RIGHTS. Any supplements or updates to the AMX SOFTWARE, including without limitation, any (if any) service packs or hot fixes provided to you 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 your 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 YOU. 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 (c)(1)(ii) of The Rights in Technical Data and Computer Software clause at DFARS 252.227-7013 or subparagraphs (c)(1) and (2) of the Commercial Computer Software Restricted Rights at 48 CFR 52.227-19, as applicable. This Agreement replaces and supercedes all previous AMX Software License Agreements and is governed by the laws of the State of Texas, and all disputes will be resolved in the courts in Collin County, Texas, USA. Should you have any questions concerning this Agreement, or if you desire to contact AMX for any reason, please write: AMX Corporation, 3000 Research Drive, Richardson, TX 75082. Table of Contents Table of Contents IREdit Program Overview ........................................................................................1 Supported Platforms.......................................................................................................... 1 The IREdit Work Area ....................................................................................................... 2 Menus................................................................................................................................ 3 File Menu ................................................................................................................................. 3 Edit Menu ................................................................................................................................. 4 View Menu ............................................................................................................................... 5 Tools Menu .............................................................................................................................. 6 Window Menu .......................................................................................................................... 6 Help Menu................................................................................................................................ 7 Standard Toolbar............................................................................................................... 8 IREdit Windows ................................................................................................................. 8 Working With Dockable Windows ............................................................................................ 8 IR Document Window .............................................................................................................. 9 Properties Window ................................................................................................................... 9 Navigator Window .................................................................................................................. 10 Search Window ...................................................................................................................... 11 Search Results Window ......................................................................................................... 11 Quick List Window.................................................................................................................. 12 Basic Operations ....................................................................................................13 Navigating using the Windows dialog.............................................................................. 13 Creating A New IR Database .......................................................................................... 13 Creating A New Hand Control File .................................................................................. 14 Using the New Hand Control Wizard............................................................................... 14 Advanced Wizard Dialog ................................................................................................. 15 Identify Dialog.................................................................................................................. 16 Using Identify Function........................................................................................................... 17 Searching for IR Hand Control Files................................................................................ 17 Using Identify Function.................................................................................................... 18 Cut, Copy And Paste Databases..................................................................................... 18 Paste Special .................................................................................................................. 19 Viewing An IR Waveform ................................................................................................ 19 Printing Files.................................................................................................................... 20 Editing IR Files ................................................................................................................ 20 Editing IR Properties .............................................................................................................. 20 Enabling Master Security Settings .................................................................................. 20 IREdit i Table of Contents Category Manager Dialog ............................................................................................... 21 Deleting A Category Via Category Manager .......................................................................... 22 Adding An IR Property ........................................................................................................... 22 Deleting An IR Property ......................................................................................................... 23 Sending An IR File .......................................................................................................... 23 Configuring Device Connection Communications Settings.................................................... 24 Device:Port:System (D:P:S)................................................................................................... 25 Transport Connection Option Settings ................................................................................... 26 Get Available Memory............................................................................................................ 27 Verifying ................................................................................................................................. 28 Virtual NetLinx Master Transfers..................................................................................... 28 Configuring the Touch Panel for Virtual NetLinx Master Transfers........................................ 28 Configuring IREdit for Virtual NetLinx Master Transfers ........................................................ 29 Powering Up and Connecting the Panel ................................................................................ 29 Transferring Files Using a Virtual NetLinx Master Connection .............................................. 29 Capturing An IR File........................................................................................................ 30 IRIS Infrared/Serial Data Capture Unit................................................................................... 30 Capture Communication Settings .......................................................................................... 30 Discrete IR Hex Codes.................................................................................................... 31 Discrete IR Hex Code Wizard Dialog ..................................................................................... 31 Importing Discrete IR Hex Codes........................................................................................... 31 Receiving An IR File........................................................................................................ 33 Importing IR Files ............................................................................................................ 34 Exporting IR Files............................................................................................................ 34 Actuate IR Dialog ............................................................................................................ 35 Actuating An IR Function ....................................................................................................... 35 Restore Default Window Settings ................................................................................... 36 IR Update Wizard Dialog................................................................................................. 36 AMX IR Database Update...................................................................................................... 37 Web Update .................................................................................................................... 37 Advanced Operations ............................................................................................ 39 Templates ....................................................................................................................... 39 Custom Toolbars And Commands .................................................................................. 39 Customizing The Toolbars ..................................................................................................... 39 Creating A New Custom Toolbar ........................................................................................... 39 Modifying Properties for Existing Toolbar Buttons ................................................................. 40 Assigning Shortcuts to Commands ........................................................................................ 41 Setting Preferences......................................................................................................... 41 Undo/Redo Support ............................................................................................................... 41 ii IREdit Table of Contents Preserving Spaces for Copied Functions............................................................................... 42 Save Window Settings ........................................................................................................... 42 Enabling Restore Workspace on Startup ............................................................................... 42 Auto Template Capture .......................................................................................................... 42 Skip Finish Page .................................................................................................................... 42 Setting Program Preferences ................................................................................43 Customizing The Toolbars .............................................................................................. 43 Toolbars Tab .......................................................................................................................... 43 Commands Tab...................................................................................................................... 44 Options Tab............................................................................................................................ 45 Customize Keyboard Dialog............................................................................................ 46 IREdit iii Table of Contents iv IREdit IREdit Program Overview IREdit Program Overview The IREdit application provides the ability to edit IR hand control files (.IRL, .IRV, or IR information contained within a .IRN database file) for use on Axcess and NetLinx platforms. You may rename and/or rearrange functions within a hand control, or combine functions from various hand control files into a single file. IREdit implements a new database file type, .IRN, that can also be used in NetLinx Studio. An .IRN database file is created when you create a new user database within IREdit. IREdit also provides the (read-only) AMX database containing IR files for many popular devices. Supported Platforms IREdit operates on: Windows XP® Professional (service pack 1 or greater, running on a Pentium 233 MHZ processor (minimum requirement); 300 MHZ or faster recommended, at least 96 MB of installed memory). Windows XP® Home (service pack 1 or greater, running on a Pentium 233 MHZ processor (minimum requirement); 300 MHZ or faster recommended, at least 96 MB of installed memory). Once the .NET framework has been installed, you may follow the steps below to change your OS settings so that no login is required when the machine is booted up. 1. While logged on with an account that has administrator rights, click Start | Run and type "CONTROL USERPASSWORDS2" 2. Once the dialog comes up, remove the check next to "Users must enter a username and password" and click Apply. Windows 2000® (service pack 3 or greater) Professional (running on a Pentium 233 MHZ processor (minimum requirement); 300 MHZ or faster recommended, with at least 96 MB of installed memory). Windows NT 4.0® Workstation (service pack 6A or greater, with at least 64 MB of installed memory). If you are installing NetLinx Studio on a Windows NT or Window 2000 machine, you must have Administrator rights to install and run all required System files. Windows 98® SE (with at least 48 MB of installed memory). Other PC requirements: Windows-compatible CD-ROM drive. Windows-compatible mouse (or other pointing device). At least 250 MB of free disk space. IREdit 1 IREdit Program Overview The IREdit Work Area The IREdit work area (FIG. 1) comprises several main components: Menu Bar Tool Bar IR Document Window Properties Window Navigator Window Quick List Window Search Window Search Results Window FIG. 1 IREdit Work Area The IREdit work area consists of individual windows which are able to be docked, moved and resized as desired. Below are the common windows found during a session. IREdit Work Area Components Item IR Document Window Description This is the main window for editing IR codes. The IR Document Window contains a table indicating up to 255 IR channels and their corresponding function names. There is one IR document window per IR hand control record. This window allows navigation through the list of IR hand controls contained within the open database. The navigator window is set up as a tree with the IR hand controls being the leaf nodes. · User codes are contained under a user designated and named node. · You can have up to 50 user databases open at one time. Quick List Window Properties Window The Quick List Window displays the available functions for the currently selected IR navigator node. Only slots containing data are displayed. This list is read only. The Properties Window gives access to all the header information for a given IR record. Use this window to edit all the attributes that pertain to the overall record including hand control name, device and notes. The Notes field is edited via a popup dialog containing an edit box for typing. This feature allows you to search a database by Manufacturer, Category, Model, Hand Control, Version, Function Name, or Function Number for a specific IR file. Displays the results of the last search operation. Click on any of the main menu items to open the associated drop-down menu. The menu bar consists of File, Edit, View, Tools, Window and Help. Click any of the icons for a shortcut to commonly used functions. See the Standard Toolbar section on page 8 for details. Navigator Window Search Window Search Results Window Menu Bar Tool Bar 2 IREdit IREdit Program Overview Menus File Menu FIG. 2 File Menu The File menu contains options relating to file management and printing. The options in this menu include: File Menu New Open Provides the option of creating a New Database or new Hand Control. Initiates the Open dialog, where you can locate and open the desired database (.IRN) Note: You can initiate an IREdit session by simply double-clicking on an .IRN, .IRV or .IRL in Explorer. Save Copy As Close Import IR File(s) Export IR File(s) Page Setup Print Preview Print Saves a copy of the currently selected database as a new .IRN file, under a user specified name and in a user specified location. Closes user created databases. Adds any preexisting .IRL or .IRVs to your created database. Initiates the Export dialog, which allows a user to export hand control records as .IRL files, to a user specified location on disk. Opens the Page Setup dialog, which allows for changes to details associated with printing. This option displays a preview of the file in a separate window, as it will appear when printed. Use the Print dialog to set preferences for your printer. Most recently used list A listing of (up to five) most recently opened .IRN, .IRL and .IRV files. Exit Exits the IREdit application. IREdit 3 IREdit Program Overview Edit Menu FIG. 3 Edit Menu The Edit menu contains options relating to editing files and categories. Edit Menu Undo/Redo Cut Copy Paste Paste Special Delete Categories Preferences Undo and Redo the last action. Cut the selected text or slot to the clipboard. Copy the selected text or slot to the clipboard. Paste the selected text or slot from the clipboard to the specified location. Paste an IR into another directory and have the option to add missing directory information. Deletes the selected IR directory or sub directory. Launches the Category Manager. Opens the Preferences Dialog. 4 IREdit IREdit Program Overview View Menu Check marks indicate the window is open. Removing the check will close the corresponding window. FIG. 4 View Menu View Menu Waveform Navigator Quick List Properties Search Search Results Status Bar Restore Default Window Settings Opens the Waveform view box displaying a graphical representation of the waveform associated with the selected IR function. This window contains a tree for every open database. This is a read only list of available functions for the currently selected hand control record. This is all of the pertinent header information for a given hand control record. This feature allows the user to search a database. The matching results for the search operations are displayed here. Located at the base of the work area, you will see the time in the right corner when the Status Bar is selected. Additionally, it contains information such as overwrite and insert. Restores dockable windows to default arrangement. IREdit 5 IREdit Program Overview Tools Menu The Tools menu contains options relating to file transfer operations, IR capture and communications settings. FIG. 5 Tools Menu Tools Menu Send Receive Verify Identify Capture Discrete IR Hex Codes Actuate Comm Settings Sends an IR to a designated Master location. Transfers an IR from a designated Master into IREdit. Checks the file integrity after a transfer. Allows you to identify functions in a list of hand controls via the Identify Dialog. Opens the IR capture wizard. Opens the Discrete IR Hex Codes Wizard allowing you to import hex codes. You can select a downloaded IR slot and then actuate it at the master to confirm a successful download. Opens the Communications Settings dialog to set both the Device Connection method and means of Capture. Window Menu The Window menu is populated by all .IRL files you have open. The open files are found in the IR Document window. Check marks indicate the window is open. Removing the check will close the corresponding window. Window Menu Items Item IR Document Description The IR Document window contains a list of 255 channels with the names of the functions that occupy any of those functions. There is one IR document window per IR hand control record. This is the main window for editing hand controls. If a template has been applied to the IR document the corresponding value appears in the Template column. 6 IREdit IREdit Program Overview Help Menu FIG. 6 Help Menu Help Menu Item Contents Index Search AMX IR Update Description Launches the IREdit help, Contents section. Launches the IREdit help, Index section. Launches the IREdit help, Search section. Launches the IR Update Wizard Dialog. Web Update Launches the AMX Web Update utility. About Displays the about IREdit dialog containing information pertaining to version and copyright. IREdit 7 IREdit Program Overview Standard Toolbar Click any of the icons for a quick step to commonly used functions Standard Toolbar Items Item Description New File - Creates a new file. Open - Opens an existing file. Cut - Cuts one or more functions from one location. Copy - Copies one or more functions from one location. Paste - Pastes a cut or copied function to another location in the same or different file. Delete - Deletes one or more function in the IR document window. Undo / Redo - Simple undo and redo support for cut, paste and deletion of IR codes. Send... - Sends an IR to a designated Master location. Receive... - Transfers an IR from a designated Master into IREdit. Capture - Opens the IR capture wizard. Verify - Checks the file integrity after a transfer. Actuate - You can select a downloaded IR slot and then actuate it at the master to confirm a successful download. Identify - Opens the Identify function wizard. Discrete IR Hex Codes - Opens the Discrete IR Hex Codes wizard. Additionally, the standard toolbar can be customized by right-clicking on the toolbar area, opening the customize context menu and selecting Customize. This opens the Customize dialog. See page 43 for more details. IREdit Windows Working With Dockable Windows All windows are both collapsible and able to be docked, moved and resized: Click on the thumb tack button located in the top right of each window to collapse the window down to a tab located on the side of the screen. To return the window back from the tab form click on the icon with the tack turned upon its side . Clicking on the tab, in collapsed form, will activate the window until another part of the application receives focus. Selecting the in the top right will close the respective window. 8 IREdit IREdit Program Overview IR Document Window The IR Document window contains a list of 255 channels with the names of the functions that occupy any of those functions. There is one IR document window per IR hand control file. This is the main window for editing IR files. If a template has been applied to the IR file, the corresponding value appears in the Template column. Tabs with the hand control file's names are present at the top of the IR Document window, allowing you to easily switch between hand control files when more than one are open. Right-click on a slot within the IR Document window to open the IR Document Context Menu: IR Document Context Menu Cut Copy Paste Delete · Cuts the selected slot to the clipboard. · Copies the selected slot to the clipboard. · Pastes the selected slot from the clipboard to the new slot location. · Deletes the selected slot. Properties · Shows the properties for the selected hand control file in the Properties window. Properties Window Use the Properties window to view all of the pertinent header information for a given hand control file. Some fields accept text, while others have pull-down menus or activate an edit dialog (as with the Note field). The Properties window updates based upon selections made in the Navigator and IR Documents window. The Properties window can be formatted with a Categorized Within the Properties window, all bold fields can be edited. or Alphabetic sort. FIG. 7 Properties Window IREdit 9 IREdit Program Overview Right-click within a field in the Properties window to open the Properties Window Context Menu: Properties Window Context Menu Undo Cut Copy Paste Delete Select All · Simple undo support for cut, paste and deletion of text fields. · Cuts the selected text to the clipboard. · Copies the selected text to the clipboard. · Pastes the selected text from the clipboard to the new text field location. · Deletes the selected text. · Selects all text within the field. Navigator Window This window allows navigation through the list of IR hand controls contained within the open database. The navigator window is set up as a tree with the IR hand controls being the leaf nodes. User codes are contained under a user designated and named node. You can have up to 50 user databases open at one time. Each manufacturer folder contains a list of categories, and each category folder contains a list of models. Within each model folder is a listing of hand controls, and each hand control folder contains at least one hand control record. Some hand control folders contain multiple hand control records. Double-clicking on a hand control file will open the file in an IR Document window. Database Manufacturer Category Model Hand Control Version FIG. 8 Navigator Window Right-click within a field in the Properties window to open the Properties Window Context Menu: Navigator Context Menu Expand · Expands the database one level down. Expand All · Expands the database down completely. Note: The AMX database can only Expand All from the model level down; user databases can only Expand All from the category level down. Close Cut Copy Paste Paste Special Delete · Closes the selected database. · Cuts a database to the clipboard. Note: The AMX database is read-only; therefore, cannot be cut. · Copies a database to the clipboard. · Pastes a database from the clipboard to a user database. · Pastes any level of an IR directory into another and has the opportunity to insert the missing information. · Deletes a selected user database. 10 IREdit IREdit Program Overview Search Window Select View > Search to show the Search Window. The Search window allows you to search for an IR hand control file within a specified database by Manufacturer, Category, Model, Hand Control, Version, Function Name, and/or Function Number. FIG. 9 Search Window Search Results Window The matches from the search operations are displayed in the Search Results Window. You can access the desired IR file by double-clicking it from this list. FIG. 10 Search Results Window Search Results Columns Manufacturer The name of the function's matching manufacturers. Category Model The categories for the matching functions. The model names for the matching functions. Hand Control The name of the matching hand control. Version Identify The version number for the matching hand control. Enables the Identify dialog found in Tools > Identify. IREdit 11 IREdit Program Overview Quick List Window The Quick List Window provides a read-only list of available functions for the currently selected hand control file. This list is displayed automatically (as long as the Quick List window is activated via the View menu), and does not require that the hand control file be open in a IR Document window. Only channels that contain functions are displayed. FIG. 11 Quick List Window 12 IREdit Basic Operations Basic Operations Navigating using the Windows dialog Once 10 or more IR hand controls are open the Windows function will be enabled. To activate a window: 1. Go to Window > Windows... to open the Windows dialog. 2. Select the hand control under Name. 3. Click the Activate button. To close a window: 1. Go to Window > Windows... to open the Windows dialog. 2. Select the hand control(s) under Name. 3. Click the Close Window(s) button. 4. Click the Close button. Creating A New IR Database The AMX database (.IRNs) is read only. If you want to construct or edit any IR hand controls you must first create a new database file. 1. Select File > New > New Database to launch the New File dialog. 2. Specify a name and target directory for the new database file. Select Save. 3. The new database will now appear in the Navigator window. 4. Populate the new database by copying and pasting IRLs from the AMX database, importing your own hand control files, or creating new hand control files. IREdit 13 Basic Operations Creating A New Hand Control File IREdit utilizes wizards to step assist in creating new IR files. Select File > New > Hand Control to access the There are two approaches to creating a new IR file via the IREdit wizards: You must have a user-created Database file open in the Navigator to enable the File > New > Hand Control option. Read the information on the initial Wizard dialog, and click Next to proceed with the New Hand Control Wizard. Select the Please take me to the advanced screen option, and click Next to open the Advanced Wizard dialog, which allows you to manually enter information for the file in a single dialog. Using the New Hand Control Wizard The New Hand Control Wizard steps you through the process of creating a new hand control file. To use the wizard: 1. Select File > New Hand Control to open the first wizard dialog ("Welcome to the new hand control wizard"). Check the Please take me to the advanced screen option to use the advanced wizard options (intended for advanced users). This option allows you to enter all of the information at once. 2. Click Next to proceed to the next wizard dialog ("Manufacturer"). Select the manufacturer of the hand control from the scrolling list. 3. Click Next to proceed to the "Category" dialog. Select a device category that matches the device to control with the selected hand control. Alternatively, you can type a new category in the text field above the list, if none of the listed categories adequately describe the target device type. 4. Click Next to proceed to the "Model" dialog. Enter the model number of the device that the selected hand control will control in the text field. 5. Click Next to proceed to the "Hand Control" dialog. Enter the model number of the selected hand control in the text field. 6. Click Next to proceed to the "Finished" dialog, which displays the selections made in the previous dialogs. Each of these fields can be edited if necessary. 7. Click Finish to save the changes, generate the hand control file and add it to the User Database file (visible in the Navigator window). 14 IREdit