AMX FILETRANSFER2 V1.0 User Manual
FileTransfer2
instruction manual
Software
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.2277013 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 countr y to
which the United States has embargoed goods; or (ii) anyone on the United States Treasury Department's list of Specially Designated Nationals or the U.S. Commerce Department's Table of Deny Orders. AMX does not authorize the downloading or exporting of any software or technical 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 Texa s ,
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 Corporation, 3000 Research Drive, Richardson, TX 75082.
Table OF Contents
Table OF Contents
Welcome To FileTransfer2 .......................................................................................1
The FileTransfer2 User Interface ...................................................................................... 1
Send Tab.................................................................................................................................. 2
Receive Tab ............................................................................................................................. 3
File Transfer Context Menu...................................................................................................... 3
Transfer Command Buttons ..................................................................................................... 4
Edit Menu ................................................................................................................................. 4
Load Options............................................................................................................................ 5
Transfer Status Window ........................................................................................................... 6
Transfer Status Context Menu ................................................................................................. 6
Supported File Types ........................................................................................................ 7
Notes on supported file types:.................................................................................................. 7
Supported Operating Systems and Minimum PC Requirements ...................................... 7
Tested Modems List .......................................................................................................... 8
Using FileTransfer2 ................................................................................................11
Step 1: Adding Files To The Transfer Queue.................................................................. 11
Using the Quick Load Dialog.................................................................................................. 11
Workspace Files (*.APW)....................................................................................................... 12
Workspace-To-Go Files (*.AXW) ........................................................................................... 13
File Transfer List (*.FTL) Files................................................................................................ 14
NetLinx Master Security ......................................................................................................... 14
Adding Files To The Files To Send Queue ..................................................................... 15
Adding All Files Contained In an APW or AXW File............................................................... 15
Adding Files From a Specific Project/System ........................................................................ 16
Adding Individual System Files From the Open Workspace file ............................................ 16
Adding Orphan Files .............................................................................................................. 16
Adding Files To The Files To Receive Queue................................................................. 17
Step 2: Communication Settings ..................................................................................... 18
Listening for NetLinx Masters................................................................................................. 18
Virtual NetLinx Master ............................................................................................................ 18
Configuring Communications Settings ................................................................................... 19
Configuring TCP/IP Communication Settings (NetLinx only) ................................................. 19
Configuring Serial Communication Settings........................................................................... 20
Configuring Modem Communication Settings........................................................................ 20
Configuring Virtual NetLinx Master Communication Settings (NetLinx only) ......................... 21
Configuring the Touch Panel for Virtual NetLinx Master USB Transfers ............................... 21
ileTransfer2
i
Table OF Contents
Configuring the Touch Panel for Virtual NetLinx Master TCP/IP Transfers ........................... 22
Step 3: Device Mapping .................................................................................................. 22
Editing Device Mapping Information ...................................................................................... 22
Device:Port:System (D:P:S)................................................................................................... 22
Step 4: Transferring The Files......................................................................................... 23
File Transfer Status Information ............................................................................................. 23
Transfer Errors and Definitions .............................................................................................. 24
Sending Files To System Devices ......................................................................................... 25
Receiving Files From System Devices................................................................................... 25
Virtual NetLinx Master (Masterless) Transfers................................................................ 25
AMX USB Driver Information for USB Enabled G4 Panels.................................................... 26
Virtual NetLinx Master Transfers via USB or TCP/IP Connection.......................................... 26
Virtual NetLinx Master TCP/IP Transfers ............................................................................... 27
Configuring the Touch Panel for Virtual NetLinx Master TCP/IP Transfers ........................... 27
Configuring FileTransfer2 for Virtual NetLinx Master TCP/IP Transfers ................................ 28
Transferring Files Using a Virtual NetLinx Master TCP/IP Connection.................................. 28
Virtual NetLinx Master USB Transfers ................................................................................... 29
Configuring the Touch Panel for Virtual NetLinx Master USB Transfers ............................... 29
Configuring FileTransfer2 for Virtual NetLinx Master USB Transfers .................................... 29
Transferring Files Using a Virtual NetLinx Master USB Connection ...................................... 30
Setting Program Preferences ................................................................................31
Overview ......................................................................................................................... 31
Preferences dialog .......................................................................................................... 31
File Transfer Options.............................................................................................................. 31
Workspace Options................................................................................................................ 31
General Options ..................................................................................................................... 31
NetLinx/Axcess Source Code Passwords.............................................................................. 32
Using the FTCon Console Program (Advanced Programmers Only) ................33
APW File Transfer Arguments ........................................................................................ 33
AXW File Transfer Arguments ........................................................................................ 34
FTL File Transfer Arguments .......................................................................................... 34
Single File Transfer Arguments....................................................................................... 34
ii
FileTransfer2
Welcome To FileTransfer2
The FileTransfer2 application gives you the ability to queue a list of files to transfer to various
NetLinx and Axcess devices, without launching NetLinx Studio.
FileTransfer2 supports the following capabilities for file transfers:
Ability to select the Platform type (NetLinx or Axcess).
Ability to set the username and password for NetLinx masters that have security enabled.
Ability to send/receive via USB (for USB enabled) devices via a Virtual NetLinx Master
(VNM) connection.
Ability to send/receive files via TCP/IP and RS232 protocols.
FileTransfer2 recognizes the following file types for transfer:
APW (NetLinx Studio Workspace)
AXW (NetLinx Studio Export-to-Go)
FTL (File Transfer List)
Welcome To FileTransfer2
The FileTransfer2 User Interface
The FileTransfer2 user-interface consists of a single main window (FIG. 1), separated into two tabs
(Send and Receive) and a Transfer Status Window.
ileTransfer2
FIG. 1 FileTransfer2 User Interface
1
Welcome To FileTransfer2
Use the Send tab for transferring files from the PC running FileTransfer2 and the target Master
Controller or System Device.
Send Tab
The Transfer List table in the Send tab indicates the files that are currently in the Files To Send
queue. Each row in the table represents a single System file, and could be any of the supported
system file types.
The columns in the table display the following file information for each file in the queue:
Use the Receive tab for transferring files from a Master Controller or System Device to
the PC.
The Menu bar provides access to the main functions of the program.
The Transfer Command Buttons allow you to control transfer functions.
The Load Options provide flexibility in how you can add files to the Transfer List.
The Transfer Status Window displays the status of each file transfer operation.
Workspace: displays the name of the currently open Workspace file
Project: displays the name of the active Project
System: displays the name of the active System
File: displays the name of the file in the Files To Send queue
Reboot: click the checkbox in this column to reboot the target device when the transfer is
complete
By default, the Reboot option is enabled (for Workspace files only), so that the System
Master will automatically reboot after the transfer is complete.
The Reboot option always reboots the Master, regardless of the device mapping
associated with the file itself. For example, TPD/TP4 files are transferred directly to
the panel, but the Reboot option will reboot the Master - not the panel that received
the file.
It is usually necessary to reboot a NetLinx master after a TKN file transfer. However, it is
not always desirable to have the reboot occur immediately after the file is transferred.
The Reboot checkbox allows you the flexibility of specifying when the reboot should
occur.
You are responsible for ordering your transfers correctly. If you choose to reboot after
a transfer and then immediately attempt to transfer to another device that is on the
bus of the master that is rebooting, the device will more than likely not be available
and the transfer will fail.
Connection: displays the communications settings associated with this file.
Mapping: displays the device-file mapping information (Device:Port:System) associated
with this file.
Options (TPD and TP4 files only): displays any optional file information associated with
the selected file (via either the TPD Transfer Options or TP4 Transfer Options dialog,
2
FileTransfer2
Welcome To FileTransfer2
depending on the file type). Currently there are only options available when transferring
TPD and TP4 type files. This button is disabled for all other file types.
Receive Tab
The Transfer List table in the Receive tab indicates the files that are currently in the Files To
Receive queue. Each row in the table represents a single System file, and could be any of the
supported system file types.
The columns in the table display the following file information for each file in the queue:
File: displays the name of the file in the Files To Send queue
Connection: displays the communications settings associated with this file.
Mapping: displays the device-file mapping information (Device:Port:System) associated
with this file. The message "Direct to Device (No Master)" indicates that the source
device does not reside behind a master. Double-click this cell to access the Enter DPS
dialog, where you can view/edit the D:P:S assignment for the selected file.
Options (TPD and TP4 files only): displays any optional file information associated with
the selected file (via either the TPD Transfer Options or TP4 Transfer Options dialog,
depending on the file type). Currently there are only options available when transferring
TPD and TP4 type files. This button is disabled for all other file types.
File Transfer Context Menu
Right-click on any file listed in the Send or Receive tabs to access the File Transfer context menu:
Add — Adds a new file to the Send or Receive table (depending on which tab is open
when this option is selected). This option opens the Select Files For Transfer dialog,
where you can select to send all files contained in a Project or System, an individual
Project/System file (assuming the Project/System is contained within the currently open
Workspace), or any other file (not contained in the open Workspace).
Remove — Removes the selected file from the list.
Remove All — Removes all files from the list.
Select — Selects a file in the list.
Deselect — Deselects the selected file.
Select All — Selects all files in the list.
Deselect All — Deselects all files in the list.
Options — (Only enabled if a TPD or TP4 Touch Panel file is selected). Displays any
optional file information associated with the selected file (via either the TPD Transfer
Options or TP4 Transfer Options dialog, depending on the file type). This option is
disabled for all other file types.
ileTransfer2
Communication Settings — Opens the Communication Settings dialog, where you can
edit the Platform, Transport Connection type and Communication Settings for the
selected file.
3
Welcome To FileTransfer2
Transfer Command Buttons
Both tabs (Send and Receive) contain the following set of command buttons:
Mapping — Opens the Enter DPS dialog, where you can view/edit the D:P:S assignment
of the source device for the selected file. If the file being transferred is a TPD file, and is
being sent via serial connection, then the Enter DPS dialog also offers a Connect Directly
To the Device - No Master option.
Up/Down — With a file selected in the Files To Send/Files to Receive tables, use these
buttons to move the file up and down in the list. The order in which the files are
represented in this table is the same order in which the files will be sent.
Add — Click to add a new file to the Files To Send/Files to Receive tables. This option
opens the Select Files For File Transfer dialog where you can select to send all files
contained in a Project or System, an individual Project/System file (assuming the Project/
System is contained within the currently open Workspace), or any other file (not
contained in the open Workspace).
Remove — Click to remove a selected file in the Files To Send/Files to Receive tables.
Remove All — Click to remove all files from the Files To Send/Files to Receive tables.
Edit — With a file selected in the Files To Send table, click the Edit command button to
open the Edit menu.
Send (Send tab only) — Click to send the file(s) in the Files To Send table to the
specified device(s).
Receive (Receive tab only) — Click to receive the file(s) in the Files To Receive table to
the specified device(s).
Exit — Click to exit the FileTransfer2 application.
Edit Menu
With a file selected in either the Send or Receive tab, click the Edit command button to open the
Edit menu, containing the following options:
Options — This option is only available if you have selected a TPD or TP4 touch panel
UI file.
If you have selected a TPD (TPdesign3) file, this option opens the TPD Transfer Options
dialog, where you can select which parts of the TPD file to include when the file is sent
(the options are Bitmaps, Fonts and Icons - by default they are all selected).
If you have selected a TP4 (TPDesign4) file, this option opens the TP4 Transfer Options
dialog, where you can select to enable Smart Transfer. Smart Transfer automatically
optimizes the transfer by identifying the various components (fonts, bitmaps, sound files,
even pages and popup pages) of the selected panel file, and comparing them to the
elements already present on the target panel. Any shared components are not sent,
resulting in a much faster transfer (assuming that there are shared components).
4
FileTransfer2
Welcome To FileTransfer2
When sending a TP4 file to a G4 panel, verify that the NetLinx Master Firmware is
build 85 or later. Verify the TPDesign4 program being used is Version 1.01 or higher.
Earlier versions of the firmware and TPD4 software are incompatible with G4 panels.
Communication Settings — Opens the Communication Settings dialog, where you can
edit the Platform, Transport Connection type and Communication Settings for the
selected file.
Alternatively, you can double-click in the Connection column to access the
Communication Settings dialog.
Device Mapping — Opens the Enter DPS dialog, where you can view/edit the D:P:S
assignment of the target device for the selected file.
In Axcess, Master Source Code files are always mapped to the Master Controller
(device = 0). Master Source Code files cannot be mapped to any other device.
NetLinx Master Source Code files are mapped according to the System settings
when the Project was created. The only way to modify these settings is via the
System Properties dialog.
Also, when sending TPD files directly to a Touch Panel (i.e. via serial cable
connection), the device = 0.
Load Options
Both tabs share the following Load Options:
Quick Load — Click to open the Quick Load dialog, where you can specify particular
file types to load into the Send list.
Load Workspace — Click to open the Open Workspace/AXW File dialog.
Load List — This option allow you to select and open an .FTL file (see below), via the
Open dialog. When an .FTL file is opened, the Send list is populated with the files
specified in the .FTL file for transfer.
Save List — This option saves the list of files currently displayed in the Send list as an
.FTL file (specify a name and target directory to save the .FTL file in the Save As dialog).
Remember Last Items Transferred — When selected, this checkbox will cause the list
of transferred files to be automatically reloaded the next time the File Transfer dialog is
opened. This is useful if you transfer the same files repeatedly. That way, you don’t have
to re-add the items over and over again. De-selecting the checkbox clears the
remembered list of files and prevents file transfer from reloading the files the next time
the dialog is displayed.
Workspace display — This (read-only) field displays the currently open Workspace or
Workspace To-Go file.
ileTransfer2
5
Welcome To FileTransfer2
Transfer Status Window
Once you have started a file transfer operation, the following types of status information are
displayed in the File Transfer Status tab of the Output Display window:
Typ e — The type of transfer (sending or receiving).
Status — The current state of the transfer (Pending, Transferring, Complete or Failed).
Connection — The communications settings used to establish communication with the
target device.
Mapping — The number(s) used to identify the target device on the bus or the message
"Direct to Device (No Master)" if the target device does not reside behind a master.
File — The name and extension of the file being transferred.
Path — The full path of the file being transferred.
Bytes Transferred — The number of bytes transferred, and the total number of bytes left
to transfer.
Error — An error message if an error has occurred.
Last Transfer — The time and date of the last transfer.
Transfer Status Context Menu
Right-click on any file listed in the Transfer Status List to access the Transfer Status context menu:
Copy All Items — Copies all items in the list to the clipboard.
Copy Selected Items — Copies only the selected items in the list to the clipboard.
Save All Items — Saves all items to a user-defined file. You will be prompted for a file
name to save the contents of the tab.
Save Selected Items — Saves only the selected items to a user-defined file. You will be
prompted for a file name to save the contents of the tab.
Clear — Clears all the items within the list.).
If the selected file is in progress, the following additional options are available:
Cancel Current Transfer — Cancels the selected transfer.
Cancel Selected Transfer Items — Cancels all selected transfer items (shift + click to
select multiple items in the Transfer Status List).
Cancel Remaining Transfer Items — Cancels all items in the Transfer Status List that
have not yet been transferred.
Cancel All Transfer Items — Cancels all items in the Transfer Status List.
6
FileTransfer2
Welcome To FileTransfer2
Supported File Types
The following are the types of files this application can send to and receive from, various NetLinx
and Axcess devices:
TOK Files
TKN Files (including compiled Duet TKN Files)
TP4 Files
TPD Files
KPD Files
IRL/IRV Files
SRC Files
Notes on supported file types:
The selection of available file types depends on the selected platform, Send/Receive
selection and communication settings
All files must mapped to devices before they can be selected for transfer.
Source Code files cannot be sent until they have been successfully compiled.
While Touch Panel UI files are sent to the panels themselves, KPD files are sent to the
master and not directly to the keypad. Before sending a KPD (KPDesign) file to the target
keypad(s), be sure that you have successfully compiled the Source Code file that contains
the keypad module, and sent it to the Master (see Configuring NetLinx Source Code for
KPD Files).
Supported Operating Systems and Minimum PC Requirements
Supported operating systems:
Windows XP®
Windows 2000®
You must have Administrator rights to install and run all required System files.
PC Requirements:
Pentium 233 MHZ processor (minimum requirement); 300 MHZ or faster recommended.
Windows-compatible CD-ROM drive.
ileTransfer2
Windows-compatible mouse (or other pointing device).
If the mouse wheel on your Microsoft® IntelliMouse® doesn't’ work with NetLinx
Studio, try downloading the latest IntelliMouse drivers from Microsoft.
7
Welcome To FileTransfer2
Tested Modems List
The following is a list of internal and external modems that have been tested with the program.
Manufacturer Model - Internal 95 98 ME NT 2000 XP
Diamond Supra 336i SP ASVD ? C ? ? ? ?
Diamond Supra 56i SP ? C ? ? ? ?
Lucent 56K LU PCI ? C ? C ? ?
US Robotics 56k Fax PCI #3CP5610A ? C ? C ? ?
US Robotics Sportster WinModem - #0467 ? X ? ? ? ?
Zoom Fax 28.8 v.341 #275 ? C ? ? ? ?
Note: Internal modes were tested only for calling capabilities.capabilities.
Manufacturer Model - External
Boca 14.4 V.32b #MV.34xx X X X X X X
Hayes Accura 56k #03328-A ? C C C C ?
Hayes Accura 144+Fax 144
MultiTech MultiModem 19.2k Data/Fax ? X ? A A ?
Practical Peripherals PM288MT II v.34 - 28K ? C< ? ? X ?
US Robotics 56k Fax v.90 #USR5686D ? CA ? CA CA ?
US Robotics Sportster56k Fax
US Robotics Sportster 33.6 - #0413 ? ? ? CA ? ?
US Robotics Sportster 14.4 Fax CJE-0235 ? ? ? ? ? ?
Zoom Fax 56kx Dualmode #2949L ? CA C CA C ?
Internal Modems --- Windows Operating System ---
External Modems --- Windows Operating System ---
XX X C X X
#5300AM
CA CA CA CA CA ?
#USR5686-03
C = Call - means that the FileTransfer2 program can get the modem to call another
modem and establish communications.
A = Answer - means that the FileTransfer2 program can get the modem to answer
inbound calls and establish communications with the master controller.
X = Not supported.
< = Less 100% reliable.
8
FileTransfer2
Welcome To FileTransfer2
ileTransfer2
9
Loading...