AMX RPMLoader Operation/Reference Manual
AMX RPMLoader Operation/Reference Manual

AMX RPMLoader Operation/Reference Manual

File transfer utility application
Table of Contents

Advertisement

Quick Links

Operation/Reference Guide
RPMLoader
File Transfer Utility Application
S of t w ar e
I n i t i a l R e l e a s e : 3 / 0 5 / 2 0 1 2

Advertisement

Table of Contents
loading

Summary of Contents for AMX RPMLoader

  • Page 1 Operation/Reference Guide RPMLoader File Transfer Utility Application S of t w ar e I n i t i a l R e l e a s e : 3 / 0 5 / 2 0 1 2...
  • Page 2 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.
  • Page 3 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.
  • Page 5: Table Of Contents

    Supported Languages ..................... 1 PC Requirements/Recommendations ................1 Installing RPMLoader ....................2 Installing a Desktop Version of the RPMLoader Application ........... 2 Installing a Portable Version of the RPMLoader Application........... 2 RPMLoader - Quick Start ..................3 Opening an RPMX Project File ..................3 Connecting to a NetLinx Master ..................
  • Page 6 Table of Contents Editing a RPMLoader Project ..................18 Device Mapping...................... 18 Device:Port:System (D:P:S).................... 18 Binding/Unbinding Devices..................19 Firmware File Transfers................... 21 Firmware File Transfer dialog..................21 Updating NetLinx Firmware ..................22 RPMLoader Work Area ..................23 Overview ........................ 23 Menu Bar........................23 File Menu ..........................
  • Page 7: Rpmloader

    RPMX file from your PC to the target NetLinx Master. RPM (Rapid Project Maker) Web Application Design, configure, and deploy AMX systems in less than an hour with Rapid Project Maker (NSS-RPM). This Cloud-based configuration tool allows entry level AV technicians or IT professionals with limited technical proficiency to easily configure an AMX system by using a step-by-step wizard-based approach.
  • Page 8: Installing Rpmloader

    RPMLoader Setup - Install Option  By default, RPMLoader is installed to a default location on your PCs local hard drive, like any other Windows application. To install RPMLoader to the default location, verify that the Install a Desktop Version of the RPMLoader Application option is selected.
  • Page 9: Rpmloader - Quick Start

    RPMLoader In the Install Option dialog, select Install a Portable Version of the RPMLoader Application and click Next to proceed. In the Select RPMLoader Portable Install Location dialog, accept the default Destination Folder (or click Browse to select a different destination folder if desired), and click Next to proceed.
  • Page 10: Connecting To A Netlinx Master

    Select Open in the File menu to open your RPMX file. Once an RPMX file has been opened in RPMLoader, the file can be edited and the files indicated in the RPMX file can be transferred to a target NetLinx Master. After making changes to your RPMX file, select Save in the File menu to update all of your changes.
  • Page 11: Reports

    FIG. 9 Cancel File Transfers button Reports RPMLoader provides several report functions, accessible via the Reports section of the Tasks window, or via the Reports menu: Last File Transfer Log Select View Last File Transfer Log from the Tasks window, or select Reports > View Last File Transfer Log to open the File Transfer Log.
  • Page 12: Online Device Tree Report

    RPMLoader Online Device Tree Report Select View Online Tree Report from the Tasks window, or select Reports > View Online Tree Report to open the Online Tree report. This report provides a summary of the online device tree for this RPM Project, in the form of a TXT file (FIG.
  • Page 13: Macro Configurations Report

    RPMLoader Macro Configurations Report Select View Macro Configuration Report from the Tasks window, or select Reports > View Macro Configuration Report to open the Macro Configurations report. The Macro Configurations report file ("MacroReport.txt") provides a summary of all macros that are defined in this project, in the form of a text file (FIG.
  • Page 14 RPMLoader RPMLoader...
  • Page 15: Using Rpmloader

    NetLinx Master for file transfers (FIG. 14): FIG. 14 Connect To Master dialog RPMLoader supports two types of connection to the NetLinx Master for file transfers: Network (TCP/IP) and Serial (RS-232). Connecting to a NetLinx Master via Network Connection To establish a Network (TCP/IP) Connection with the target NetLinx Master: Click the Communication Settings command button to open the Connect To Master dialog.
  • Page 16: Adding A New Network Connection

    Using RPMLoader Alternatively, select the desired target Master and click the Select button to populate the Network Connection fields with the selected Master's IP Address and Description (FIG. 17): FIG. 17 Connect To Master dialog - Network Connection fields ...
  • Page 17: Editing A Network Connection

    Using RPMLoader FIG. 18 New TCP/IP Setting dialog Enter a valid TCP/IP Address. Fill in the Description. Enter a valid Username and Password if the target Master is secured. Do not change the Port number - it should remain set to 1319.
  • Page 18: Searching For Masters On The Subnet

    Using RPMLoader Searching for Masters on the Subnet If the target NetLinx Master is online, but is not indicated in the List of Masters window (in the Connect To Master dialog), search the network for online NetLinx Masters via the Search For Masters dialog (FIG. 20): FIG.
  • Page 19 Using RPMLoader FIG. 22 Search For Masters dialog - Select NetLinx Master To Add An instance of the New TCP/IP Setting dialog will be presented for each of the selected Masters, to provide an opportunity to enter a Description for each Master as well as to enter User Names and Passwords, if required (FIG.
  • Page 20: Connecting To A Netlinx Master Via Serial Connection

    Using RPMLoader Connecting to a NetLinx Master via Serial Connection To establish a Serial Connection with the target NetLinx Master: Click the Communication Settings command button to open the Connect To Master dialog. Under Connection To Master, select Serial Connection (FIG. 25): FIG.
  • Page 21: Working With Rpmx Project Files

    Using RPMLoader These settings are for the CONFIGURATION DIP Switch on the NetLinx Master. Verify that the CONFIGURATION DIP Switch on the NetLinx Master matches the appropriate diagram in this dialog. Enter a valid Username and Password if the target Master is secured: Click OK to close the Connect To Master dialog.
  • Page 22: Importing Local Files Into The Project For Transfer

    Using RPMLoader FIG. 30 Add/Import File To Transfer dialog To select a file to add, click the Open icon next to the File field (FIG. 31): FIG. 31 Add/Import File To Transfer dialog - Open button This invokes the Open dialog. Note that this dialog includes a File Type drop-down menu (lower-left corner).
  • Page 23: Removing Files From The File Transfer List

    PC (for uploads) are not included in the transfer. By default, Smart Transfer is enabled in RPMLoader. This feature can be disabled via the Enable "Smart Transfer" for all TP4 Files option in the Preferences dialog (FIG. 35): FIG.
  • Page 24: Creating A New Rpm Loader Project File

    RPMLoader (RPMX) Project Files can be created in RPMLoader, to provide a method of using RPMLoader to transfer files that were not necessarily generated as part of a RPM Project: when a new RPMLoader Project is created, you can add and/or import local files as desired and transfer them via RPMLoader.
  • Page 25: Binding/Unbinding Devices

    Using RPMLoader  Device: 16-bit integer representing the device number  Port: 16-bit integer representing the port number (in the range 1 through the number of ports on the device)  System: 16-bit integer representing the system number (0 = this system) that the device belongs to.
  • Page 26 Using RPMLoader  A Bound device is one which has established communication with a specific Master. The devices listed beneath the top System folder in the Online Device Tree are Bound to the Master.  An Unbound device is an NDP-capable device which has not yet been assigned (bound) to communicate with a specific Master.
  • Page 27: Firmware File Transfers

    NXI Master Controllers use Kit files for firmware upgrades. A Kit file (.KIT) is a package of several files, all of which are required to upgrade the firmware, and are available online via www.amx.com. The Online Device Tree displays information about each online device, including the current firmware version.
  • Page 28: Updating Netlinx Firmware

    Using RPMLoader Updating NetLinx Firmware Choose Options > Advanced > Firmware File Transfer to open the Firmware File Transfer dialog. Click the Browse (...) button to navigate to the target directory (in the Browse For Folder dialog). The selected directory path is displayed in the Location field. Assuming that the specified target directory contains one or more Kit files, the Kit files in the selected directory are displayed in the Files list box (with the file’s last modified date and time).
  • Page 29: Rpmloader Work Area

    Click to close the current RPM Project file. New: Click to create a new RPMLoader Project. This command opens the New Project dialog. See the Creating a New RPM Loader Project File section on page 18 for details. Recent Files: Click to select from a listing of recently opened RPMX Project files.
  • Page 30: View Menu

    Click to open the Preferences dialog, where you can change the appearance of the Online Device Tree Window, change the default Telnet application to use with RPMLoader, as well as disable/enable the Smart Transfer feature for TP4 File Transfers. See the Working With RPMX Project Files section on page 15 for details.
  • Page 31: Toolbar

    About Opens the About RPM Loader dialog. RPMLoader Tasks Window The RPMLoader Tasks window provides links to the key functions of the application, separated into five menus (FIG. 45): Contains quick-start links to commonly used functions (click up arrow to collapse)
  • Page 32 RPMLoader Work Area RPMLoader Tasks Window Options Start • Open a RPMLoader Project File - Click to open a RPMX file. This command is the same as selecting File > Open or clicking the Open toolbar button. See the Opening a RPMLoader Project File section for details.
  • Page 33: Rpmloader Project Window

    Use the options in this dialog to create a ZIP file containing several key files in the current RPMLoader project and e-mail the ZIP file to AMX Technical Support, in the case that the RPMLoader project fails to work. See the Package Files for Tech Support topic for details.
  • Page 34: Help Window

    RPMLoader Work Area Help Window The On-Screen help window provides help relating to the common tasks in RPMLoader (FIG. 48): . FIG. 48 Help Window This window also indicates when a File Transfer operation has completed (FIG. 49)..FIG. 49 Help Window - Transfer Complete ...or if errors occurred that prevented the File Transfer operation from competing successfully (FIG.
  • Page 35: Online Device Tree Window

    Online Device Tree Window The Online Device Tree window displays a list of devices detected to be currently online by the Master Controller to which RPMLoader is currently connected - providing the device number, port count and firmware version for each (FIG. 51): FIG.
  • Page 36: Online Device Tree Context Menu

    Online Tree Reboot Master Click to reboot the NetLinx Master to which RPMLoader is currently connected. Note that if the Master is rebooted, it may take several moments for it become available to reconnect (via the Connect To Master option).
  • Page 37: File Transfer List Window Context Menu

    File list for transfer to AMX devices. Remove Item From List Click to remove the selected file from the File list. RPMLoader will prompt you to verify this action before the selected file is removed.
  • Page 38: Output Status Window

    RPMLoader Work Area Output Status Window When an File Transfer is started, the Output Status window provides a listing of the files that have been transferred, indicating the status of each transfer (FIG. 53): FIG. 53 Output Status Window Output Status Window Context Menu...
  • Page 39: Troubleshooting

    Overview This section outlines common troubleshooting tasks that can be performed in case you have trouble using RPMLoader. Cannot Communicate with the Master Controller Your packaged RPMX file comes with the communications setting already defined. However, if you need to select a different IP/URL address for your control system, select the Communication Settings option in the Start Tasks window (FIG.
  • Page 40: Error During A File Transfer - Invalid Device Mapping

    (FIG. 59): FIG. 59 Enter DPS dialog Enter the correct D:P:S and click OK. After changing the device mapping, deselect all the files that did transfer successfully and make sure the problem file is selected in the File Transfer List. RPMLoader...
  • Page 41: Error During A File Transfer - Device Is Offline

    Select the Launch Configuration Page option in the Master Tasks window (FIG. 62): FIG. 62 Master Tasks window - Launch Configuration Page This will open the Web Configuration page of the connected NetLinx Master within your default browser. (FIG. 63): RPMLoader...
  • Page 42 You may also launch a Telnet window for the Master Controller: select the Launch Telnet Window option in the Master Tasks window. This will launch the default Telnet program for the Master Controller (FIG. 64): FIG. 64 Example Telnet connection to a NetLinx Master RPMLoader...
  • Page 43: Need To Change A Configuration Parameter On A Device

    Online Device Tree context menu - Launch Telnet Window The default program is TELNET.EXE, and can be changed via options in the Preferences dialog (FIG. 66): Click the Browse (...) button to locate and select a different Telnet program to use. FIG. 66 Preferences dialog RPMLoader...
  • Page 44: Need Detailed Information On A Device

    You can also generate a full report of all the devices: FIG. 69 Online Device Tree - Device Properties Right-click within the Online Device Tree to open the context menu, and select Report. Alternatively, select View Online Tree Report from the Reports Tasks window. RPMLoader...
  • Page 45: Package Files For Tech Support

    Package Files for Tech Support dialog Use the options in this dialog to create a ZIP file containing several key files in the current RPMLoader project and e-mail the ZIP file to AMX Technical Support, in the case that the RPMLoader project fails to work.
  • Page 46 Troubleshooting RPMLoader...
  • Page 47 Enter the name of the last section here RPMLoader...
  • Page 48 - Schedules and registration for any AMX University course - Travel and hotel information - Your individual certification requirements and progress 3000 RESEARCH DRIVE, RICHARDSON, TX 75082 USA • 800.222.0193 • 469.624.8000 • 469-624-7153 fax • 800.932.6993 technical support • www.amx.com...

Table of Contents