NCSETUP for Windows Technical Bulletin

NCSETUP for Windows Technical Bulletin
Issue Date
09/01/01
TECHNICAL BULLETIN
NCSETUP for Windows
Introduction
Page
4
•
Hardware Requirements
5
•
Software Requirements
5
Using NCSETUP for Windows
6
•
Features
6
•
Multiple Modes of Operation
6
•
Starting NCSETUP for Windows in Normal Mode
6
•
Running NCSETUP Direct Connect without Knowing the Network Name
7
•
Exiting NCSETUP Normal Mode
8
•
Starting NCSETUP for Windows in Standalone Mode
8
•
NCSETUP Standalone Mode Restrictions
10
•
Exiting NCSETUP Standalone Mode
10
•
Windows Interface
11
•
Making a Connection
12
•
NCSETUP File Menu
13
•
NCM Address Entry
14
•
Clear First GPF Data
15
•
Clear Network Data
15
•
NCSETUP Command Menu
16
•
NOVRAM View and Modify
17
•
NOVRAM Advanced Settings
20
•
Information
22
•
View Acquired
23
•
Operator Terminal Port
24
© 2001 Johnson Controls, Inc.
Code No. LIT-6360251d
1
www.johnsoncontrols.com
Software Release 12.00
2
•
S2 Trunk Parameters
•
LONWORKS Parameters
26
•
Logfile
30
•
Logfile Clear
31
•
N1 Statistics
32
•
N1 Statistics Clear
32
•
Task Utilization
32
•
Trace Data
34
•
First GPF Data
35
•
IP Address Configuration
36
•
FN Configuration
37
•
Read Modem
38
•
Write Modem
39
•
ISA Slot Mapping
41
•
Reset NCM
41
•
Reload NCM
42
•
Set Duty/ Standby Flag
42
•
Reset Lowest Acquired
43
•
NCSETUP Advanced Menu
44
•
Update Flash
44
•
Debug Enable
47
•
Switch Trace Buffer
48
•
Read Memory
48
•
View Current Acquired Memory
48
•
NCSETUP View Menu
49
•
NCSETUP Network Menu
49
Page
25
Errors
51
•
Values Out of Range
51
•
Missing Supporting Image Files
52
NCSETUP for Windows
NCSETUP Parameters
Page
53
•
NCM Address Entry
53
•
Maximum NCM Node
53
•
Window Position
54
Tips for Using NCSETUP for Windows
55
•
OK vs. Cancel
55
•
Printing
56
•
Connecting to a New NCM
56
NCSETUP for Windows
3
Introduction
NCSETUP for Windows (WNCSETUP) is a software utility that sets up
and modifies a Network Control Module’s (NCM) non-volatile RAM
(NOVRAM) and flash memory configuration. The NCSETUP.EXE
diagnostics are replaced by WNCSETUP.EXE.
IMPORTANT:
Throughout the document, NCSETUP refers to the
Windows version. The software, however, abbreviates
NCSETUP for Windows software as WNCSETUP.
Features of NCSETUP include the standard Windows look and feel, a
Metasys communications interface, and Ethernet/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 that establishes to the system what type of
NCM you are commissioning (for example, what program set--standard,
security, S2 Migration). To look up the various NC software
configurations that are supported for each NCM base hardware option, see
the NCM Software Options Technical Bulletin (LIT-636023).
Note: Metasys 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.
4
NCSETUP for Windows
Hardware
Requirements
NCSETUP for Windows runs in Normal mode on a configured Metasys
Operator Workstation (OWS). For information on the Personal Computer
(PC) configuration, see the Operator Workstation Configurations
Technical Bulletin (LIT-636013d). Shown below are the cabling
requirements. If the NCSETUP is run via:
•
RS-232: NCM200: a straight through cable is required to connect
PC/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 PC end, based on
the type of PC or portable used. The NCM connection is 25 pin. The
serial port on the PC or portable must be connected to the NCM
integrated RS-232 port (Port 3).
NCM300: RS-232 Port 3--a null-modem cable must be used. The cable
could be 9-pin female or 25-pin female on the PC end, based on the
type of PC/portable used. The NCM connection is 9 pin.
•
N1: N1 coax or twisted-pair cable is required to connect the PC or
portable to the NCM. An ARCNET or Ethernet Network Interface
Card (NIC) is also required.
NCSETUP also has the ability to operate in Standalone mode on a PC or
portable device in which the Metasys OWS software has not been
installed.
Software
Requirements
NCSETUP for Windows is included in the Metasys PMI (Person-Machine
Interface) software.
NCSETUP for Windows
5
Using NCSETUP for Windows
This section explains the features of NCSETUP for Windows, how to
navigate through the program, the new organization of NCSETUP menus
and parameters, and how to configure various NCSETUP sessions.
Features
Multiple Modes
of Operation
Starting
NCSETUP for
Windows in
Normal Mode
Enhancements to NCSETUP include:
•
ability to capture screens (for example, View Logfile) and paste the
information into a window
•
ability to run NCSETUP whether or not the Metasys Network is
running
•
commands that were previously view only 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 software industry-standard look and feel
NCSETUP for Windows has the ability to operate under two separate
modes: Standalone mode and Normal mode. All versions of NCSETUP
have the ability to operate under Normal mode. Release 12.00 NCSETUP
for Windows has the added ability to operate in Standalone mode.
•
Normal mode operation requires the presence of a configured OWS
and allows NCSETUP to communicate with any NCM defined on the
network.
•
Standalone mode operation does not require the presence of a
configured OWS and allows NCSETUP “automatically” to connect
directly to any NCM connected to the PC via serial port.
To use NCSETUP for Windows for operation in Normal mode:
•
Metasys system must be running.
•
NC must be communicating with the OWS.
•
NC must be defined in the Metasys database, so the communication
method can be selected (N1, Dial, Direct).
Because NCSETUP for Windows relies on the Metasys communication
interface, it is no longer necessary to exit to DOS and reboot the machine.
NCSETUP for Windows can run as a regular application.
6
NCSETUP for Windows
To start the NCSETUP program, follow the steps below:
1.
If the Metasys system is not operational, start the Metasys PMI.
2.
In Microsoft Windows:
a.
Click the Start button, 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).
Running
NCSETUP
Direct Connect
without
Knowing the
Network Name
Starting with Metasys 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 wild card network name for the NCM:
@NET
PORT “COM#” , 2 , 19200
NET “wncsetup”, “JCI Tools”
NCDIRECT
IMPORTANT:
The network must be named “wncsetup.”
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 Metasys to automatically detect the baud rate for rates of
4800, 9600, and 19200.
NCSETUP for Windows
7
Exiting
NCSETUP
Normal Mode
To exit NCSETUP Normal mode, on the File menu, select Exit.
Starting
NCSETUP for
Windows in
Standalone
Mode
To use NCSETUP for operation in Standalone mode:
•
Release 12.00 or later Standalone NCSETUP for windows must be
installed on the PC. (Standalone NCSETUP can be installed by itself
from a Release 12.00 or later Metasys PMI CD. It is also installed
automatically whenever the Release 12.00 or later Metasys PMI is
installed.)
•
Metasys software must not be running.
•
An NCM must be connected directly to the PC via serial port. The PC
COM1 or COM2 port must be connected to the RS-232 Port 3 of the
NCM.
Standalone mode utilizes a special communication interface that does not
rely on Metasys software. When an NCM needs to be configured, a user
can connect using NCSETUP in Standalone mode without configuring a
working OWS. This approach greatly reduces the amount of time
necessary to configure an NCM. NCSETUP Standalone 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 system registry.
To start NCSETUP in Standalone mode:
1.
If the Metasys system is operational, shut down the Metasys PMI.
2.
From the Windows 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
Standalone 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.
3.
The Wncsetup Communication Setup dialog box immediately
prompts the user to fill out the NC gate and node fields, select the
correct PC COM port, and choose the proper baud rate (Figure 1).
Note: Auto Baud Detect is not available in Standalone 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.
8
NCSETUP for Windows
Figure 1: Wncsetup Communication Setup Box
4.
Enter the correct information and press OK. The NC Communication
box appears, which displays various communication information
including the PC COM port number, connected baud rate, and the
NCM download condition (Figure 2). The NC Communication box
will be titled NC Direct2 or NC Direct depending on port selection.
The text in this window may change to reflect the current
communication status.
Figure 2: NC Communication Box
5.
After the communication software successfully establishes a
connection with the NCM, the Main WNCSETUP window appears
(Figure 4).
Notes: The NCM Address Entry Dialog Box will not appear as in Normal
mode operation (seen in Figure 6). In WNCSETUP Standalone
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 Standalone 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 Standalone mode. See Table 43 for more information on the
Collect Data command.
In Standalone mode, WNCSETUP can communicate only with the
directly connected NCM.
NCSETUP for Windows
9
6.
NCSETUP
Standalone
Mode
Restrictions
The Wncsetup Communication Control screen automatically
disappears when communication with the NC is successfully
established.
The following restrictions apply when operating under NCSETUP
Standalone mode:
•
NCSETUP is limited to one instance. It is not possible to start more
than one instance of NCSETUP for Standalone mode operation.
However, multiple instances of NCSETUP can be executed when
operating under Normal mode.
IMPORTANT:
Shut down NCSETUP when operating under
Standalone mode before the Metasys PMI is started.
Metasys PMI Release 12.00 has the added
functionality of automatically detecting and shutting
down Standalone NCSETUP if it is executing when
PMI is started. Metasys PMI displays the shutdown
message in Figure 3 if it detects an instance of
Standalone NCSETUP running. Previous versions of
Metasys PMI prior to Release 12.00 are not able to
automatically detect and shut down Standalone
NCSETUP. Users with Metasys PMI prior to
Release 12.00 have to manually shut down Standalone
NCSETUP themselves before starting PMI. Failure to
shut down Standalone NCSETUP before starting the
Metasys PMI results in undefined errors.
Figure 3: PMI Shutdown Message
Exiting
NCSETUP
Standalone
Mode
10
To exit NCSETUP Standalone mode, on the File menu of the main
WNCSETUP window, click Exit. All windows and tasks associated with
Standalone mode terminate.
NCSETUP for Windows
Windows
Interface
Main Window
When using NCSETUP for Windows, you need to be familiar with the
Windows environment. The windows shown in this document are from
Windows 95 operating system.
Title Bar
Maximize Button
Close
Minimize Button Button
Menu Bar
Wncsetup - Not Connected
X
File Command Advanced View Help Network
Toolbar
Document Area
Status Bar
Keyboard Indicators
Read and Display NCM data
NUM
Figure 4: Main NCSETUP Window
Toolbar
You can access the NCSETUP for Windows 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.
NCSETUP for Windows
11
Task
ISA Slot
FN
About
LONParameters
Operator
Utilization
Mapping *
Configuration
WNCSETUP
Terminal Port
NOVRAM
Logfile Clear
Write Modem
Reload
View
N1 Statistics
Logfile
Parameters
Trace
NCM
Print
Acquired
Clear
Wncsetup - JCHDQTRS 1 72
X
File Command View Help
2
New Address Information
S2 Trunk
Parameters
N1 Statistics
*Debug and ISA Slot Mapping are for internal
Johnson Controls use only.
Debug*
IP Address
Configuration
Read Modem
Parameters
Reset Lowest
Acquired Memory
Reset
NCM
Figure 5: NCSETUP Toolbar
Title Bar
The title bar of NCSETUP for Windows 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
Making a
Connection
12
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.
When 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.
NCSETUP for Windows
NCM Address Entry
Gate
1
Node
99
Network Name
X
JCHDQTRS
View Other Addresses:
Addr1
Figure 6: NCM Address Entry Dialog Box
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.
Table 1: Format for Command Quick Reference
NCSETUP File
Menu
Parameter
Description
Command
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
To perform a command, click on the File drop-down menu and select the
command.
NCSETUP for Windows
13
NCM Address
Entry
Table 2: NCM Address Entry Quick Reference
Parameter
Description
Command
File menu, Address
Hot Key
CTRL-A
Button
1
Purpose
To set the address of the NCM to establish an NCSETUP
connection
NCMs
All
The first time that NCSETUP is run on a system with software installed,
the parameters are set as shown in Table 3.
Table 3: Initial NCM Settings
Parameter
Setting
Gate
1
Node
(of the NC)
99
Network Name
JCHDQTRS
When NCSETUP is run again, the NCM Address Entry dialog box lists
the last referenced gate, node, and network name.
Table 4: NCM Address Entry Parameters
14
Parameter
Range
Gate
1 to 254
Node
(of the NC)
1 to 254
Network Name
Name length cannot exceed
eight characters
NCSETUP for Windows
If the communication parameters are correct, select OK. NCSETUP for
Windows 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
Network. This box is updated every time NCSETUP for Windows
starts. If you are adding an NCM to the list, exit and return to
NCSETUP for Windows to view the changes.
Once the OK button is pressed, NCSETUP for Windows attempts to
connect to the specified NCM via the network.
Clear First GPF
Data
Clear Network
Data
Table 5: Clear First GPF Data
Parameter
Description
Command
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
Table 6: Clear Network Data
Parameter
Description
Command
Clear Network Data
Hot Key
None
Button
None
Purpose
Resets (clears) the contents of the network data file.
NCMs
All
NCSETUP for Windows
15
NCSETUP
Command
Menu
To 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.
Novram...
Information
View acquired...
Ctrl+N
Ctrl+I
Ctrl+V
Operator Terminal Port...
S2 Trunk Parameters...
LON Parameters...
Ctrl+O
Ctrl+S
Ctrl+B
Logfile
Logfile Clear
Ctrl+L
Ctrl+C
N1 Statistics
N1 Statistics Clear
Ctrl+1
Ctrl+R
Task Utilization...
Trace Data...
First GPF Data...
IP Address Configuration...
FN Configuration...
Ctrl+T
Ctrl+D
Ctrl+E
Ctrl+J
Read Modem...
Write Modem...
Ctrl+M
Ctrl+W
ISA Slot Mapping...
Ctrl+P
Reset NCM...
Reload NCM...
Ctrl+J
Ctrl+K
Set Duty.Standby Flag...
Reset Lowest Acquired...
Ctrl+F
Ctrl+Q
Commen2
Figure 7: Command Menu
16
NCSETUP for Windows
NOVRAM View
and Modify
Table 7: NOVRAM View and Modify Quick Reference
Parameter
Description
Command
Command menu, NOVRAM
Hot Key
CTRL-N
Button
2
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
The following sections describe the fields found on the NOVRAM View
and Modify dialog box.
NCSETUP for Windows
17
NCM Address
The 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
CAUTION: 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.
NCMs can be downloaded with different device code types. Table 8 shows
all of the options for each NCM.
Table 8: Code Download Types
NCM Type
Device Type
NCM350
Standard, Fire, Security, Migration, JC/85 Gateway, Operator
Terminal (OT), Network Port*, General with NT*, General with OT*,
UL 864 Fire
NCM300
Standard, Fire, Security, Migration, JC/85 Gateway, Operator
Terminal (OT), Network Port*, General with NT*, General with OT*,
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
* Requires a minimum of 4 MB of acquired memory. For NCM 3xx-0 or 3xx-1 memory is
added via SIMM slots. NCM 350-8 comes with a fixed 8 MB of memory.
Archive Device
Address
You 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.
Table 9: Archive Device Address Parameters
Parameter
Range
Archive Gate
1-254
Archive Node
1-254*
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.
* 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.
18
NCSETUP for Windows
Table 10 shows connections and port dependencies that NCSETUP
follows in allowing Archive Device Address configuration. 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 Baud Rate defined in
the Archive Device Address section and the 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.
Table 10: NCM Connection/Port Dependencies
Connection Type
Port 2
Port 3
Port 5
Port 6
OWS Direct
NCM101
NCM200
NCM300
NCM350
NCM101
NCM200
NCM300
NCM350
NCM350
NCM350
OWS Dial
NCM101
NCM200
NCM300
NCM350
NCM300
NCM350
NCM350
NCM350
OWS Unconfigured
OWS N1
Notes:
Port 4
ARCNET
IP
NCM101
NCM200
NCM300
NCM350
NCM350
NCM101
NCM200
NCM300
NCM350
Ports 5 and 6 allow the following baud rates: 1200, 2400, 4800, 9600, 14400, 19200, 28800, 38400,
57600. If you are using a serial card, use a 16550AF (16 character First-In, First-Out [FIFO] support)
Universal Asynchronous Receive Transmit (UART) card.
An unconfigured device can be connected to Ports 5 and 6 if there is a configured device defined on the
port.
Ports 2 and 3 allow the following baud rates: 1200, 2400, 4800, 9600, 19200.
Alarm/Warning
Delay Mode for
AD/AI Objects
The 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 COS (Change-of-State) 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 and
NCM300 series. NCM 101/102/401 support Warning Delay only.
NCSETUP for Windows
19
NOVRAM
Advanced
Settings
Table 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 Dialog Box
20
NCSETUP for Windows
Table 11: NOVRAM Advanced Settings
Time Required to
Detect a Device
Offline
Parameter
Description
Acquired Memory Size
A scratch pad area for communications between
tasks
Reset 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.
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
one 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 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 PCs and NCs).
Table 12: Time Required to Detect a Device Offline
Broadcast
Interval
(min:sec)
[1:00]
Note:
Messages Missed Before Considered
Offline
[2]
3
4
5
[2:00-4:00]
3:00-5:00
4:00-6:00
5:00-7:00
Maximum IP
Connected
Nodes
[100]
Default values are enclosed in brackets.
NCSETUP for Windows
21
Information
Table 13: Information Quick Reference
Parameter
Description
Command
Command menu, Information
Hot Key
CTRL-I
Button
3
Purpose
To retrieve general information regarding the NCM, such as NC
state, runtime, memory information, self-test, etc.
NCMs
All
Wncsetup - JCHDQTRS 1 72
File
Command
X
Advanced View
Help
Network
2
Information data for JCHDQTRS 1 72 0,
04/26/96
14 13 03
NCM300 with 2 Megabytes of DRAM; Battery status = Not Installed
EPROM release 600 DRAM release H39
Current NC state: operational
Runtime is 535 days
Total available allocable memory is 567590
Initial available allocable memory is 750000
Lowest available allocable memory is 566084
Total available acquire memory is 66616
Initial available acquire memory is 150000
Lowest available acquire memory is 49072
The internal loopback test on port 1 (quart channel A) passed
The internal loopback test on port 2 (quart channel B) passed
The internal loopback test on port 3 (quart channel C) passed
The internal loopback test on port 4 (quart channel D) passed
The sanity timeout test passed
The clock/calendar chip test passed
The arcnet test passed
Ready
CAP
Figure 10: Information Output Screen
The NCM information reported in Figure 10 is a function of the NC type,
and consists of:
22
•
general network identification
•
NCM identification
•
memory information
•
any internal testing run by the NCM
NCSETUP for Windows
View Acquired
Table 14: View Acquired Quick Reference
Parameter
Description
Command
Command menu, View Acquired
Hot Key
CTRL-V
Button
4
Purpose
To view the acquired memory information
NCMs
NCM200 and NCM300
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:
Ncsetup Windows Application
!
X
There is no Acquired Memory data to display
OK
view
Figure 11: NCSETUP Windows Application Dialog Box
NCSETUP for Windows
23
Operator
Terminal Port
Table 15: Operator Terminal Port Quick Reference
Parameter
Description
Command
Command menu, Operator Terminal Port
Hot Key
CTRL-O
Button
5
Purpose
To set the port for the Operator Terminal connection
NCMs
OT NCM
Operator Terminal Port Configuration
X
Port
OK
Port 2
Cancel
Port 3
Port 4
Port 5
Check if Dial
Port 6
otconfig
Figure 12: Operator Terminal Port Configuration Dialog Box
The Operator Terminal (OT) port command is available only if the NCM
NOVRAM is configured to be an Operator Terminal NCM. 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. Other NCs allow Ports 2, 3, or 4. Refer to Table 16:
Table 16: NCM Connection/Port Dependencies for the OT
Connection Type
Port 2
Port 3
Port 4*
Port 5
Port 6
Operator Terminal
NCM200
NCM300
NCM350
NCM200
NCM300
NCM350
NCM101
NCM200
NCM300
NCM350
NCM300
NCM350
NCM300
NCM350
OT Dial
NCM200
NCM300
NCM350
NCM300
NCM350
**
**
* Port 4 does not allow for connections with modems.
** Internal Plug and Play modems are not recommended for use with NCM300/350 series
devices.
The allowed connection baud rates are: 1200, 2400, 4800, 9600, and
19200 for all ports. Select the baud rate from the NOVRAM View and
Modify or the Archive commands of NCSETUP for Windows.
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.
24
NCSETUP for Windows
S2 Trunk
Parameters
Table 17: S2 Trunk Parameters Quick Reference
Parameter
Description
Command
Command menu, S2 Trunk Parameters
Hot Key
CTRL-S
Button
7
Purpose
To set up the S2 trunk parameters for a Migration NCM
NCMs
Migration NCM
S2 Trunk Parameters
X
The S2 delay between polls is 6
ticks of 50 msecs
The S2 transmit retry count is 4
The S2 reply timout is
OK
20
ticks of 50 msecs
Cancel
s2trunkparam
Figure 13: S2 Trunk Parameters Dialog Box
The S2 Trunk Parameters window shows what 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.
NCSETUP for Windows
25
LONWORKS
Parameters
Table 18: LONWORKS Parameters Quick Reference
Parameter
Description
Command
Command menu, LONW ORKS Parameters
Hot Key
CTRL-B
Button
Purpose
To setup the LONW ORKS parameters used to initialize the
LONW ORKS network interface board
LonWorks Parameters
Binding Mode
Unbound
Bound
Domain Length (bytes)
Domain ID (hex)
0
Subnet ID
1
Fully Bound
000000000000
Node ID
1
Network Buffer Size (bytes)
66
Non Group Timer (msec)
Network Input Buffer Count
2
Network Output Buffer Count
2
Application Input Buffer Count
3
Application Output Buffer Count
3
Maximum Poll Image Size (*32KB)
2
Time to Live (sec.)
(temporary NV in Poll Image)
128
35
Set Defaults
OK
Cancel
LON_Dlg.cdr
Figure 14: LONWORKS Parameters
26
NCSETUP for Windows
Table 19 explains the LONWORKS parameters:
Table 19: LONWORKS Parameters
Parameter
Description
Default
Value
Minimum
Maximum
Binding Mode
If LONW ORKS 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 (= 32K)
8 (= 256)
Time to Live
For temporary NVs (Network Variables) in
1
Poll Image cache . 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, ∞.
0 = Never
No temporary NVs are created.
35 seconds
Never
Forever
The second level of the LonTalk
domain/subnet/node addressing hierarchy
1
1
255
The third level of the LonTalk
domain/subnet/node addressing hierarchy
1
1
127
Length in bytes of the domain
0
0
6
The top level of the LonTalk
3
domain/subnet/node addressing hierarchy
0
N/A
N/A
Network Buffer Size
4
Size for input and output network buffer in
Neuron chip
11
(=66 Bytes)
0
15
Network Input Buffer
4
Count
Number of input network buffer in Neuron
chip
3
(=2 Buffers)
0
15
Neuron Network
4
Output Buffer Count
Number of output network buffer in Neuron
chip
3
(=2 Buffers)
0
15
Neuron Application
4
Input Buffer Count
Number of application input buffer in the
Neuron chip
4
(= 3 Buffers)
0
15
Neuron Application
4
Output Buffer Count
0
15
Neuron Non Group
4
Timer
0
15
∞ = Forever
3
Subnet ID
3
Node ID
Domain Length
3
2, 3
Domain ID
Temporary NVs are never
deleted (except during warm
start or if device goes offline).
Notes:
1 See the LONWORKS Network Layout Technical Bulletin (LIT-1162150) for details.
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 binding tool. The
values shown in this mode are the values the NCM read from the LONW ORKS board during its warm start
(system reset). Use this feature to check the address that the NCM actually uses.
4 These parameters override any settings a binding tool may write into the LONW ORKS board's Neuron chip (a
binding tool cannot determine what communication load the NCM has, so it cannot determine useful buffer
settings). For field devices, the binding tool can determine how many binding connections each device has and
can make a reasonable determination of the device's communication needs.
NCSETUP for Windows
27
Poll Image
Parameters
The 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 Figure 15.
28
NCSETUP for Windows
Cache
Hits
Misses
Network Variable
Permanent
Temporary
32345
12374
112
5
Poll Cycle (* 50 ms)
Prio 1
Prio 2
6
Prio 3
23
56
Figure 15: LONWORKS Statistics
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.
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 table below presents a few
general guidelines for improving performance.
Table 20: Guidelines for Improving Poll Image Performance
Statistics Indicator
Poll Image Parameter to Adjust
Error 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.
NCSETUP for Windows
29
Logfile
Table 21: Logfile Quick Reference
Parameter
Description
Command
Command menu, Logfile
Hot Key
CTRL-L
Button
8
Purpose
To view the logfile of the NCM
NCMs
All
Wncsetup - JCHDQTRS 1 85
File
X
Command Advanced View
Help
Network
2
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
Ready
NUM
Figure 16: Logfile Screen Dump
The Logfile window reports in a table the following information for each
call to the NC Logfile function:
30
•
Count
•
Log Error
•
Information
•
Task name and ID
•
Time
NCSETUP for Windows
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.
Logfile Clear
Table 22: Logfile Clear Quick Reference
Parameter
Description
Command
Command menu, Logfile Clear
Hot Key
CTRL-C
Button
9
Purpose
To clear the NCM logfile and allow for additional log information to
be recorded
NCMs
All
Wncsetup - JCHDQTRS 1 85
File
Command Advanced View
X
Help
Network
2
Logfile data for : JCHDQTRS 1 85 0
Number Error
Arg
Task
Date/Time
__________________________________________________________________________________
__
Ready
NUM
Figure 17: Logfile Clear Screen
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.
NCSETUP for Windows
31
N1 Statistics
Table 23: N1 Statistics Quick Reference
Parameter
Description
Command
Command menu, N1Statistics
Hot Key
CTRL-1
Button
N1 Statistics
Clear
Purpose
Read and display N1 statistics
NCMs
Any
Table 24: N1 Statistics Clear Quick Reference
Parameter
Description
Command
Command menu, N1 Clear
Hot Key
CTRL-R
Button
Task Utilization
Purpose
Clear N1 statistics
NCMs
Any
Table 25: Task Utilization Quick Reference
Parameter
Description
Command
Command menu, Task Utilization
Hot Key
CTRL-T
Button
10
Purpose
To retrieve the task utilization information from an NCM, either as a
one-time request, or at a periodic time interval
NCMs
All
Task Utilization Parameters
Number of periods
Length of period in seconds
(minimum of 15 seconds)
X
1
60
OK
Cancel
task1
Figure 18: Task Utilization Dialog Box
32
NCSETUP for Windows
After successfully reading the requested information and saving it to the
file, you can view the file using the View menu.
Wncsetup - JCHDQTRS 51 51
File
Command Advanced View
X
Help
Network
2
Utilization data for JCHDQTRS 51 51 0, 04/08/96 15:41:10 Period: 0
task 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=24783
tics=0
tics=21716
tics=5082
tics=0
tics=17899
tics=6051
tics=2902
tics=3
tics=5549
tics=5113
tics=0
tics=245
tics=1968
tics=112
tics=0
tics=0
tics=0
tics=0
tics=1
tics=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)
Ready
tics=5377
tics=6647
tics=1358
tics=1358
tics=39
tics=972
tics=1380
tics=1677
tics=2
tics=1870
tics=1441
tics=242
tics=114
tics=0
tics=1
tics=0
tics=0
tics=0
tics=0
tics=8
tics=2
NUM
Figure 19: Task Utilization Data Screen
NCSETUP for Windows
33
Trace Data
Table 26: Trace Data Quick Reference
Parameter
Description
Command
Command menu, Trace Data
Hot Key
CTRL-D
Button
12
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
Wncsetup
!
X
No RTOS386 Trace Data - NCM has not rebooted
OK
tracenon
Figure 20: Read Trace Data Dialog Box
The amount of trace data information is based off of the available NCM
memory.
If the Trace Data command fails because the NCM has not rebooted,
NCSETUP responds with an error dialog box.
34
NCSETUP for Windows
First GPF Data
Table 27: First GPF Data
Parameter
Description
Command
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’s
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 NCM350
X
!
No GPF Data
OK
Figure 21: No GPF Data Dialog Box
X
!
GPF Data Storage is Complete
OK
Figure 22: GPF Data Dialog Box
NCSETUP for Windows
35
IP Address
Configuration
Table 28: IP Address Configuration Quick Reference
Parameter
Description
Command
Command menu, IP Address Configuration
Hot Key
CTRL-E
Button
11
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 N1 Ethernet
networks.
NCMs
NCMs on the IP network
IP Address Settings
IP Address 192
Subnet mask 255
Network router 192
UDP Port Address:
[2050-65535]
11001
X
9
205
51
255
255
0
9
205
2
Broadcast Type
All Ones
Network Directed
None
ipaddr
Figure 23: IP Address Settings Dialog Box
This feature allows the user to edit the settings of the IP address
configuration that the NCM needs to connect to an IP network.
The Broadcast Type option specifies the broadcast type for the NCM. It is
recommended, but not required, that all nodes on a Metasys 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 23) 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
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 29 for a description of the different Broadcast Types.
36
NCSETUP for Windows
Table 29: Broadcast Types
Broadcast Type
Description
All 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.
FN
Configuration
Table 30: FN Configuration Quick Reference
Parameter
Description
Command
Command menu, FN Configuration
Hot Key
CTRL-F
Button
13
Purpose
To set up the FN style and port threshold
NCMs
Fire-Net NCM (NU-NCM300-FIRE)
X
FN Configuration
Port A Threshold
High
Low
Port B Threshold
High
Low
FN UL Style
4
7
fnconfig
Figure 24: FN Configuration Dialog Box
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 independent of each other.
NCSETUP for Windows
37
Read Modem
Table 31: Read Modem Quick Reference
Parameter
Description
Command
Command menu, Read Modem
Hot Key
CTRL-M
Button
14
Purpose
To read the profile of the modem on the specified port
NCMs
NCM200, NCM300, and NCM350
Note:
NCM200 and NCM300 must be downloaded.
X
Read NCM Modem Profile
Modem Port
Port 2
OK
Cancel
Port 3
Port 5
Port 6
Modem Command
AT&V
readncm
Figure 25: Read NCM Modem Profile Dialog Box
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 doesn’t work if the port that is interrogated is in use.
The Hayes Improved Escape Sequence with Guard Time 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 (Light-Emitting Diodes) on the modem are on,
indicating that the modem is operational and the NCM is
connected to it.
For non-Hayes compatible modems, it is possible to change the command
used to retrieve the profile. On the Read Modem dialog box, there is a
drop-down list box that lists the Hayes as well as other common command
strings.
In other cases, reading from or writing to 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 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.
38
NCSETUP for Windows
The ports that are available on the screen are 2, 3, 5, and 6. The
availability to select a port is a function of the NCM type. See the
NOVRAM View and Modify section for details.
Write Modem
Table 32: Write Modem Quick Reference
Parameter
Description
Command
Command menu, Write Modem
Hot Key
CTRL-W
Button
15
Purpose
To write a command string to the modem on a specified port
NCMs
NCM200, NCM300, and NCM350
Note:
NCM200 and NCM300 must be downloaded.
X
Write NCM Modem Profile
Modem Port
Port 2
Port 3
OK
Cancel
Port 5
Port 6
Select Modem
(Brand Name)
writencm
Figure 26: Write NCM Modem Profile Dialog Box
Changes to this operation have been made for Metasys Release 11.00 or
later. Figure 26 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.
Note: The command doesn’t work if the port that is interrogated is in use.
The Hayes Improved Escape Sequence with Guard Time 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.
NCSETUP for Windows
39
For non-Hayes compatible modems, it is possible to change the command
used to retrieve the profile. The Write Modem dialog box has a drop-down
menu option that lists Hayes and other common modem commands.
In other cases, reading from or writing to a modem requires defining a dial
connection on the port you are trying to read. For example, if you want to
write to the modem parameters on Port 6, the local Metasys 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, you can add the new modem to 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.
40
NCSETUP for Windows
Updating
MODEM.INI
Occasionally a new set of modems supported by Metasys software will be
available from The Advisor Web site. In order to update a particular
customer, copy the entire MODEM.INI from The Advisor and replace the
present MODEM.INI on the Metasys Release 11.00 or later jobsite.
Remember, any user defined modems are 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 Advisor.
ISA Slot
Mapping
X
Slot 1 IO
300
Slot 1 Base Memory
OK
c0000
Cancel
Slot 2 IO 2e0
Slot 2 Base Memory d0000
Only the first two digits of the IO
and Base memory are used:
Valid IO range is 260 to 3E0
Valid Memory Range is C0000 to D0000
ISAslots
Figure 27: ISA Slot Mapping
Reset NCM
Table 33: Reset NCM Quick Reference
Parameter
Description
Command
Command menu, Reset NCM
Hot Key
CTRL-J
Button
16
Purpose
To reset the NCM
NCMs
All
X
Command Verification
Do You really want to RESET the NCM?
Yes
No
resetncm
Figure 28: Command Verification on
Resetting NCM Dialog Box
When you force the reset of an NCM, the Command Verification dialog
box appears requesting that you to confirm the command.
NCSETUP for Windows
41
Reload NCM
Table 34: Reload NCM Quick Reference
Parameter
Description
Command
Command menu, Reload NCM
Hot Key
CTRL-K
Button
17
Purpose
To force a reload of the NCM from its archive
NCMs
All
X
Command Verification
Do You really want to RELOAD the NCM?
Yes
No
reload
Figure 29: Command Verification Dialog Box
When you reload the NCM, the Command Verification dialog box appears
requesting that you confirm the command.
Set Duty/
Standby Flag
Table 35: Set Duty/Standby Flag Quick Reference
Parameter
Description
Command
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, and NCM350
Duty/Standby Flag
X
The NCM is NOT a Duty/Standby NCM
Make a Duty/Standby
OK
Cancel
Changing Duty/Standby Flag
Requires NCM RELOAD
dutystandbyflag
Figure 30: Duty/Standby Flag Dialog Box
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.
42
NCSETUP for Windows
Reset Lowest
Acquired
Table 36: Reset Lowest Acquired Quick Reference
Parameter
Description
Command
Command menu, Reset Lowest Acquired
Hot Key
CTRL-Y
Button
18
Purpose
To set the lowest acquired memory size to the Initial Acquired
Memory size
NCMs
NCM200, NCM300, and NCM350
Reset Lowest Acquired
Lowest Acquired Memory size:
Initial Acquired Memory size:
X
99306
150000
Reset Lowest Acquired size to Initial Aquired size?
OK
Cancel
rlacquir
Figure 31: Reset Lowest Acquired Dialog Box
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 31, if a user clicked OK, the Lowest Acquired
Memory size would be set to 150000.
NCSETUP for Windows
43
NCSETUP
Advanced
Menu
Figure 32 shows the Advanced menu in the main NCSETUP window.
To access this menu, select Advanced from the menu bar.
Wncsetup - JCHDQTRS 1 142
X
File Command Advanced View Help Network
Update Flash...
Debug...
Switch Trace Buffer
Read Memory...
View Current Acquired Memory
Update Flash
advmenu
Figure 32: Advanced Menu
Update Flash
Refer to Table 37 for Update Flash menu options.
Table 37: Update Flash Quick Reference
44
Parameter
Description
Command
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
NCSETUP for Windows
Update Flash
File to Download to NCM Flash
Start Sector
0
Start Address
Choose File
0
End Sector
End Address
Sector Start Address
HEX 32
Reboot NCM after download
OK
Cancel
update1
Figure 33: Update Flash Dialog Box
IMPORTANT:
We strongly recommend that you have an additional
ROM150 SIMM on hand before updating the flash chip.
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
Downloaded
Get 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 doesn’t exist.
2.
Power the NCM download without a battery.
3.
Power the NCM back up.
Or:
Updating the
Flash Chip
1.
Power the NCM download without a battery.
2.
Power the NCM back up.
3.
Abort the download.
!
WARNING:
The FLASH802.FLH contains the primary
downloading code for the NCM. If the download
operation does not complete (for example, you
have a software problem or power failure), the
NCM is inoperable until the ROM150 SIMM is
replaced.
NCSETUP for Windows
45
Follow the steps below to update the flash chip:
1.
Under the Command Menu, choose Update Flash. The Update Flash
dialog box appears (Figure 33).
2.
Press the Choose File button. The Flash Update File-Name Selection
dialog box appears (Figure 34) with the following .FLH files:
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 the following section Details for Updating
NCM350 Flash Code.)
Flash update file-name selection
File name:
Folders:
*.flh
c:\fms\code
Flash802.flh
c:\
fms
code
List files of type:
OK
Cancel
Network...
Drives:
c:
update2
Figure 34: Flash Update File-Name Selection Dialog Box
3.
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.
46
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.
NCSETUP for Windows
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:
Debug Enable
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.
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.
Table 38: Debug Enable Quick Reference
Parameter
Description
Command
Advanced menu, Debug
Hot Key
CTRL - G
Button
Purpose
Set softscope debug settings
NCMs
NCM 200, 300, 350
X
Debug Enable
Softscope Enable
Port Selection
OK
Cancel
Port 2
Port 3
Port 4
Port Baud Rate Selection
9600
Stop at Startup
debug
Figure 35: Debug Enable Dialog Box
NCSETUP for Windows
47
Switch Trace
Buffer
Read Memory
Table 39: Switch Trace Buffer Quick Reference
Parameter
Description
Command
Advanced menu, Switch Trace Buffer
Hot Key
N/A
Button
N/A
Purpose
Advanced troubleshooting
NCMs
Any
Table 40: Read Memory Quick Reference
Parameter
Description
Command
Advanced menu, Read Memory
Hot Key
N/A
Button
N/A
Purpose
Advanced troubleshooting
NCMs
Any
X
Selector
50
Offset
0
task
0
OK
Cancel
Set Address
Figure 36: Read Memory Dialog Box
View Current
Acquired
Memory
48
Table 41: View Current Acquired Memory Quick Reference
Parameter
Description
Command
Advanced menu, View Current Acquired Memory
Hot Key
N/A
Button
N/A
Purpose
Advanced troubleshooting
NCMs
Any
NCSETUP for Windows
NCSETUP View
Menu
The 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 Menu
View Command
Filename
Trace Data
TRCx.lst
Acquired Memory
ACQx.lst
Task Utilization
TSKx.lst
Network Data
NETDATA.txt
First GPF Data
GPFx.lst
Note:
NCSETUP
Network Menu
x represents the NCM number.
The Network menu allows you to collect or stop collection of specified
data for the Metasys Network. The collect data command is disabled when
NCSETUP operates in Standalone mode.
Table 43: Network Menu
Network Command
Description
Collect Data
Begins collection of specified data for the
Metasys 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 will continue
for NCM 15. No further processing is
done for NCMs 16-20.
NCSETUP for Windows
49
Figure 37: Network Data Dialog Box
Table 44: Network Data Collection Options
Option
Description
N1 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
View Acquired
View the acquired memory after a reset for all
NCMs in the network
Task Utilization (10 seconds)
Retrieve task utilization information for all NCMs
in the network
Trace (5000 entries)
View trace data for all NCMs in the network*
GPF Data
View GPF data for all NCMs in the network*
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.
* NCM100 not supported.
50
NCSETUP for Windows
Errors
This section shows the NCSETUP for Windows 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:
Values Out of
Range
•
missing image files
•
values out of range (shown in Debug mode)
An NCSETUP Windows Application dialog box indicates integer values
that are out of range, or character strings of incorrect or improper size.
Ncsetup Windows Application
!
X
Please enter an integer.
OK
Integer
Figure 38: NCSETUP Windows Application Dialog Box
Indicating Invalid Integer
NCSETUP for Windows
51
When you return to the NCM Address Entry dialog box, the invalid
integer is highlighted.
NCM Address Entry
Gate
1
Node
1.1
Network Name
X
JCHDQTRS
View Other Addresses:
Highlt
Figure 39: Highlighted Invalid Integer
Missing
Supporting
Image Files
When either Metasys 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 PMI has not yet been started.
52
NCSETUP for Windows
NCSETUP Parameters
This section explains all of the parameters that are added to the
METASYS.INI file to configure Metasys software for NCSETUP for
Windows. The METASYS.INI file does not ship with NCSETUP for
Windows 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
Entry
NCSETUP 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
Node
When NCSETUP retrieves a list of nodes from the Metasys 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
53
Window
Position
NCSETUP 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, since coordinates may differ screen to screen. The
first time NCSETUP runs, its window is shown at 100, 75, 750, 500. After
NCSETUP shuts down, it saves the current window coordinates.
54
NCSETUP for Windows
Tips for Using NCSETUP for
Windows
This section describes some of the tips that allow greater performance of
NCSETUP for Windows (specifically, how to use NCSETUP and settings
of the initialization file parameters).
OK vs. Cancel
All 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. Using Cancel increases performance of the PC, the NC, and
decreases network traffic.
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.
NCSETUP
repackages
screen information.
Click Cancel.
Normal Operation
NCSETUP tests if
user data is valid.
NCSETUP sends
message back
to NCM.
Normal Operation
commun
Figure 40: Communication Process Between
NCSETUP and NCM
For example, if you select the NOVRAM command, NCSETUP prepares
a request message and sends it to the NCM. After some time, the response
comes back and NCSETUP retrieves the response and decodes it into
information you can understand.
NCSETUP for Windows
55
The NOVRAM View and Modify dialog box appears and you can either
select OK or Cancel. If you select OK, NCSETUP repackages all of the
screen information, and assuming it is valid, sends it back to the NCM.
If the Cancel button is used, NCSETUP returns to normal operation (that
is, does not have to translate the screen information, verify it is valid, and
send it to the NCM).
Printing
Print 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 spawn 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 NCM
NCSETUP requires a network name when doing a direct connect unless
the instructions in Running NCSETUP Direct Connect without Knowing
the Network Name earlier in document are followed. NCSETUP does not
require the network name when connecting over the N1.
Controls Group
507 E. Michigan Street
P.O. Box 423
Milwaukee, WI 53201
56
NCSETUP for Windows
www.johnsoncontrols.com
Release 12.00
Printed in U.S.A.
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement