instruction manual IREdit v1.
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.
Table of Contents Table of Contents IREdit Program Overview ........................................................................................1 Supported Platforms.......................................................................................................... 1 The IREdit Work Area ....................................................................................................... 2 Menus.....................................................................................................
Table of Contents Category Manager Dialog ............................................................................................... 21 Deleting A Category Via Category Manager .......................................................................... 22 Adding An IR Property ........................................................................................................... 22 Deleting An IR Property ..............................................................................................
Table of Contents Preserving Spaces for Copied Functions............................................................................... 42 Save Window Settings ........................................................................................................... 42 Enabling Restore Workspace on Startup ............................................................................... 42 Auto Template Capture .................................................................................................
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 .
IREdit Program Overview The IREdit Work Area The IREdit work area (FIG. 1) comprises several main components: Menu Bar IR Document Window Tool Bar 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 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 Provides the option of creating a New Database or new Hand Control. Open 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.
IREdit Program Overview Edit Menu FIG. 3 Edit Menu The Edit menu contains options relating to editing files and categories. Edit Menu 4 Undo/Redo Undo and Redo the last action. Cut Cut the selected text or slot to the clipboard. Copy Copy the selected text or slot to the clipboard. Paste Paste the selected text or slot from the clipboard to the specified location. Paste Special Paste an IR into another directory and have the option to add missing directory information.
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 IREdit Waveform Opens the Waveform view box displaying a graphical representation of the waveform associated with the selected IR function. Navigator This window contains a tree for every open database. Quick List This is a read only list of available functions for the currently selected hand control record.
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 Sends an IR to a designated Master location. Receive Transfers an IR from a designated Master into IREdit. Verify Checks the file integrity after a transfer. Identify Allows you to identify functions in a list of hand controls via the Identify Dialog. Capture Opens the IR capture wizard.
IREdit Program Overview Help Menu FIG. 6 Help Menu Help Menu Item Description Contents Launches the IREdit help, Contents section. Index Launches the IREdit help, Index section. Search Launches the IREdit help, Search section. AMX IR Update Launches the IR Update Wizard Dialog. Web Update Launches the AMX Web Update utility. About IREdit Displays the about IREdit dialog containing information pertaining to version and copyright.
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.
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.
IREdit Program Overview Right-click within a field in the Properties window to open the Properties Window Context Menu: Properties Window Context Menu Undo • Simple undo support for cut, paste and deletion of text fields. Cut • Cuts the selected text to the clipboard. Copy • Copies the selected text to the clipboard. Paste • Pastes the selected text from the clipboard to the new text field location. Delete • Deletes the selected text. Select All • Selects all text within the field.
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.
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.
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.
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.
Basic Operations Advanced Wizard Dialog The Advanced dialog of the Hand Control Wizard allows you to create a new hand control file in just one dialog: 1. Select File > New Hand Control to open the first wizard dialog ("Welcome to the new hand control wizard"). 2. Check the Please take me to the advanced screen option to use the advanced wizard dialog (intended for advanced users): Manufacturer: Select the manufacturer of the hand control from the drop-down list.
Basic Operations Identify Dialog Click on any of the column heading to arrange the fields in either ascending or descending order. FIG. 12 Identify Dialog The Identify dialog is divided into the columns: Manufacturer - The name of the function's matching manufacturers. Category - The categories for the matching functions. Model - The model names for the matching functions. Hand Control - The name of the matching hand control. Function - The function description for the matching function.
Basic Operations Using Identify Function The Identify feature allows functions to be identified from a list of hand controls. An IRIS connected to the serial port is necessary in order to utilize this feature. 1. Use the Search function with the desired criteria. 2. Within the Search Results window, under the Identify column, click on the functions to be added to the Identify list. 3. After all desired functions have been selected, go to Tools > Identify... 4.
Basic Operations Using Identify Function The Identify feature allows functions to be identified from a list of hand controls. An IRIS connected to the serial port is necessary in order to utilize this feature. 1. Use the Search function with the desired criteria. See Searching for IR Hand Control Files. 2. Within the Search Results window, under the Identify column, click on the functions to be added to the Identify list. 3. After all desired functions have been selected, go to Tools > Identify... 4.
Basic Operations Paste Special The options in the Paste Special dialog allow you to paste any level of an IR directory into another, with the opportunity to insert any missing information. FIG. 13 Paste Special Dialog 1. Select the IR, Hand Control Model, Device Model or Category you want to copy in the Navigator window. 2. Select Edit > Copy. 3. Select the new directory into which you want to paste the selection. 4. Select Edit > Paste Special to open the Paste Special dialog.
Basic Operations Printing Files You can print the active IR file using File > Print: Choose File > Print Preview to open the Print Preview window, to preview the file as it will be printed (if necessary). Choose File > Print to print the file. Editing IR Files IREdit allows you to edit up to 255 functions within user-created IR files. IR files contained within the AMX Database cannot be edited. Values from other hand controls can be cut or copied and then pasted into any one of the 255 function slots.
Basic Operations Category Manager Dialog Category Manager can manage your categories without expanding the database. To access the Category Manager Dialog for a given database: 1. Select a user database in the Navigator window. 2. Select Edit > Categories. This will open the Category Manager Dialog. Adding a Category Via Category Manager 1. Select a user database file in the Navigator window. 2. Select Edit > Categories to open the Category Manager dialog. FIG. 14 Category Manager Dialog 3.
Basic Operations Deleting A Category Via Category Manager 1. Select a user database file in the Navigator window. 2. Select Edit > Categories to open the Category Manager Dialog. 3. Select the category you want to delete. 4. Click on the Delete button. 5. Once finished, click on the Close button. Deleting a category will also delete all information contained therein. Adding An IR Property 1. Within the Properties window select Model Name. 2.
Basic Operations Deleting An IR Property 1. Within the Properties window select Model Name. 2. Model Name provides a drop-down button, when selected will open the Model Manager Dialog. 3. Within the Model Manager select the model line to be deleted. 4. Select Delete. 5. You will be prompted to confirm your selection. Click Yes. 6. Afterwards you are returned to Model Manager. Click OK. Sending An IR File Use the Send function to transfer the IR files to devices on the bus.
Basic Operations 3. After you have all the necessary information listed, click Start. You will then see a status bar. 4. Once it is done sending you can select Close. The status will read "Disconnecting". Configuring Device Connection Communications Settings Use the options in the Communications Settings dialog to specify communication settings for transfer operations. FIG. 17 Device Connection Communications Settings Dialog 1. Select Tools > Comm Settings... to open the Communications Settings dialog.
Basic Operations Device:Port:System (D:P:S) A device is any hardware component that can be connected to the NetLinx bus. Each device must be assigned a unique number to locate that device on the bus. The Axcess language allows physical device numbers in the range 0-255. The NetLinx language allows numbers in the range 0-32767. Device 0 refers to the master; numbers above 32767 are reserved for internal use.
Basic Operations Transport Connection Option Settings When setting TCP/IP Settings you need to: Select Tools > Comm Settings..., select the TCP/IP as the Transport Connection option, and then click Settings to access the TCP/IP Settings dialog. This option is only available for NetLinx systems. FIG. 18 TCP/IP Settings Dialog Enter a valid target TCP/IP Address and IP Port assignment. The IP Port assignment defaults to 1319. You should not change the IP Port number.
Basic Operations Data Bits - Click the down arrow to open a menu where you can choose the Data Bits (suggested setting = 8). Parity - Click the down arrow to open a menu where you can choose the parity (suggested setting = none). Stop Bits - Click the down arrow to open a menu where you can choose the Stop bit(s) (suggested setting = 1). Flow Control - Click the down arrow to open a menu where you can choose the Flow Control (suggested setting = none).
Basic Operations Verifying Verifying is a means of ensuring no corruption occurred to your hand control file during the sending to the Master. Verify will compare all functions in the hand control file on the Master’s port to the functions listed in IREdit’s hand control selected in the Navigator window. In order to verify you must first send a hand control file. 1. Select Tools > Verify. This launches the IR Verify Wizard. 2. Select Next. 3. Designate the Device, Port and System.
Basic Operations 7. After several seconds, the panel should appear in the online device tree, listed as Virtual NetLinx Master. Once you can see the device online, you may transfer panel files to the G4 device without the need for an intermediate NetLinx master. Configuring IREdit for Virtual NetLinx Master Transfers 1. Select Tools > Comm Settings... to open the Communications Settings dialog. 2. Select the Virtual NetLinx Master radio button. 3.
Basic Operations Capturing An IR File With the use of an IRIS, IREdit can capture IRs into hand control functions specified by you. 1. Select Tools > Comm Settings > Capture Tab to set the port location of the IRIS. Select OK. 2. In the IR Document window select the channel into which you want to capture. 3. Select Tools > Capture. This will launch the IR Capture Wizard. 4. You will need to enter the function name and select Next. 5.
Basic Operations Discrete IR Hex Codes Hex format codes are available only online. Therefore, hex format codes cannot be captured from a manufacturer's remote by an IRIS and added into an .IRN or .IRL/.IRV file. IREdit utilizes the base format (raw oscillated code) of the hex codes (available at www.remotecentral.com). Discreet hex codes can be imported into IREdit files via a wizard process.
Basic Operations 6. Paste the code into the text edit field provided by the wizard. The Discrete IR Hex-format code can also be typed in verbatim. 7. When text has been entered into the edit control, the page’s Next button will then become enabled. No validation will be performed on the text until the Next button is pressed, which launches the translation process. 8. Click Next to begin translation to AMX-format.
Basic Operations Receiving An IR File You can transfer a preexisting IR file from either an Axcess or NetLinx Master directly into IREdit. All property information except Notes is received from a NetLinx Master and no property information is received from an Axcess Master. 1. First select a user database in the Navigator window. If you do not have a user database you must create one. 2. Select Tools > Receive.
Basic Operations Importing IR Files You have the option of importing any of your preexisting .IRL files into a user defined database 1. Select the destination database in the Navigation window for the .IRL files. 2. Select File Menu > Import IR File(s).... This launches the Import IR dialog. 3. Select the .IRL files you wish to import and click Open. 4. The new .IRL files appears under the database in the Navigator window. Next is the product name, then Imported File. Then the hand control model.
Basic Operations Actuate IR Dialog Select Tools > Actuate to open the Actuate IR Dialog. The connection status is indicated in the Device section is the connection status. Specify Device, Port and System address information in the text fields in this section The Channel section contains a scrolling list, select a channel to test. The Toggle section manually actuates from OFF to ON. Click the Off button to turn on the corresponding LED at the master.
Basic Operations System 4. Select one of the Channels in the Channel field. 5. Click the Off button. It will then switch to on and the corresponding LED at the master will illuminate. You can select Pulse to have the master's LED flash at the intervals of the waveform. The interval between when the channel ON command is sent to the target device and when the channel OFF command is sent can be set in the Pulse interval time field. The field will accept any value between 1 and 100.
Basic Operations Back - Returns the wizard to the Check for updates Screen. Finish - This button is enabled when the download is complete, click it to close the wizard. Cancel - This button cancels the update and closes the dialog. Help - This button opens the help associated with using the IR Update Wizard. AMX IR Database Update AMX is constantly adding IR codes to the database. The database can be updated via AMX IR Update. 1. Go to Help > AMX IR Update to launch the IR Update Wizard Dialog. 2.
Basic Operations 38 IREdit
Advanced Operations Advanced Operations Templates Within the Properties window you can select to apply a template. Choose templates for categories of equipment to allow them to comply with applications such as Design Xpress. 1. Within the Properties window under the category of Hand Control is the field for template. The default value is (None). 2. Clicking in this field will give you a drop down menu from which to select a template. 3. Select your template.
Advanced Operations FIG. 22 New Toolbar Dialog 4. Enter a name for the new toolbar in the Toolbar Name field. 5. Select a placement option from the drop-down list (Docked Top, Docked Bottom, Docked Left, Docked Right, or Floating). The default setting is Docked Top. 6. Click OK to save the changes and close the New Toolbar dialog. 7. The new (empty) toolbar appears in the workspace according to the placement option specified. To add commands to the new toolbar refer to Customizing the Toolbars.
Advanced Operations Assigning Shortcuts to Commands Use the options in the Customize Keyboard dialog to assign shortcut keys to commands. 1. Right-click on the toolbar and select Customize from the Customize context menu. 2. Within the Customize Dialog select the Keyboard command button to open the Customize Keyboard dialog. 3. Select a category in the Categories view. 4. Under Commands, find your selection. 5. Choose the shortcut you would like to associate in the Specify a Shortcut drop down menu. 6.
Advanced Operations Preserving Spaces for Copied Functions By default, functions copied within a hand control or to another hand control will not keep spaces that may occur between the functions. For example, channels 1, 2 and 5 will be copied into channels 1, 2 and 3. Preserve spaces when copying functions must be enabled for the spaces to be included when copying functions. For example, channels 1, 2 and 5 will be copied into channels 1, 2 and 5.
Setting Program Preferences Setting Program Preferences Customizing The Toolbars You can customize the toolbar by right-clicking on the standard toolbar area and selecting Customize from the Customize context menu. The three tabs available in the Customize dialog are: Toolbars Tab Commands Tab Options Tab Toolbars Tab The Toolbars Tab of the Customize dialog allows you to create a new toolbar populated with commonly used tasks. You can control which toolbars are visible in addition to managing them. FIG.
Setting Program Preferences Click the Keyboard command button to customize your own quick key strokes for commonly used functions. Commands Tab Functions for populating the toolbars are located on the Commands Tab of the Customize dialog. FIG. 25 Commands Tab within Customize Dialog Right-click and select Customize from the Customize context menu to access this dialog.
Setting Program Preferences Options Tab The Options Tab of the Customize dialog allows you to alter the look of the toolbar including the size of the icons that populate it. FIG. 26 Options Tab within Customize Dialog Personalized Menus and Toolbars Always show full menus - When checked, drop down menus will show all available commands. Show full menus after a short delay - used in conjunction with Always show full menus, checked will display all available commands within a drop down menu after a delay.
Setting Program Preferences Menu Animations - You can choose from Fade, Slide, Unfold, Random and None for Menu Animations. Customize Keyboard Dialog Shortcut keys can be assigned and reassigned to user specified commands. FIG. 27 Customize Keyboard Dialog Categories: All Commands - This selection will display all commands under the Commands view. Edit - This selection will display only the commands associated with the Edit menu in the Commands view.
Setting Program Preferences Commands - List of commands associated with a shortcut. Specify a Shortcut - A drop down list of shortcuts that can be associated to the commands. Currently assigned to: - In the event a shortcut is already assigned to the shortcut it will be displayed. Description - A read-only message of attributes associated with the selected command. Assign - Confirms changes made to commands. Remove - Deletes shortcut associated to command.
033-004-2730 03/05 ©2005 AMX Corporation. All rights reserved. AMX, the AMX logo, the building icon, the home icon, and the light bulb icon are all trademarks of AMX Corporation. AMX reserves the right to alter specifications without notice at any time. *In Canada doing business as Panja Inc. AMX reserves the right to alter specifications without notice at any time.
