NCSETUP for Windows® Operating SystemTechnical Bulletin
Code No. LIT-6360251dIssued June 16, 2006
Software Release 12.04Supersedes June 21, 2004
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Hardware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Software Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Using NCSETUP for Windows OS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Multiple Modes of Operation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Starting NCSETUP for Windows OS in Normal Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Running NCSETUP Direct Connect without Knowing the Network Name . . . . . . . . . . . 8
Exiting NCSETUP Normal Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Starting NCSETUP for Windows OS in Stand-Alone Mode . . . . . . . . . . . . . . . . . . . . . . . 8
NCSETUP Stand-alone Mode Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Exiting NCSETUP Stand-alone Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Windows OS Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Main Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Toolbar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Title Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Status Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Making a Connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
NCSETUP File Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
NCM Address Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Clear First GPF Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Clear Network Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
NCSETUP Command Menu. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
NOVRAM View and Modify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
NCM Address. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
1NCSETUP for Windows® Operating System Technical Bulletin
Code Download Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Archive Device Address. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Alarm/Warning Delay Mode for AD/AI Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
NOVRAM Advanced Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Time Required to Detect a Device Offline . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
View Acquired . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Operator Terminal Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
S2 Trunk Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
LONWORKS Network Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Poll Image Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Logfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Logfile Clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
N1 Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
N1 Statistics Clear . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Task Utilization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Trace Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
First GPF Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
IP Address Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
FN Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Read Modem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Write Modem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
User-Defined Modems. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Updating MODEM.INI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
ISA Slot Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Reset NCM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Reload NCM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Set Duty/Standby Flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Reset Lowest Acquired . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
NCSETUP Advanced Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
NCSETUP for Windows® Operating System Technical Bulletin2
Update Flash . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Verifying the NCM Is Not Downloaded . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Updating the Flash Chip . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Details for Updating NCM350 Flash Code. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Debug Enable . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Switch Trace Buffer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Read Memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
View Current Acquired Memory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
NCSETUP View Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
NCSETUP Network Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Values Out of Range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Missing Supporting Image Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
NCSETUP Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
NCM Address Entry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Maximum NCM Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Window Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Tips for Using NCSETUP for Windows OS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
OK vs. Cancel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Printing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Connecting to a New NCM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
NCSETUP for Windows® Operating System Technical Bulletin 3
NCSETUP for Windows® Operating System Technical Bulletin4
NCSETUP for Windows® Operating SystemTechnical Bulletin
IntroductionNCSETUP for Microsoft® Windows® (Wncsetup) Operating System (OS) is a software utility that sets up and modifies a Network Control Module (NCM)’s Nonvolatile RAM (NOVRAM) and flash memory configuration. The NCSETUP.EXE diagnostics are replaced by WNCSETUP.EXE.
Features of NCSETUP include the standard Windows OS look and feel, a Metasys® system communications interface, and Ethernet/Internet Protocol (IP) N1 support. Like the DOS version, it provides several status and diagnostic functions. In addition, NCSETUP stores the system paths that a restarted NCM can use to call data and applications from archive files.
NCSETUP is also the utility used to select the type of NCM you want to commission (for example, which program set the NCM is to use, such as Standard, Security, or S2 Migration). To look up the various NCM software configurations that are supported for each NCM base hardware option, refer to the NCM Software Options Technical Bulletin (LIT-636023). For information about the NCM45x0-2 in particular, refer to the NCM45x0-2 Series Hardware and Software Options Technical Bulletin (LIT-12011180).
Note: Metasys system Release 10 (or later) software implements LONWORKS® technology and supports one LonTalk® trunk. If a LonTalk trunk is defined, you cannot use the N2 trunk.
This document may contain information about discontinued features or products. This information is for reference only. Beginning with Release 12.04, the following products or features are no longer supported:
• ARCNET® network communication protocol
• Initialization file parameters relating to the ARCNET protocol
Note: If you are commissioning the NCM45x0-2, you can use the Network Automation Engine (NAE) Configuration Tool (NCT) to obtain additional diagnostic information beyond what NCSETUP provides. Refer to the NAE Configuration Tool Technical Bulletin (LIT-1201990).
IMPORTANT: Throughout the document, NCSETUP refers to the Windows OS version. The software, however, abbreviates NCSETUP for Windows OS software as Wncsetup.
NCSETUP for Windows® Operating System Technical Bulletin 5
Hardware RequirementsNCSETUP for Windows OS runs in Normal mode on a configured Metasys Operator Workstation (OWS). For information on the configuration, refer to the Operator Workstation Configurations Technical Bulletin (LIT-636013d). The following are the cabling requirements. If the NCSETUP is run via:
• RS-232 (NCM200): a straight-through cable is required to connect computer/portable’s COM1 or COM2 port to the NCM RS-232 port. The cable could be 9-pin female or 25-pin female on the computer end, based on the type of computer or portable used. The NCM connection is 25 pin. The serial port on the computer or portable must be connected to the NCM integrated RS-232 port (Port 3).
RS-232 (NCM300/45x0-2): Port 3 (NCM300) or RS232C A/Port 3 (NCM45x0-2) — a null-modem cable must be used. The cable could be 9-pin female or 25-pin female on the computer end, based on the type of computer/portable used. The NCM connection is 9 pin.
• N1: N1 coax or twisted-pair cable is required to connect the computer or portable to the NCM. An ARCNET network card or Ethernet Network Interface Card (NIC) is also required. For the NCM45x0-2, the Ethernet circuitry is onboard, so no card is needed.
NCSETUP also has the ability to operate in Stand-alone mode on a computer or portable device in which the Metasys system OWS software has not been installed.
Software RequirementsNCSETUP for Windows OS is included in the Metasys system Person-Machine Interface (PMI) software.
Using NCSETUP for Windows OSThis section explains the features of NCSETUP for Windows OS, how to navigate through the program, the new organization of NCSETUP menus and parameters, and how to configure various NCSETUP sessions.
FeaturesEnhancements to NCSETUP include:
• ability to capture screens (for example, View Logfile) and paste the information into a window
• ability to run NCSETUP whether the Metasys Network is running
• commands that were previously viewed can be edited via dialog boxes. For example, the NOVRAM command now has a dialog box with editable fields that allow the user to view and modify the NOVRAM.
• faster error detection and correction
• Windows OS software with an industry-standard look and feel
NCSETUP for Windows® Operating System Technical Bulletin6
Multiple Modes of OperationNCSETUP for Windows OS has the ability to operate under two separate modes: Stand-alone mode and Normal mode. All versions of NCSETUP have the ability to operate under Normal mode. Release 12.00 NCSETUP for Windows OS has the added ability to operate in Stand-alone mode.
• Normal mode operation requires the presence of a configured OWS and allows NCSETUP to communicate with any NCM defined on the network.
• Stand-alone mode operation does not require the presence of a configured OWS and allows NCSETUP automatically to connect directly to any NCM connected to the computer via serial port.
Starting NCSETUP for Windows OS in Normal ModeTo use NCSETUP for Windows OS for operation in Normal mode:
• Metasys system software must be running
• Network Controller (NC) must be communicating with the OWS
• NC must be defined in the Metasys system database, so the communication method can be selected (N1, Dial, Direct)
Because NCSETUP for Windows OS relies on the Metasys system communication interface, it is no longer necessary to exit to DOS and reboot the machine. NCSETUP for Windows OS can run as a regular application.
To start the NCSETUP program, follow these steps:
1. If the Metasys system is not operational, start the Metasys system PMI.
2. In Microsoft Windows OS:
a. Click the Start button, and select Programs. The Programs menu appears.
b. Select METASYS to show the METASYS program group.
c. Select WNCSETUP.
When the NCSETUP program is launched, the NCM Address Entry dialog box prompts the user for information needed to set up or modify the configuration, or run diagnostics on the NCM.
Note: If the NCM is not powered up before you run NCSETUP, the NCSETUP title bar indicates that the NCM is not connected (Figure 4).
NCSETUP for Windows® Operating System Technical Bulletin 7
Running NCSETUP Direct Connect without Knowing the Network Name
Starting with Metasys system Release 9.0, NCSETUP can be run when directly connected to an NCM, even when the network name and baud rate are unknown. Prior to Release 9.0, this information had to be entered into the NET.DDL file before NCSETUP could be used. The following NET.DDL file is now used as a wildcard network name for the NCM:
@NET PORT "COM#", 2 , 19200 NET "wncsetup", "JCI Tools" NCDIRECT
This allows the tool to ignore the network name in the NCM. In addition, a switch has been added to the METASYS.INI file. The switch in the file appears as follows:
[Metasys] AutoBaudDetect=1
This allows the Metasys system to automatically detect the baud rate for rates of 4800, 9600, and 19200.
Exiting NCSETUP Normal ModeTo exit NCSETUP Normal mode, on the File menu, select Exit.
Starting NCSETUP for Windows OS in Stand-Alone ModeTo use NCSETUP for operation in Stand-alone mode:
• Release 12.00 or later Stand-alone NCSETUP for Windows OS must be installed on the computer. (Stand-alone NCSETUP can be installed by itself from a Release 12.00 or later Metasys system PMI CD. It is also installed automatically whenever the Release 12.00 or later Metasys system PMI is installed.)
• Metasys system software must not be running.
• An NCM must be connected directly to the computer via serial port. The computer COM1 or COM2 port must be connected to Port 3 of the NCM300 or the RS232C A/Port 3 of the NCM45x0-2.
IMPORTANT: The network must be named “wncsetup.”
NCSETUP for Windows® Operating System Technical Bulletin8
Stand-alone mode uses a special communication interface that does not rely on Metasys system software. When an NCM needs to be configured, a user can connect using NCSETUP in Stand-alone mode without configuring a working OWS. This approach greatly reduces the amount of time necessary to configure an NCM. NCSETUP Stand-alone mode also does not require the presence of a METASYS.INI file to store configuration information. Any pertinent configuration information is automatically stored in the Windows OS system registry.
To start NCSETUP in Stand-alone mode:
1. If the Metasys system is operational, shut down the Metasys system PMI.
2. From the Windows OS Start menu, select Programs > Metasys > WNCSETUP. The Wncsetup Communication Control application launches.
Note: The purpose of the Wncsetup Communication Control application is to gather information needed to connect to the NCM for Stand-alone mode operation. The Commands menu on the main Wncsetup Communication Control enables the user to initialize the Wncsetup Communication Setup dialog box if it was previously cancelled.
The Wncsetup Communication Setup dialog box immediately prompts the user to fill out the NC gate and node fields, select the correct computer COM port, and choose the proper baud rate (Figure 1).
Note: Auto Baud Detect is not available in Stand-alone mode. Manually select the baud rate from 9600 to 19200 baud. It is not necessary to enter a network name. You do not need a NET.DDL or METSYS.INI file.
Figure 1: Wncsetup Communication Setup Box
FIG
:com
mst
p
NCSETUP for Windows® Operating System Technical Bulletin 9
Note: Enter the correct information and press OK. The NC Communication box appears, which displays various communication information including the computer COM port number, connected baud rate, and the NCM download condition (Figure 2). The NC Communication box is titled NC Direct or NC Direct2, depending on port selection. The text in this window may change to reflect the current communication status.
After the communication software successfully establishes a connection with the NCM, the Main Wncsetup window appears (Figure 4).
Note: The NCM Address Entry Dialog Box does not appear as in Normal mode operation (seen in Figure 4). In Wncsetup Stand-alone mode, the NCM Address command is completely disabled. Wncsetup proceeds automatically to connect to the NCM using the gate and node information entered in the Wncsetup Communication Setup box (Figure 1).
When in Stand-alone mode, all commands have the same functionality as Normal mode with the exception of Collect Data. The Collect Data command is completely disabled when operating in Stand-alone mode. See Table 44 for more information on the Collect Data command.
In Stand-alone mode, Wncsetup can communicate only with the directly connected NCM.
The Wncsetup Communication Control screen automatically disappears when communication with the NC is successfully established.
NCSETUP Stand-alone Mode RestrictionsThe following restrictions apply when operating under NCSETUP Stand-alone mode:
Figure 2: NC Communication Box
FIG
:com
m
NCSETUP for Windows® Operating System Technical Bulletin10
Note: NCSETUP is limited to one instance. It is not possible to start more than one instance of NCSETUP for Stand-alone mode operation; however, multiple instances of NCSETUP can be executed when operating under Normal mode.
Exiting NCSETUP Stand-alone ModeTo exit NCSETUP Stand-alone mode, on the File menu of the main Wncsetup window, click Exit. All windows and tasks associated with Stand-alone mode terminate.
Windows OS Interface
Main WindowWhen using NCSETUP for the Windows OS, you need to be familiar with the Windows OS environment.
IMPORTANT: Shut down NCSETUP when operating under Stand-alone mode before the Metasys system PMI is started. Metasys system PMI Release 12.00 has the added functionality of automatically detecting and shutting down Stand-alone NCSETUP if it is executing when PMI is started. Metasys system PMI displays the shutdown message in Figure 3 if it detects an instance of Stand-alone NCSETUP running. Previous versions of Metasys system PMI prior to Release 12.00 are not able to automatically detect and shut down Stand-alone NCSETUP. Users with Metasys system PMI prior to Release 12.00 have to manually shut down Stand-alone NCSETUP themselves before starting PMI. Failure to shut down Stand-alone NCSETUP before starting the Metasys system PMI results in undefined errors.
Figure 3: PMI Shutdown Message
NCSETUP for Windows® Operating System Technical Bulletin 11
X
UM
tton
ors
Toolbar
CloseButton
Figure 4: Main NCSETUP Window
File Command View Help
Wncsetup - Not Connected
Read and Display NCM data N
Menu BarTitle Bar
Status Bar
Document Area
Maximize Bu
Minimize Button
Keyboard Indicat
NetworkAdvanced
NCSETUP for Windows® Operating System Technical Bulletin12
set Lowestired Memory
d
About WNCSETUP
X
ToolbarYou can access the NCSETUP for Windows OS commands either by using the Command menu or the toolbar. The toolbar contains the commands that are used most frequently (Figure 5). A brief description or ToolTip is displayed when the mouse pointer is positioned on any of the buttons.
Title Bar
The title bar of NCSETUP for Windows OS shows the current communication status, which can be either:
• WNCSETUP--Not Connected (Figure 4)
• WNCSETUP--<network name><NCM gate node > For example, in Figure 5, the network name is JCHDQTRS and the NCM gate and node numbers are 1 and 72.
When connected, the network name, NCM gate, and node values are shown. The title and status bars show the current state of operation.
Status Bar
The status bar shows the current state of NCSETUP operation. The messages displayed include:
• Sending Message: Indicates that the NCSETUP program is sending a message to an NCM.
• Receiving Message: Indicates that the NCSETUP program is receiving a message from the NCM.
• Ready: Indicates that the NCSETUP program is ready for the next command.
Figure 5: NCSETUP Toolbar
File Command View Help
Wncsetup - JCHDQTRS 1 72
New Address Information S2 TrunkParameters
N1 Statistics IP AddressConfiguration
Debug*
ResetNCM
ReAcqu
Read ModemParameters
View Acquired Logfile TraceN1 Statistics
Clear
Write ModemParameters
ReloaNCM
TaskUtilization
FNConfiguration
ISA Slot Mapping *
NOVRAMOperator
Terminal Port Logfile Clear
*Debug and ISA Slot Mapping are for internal Johnson Controls use only.
LONParameters
2
NCSETUP for Windows® Operating System Technical Bulletin 13
Making a ConnectionWhen you first open NCSETUP, the program automatically prompts you to fill in the NCM Address Entry dialog box. To start communicating with the NCM, fill out the gate and node numbers or select an entry from the list box. This box only appears when operating under Normal mode.
The Graphical User Interface (GUI) that replaces the text-based interface is explained in detail, command by command, in the following pages. The command parameters are listed in tables at the beginning of each section, followed by more detailed descriptions.
NCSETUP File MenuTo perform a command, click on the File drop-down menu and select the command.
Table 1: Format for Command Quick ReferenceParameter DescriptionCommand The menu actions to reach the command
Hot Key The keyboard shortcut used to enter a command
Button The button that can be pressed to enter a command
Purpose The purpose of the command
NCMs Lists NCMs the command is available for.
Figure 6: NCM Address Entry Dialog Box
NCM Address Entry X
FIG
:AD
DR1
Gate
Node
Network Name
View Other Addresses:
1
99
JCHDQTRS
NCSETUP for Windows® Operating System Technical Bulletin14
NCM Address Entry
The first time that NCSETUP is run on a system with software installed, the parameters are set as shown in Table 3.
When NCSETUP is run again, the NCM Address Entry dialog box lists the last referenced gate, node, and network name.
If the communication parameters are correct, select OK. NCSETUP for Windows OS checks if other required programs are running. If one or more of the required programs are missing, then an error dialog box appears. See the Errors section of this technical bulletin for details.
Note: At the bottom of the NCM Address Entry dialog box, there is a drop-down list box that lists all the NCMs on the Metasys system Network. This box is updated every time NCSETUP for Windows OS starts. If you are adding an NCM to the list, exit and return to NCSETUP for Windows OS to view the changes.
Once the OK button is pressed, NCSETUP for Windows OS attempts to connect to the specified NCM via the network.
Table 2: Format for Command Quick ReferenceParameter DescriptionCommand File menu, Address
Hot Key CTRL-A
Button
Purpose To set the address of the NCM to establish an NCSETUP connection
NCMs All
Table 3: Initial NCM SettingsParameter SettingGate 1
Node (of the NC) 99
Network Name JCHDQTRS
Table 4: NCM Address Entry ParametersParameter RangeGate 1 to 254
Node (of the NC) 1 to 254
Network Name Name length cannot exceed eight characters.
1
NCSETUP for Windows® Operating System Technical Bulletin 15
Clear First GPF Data
Clear Network Data
Table 5: Clear First GPF DataParameter DescriptionCommand Clear First GPF Data
Hot Key None
Button None
Purpose To enable the NCM to be able to store data when the next GPF occurs. After executing this command, the first GPF data for the NCM 200/300 is not readable. The NCM350 data remains readable.
NCMs All except NCM45x0-2
Table 6: Clear Network DataParameter DescriptionCommand Clear Network Data
Hot Key None
Button None
Purpose Resets (clears) the contents of the network data file.
NCMs All
NCSETUP for Windows® Operating System Technical Bulletin16
NCSETUP Command MenuTo perform a command, do one of the following:
• Click on the Command drop-down menu and select the command (Figure 7).
• Press the appropriate button on the toolbar (Figure 5).
• Use the designated hot keys shown throughout this technical bulletin.
Figure 7: Command Menu
FIG
:Com
men
2
NIV
ovram... nformation iew acquired...
OS
perator Terminal Port...2 Trunk Parameters...
LON Parameters...
LC
ogfileLogfile lear
N StatisticsN1 Statistics Clea
1r
TD
u
ask Utilization...Trace ata...First GPF Data...
FN Config ration...IP Addr ss Configuration...e
Read odem...rite Modem...
MW
ISA Slot Ma ping...p
Reset NCM...Reload NCM...
Set Duty.Standby lag...Reset Lowest Ac uired...
Fq
Ctrl+NCtrl+ICtrl+V
Ctrl+OCtrl+SCtrl+B
Ctrl+LCtrl+C
Ctrl+1Ctrl+R
Ctrl+TCtrl+D
Ctrl+ECtrl+J
Ctrl+MCtrl+W
Ctrl+P
Ctrl+JCtrl+K
Ctrl+FCtrl+Q
NCSETUP for Windows® Operating System Technical Bulletin 17
NOVRAM View and Modify
The following sections describe the fields found on the NOVRAM View and Modify dialog box.
Table 7: NOVRAM View and ModifyParameter DescriptionCommand Command menu, NOVRAM
Hot Key CTRL-N
Button
Purpose To view the current status of the NCM NOVRAM. The NOVRAM parameters can be modified and updated.
NCMs All
Figure 8: NOVRAM View and Modify Dialog Box
2
NCSETUP for Windows® Operating System Technical Bulletin18
NCM AddressThe top portion of the NOVRAM View and Modify dialog box contains NCM address information. For the ranges of the gate, node, and network name values, see the NCM Address Entry section of this document.
Code Download Types
NCMs can be downloaded with different device code types. Table 8 shows all of the options for each NCM.
Archive Device AddressYou can specify which OWS downloads the NCM in the Archive Device Address section. Certain fields under the Port section may be grayed out depending on the NCM type.
IMPORTANT: If you changed the NC node address and the Reboot on DownLoad Error flag is checked, the NC reboots. If that flag is clear, you need to cycle power or manually reset the NC for the change to take effect.
Table 8: Code Download TypesParameter DescriptionNCM350 Standard, Fire, Security, Migration, JC/85 Gateway,
Operator Terminal (OT), Network Port1, General with NT1, General with OT1, UL 864 Fire
1. Requires a minimum of 4 MB of acquired memory.
NCM300 Standard, Fire, Security, Migration, JC/85 Gateway, Operator Terminal (OT), Network Port1, General with NT1, General with OT1, UL 864 Fire
NCM200 Standard, Fire, Security, Migration, JC/85 Gateway, Operator Terminal (OT), Network Port, General with NT, General with OT
NCM101 Standard, Lighting Control, System 91, Fire
NCM401 Standard, Lighting Control, System 91, Fire, Migration, JC/85 Gateway
NCM45x0-2 General with NT, General with OT
Table 9: Archive Device Address ParametersParameter RangeArchive Gate 1-254
Archive Node 1-2541
1. If the selected NCM is a Fire-Net NCM, the node field must be between 70-79. If you enter a node number that is outside of this range for a Fire-Net NCM, a Warning dialog box appears.
Network Name Name limited to eight characters (not case sensitive)
IP Address Fields are selectable only if the archive NCM is set up on the Ethernet/IP N1.
Port Indicates the download media. See Table 8 for available types.
NCSETUP for Windows® Operating System Technical Bulletin 19
Port 5. 0, 57600; 550AF ) card.on the port.
IP
NCM350NCM45x0-2
Table 10 shows connections and port dependencies that NCSETUP follows in allowing Archive Device Address configuration (Port 4 excluded). The configuration entered by the user is checked against the information in the table. If the port is a possible dial port, the Check if Dial entry becomes active, and the dial data can be entered.
Note: If there is a discrepancy between the Port 3 (RS232C A/Port 3) Baud Rate defined in the Archive Device Address section and the Port 3 (RS232C A/Port 3) Baud Rate defined on the bottom of the NOVRAM View and Modify dialog box, the one on the bottom of the dialog box is used.
To change the Archive Address from ARCNET or IP to serial or dial port:
1. Select Port 2 or Port 3 (RS232C A/Port 3 only for NCM45x0-2).
2. Enter the Archive Device Address of the NCM gate and node.
3. Select the port a second time to enable the Port Baud Rate and dial settings.
4. Enter the Port Baud Rate and dial settings if applicable.
Note: For the NCM45x0-2 only, do not select 28800 for the baud rate of RS232C B/Port 5. This baud rate is not supported.
Table 10: NCM Connection/Port Dependencies (Excluding Port 4)Connection Type
Port 21
1. Ports 2 and 3 allow the following baud rates: 1200, 2400, 4800, 9600, 19200.
Port 31 orRS232C A/Port 32
2. The RS232C A/Port 3 on the NCM45x0-2 is equivalent to Port 3; RS232C B/Port 5 is equivalent to
Port 53,4 orRS232C B/Port 52
3. Ports 5 and 6 allow the following baud rates: 1200, 2400, 4800, 9600, 14400, 19200, 28800, 3840however, for the NCM45x0-2 only, do not use 28800 baud. If you are using a serial card, use a 16(16 character First-In, First-Out [FIFO] support) Universal Asynchronous Receive Transmit (UART
4. An unconfigured device can be connected to Ports 5 and 6 if there is a configured device defined
Port 63,4 ARCNET
OWS Direct NCM101NCM200NCM300NCM350
NCM101NCM200NCM300NCM350NCM45x0-2
NCM350NCM45x0-2
NCM350
OWS Dial NCM350 NCM350NCM45x0-2
NCM350NCM45x0-2
NCM350
OWS Unconfigured
NCM350NCM45x0-2
OWS N1 NCM101NCM200NCM300NCM350
NCSETUP for Windows® Operating System Technical Bulletin20
Alarm/Warning Delay Mode for AD/AI ObjectsThe Analog Data (AD) and Analog Input (AI) objects have a Delay field. The Warning Delay mode is the default selection (defined in minutes) that delays Warning Change-of-State (COS) reporting but not Alarm COS reporting. The Alarm Delay mode (defined in minutes) delays both Warning and Alarm COS reporting. The entry field is from 0 to 255. All AD/AI software objects defined for this NCM interpret the delay field in minutes according to the selection made in the NOVRAM View and Modify dialog box (Figure 8). For more information on the Alarm/Warning Delay modes for AD and AI objects, refer to the Analog Input (AI) Object Technical Bulletin (LIT-636080) or the Analog Data (AD) Object Technical Bulletin (LIT-636078).
Note: The Alarm Delay option is supported only on NCM200, NCM300, and NCM45x0-2 Series. NCM 101/102/401 support Warning Delay only.
NOVRAM Advanced SettingsTable 11 describes the various fields found in the Advanced Settings -- NOVRAM dialog box. To access this screen, you must set the Debug parameter to yes in the WNCSETUP section of the METASYS.INI file. Refer to the Initialization Parameters Technical Bulletin (LIT-636345) for more information.
Figure 9: NOVRAM - Advanced Settings Box
FIG
:NO
VRA
MA
d
NCSETUP for Windows® Operating System Technical Bulletin 21
Note: For the NCM45x0-2, the NCM Type field on this screen indicates NCM350.
Time Required to Detect a Device Offline
Table 12 explains the time delays in online/offline reporting as a function of the NM Status Update Threshold. The value of Messages Missed Before Being Considered Offline is the NM Status Update Threshold. The values in the table are read minimum to maximum time in minutes:seconds. Choose a higher number of missed messages to compensate for poor line quality. The NM Status Update Threshold must be consistent throughout the network (across all computers and NCs).
Table 11: NOVRAM Advanced SettingsParameter DescriptionAcquired Memory Size A scratch pad area for communications between tasks
Reset Demand Limiting Load Rolling (DLLR) on Warmstart
Load signup after NCM powerfail
NCM Clock Source Applies to the NCM200 or later. Use either 60 Hz from the power source or the crystal in the NC. For the NCM45x0-2, select Crystal. If you select Frequency, Crystal is used anyway, since the Frequency source type is not available.
Transmit Timeout Value Never modify these parameters; doing so adversely affects N1 communications.
Transmit Retry Count Never modify these parameters; doing so adversely affects N1 communications.
Reply Timeout Never modify these parameters; doing so adversely affects N1 communications.
Hardware Timeout Never modify these parameters; doing so adversely affects N1 communications.
RK Ack Timeout is Never modify these parameters; doing so adversely affects N1 communications.
NM Status Update Timer This timer is not supported. Leave it at its default setting of 2. This setting gives a broadcast interval of 1 minute.
NM Status Update Threshold The number of Status Update messages that must be missed (consecutively) before considering a node to be offline.To modify this parameter, the following line must be added to the METASYS.INI file:NMStatUpdThreshold=The valid range is 1-15.
Table 12: Time Required to Detect a Device Is OfflineBroadcast Interval (min)
Messages Missed Before Considered Offline Maximum IP Connected Nodes
[2]1
1. Default value.
3 4 5
[1:00]1 [2:00-4:00]1 3:00-5:00 4:00-6:00 5:00-7:00 [100]
NCSETUP for Windows® Operating System Technical Bulletin22
X
CAP
Information
The NCM information reported in Figure 10 is a function of the NC type and consists of:
• general network identification
• NCM identification
• memory information
• any internal testing run by the NCM
Table 13: Information Quick ReferenceParameter DescriptionCommand Command menu, Information
Hot Key CTRL-I
Button
Purpose To retrieve general information regarding the NCM, such as NC state, runtime, memory information, self-test, and idle time.
NCMs All
Figure 10: Information Output Screen
File Command View Help
Wncsetup - JCHDQTRS 1 72
Ready
Information data for: JCHDQTRS 1 72 0, 03/26/2006 14:13:03
NCM350 with 4 Megabytes of DRAM; Battery status = GoodEPROM release 802 DRAM release C04Current NC state: operationalRuntime is 535 daysTotal available allocable memory is 1884838Initial available allocable memory is 2200000Lowest available allocable memory is 1883326Total available acquire memory is 291534Initial available acquire memory is 300000Lowest available acquire memory is 247334The internal loopback test on port 1 (quart channel A) passedThe internal loopback test on port 2 (quart channel B) passedThe internal loopback test on port 3 (quart channel C) passedThe internal loopback test on port 4 (quart channel D) passedThe sanity timeout test passedThe clock/calendar chip test passedThe arcnet test failedThe minibos test passedThe romdos test passedThe romdisk test passedNCM current idle time 84.2
Network
2
Advanced
3
NCSETUP for Windows® Operating System Technical Bulletin 23
Note: The ARCNET test for an NCM with Ethernet always fails, because no ARCNET components are used for this type of NCM.
Note: For the NCM45x0-2, the following lines in the body of the Information Output Screen contain the following values:
1st line: shows NCM350 as the NCM model, not NCM45x0-2.
2nd line: shows an EPROM release number of 000
14th line: may show that the internal loopback test on port 4 failed (acceptable, as there is no Port 4 on this NCM)
Last line: shows an idle time that may be higher than would be reported by an NCM300 Series model when running the same database, which is due to greater processing bandwidth on the NCM45x0-2.
View Acquired
This command allows you to view the NCM acquired memory after reset.
If this command fails because there is no data to display, NCSETUP responds with the following window:
Note: For the NCM45x0-2, use the NCT to obtain NCM acquired memory information. Refer to the NAE Configuration Tool Technical Bulletin (LIT-1201990).
Table 14: View Acquired Quick ReferenceParameter DescriptionCommand Command menu, View Acquired
Hot Key CTRL-V
Button
Purpose To view the acquired memory information
NCMs NCM200 and NCM300
4
Figure 11: NCSETUP Windows OS Application Dialog Box
Ncsetup Windows Application XX
FIG
:vew
OK
There is no Acquired Memory data to display!
NCSETUP for Windows® Operating System Technical Bulletin24
ort 6
CM300CM350
Operator Terminal Port
The Operator Terminal (OT) port command is available only if the download code type General with OT is selected in the NOVRAM settings. The default OT port is 4, direct connect.
The OT can be connected on Ports 2, 3, 4, 5, or 6 for the NCM300 and NCM350. For the NCM45x0-2, the OT can use either Port 3 (connect to RS232C A/Port 3) or Port 5 (connect to RS232C B/Port 5). Other NCs allow Ports 2, 3, or 4. See Table 16.
Table 15: Operator Terminal Quick ReferenceParameter DescriptionCommand Command menu, Operator Terminal Port
Hot Key CTRL-O
Button
Purpose To set the port for the Operator Terminal connection
NCMs OT NCM
Table 16: NCM Connection/Port Dependencies for the OTConnection Type Port 2 Port 3 or
RS232C A/Port 31
1. RS232C A/Port 3 on the NCM45x0-2 is equivalent to Port 3; RS232C B/Port 5 is equivalent to Port 5.
Port 42
2. Port 4 does not allow for connections with modems.
Port 5 orRS232C B/Port 51
P
Operator Terminal NCM200NCM300NCM350
NCM200NCM300NCM350NCM45x0-23
3. The OT baud rate for the NCM45x0-2 must be set for 9600 bps only.
NCM101NCM200NCM300NCM350
NCM300NCM350NCM45x0-23
NN
OT Dial NCM200NCM300NCM350
NCM300NCM350NCM45x0-23
4
4. Internal Plug and Play modems are not recommended for use with NCM300/350 Series devices.
4
Figure 12: Operator Terminal Port Configuration Dialog Box
Operator Terminal Port Configuration X
FIG
:otc
onfig
Cancel
OKPort 2
Port 3
Port 4
Port
Check if DialPort 5
Port 6
For NCM45x0-2:- Select Port 3 for RS232C A- Select Port 5 for RS232C B
5
NCSETUP for Windows® Operating System Technical Bulletin 25
The allowed connection baud rates for all NCMs except the NCM45x0-2 are 1200, 2400, 4800, 9600, and 19200 for all ports. For the NCM45x0-2 only, the OT baud rate must be set for 9600. Select the baud rate from the NOVRAM View and Modify or the Archive commands of NCSETUP for Windows OS.
Note: When using a modem, the connection speeds refer to the NCM modem connection speed, and not the actual communication speed dictated by the modems.
S2 Trunk Parameters
The S2 Trunk Parameters window shows which parameters can be set for the Migration NCM. There are no restrictions on the parameters’ ranges; however, adjusting these parameters too high affects S2 performance characteristics. If the S2 parameters cannot be read, a label at the bottom of the window reads: Unable to read parameters. NC must be downloaded first.
Table 17: S2 Trunk Parameters Quick ReferenceParameter DescriptionCommand Command menu, S2 Trunk Parameters
Hot Key CTRL-S
Button
Purpose To set up the S2 trunk parameters for a Migration NCM
NCMs Migration NCM
Figure 13: S2 Trunk Parameters Dialog Box
S2 Trunk Parameters X
FIG
:s2tru
nkpa
ram
The S2 transmit retry count is 4
The S2 reply timout is 20 ticks of 50 msecs
The S2 delay between polls is 6 ticks of 50 msecs
CancelOK
7
NCSETUP for Windows® Operating System Technical Bulletin26
LONWORKS Network Parameters Table 18: LONWORKS Network Parameters Quick ReferenceParameter DescriptionCommand Command menu, LONWORKS Parameters
Hot Key CTRL-B
Button
Purpose To set up the LONWORKS network parameters used to initialize the LONWORKS network interface board
NCMs NCM300/350/45x0-2
Figure 14: LONWORKS Parameters
LonWorks Parameters
FIG
:LO
N-D
lg
Maximum Poll Image Size (*32KB) Time to Live (sec.)(temporary NV in Poll Image)
Application Input Buffer Count Application Output Buffer Count
Network Input Buffer Count Network Output Buffer Count
Network Buffer Size (bytes) Non Group Timer (msec)
Subnet ID Node ID
Domain ID (hex)Domain Length (bytes)
Set Defaults
2
3 3
2 2
66 128
35
1 1
0 000000000000
CancelOK
Fully BoundUnbound Bound
Binding Mode
NCSETUP for Windows® Operating System Technical Bulletin 27
Maximum
—
8 (= 256)
Forever
255
127
6
ing tool. The m start (system
N/A
ron chip (a ful buffer vice has and
15
15
15
15
15
15
Table 19 explains the LONWORKS parameters:Table 19: LONWORKS ParametersParameter Description Default
ValueMinimum
Binding Mode If LONWORKS network is bound by tool, make sure that you use Field Devices Bound or Fully Bound. Options are Unbound, Bound (only field devices are bound), and Fully Bound. (Field devices and NCM get address from tool.)
Unbound —
Maximum Poll Image Size Maximum amount of allocated memory to be consumed in increments of 32 K.
2 1 (= 32 K)
Time to Live For temporary Network Variables (NVs) in Poll Image cache1. A temporary NV is deleted when it has not been read in this time. Value range: 0, 10, 35, 60 minutes, 2, 5, 10 hours, or ∞
0 = NeverNo temporary NVs are created.∞ = ForeverTemporary NVs are never deleted (except during warm start or if device goes offline).
1. Refer to the LONWORKS Network Layout Technical Bulletin (LIT-1162150) for details.
35 seconds Never
Subnet ID3 The second level of the LonTalk domain/subnet/node addressing hierarchy
1 1
Node ID3 The third level of the LonTalk domain/subnet/node addressing hierarchy
1 1
Domain Length3 Length in bytes of the domain 0 0
Domain ID2 3
2. Length of this parameter is determined by the domain length parameter.3. These parameters are disabled in fully bound mode because they are expected to be set by a bind
values shown in this mode are the values the NCM read from the LONWORKS board during its warreset). Use this feature to check the address that the NCM actually uses.
The top level of the LonTalk domain/subnet/node addressing hierarchy 3
0 N/A
Network Buffer Size4
4. These parameters override any settings a binding tool may write into the LONWORKS board’s Neubinding tool cannot determine which communication load the NCM has, so it cannot determine usesettings). For field devices, the binding tool can determine how many binding connections each decan make a reasonable determination of the device’s communication needs.
Size for input and output network buffer in Neuron® chip
11(= 66 Bytes)
0
Network Input Buffer Count4
Number of input network buffer in Neuron chip
3(= 2 Buffers)
0
Neuron Network Output Buffer Count4
Number of output network buffer in Neuron chip
3(= 2 Buffers)
0
Neuron Application Input Buffer Count4
Number of application input buffer in the Neuron chip
4(= 3 Buffers)
0
Neuron Application Output Buffer Count4
0
Neuron Non Group Timer4 0
NCSETUP for Windows® Operating System Technical Bulletin28
Poll Image ParametersThe poll image is a cache allocated from NCM memory that stores Network Variable (NV) values polled from field devices. When it needs a value for a certain NV, the NCM firsts checks whether the value is already stored in the poll image. If so, it retrieves the value from the poll image (cache hit). If not, it goes out onto the LONWORKS network and polls the device containing the NV (cache miss). The poll image stores permanent NVs and temporary NVs.
• Permanent NVs are mapped to software objects (such as a Binary Input [BI]) that must always be polled to check for changes-of-state. Permanent NVs remain in the poll image as long as the software object exists.
• Temporary NVs are stored in the poll image only as needed, for example, when the user opens a Focus window for an Analog Input (AI) object mapped to an NV. Only the first read message to this NV has to go out onto the network causing the requesting Focus window to wait for the relatively slow network to answer. Once read, the NV value is stored in the poll image so that further read messages from the Focus window and other tasks can be answered directly from the cache.
The Time to Live parameter determines how long temporary NVs are held in the poll image before being deleted. Each cache hit resets the NV’s Time to Live timer. Regular polls with a poll time lower than the Time to Live parameter keep an NV in the poll image as long as it is polled.
A background task in the NCM continuously polls devices to ensure that NVs in the poll image contain the most recent values.
The two parameters affecting the poll image (Maximum Poll Image Size and Time to Live) can be modified if you suspect performance problems with the NCM. Note, however, that judging performance is not straightforward but improves as you gain experience with the LONWORKS network. The main performance indicator available on the OWS is the Diagnostics - LONWORKS Statistics window, which you open by selecting a LONWORKS NCM from the Devices PC Group, then selecting LONWORKS Statistics in the Network Map - Diagnostics dialog box that appears. The LONWORKS Statistics window displays a row of diagnostics for the selected LONWORKS NCM, as shown in Table 20.
Note: The statistics show the number of Cache Hits/Misses and the number of Permanent/Temporary Network Variables in the poll image. The Poll Cycles show the time it took to poll NVs of each priority, which is displayed as a count of system ticks, where one system tick is 50 ms long.
Table 20: LONWORKS StatisticsCache Hits Misses
Network Variable Poll Cycle (* 50 ms)
Permanent Temporary Prio 1 Prio 2 Prio 3
32345 12374 112 5 6 23 56
NCSETUP for Windows® Operating System Technical Bulletin 29
A second source of diagnostic information is the Error Log for the LONWORKS NCM. In particular, an error message is written to the error log whenever the poll image becomes full. The following table presents a few general guidelines for improving performance.
Logfile
The Logfile window reports in a table the following information for each call to the NC Logfile function:
• Count
• Log Error
• Information
• Task name and ID
• Time
If a task ID is not known to NCSETUP, the string UNKNOWN is displayed. The task ID, however, is listed in the parenthesis following the string with the rest of the known task IDs.
If the time variable does not initialize by the time information is logged, the string NOT INITIALIZED appears in the time column.
Table 21: Guidelines for Improving Poll Image PerformanceStatistics Indicator Poll Image Parameter to AdjustError Log shows that the poll image becomes full very often.
Increase the Maximum Poll Image Size, or decrease the Time to Live if the number of temporary NVs is significantly larger than the number of permanent NVs.
Large number of Cache Misses compared to Cache Hits.
Increase the Time to Live.
Poll Cycle times are too long for all priorities.
Decrease the Time to Live. This helps only if there are a significant number of temporary NVs in the poll image.
Table 22: Logfile Quick ReferenceParameter DescriptionCommand Command menu, Logfile
Hot Key CTRL-L
Button
Purpose To view the logfile of the NCM
NCMs All
8
NCSETUP for Windows® Operating System Technical Bulletin30
X
NUM
Logfile Clear
Note: The information found in the logfile before issuing the Logfile Clear command is shown in Figure 16. If the logfile is read soon after clearing the file, the window looks like Figure 17.
Table 23: Logfile Clear Quick ReferenceParameter DescriptionCommand Command menu, Logfile Clear
Hot Key CTRL-C
Button
Purpose To clear the NCM logfile and allow for additional log information to be recorded
NCMs All
Figure 15: Logfile Screen Dump
File Command View Help
Wncsetup - JCHDQTRS 1 85
Ready
Logfile data for : JCHDQTRS 1 85 0, 05/15/96 14 : 59 : 21
Number Error Arg Task Date/Time____________________________________________________________________________________
001 0181 0 INITIALIZATION(28)002 0181 1 TOD_TASKID(40) 5/15/96 11 : 32 : 50
Network
2
Advanced
9
NCSETUP for Windows® Operating System Technical Bulletin 31
X
NUM
N1 StatisticsTable 24: N1 Statistics Quick ReferenceParameter DescriptionCommand Command menu, N1 Statistics
Hot Key CTRL-1
Button
Purpose Read and display N1 statistics.
NCMs Any
Figure 16: Logfile Clear Screen
File Command View Help
Wncsetup - JCHDQTRS 1 85
Ready
Logfile data for : JCHDQTRS 1 85 0Number Error Arg Task Date/Time____________________________________________________________________________________
Network
2
Advanced
NCSETUP for Windows® Operating System Technical Bulletin32
N1 Statistics Clear
Task Utilization
After successfully reading the requested information and saving it to the file, you can view the file using the View menu.
Table 25: N1 Statistics Clear Quick ReferenceParameter DescriptionCommand Command menu, N1 Statistics Clear
Hot Key CTRL-R
Button
Purpose Clear N1 statistics.
NCMs Any
Table 26: Task Utilization Quick ReferenceParameter DescriptionCommand Command menu, Task Utilization
Hot Key CTRL-T
Button
Purpose To retrieve the task utilization information from an NCM, either as a one-time request, or at a periodic time interval
NCMs All except NCM45x0-2
Figure 17: Task Utilization Dialog Box
Task Utilization Parameters X
FIG
:tsk1
Length of period in seconds(minimum of 15 seconds)
60
Number of periods 1
Cancel
OK
10
NCSETUP for Windows® Operating System Technical Bulletin 33
X
NUM
7788
07
01
Figure 18: Task Utilization Data Screen
File Command View Help
Wncsetup - JCHDQTRS 51 51
Ready
Utilization data for JCHDQTRS 51 51 0, 04/08/96 15:41:10 Period: 0task count = 86 idle count = 2212323013 seconds counter = 16051
DATA_LINK_MGR (6)N2_COM2 (69)UDP_TX_TSK(131)RTIP_TIMER_TID(132)XM_HW_MGR(35)HDW_POLLER_TASK(104)PSEUDO_AD_POLL_TASK(70)DCDR_OBJ_MGR(98)LCD_OBJ_MGR(37)DIRECTORY_MGR(27)IO_DISPATCH(13)PIDL_OBJ_MGR(49)BI_OBJ_MGR(43)AI_OBJ_MGR(33)ACM_TASK(29)L2_XMIT1(77)L2_TASKCMD1(81)L2_SMIT2(78)L2_TSKCMD2(82)MC_OBJ_MGR(119)JCB_INTERPRETER(25)
tics=24783tics=0tics=21716tics=5082tics=0tics=17899tics=6051tics=2902tics=3tics=5549tics=5113tics=0tics=245tics=1968tics=112tics=0tics=0tics=0tics=0tics=1tics=0
N1_LOADER(11)N2_COM1(68)UDP_GET(130)RTIP_IPTASK_TID(133)PID_OBJ_MGR(42)PSEUDO_BDMSSD_POLL_TASK(71)PSEUDO_OBJ_MGR(73)N2O_OBJ_MGR(97)DSC_OBJ_MGR(83)NODE_MANAGER_TASKID(41)BO_OBJ_MGR(31)CSG)OBJ_MGR(96)AO_OBJ_MGR(38)LCG_OBJ_MGR(72)CS_OBJ_MGR(84)L2_COM1(75)L2_POLLER1(79)L2_COM2(76)\L2_POLLER2(80)JCB_NC_OBJ_MGR(26)JCB_SCHEDULER(24)
tics=537tics=664tics=135tics=135tics=39tics=972tics=138tics=167tics=2tics=187tics=144tics=242tics=114tics=0tics=1tics=0tics=0tics=0tics=0tics=8tics=2
Network
2
Advanced
NCSETUP for Windows® Operating System Technical Bulletin34
Trace Data
The amount of trace data information is based on the available NCM memory.
If the Trace Data command fails because the NCM has not rebooted, NCSETUP responds with an error dialog box.
Table 27: Trace Data Quick ReferenceParameter DescriptionCommand Command menu, Trace Data
Hot Key CTRL-D
Button
Purpose To save the trace data for the NCM to a file (TRCx.lst) in Error Log directory, where x = NC number
NCMs NCM200, NCM300, and NCM350
Figure 19: Read Trace Data Dialog Box
Wncsetup XX
FIG
:trac
nonOK
No RTOS386 Trace Data - NCM has not rebooted!
12
NCSETUP for Windows® Operating System Technical Bulletin 35
First GPF Data
IP Address Configuration
Table 28: First GPF DataParameter DescriptionCommand Command menu, First GPF Data
Hot Key none
Button none
Purpose To retrieve the important data at the time of the first general protect violation. The NCM200 and NCM300 stores information that stays intact until the NCM is reloaded or running in the download state. The NCM350 stores the data to flash. The data stays intact until it is overwritten. The command saves the First GPF Data for the NCM to a file (GPFx.lst) in Error Log directory, where x=NC number.
NCMs NCM200, NCM300, and NCM350Note: For the NCM45x0-2, this data is stored in debug log
files. To retrieve these files, refer to the NAE Configuration Tool Technical Bulletin (LIT-1201990).
Table 29: IP Address Quick ReferenceParameter DescriptionCommand Command menu, IP Address Configuration
Hot Key CTRL-E
Button
Purpose To set the IP Address parameters to allow communication on the Ethernet/IP N1. The M5 Multinetwork feature uses the UDP Port Address to isolate and distinguish between Metasys system N1 Ethernet networks.
NCMs NCMs on the IP network
Figure 20: No GPF Data Dialog Box
XX
OK
No GPF Data !
Figure 21: GPF DataDialog Box
XX
OK
GPF Data Storage is Complete!
11
NCSETUP for Windows® Operating System Technical Bulletin36
This feature allows the user to edit the settings of the IP address configuration that the NCM needs to connect to an IP network.
Note: When configuring the NCM300 or NCM45x0-2 Series controllers for the first time, do not leave the Network Router setting blank. If you save this screen with an empty Network Router address, NCSETUP reports Invalid Node when trying to reestablish communication with the device. You then need to reset the NCM to its factory defaults and reenter the NOVRAM settings. If your network does not use a router, reserve an address for use in the network router address fields which is valid for the network segment and subnet mask entries. For example, if the IP address is 10.10.10.1 and the subnet mask is 255.255.255.0, a network router address of 10.10.10.254 is valid, which is within the same segment space as the IP address.
The Broadcast Type option specifies the broadcast type for the NCM. It is recommended but not required that all nodes on a Metasys system Network use the same broadcast mechanism. If the broadcast type is not specified or is not a valid broadcast type in the METASYS.INI file, the Broadcast Type portion of the IP Address Settings dialog box (Figure 22) is grayed out. The default Broadcast Type is All Ones.
To change the broadcast type, shut down the Metasys system and open the METASYS.INI file in Microsoft Wordpad, Notepad, or similar text editor. Add one of the following lines of text, depending on whether you want to specify All Ones, Network Directed, or None as the Broadcast Type:
• Broadcast_type=Allones
• Broadcast_type=Directed
• Broadcast_type=None
Figure 22: IP Address Settings Dialog Box
IP Address Settings X
FIG
:ipad
dr
IP Address
Subnet mask
Network router
192
255
192
9
255
9
205
255
205
51
0
2
Broadcast Type
Network Directed
None
All OnesUDP Port Address:[2050-65535]
11001
NCSETUP for Windows® Operating System Technical Bulletin 37
Save and close the METASYS.INI file and restart the Metasys system. The IP Address Settings dialog box should now show the set Broadcast Type. See Table 30 for a description of the different Broadcast Types.
FN Configuration
This command is exclusive to the Fire-Net NCM and deals with the Metasys Intelligent Fire Network (FN) topology and port settings. All the Fire-Net NCMs on the FN must have the same FN Style. Use the High Threshold setting for each port because of its superior noise rejection, unless weak signal levels require the use of the Low Threshold. Ports A and B can be set independently of each other.
Table 30: Broadcast TypesBroadcast Type DescriptionAll Ones An IP message is sent to IP Address 255.255.255.255 so the
message is seen by all nodes on the IP network. This message is sent as a broadcast message. All nodes on the network decode and act on this message. This is the default if not specified in METASYS.INI.
Network Directed An IP address is sent that only broadcasts on a single IP network domain. The host portion of the destination IP address is set to all ones while the network portion is sent to a specific network address. This message is sent as a broadcast message. Only nodes defined on the specified network decode and act upon the message.
None No broadcast messages are used.
Table 31: FN Configuration Quick ReferenceParameter DescriptionCommand Command menu, FN Configuration
Hot Key CTRL-F
Button
Purpose To set up the FN style and port threshold
NCMs Fire-Net NCM (NU-NCM300-FIRE)
Figure 23: FN Configuration Dialog Box
FN Configuration X
FIG
:FN
CON
FIG
High
High 4
Low
Low 7
Port A Threshold
Port B Threshold FN UL Style
13
NCSETUP for Windows® Operating System Technical Bulletin38
Read Modem
The purpose of the Read Modem command is to retrieve a modem’s active profile, Profile 0, Profile 1, and the stored phone numbers. The active profile should match the stored Profile 0 if the modem has been initialized properly.
When selecting this command, NCSETUP waits 10 seconds for the Read Modem operation to take place.
Note: The command does not work if the port that is interrogated is in use. The Hayes® Improved Escape Sequence with Guard Time feature cannot be used because of conflicts with the running protocol. In general, the Read and Write commands fail unless the HS, AA, MR, and TR Light-Emitting Diodes (LEDs) on the modem are on, indicating that the modem is operational and the NCM is connected to it.
In some cases, reading from a modem requires defining a dial connection on the port you are trying to read. For example, if you want to read the modem parameters on Port 6, the local Metasys system database must have a definition for a DIAL-PC, DIAL-PRINTER, or the NC must expect a DIAL-OT. In this case, the NC must be downloaded.
Table 32: Read Modem Quick ReferenceParameter DescriptionCommand Command menu, Read Modem
Hot Key CTRL-M
Button
Purpose To read the profile of the modem on the specified port
NCMs NCM200, NCM300, NCM350, NCM45x0-2Note: NCM200, NCM300 and NCM45x0-2 must be
downloaded.
Figure 24: Read NCM Modem Profile Dialog Box
Read NCM Modem Profile X
FIG
:radn
cm
Cancel
OK
Port 2
Port 3
Port 5
Port 6
Modem Port
Modem Command
AT&V
For NCM45x0-2:- Select Port 3 for RS232C A- Select Port 5 for RS232C B
14
NCSETUP for Windows® Operating System Technical Bulletin 39
The ports that are available on the screen are 2, 3, 5, and 6. For the NCM45x0-2, only Port 3 (RS232C A/Port 3) and Port 5 (RS232C B/Port 5) are supported. Also, the availability to select a port is a function of the NCM type. See the NOVRAM View and Modify section for details.
Write Modem
Note: For the NCM45x0-2, only Port 3 (RS232C A/Port 3) and Port 5 (RS232C B/Port 5) are supported.
Changes to this operation have been made for Metasys system Release 11.00 or later. Figure 25 shows a drop-down box. Selecting the drop-down box produces a list of approved modems supported from the NCM. User-defined modem is the last modem listed. Select the modem brand that matches the modem connected to this NCM. After selecting OK, the setup string for the desired modem is sent.
The Modem Port is a function of the NCM type. When selecting this command, NCSETUP waits 10 seconds for the Write Modem operation to take place.
Table 33: Write Modem Quick ReferenceParameter DescriptionCommand Command menu, Write Modem
Hot Key CTRL-W
Button
Purpose To write a command string to the modem on a specified port
NCMs NCM200, NCM300, NCM350, NCM45x0-2Note: NCM200, NCM300, NCM45x0-2 must be
downloaded.
Figure 25: Write Modem Profile Dialog Box
Write NCM Modem Profile X
FIG
:wrte
NCM
Cancel
OKPort 2
Modem Port
Select Modem
(Brand Name)
Port 3
Port 5
Port 6
For NCM45x0-2:- Select Port 3 for RS232C A- Select Port 5 for RS232C B
15
NCSETUP for Windows® Operating System Technical Bulletin40
Note: The command does not work if the port that is interrogated is in use. The Hayes Improved Escape Sequence with Guard Time feature cannot be used because of conflicts with the running protocol. In general, the Read and Write commands fail unless the HS, AA, MR, and TR LEDs on the modem are on, indicating that the modem is operational and the NCM is connected to it.
In some cases, writing to a modem requires defining a dial connection on the port to which you are trying to write. For example, if you want to write to the modem parameters on Port 6, the local Metasys system database must have a definition for a DIAL-PC, or DIAL-PRINTER, or the NC must expect a DIAL-OT. In this case, the NC must be downloaded.
User-Defined Modems
If a brand being used is not listed under the Select Modem drop-down box, you can add it to the list by defining the new modem in the MODEM.INI file. This file is located in the same directory as the METASYS.INI file.
Under the [WNSETUP] section, find the User-Defined Modem entry as shown below. Create a new modem string definition by following the same format as the other modem definitions. The first line contains an asterisk followed by the modem name. The second line contains the modem initialization string.
[WNCSETUP]
*ZOOM 56k External
AT&FE0V0X3M1W0S0=1S109=0&C1&D2&Q5&W0&Y0
.
.
*Practical Peripherals PM144MT II External
AT&FE0V0X3M1W0S0=1&C1&D2&Q5&W0&Y0
*UserDefined Modem
REPLACE THIS LINE WITH YOUR STRING
.
.
.
While editing this section, remember to insert the new modem to keep a User-Defined modem line displayed in the Write list box. After creating the new modem, go back to the Write Modem operation. The new modem name should appear along with User-Defined.
NCSETUP for Windows® Operating System Technical Bulletin 41
Updating MODEM.INIOccasionally, a new modem supported by the Metasys system software becomes available and is announced on the Portal site. To update a particular customer, copy the entire MODEM.INI from the Portal and replace the present MODEM.INI on the Metasys system Release 11.00 or later job site. Remember, any user defined modem is lost during the updating process. Follow the procedure (located in the User-Defined Modems section) again to add a unique modem not supplied in the MODEM.INI file from the Portal.
ISA Slot MappingNote: The NCM45x0-2 has no ISA slots; do not use the ISA Slot Mapping
option. If you do, the user message “Enter a hex value between 26 and 3e in the first two numbers” appears. Click OK to clear the message.
Figure 26: ISA Slot Mapping
X
FIG
:ISA
slts
Cancel
OKSlot 1 IO 300
Slot 1 Base Memory
Slot 2 IO
Slot 2 Base MemoryOnly the first two digits of the IO and Base memory are used:
Valid IO range is 260 to 3E0Valid Memory Range is C0000 to D0000
c0000
2e0
d0000
NCSETUP for Windows® Operating System Technical Bulletin42
Reset NCM
When you force the reset of an NCM, the Command Verification dialog box appears, requesting that you confirm the command.
Reload NCM
When you reload the NCM, the Command Verification dialog box appears, requesting that you confirm the command.
Table 34: Reset NCM Quick ReferenceParameter DescriptionCommand Command menu, Reset NCM
Hot Key CTRL-J
Button
Purpose To reset the NCM.
NCMs All
Table 35: Reload NCM Quick ReferenceParameter DescriptionCommand Command menu, Reload NCM
Hot Key CTRL-K
Button
Purpose To force a reload of the NCM from its archive.
NCMs All
Figure 27: Command Verification on Resetting NCM Dialog Box
Command Verification X
FIG
:rset
ncmNo Yes
Do You really want to RESET the NCM?
16
Figure 28: Command Verification Dialog Box
Command Verification X
FIG
:reld
No Yes
Do You really want to RELOAD the NCM?
17
NCSETUP for Windows® Operating System Technical Bulletin 43
Set Duty/Standby Flag
The Duty/Standby Flag dialog box indicates whether or not the NCM is a Duty/Standby NCM, and shows what action is undertaken. To make the NCM a Duty/Standby NCM, check the Make a Duty/Standby box.
Note: For the NCM45x0-2, the two NCMs used as Duty/Standby controllers must both be NCM45x0-2 models. In other words, an NCM45x0-2 and NCM350 cannot be used together as Duty/Standby NCMs.
Table 36: Set Duty/Standby Flag Quick ReferenceParameter DescriptionCommand Command menu, Set Duty/Standby Flag
Hot Key CTRL-Z
Button N/A
Purpose To make the NCM a Duty/Standby NCM
NCMs NCM200, NCM300, NCM350, NCM45x0-2
Figure 29: Duty/Standby Flag Dialog Box
Duty/Standby Flag X
FIG
:dty
stndb
yflg
CancelOK
Make a Duty/Standby
The NCM is NOT a Duty/Standby NCM
Changing Duty/Standby FlagRequires NCM RELOAD
NCSETUP for Windows® Operating System Technical Bulletin44
Reset Lowest Acquired
With this command, NCSETUP reads the Lowest Acquired Memory and Initial Acquired Memory sizes from the NCM, display them in the above dialog box, and wait for user to click the OK or Cancel buttons.
For example, in Figure 30, if a user clicked OK, the Lowest Acquired Memory size would be set to 150000.
Table 37: Reset Lowest Acquired Quick ReferenceParameter DescriptionCommand Command menu, Reset Lowest Acquired
Hot Key CTRL-Y
Button
Purpose To set the lowest acquired memory size to the Initial Acquired Memory size.
NCMs NCM200, NCM300, NCM350, NCM45x0-2
Figure 30: Reset Lowest Acquired Dialog Box
Reset Lowest Acquired X
FIG
:rlac
quirOK Cancel
Reset Lowest Acquired size to Initial Aquired size?
Lowest Acquired Memory size: 99306
Initial Acquired Memory size: 150000
18
NCSETUP for Windows® Operating System Technical Bulletin 45
X
FIG
:adv
men
NCSETUP Advanced MenuFigure 31 shows the Advanced menu in the main NCSETUP window. To access this menu, select Advanced from the menu bar.
Update FlashSee Table 38 for Update Flash menu options.
Note: Do not use the Update Flash option for an NCM45x0-2. You must use the Metasys NCM Update Utility to update its flash. For details, refer to the NCM-45x0-2 Network Control Module Commissioning Guide (LIT-12011176).
Table 38: Update Flash Quick ReferenceParameter DescriptionCommand Advanced menu, Update Flash
Hot Key CTRL-H
Button N/A
Purpose To download a new packet driver and update the flash memory
NCMs NCM350 only
IMPORTANT: We strongly recommend that you have an additional ROM150 SIMM on hand before updating the flash chip.
Figure 31: Advanced Menu
File Command View Help
Wncsetup - JCHDQTRS 1 142
Update Flash
NetworkAdvanced
Update Flash...
Read Memory...Switch Trace BufferDebug...
View Current Acquired Memory
NCSETUP for Windows® Operating System Technical Bulletin46
To update the flash, first prepare the NCM by verifying the NCM is not downloaded (does not have a database) or in the process of being downloaded.
Verifying the NCM Is Not DownloadedGet the NCM ready to update the flash chip (the NCM must be in the not downloaded state), in one of two ways:
Either:
1. Set the archive address to an OWS that does not exist.
2. Power the NCM download without a battery.
3. Power the NCM back up.
Or:
1. Power the NCM download without a battery.
2. Power the NCM back up.
3. Abort the download.
Updating the Flash Chip
Follow the steps below to update the flash chip:
1. Under the Command Menu, choose Update Flash. The Update Flash dialog box appears (Figure 32).
2. Press the Choose File button. The Flash Update File-Name Selection dialog box appears (Figure 33) with the following .FLH files:
IMPORTANT: The FLASH802.FLH contains the primary downloading code for the NCM. If the download operation does not finish (for example, you have a software problem or power failure), the NCM is inoperable until the ROM150 SIMM is replaced.
Figure 32: Update Flash Dialog Box
Update Flash
FIG
:upd
at1
OK Cancel
Choose FileFile to Download to NCM Flash
Start Sector End Sector
Start Address
Sector Start Address
HEX 32HEX 32 Reboot NCM after downloadReboot NCM after download
End Address
OK
0 0
NCSETUP for Windows® Operating System Technical Bulletin 47
FLASH802.FLH: File contains Johnson Controls® Download code.
*.FLH: Current packet driver. File name varies per driver.
MINIBIOS.FLH
ROMDOS.FLH
For more information, see Details for Updating NCM350 Flash Code.
3. Select the appropriate file and press OK. It takes a few seconds for the file to write to the flash. A dialog box appears saying the write to flash is complete.
Details for Updating NCM350 Flash Code
To download the new flash code, the NCM350 must not be downloaded. To get the NCM350 in this state, use one of two ways:
Either:
1. If you are at the NCM’s archive OWS, force the NCM to reload. Click on the Command drop-down menu and select Reload NCM. As soon as the message appears stating that the NCM is downloading, select it and abort the download. It may be necessary to restore the download window.
2. Click on the Command drop-down menu and select Update Flash. Click on the Choose File button, select FLASH802.FLH, and click OK twice.
3. Once the message Write to Flash is Complete appears, click on the Command drop-down menu and select Command Reload. This forces the NCM to download and use the new flash code.
Or:
1. Set the archive address to a non-existing node address; then reload the NCM. Click on the Command drop-down menu and select Reload NCM.
2. Click on the Command drop-down menu and select Update Flash. Click on the Choose File button, select FLASH802.FLH, and click OK.
Figure 33: Flash Update File-Name Selection Dialog Box
Flash update file-name selection
FIG
:upd
at2
OK
Cancel
Network...
File ame:n Folders:
Flash802.flh c:\fmscode
List files of ype:t Dri es:v
*.flh c:\fms\code
c:
NCSETUP for Windows® Operating System Technical Bulletin48
3. Once the message Write to Flash is Complete appears, set the archive address back to the archive OWS. Click on the Command drop-down menu and select Command Reload to reset the NCM. This forces the NCM to download and use the new flash code.
NCSETUP for Windows® Operating System Technical Bulletin 49
Debug Enable
Switch Trace Buffer
Read Memory
Table 39: Debug Enable Quick ReferenceParameter DescriptionCommand Advanced menu, Debug
Hot Key CTRL-G
Button
Purpose To set softscope debug settings and enable log file time update tracing.
NCMs NCM200, 300, 350, 45x0-2(For NCM45x0-2, this enables log file time update tracing only.)
Table 40: Switch Trace Buffer Quick ReferenceParameter DescriptionCommand Advanced menu, Switch Trace Buffer
Hot Key N/A
Button N/A
Purpose Advanced troubleshooting
NCMs Any except NCM45x0-2
Table 41: Read Memory Quick ReferenceParameter DescriptionCommand Advanced menu, Read Memory
Hot Key N/A
Button N/A
Purpose Advanced troubleshooting
NCMs Any except NCM45x0-2
Figure 34: Debug Enable Dialog Box
Debug Enable X
FIG
:dbu
g
Cancel
OK
Port 2Port 3
Port 4
Port Selection
Port Baud Rate Selection
Softscope Enable
9600
Stop at Startup
NCSETUP for Windows® Operating System Technical Bulletin50
View Current Acquired Memory
NCSETUP View MenuThe View menu allows you to display the last retained data saved via the command menu. The following types of data can be viewed:
Table 42: View Current Acquired Memory Quick ReferenceParameter DescriptionCommand Advanced menu, View Current Acquired Memory
Hot Key N/A
Button N/A
Purpose Advanced troubleshooting
NCMs Any except NCM45x0-2
Table 43: View TableParameter Description1
1. “x” represents the NCM node number.
Trace Data TRCx.lst
Acquired Memory ACQx.lst
Task Utilization TSKx.lst
Network Data NETDATA.txt
First GPF Data GPFx.lst
Figure 35: Read Memory Dialog Box
X
FIG
stA
ddr
Cancel
Selector
Offset
task
50
0
0
OK
NCSETUP for Windows® Operating System Technical Bulletin 51
NCSETUP Network MenuThe Network menu allows you to collect or stop collection of specified data for the Metasys system network. The collect data command is disabled when NCSETUP operates in Stand-alone mode. Table 44: Network MenuNetwork Command DescriptionCollect Data Begins collection of specified data for the Metasys system
Network. The Network Data dialog box options are described in Table 44.
Stop Collection Stops the collection of network data. Once the data collection for the current NCM is complete, this command stops further data collection. For example, if you have 20 NCMs and the Stop Collection command is selected while NCM 15 is being processed, processing continues for NCM 15. No further processing is done for NCMs 16-20.
Table 45: Network Menu (Part 1 of 2)Network Command DescriptionN1 Statistics View the N1 statistics of all NCMs in the network.
Information Retrieve general information regarding the NCMs in the network.
Logfile Retrieve logfile data for all the NCMs in the network.
Figure 36: Network Data Dialog Box
FIG
:Ntd
ta
NCSETUP for Windows® Operating System Technical Bulletin52
View Acquired1 View the acquired memory after a reset for all NCMs in the network.
Task Utilization (10 seconds)1 Retrieve task utilization information for all NCMs in the network.
Trace (5,000 entries)1 View trace data for all NCMs in the network2.
GPF Data1 View GPF data for all NCMs in the network2.
Network Data File Enter location of the file to store the collected network data. The file is not automatically cleared after each subsequent network data collection. Use the File > Clear Network Data command to reset the contents of the file.
1. NCM45x0-2 not supported.2. NCM100 not supported.
Table 45: Network Menu (Part 2 of 2)Network Command Description
NCSETUP for Windows® Operating System Technical Bulletin 53
ErrorsThis section shows the NCSETUP for Windows OS dialog boxes used to indicate errors or warnings. Errors include the following:
• values out of range
• timer setting failure
• memory allocation failure
• inability to connect to the network
Warnings include:
• missing image files
• values out of range (shown in Debug mode)
Values Out of RangeAn NCSETUP Windows OS Application dialog box indicates integer values that are out of range, or character strings of incorrect or improper size.
When you return to the NCM Address Entry dialog box, the invalid integer is highlighted.
Figure 37: NCSETUP Windows OS Application Dialog Box Indicating Invalid Integer
Ncsetup Windows Application XX
OK
FIG
:intg
er
Please enter an integer.!
Figure 38: Highlighted Invalid Integer
NCM Address Entry X
FIG
:hig
hlt
Gate
Node
Network Name
View Other Addresses:
1
1.1
JCHDQTRS
NCSETUP for Windows® Operating System Technical Bulletin54
Missing Supporting Image FilesWhen either Metasys system PMI or N1SENDER.DLL, N1SNDMSG.DLL, or N1SNDRT.EXE are missing or not running, NCSETUP is not able to compute and a warning dialog box appears.
This warning could happen if there is not enough memory available for the service DLLs to run, or Metasys system PMI has not yet been started.
NCSETUP ParametersThis section explains all of the parameters that are added to the METASYS.INI file to configure Metasys system software for NCSETUP for Windows OS. The METASYS.INI file does not ship with NCSETUP for Windows OS parameters installed. The parameters are added the first time that NCSETUP runs, or the first time that NCSETUP needs them.
The section that is created in the METASYS.INI file is called [WNCSETUP].
NCM Address EntryNCSETUP holds information regarding the last used gate, node, port, and network name settings. The following parameters are created:
Gate=1
Node=99
Network=JCHDQTRS
Every time you open NCSETUP, the NCM Address Entry parameters are read, and each time you close NCSETUP, the current or last used parameters are saved in the METASYS.INI file. Shown above are the default values.
Maximum NCM NodeWhen NCSETUP retrieves a list of nodes from the Metasys system Network, it cannot distinguish whether the node is an Operator Workstation (OWS) or an NCM. NCM node addresses are usually within the 0-99 range, although they are not restricted to this range. NCSETUP allows the user to select the maximum node address for a network device. The default maximum is 99. The following parameter indicates the maximum node address:
MaxNCMAddressMask=99
If you use the default of 99, NCSETUP retrieves all of the node addresses from 1 to 99 and discards nodes with addresses above 99.
NCSETUP for Windows® Operating System Technical Bulletin 55
Window PositionNCSETUP saves the current position of the NCSETUP window on the screen under the Left, Top, Right, and Bottom parameters. An example is shown below:
Left=11
Top=32
Right=577
Bottom=390
The above values are used to restore the NCSETUP window to the position it was in before shutting down. The coordinates may differ from screen to screen, and NCSETUP automatically changes the values. Do not change them manually, because coordinates may differ screen to screen. The first time NCSETUP runs, it uses these window coordinates: 100, 75, 750, and 500. After NCSETUP shuts down, it saves the current window coordinates.
NCSETUP for Windows® Operating System Technical Bulletin56
Tips for Using NCSETUP for Windows OSThis section describes some of the tips that allow greater performance of NCSETUP for Windows OS (specifically, how to use NCSETUP and settings of the initialization file parameters).
OK vs. CancelAll dialog boxes have OK and Cancel buttons. If you don’t make any changes to the information, use Cancel rather than OK to exit the dialog box. Use Cancel to increase performance of the computer, the NC, and to decrease network traffic.
For example, if you select the NOVRAM command, NCSETUP prepares a request message and sends it to the NCM. After a few seconds, NCSETUP receives a response from the NCM and presents the data in an understandable form.
This form is the NOVRAM View and Modify dialog box. If you make changes to the information in the dialog box and click OK, NCSETUP repackages the information and sends it back to the NCM. If instead you click the Cancel button, NCSETUP does not send the information and the NOVRAM dialog box closes.
Figure 39: Communication Process between NCSETUP and NCM
1. Select NOVRAM Command.
2. NCSETUP sends message to NCM.
3. NCM sends reply to NCSETUP.
4. NCSETUP retrieves and decodes for user.
Click OK. Click Cancel.
Normal Operation
Normal Operation
NCSETUPrepackagesscreen information.
NCSETUP tests ifuser data is valid.
NCSETUP sendsmessage backto NCM.
FIG
:CO
MM
UN
NCSETUP for Windows® Operating System Technical Bulletin 57
PrintingPrint and Print Preview of only the first logical page of any document is supported. We suggest you print the files that are created by NCSETUP for each command that requires output.
Under the View menu, there are three fields that allow you to start the preferred system editor and open one of the files created. The last files created by NCSETUP are listed under the View menu item. The system editor name is retrieved from the METASYS.INI file. In the editor field, the default is NOTEPAD.EXE.
Connecting to a New NCMNCSETUP requires a network name when connecting to the NCM directly, unless you follow the instructions in Running NCSETUP Direct Connect without Knowing the Network Name earlier in document. NCSETUP does not require the network name when connecting over the N1.
Metasys® is a registered trademark of Johnson Controls, Inc.All other marks herein are the marks of their respective owners.
© 2006 Johnson Controls, Inc.
Controls Group507 E. Michigan StreetMilwaukee, WI 53202
Published in U.S.A. www.johnsoncontrols.com
NCSETUP for Windows® Operating System Technical Bulletin58