NDCback-Java
User Guide
NDC Infrared Engineering Inc. Main Phone +1(626) 960-3300
5314 North Irwindale Avenue General Fax +1(626) 939-3870
Irwindale, CA 91706 [Link]
© 2008 NDC Infrared Engineering Inc.
Table of Contents
NDCBACK-JAVA USER GUIDE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
CONNECTION TYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2
Serial Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2
INSTALLING NDCBACK-JAVA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3
BACKING UP THE NDC SYSTEM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4
RESTORING SYSTEM PARAMETERS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13
QUITTING NDCBACK-JAVA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
VIEWING THE VERSION OF NDCBACK-JAVA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .16
TROUBLESHOOTING . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17
CONNECTION TESTS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18
DESCRIPTION OF FILES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
Backup File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
Log file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
CONNECTING A PC TO THE TDI NETWORK . . . . . . . . . . . . . . . . . . . . . . . . . . . .A-1
•
•
NDCback-Java User Guide 7/7/08 • i
•
•
•
•
•
ii •
• NDCback-Java User Guide 7/7/08
•
•
NDCback-Java User Guide
NDCback-Java is a Java-based program that is run on a computer to back up all parameters in
an NDC system. Any time that it is desired to restore the setup of the system to the one at the
time of the backup, NDCback-Java can be run to send the backup file to the system, and
restore its setup.
NDCback-Java provides two options:
• The Save option makes a backup of all settings in the system. These settings are
saved to a text file.
It is recommended to run NDCback-Java any time you have made significant
changes to your system, so that a backup is available should your system settings
become corrupted.
• The Restore option restores all settings from a backup file to a system.
Before a software upgrade is performed, NDCback-Java should be run with the Save option to
save the configuration of the system. After the software has been upgraded in the system,
NDCback-Java is run again, this time using the Restore option, to restore all parameters and
recipes.
•
NDCback-Java User Guide 7/7/08 •• 1
•
•
•
Connection Type
8000TDi systems
The PC that is running NDCback-Java must be connected via Ethernet to the TDi network.
Follow the procedure in Appendix A- Connecting a PC to the TDi Network.
8000 MicroBric, 8000 Bric and T-Gage systems
8000 MicroBric, 8000 Bric and T-Gage systems support either an Ethernet connection or a
serial connection to the PC. An Ethernet connection is available only if your system
includes the Ethernet option. A serial connection requires the use of a null modem cable.
Serial Setup
Attach one end of an RS-232 null modem cable (p/n 622198-2-xx) to the port on the
system chassis labeled “HIF COM 1”. Connect the other end of the cable to a COM
port on the PC.
The configuration of the null modem cable is shown in Figure 1.
Null Modem Cable
(NDC p/n 622198-2-xx)
NDC System 2 3 PC
3 2 9-Pin
9-Pin D-Sub Female
5 5
Figure 1 Null modem cable (NDC p/n 622198-2-xx)
•
•
2 • NDCback-Java User Guide 7/7/08
•
•
•
Installing NDCback-Java
1. Insert the NDCback-Java CD (p/n 903000) in the CD-ROM drive.
2. Double-click on [Link].
The default installation directory is “C:\Program Files\NDCback-Java\NDCback”.
This directory may be changed, if desired, by clicking Browse.
Follow the instructions on the screen to install the NDCback-Java program.
•
•
NDCback-Java User Guide 7/7/08 •• 3
•
•
Backing Up the NDC System
The procedure to back up the NDC system is as follows:
Step 1 – Launch NDCback-Java
Step 2 – Select System Type
Step 3 – Select Connection Type
Step 4 – Enter Communication Settings
Step 5 – Enter Name of Backup File
Step 6 – Select the Save option
•
•
4 • NDCback-Java User Guide 7/7/08
•
•
•
Step 1 – Launch NDCback-Java
Launch NDCback-Java by selecting Programs > NDCback-Java > NDCback-Java from
the Start menu, or by double-clicking on the NDCback-Java icon on the Desktop.
•
•
NDCback-Java User Guide 7/7/08 •• 5
•
•
Step 2 – Select System Type
Figure 2 Select System Type screen
Refer to Figure 2.
1. Select:
– 8000 if you have an 8000TDi, 8000 MicroBric or 8000 Bric system
– T-Gage if you have a Model 100TC, 4100TC, 5100TC, 5400TC or 6100TC
system
2. Select Next to move to the next screen.
•
•
6 • NDCback-Java User Guide 7/7/08
•
•
•
Step 3 – Select Connection Type
Figure 3 Select Connection Type screen
Refer to Figure 3.
1. Select the type of connection:
– Serial if the PC is connected via a serial port to the NDC system
– Serial-USB if the PC is connected to the NDC system via a USB port and a
USB-to-Serial converter
– Ethernet if the PC is connected via Ethernet to the NDC system
2. Select Next to move to the next screen.
•
•
NDCback-Java User Guide 7/7/08 •• 7
•
•
Step 4 – Enter Communication Settings
Ethernet Connection
Figure 4 Ethernet Connection Setup
Refer to Figure 4.
1. In the Hostname box, enter the IP Address (or hostname) of the NDC system (e.g.,
[Link]).
2. In the Port box, enter 20000.
3. Select Next to move to the next screen.
•
•
8 • NDCback-Java User Guide 7/7/08
•
•
•
Serial or Serial-USB Connection
Figure 5 Serial or Serial-USB Connection Setup
Refer to Figure 5.
1. For COM Port, enter the serial port on the PC (e.g., 1 for COM1, 2 for COM2, etc.).
2. For Baud Rate, select 9600.
3. For Data Bits:
– Select 7 if you have an 8000 MicroBric or 8000 Bric system
– Select 8 if you have a T-Gage system (Model 100TC, 4100TC, 5100TC,
5400TC or 6100TC)
4. For Parity:
– Select Even if you have an 8000 MicroBric or 8000 Bric system
– Select None if you have a T-Gage system
5. For Stop Bits, select 1.
6. For Handshake, select XON/XOFF.
7. The USB Delay setting is only relevant for a Serial-USB connection. It sets the delay in
milliseconds after sending a parameter from a backup file to the NDC system. The default
value is 50 milliseconds. The minimum allowed value is 30 milliseconds. The higher the
USB Delay value, the longer it will take to send a backup file to the NDC system via the
Restore option. If a problem occurs when using the Restore option with a Serial-USB con-
nection, set USB Delay to a higher value, then repeat the Restore option.
8. Select Next to move to the next screen.
•
•
NDCback-Java User Guide 7/7/08 •• 9
•
•
Step 5 – Enter Name of Backup File
Figure 6 Enter Filename screen
Refer to Figure 6.
1. Type the name of the backup file in the Filename box.
Alternately, click on the Browse button, and a dialog will appear for selecting a file
(Figure 7). Navigate to the desired directory, select the file or type the name of the file in
the File Name box, then click on Open. The name of the selected file will be shown in
the Filename box in Figure 6.
Figure 7 Select File dialog
2. Select Next to move to the next screen.
•
•
10 • NDCback-Java User Guide 7/7/08
•
•
•
Step 6 – Select the Save option
Figure 8 Current Settings screen
Refer to Figure 8. The Current Settings screen shows a list of the settings that have been
entered. These settings may be edited by clicking on the Previous button to scroll back
through the previous screens.
If the displayed settings are correct, click on Save to start saving the system parameters to the
backup file.
A dialog box will display the Backup status, including the names of the recipes saved
(Figure 9). A label at the top displays the number of lines of parameters saved.
When NDCback-Java has completed saving the data, the message “Save Completed Success-
fully” is displayed. Select OK to return to the Current Settings screen (Figure 8).
•
•
NDCback-Java User Guide 7/7/08 •• 11
•
•
Figure 9 Backup Status dialog
•
•
12 • NDCback-Java User Guide 7/7/08
•
•
•
Restoring System Parameters
Once a backup file has been saved, it can be sent to the NDC system at any time to restore all
the parameters in that system. The same program, NDCback-Java, that was used to save the
backup file, is used to restore the system’s parameters.
To restore a backup file:
1. Launch the NDCback-Java program.
2. Repeat steps 1 to 5 in the Backing Up the NDC System section.
In step 5, select the name of the backup file.
3. At this stage in the program, the screen should look similar to Figure 10.
Figure 10 Current Settings screen
4. Select Restore to start sending the file to the NDC system.
A dialog box will display the program status, including the names of the recipes restored
(Figure 11). A label at the top displays the number of lines of parameters restored.
When NDCback-Java has completed restoring the data, the message “Restore Completed
Successfully” is displayed. Select OK to close the dialog box.
•
•
NDCback-Java User Guide 7/7/08 •• 13
•
•
Figure 11 Restore Status dialog
Note: 8000 TDi Systems
Before resetting power to the system, wait for the SAVE button (on the OWS) to
change from Green to Blue and the “#_ SAVE FL-BANK OK” message to appear in
the header of the OWS.
•
•
14 • NDCback-Java User Guide 7/7/08
•
•
•
Quitting NDCback-Java
To quit NDCback-Java, select Exit from the File menu, or click the X on the far right of the title
bar.
•
•
NDCback-Java User Guide 7/7/08 •• 15
•
•
Viewing the Version of NDCback-Java
To view the version of the NDCback-Java software, select Version from the File menu.
A dialog box similar to Figure 12 will be displayed.
Figure 12 Version of NDCback-Java
•
•
16 • NDCback-Java User Guide 7/7/08
•
•
•
Troubleshooting
Follow the procedures below if NDCback-Java has a problem backing up or restoring system
parameters.
Ethernet Connection
• Check that the NIC (Network Interface Card) on the PC is recognized by the oper-
ating system.
• Check that the network cables are not defective.
• Check that the network cables are securely connected.
Serial Connection
• Check the configuration of the serial cable. Refer to Figure 1.
• Check that the serial cable is connected to the HIF COM 1 port on the system chas-
sis.
Serial-USB Connection
• Check that the USB cable is recognized by the operating system, and has the latest
drivers.
• A situation may arise where the NDCback-Java program fails to restore a backup
file to the NDC system, and subsequent attempts to communicate with the NDC
system are unsuccessful. If this happens:
1. Exit the NDCback-Java program.
2. Turn power off to the NDC system, then turn power back on.
3. Restart the NDCback-Java program.
4. Set the USB Delay to a higher value.
5. Run the Restore option again.
•
•
NDCback-Java User Guide 7/7/08 •• 17
•
•
Connection Tests
Ethernet Connection
– Run the ping program to test the Ethernet connection
1. From the Start menu, select Run.
2. In the Open box, type:
ping <IP Address of NDC system>
Example
ping [Link]
If ping was successful, a response similar to the sample response below should be
received:
Reply from [Link]: bytes=32 time=2ms TTL=255
Reply from [Link]: bytes=32 time<1ms TTL=255
Reply from [Link]: bytes=32 time<1ms TTL=255
Reply from [Link]: bytes=32 time<1ms TTL=255
– Run the telnet program to test the Ethernet connection
1. From the Start menu, select Run.
2. In the Open box, type:
telnet <IP Address of NDC system> 20000
Example
telnet [Link] 20000
If telnet was successful, a telnet window should appear with the following message:
Host Interface : Initialization complete
Ok
•
•
18 • NDCback-Java User Guide 7/7/08
•
•
•
Serial Connection
Run the HyperTerminal program to test the serial connection.
1. From the Start menu, select Programs > Accessories > Communications >
HyperTerminal.
2. The Connection Description dialog will appear.
Type a name for the connection in the Name box (e.g., NDC), then click OK.
3. In the Connect To dialog, under Connect using, select the COM port on your PC that is
connected to the NDC system (e.g., COM1 or COM2), then click OK.
4. In the Port Settings box, enter the following:
• Bits per second: 9600
• Data bits: 7 if you have an 8000 MicroBric or 8000 Bric system
8 if you have a T-Gage system
• Parity: Even if you have an 8000 MicroBric or 8000 Bric system
None if you have a T-Gage system
• Stop bits: 1
• Flow control: Xon/Xoff
Then click OK.
5. In the HyperTerminal window, type:
22? <Enter> if you have an 8000 MicroBric or 8000 Bric system
52? <Enter> if you have a T-Gage system
The system should return a response that shows the model of your system.
•
•
NDCback-Java User Guide 7/7/08 •• 19
•
•
Description of Files
Backup File
Figure 13 shows a sample backup file that is saved when the Save option is selected for
NDCback-Java. This is a text file containing all system settings and recipes. This file may be
viewed or edited using any text editor program such as Notepad.
Figure 13 Parameters file saved by Save option
Log file
Each time the NDCback-Java program is run, a record of the program settings is written to the
file, [Link]. This file is stored in the same folder as the backup file that was saved or
restored. Data is appended to this file every time NDCback-Java is executed. This is a text file
that may be viewed using any text editor program such as Notepad.
Figure 14 [Link] file
•
•
20 • NDCback-Java User Guide 7/7/08
•
•
•
Information stored in the [Link] file (Figure 14) includes:
• Date and time when NDCback-Java was started
• Name of the file saved or restored
• Type of system
• Serial or Ethernet settings
• Messages displayed by NDCback-Java while saving or restoring the data, includ-
ing names of recipes saved or restored
•
•
NDCback-Java User Guide 7/7/08 •• 21
•
•
•
•
22 • NDCback-Java User Guide 7/7/08
•
•
•
APPENDIX
A Connecting a PC to the TDi Network A
Ethernet
ports on
Frame Node
Figure 1 Ethernet ports on Frame Node
1. Connect an Ethernet cable from the PC to an Ethernet port on a Frame Node (Figure 1).
2. Assign an IP Address and Subnet mask for the PC as follows:
a. Select Start > Control Panel > Network Connections > Local Area Connection.
A dialog similar to Figure 2 will be displayed.
•
NDCback-Java User Guide: Connecting a PC to the TDi Network •• A-1
•
•
•
A
Figure 2 Local Area Connection Status
b. Select Properties.
c. Under the “This connection uses the following items” box, select Internet Protocol
(TCP/IP), then select Properties (Figure 3).
Figure 3 Local Area Connection Properties
d. Click on Use the following IP address (Figure 4).
•
•
A-2 •• NDCback-Java User Guide: Connecting a PC to the TDi Network
•
•
e. Set the IP Address to:
[Link]
where xxx is any number that is not the IP Address of any of the Nodes in the
8000TDi system
Example:
[Link]
f. Set the Subnet mask to [Link].
A
g. Select OK, select OK again, then select Close.
Figure 4 Enter IP Address and Subnet mask
•
•
NDCback-Java User Guide: Connecting a PC to the TDi Network • A-3
•
•
•
A
•
•
A-4 •• NDCback-Java User Guide: Connecting a PC to the TDi Network
•
•
Contact NDC Infrared Engineering
The NDC Infrared Engineering web site is [Link]
Americas Support Desk
Tel +1-626-939-3855
Fax +1-626-939-3871
Email supportdesk@[Link]
Main +1-626-960-3300
Switchboard
Tel
European Helpdesk
Tel +44-(0)1621-841002
Fax +44-(0)1621-856180
Email helpdesk@[Link]
Main +44-(0)1621-852244
Switchboard
Tel
China Support Desk
Tel +86-(0)10-6581-2946
Fax +86-(0)10-6581-7341
Japan Support Desk
Tel +81 (0)3 3255 8157
Fax +81 (0)3 3255 8154