mcl tool 5.4 - Johnson Controls

Transcription

MCL TOOL 5.4 - SECTION ONE
SOFTWARE OVERVIEW
Chapters
1. MCL Tool Software Architecture
Literature # - TD-2058
Software Overview Introduction
MCL Tool User’s Guide
Rev 5.4
The documentation contained in this publication is the exclusive property of Johnson Controls, Inc., and its use
is restricted to the licensed software with which it is furnished. This publication may not be used for any other
purpose without the express written consent of Johnson Controls, Inc. Johnson Controls, Inc., reserves the right
to update specifications when appropriate. Information contained in this document is based on specifications
believed to be correct at the time of publication.
© 2002, 2004 Johnson Controls, Inc.
All Rights Reserved
www.johnsoncontrols.com
Prublished in U.S.A.
2
Software Overview
Rev 5.4
Table of Contents
Chapter One - MCL Tool Software Architecture
1-1
MCL Tool Software Architecture .......................................................................................
MCL Tool ................................................................................................................
MCLT .....................................................................................................................
LNServer ...............................................................................................................
LNS .......................................................................................................................
OPC LonWorks Server ..........................................................................................
M3 Workstation ......................................................................................................
M5 Workstation ......................................................................................................
NAE .......................................................................................................................
1-2
1-2
1-3
1-3
1-3
1-3
1-3
1-3
1-3
Software Overview Index
Index -1
Software Overview
3
4
Software Overview
Rev 5.4
Chapter One
MCL Tool Software Architecture
This chapter contains information on:
z The MCLT
z The LNServer
z LONWORKS® Network Services (LNS® Services)
z OPC LONWORKS® Server
z The M-Series Workstations
MCL Tool Software Overview
Rev 5.4
MCL TOOL SOFTWARE ARCHITECTURE
MCL Tool software architecture, as it relates to the Metasys® system extended architecture, is comprised of five
main elements:
·
The MCLT
·
The LNServer
·
LONWORKS® Network Services (LNS) Architecture
·
The M3 or M5 Workstation
·
The Object Linking and Embedding for Process Controls (OPC) LONWORKS® Server
The combination of MCL Tool, M-Series Workstation, and OPC technologies provides a full range of facility
management setup, control, and analysis capabilities, all within a LONWORKS®–based environment. Figure 1
below illustrates the basic architecture.
MCL Tool
MCLT
M3* or M5**
Workstation
*Please see the M3
Workstation Users
Manual for product
information.
** Please contact SIS
in Louisville for more
information on using
the M5 Workstation.
OPC
LNServer
LONWORKS
SERVER
LNS
LONWORKS
NODE
NAE
Figure 1. MCL Tool Software Architecture
MCL TOOL
MCL Tool is a LONWORKS® network configuration tool used for the setup and configuration of the building
automation system. It is comprised of three components; MCLT, LNServer, and LNS. MCL Tool can also
export a database of a configured LONWORKS device so it can be viewed and controlled from the Metasys®
system extended architecture environment. See the LONWORKS Network Integration With NAE Technical Bulletin
(LIT-1201668) for more information on Metasys system extended architecture.
1-2
Section 1-Software Overview
Rev 5.4
MCLT
MCLT is the graphical user interface for MCL Tool. All node configuration, node operations, point binding, and
execution of plug-ins is performed using MCLT. MCLT is also used for writing and editing specialty programs
for the Flexible System Controller (FSC) using Control Programming Language (CPL), and scheduling of the
FSC. In addition, the MCLT is used to create the database export files for use in the Metasys system extended
architecture. See the Generate MSEA Export File menu option in Section 3 - System Setup>Chapter 1 Common Node Functions of the MCL Tool 5.4 User’s Guide (LIT-TD2060).
LNSERVER
LNServer allows MCLT to communicate with the LNS architecture. It serves as the interface between MCLT
and the LNS Component Object Model (COM) technology. When the user makes a request in MCLT, the data is
sent to LNServer using TCP-IP protocol. LNServer then communicates the data to LNS. Information is returned
to MCLT and ultimately the user in the same way.
LNS
LONWORKS® Network Services (LNS) 3.0 Architecture is a set of network services that provides inter-operability
between tools. LNS features an Active X “wrapper” that allows it to interface with a variety of applications. LNS
communicates directly with devices on the LONWORKS® network using LONTALK® protocol, and then passes this
information back to the LNServer.
OPC LONWORKS SERVER
The OPC LONWORKS® Server is the “plug-and-play” interface between the M-Series Workstation and the LNS
Architecture. It utilizes Object Linking and Embedding – for Process Control (OPC) technology for plug-andplay software, providing communications between building control systems. The OPC Server accesses data from
the field through LNS, and provides that data to the M-Series Workstation. The multi-tasking OPC LONWORKS®
Server communicates with all LONTALK® media.
M3 WORKSTATION
The M3 Workstation is the dynamic graphical display for the building control system. The M3 Workstation
provides trending, graphics, and alarm features to assist users in analyzing system efficiency and energy consumption. Users can also add navigation links, issue commands, and set up interactive displays of the facility.
M3 receives information from the field via the OPC Server.
M5 WORKSTATION
The M5 Workstation is supported by Johnson Controls Systems Integration Services (SIS) in Louisville Kentucky. Contact SIS Engineering Services for engineering and design help, and SIS Product Support for installed
systems.
NAE
The Network Automation Engine (NAE) with a LONWORKS® network interface serves as a LONWORKS network
integrator within the Metasys® system extended srchitecture. As a LONWORKS network integrator, the NAE
monitors and supervises LONWORKS enabled devices on a single network segment. Data is presented on a Web
browser that is logged in to the NAE or Application and Data Server (ADS) requesting data over the IP network.
MCL Tool is used strictly as a configuration tool to add and setup nodes on the LONWORKS network. Once these
nodes are configured and online, a Web browser, logged in to the NAE is used as the NAE user interface (UI).
An NAE must be commissioned and online on the LONWORKS network to assure communication and control
from the Metasys system extended architecture. Once the NAE and any other LONWORKS devices have been
added to the physical tree, a database export file for each LONWORKS device can be created and then imported
into the NAE using a Web browser. See Generate Metasys Export File in the Section 3 - System Setup Common Node chapter of this document. See the LONWORKS Network Integration With NAE Technical
Bulletin (LIT-1201668) for more information on the NAE.
1-3
1-4
Rev 5.4
Rev 5.4
L
LNS 1-3
LNServer 1-3
M
M3 Workstation 1-3
M5 Workstation 1-3
MCL Tool 1-2
MCLT 1-2, 1-3
N
NAE SWO 1-3
Network Automation Engine 1-3
O
OPC LonWorks® Server 1-3
Index-1
Index-2
Rev 5.4
MCL TOOL 5.4 - SECTION TWO
INSTALLATION AND STARTUP
Chapters
1. MCL Tool Software Installation
2. Hardware Installation
3. Getting Started
Installation and Startup Introduction
Rev 5.4
Echelon ©, Coactive©, Windows NT©, and General Electric© are registered trademarks and service marks of
companies other than Johnson Controls, Inc. FSC™, CPL™ and MCL Tool™ are trademarks of Johnson
Controls, Inc.
All Rights Reserved
Published in U.S.A.
2
Section 2 - Installation and Startup
Rev 5.4
Table of Contents
Chapter
ter One - MCL Tool Software Installation
In
tion
1-1
MCL Tool
ool Overview ...........................................................................................................
..................................
.........................................................
1-2
nfiguration Types .....................................................................................................
............................
.........................................................
PC Configuration
1-2
Installation Checklist ....................................................................................
1-3
...........
.........................................................
Before You Begin The Installation: ..................................................................................... 1-4
Installing Network Protocols ................................................................................... 1-4
Installing MCL Tool For The First Time .............................................................................. 1-5
Configuring LNServer .............................................................................................
.................
........................................... 1-6
Opening The LNServer Configuration
Wizard ..............................................
Co
........................................... 1-6
Configuring LNServer For Local Location ...................................................
........................................... 1-7
Configuring LNServer For Remote Location (TCP/IP
CP/IP - Lightweight Client) 1-10
Configuring LNServer For Remote Location ( NSI
SI - Full Client) ............... 1-13
Configuring LNServer For A Remote Location ( IP - Full Client) ............... 1-15
Chapter Two - Hardware Installation
2-1
Introduction ....................................................................................................................... 2-2
Disabling And Removing The Full-Size PCLTA Card ......................................................... 2-3
Installing The Hardware Drivers ........................................................................................ 2-4
Installing The PCLTA-10/20 Card .................................................................................... 2-11
Installing The PCC-10 (Laptop Only) ............................................................................... 2-11
Chapter Three - Getting Started
3-1
Start-Up Procedure ........................................................................................................... 3-2
Add ESUSA Resources To Catalog ........................................................................ 3-2
Adding ESUSA Resources To Catalog ........................................................ 3-2
Starting MCLT And LnServer .................................................................................. 3-4
Starting MCLT And LNServer Together ........................................................ 3-4
Starting MCLT .............................................................................................. 3-4
Starting LNServer ........................................................................................ 3-4
MCLT Main Window ................................................................................................ 3-5
Title Bar .................................................................................................................. 3-5
Version Number of MCLT Software ........................................................................ 3-5
Resizing The MCLT Windows ................................................................................. 3-6
Menu Bar ................................................................................................................ 3-6
Toolbar .................................................................................................................... 3-6
Physical Tree .......................................................................................................... 3-7
Working Panels ....................................................................................................... 3-7
Server Status Bar ................................................................................................... 3-7
Exiting MCLT ..................................................................................................................... 3-8
Exiting LNServer ............................................................................................................... 3-8
Installation and Startup Index
Index-1
3
4
Rev 5.4
Chapter One
MCL Tool Software Installation
Types of PC Configurations
Minimum System Requirements
Installing MCL Tool
Configuring LNServer
Software Installation
Rev 5.4
MCL TOOL OVERVIEW
Metasys® system Connectivity to LONWORKS® networks (MCL) Tool 5.4 is a LONWORKS Network Services (LNS)
software binding tool used to configure a LONWORKS network, and is based on the LNS database standard. The
LNS database generated by MCL Tool is used to create an OPC tag database for the LONWORKS Network (LN)
Data Access Server.
PC CONFIGURATION TYPES
There are two possible Personal Computer (PC) configurations used in an MCL Tool system:
· Server PC which has the MCLT, LNServer, and LONWORKS Network Services (LNS™)
· Remote/Network PC which has the MCLT, LNServer, LNS™ Client, and communicates with a Server PC
over a network (Figure 1).
Server PC
MCLT
LNServer
LNS
Figure 1. Server PC with MCLT, LNServer, and LNS
Remote/Network PC
ket
Soc
Server PC
MCLT
LNServer
LNS Client
Remote/Network PC
MCLT
LNServer
LNS
Socket
Figure 2. Remote/Network PC Communicating with Server PC through Sockets
1-2
MCLT
LNServer
LNS Client
Rev 5.4
INSTALLATION CHECKLIST
Use this checklist as a guide through the Installation and Startup procedures, beginning with Step 1. If a step is not applicable to your particular
setup, skip that step and proceed with the one immediately following it.
•
•
•
•
•
•
•
•
Step One: Install Network Protocols (TCP/IP)
Step Two: Install MCL Tool
Step Three: Disable and Remove Full-Size PCLTA
Step Four: Install Drivers For Your PCLTA/PCC-10 Card
Step Five: Install PCLTA-10/PCLTA-20/PCC-10
Step Six: Reinstall Service Pack
Step Seven: Starting MCLT
Step Eight: Configure LNServer
1-3
Rev 5.4
BEFORE YOU BEGIN THE INSTALLATION:
Before you begin your MCL Tool installation, verify that your PC meets the minimum criteria listed below. In
order to successfully install MCL Tool 5.4 software, each MCL Tool PC must have the following:
Windows® 2000 Professional operating system with Service Pack (SP) 4 or later
or Windows® XP Professional operating system with SP 1 or later
2.6 GHz Pentium® 4 processor (Dual processors are not supported)
256MB Random Access Memory (RAM), 512 MB for high point density systems
40 GB hard disk capacity minimum (If running System Tools and an M-Series Workstation on the same
computer, maintain at least 600 MB of free space on the hard disk for virtual memory.)
1.44 MB 3.5" diskette drive
Super VGA color monitor (800 x 600), (1024 x 768), or (1280 x 1024)
IBM-compatible mouse
PCLTA-10, PCLTA-20 or PCC-10 (laptop)
Network Adapter
4x or higher CD-ROM drive, CD-RW drive recommended for making backups.
MCL Tool 5.4 Software must be installed in the order given in this User Guide:
1. Install the Network Protocols
2. Install the MCL Tool software
3. Reinstall either the Windows® 2000 Service Pack or Windows® XP Service Pack
4. Configure the LNServer.
INSTALLING NETWORK PROTOCOLS
Windows® 2000 Professional and Windows® XP Professional operating systems both use plug-and-play to
recognize a network interface card when it is present in a PC. Once Windows recognizes the network card it
must be configured with the proper protocols. MCL Tool requires that the TCP/IP protocol be installed.
To verify TCP/IP is present:
1.
Click
and choose Settings > Control Panel.
2.
Double click on the icon labeled Network and Dial-up Connections to open the Network and DialUp Connections screen (Figure 3).
Figure 3. Network and Dial-Up Connections Screen
3.
1-4
Right-click on the Local Area Connection icon and select Properties to open the Local Area
Connection Properties screen (Figure 4).
Rev 5.4
Figure 4. Local Area Connections Properties Page Showing TCP/IP Already Configured
If TCP/IP is in the list of components and the box next to it is checked, then TCP/IP is already configured and active.
If the box next to TCP/IP is not checked, check it to make TCP/IP active.
If TCP/IP is not in the list of components, see your network administrator or refer to the Windows Help
file for information on installing TCP/IP.
INSTALLING MCL TOOL FOR THE FIRST TIME
•
You must set up the network before installing MCL Tool. See Installing Network Protocols in this
chapter.
•
To install MCL Tool, you must log in to your Windows 2000 computer under a profile which has
system administrator privileges. You MUST install TCP/IP on all PCs prior to installing MCL Tool.
•
Before running MCL Tool on a network, you must install a PCLTA-10 or PCLTA-20 card in your PC
(or PCC-10 in the laptop) and configure it (See Chapter Two, Hardware Installation).
NOTE: These installation steps must be performed on every PC, server, and remote PC.
The MCL Tool software is shipped on a CD-ROM. Use the following procedure to install MCL Tool.
To install MCL Tool:
1.
2.
Place the MCL Tool 5.4 Installation CD into the CD ROM drive. Wait about 10 seconds.
If the MCL Tool Autorun does not initialize the software program:
a. Click
and select Run…. from the Start Menu.
b. Select the drive containing the MCL Tool Installation CD.
c. Select the NexSys2 directory.
d. Select Setup.exe and click
.
1-5
Rev 5.4
e. You will be returned to the Run window. Verify that the file path is correct, and click
. A Welcome screen will display. Click
3.
.
The LNS Server install will begin. This is an Echelon installation program executed from within the
MCL Tool Install. Follow the instructions on your monitor. If you are prompted to overwrite
to continue
existing files, select “No To All.” When the installation is complete, click
with the MCL Tool Install program.
4.
Choose the destination directory where MCL Tool 5.4 will be installed. The default directory is C:/
NEXSYS2. If you would like to change the directory, click Browse. Select the appropriate destination and click
5.
, then click
.
Choose the Folder Name for the Start menu. The default name is MCL Tool 5.4. To change the
.
name of this directory, enter a new name into the Program Folders field. Click
6.
A window will display all the settings you’ve chosen for your MCL Tool 5.4 install. Review the
options. If they are correct, select
7.
. To make changes, click
.
A message window will pop up telling you that you must install a valid LONTALK card before MCL
Tool will communicate on the LONWORKS network. Click
.
NOTE: The Windows 2000 installation for the PCLTA-10, PCLTA-20, and PCC-10 cards is found
in the PCLTA directory on the MCL Tool 5.4 Installation CD-ROM. See Chapter Two,
Hardware Installation.
8.
To complete the installation, you must restart the PC. Select the Yes, I want to restart my computer now radio button and click Finish.
Upon completion of the install, you may press
> Programs > MCL Tool 5.4 to display the
three necessary MCL Tool programs. If you like, you may create desktop icons for these programs.
NOTE: Install all hardware (Chapter Two, Hardware Installation) and configure the LNServer
(Chapter Three, Getting Started) before using this application.
CONFIGURING LNSERVER
LNServer uses a Configuration Wizard to guide you through the process. The steps below explain the basic
concepts of each step in the order presented by the Wizard software. Configuration for a local server is ex,
plained first, followed by the steps for configuration on a remote server. Use the
, and
buttons as needed.
OPENING THE LNSERVER CONFIGURATION WIZARD
1.
To open the LNServer Configuration Wizard, either click
on the Windows 2000 task bar
and choose Programs > MCL Tool 5.4 > Configure LNServer (Figure 5),
1-6
Rev 5.4
Figure 5. Start menu for Configure LNServer
OR:
2.
Double click on the
icon on your desktop (if installed).
3.
The MCL Tool LNServer Configuration Wizard window (Figure 6) opens. Click
to
begin the configuration process.
CONFIGURING LNSERVER FOR A LOCAL LOCATION
Figure 6. LNServer Configuration Wizard Window
1.
This screen (Figure 7) prompts you for the location of your server. Use the default selection Local
.
(Your Machine). Click
2.
Figure 7. LNServer Server Location Window
Select your network (Figure 8). You can enter a new network, select an existing one, or delete a
network from this window.
To create a new network:
a. Select the New Network radio button.
b. Enter the Network Name in the text field below. You are allowed a maximum of eight
characters.
c. Enter the name of the Database Folder. You are allowed a maximum of 23 characters. You
can use the
Browse button to select your folder.
d. Click
.
To select an existing network:
1-7
Rev 5.4
a. Select the Existing Network radio button.
b. Using your mouse pointer, click on the network desired.
c. Click
.
To delete an existing network:
a. Using your mouse pointer, click on the network you want to delete.
b. You will be prompted to verify the deletion (Figure 9). Click
c. Click the
button.
Figure 8. LNServer Select Network Window
3.
.
Figure 9. Please Verify Deletion Window
Select the Network Interface from the menu on the right side of the window (Figure 10). If your
setup does not have a PCLTA card, select the No NI (engineered mode). Click
.
Figure 10. LNServer Select Network Interface Window
4.
Enter the properties for your server (Figure 11) as explained below:
NOTE: If you are not sure of the correct properties, use the default values already shown.
Authentication Key: This value acts as an encrypted code that is used by devices in the field to
authenticate that transmissions received are coming from a valid source.
Domain ID: This value can be 1, 3, or 6 bytes long. It will be assigned as the system domain.
Import Folder: Type in or use the
1-8
Browse button to select the path that you want LNServer to
Rev 5.4
follow to find .xif (XIF Image Document) files.
Graphics Folder: Type in or use the
follow to find icons and bitmap files.
Browse button to select the path that you want LNServer to
Resource Catalog Folder: Type in or use the
Browse button to select the path that you want
LNServer to follow to find resource catalog files. These are the files that give LNServer the information
it needs to decode and extracts network variables (NVs) and configuration parameters (CPs).
5.
When you have entered values for all the fields, click
.
6.
The Local IP/Remote Channel Settings window (Figure 12) allows you to restrict who can connect to
your network. The permission string specifies the access permission for remote IP clients. It applies
to all remote IP clients with an IP address that satisfies the rules of the permission string.
to continue.
You can leave the fields blank if you don’t want this option. Click
Figure 11. Local Server Properties Window
7.
Figure 12. Local IP/Remote Channel Settings Window
Use the Subsystem Selection window (Figure 13) to enter a new or existing subsystem. This subsystem will have all new nodes assigned to it. You can also delete a subsystem with this window.
Note: The subsystem can not have the same name as the main system.
To create a new subsystem:
a. Select the New Subsystem radio button.
b. Enter the Subsystem Name in the text field below. You are allowed a maximum of sixteen
characters.
c. Click
.
To select an existing subsystem:
a. Select the Existing Subsystem radio button.
b. Using your mouse pointer, click on the subsystem desired.
c. Click
.
To delete an existing subsystem:
a. Using your mouse pointer, click on the subsystem you want to delete.
1-9
b. Click the
8.
Rev 5.4
button.
The Verify and Exit window (Figure 14) is the last step in the configuration process. Once you have
verified that the LNServer configuration information listed is correct, you can select to exit with or
without starting LNServer.
If the listed information is not correct, use the
Figure 13. Subsystem Selection Window
button to select the correct parameters.
Figure 14. Verify And Exit Window
CONFIGURING LNSERVER FOR A REMOTE LOCATION (TCP/IP - LIGHTWEIGHT
CLIENT)
TCP/IP Lightweight Client in not recommended for more than 2 remote clients. Full client is the recommended
configuration.
1.
This screen (Figure 15) prompts you for the location of your server and other information, if necessary. For a remote server, you must also enter a TCP/IP address and register your network by using
the LNS Remote Configuration Utility (RCU). Follow the steps below:
a. Select the Remote (TCP/IP or NSI) radio button from the MCLT Server Location menu.
b. Select the TCP/IP or NSI from the Remote Server menu.
Figure 15. LNServer Server Location Window
c. Click the
(Figure 16).
1-10
RCU button. The LNS Remote Client Configuration Utility window opens
Rev 5.4
d. From this window, you can add, edit, or delete remote networks. TCP must be selected for the
Default Remote Transport field.
• To add a remote network, click
. The Add LNS Network window opens (Figure
17). Enter the network name and local address (if applicable). Click
Browse to select the
Server Address. The Local LNS Servers window opens (Figure 18). Use the mouse pointer to
. The Server Port will update to
select the network address you want, and click
the selected address.
You will return to the LNS Remote Client Configuration Window, with your network listed in the Remote
Networks field. Click
. Proceed to step 1e.
Figure 16. LNS Remote Client Configuration Window
Figure 17. Add LNS Network Window
Figure 18. Local LNS Servers Window
Figure 19. Edit LNS Network Window
• To edit a remote network, select the network and click
. The Edit LNS Network
window opens (Figure 19). Make changes as described in Adding a Remote Network above.
When you have made all changes, click
. You will return to the LNS Remote
Client Configuration window, with your network will be listed in the Remote Networks field.
If you select it, the changes will be displayed in the lower field. Click
and
proceed to step 1e.
• To delete a network, select the network and click
Click
. The network will be removed.
and proceed to step 3e.
1-11
Rev 5.4
1e. Click
2.
The Network Interface Selection (Figure 20) window opens. Use the default selection Internet in the
.
Remote Network Interface (TCP/IP) field. Click
3.
The Network Selection window opens (Figure 21). You must use an existing network in this window,
and you can not delete networks. This field is the result of the networks you registered using the LNS
Remote Configuration Utility in Step 3. Click the Existing Network radio button, select the network
you want to use, and click
.
Figure 20. Network Interface Selection Window
4.
The Local IP/Remote Channel Settings window (Figure 22) opens. Leave the Remote Server
Settings Channel field blank, and click
5.
Figure 21. Network Selection Window
.
Use the Subsystem Selection window (Figure 23) to select an existing subsystem. Click
..
6.
1-12
Rev 5.4
Figure 24. Verify And Exit Window
7.
Click the
button to save your selections and exit.
CONFIGURING LNSERVER FOR A REMOTE LOCATION ( NSI - FULL CLIENT)
1.
Run the Configure LNServer option from the MCL Tool Menu to display the LNServer Configuration Wizard (Figure 25). Click
to open the Server Location Selection Screen (Figure 26).
This screen prompts you for the location of your server and remote server type. Follow the steps
below:
a. Select the Remote (TCP/IP or NSI) radio button from the MCLT Server Location menu.
b. Select the NSI (Full Client) from the Remote Server menu.
Figure 26. Server Location Selection Window
2.
The Network Interface Selection (Figure 27) window opens. Choose a network in the Remote
.
Network Interface (NSI) field. Click
3.
The Network Selection window opens (Figure 28). You must choose an existing network in this
window. This Existing Network field is the result of the networks you registered previously. Click
the network you want to use, and click
.
1-13
4.
.
5.
6.
.
Figure 31. Verify and Exit Window
1-14
Rev 5.4
Rev 5.4
7.
Click the
CONFIGURING LNSERVER FOR A REMOTE LOCATION ( IP - FULL CLIENT)
1.
Run the Configure LNServer option from the MCL Tool Menu to display the LNServer Configuration Wizard (Figure 32). Click
to open the Server Location Selection Screen (Figure 33).
This screen prompts you for the location of your server and remote server type. Follow the steps
below:
a. Select the Remote (TCP/IP or NSI) radio button from the MCLT Server Location
menu.
b. Select the NSI (Full Client) from the Remote Server menu.
Figure 33. Server Location Selection Window
2.
The Network Interface Selection (Figure 34) window opens. Choose a network in the Remote
.
Network Interface (NSI) field. Click
3.
The Network Selection window opens (Figure 35). You must choose an existing network in this
window. This Existing Network field is the result of the networks you registered previously. Click
the network you want to use, and click
.
1-15
Rev 5.4
4.
.
5.
6.
Figure 38. Verify and Exit Window
7.
1-16
.
Click the
Chapter Two
Hardware Installation
Disabling and Removing a Full-Size PCLTA
Installing the Drivers for Your Card
Installing a PCLTA-10/20
Installing a PCC-10
Rev 5.4
INTRODUCTION
The MCL Tool PC uses the internally mounted Echelon LonTalk® PCLTA-10, the PCLTA-20, or the PCC-10:
• The PCLTA -10 (Figure 1) comes with an integrated transceiver
• The PCLTA-20 is available with:
• An integrated transceiver (Figure 2)
• A non-integrated board with the 78K bps Transceiver daughter-board (Figure 3)
• A 1.25Mbps Transceiver daughter-board (Figure 4)
• The 1.25 Mbps Fiber Optic LONWORKS® SMX™ Transceiver daughter-board (Figure 5).
• The PCC-10 (Figure 6) Card is for use with a laptop.
NOTE: Since MCL Tool 5.4 uses LONWORKS Network Services (LNS), the traditional full-size
PCLTA card with piggyback SMX board may no longer be used.
If you are installing a LonTalk® card for the first time, proceed directly to Installing The
Hardware Drivers. If you have a full-size PCLTA installed, you will need to follow the
procedure Disabling and Removing the Full-Size PCLTA Card on the following page
before you install a new LonTalk® card.
MAYLASIA
ECHELON
LSBR549
FTT-10A
ECH
96-01
MAYLASIA
LSBR549
MAYLASIA
LSBR549
MAYLASIA
LSBR549
MAYLASIA
LSBR549
MAYLASIA
LSBR549
U
L
ECH
96-01
MAYLASIA
LSBR549
Figure 1. PCLTA-10 Board
JP1
ECHELON
FTT-10A
50051
9745A
P1
Figure 2. PCLTA-20 Board With Integrated Transceiver
2-2
J7
JP10
BUS
FREE
JP9
1
0
C
U9
1
Figure 3. SMX 78K Transceiver Board
U9
J1
DS1
JP9
1
1
JP1
LSBR549
1
0
MAYLASIA
ECHELON
506060
946456
LSBR549
MAYLASIA
JP2
TWISTED PAIR MODULAR TRANSCEIVER
J2
1
JP10
1
1
J2
JP3
J1
TM
1
ECHELON
LONWORKS
LSBR549
C
MAYLASIA
LSBR549
MAYLASIA
1
ECHELON MODEL 77040 FTM-10 MODULAR TRANSCEIVER
1
LONWORKSTM
J7
Rev 5.4
ECHELON
Figure 4. SMX 1250 Transceiver Board
LSBR549
MAYLASIA
1
145B148R
DFG-0 HTRX
PBSFLR41R
5810S
PCC-10 Network Adapter
Raytheon
145B148R
Figure 5. SMX Dual Fiber Optic Module (DFOM) Transceiver Board
Figure 6. PCC-10 Card For Laptops
DISABLING AND REMOVING THE FULL-SIZE PCLTA CARD
LNSTM and MCL Tool 5.4 do not support the full-size PCLTA card. MCL Tool PCs require a PCLTA-10,
PCLTA-20, or a PCC-10. However, the Echelon PCLTA driver install program used with NexSys 1.33 and all
previous Windows NT versions of NexSys do not have an uninstall feature. In order to install an LNS compatible card, you must first disable and then physically remove the PCLTA driver from the NT system.
1.
Open the Windows Control Panel by pressing
>Settings>Control Panel. Double click on
the Devices icon. The Devices window displays (Figure 7).
Figure 7. Devices Window
2.
Scroll through the list to find PCLTA. Select it and press
button. Click
. Select the Disabled radio
.
2-3
3.
Press
. Select
Rev 5.4
. Your window should look like Figure 8. Click
.
Figure 8. Device Window Showing The PCLTA Card Disabled
4.
You will have returned to the Devices Window (Figure 7). Click
.
5.
Turn off your PC. Remove the case, and physically remove the full-size PCLTA card.
6.
Reboot your PC.
INSTALLING THE HARDWARE DRIVERS
The PCLTA-10 is a half-size ISA card for a standard PC. The PCLTA- 20 is the PCI version of the card for a
standard PC, and it comes in two varieties; with an integrated transceiver board, or with a piggyback mounted
SMX board.
The PCC-10 is a PCMCIA card for a laptop computer and is equivalent to a PCLTA-10/20 card in a desktop
computer.
No matter which card you use , you will follow the same installation procedure. This is a general guideline for
installing the PCLTA-10/PCLTA-20 or PCC-10 card. To install the driver, you will need the driver and install
files located on your MCL Tool Install CD in the PCLTA10 folder.
1.
Start up Windows. Do NOT install the hardware first, as Echelon recommends that you run the
install program prior to installing the card. Place the MCL Tool Installation CD-ROM into your
CD-ROM drive.
Note: The MCL Tool Installation CD-ROM contains an Autorun file. If the MCL Tool Installation
program does not does not begin automatically within 10 seconds, skip Step 2 and proceed
to Step 3.
2.
The MCL Tool Installation program will automatically open to the Introduction Page (Figure 8).
Click
. The Exit Setup message window displays (Figure 9). Click
should exit the MCL Tool Installation Program and return to your PC Desktop.
2-4
. You
Rev 5.4
Figure 8. MCL Tool Introduction Page
3.
Press
>Run. Click
Pclta10 (Figure 10). Click
Figure 9. Exit Setup Message Window
. Double click on your CD-ROM drive, and then select
. Select Setup.exe (Figure 11) and click
This will return you to the Run window, which will be similar to (Figure12). Click
Figure 10. Select Pclta10
.
.
Figure 11. Select Setup.exe
Figure 12. Run ..\Pclata10\Setup.exe
4. Choose the appropriate language and click . The LONWORKS™ Welcome Window opens (Figure 13).
Click
. The Software License Agreement displays (Figure 14). To accept the terms, click
.
2-5
Figure 13. LonWorks Setup Welcome Window
Figure 15. Select Components Window
4.
Figure 14. Software License Agreement
Figure 16. Select Directory Window
Select the PCLTA-10 or PCLTA-20 or PCC-10 radio button on the Select Components window
. Accept the default installation directory C:\LONWORKS (Figure
(Figure 15) and click
16) and click
Figure 17. Setup Window
2-6
Rev 5.4
.
Rev 5.4
5.
The Setup window shown in Figure 17 displays. When complete, the Optional Device Name
window shown in Figure 18 will display.
Figure 18. Optional Device Name Window
Figure 19. Setup Complete Window
6.
Since this will be the only LonTalk card in your machine, accept 1 as the numeric base for the device
. The window (Figure 19) will display. Click
.
name and click
7.
The install program will ask you if you want to restart the computer. Select the No, I will restart
. A warning message will display
my computer later radio button (Figure 20). Click
(Figure 21). Click
Figure 20. Setup Complete Window
Figure 21. Warning Message Window
2-7
8.
Rev 5.4
Perform a shutdown and remove all power from the computer. Insert the LONWORKS PCLTA-10 or
PCLTA-20 card. Restart the computer. Go to
>Programs >Adminstrative Tools >Event
Viewer. Verify that no errors are associated with the card driver pnplon selected (Figure 22). Go to
> Control Panel > Devices. Confirm that the Status is Started and the Startup is Automatic (Figure 23).
Figure 22. Event Viewer Window
Figure 23. Devices Window
Figure 24. Control Panel’s LonWorks® Plug ‘n Play Window
2-8
Rev 5.4
Figure 25. LON1 Diagnostics Window
9.
Go to
> Control Panel. Double click on the
LonWorks Plug ’n Play window displays (Figure 24). Click
LonWorks® Plug ’n Play icon. The
. The LON1 Diagnos-
. When the PCLTA card is configured correctly, the
tics window appears (Figure 25). Click
diagnostic test will result in a screen similar to Figure 26. Leave the LON1Diagnostics window open.
If the test fails, proceed to Step 11
Figure 26. Example of Results of LON1Diagnostics Test
10.
Connect the PCLTA to the LON. From the LON1 Diagnostics window (Figure 25), click
.
The message window shown in Figure 27 will display. Click
. The card will now be waiting
for a service pin. Press the service pin on any node on the LON. A ping successful message and
receipt of a neuron ID indicates that the interface adapter can communicate with the field. The
installation process is finished and you can skip the remaining steps of this section.
Figure 27. Message Window
Note: If the diagnostic test of step 9 failed, you could have either a hardware failure or a resource
conflict. The remaining steps will help resolve resource conflicts.
2-9
11.
Go to
> Control Panel. Double click on the
Rev 5.4
LonWorks® Plug ‘n Play icon. Click
. Choose the appropriate tab (Figures 28). This option allows you to select an I/O
range and IRQ.
Figure 28. Plug ‘N Play Preferences Window
12.
The selection of the I/O range and IRQ will vary from machine to machine. To check your current
IRQ settings, click
>Programs >Administrative Tools >NT Diagnostics. Select the
Resources tab. The IRQs already in use will display. Select an available IRQ for your LONWORKS
network card.
2-10
13.
If you installed a PCLTA-10, select the PCLTA-10 tab on the Preferences window. Select the
Interrupt Request radio button for one of your available IRQs. By selecting a radio button, you
change the IRQ sequence. If you installed a PCC-10, select the PCC-10 tab on the Preferences
window. First accept the default I/O range (0120-0123), and then try different IRQs. IRQ 15 usually
doesn’t work. Try selecting IRQ 10 and restarting the computer. The PCLTA-20 has no additional
settings.
14.
If you changed the IRQ, reboot the machine and run the diagnostic test again. See step 9. Repeat the
procedure until you find an appropriate IRQ. If you still have trouble with the PCC-10, you may
need to select a different I/O port and reset the IRQs again.
Rev 5.4
INSTALLING THE PCLTA-10/20 CARD
Once the software has been installed, you can now physically install your PCLTA-10 (Figure ) or PCLTA-20
(Figure ) card. Power down the system and mount the board into a 16-bit ISA slot of the MCL Tool PC as
directed below:
1. Power down the system completely, and remove the AC power source.
2. Remove the cover and select on the motherboard:
• an open 16-bit ISA slot (PCLTA-10)
• an open PCI slot (PCLTA-20)
3. Align the card’s edge connector with the PC slot and press the card firmly into place. Be sure to seat the
board’s edge connector carefully and securely.
4. Secure the card to the case using the correct screw for that slot.
5. Connect the LON wiring to the board’s network terminal block.
6. Replace the cover and power up the MCL Tool PC.
INSTALLING THE PCC-10 (LAPTOP ONLY)
Once the software has been installed, you can now physically install your PCC-10 card. Power down the system
and insert the card.
1. Power down the system completely, and remove the AC power source.
2. Insert the PCC-10 into the Type II slot.
3. Connect the network cable that came with the PCC-10.
4. Connect the LON wiring to the board’s network terminal block.
5. Power up the MCL Tool laptop.
2-11
2-12
Rev 5.4
Chapter Three
Getting Started
Adding Resource Files to Catalog
Start-Up Procedure
MCLT Main Window
Exiting MCLT
Exiting LNServer
Getting Started
Rev. 5.4
START-UP PROCEDURE
MCLT is always run concurrently with LNServer. MCLT needs LNServer to communicate with LNS and
ultimately, the devices in the field.
All remote MCLT systems need the LNServer on the main system to be running so that they can communicate
with the network. In accordance with this requirement, the User can open both programs with one command, but
each program must be shut down separately.
NOTE: This chapter gives general information on start-up procedures only. For detailed information
on MCLT functions, see Section Five, Operations - Chapter One.
ADD ESUSA RESOURCES TO CATALOG
After the MCLT installation has been completed, but before starting MCLT and LNServer for the first time, the
User must first add MCLT Resources Files to the LNS Catalog.
ESUSA Resource Files are files that contain the manufacturer-specific information on how to properly display
data on MCLT. All additional information on NVs, CPs, and documentation is contained in the files. The
Echelon LONMARK Support Catalog is a software tool that allows MCLT and LNS easy access to these files.
NOTE: The User must add the Resources Files when starting MCLT and LNServer for the first
time only. Manufacturer’s new or updated Resources Files received at a later date follow
the procedure explained below.
ADDING ESUSA RESOURCES TO CATALOG
1.
Click
> Programs > MCL Tool 5.4> Add ESUSA Resources to Catalog (Figure 1).
2.
The LONMARK Device Resource Files Editor (Figure 2) opens. Click
Figure 1. MCLT Main/Remote System Menu
3.
.
Figure 2. Open LONMARK Resource Files Editor
The Open A Catalog window opens (Figure 3). Select the default directory:
C:\Lonworks\Types\User\ESUSA (Double click on User directory to select ESUSA).
4.
The Edit A Catalog window opens (Figure 4). Click
5.
The Choose A Directory window opens (Figure 5). Verify that the default directory
C:\Lonworks\Types\User\ESUSA is selected, and click
3-2
.
.
Rev 5.4
Getting Started
Figure 3. Open A Catalog Window
Figure 4. Edit A Catalog Window
Figure 5. Choose A Directory Window
Figure 6. Catalog Information Section
6.
You will return to the Edit A Catalog window (Figure 4 above). In the Catalog Information section of
the window (Figure 6), verify the Catalog Status. If the Catalog Status text field states “Needs a
Refresh” (Figure 7), click
7.
.
The Catalog Status field now reads “Up To Date” (Figure 8). Click
.
Figure 7. “Needs A Refresh” Message
Figure 8. “Up To Date” Message
3-3
Getting Started
Rev. 5.4
STARTING MCLT AND LNSERVER
The User can select the Start MCL Tool 5.4 Main System command to open both programs simultaneously.
Both programs can also be opened separately.
STARTING MCLT AND LNSERVER TOGETHER
This command (Figure 9) will open both MCLT and LNServer simultaneously:
1.
Click
> Programs >MCL Tool 5.4> MCL Tool 5.4 Main System
Figure 9. Start MCL Tool 5.4 Main System Dropdown Menu
STARTING MCLT
Two methods are available for starting MCLT:
1.
Double Click on
2.
Click
MCL Tool icon OR:
> Programs>MCL Tool 5.4>MCLT (Figure 10)
Figure 10. Start MCLT Dropdown Menu
STARTING LNSERVER
Two methods are available for starting LNServer:
1.
Double Click on
2.
Click
LNServer icon OR:
> Programs >MCL Tool 5.4> LNServer (Figure 11)
Figure 11. Start LNServer Dropdown Menu
3-4
Rev 5.4
Getting Started
MCLT MAIN WINDOW
The MCLT Main window (Figure 12) has two main areas: the Physical Tree, and the Working Panels. At the top
of the MCLT window is located the Title Bar, Menu Bar, Operator name, and the Tool Bar. The status of
LNServer is also displayed in the lower left-hand corner of the window.
Figure 12. MCLT Main Window
TITLE BAR
The Title Bar (Figure 13) is the horizontal bar at the top of the window. It contains the title of the window, the
MCLT icon, and the
(Maximize),
(Minimize), and
(Close) buttons.
Figure 13. MCLT Title Bar
VERSION NUMBER OF MCLT SOFTWARE
To display the version number of your MCLT software:
1.
From the MCLT menu bar, select Help > About....
2.
The About MCL Tool (Figure 14) opens, displaying the information.
3-5
Getting Started
Rev. 5.4
Figure 14. Message Window showing Software Information
RESIZING THE MCLT WINDOWS
To make a window smaller or larger:
1.
Place the cursor on either a horizontal or vertical window border. When the double
ended arrow appears, drag the edge or corner of the window to resize appropriately.
2.
Dragging the edge of a window will change only one dimension of the window.
To change both the width and the height of the window equally, drag a corner of the window.
If you resize a MCLT window, the workstation will remember. When the resized window is reopened, it will
retain the new dimensions. Use caution when resizing windows. By making a window smaller, you may
eliminate important information fields (check boxes, radio buttons, text fields, etc.) from the visible part of the
window. Use the scroll bars to view the “hidden” part of the screen, or resize the window to show all the fields.
MENU BAR
The Menu Bar (Figure 15) contains the names of MCLT menus. It appears below the Title Bar. Each menu item
is a pull-down list of available commands. You open a menu by clicking on the menu name. Figure 16 below
shows an example of an MCLT Menu Bar pull-down menu.
Figure 15. MCLT Menu Bar
Figure 16. MCLT Menu Bar Pull-down List
TOOLBAR
The MCLT Toolbar has five shortcut buttons that provide quick access to commands. Holding the mouse cursor
over the Toolbar button causes the name of the button to pop up (Figure 17).
Figure 17. MCLT Toolbar
3-6
Rev 5.4
Getting Started
PHYSICAL TREE
The MCLT Physical Tree displays a system tree listing all the nodes in the control system. The tree can be
expanded further, or collapsed. All node commands are initiated from this point. The desired node is selected
from this menu, and the working panels will correspond to the selected node. In Figure 18 below, the VAV-02
node is selected.
Figure 18. MCLT Physical Tree with VAV-01 Node Selected.
WORKING PANELS
MCLT Working Panels gives the user specific information on a selection node. In the example below, the ASG
(Application Specific Graphic) working panel shows the temperature for node VAV-01 (Figure 19).
Figure 19. Example of MCLT ASG Working Panel
SERVER STATUS BAR
The Server Status Bar (Figure 20) allows the user to monitor the status of LNServer. LNServer must be running
for MCLT to operate.
Figure 20. Server Status Bar
3-7
Getting Started
Rev. 5.4
EXITING MCLT
There are five ways to exit the MCLT:
1.
Click on MCLT from the Menu Bar. Select Exit.
2.
Click
3.
Right click anywhere on the MCLT Title Bar. Select Close.
4.
Click the
5.
Click on the MCLT icon in the left corner of the Title Bar. Select Close.
from the MCLT Toolbar
(Close) button from MCLT Title Bar.
EXITING LNSERVER
There are four ways to exit the MCLT:
1.
Click on File from the Menu Bar. Select Exit.
2.
Right click anywhere on the Title Bar. Select Close.
3.
Click the
4.
Click on the LNServer icon in the left corner of the Title Bar. Select Close.
(Close) button from Title Bar.
The LNServer button on the Windows NT Task Bar at the bottom of the screen will appear as in Figure 21.
Figure 21. LNServer Shutting Down
3-8
Rev 5.4
C
P
Catalog 3-2
PC configurations 1-2
PCC-10 2-4
PCLTA Card, Full Size
Disabling 2-3
Removing 2-3
PCLTA-10 2-4
PCLTA-20 2-4
E
ESUSA Resources 3-2
Exiting LNServer 3-8
Exiting MCLT 3-8
H
Hardware Drivers 2-4
I
Installing
PCC-10 2-11
PCLTA-10/20 Card 2-11
Installing a Network Adapter 1-4
Installing MCL Tool For The First Time 1-5
Interrupt Request (IRQ)
Selecting 2-10
L
LNServer
Configuration Wizard 1-6
Configure for Local Location 1-7
Configure for Remote Location 1-10,1-13
Starting LNServer 3-4
Status Bar 3-7
R
Resizing The MCLT Windows 3-6
Resource Files 3-2
Adding ESUSA Resources to Catalog 3-2
S
Section One - Software Overview 1
Section Two - Installation and Startup 1
SMX
1250 Transceiver Board 2-3
78K Transceiver Board 2-3
DFOM Transceiver Board 2-3
Start-Up Procedure 3-2
Starting LNServer And MCLT Together 3-4
Starting MCLT 3-4
V
Version Number of MCLT Software 3-5
M
MCLT Main Window 3-5
Menu Bar 3-6
Physical Tree 3-7
Title 3-6
Toolbar 3-7
Minimum Criteria 1-4
N
Network Adapter
Installing 1-4
Index-1
Index-2
Rev 5.4
MCL TOOL 5.4 - SECTION THREE
SYSTEM SETUP
Chapters
1. Common Node Functions
2. Setting Up a Router
3. Setting Up an FSC/FLC
4. Setting Up a VAV
5. Setting Up a Heat Pump
6. Setting Up a Packaged Equipment Controller
7. Setting Up an NAE
8. Setting Up LN Series Devices
9. Index
System Setup Introduction
Rev 5.4
Johnson Controls, Inc. reserves the right to update specifications when appropriate. Information contained in
this document is based on specifications believed to be correct at the time of publication.
Echelon® and Coactive® are registered trademarks and service marks of companies other than Johnson Controls,
Inc. FSC™, CPL™ and MCL Tool™ are trademarks of Johnson Controls, Inc.
All rights reserved.
www.johnsoncontr
Published in U.S.A
2
Section 3 - System Setup
Rev 5.4
System Setup Table of Contents
Chapter One - Common Node Functions
1-1
Overview ........................................................................................................................... 1-2
Node Menu ........................................................................................................................ 1-2
Node Commands .................................................................................................... 1-2
Wink .............................................................................................................
.............................................................................
1-2
Offline ..........................................................................................................
1-3
..........................................................................
Reset ...........................................................................................................
1-3
...........................................................................
Test ..............................................................................................................
1-4
..............................................................................
Plug-Ins ..................................................................................................................
1-5
..................................................................................
Registering/Unregistering A Plug-In ............................................................
1-5
............................
Running A Plug-In ........................................................................................
1-6
........................................................
Set Time Provider ...................................................................................................
1-7
...................................................................
Move .......................................................................................................................
1-8
.......................................................................................
Add .........................................................................................................................
1-8
.........................................................................................
Setup Node ............................................................................................................
1-9
............................................................................
Check Box Explanations ............................................................................
1-11
..............................................
....................................................................................................... 1-12
Replace Node .........................................................................
Decommission Node ............................................................................................ 1-13
Edit/View Binding .................................................................................................. 1-14
Delete ................................................................................................................... 1-15
Config Data Set .................................................................................................... 1-15
Set Time/Date On Node ....................................................................................... 1-17
Rename ................................................................................................................ 1-17
Upgrade Node ...................................................................................................... 1-18
Generate A MSEA Export File .............................................................................. 1-19
MSEA Export File Naming ......................................................................... 1-20
Export Wizard ............................................................................................ 1-20
Load Firmware ...................................................................................................... 1-23
MultiNode Operations ........................................................................................... 1-26
Connection Description Template (CDT) .............................................................. 1-28
Adding A Connection Description Template (CDT) .................................... 1-28
Modifying Connection Description Templates (CDT) ................................. 1-30
Deleting Connection Description Templates (CDT) .................................... 1-31
Eng. Unit ............................................................................................................... 1-31
Node Configuration Wizard ................................................................................... 1-32
Chapter Two - Setting Up a Router
2-1
Overview ........................................................................................................................... 2-2
Router Classification Types .................................................................................... 2-2
Far-Side Transceiver Types ..................................................................................... 2-3
Adding a Router to the Physical Tree ..................................................................... 2-3
Commissioning a Defined Router ........................................................................... 2-6
Adding Nodes To A Router ..................................................................................... 2-7
Commissioning the PEC .............................................................................. 2-8
Check Box Explanations ................................................................. 2-10
3
Chapter Three - Setting Up an FSC/FLC
Rev 5.4
3-1
Setting Up an FSC/FLC .................................................................................................... 3-2
FSC Overview ........................................................................................................ 3-2
FLC Overview ......................................................................................................... 3-2
Adding an FSC or FLC to the Physical Tree ........................................................... 3-2
Defining an FSC/FLC ................................................................................... 3-3
Commissioning the FSC/FLC ...................................................................... 3-4
Check Box Explanations ................................................................... 3-5
FSC/FLC Configuration Wizard .............................................................................. 3-6
FSC/FLC Wizard Page 1 - Configure FSC Time Values ......................................... 3-7
FSC/FLC Wizard Page 2 - Enable Daylight Savings Time ...................................... 3-8
FSC/FLC Wizard Page 3 - Configure Daylight Savings Time ................................. 3-8
FSC/FLC Wizard Page 4 - Select FSC Modules .................................................... 3-9
Edit FSC Point Tab ................................................................................................ 3-10
General Screen .......................................................................................... 3-10
FSC Point Broadcast Screen ..................................................................... 3-10
Max. Send Time ............................................................................. 3-11
Min. Send Time ............................................................................... 3-11
Min. Delta ........................................................................................ 3-11
NV Update Timeout ......................................................................... 3-11
Actions Screen ........................................................................................... 3-12
Alarm Screen ............................................................................................. 3-12
Feedback Screen ....................................................................................... 3-12
I/O Module Screen Screen ........................................................................ 3-12
Chapter Four - Setting Up a VAV
4-1
Setting up a VAV ................................................................................................................ 4-2
Adding a VAV to the Physical Tree .......................................................................... 4-2
Defining a VAV ............................................................................................. 4-2
Commissioning the VAV ............................................................................... 4-3
VAV Configuration Wizard ...................................................................................... 4-5
VAV Wizard Page 1 - Room Sensor Type .................................................... 4-7
VAV Wizard Page 2 - Thermostat Configuration .......................................... 4-8
VAV Wizard Page 3 - Default Setpoints and Thermal Load Parameters ...... 4-9
VAV Wizard Page 4 - Setpoint Configuration ............................................... 4-9
VAV Wizard Page 5 - Thermal Load Parameters ....................................... 4-10
VAV Wizard Page 6 - K-Factor ................................................................... 4-11
VAV Wizard Page 7 - Flow Parameters ...................................................... 4-13
VAV Wizard Page 8 - Accept Air Flow PID Parameters? ........................... 4-14
VAV Wizard Page 9 - Flow PID Parameters ............................................... 4-14
VAV Wizard Page 10 - Fan Type ................................................................ 4-16
VAV Wizard Page 11 - Reheat Parameters ................................................ 4-16
VAV Wizard Page 12 - Floating Reheat ..................................................... 4-17
VAV Wizard Page 13 - Electric Reheat ...................................................... 4-18
VAV Wizard Page 14 - PWM Reheat ......................................................... 4-18
VAV Wizard Page 15 - Broadcast Damper Inc Output? ............................. 4-20
VAV Wizard Page 16 - Broadcast Damper DEC Output? .......................... 4-20
VAV Wizard Page 17 - Broadcast Fan Output? .......................................... 4-21
4
Rev 5.4
VAV Wizard Page 18 - Broadcast Reheat INC/ST 1 Output? .................... 4-21
VAV Wizard Page 19 - Broadcast Reheat DEC/ST 2 Output? ................... 4-22
Advanced Point Editing ......................................................................................... 4-23
Chapter
ter Five - Setting Up a Heat Pump
5-1
Setting
g up a Heat Pump ...........................................................................
.................................................................................................... 5-2
Adding a Heat Pump to the Physical Tree ....................................
.............................................................. 5-2
.................................................................................. 5-2
Defining a Heat Pump .........................................................
................................................................... 5-3
Commissioning the Heat Pump ..........................................
................................................................... 5-5
Check Box Explanations ..........................................
........................................................................... 5-6
Heat Pump Configuration Wizard ..................................................
.................................................... 5-7
Heat Pump Wizard Page 1 - Room Sensor Type ..........................
.......................................... 5-7
Heat Pump Wizard Page 2 - Thermostat Configuration .................
Parameters ......... 5-8
Heat Pump Wizard Page 3 - Default Setpoints & Thermal Load P
............................................... 5-9
Heat Pump Wizard Page 4 - Setpoint Configuration ......................
Heat Pump Wizard Page 5 - PID Parameters For Thermal Load .......................... 5-10
................................... 5-11
Heat Pump Wizard Page 6 - Local Emergency Shutdown ............
.................................................... 5-11
Heat Pump Wizard Page 7 - Economizer Type .............................
................................................. 5-12
Heat Pump Wizard Page 8 - Economizer Enable ..........................
.................................................... 5-12
Heat Pump Wizard Page 9 - Local Economizer .............................
............................................ 5-13
Heat Pump Wizard Page 10 - Mixed Air Parameters .....................
Heat Pump Wizard Page 11 - Low Limit Shutdown Parameters ...........................
5-14
...
Heat Pump Wizard Page 12 - Fan Controller Parameters ....................................
5-15
.............
Heat Pump Wizard Page 13 - Number of Stages For Compressor?
Compressor .................... 5-16
Heat Pump Wizard Page 14 - Compressor Controller ..........................................
5-17
...................
Heat Pump Wizard Page 15 - Reverse Valve Setup .............................................
5-18
......................
Heat Pump Wizard Page 16 - Loop Enable ..........................................................
5-19
...................................
Heat Pump Wizard Page 17 - Broadcast Output For Damper? ............................
5-19
....
Heat Pump Wizard Page 18 - Broadcast Output For Fan Output? ....................... 5-20
Heat Pump Wizard Page 19 - Broadcast Output For Reverse Valve?
.................. 5-20
Valv
Heat Pump Wizard Page 20 - Broadcast Output For Compressor 1? .................. 5-21
Heat Pump Wizard Page 21 - Broadcast Output For Compressor 2? .................. 5-21
Heat Pump Wizard Page 22 - Broadcast Output For Compressor 3/EH? ............ 5-22
Chapter Six - Setting Up a PEC
6-1
Setting up a PEC ............................................................................................................... 6-2
Adding a PEC to the Physical Tree ......................................................................... 6-2
Defining a PEC ............................................................................................ 6-2
Commissioning the PEC .............................................................................. 6-3
Configuration Wizard (PEC) .............................................................................................. 6-6
PEC Wizard Page 1 - Room Sensor Type .............................................................. 6-7
PEC Wizard Page 2 - Thermostat Configuration .................................................... 6-8
PEC Wizard Page 3 - Default Setpoints and Thermal Load Parameters ................ 6-9
PEC Wizard Page 4 - Setpoint Configuration ......................................................... 6-9
PEC Wizard Page 5 - PID Parameters For Thermal Load .................................... 6-10
PEC Wizard Page 6 - Local Emergency Shutdown .............................................. 6-11
PEC Wizard Page 7 - Economizer Type ............................................................... 6-12
PEC Wizard Page 8 - Economizer Enable ............................................................ 6-12
5
Rev 5.4
PEC Wizard Page 9 - Local Economizer .............................................................. 6-13
PEC Wizard Page 10 - Mixed Air Parameters ...................................................... 6-14
PEC Wizard Page 11 - Low Limit Shutdown Parameters ..................................... 6-15
PEC Wizard Page 12 - Fan Controller Parameters ............................................... 6-16
PEC Wizard Page 13 - Discharge Air Reset From Thermal Load ......................... 6-17
PEC Wizard Page 14 - Discharge Air Reset ......................................................... 6-18
PEC Wizard Page 15 - Number of Valves ............................................................. 6-19
PEC Wizard Page 16 - Winter/Summer Controller ............................................... 6-19
PEC Wizard Page 17 - Local Winter/Summer Controller ...................................... 6-20
PEC Wizard Page 18 - Heating Type ....................................................................
.................................................................. 6-21
PEC Wizard Page 19 - Floating Heating Parameters ...........................................
.................................
......................................... 6-21
.................................
PEC Wizard Page 20 - Discrete Heating Parameters ...........................................
......................................... 6-22
PEC Wizard Page 21 - Cooling Type ....................................................................
..........................................................
.................................................................. 6-23
PEC Wizard Page 22 - Floating Cooling Parameters ...........................................
.................................
......................................... 6-23
PEC Wizard Page 23 - Discrete Cooling ..............................................................
....................................................
............................................................ 6-24
PEC Wizard Page 24 - Broadcast Output For Damper? .............................
.....................................
....................................... 6-25
PEC Wizard Page 25 - Broadcast Output For Fan Output? ........................
................................
.................................. 6-25
PEC Wizard Page 26 - Broadcast Output For Cooling Increment? ............
....................
...................... 6-26
PEC Wizard Page 27 - Broadcast Output For Cooling Decrement? ...........
...................
..................... 6-27
PEC Wizard Page 28 - Broadcast Output For Heating Increment? ............
....................
...................... 6-27
..................... 6-28
PEC Wizard Page 29 - Broadcast Output For Heating Decrement? ...........
...................
Advanced
.................................................................................................... 6-29
ced PEC Editing ........................................
..........................................................................................
..................................................................................................
........................................................................................................ 6-29
Editing Points ............................................
..............................................................................................
......................................................................................................
................................ 6-29
Editing Point #1 - Discharge Air Te
Temp (Analog Input) ......................
..............................
....................................... 6-29
Editing Point #2 - Mixed Air Temp ((Analog Input) .............................
.....................................
........................................... 6-29
Editing Point #3 - Space Temp (Ana
(Analog Input) .................................
.........................................
AIr/Supply Water Temp (Analog Input) .............
Editing Point #4 - Outside AIr/Suppl
...
........... 6-30
Editing Point #5 - Fan Status Input ((Digital Input) ......................................
............................
.................................... 6-30
............................. 6-30
Editing Point #6 - Emergency Shut
Shutdown (Digital Input) ...................
...........................
.................................................. 6-30
Editing Point #7 - Space Temp Cont
Controller ........................................
................................................
.......................................... 6-30
Editing Point #8 - Indoor Air Quality Controller ................................
........................................
........................................................... 6-30
Editing Point #9 - Outside Air Temp .................................................
.........................................................
..................................... 6-30
Editing Point #10 - Manual Occupa
Occupancy Controller ...........................
...................................
.............................................. 6-30
Editing Point #11 - User Setpoint C
Controller ....................................
............................................
...................................................... 6-31
Editing Point #12 - Override Control
Controller ............................................
....................................................
........................................ 6-31
Editing Point #13 - Application Mod
Mode Controller ..............................
......................................
.............................................................. 6-31
Editing Point #14 - Manual Reset ..
....................................................
............................................................
..................................................... 6-31
Editing Point #15 - Low Limit Shutd
Shutdown ...........................................
...................................................
........................................ 6-31
Editing Point #16 - Local Emergenc
Emergency Shutdown ..............................
......................................
......................................... 6-31
Editing Point #17 - LON Emergenc
Emergency Shutdown ...............................
.......................................
....................................................... 6-32
Editing Point #18 - Setpoint Controller .............................................
.....................................................
.............................................. 6-32
Editing Point #19 - Mixed Air PID Controller ....................................
............................................
................................ 6-32
Editing Point #20 - Emergency Command Controller ......................
..............................
........................................... 6-33
Editing Point #21 - Winter/Summer Controller .................................
.........................................
.................................................... 6-33
Editing Point #22 - Temp PID Controller ..........................................
..................................................
................................................. 6-33
Editing Point #23 - Economizer Controller .......................................
...............................................
Editing Point #24 - Fan Controller .............................................................. 6-33
6
Rev 5.4
Editing Point #25 - Heating/Cooling Controller .......................................... 6-33
Editing Point #26 - Analog Output .............................................................. 6-33
Editing Point #27 - Digital Output #1 Fan Actuator Output ......................... 6-33
Editing Point #28 - Digital Output #2 Cooling Stage 1/Inc Output .............. 6-34
Editing Point #29 - Digital Output #3 Cooling Stage 2/Dec Output ............ 6-34
Editing Point #30 - Digital Output #4 Heating Stage 1/Inc Output ............. 6-34
Editing Point #31 - Digital Output #5 Heating Stage 2/Dec Output ............ 6-34
Chapter Seven - Setting Up an NAE
7-1
NAE Overview ................................................................................................................... 7-2
NAE Setup Requirements ...................................................................................... 7-2
Adding an NAE to the Physical Tree ....................................................................... 7-2
Defining an NAE .......................................................................................... 7-2
Commissioning the NAE .............................................................................. 7-3
Chapter Eight - Setting Up LN Series Devices NAE
8-1
LN Series Documentation Overview ................................................................................. 8-2
LN Series Device Plug-in Documentation ......................................................................... 8-2
Metasys System LN Series Documentation ...................................................................... 8-2
System Setup Index
Index-1
7
8
Rev 5.4
Chapter One
Common Node Functions
This chapter contains information about:
Node Commands
Plug-ins
Setting a Time Provider
Moving a Node
Adding a Node
Node Setup
Replacing a Node
Decommissioning a Node
Edit/View Binding
Deleting a Node
Configuration Data Set
Set Time/Date On A Node
Renaming a Node
Upgrading a Node
Generating a Metasys system extended
architecture (MSEA) Export File
Loading Firmware
MultiNode Operations
Connection Template
Dumping Eng. Units
The Node Configuration Wizard
Rev 5.4
OVERVIEW
There are common node functions used in the MCLT. For example, the same process is used for winking a
Flexible System Controller (FSC), Fan Coil Unit (FCU), Heat Pump Unit (HPU), Package Equipment Controller
(PEC), Rooftop Unit (RTU), and a Variable Air Volume controller (VAV-01, and VAV-02). These commonalties
can be loosely categorized as node information accessible from the Physical Tree window, features of the Node
Configuration wizard, and node commands.
NODE MENU
The Node Menu (Figure 1) is used to setup nodes and their functions. There are fifteen menu choices on the
standard Node Menu that help you to configure your system. The Node Menu for the FSC has seventeen menu
choices. See the FSC section of System Setup for more information. The following fifteen menus, several of
which have submenus, explain each function.
NODE COMMANDS
There are four commands available in the Node Commands Menu: Wink, Offline, Reset, and Test. The Node
Commands Menu (Figure 2) is shown below.
Figure 1. Node Menu
Figure 2. Node Commands Menu
WINK
Issuing a Wink command from the Node Commands Menu identifies the selected node in the field. Most devices
flash the Wink LED on that node. However, since Wink tasks are device specific, some 3rd party devices may
include such actions as the flashing of an LED, or sounding of an alarm.
Note: Winking the FSC lights LEDs 1-8 on the 386 CPU.
To Wink a node:
1.
Right click on the node’s icon. The Node Menu appears.
2.
Right click on the Node Commands Menu, the submenu appears (Figure 2).
3.
Click on Wink. The selected node’s Wink LED flashes, the Node Command submenu (Figure 3)
appears and displays “Finished” in the bottom left corner.
Figure 3. Node Command Submenu
4.
1-2
Click the
button to close the Node Command submenu.
Rev 5.4
OFFLINE
Issuing an Offline command from the Node Commands Menu stops the selected node from executing its
application.
NOTE: A PEC is used in the following example.
To take a node Offline:
1.
Right click on the PEC’s icon. The Node Menu appears.
2.
Right click on the Node Commands Menu, the submenu appears (Figure 4).
3.
Click on Offline. The Node Command window appears with a “Working...” message. Once the node
is offline, the message will change to “Finished.” (Figure 5). The Node Command window closes and
the physical tree appears with the PEC now offline (Figure 6).
Figure 4. Node Menu.
Figure 5. Offline Window with Finished Message.
Figure 6. PEC now Offline.
NOTE: Once you take the PEC offline, the Node Commands menu, for that device only, changes
so you can bring the it online. Use the Node Commands Menu Online command to bring
the node back online.
4.
Click the
RESET
Issuing a Reset command from the Node Commands Menu resets the selected node.
To Reset a node:
1.
Right click on the PEC icon. The Node Menu appears.
2.
Click on Node Commands. The submenu appears (Figure 7).
3.
Click on Reset. The Node Command window appears with the “Working” message in the bottom left
corner of the window. When the reset is complete, the message will change to “Finished” (Figure 8).
The Reset window closes and the physical tree appears.
1-3
Figure 7. Node Menu
4. Click the
Rev 5.4
Figure 8. Message Window
TEST
Issuing the Test command from the Node Commands Menu the tests the selected application device or router.
Testing an application device verifies that the device is able to communicate on the network and that its configuration matches the information contained in the LNS database. To pass the test, an application device with the
expected Neuron ID must exist on the network, contain the expected domain/subnet/node address (if the device
is installed), contain the expected program ID, contain the expected network management authentication setting
(enabled or disabled), and, if network management is enabled, contain the correct system authentication key.
Testing a router verifies the router is able to communicate on the network and that its configuration matches the
information contained in the LNS database. To pass the test, a router with the expected Neuron IDs must exist
on the network, contain the expected domain/subnet/node address (if the router is installed), and contain the
expected program ID.
The Test command assumes that the node's network image is up-to-date. Be sure that the node is up-to-date by
running the Test command only while LNServer is in the OnNet mode.
To Test a node:
1.
Right click on the PEC icon. The Node Menu appears (Figure 9).
2.
1-4
Figure 10. Node Command Window
Click on Test. The Node Command window appears with the “Working” message. When the test is
complete, the message will change to “Finished” (Figure 10). The Node Command window closes
and the physical tree appears.
Rev 5.4
PLUG-INS
Plug-Ins are required configuration files and utility programs for third party devices. They provide necessary
setup information for the device to function properly on a LONWORKS network. Contact your device manufacturer for the latest plug-in software for your device. Plug-ins must be registered before they can be run. Before
you can register a plug-in you must first install it to a directory on the hard drive. Next, run the Registering/
Unregistering A Plug-In option to register them.
Important: Refer to the Metasys System LN Series Device Plug-in Installation Quick Start Guide
(LIT-1201982) for detailed information on registering and unregistering LN Series plug-ins.
In the Plug-in Register window you select which plug-ins you would like to register or unregister. The Plug-Ins
menu (Figure 10) is shown below.
Note: You can only register a plug-in from the global node. They can be run from any node.
The Node Menu, when selected from the Global Node, is different than the Node Menu
selected from any other node.
REGISTERING/UNREGISTERING A PLUG-IN
Note: You must first install your 3rd party plug-ins before you can register them. Remember their
location so you can locate them during the registration process.
To register/unregister a plug-in:
1.
Right-click on the global node to display the Global Node Menu (Figure 10).
2.
Click on the Plug-In Menu, then click on Register (Figure 10). The Plug-In Register screen appears
(Figure 11).
Figure 10. Global Node Menu
Figure 11. Plug-In Register Screen Showing an UnRegistered Plug-In
3.
Click on the plug-in you want to register/unregister.
4.
Click
to register the plug-in. The selected plug-in description changes from “Unregis-
tered” to “Registered” (Figure 12).
5.
Click
to unregister the plug-in. The selected plug-in description changes from “Regis-
tered” to “Unregistered”.
1-5
Rev 5.4
Figure 12. Plug-In Register Screen With Newly Registered Plug-In
5.
Click
to close the window and display the tree.
RUNNING A PLUG-IN
To run a Plug-In:
1.
Right-click on the node to display the Node Menu.
2.
Click on the Plug-In Menu, then click on Run (Figure 13). The Plug-In Run window appears (Figure
14).
Figure 13. Node Menu
3.
1-6
Figure 14. Plug-In Run Window
Click on a registered plug-in.
Rev 5.4
4.
Click
to run the plug-in. The plug-in runs and displays (Figure 15).
Figure 15. Run Plug-In Example Result
1.
Complete the Plug-In program and exit to the tree.
SET TIME PROVIDER
The Set Time Provider command (Figure 16), available only on nodes capable of date/time processing, opens
the Set System Time Provider window (Figure 17), allowing you to change the system Time Provider from one
node to another.
Note: Setting an LN Series device as the time provider requires a binding change for proper
operation. Refer to the Readme.txt file for the LN Series device you want to use as a time
provider.
This command should be used only on the NAE, the FSC, and LN Series nodes with a Real
Time Clock (RTC). This command is available on other nodes, but non-RTC nodes do not
keep accurate time.
To Set the Time Porvider:
1.
Right click on the node you want to make the time provider, to open the Node Menu.
1-7
Figure 16. Set Time Provider Menu
Rev 5.4
Figure 17. Set System Time Provider Screen
MOVE
The Move command is used to move a node’s location on the tree.
Note: A PEC is used in this example.
1.
Right click on the PEC icon (Figure 16). The Node Menu appears.
2.
Click on Move. The Move submenu appears (Figure 17).
3.
Click on Up or Down. The selected device moves in the direction you select.
Figure 16. PEC Selected
4.
Figure 17. Move Submenu
Figure 18. PEC Moves To New Position
Repeat as required.
ADD
This command is used to Add a Node or Router to the tree.
1.
1-8
Right click on the Global Node or Router where the PEC will be located. The Node Menu (Figure
19) appears. Click Add to display the secondary menu, then choose Node, then either Before or
After to set the PEC’s placement on the tree. The Add Node menu (Figure 20) appears.
Rev 5.4
2.
Figure 20. Add Node Menu.
Click on the PEC in the list of devices and then enter a name for the PEC in the New Node Name:
area. This should be as descriptive as possible and indicate the purpose and/or location of the PEC.
For example, this could be PEC 2nd Floor West Wing.
NOTE: This field can have a total of 31 characters.
3.
Click
. The uncommissioned PEC has been added to the physical tree (Figure 21).
Figure 21. Physical Tree with Newly Added Uncommissioned PEC
Note: The PEC must be Commissioned using the Setup Node Menu, to be functional.
SETUP NODE
After a node has been added, it must be setup to be functional. This process is called commissioning. After the
node had been setup it will be functional, but will have default configuration settings. It is suggested that you run
the Configuration Wizard to properly configure the node. Any node that has not yet been commissioned will
have (Never Commissioned) after the device’s name on the tree.
1.
Right click on the uncommissioned PEC to bring up the Node Menu (Figure 22). Select Setup Node
to bring up the Node Setup Menu (Figure 23).
1-9
Rev 5.4
Figure 23. Node Setup Menu
2.
If you know the exact Neuron ID for the PEC, type it in the Neuron ID field. The Neuron ID is
specific to the PEC controller you are setting up and is given to the MCLT when the service pin is
pressed on the controller. If you do not know the exact Neuron ID number, do not type anything in
this field. Go to Step 3.
3.
If you don’t know the Neuron ID then click the Service Pin button on the Node Setup menu. Next
press the Service Pin on the PEC you are commissioning. This registers the Neuron ID, Program ID
and associated device specific information. Once you press the service pin on the PEC the Setup
Node Menu displays the PEC’s Neuron ID and Program ID information (Figure 24).
Figure 24. Node Setup Menu after pressing the Service Pin on the PEC
4.
1-10
Click
to advance to the next Node Setup pages (Figures 25 & 26). Select any options you want
Rev 5.4
to configure.
Figure 25. Node Setup Page 2
The checkboxes on Figures 24, 25, and 26 are described in the next paragraph.
CHECK BOX EXPLANATIONS
TIONS
The node setup pages contain a number of checkboxes that are used in the configuration process. Their settings
determine the information sent and whether it is sent from the LNS database to the device, or vice-versa.
Choose carefully how you use these commands. If used incorrectly, it is possible to overwrite default values that
are not recoverable.
NOTE: SEND moves data from the LNS database to the device.
GET moves data from the device to the LNS database.
Send Network Image - Sends the device’s network address and bindings to the LNS database.
Send Config. Data - Sends the device’s configuration parameters (CPs) from the LNS database to the device.
Force Defaults - Sends the default CPs from the LNS database to the device.
Send Trend - Sends Trend setup data from the LNS database to the device.
Get Config. Data - Gets the device’s CPs from the device and sends them to the LNS database. This is used as a
backup in the event the device requires reconfiguration.
Use as defaults - Checking this box gets the device’s current configuration settings and makes them the
default CP settings for all similar devices. These settings are stored in the LNS database.
Note: Use this command when you have a number of devices that will be configured the same.
Get unknown only - Gets any “unknown” CP data, from the device currently being setup, and sends it to
the LNS database. Typically, unknown CP information is associated with 3rd party devices.
Get Trend - Gets Trend setup data from the device and sends it to the LNS database.
Close window when configuring node done - Closes the configuration window and displays the tree as soon as
the configuration process is done.
1-11
5.
Click
Rev 5.4
to save your changes to the Node Setup Menu, close the wizard and display the
tree. This will complete the commissioning process and remove the Never Commissioned label from
the PEC on the tree. Click
to abandon your changes to the Node Setup Menu. If you
cancel you will be prompted to confirm your cancellation. Confirming the cancellation closes the
wizard and returns to the tree display. Abandoning the cancellation returns you to the wizard.
REPLACE NODE
The Replace Node command is used when a defective node device, such as a PEC, must be replaced. Since each
node has a unique Neuron ID, simply replacing the device without using the Replace Node command will cause
errors. The defective device must be replaced with the exact same device type. Example: You
Y cannot replace a
VAV-01 with a VAV-02 since they have different Program ID types. You must either replace it with a VAV-01
VAV or
delete the VAV-01 and then add a VAV-02 in its place.
To Replace a Node:
1.
Go to the field and physically replace the defective node device with the new device and reconnect
all wiring.
2.
Right-click on the node you want to replace, the Node Menu appears (Figure 27).
3.
Click on Replace Node. The first Replace Node window appears (Figure 28).
4.
Press the service pin on the new node device or, if you are sure it is correct, enter the Neuron ID for
the new node device.
5.
Figure 28. Replace Node - Window 1
Press the
to move to the second Replace Node window (Figure 29). Uncheck any of the checkboxes you don’t want to be executed.
Send Config. Data - Sends the previous device’s configuration parameters (CPs) from the LNS
database to the device. This ensures the new node will perform exactly as the old one did.
Exclude Mfg CPs - When selected, this excludes 3rd party manufacturer’s configuration parameters
from being sent from the LNS database to the new node. The Send Config. Data box above must be
checked for this box to be available.
6.
1-12
Press the
to move to the third Replace Node window (Figure 30).
Rev 5.4
7.
This window summarizes the replacement configuration settings. Click
to save your
changes, close the Replace Node window and display the tree. This will complete the node replacement process and display the new node device on the tree. Click
to abandon your changes to
the Replace Node windows. If you cancel you will be prompted to confirm your cancellation.
Confirming the cancellation closes the window and returns to the tree display.
DECOMMISSION NODE
To Decommission a node:
NOTE: A configured VAV-01 is used in the following example.
1.
Right click on the node you want to decommission. The Node menu appears (Figure 31).
2.
Click on Decommission Node. The Decommission Node confirmation screen displays (Figure 32).
Figure 31. Decommission Node
2.
Figure 32. Decommission Confirmation Screen
Click the Close window when decommissioning done box, then click
the node. The node displays its decommissioned status (Figure 33).
to decommission
1-13
Rev 5.4
Figure 33. Decommissioned Node
EDIT/VIEW BINDING
To open the Binding Editor:
NOTE: A configured PEC-01 is used in the following example.
1.
Right click on the PEC icon. The Node menu appears (Figure 34).
2.
Click on Edit/View Bindings. The Binding Editor displays (Figure 35).
3.
Figure 35. Binding Editor.
Edit the bindings as required.
NOTE: For more information on the Bind Node Editor, see the Using the Binding Editor chapter
of the Programming section.
1-14
Rev 5.4
DELETE
This command deletes a node from the physical tree. A confirmation screen prevents accidental deletions.
To delete a node:
1.
Right click on the node you want to delete. The Node Menu appears (Figure 36).
2.
Click on Delete. The Delete Node window asks you to confirm the deletion request (Figure 37).
3.
Figure 37. Delete Confirmation Screen
Click
. The Delete Node window closes and the physical tree appears with the node removed
from the physical tree.
CONFIG DATA SET
The Configuration Data Set (CDS) command allows you to create a device template from a previously configured device. This configuration data set can then be applied as you add other devices of the same type.
There are four Config Data Set Menu (Figure 38) commands:
1. Add - Creates a new CDS file using the selected FSC or ASC.
2. Apply - Applies the selected CDS file to the selected FSC or ASC.
3. Export - Exports the config data of the selected FSC or ASC, to the selected hard drive directory.
Note: Exported config data sets must be imported into the CDS database before it can be applied.
4. Import - Imports previously exported device config data sets into the CDS database.
Note: You can’t import a CDS to a dissimilar device type. Attempting to do so will result in a Program ID mismatch error message.
• To Add a CDS, click Config. Data Set > Add. The Add CDS window opens (Figure 39),
displaying a list of device templates with their corresponding CDS. Click the appropriate item,
.
and click
• To Apply a CDS, click Config. Data Set > Apply. The Apply CDS window opens (Figure 40),
displaying a list of CDSs applicable to the selected node. Click the appropriate item, and click
. A prompt appears, warning you that the existing configuration parameters on the node
will be overwritten. Click
to proceed.
• To Export a CDS, click Config. Data Set > Export. The Export CDS window (Figure 41)
opens, displaying a list of CDSs applicable to the selected node. Check the Current Device
Configuration checkbox if you want to export the selected device. Rename the CDS if you
1-15
Rev 5.4
want to. Click
to export the CDS to the selected directory. It must be imported into the
CDS database before it can be applied to a device.
• To Import a CDS into the CDS database so it can be applied later, click Config. Data Set >
Import. The Import CDS window opens (Figure 42), displaying a list of CDSs exports
available for import. Rename the CDS if you want to. Click
to import the CDS into the
selected directory.
Figure 38. Config. Data Set Menu
Figure 40. Apply CDS Window
1-16
Figure 39. Add CDS Window
Rev 5.4
Figure 41. Export CDS Window
Figure 42. Import CDS Window
SET TIME/DATE ON NODE
This command set the time and date on the selected node.
To set the time and date a node:
1.
Right click on the node you want to set the time and date on. The Node Menu appears (Figure 43).
2.
Click on Set Time/Date on Node. The Set Time/Date Window appears (Figure 44).
3.
Figure 44. Set Time/Date Window
Enter the desired Date and Time for the node.
Note: Pressing the
on the date drop-down box displays a calendar (Figure 45).
Figure 45. Set Time/Date Window with Calendar Displayed
4.
Click
to save your changes and return to the tree.
RENAME
This command renames the selected node.
To rename a node:
1.
Right click on the node you want to rename. This brings up the Node Menu (Figure 46).
2.
Click on Rename, the Rename a Panel window (Figure 47) appears with the current node name
highlighted.
1-17
Rev 5.4
Figure 47. Rename a Panel Window - Old Name
3. Type in the new name (Figure 48) and click
to save your changes. The name changes on the tree,
Done appears in the bottom left corner of the Rename a Panel screen and the
changes to
button
.
Figure 48. Rename a Panel Window - New Name
4. Click
to exit the screen.
UPGRADE NODE
This command upgrades the selected ASC, FSC or 3rd party node by using a new device template. As code
improvements or new features are introduced, new XIF files are created. Before you can upgrade a node the new
XIF file must be copied into the desired directory and then a new device template must be created using the new
XIF file.
To upgrade a node:
1.
Right click on the node you want to upgrade. This brings up the Node Menu (Figure 49).
2.
Click on Upgrade, the Upgrade Node window and (Figure 50) appears.
3.
Click the device template that was created using the new XIF file (Figure 51 and click
sure the device template matches the node’s device type.
. Be
Note: If a device template for the device type you are upgrading is not present in the list, it means
there is no valid template available for the device. The device template currently being used
by the device is never displayed in the device template list.
1-18
Rev 5.4
Figure 50. Upgrade Node Window
Figure 51. Upgrade Node window with highlighted device template
After the node has been upgraded, the firmware must then be updated. See the Load Firmware below.
GENERATE A MSEA EXPORT FILE
The Generate MSEA Export File menu option is used to export a database file of a selected LONWORKS device
so it can be viewed and controlled from the Metasys system extended architecture (MSEA) environment. The
resulting .IMP file provides a means for mapping LONWORKS device point and network variable data into the
Metasys system extended architecture UI. The Web browser user interface of the NAE is used to import the
.IMP file into the NAE database. See the LONWORKS Network Integration With NAE Technical Bulletin
(LIT-1201668) for more information on Metasys system extended architecture.
MCL Tool 5.4 allows you to create a database export file for either an MSEA 1.1 or MSEA 1.2 system. The
table below shows the database export file properties of MCL Tool 5.3 and MCL Tool 5.4. There are database
attribute differences between MSEA 1.1 and MSEA 1.2 systems.
1-19
Rev 5.4
IMPORTANT: If you create an MSEA 1.2 database export file using MCL Tool 5.4 and import it into
an MSEA 1.1 system, an error will result.
MSEA EXPORT FILE NAMING
When MCL Tool 5.4 creates a database export file it automatically adds MSEA 1.1 or MSEA 1.2 to then end of
the file name.
Example: Creating an MSEA 1.2 export file named West Wing Heat Pump.IMP would result in the
file being named West Wing Heat Pump MSEA 1.2.IMP.
Adding the MSEA type helps prevent accidently importing the database into the wrong MSEA system type.
MSEA Version Database Export Table
Database Export File
Imported Into
MCL Tool 5.3 Metasys Export File
MCL Tool 5.3 Metasys Export File
MSEA 1.1 System
MSEA 1.2 System
Valid Retry count attribute set to:
Yes
Yes
NA
1
MCL Tool 5.4 MSEA 1.1 Export File
MSEA 1.1 System
Yes
NA
MSEA 1.1 System
MSEA 1.2 System
ERROR
Yes
NA
Set to # of parents
EXPORT WIZARD
The export wizard has five screens that allow you to select specific parameters to include, and how you want that
information to be formatted in the export file. The screens are as follows:
Screen 1 Export Options - Include Points or NVs in the export file. Select the MSEA version you are importing
the database into. Name the export file.
Screen 2 SNVT_switch Mapping - Include AI/AO, DI/DO or MSI/MSO mapping in the export file.
Screen 3 2-State Point Null Mapping - Map 2-state points as BI/BO(without NULL), MSI/MSO(with NULL),
or map both ways.
Screen 4 Map Complex NV/CP - Expand complex NV, Map to Single GIO, or Don’t Map.
Screen 5 Export Database File and Save Text File - Begin the export process and, if desired, save a text file of
the exported data.
To Generate a Metasys Export File:
1.
Right click on the device’s node icon. The Node Menu appears (Figure 52).
2.
Click on Generate Metasys Export File to open the first screen (Figure 53).
3.
Click on the Points or NVs check-boxes to include them in the export file. Click on the right arrow
to open the second screen (Figure 52).
4.
Click on the MSEA Version drop-down box and select either 1.1 or 1.2.
Note: The Points check-box is disabled if the node does not contain any points.
1-20
Rev 5.4
4.
Figure 53. Export to Metasys - Screen 1
Click on the AO/AI, BI/BO or MSI/MSO check-boxes to set how to map SNVT_switch objects in
the export file. Click on the right arrow to open the third screen (Figure 54).
5.
Click on either the Map 2-state point to BI/BO (without NULL state), Map 2-state point to MSI/
MSO (with NULL state), or Map both ways. Click on the right button carry open the fourth screen
1-21
Rev 5.4
(Figure 55).
5
6.
1-22
Click on either the Map to single GIO, or Don’t Map radio-button to carry out the process in the
exported file. Click on the right button to open the fifth screen (Figure 56).
Rev 5.4
7.
Click the Finish button complete the export process. Click on the Save To File button to save a log
of the current export file (Figure 57).
LOAD FIRMWARE
Loading firmware is used when you want a different software revision on a controller.
IMPORTANT: Use extreme caution when copying firmware to a controller. Sending the wrong
firmware can have disastrous system effects.
IMPORTANT: Before updating the firmware revision on an FSC or FLC, place any critical points in
1-23
Rev 5.4
Fixed mode from the MCLT or place the controller in Hand mode from the field. The process of updating the FSC/FLC firmware from the workstation is lengthy, and during the
update time, the MCLT will not receive point statuses or alarms, or issue commands. Take
the necessary measures to ensure the safety and comfort of building occupants and protect
equipment. The panel will reset after the update firmware is complete.
To Load Firmware to a node:
1.
Right click on the node icon. The Node Menu appears (Figure 58).
NOTE: A node must be configured and Online to update the firmware from the MCLT.
2.
Click on Load Firmware to open the first screen (Figure 59).
Figure 59. Load Firmware Screen 1
3.
Verify the device’s Neuron ID and program ID are correct or hit the service pin to capture it. Click
4.
to move to Screen 2 (Figure 60).
Verify the current hardware and software revision are what you want to overwrite. The current
firmware file path is shown. Click
Figure 60. Screen 2 Showing Old APB File
5.
1-24
to open the Select APB Path window (Figure 61).
Figure 61. Select APB Path
Browse to the folder containing the new APB file you need. Click on the APB file you want to
to save. Once the file is saved, Screen 2 reappears
replace the old APB file with, and click
Rev 5.4
with the new APB file as the default (Figure 62). Click
Existing Nodes (Figure 63).
Figure 62. Screen 2 Showing New APB File
to move to Screen 3 - Options For
Figure 63. Screen 3 - Options For Existing Nodes
Screen 3 sets firmware loading options for existing nodes of the device type you are currently editing, PEC-01 in
this example.
5.
Check the Set Firmware file to box to set all devices on the tree with the device type, PEC-01 in this
example, to use the new firmware file you just selected. This will send the new firmware to every
PEC-01 on the tree when the load checkbox below is checked and the
6.
button is clicked.
Check the Load firmware to devices box to load the selected firmware file to all devices with the
device name ESUSA PEC-01 in this example. The loading process will take place when you press
the
button. Click
to move to Screen 4 (Figure 64).
Screen 4 sets firmware loading options for new nodes. The Use Firmware entry area shows the firmware path
and file name you just selected.
1-25
Figure 64. Options For New Nodes
7.
Figure 65. Summary Screen
Click the Yes radio button to make the new firmware file the default for all new devices, PEC-01 in
this example. Click the No radio button to leave default settings as they are.
Default: No
8.
Rev 5.4
Click
Option: Yes
to move to the summary screen (Figure 67). Review the settings and arrow back to make
any changes. Click
to save all changes and exit to the tree. Click
changes and exit to the tree.
to abandon all
MULTINODE OPERATIONS
Multi-Node Operations allows you to program multiple ASC, FSC or 3rd party nodes at once.
Note: Multi-Node Operations is only available from the Global Node.
To Use Multi-Node Operations:
1.
Right-click on the Global Node to bring up the Node Menu (Figure 68). Click on Multi-Node
Operations, the first Multi-Node Operations screen appears (Figure 69).
Figure 68. Global Node - Node Menu
2.
Figure 69. Multi-Node Operations Screen 1
Click on a node in the Available Nodes window. Use the following keys to select the nodes you want
to configure:
Adds the individual node you select to the Selected Nodes field.
1-26
Rev 5.4
Adds all nodes on the tree to the Selected Nodes field.
Removes nodes from the Selected Nodes field.
Removes all nodes from the Selected Nodes field.
Adds all nodes, having the device type of the node you select, to the Selected
Nodes field.
Multi-Node Operations Screen 2 shows the selected nodes (Figure 70).
3.
Click the
, the Multi-Node Operations Screen 3 appears (Figure 71).
4.
Use the checkboxes to select the operations you want to run. Click the
tions Screen 4 appears (Figure 72).
, the Multi-Node Opera-
Note: The information on Screens 4 and 5 will vary depending on which checkboxes are selected
on Screen 3.
4.
Verify the firmware path and files are correct. Browse and correct any incorrect files. Click the
the Multi-Node Operations Screen 5 appears (Figure 73).
5.
to go back and make any changes. Click
Verify the selected operations. Use the
execute the operations and return to the tree.
,
to
1-27
Rev 5.4
CONNECTION DESCRIPTION TEMPLATE (CDT)
The Connection Description Template (CDT) is the template used to define the parameters of a binding. The
CDT determines the type of addressing and message service to be used, timing parameters, use of authentication
and priority slots, etc. The User can create a new template, or modify existing templates.
The CDT uses five different types of Addressing:
Broadcast - Addresses all the nodes in a subnet or domain.
Neuron ID - Refers to a single node by its unique 48-bit ID
Group -
Refers to numbered group of nodes in the system.
Subnet/Node - Refers to a single node by its domain, subnet, or node (DSN) address (assigned when the
network image is sent to the node for the first time).
Turnaround - Used for connections that take place only within a node.
The CDTs created on the MCL Tool Network Interface node are displayed in the Connection Description
Template List (Figure 64 ). They will also appear in a scrollable Connection Template list in the Bind To Editor
for the User to select when adding a new bind (please see Section for more information on Binding).
To access the CDTs:
1.
Right click on the MCLT Network Interface node. The pop-up menu will open.
2.
Select the Connection Template command (Figure 74).
3.
The Connection Description Template List (Figure 75) opens.
Figure 74. Connection Template Command
Figure 75. Connection Description Template List
ADDING A CONNECTION DESCRIPTION TEMPLATE (CDT)
To add a new CDT:
1.
Open the Connection Description Template List (described above.)
2.
Click
to open the Add Connection Description Template Setting Window
(Figure 76).
3.
1-28
Enter the Name and a Descriptor (if desired) for the CDT in the appropriate text fields (Figure 77).
This information will be displayed in the CDT List (Figure 78). You must enter a Name.
Rev 5.4
Figure 76. Add CDT Setting Window
Figure 77. Name and Descriptor Text Fields
Figure 78. Name and Descriptor as displayed in the CDT List
4.
Enter values for the following parameters:
Addressing:
Force Unicast - Forces LNS to use DSN (domain/subnet/node) or NID (Neuron ID) addressing
where it would normally use group (or broadcast) addressing.
No broadcast - Tells LNS to fail if there is no other way to address the message besides broadcast.
Fail group to broadcast - Tells LNS to use broadcast addressing if it has trouble using group
addressing.
Always broadcast - Tells LNS to always use broadcast addressing.
Service Types:
Service Type Override - Tells LNS that you will choose the service type explicitly rather than
allowing LNS to determine it.
Acknowledged - The message is sent out and acknowledged by the receiver (not to be used for large
group bindings causing failure to received Acknowledge messages.
Unacknowledged repeated - The message is sent out many times to ensure the probability of it
reaching its destination.
Unacknowledged - The message is sent out once.
Request Response - Used only for out-and-back messages (e.g.,. NV polls), not used for binds.
Timing Parameters:
Repeat Count Override - Enter a value for the number of times LNS should repeat an unacknowledged-repeated message.
1-29
Rev 5.4
Retry Count Override - Enter a value for the number of times LNS should retry an acknowledged
message if it does not receive an acknowledgment in time.
Transmit Timer Override - Enter a value for the interval rate LNS waits between retries of
acknowledged and request/response messages.
Receive Timer Override - Select a value that tells LNS the time period within which receiving
devices will treat messages from the same source with the same reference ID as
duplicate messages. Repeats of messages using the above service types all use the
same reference ID as the original to identify them as duplicates.
Repeat Timer Override - Select a value for the interval LNS waits between repeats for unacknowledged-repeated messages.
Other:
Authentication Override - Manually overrides control of the LNS message Authentication option.
Use Authentication - Turns the message Authentication option on, telling MCLT to begin sending
and receiving authentication packets for messages on the network.
Priority Override - Manually overrides control of the LNS message Priority Override option.
Use Priority - Tells LNS that the binding should use a reserved time slot on the network,
helping the message to arrive more quickly to its destination.
Suppress Source Address - Tells LNS to suppress the source address.
MODIFYING CONNECTION DESCRIPTION TEMPLATES (CDT)
To modify an existing CDT:
1.
Open the Connection Description Template List.
2.
Click
to open the Modify Connection Description Template Setting Window
(Figure 79). The Name of the selected CDT appears in the title bar, and both the Name and Descriptor appear in the associated text fields (Figure 80) of the window.
3.
Make changes to settings as desired.
Figure 79. Modify CDT Setting Window
Figure 80. Selected CDT Name and Descriptor
1-30
Rev 5.4
DELETING CONNECTION DESCRIPTION TEMPLATES (CDT)
To delete an existing CDT:
1.
2.
Select the CDT you wish to delete, and click
3.
A Warning box (Figure 81) appears, asking you to confirm the deletion. Click
.
to delete.
Figure 81. Delete CDT Warning Box
ENG. UNIT
The Eng. Unit command is only available from the Node Menu of the FSC.
To run the Eng. Unit screen:
1.
Right-click on the FSC.
2.
Click Eng. Unit from the Node Menu to open the Dump Eng. Unit screen (Figure 82) .
1-31
Rev 5.4
Figure 82. Dump Eng. Unit Screen
3.
Click Dump Ana. button to dump to the screen the analog SNVT data for the selected FSC (Figure
83).
Figure 83. Dump Eng. Unit Analog Data Screen
4.
Click the Dump Dig. Button to dump the digital SNVT data for the selected FSC to the screen.
5.
Click the Table Format box before clicking the Dump Dig. or Dump Ana. buttons to put the data in
a tabular format.
6.
Right-click in the data window and select Select All.
7.
Right-click on the selected data and select Copy.
8.
Open an Excel spreadsheet, right-click in a cell, and select Paste.
9.
Resize the columns and view the data.
NODE CONFIGURATION WIZARD
The Node Configuration Wizard (Figure 69) uses a series of editor screens to configure a device. Each device
type has a different editor to address the device’s specific configuration. See the configuration wizards for each
device in the following System Setup chapters. You are currently in Chapter 1 of the System Setup section.
Chapter 3 - FSC/FLC
Chapter 4 - VAV
Chapter 5 - Heat Pump
1-32
Chapter 6 - PEC
Chapter 7 - NAE
Chapter Two
Setting Up a Router
Adding a Router
Setting up a Router
Adding Nodes To A Router
Splitting a Channel
Setting Up a Router
Rev 5.4
OVERVIEW
This guide is intended for someone familiar with routers, TCP/IP and LONWORKS networks. If you are unfamiliar
with any of these please refer to the:
1. Network Basics book for information on TCP/IP, Router Specifications, and MCLT Networks.
2. Installation and Startup section of this manual for information on setting up TCP/IP.
3. Network Wiring Specifications book for information on LONWORKS network wiring.
Before you begin you should know:
1. Router classification type - How will this router be used?
2. Transceiver type of the router you want to install.
3. A descriptive name for the router that designates a specific location.
4. The Neuron ID of the router should you choose not to use the service pin method.
5. Do you need a “plug-in”? A plug-in is a software configuration file that may be required for some routers.
MCLT provides plug-ins for several common routers. Confirm that the plug-in for the router you are installing is
provided by MCLT. If not you must have the plug-in file provided by the router manufacturer.
The steps to add a router are listed below:
1. Add the router to the physical tree. This is known as Defining.
2. Setup the router. This is known as Commissioning.
3. Add nodes to the router.
4. Setup the nodes on the router.
ROUTER CLASSIFICATION TYPES
MCLT supports six different router classification types using one of four LONWORKS routing algorithms. During
the router installation process you must choose a classification type from the list shown below:
1. Configured Router - A configured router forwards only messages received on either of the router’s
domains. A forwarding table at each end is used for each domain.
2. Learning Router - A learning router forwards only messages that have met specific forwarding rules.
The messages are received on either of the router’s domains. Installation is simplified since network
topology information is not required to configure the learning router.
3. Repeater Router - A repeater router forwards all valid messages, in both directions, regardless of the
destination or domain of the message.
Permanent Repeater Router - A permanent repeater router is a repeater router that, once configured,
cannot be readily reconfigured as a standard repeater. It must be deleted, along with all its associated
nodes, and then reinstalled as a standard repeater router.
4. Bridge Router - A bridge router forwards all messages received on either of the router’s domains
regardless of the message’s domain. Bridges are typically used to span one or two domains.
Permanent Bridge Router - A permanent bridge router is a bridge router that, once configured, cannot
be readily reconfigured as a standard bridge router. It must be deleted, along with all its associated
nodes, and then reinstalled as a standard bridge router.
You will need to know the classification type when you install a router.
2-2
Rev 5.4
Setting Up a Router
FAR-SIDE TRANSCEIVER TYPES
MCLT sets the near-side transceiver type based on the network backbone channel type. During the router
installation process you must choose a far-side transceiver type from the list of LonMark approved far-side
transceiver types shown in the Table below:
Table 1: Far-Side Transceiver Type
Far-Side Transceiver Type
TP/XF-78
PL-30
TP/XF-1250
PL-20N
TP/RS485-78
PL-20C
TP/RS485-78
PL20-A
TP/RS485-625
PL-10
TP/RS485-39
IR-20
TP/RS485-1250 IR-10
TP/FT-10
IP-10W
RF-20
IP-10L
RF-20
FO-20L
RF-10
FO-20S
DC-78
DC-625
DC-1250
Custom—CTI NCB/RF
Custom—CTI NCB/IS
Custom—CTI NCB/IM
Custom—CTI NCB/FL
Custom—CTI NCB/EM
Custom—CTI NCB/EL
Custom
Backplane
Routers supported by MCLT include the standard, Coactive, NCB (Network Combiner Module), ENCB
(Ethernet Network Combiner Module), and the Raytheon FTR (Fiber Optic/Twisted Pair) routers. In addition,
3rd party routers, if they are LonMark compliant and have all necessary plug-ins, should work with MCLT.
ADDING A ROUTER TO THE PHYSICAL TREE
Adding a router to the Physical Tree requires two steps to be carried out in order: defining and commissioning.
Defining - The Add Router Menu is used to define the router’s name, classification type and farside transceiver
type. The router being defined can be either offline or online and does not have to be physically attached to the
network until the commissioning stage.
Commissioning - The Node Setup Menu is used to commission the defined router. Commissioning writes the
network image, Neuron ID, and two network addresses (one for each side) to a database. The defined router
must be online and physically attached to the network.
To add a router to the Physical Tree:
1.
Click on the Physical Tree to highlight where the router will be added. Right click on an open area
of the tree to bring up the Node Menu (Figure 1). Click Add to display the secondary menu, then
click Router, then click either Before or After to set the router placement on the Physical Tree.
After you select Before or After, the Add Router Menu list of available router types is displayed
(Figure 2).
2-3
Setting Up a Router
Figure 1. Node Configuration Menu.
Rev 5.4
Figure 2. Add Router Menu.
Note 1: If you select the Global Node as the location to add the router, the Router will be placed
on the Physical Tree directly AFTER the Global Node. If you select any other place to add
the router your choices are either BEFORE or AFTER the selected entry point.
Note 2: Routers are classified by type as either, Configured, Learning, Repeater, Bridge, Permanent Repeater, or Permanent Bridge. See the Router Guide for more information.
2.
Click on the Classification type of the router you want to install. Then select the Far Side Transceiver type from the list. MCLT already knows the Near Side Transceiver type based on the
network backbone channel type.
IMPORTANT: CHOOSE THE CORRECT ROUTER TYPE. YOU CAN NOT CHANGE THE
ROUTER HARDWARE TYPE ONCE THE MENU ITEM HAS BEEN SELECTED. IF THE
WRONG TYPE IS CHOSEN, ALL THE NODES UNDER THE ROUTER WILL HAVE TO BE
DELETED, THE ROUTER WILL HAVE TO BE DELETED, AND THE CORRECT ROUTER
WILL HAVE TO BE ADDED.
3.
Enter a Name for the router. This should be as descriptive as possible and indicate the purpose and/
or location of the router. For example, this could be 1st Floor - Zone #1.
Split Existing Channel Box Clicking this box “splits” the channel where the router is added (Figure 3).
All nodes physically wired below the router are then placed under the new router on the tree. It
doesn’t matter where on the tree the new router is placed. The tree will move the nodes based only
on physical wiring.
Delay(ms) Box This value represents the average number of milliseconds required for a packet to get onto
the channel once queued. Certain routers have predefined delay values that are automatically chosen
for the specific router. Many routers have a default value of 0, with valid numbers ranging from 0 to
65535. A delay value of 0 uses the default of two packet cycles based on the average packet size.
NOTE: Coactive, NCB, fiber-optic, and ENCB routers must be added in pairs. The local router will
be added first. When you add the remote router, right click on the local router and choose
Add. The option will be Router (for Coactive), Remote NCB, or Remote ENCB. So, the
remote router will be added to the local router.
NOTE: EVERY time a Coactive router is configured from MCLT, you must run RTR_CNF.EXE.
Refer to the Coactive router documentation that came with the router.
2-4
Rev 5.4
MCLT Tree
Before Adding Router
Setting Up a Router
Field Wiring
Before Adding Router
Workstation
Workstation
VAV-02 South Wing
VAV-02 Floor 1
VAV-02 Floor 2
HP-01 Lobby
VAV-02 North Wing
Router to be
wired in here
VAV-02 West Wing
VAV-02 South Wing
HP-01 Lobby
VAV-02 North Wing
VAV-02 Floor 1
VAV-02 West Wing
VAV-02 Floor 2
MCLT Tree
After Adding Router
Workstation
Field Wiring
After Adding Router
Workstation
VAV-02 South Wing
VAV-02 South Wing
VAV-02 North Wing
VAV-02 North Wing
VAV-02 West Wing
VAV-02 West Wing
Router
Router
HP-01 Lobby
HP-01 Lobby
VAV-02 Floor 1
VAV-02 Floor 1
VAV-02 Floor 2
VAV-02 Floor 2
Figure 3 Splitting An Existing Channel Using A Router
4.
Click
. This will add the router node to the physical tree. However, it is not yet configured.
You must run the Node Setup menu selection to configure the router.
2-5
Setting Up a Router
Rev 5.4
COMMISSIONING A DEFINED ROUTER
Once you have defined a router you must commission it. The router must be online for the commissioning
process to work. Routers have two Neuron IDs, one for the near side and one for the far side.
1.
Right-click on the router to be commissioned to bring up the Node Menu (Figure 4).
2.
Click on Setup Node to bring up the Node Setup Menu (Figure 5).
Figure 4. Node Configuration Menu Figure 5. Setup Node Menu
3.
Click on the
button on the Setup Node Menu and then press the service pin on the router.
The Neuron ID is specific to the router you are setting up and is given to the MCLT when the service
pin (CSRVC on the NCB or ENCB router) is pressed on the router. The Neuron ID will appear in the
editor when the service pin is pressed.
NOTE: If you do not know the exact Neuron ID number, leave this field blank and wait for the
service pin to capture it. When the service pin is pressed on a standard router, both Neuron
IDs are sent out, but only one is captured. Both Neuron IDs are given to the MCLT when
the service pin is pressed. The NCB and ENCB routers have two service pins, the CSRVC
and the RSRVC. Press ONLY the CSRVC pin. Pressing the RSRVC pin will cause problems.
4.
Click
to advance to the 2nd Node Configuration Menu (Figure 6).
Figure 6. Node Configuration Menu 2
5.
2-6
Click the Send Network Image box if you want to send the device’s network address to the LNS
button is pressed (Figure 6).
database when the
Rev 5.4
6.
Click
Setting Up a Router
to advance to the 3rd Node Configuration Menu (Figure 7).
Figure 7. Node Configuration Menu 3
7.
Click
to save your changes to the Node Setup Menu, close the window and display the
the Router on the tree. Click
window and returns to the tree display. Abandoning the cancellation returns you to the window.
ADDING NODES TO A ROUTER
To add a node to a Router:
1.
Right click on the Router where the PEC will be located. The Node pop-up menu (Figure 8) appears.
Click Add to display the secondary menu, then choose Node, then At End to set the PEC’s placement after the router on the tree. The Add Node menu (Figure 9) appears.
2.
2-7
Setting Up a Router
3.
Click
Rev 5.4
COMMISSIONING THE PEC
The second step is to commission the PEC. Any PEC that has not yet been commissioned will have (Never
Commissioned) after the PEC’s name on the tree.
1.
2.
2-8
specific to the PEC controller you are setting up and is given to the MCLT when the service pin is
Rev 5.4
3.
Setting Up a Router
4.
Click
to advance to the next Node Setup pages (Figures 14 & 15). Select any options you want
to configure.
The checkboxes on Figures 12, 13, and 14 are described on the next page.
2-9
Setting Up a Router
Rev 5.4
Configure the first device the way you want the rest to resemble. Then
5.
Click
the PEC on the tree. Click
2-10
Chapter Three
Setting Up an FSC/FLC
This chapter contain information on:
Adding an FSC or FLC
Defining an FSC or FLC
Commissioning an FSC or FLC
FSC/FLC Configuration Wizard
Setting the Time on an FSC
Adding I/O Modules to an FSC
FSC Point Broadcast Settings
Rev 5.4
SETTING UP AN FSC/FLC
FSC OVERVIEW
The Flexible System Controllers (FSC) are microprocessor based controllers that work in conjunction with other
FSCs and all Application Specific Controllers (ASCs) in the MCL TOOL family product line. The FSCs provide
complete flexibility and are user defined. The FSCs can be set up for many purposes. For example, they can be
used to:
· Control an HVAC unit that requires more inputs and outputs than are available on an ASC
· Provide the time for an entire system
· Run custom programs
· To determine occupancy for an ASC
The FSC Editor allows you to add 17 point types to the FSC and then program the FSC for your needs. The
programing is done through CPL (Control Programing Language) and gives you the flexibility to program the
FSC to perform the tasks that are specific to your system.
The FSC-01 allows up to eight I/O modules. The FSC-02 allows four I/O modules. The setup of both FSCs will
be discussed in this chapter.
FLC OVERVIEW
The Flexible Lighting Controller (FLC) is a microprocessor based controller that works in conjunction with
other FLCs, FSCs, and all Application Specific Controllers (ASCs) in the MCL TOOL family product line. The
FLC uses the same CPU and programming as the FSC, but has a specific expansion module designed for lighting
control. The Lighting Control Module (LCM), formerly known as the 8 Triac/4 Digital Input expansion module,
is designed for use with 4 G.E. RR7 or RR9 lighting relays. The other expansion modules (8 UI, 4 DO/4 AO, and
8 DO) can be used in conjunction with the lighting expansion module for additional HVAC and lighting control
sequences. The FLC provides complete flexibility and is user defined. The FLC supports lighting control
applications such as:
· Time of day scheduling
· Remote tenant override
· Wink notification before lighting turn-off
· Zoning of lighting relays
· Use of motion detectors or photocells
The FLC is setup through the FSC Editor which allows you to add 17 point types to the FLC and then program
the FLC for your needs. The programing is done through CPL (Control Programing Language) and gives you the
flexibility to program the FLC to perform the tasks which are specific to your system.
ADDING AN FSC OR FLC TO THE PHYSICAL TREE
Adding an FSC/FLC to the Physical Tree requires three steps to be carried out in order. These three steps are
Defining, Commissioning, and Configuring.
Defining - The Add Node Menu is used to install the FSC/FLC on the tree, define the FSC/FLC’s name and
Program ID. The FSC/FLC being defined can be either off-line or on-line and does not have to be physically
attached to the network until the commissioning stage. You can define multiple devices and then commission
them all at once.
Commissioning - The Node Setup Menu is used to commission the defined FSC/FLC. Commissioning writes
the network image, Neuron ID, and Program ID to a database. The defined FSC/FLC must be on-line and
physically attached to the network for the commissioning process to work.
Configuring - The FSC/FLC Wizard is the editor used to configure a commissioned FSC/FLC. The wizard
works at the panel level to assign basic configuration settings and customize the FSC/FLC to your requirements.
Advanced editing at the point level is described in the Advanced Point Editing section of this manual.
3-2
Rev 5.4
DEFINING AN FSC/FLC
To add an FSC/FLC to the Physical Tree:
1.
Right click on the Network Interface or Router where the FSC/FLC will be located. The Node popup menu (Figure 1) appears. Click Add to display the secondary menu, then choose Node, then
either Before or After to set the FSC/FLC’s placement on the tree. The Add Node menu (Figure 2)
appears.
2.
Click on the FSC/FLC in the list of devices and then enter a name for the FSC/FLC in the New
Node Name: area. This should be as descriptive as possible and indicate the purpose and/or location
of the FSC/FLC. For example, this could be FSC 02 West Wing.
3.
Click
. The uncommissioned FSC/FLC has been added to the physical tree (Figure 3).
Figure 3. Physical Tree with Newly Added Uncommissioned FSC
3-3
Rev 5.4
COMMISSIONING THE FSC/FLC
The next step is to commission the FSC/FLC. Any FSC/FLC that has not yet been commissioned will have
(Never Commissioned) after the FSC/FLC’s name on the tree.
1.
Right click on the uncommissioned FSC/FLC to bring up the Node Menu (Figure 4). Select Setup
Node to bring up the Node Setup Menu (Figure 5).
2.
If you know the exact Neuron ID for the FSC/FLC, type it in the Neuron ID field. The Neuron ID is
specific to the FSC/FLC controller you are setting up and is given to the MCL TOOL when the
service pin is pressed on the controller. If you do not know the exact Neuron ID number, do not type
anything in this field. Go to Step 3.
3.
press the Service Pin on the FSC/FLC you are commissioning. This registers the Neuron ID, Program
ID and associated device specific information. Once you press the service pin on the FSC/FLC the
Setup Node Menu displays the FSC/FLC’s Neuron ID and Program ID information (Figure 6).
Figure 6. Node Setup Menu after pressing the Service Pin on the FSC/FLC
3-4
Rev 5.4
4.
Click
to advance to the next Node Setup pages (Figures 7 & 8). Select any options you want to
configure.
• Send Network Image - Sends the device’s network address and bindings to the LNS database.
• Send Config. Data - Sends the device’s configuration parameters (CPs) from the LNS database to the device.
• F o rce Defaults - Sends the default CPs from the LNS database to the device.
• Send Trend - Sends Trend setup data from the LNS database to the device.
• Get Config. Data - Gets the device’s CPs from the device and sends them to the LNS database. This is used
as a backup in the event the device requires reconfiguration.
• Use as defaults - Checking this box gets the device’s current configuration settings and makes them the
Note: Use this command only when you have a number of ASC devices that will be configured the
same. Configure the first ASC device the way you want the rest to resemble.
• Get unknown only - Gets any “unknown” CP data, from the device currently being setup, and sends it to
• Get Trend - Gets Trend setup data from the device and sends it to the LNS database.
• Send CPL/Schedules - Sends CPL/Schedule data from the LNS database to the device.
• Get CPL/Schedules - Gets CPL/Schedule data from the device and sends them to the LNS database.
• Close window when configuring node done - Closes the configuration window and displays the tree as soon
as the configuration process is done.
3-5
5.
Click
Rev 5.4
the FSC/FLC on the tree. Click
to abandon your changes to the Node Setup Menu. If
you cancel you will be prompted to confirm your cancellation. Confirming the cancellation closes the
FSC/FLC CONFIGURATION WIZARD
The FSC/FLC Configuration Wizard is used to configure a newly commissioned FSC/FLC. It steps you through
a series of editor pages and allows you to accept the default settings or enter your own settings. As you move
through the Configuration Wizard the editor pages presented will vary, based on your preceeding choices. For
example, if you select Thermistor instead of Intelligent/TSO, you will automatically skip past the pages for
thermostat configuration, since the thermistor requires no configuration. The FSC/FLC flowchart (Figure 9)
shows each of the pages in the Wizard. The Wizard pages have been numbered to simplify following the
configuration process.
Note: Configuration Wizards for other devices have different point types and configuration pages.
Open The
FSC Wizard
Page 1
Configure
FSC/FLC
Time Values
Page 2
Enable
Daylight Savings
Time?
No
Page 4
Select
FSC
Modules
Finish
Figure 9. FSC/FLC Flow Chart
3-6
Yes
Page 3
Configure Daylight
Savings Time
Rev 5.4
FSC/FLC WIZARD PAGE 1 - CONFIGURE FSC TIME VALUES
The first page to display in the FSC/FLC Wizard is the Configure FSC Time Values page. On this page you set
three time parameters. The first is Status Send Interval which is the time the FSC/FLC will send Status updates.
The Configure FSC Time Values page is displayed below (Figure 10).
Figure 10. Configure FSC Time Values Page
1.
Set the Status Send Interval by typing in a new value, or using the spin boxes. This is the maximum
amount of time that elapses before the FSC or FLC sends a point status to the MCL Tool. This is
done by walking through the list of points and sending one point each time, regardless of the maximum and minimum send times or the send on delta. This keeps the MCL Tool aware that the FSC is
communicating.
Default: 0 seconds
Range: 0 to 1 Hour 49 Minutes and 13 seconds
NOTE: The Maximum time you can enter is 1 Hour 49 Minutes and 13 seconds. If you enter a
time greater than 1 Hour 49 Minutes and 13 seconds and click
to 1 Hour 49 Minutes and 13 seconds.
2.
, the time defaults
Set the Time Broadcast Interval by typing in a new value, or using the spin boxes. This is only
used if this FSC or FLC is the time provider. This interval is the length of time that elapses before the
FSC or FLC synchronizes other controllers to the time.
Default: 15 minutes Range: 0 to 1 Hour 49 Minutes and 13 seconds
NOTE: The Maximum time you can enter is 1 Hour 49 Minutes and 13 seconds. If you enter a
time greater than 1 Hour 49 Minutes and 13 seconds and click
to 1 Hour 49 Minutes and 13 seconds.
3.
, the time defaults
Set the Time Zone Offset From GMT by typing in a new value, or using the spin boxes. This field
represents the number of hours to add to the local standard time to obtain Greenwich Mean Time.
EST add 5 hours, CST add 6 hours, MST add 7 hours, PST add 8 hours.
Default: 5 Range: Hours=0-23 Minutes=0-59 Seconds=0-59
2.
Press
to move to Page 2 - Enable Daylight Savings Time.
3-7
Rev 5.4
FSC/FLC WIZARD PAGE 2 - ENABLE DAYLIGHT SAVINGS TIME
This page sets whether Daylight Savings Time will be enabled or disabled. The Enable Daylight Savings Time is
displayed below (Figure 11).
Figure 11. Enable Daylight Savings Time Page
1.
Accept the default Yes radio button to Enable Daylight Savings Time or click the No radio button to
Disable Daylight Savings Time.
Default: Yes
Option: No
Selecting No skips you to Page 4 - Select FSC Modules.
Selecting Yes moves you to Page 3 - Configure Daylight Savings Time.
2.
Click
to advance to the selected page.
FSC/FLC WIZARD PAGE 3 - CONFIGURE DAYLIGHT SAVINGS TIME
On this page you configure the Daylight Savings Time parameters by setting the Month, Week, Day, and Time
for the Start and End of Daylight Savings Time. The Configure Daylight Savings Time page is displayed below
(Figure 12).
Figure 12. Configure Daylight Savings Time Page
1.
Select the Start and Stop Month for Daylight Savings Time from the drop-down list boxes in the
Month field. This is the month range that Daylight Savings Time will be in effect.
Default: Start=April
2.
End=October
Select the Start and Stop Week for Daylight Savings Time from the drop-down list boxes in the
Week field. These are the weeks of the selected months that Daylight Savings Time begins and
ends.
Default: Start=First End=Last
3.
Select the Start and Stop Day for Daylight Savings Time from the drop-down list boxes in the Day
field. These are the days of the selected weeks that Daylight Savings Time begins and ends.
Default: Start=Sunday End=Sunday
3-8
Rev 5.4
4.
Select the Start and Stop Time for daylight savings time in the Time field. These are the times of
the selected days that daylight savings times changes will begin.
Default: 2 hours
5.
Range: Hours=0-23 Minutes=0-59 Seconds=0-59
Click
to advance to Page 4 - Select FSC Modules.
FSC/FLC WIZARD PAGE 4 - SELECT FSC MODULES
On the Modules page of the FSC Editor you define I/O modules on the FSC or FLC (Figure 13). If you are
editing an FSC-02, only modules 1 to 4 will display. Modules 5 to 8 will not be available with the FSC-02. The
Select FSC Modules page is displayed below (Figure 13).
Figure 13. Select FSC Modules Page
EXPANSION A
MODULE 1
MODULE 2
MODULE 3
MODULE 4
EXPANSION B
386 CPU
The 8 Universal Input (UI), 4 DO/4 AO (4 Digital Output/4 Analog Output), 8 DO (Digital Output), and LCM (8
Triac/4 Digital Input) modules are the I/O modules that can be connected with the FSC or FLC, but the LCM (8
Triac/4 Digital Input) module should only be used for lighting control. A total of 8 I/O modules can be used on
the FSC or FLC, with 4 modules connected to EXPANSION A and 4 modules connected to EXPANSION B of
the 386 CPU. The information on this page must match the hardware in the field. The first module connected to
the 386 CPU on EXPANSION A is Module 1 and the first board connected to EXPANSION B is Module 5
(Figure 14).
MODULE 5
MODULE 6
MODULE 7
MODULE 8
Figure 14. Numbers for I/O Modules.
To complete the Modules page for the FSC Wizard:
1.
Use the drop-down list to select the I/O module type for each Module connected to the FSC or FLC
(Figure 10).
Default: None
Options: None, 8 Univ. Input, 4 AO/4 DO, 8 DO, LCM (8 Triac/4 Dig. Input)
Note: You have the option to select non-checksum I/O boards, typically used in older installations. Most
new installations use checksum I/O boards.
NOTE: The information on this page must match the placement of the I/O modules in the field. For
example, if you have 3 I/O modules and they are all connected to EXPANSION A, then you
must enter the module type for Modules 1, 2, and 3. The other modules should be None.
Likewise, if you have a total of 4 I/O modules and you have 2 modules connected to EXPANSION A and 2 modules connected to EXPANSION B, then you must enter the module
type for Modules 1, 2, 5, and 6. The other modules should be None.
3-9
Rev 5.4
Note: This is the last page in the FSC/FLC Configuration Wizard.
2.
Press
if you need to make any changes in any of the previous pages.
Click
to save your changes and exit the FSC/FLC Wizard.
Click
to abandon your changes and exit the FSC/FLC Wizard. You will be prompted to
confirm your desire to cancel.
EDIT FSC POINT TAB
There are several important configuration steps involving the FSC. The Edit FSC Point tab is used to configure
settings for each FSC point. Screens and menu options vary, depending on the point type.
GENERAL SCREEN
The General screen allows you to set default settings for the selected point (Figure 15).
Figure 15. General Screen
FSC POINT BROADCAST SCREEN
The FSC’s input and output points have broadcast timers that are, in essence, the Send and Receive Heartbeat
timers. They must be configured properly so they don’t add unnecessary “traffic” on the network.
To open the FSC Point Broadcast screen:
1. Click on the FSC icon.
2. Click on the Points icon.
3. Click on the FSC point you want to edit. The detail screen for that point appears.
4. Click on the Edit FSC Point tab to open the General information screen for the point.
3-10
Rev 5.4
5. Click on Broadcast to display the Broadcast screen (Figure 16).
Figure 16. Edit FSC Point Tab’s Broadcast Screen
6. Set the information to configure the point broadcast timing. Details of the menus are listed below.
MAX. SEND TIME
If the process variable does not change and this timer is reached, then the existing point value is broadcast.
MIN. SEND TIME
The amount of time that must pass between the last broadcasted value and the next broadcasted value. The timer
starts when the last value was broadcast.
Note: Setting this value too low can result in unnecessarily high network traffic.
MIN. DELTA
If there is a process change that equals or exceeds the Min. Delta setting, then the new value is broadcast, unless
the Min. Send Timer has not been reached.
Note: Min. Delta default values vary, based on the SNVT used, and should be updated to more
realistically suit the application.
NV UPDATE TIMEOUT
The NV Update Time (Figure 17) is the Receive Heartbeat timer for the point. The default value on FSC input
points is 0, which means it is disabled. If a valid time is entered, and the transmitting node does not send an
update within that time frame, the displayed value should go to the default value setup for the point.
Figure 17. NV Update Timeout Screen
3-11
Rev 5.4
ACTIONS SCREEN
The Actions screen allows you to set action settings for the selected point (Figure 18). Actions types could be
ON/OFF, OPEN/CLOSE, DIRECT/REVERSE, and a number of others, depending on the point type.
Figure 18. Action Screen
ALARM SCREEN
The Alarm screen allows you to set alarm settings for the selected point (Figure 19). When the selected alarm
condition is met an alarm is broadcast. The Alarm Set Time is the time before the alarm is broadcast.
Figure 19. Alarm Screen
FEEDBACK SCREEN
The Feedback screen (Figure 20) allows you to select a digital output point to use as a status feedback point.
Available digital output feedback points are listed in the Digital Point dropdown list. The Command Fail Time
starts a timer when a command is issued. If the command does not match the feedback status within the
Command Fail Time, an alarm is generated.
Figure 20. Feedback Screen
I/O MODULE SCREEN SCREEN
The I/O Module screen (Figure 21) allows you to select an available I/O module, and then assign an available
point on that module to the FSC.
Figure 21. I/O Module Screen
3-12
Chapter Four
Setting Up a VAV
Setting Up A VAV
Defining A VAV
Commissioning A VAV
Configuring A VAV
Setting Up a VAV
MCL TOOL User’s Guide
Rev 5.4
SETTING UP A VAV
The NXA-VAV-02 is an Application Specific Controller (ASC) in the MCL Tool product line. Its primary
purpose is pressure independent Variable Air Volume (VAV) control. The VAV-02 communicates on the same
LONWORKS network with all of the other MCL TOOL controllers. The NXA-VAV-02 is designed with an
integrated actuator for most standard VAV applications.
ADDING A VAV TO THE PHYSICAL TREE
Adding a VAV to the Physical Tree requires three steps to be carried out in order. These three steps are Defining,
Commissioning, and Configuring.
Defining - The Add Node Menu is used to install the VAV on the tree, define the VAV’s name and Program ID.
The VAV being defined can be either off-line or on-line and does not have to be physically attached to the
network until the commissioning stage. You can define multiple devices and then commission them all at once.
network image, Neuron ID, and Program ID to a database. The defined VAV must be on-line and physically
attached to the network for the commissioning process to work.
Configuring - The VAV Wizard is the editor used to configure a commissioned VAV. The wizard works at the
panel level to assign basic configuration settings and customize the VAV to your requirements.
DEFINING A VAV
The first step to adding a VAV is the defining process.
To add a VAV to the Physical Tree:
1.
Right click on the Global Node or Router where the VAV will be located. The Node pop-up menu
(Figure 1) appears. Click Add to display the secondary menu, then choose Node, then either Before
or After to set the VAV’s placement on the tree. The Add Node menu (Figure 2) appears.
2.
Click on the VAV in the list of devices and then enter a name for the VAV in the New Node Name:
area. This should be as descriptive as possible and indicate the purpose and/or location of the VAV.
For example, this could be VAV 2nd Floor West Wing.
3.
4-2
Click
. The uncommissioned VAV has been added to the physical tree (Figure 3).
Rev 5.4
Setting Up a VAV
Figure 3. Physical Tree with Newly Added Uncommissioned VAV
COMMISSIONING THE VAV
The second step is to commission the VAV. Any VAV that has not yet been commissioned will have (Never
Commissioned) after the VAV’s name on the tree.
1.
Right click on the uncommissioned VAV to bring up the Node Menu (Figure 4). Select Setup Node
Figure 4. Node Menu
2.
If you know the exact Neuron ID for the VAV, type it in the Neuron ID field. The Neuron ID is
specific to the VAV controller you are setting up and is given to the MCLT when the service pin is
3.
press the Service Pin on the VAV you are commissioning. This registers the Neuron ID, Program ID
and associated device specific information. Once you press the service pin on the VAV the Setup
Node Menu displays the VAV’s Neuron ID and Program ID information (Figure 6).
4-3
Setting Up a VAV
Rev 5.4
Figure 6. Node Setup Menu after pressing the Service Pin on the VAV
4.
Click
configure.
4-4
Rev 5.4
Setting Up a VAV
5.
Click
the VAV on the tree. Click
VAV CONFIGURATION WIZARD
The VAV Wizard is used to configure a newly commissioned VAV. It steps you through a series of editor pages
and allows you to accept the default settings or enter your own settings. As you move through the VAV Wizard
the editor pages presented will vary, based on your preceding choices. For example, if you select Thermistor
instead of Intelligent/TSO, you will automatically skip past the pages for thermostat configuration, since the
thermistor requires no configuration. The VAV flowchart on the next page (Figure 9) shows each of the pages in
the Wizard. The Wizard pages have been numbered to simplify following the configuration process.
4-5
Setting Up a VAV
Open The
VAV Wizard
Page 1
Intelligent/
TSO?
Rev 5.4
A
Yes
Page 2
Obtain:
Balance Password
Stat Password
Stat Units
Time Display
Override Time
Floating
Page 11
Select
Reheat Type,
Morning Warmup
Electric
No
Page 12
Set
Floating Reheat
Parameters
Page 13
Set
Electric Reheat
Parameters
PWM
Page 3
Accept Default
Setpoints and Thermal
Load Parameters?
No
Page 4
Obtain
Setpoints
Page 5
Obtain
Thermal Load
PID
Parameters
Yes
None
Page 15
Broadcast Damper
Inc Output?
Page 16
Broadcast Damper
Dec Output?
Page 6
Set Box K-Factor
Page 7
Set
Flow Parameters
Page 17
Broadcast Fan
Output?
Page 18
Broadcast Reheat
Inc/St 1?
Page 8
Accept Default Air Flow
PID Parameters?
No
Yes
Page 10
Fan Type
A
Figure 9. VAV Wizard Flowchart
4-6
Page 9
Flow PID
Parameters,
Scan Time,
Drive Time,
Direction
Page 19
Broadcast Reheat
Dec/St 2?
Finish
Page 14
Set
PWM Reheat
Parameters
Rev 5.4
Setting Up a VAV
To enter the VAV Wizard:
1.
Right click on the commissioned VAV to be configured (Figure 10) to bring up the Node Menu
(Figure 11).
Figure 10. Highlighted Commissioned VAV
2.
Select Configuration Wizard to bring up the VAV Wizard’s first editor page, Room Sensor Type
(Figure 12).
VAV WIZARD PAGE 1 - ROOM SENSOR TYPE
The first page to display in the VAV Wizard is the Room Sensor Type page. On this page you choose whether
the VAV will use either an Intelligent/TSO STAT or a thermistor to determine space temperature. If you are using
an Intelligent/TSO STAT, you have the option to use an auxiliary space temperature. If you are using a thermistor, you do not have the option of an auxiliary space temperature. The Room Sensor Type page (Figure 12) is
shown below.
NOTE: You must select Thermistor if you are binding space temperature from another controller.
Figure 12. Room Sensor Type
1.
Click on the appropriate radio button to select either an Intelligent/TSO STAT or a thermistor.
Default: Intelligent Option: Thermistor
Selecting Intelligent/TSO moves you to Page 2 - Thermostat Configuration.
Selecting Thermistor will skip you to Page 4 - Setpoint Configuration.
2.
Press
4-7
Setting Up a VAV
Rev 5.4
VAV WIZARD PAGE 2 - THERMOSTAT CONFIGURATION
On the Thermostat Configuration page you set the Balance Mode password and Stat password, configure
Engineering Units, Time Display and Override Time. The Thermostat Configuration page (Figure 13) for the
Intelligent/TSO STAT is displayed below.
Figure 13. Thermostat Configuration Page
1.
Accept the default or enter a new configuration password in the Stat Password field. This is the
password that is used to enter the Configuration Mode using an Intelligent STAT.
Default: 5001
2.
Accept the default or enter a new configuration password in the Balance Password field. This is the
password that is used to enter the Balance Mode using an Intelligent STAT.
Default: 4999
3.
Range: 0-9999
Range: 0-9999
Select whether the Intelligent STAT displays Engineering Units in English or Metric. This applies
to all units that are displayed on the Intelligent STAT.
Default: English
Option: Metric
NOTE: This applies even if you are using a thermistor because you can still use the Intelligent STAT as a
configuration tool through the STAT port.
4.
Select whether the Intelligent STAT displays the Time Display in AM/PM or Military. This applies
to all time mode parameters that are displayed on the Intelligent STAT.
Default: AM/PM
Option: Military
NOTE: This applies even if you are using a thermistor because you can still use the Intelligent STAT as a
configuration tool through the STAT port.
5.
Select the Override Time for the parameters in User Mode on the Intelligent STAT. Override is used
to cause the system to control to the occupied setpoints when the building is not normally occupied.
Override places the controller back into occupied mode for a specified time (set in the Override Time
field). When this time expires, the previous control (setpoints) resumes.
Default: 50 minutes
6.
4-8
Click
to advance to Page 3 - Default Setpoints and Thermal Load Parameters.
Rev 5.4
Setting Up a VAV
VAV WIZARD PAGE 3 - DEFAULT SETPOINTS AND THERMAL LOAD PARAMETERS
On this page you choose whether to accept the Default Setpoints and Thermal Load Parameters. The Default
Setpoints and Thermal Load Parameters page (Figure 14) for the Intelligent/TSO STAT is displayed below.
Figure 14. Accept Default Setpoints and Thermal Load Parameters Page
1.
Click on the Yes radio button to accept the Default Setpoints and Thermal Load Parameters.
Click on the No radio button to set your own Setpoint and Thermal Load Parameters.
Default: Yes
Option: No
Selecting Yes skips you to Page 6 - Local Emergency Shutdown.
Selecting No moves you to Page 4 - Setpoint Configuration, then Page 5 -Thermal Load Parameters.
2.
Click
VAV WIZARD PAGE 4 - SETPOINT CONFIGURATION
This page sets the Intelligent/TSO STAT’s Heating and Cooling setpoints for the Occupied, Economy, and
Unoccupied modes. The Setpoint Configuration page (Figure 15) for the Intelligent/TSO STAT and Thermistor
is displayed below.
Figure 15. Setpoint Configuration Page
1.
Enter the Occupied Heating and Occupied Cooling Setpoints. These are the setpoints the controller controls to in occupied mode.
Default: Heating=72.00°F (22.2°C) Cooling=73.99°F (23.3°C)
2.
Enter the Economy Heating and Economy Cooling Setpoints. These are the setpoints the controller
controls to in economy mode.
4-9
Setting Up a VAV
3.
Rev 5.4
Enter the Unoccupied Heating and Unoccupied Cooling Setpoints. These are the setpoints the
controller controls to in unoccupied mode.
4.
Enter the User Offset. This is the maximum number of degrees, above and below the user setpoint,
the user is allowed to set the Setpoint on the Intelligent or TSO STAT.
Example: If the setpoint is 70°F and the User Offset is 2°F, the maximum setpoint would be 72°F and the
minimum setpoint would be 68°F.
Default: 2.00°F (1.11°C).
NOTE 1: The offset is never applied to the unoccupied setpoints.
NOTE 2: The values entered on this screen set up a basic relationship between the setpoints.
Even though an offset is determined and added to the setpoints, the numbers entered on
this screen do not change. For more information, see the VAV Engineering Guide.
5.
Click
to advance to Page 5 -Thermal Load Parameters.
VAV WIZARD PAGE 5 - THERMAL LOAD PARAMETERS
This page’s settings are used to calculate thermal load for the controller. The actual space temperature from the
Space Temp Controller and the desired space temperature from the Setpoint Controller and outputs a thermal
load value. This values is then fed to the Economizer Controller, the Fan Controller, and the Heating/Cooling
Controller. The output of the Emergency Command Controller and the output of the Application Mode Controller are also used at in the determination of thermal load. The PID Parameters for Thermal Load page is displayed below (Figure 16).
Figure 16. Set Flow Details Page
1.
Enter the Heating and Cooling PID Prop. Integ. Derv. gains. A PID loop always requires two
values (actual and desired) that have the same engineering units, such as two °F temperatures, two
CFM air flow readings, etc., and generates a command to correct the error between them. Typically,
this command is then used with some other point for a final action. In this case, the point takes the
actual space temperature and the desired space temperature and outputs a thermal load value that is
fed to the Economizer, Fan Controller, and the Heating/Cooling Controller.
The Proportional (Prop.) gain is how much error between the two values you want for 100% control.
Proportional gain is always in the engineering units of the input variables, in this case °F. Decreasing
the proportional gain increases the control.
Default: 4° F
The Integral (Integ.) gain is how much time elapses before 100% of the error is added back into the
control. Integral gain is always in seconds. Decreasing the integral gain increases the control.
Default: 2000 Seconds
4-10
Rev 5.4
Setting Up a VAV
The Derivative (Deriv.) gain controls based on how fast the temperature is changing, and attempts to
sense rapid changes. The derivative gain is always in seconds. Increasing the derivative gain, decreases
control.
Default: 0
NOTE 1: It is recommended that the Derivative gain always be 0.
NOTE 2: If your control is too sensitive and your system is oscillating, you need to increase the
Proportional and/or Integral gains. If your control is too insensitive and it is taking too long to
reach the Active Setpoint, then you need to decrease the Proportional and/or Integral gains.
2.
Enter the Heating and Cooling Scan Rates. This is how often the Heating and Cooling Temperature PID loops are recalculated.
Default:
Cooling = 6 Seconds
Heating = 7 Seconds
NOTE: The Maximum time you can enter is 1 Hour 49 Minutes and 13 Seconds. If you enter a
time greater than 1 Hour 49 Minutes and 13 Seconds and click
, the time defaults
to 1 Hour 49 Minutes and 13 Seconds.
3.
Enter the Default Output. This is a thermal load that is forced to the system in the event of a
controller failure or an invalid space temperature, such as a short or open connection to a sensor or
thermostat.
Default: 50%
4.
Click
to advance to Page 6 - K-Factor.
VAV WIZARD PAGE 6 - K-FACTOR
On the K- Factor page you set the K-Factor, k_Cal and K-Offset. The K-Factor page is displayed below (Figure
17).
Figure 17. K-Factor Page
1.
Enter the K Factor. K Factor is the actual CFM at a measured Velocity pressure of 1 inch water
column. K Factor = CFM / SqRt of Inches of water column. There are 3 different methods to
determine K Factor:
• From the Dual Duct VAV box manufacturer’s field calibration chart, find the curve for the box
size in your system and whatever CFM value exists at exactly 1” w.c. is the K Factor. For
example, on a particular box manufacturer’s field calibration chart, a 10” box supplies 1450
CFM at 1” w.c. Therefore, you would enter 1450 for the K Factor.
4-11
Setting Up a VAV
Rev 5.4
• From the Dual Duct VAV box manufacturer’s field calibration chart, find a point where the
inches of water column and a curve intersect with a CFM vertical line. Then to determine K
Factor use the following equation: K Factor = CFM / SqRt of Inches of water column. For
example, on a particular box manufacturer’s field calibration chart, a 10” box supplies 250
CFM at .03” w.c. Using the above equation, K Factor = 250 / Ö .03. You would enter 1443 for
the K Factor.
• Obtain an exact CFM reading at 1” w.c. from the box manufacturer.
Default: 300
2.
Enter the K Factor Calibration. K Factor Calibration is calibration, or verification, of K Factor to
actual field conditions. To determine K Factor Calibration:
1. Set the VAV box to Maximum CFM position and measure all diffusers for CFM (Measured
CFM).
2. Record the actual CFM reading at the Intelligent Stat or MCLT at the maximum position
(Read CFM).
3. Calculate the difference in CFM (Measured CFM - Read CFM).
4. Use the following equation to calculate K Factor Calibration:
K Factor Calibration = ( Measured CFM - Read CFM) / SqRt of Inches of water column
For example, on a particular box manufacturer’s field calibration chart, a 6” box supplies 500
CFM at 1” w.c. When you command the box to maximum, you get a reading of 490 CFM on
the Intelligent Stat. The Balance Commissioner gets a reading of 505 CFM. Using a manometer, you determine .98” w.c. at 640 CFM.
Now plugging in the numbers to determine K Factor Calibration:
K Factor Calibration = ( Measured CFM - Read CFM) / SqRt of Inches of water column
K Factor Calibration = (505-490)/Ö.98
K Factor Calibration = (15)/.9899494
K Factor Calibration = 15.25
Default: 0
NOTE: For more information regarding K Factor and K Factor Calibration, see the VAV Engineering Guide.
3.
Enter the Flow Offset. Flow Offset is a true offset used to make small adjustments at low CFM
reading. The Flow Offset is limited to no more than 5% of the maximum CFM value. This offset can
be used for inadequate laminar air flow entering the VAV box, installation variances, etc.
Default: 0
4.
4-12
Click
to advance to Page 7 - Flow Parameters.
Rev 5.4
Setting Up a VAV
VAV WIZARD PAGE 7 - FLOW PARAMETERS
The Flow Parameters page sets the desired flow for the controller. The Flow Parameters page is displayed below
(Figure 18).
Figure 18. Flow Parameters Page
1.
Enter the Mode type. This is the pressure mode for the controller
Default: PRESSURE_INDEPENDENT
2.
Enter the Minimum and Maximum Air Flow. These are the minimum and maximum amounts of
air flow the system is allowed to provide in pressure independent mode.
Default:
3.
0 CFM (0 LPS)
Enter the MWU Max. Flow. Morning warmup maximum flow is the maximum flow that the system
is allowed to provide during the morning warmup application mode.
Default:
6.
199 CFM (94 LPS)
Enter the MWU Min. Flow. Morning warmup minimum flow is the minimum flow that the system is
allowed to provide during the morning warmup application mode.
Default:
5.
Minimum=199 CFM (94 LPS) Maximum=1000 CFM (472 LPS)
Enter the Min. Reheat Flow. Minimum reheat flow is the minimum air flow that the system is
allowed to provide while the controller is in reheat.
Default:
4.
Option: PRESSURE_DEPENDENT
Click
1000 CFM (472 LPS)
to advance to Page 8 - Accept Air Flow PID Parameters.
4-13
Setting Up a VAV
Rev 5.4
VAV WIZARD PAGE 8 - ACCEPT AIR FLOW PID PARAMETERS?
On the Accept Air Flow PID Parameters page you choose to Accept or Decline the Air Flow PID Parameters.
The Accept Air Flow PID Parameters page is displayed below (Figure 19).
Figure 19. Flow Parameters Page
1.
Click on the Yes radio button to accept the Air Flow PID parameters.
Click on the NO radio button to set your own Air Flow PID parameters.
Selecting Yes skips you to Page 10 - Fan Type.
Selecting No moves you to Page 9 - Flow PID Parameters.
2.
Click
VAV WIZARD PAGE 9 - FLOW PID PARAMETERS
This point is the desired position of the damper. This point takes the actual air flow from the Flow Sensor and
the desired air flow from the Air Flow Reset Controller and outputs a value to either the Damper Actuator Inc. or
Damper Actuator Dec. This point also looks at the output of the Emergency Command Controller before
determining the output to the damper. The Flow PID Parameters Page is displayed below (Figure 20).
Figure 20. Flow PID Parameters
1.
4-14
Enter the Air Flow Prop. Integ. Derv. gains. A PID loop always requires two values (actual and
desired) that have the same engineering units, such as two °F temperatures, two CFM air flow
readings, etc. and generates a command to correct the error between them. Typically, this command is
then used as with some other point for a final action. In this case, the point takes the actual air flow
and the desired air flow and outputs a value to the Damper Actuator Incr. or Damper Actuator Decr.
Rev 5.4
Setting Up a VAV
Proportional gain is always in the engineering units of the input variables, in this case CFM. Decreasing
Default: 500 CFM
Default: 120
control.
Default: 0
NOTE: It is recommended that the derivative gain always be 0.
NOTE: If your control is too sensitive and your system is oscillating, you need to increase the
proportional and/or integral gains. If your control is too insensitive and it is taking too long to
reach the active setpoint, then you need to decrease the proportional and/or integral gains.
2.
Enter the Scan Time. This is how often the Air Flow PID loop is recalculated.
Default: 5 Seconds
3.
, the time defaults
Enter the Actuator Drive Time. This is the amount of time it takes for the damper to go from full
open to full closed.
Default: 3 minutes
NOTE 1: The drive time for the VAV-02 is 3 minutes. Always consult the manufacturer’s specifications if you are unsure of your damper actuator’s drive time.
4.
Select whether the damper Direction is Clockwise or Counter-Clockwise. This sets the damper to
move in a Clockwise or Counter-Clockwise direction. This is useful if the damper has been wired
wrong in the field.
Default: Clockwise
NOTE: Due to the integrated actuator, a VAV-02 controller should always be Direct. Proportional
gain is always in the engineering units of the input variables, in this case ° F. Decreasing
5.
Enter the Default Position. This is a thermal load that is forced to the system in the event of a
thermostat.
Default: Closed
6.
Click
to advance to Page 10 - Fan Type.
4-15
Setting Up a VAV
Rev 5.4
VAV WIZARD PAGE 10 - FAN TYPE
This page sets the fan type, if any, the controller should use. The Fan Type page (Figure 21) is shown below:
Figure 21. Fan Type
1.
Select whether the fan type for the VAV system is None, Serial, or Parallel.
Default: PARALLEL
2.
Click
Options: NONE, SERIAL
to advance to Page 11 - Reheat Parameters.
VAV WIZARD PAGE 11 - REHEAT PARAMETERS
The Reheat Parameters page determines what reheat type (if any) should be used. It looks at the output of the
Temp PID Controller and determines if reheat should be ON or OFF. The output of this point is sent to the
Reheat Increment/Stage 1 and the Reheat Decrement/Stage 2, which are the control points for reheat. The
Reheat Parameters page is displayed below (Figure 22).
Figure 22. Reheat Parameters
1. Enter the Reheat Type.
Options:
REHEAT_NONE
REHEAT_FLOATING
REHEAT_2_STAGE_ELEC
REHEAT_3_STAGE_ELEC
REHEAT_PWM
2. Enter the Morning Warmup default status setting.
Options:
MWU_REHEAT_ENABLE
MWU_REHEAT_DISABLE
4-16
Rev 5.4
Setting Up a VAV
Selecting REHEAT_NONE skips you to Page 15 - Broadcast Damper DEC Output.
Selecting REHEAT_FLOATING moves you to Page 12 - Floating Reheat Parameters.
Selecting REHEAT_2_STAGE_ELEC or REHEAT_3_STAGE_ELEC skips you to Page 13 - Electric
Reheat Parameters.
Selecting REHEAT_PWM skips you to Page 14 - PWM Reheat Parameters.
3.
Click
VAV WIZARD PAGE 12 - FLOATING REHEAT
On the Floating Reheat page you set the controllers Drive Time, Direction, and Default Position. The Floating
Reheat page is displayed below (Figure 23).
Figure 23. Floating Reheat Page
1.
Enter the Drive Time. This is the amount of time it takes to drive the motor controlling the reheat
valve from full open to full closed.
Default: 1 Minute and 30 Seconds
, the time defaults
2.
Enter the Direction. This is the direction the damper moves.
Default: Clockwise
3.
Option: Counter-Clockwise
Enter the Default Position for the damper.
This determines if the motor is moving in the Normal direction or if it is moving in the Reverse
direction. Points 20 and 21 are the increment and decrement controls for the reheat. If Point #20
increases the heat and Point #21 decreases the heat, then select Normal. If Point #20 decreases the heat
and Point #21 increases the heat, select Reverse. This is helpful if the reheat device has been wired
backwards.
Default: Close
4.
Click
Option: Open
to skip to Page 15 - Broadcast Damper DEC Output.
4-17
Setting Up a VAV
Rev 5.4
VAV WIZARD PAGE 13 - ELECTRIC REHEAT
On the Electric Reheat page you set the Interstage Delay. This is a minimum amount of time that must elapse
after a stage of reheat has turned ON. The Electric Reheat page is displayed below (Figure 24).
Figure 24. Electric Reheat Page
1.
Enter the Interstage Delay.
, the time defaults
2.
Click
to skip to Page 15 - Broadcast Damper DEC Output
VAV WIZARD PAGE 14 - PWM REHEAT
On the PMW (Pulse Width Modulation) Reheat page you set the Minimum On Time, Pulse Width, and
Minimum Off Time for the controller. When pulse width modulation is used, an electrical pulse of variable
length correlates directly with the value under regulation. For example, a pulse width might be 5 seconds and
the output value may range from 0-100%. If the pulse sent were 2.5 seconds, the controller would regulate the
device to 50%. A 2.5 second signal would be sent by the controller each time the modulator cycles. The PWM
Reheat page (Figure 25) is displayed below.
Figure 25. PWM Reheat Page
1.
Enter the Minimum On Time.
The Minimum On Time is the length of each pulse if the output value is determined by the controller to
be 0%. This initializing pulse, like a heartbeat, indicates that the controller is active and a pulse will
follow. This value may be set to zero.
Default: 0
4-18
Rev 5.4
2.
Setting Up a VAV
Enter the Pulse Width.
The Pulse Width is the maximum length of a pulse. If a maximum pulse is sent, the output value will
be 100%. If the pulse sent minus the minimum on time is zero seconds, then the output value will be
0%. When the Minimum On Time, Pulse Width, and Minimum Off Time are added together, you
find the length of the pulse modulation cycle. If you wish to have a cycle length of 60 seconds, the
minimum on time is set to 0, and a maximum pulse length is set to 5 seconds, then the minimum off
time would be set to 55 seconds. See Figure 31. Refer to the note under step 6.
Default: 1 Minute and 30 Seconds
Min.
Off
Time
Min.
On
Time
Pulse Width for 50% Output
Min.
Off
Time
Min.
On
Time
Min.
Off
Time
Min.
On
Time
Min.
Off
Time
Min.
On
Time
One Cycle Length
Min.
Off
Time
Min.
On
Time
One Cycle Length
Min.
Off
Time
Min.
On
Time
One Cycle Length
Figure 31. A Pulse Width Modulation Cycle.
3.
Enter the Minimum Off Time.
The Minimum Off Time is used to set an off time after a pulse cycle. This value may be set to zero.
This value is used to space out the actuator updates by requiring an off period where nothing occurs.
Default: 0
4.
Click
to advance to Page 15 - Broadcast Damper DEC Output
4-19
Setting Up a VAV
Rev 5.4
VAV WIZARD PAGE 15 - BROADCAST DAMPER INC OUTPUT?
On the Broadcast Damper Increment Output page you select whether to broadcast the damper increment output.
The Broadcast Damper INC Output page is displayed below (Figure 26).
Figure 26. Broadcast Damper INC Output? Page
1.
Select whether this point is Broadcast to the network.
Default: No
Option: Yes
Note: It is suggested that this be set to No. This point receives the output of Point #12 - Damper
Position and that point is always broadcast to the network. If Point #17 is used for its default
purpose, it is redundant to broadcast both points. If the binding was broken between Point
#12 - Air Flow PID Controller and Point #17 - Damper Actuator Incr., and Point #17 was
bound to a point on an FSC, then you might want to broadcast this point.
2.
Click
to advance to Page 16 - Broadcast Damper DEC Output.
VAV WIZARD PAGE 16 - BROADCAST DAMPER DEC OUTPUT?
On the Broadcast Damper Decrement Output page you select whether to broadcast the damper decrement
output. The Broadcast Damper DEC Output page is displayed below (Figure 27).
Figure 27. Broadcast Damper DEC Output? Page
1.
Default: No
Option: Yes
Note: It is suggested that this be set to No. This point receives the output of Point #12 - Damper
Position and that point is always broadcast to the network. If Point #18 is used for its default
purpose, it is redundant to broadcast both points. If the binding was broken between Point
#12 - Air Flow PID Controller and Point #18 - Damper Actuator Decr., and Point #18 was
bound to a point on an FSC, then you might want to broadcast this point.
2.
4-20
Click
to advance to Page 17 - Broadcast Fan Output.
Rev 5.4
Setting Up a VAV
VAV WIZARD PAGE 17 - BROADCAST FAN OUTPUT?
On the Broadcast Fan Output page you select whether to broadcast the fan output. The Broadcast Fan Output
page is displayed below (Figure 28).
Figure 28. Broadcast Fan Output? Page
1.
Default: No
Option: Yes
Note: It is suggested that this be set to No. This point receives the output of Point #15 - Fan and
that point is always broadcast to the network. If Point #19 is used for its default purpose, it is
redundant to broadcast both points. If the binding was broken between Point #15 - Fan
Controller and Point #19 - Fan Output, and Point #19 was bound to a point on an FSC, then
you might want to broadcast this point.
2.
Click
to advance to Page 18 - Broadcast Reheat INC/ST 1 Output.
VAV WIZARD PAGE 18 - BROADCAST REHEAT INC/ST 1 OUTPUT?
On the Broadcast Reheat INC/ST 1 Output page you select whether to broadcast the Reheat Increment/Stage 1
Output. The Broadcast Reheat INC/ST 1 Output page is displayed below (Figure 29).
Figure 29. Broadcast Reheat INC/ST 1 Output? Page
1.
Default: No
Option: Yes
Note: Select whether this point is Broadcast to the network. It is suggested that this be set to No.
This point receives the output of Point #16 - Reheat and that point is always broadcast to
the network. If Point #20 is used for its default purpose, it is redundant to broadcast both
points. If the binding was broken between Point #16 - Reheat Controller and Point #20 Reheat Act. Incr. or Stage 1, and Point #20 was bound to a point on an FSC, then you might
want to broadcast this point.t.
2.
Click
to advance to Page 19 - Broadcast Reheat DEC/ST 2 Output.
4-21
Setting Up a VAV
Rev 5.4
VAV WIZARD PAGE 19 - BROADCAST REHEAT DEC/ST 2 OUTPUT?
On the Broadcast Reheat INC/ST 1 Output page you select whether to broadcast the Reheat Decrement/Stage 2
Output. The Broadcast Reheat DEC/ST 2 Output page is displayed below (Figure 30).
Figure 30. Broadcast Reheat DEC/ST 2 Output? Page
1.
Default: No
Option: Yes
Note: It is suggested that this be set to No. This point receives the output of Point #16 - Reheat
and that point is always broadcast to the network. If Point #21 is used for its default purpose, it is redundant to broadcast both points. If the binding was broken between Point #16 Reheat Controller and Point #21 - Reheat Act. Decr. or Stage 2, and Point #21 was bound to
a point on an FSC, then you might want to broadcast this point.
Note: This is the last page in the VAV Wizard.
2.
Press
Click
to save your changes and exit the Configuration Wizard.
Click
to abandon your changes and exit the Configuration Wizard. You will be
prompted to confirm your desire to cancel.
4-22
Rev 5.4
Setting Up a VAV
ADVANCED POINT EDITING
The VAV Configuration Wizard takes care of configuring most VAVs. However, there will be instances where
you need to directly access a point to verify status or to command the point. All 21 points on the VAV controller
are editable, and you can edit the points to tune your VAV system. Each point has a predefined number and point
type that are uneditable.
Figure 30. VAV-02 Point Listing
To edit an a VAV point:
1. Double-click the VAV you want to edit. The Points and LMOs subtree appears.
2. Double-click on the Points heading. The VAV Points page appears.
3. Double-click on the point you want to edit. The Status Command page appears.
4. Enter a new value into the command field.
5. Press Set to issue the command.
4-23
Setting Up a VAV
4-24
Rev 5.4
Chapter Five
Setting Up a Heat Pump
Setting Up A Heat Pump
Defining A Heat Pump
Commissioning A Heat Pump
Configuring A Heat Pump
Rev 5.4
SETTING UP A HEAT PUMP
The NXA-HPU-01 is an Application Specific Controller (ASC) in the MCL Tool product line. Its primary
purpose is to provide control for one individual heat pump; either a stand alone unit or one of the units in a
closed loop system. This ASC communicates on the same LONWORKS network with all of the other MCL Tool
controllers. The NXA-HPU-01 is designed for standoff or snap-track installation.
ADDING A HEAT PUMP TO THE PHYSICAL TREE
Adding a Heat Pump to the Physical Tree requires three steps to be carried out in order. These three steps are
Defining, Commissioning, and Configuring.
Defining - The Add Node Menu is used to install the Heat Pump on the tree, define the Heat Pump’s name and
Program ID. The Heat Pump being defined can be either off-line or on-line and does not have to be physically
attached to the network until the commissioning stage. You can define multiple devices and then commission
them all at once.
Commissioning - The Node Setup Menu is used to commission the defined Heat Pump. Commissioning writes
the network image, Neuron ID, and Program ID to a database. The defined Heat Pump must be on-line and
physically attached to the network for the commissioning process to work.
Configuring - The Heat Pump Wizard is the editor used to configure a commissioned Heat Pump. The wizard
works at the panel level to assign basic configuration settings and customize the Heat Pump to your requirements.
DEFINING A HEAT PUMP
To add a Heat Pump to the Physical Tree:
1.
Right click on the Global Node or Router where the Heat Pump will be located. The Node pop-up
menu (Figure 1) appears. Click Add to display the secondary menu, then choose Node, then either
Before or After to set the Heat Pump’s placement on the tree. The Add Node menu (Figure 2)
appears.
2.
Click on the Heat Pump in the list of devices and then enter a name for the Heat Pump in the New
Node Name: area. This should be as descriptive as possible and indicate the purpose and/or location
of the Heat Pump. For example, this could be Heat Pump 2nd Floor West Wing.
5-2
Rev 5.4
3.
Click
. The uncommissioned Heat Pump has been added to the physical tree (Figure 3).
Figure 3. Physical Tree with Newly Added Uncommissioned Heat Pump
COMMISSIONING THE HEAT PUMP
The next step is to commission the Heat Pump. Any Heat Pump that has not yet been commissioned will have
(Never Commissioned) after the Heat Pump’s name on the tree.
1.
Right click on the uncommissioned Heat Pump to bring up the Node Menu (Figure 4). Select Setup
Node to bring up the Node Setup Menu (Figure 5).
2.
If you know the exact Neuron ID for the Heat Pump, type it in the Neuron ID field. The Neuron ID
is specific to the Heat Pump controller you are setting up and is given to the MCL Tool when the
service pin is pressed on the controller. If you do not know the exact Neuron ID number, do not type
anything in this field. Go to Step 3.
3.
press the Service Pin on the Heat Pump you are commissioning. This registers the Neuron ID,
Program ID and associated device specific information. Once you press the service pin on the Heat
Pump the Setup Node Menu displays the Heat Pump’s Neuron ID and Program ID information
(Figure 6).
5-3
Rev 5.4
Figure 6. Node Setup Menu after pressing the Service Pin on the Heat Pump
4.
Click
configure.
5-4
Rev 5.4
• Send Network Image - Sends the device’s network address and bindings to the LNS database.
• Send Config. Data - Sends the device’s configuration parameters (CPs) from the LNS database to the device.
• F o rce Defaults - Sends the default CPs from the LNS database to the device.
• Send Trend - Sends Trend setup data from the LNS database to the device.
• Get Config. Data - Gets the device’s CPs from the device and sends them to the LNS database. This is used
as a backup in the event the device requires reconfiguration.
• Use as defaults - Checking this box gets the device’s current configuration settings and makes them the
• Get unknown only - Gets any “unknown” CP data, from the device currently being setup, and sends it to
• Get Trend - Gets Trend setup data from the device and sends it to the LNS database.
• Close window when configuring node done - Closes the configuration window and displays the tree as soon
5.
Click
the Heat Pump on the tree. Click
to abandon your changes to the Node Setup Menu. If
you cancel you will be prompted to confirm your cancellation. Confirming the cancellation closes the
5-5
Rev 5.4
HEAT PUMP CONFIGURATION WIZARD
The Heat Pump Configuration Wizard is used to configure a newly commissioned Heat Pump. It steps you
through a series of editor pages and allows you to accept the default settings or enter your own settings. As you
move through the Configuration Wizard the editor pages presented will vary, based on your preceding choices.
For example, if you select Thermistor instead of Intelligent/TSO, you will automatically skip past the pages for
thermostat configuration, since the thermistor requires no configuration. The Heat Pump flowchart (Figure 9)
shows each of the pages in the Wizard. The Wizard pages have been numbered to simplify following the
configuration process.
Open The
Heat Pump Wizard
A
Page 1
Intelligent/
TSO?
Page 2
Obtain:
Balance Password
Stat Password
Stat Units
Time Display
Yes
Page 12
Fan Controller
Parameters
No
Page 3
Accept Default
Load Parameters?
Page 13
Compressor
Stages
(1, 2, 3)
Page 4
Obtain
Setpoints
No
Page 14
Compressor Controller
Emerg. Heat, Holdoff,
Min On, Min Off
Interstage Delay
Page 5
Obtain
Thermal Load
Parameters
Yes
Page 15
Reverse Valve
Parameters
Page 6
Local Emergency Shutdown:
Enable/Disable
Page 16
Loop Enable
(Water/Air)
Page 7
Economizer
Type?
Page 17
Broadcast
Damper Output?
None or 2-Position
Floating
Page 9
Local Economizer
Parameters
Local
Page 8
Economizer
Enable?
Network
Page 10
Mixed Air
Parameters
End
Finish
Figure 9. Heat Pump Flow Chart
5-6
A
Page 18
Broadcast Fan
Output?
No
Low Limit?
Yes
Page 11
Low Limit
Shutdown
Parameters
Page 22
Broadcast
Compressor 3/EH?
Page 21
Broadcast
Compressor 2?
Page 19
Broadcast
Reverse Valve?
Page 20
Broadcast
Compressor 1?
Rev 5.4
HEAT PUMP WIZARD PAGE 1 - ROOM SENSOR TYPE
The first page to display in the Heat Pump Wizard is the Room Sensor Type page. On this page you choose
whether the Heat Pump will use either an Intelligent/TSO STAT or a thermistor to determine space temperature.
If you are using an Intelligent/TSO STAT, you have the option to use an auxiliary space temperature. If you are
using a thermistor, you do not have the option of an auxiliary space temperature. The Room Sensor Type page is
1.
Selecting Intelligent/TSO moves you to Page 2.
Selecting Thermistor will skip you to Page 4.
2.
Press
to move to the selected page.
HEAT PUMP WIZARD PAGE 2 - THERMOSTAT CONFIGURATION
Engineering Units, Time Display and Override Time. The Thermostat Configuration page for the Intelligent/
TSO STAT is displayed below (Figure 11).
1.
Default: 4999
Range: 0-9999
5-7
2.
Rev 5.4
Default: 5001
3.
Range: 0-9999
Default: English
Option: Metric
NOTE: This applies even if you are using a thermistor because you can still use the Intelligent
STAT as a configuration tool through the STAT port.
4.
Default: AM/PM
Option: Military
5.
Default: 50 minutes
6.
Click
to advance to Page 3 - Default Setpoints and Thermal Load Parameters.
HEAT PUMP WIZARD PAGE 3 - DEFAULT SETPOINTS & THERMAL LOAD PARAMETERS
Setpoints and Thermal Load Parameters page for the Intelligent/TSO STAT is displayed below (Figure 12).
Figure 12. Default Setpoints and Thermal Load Parameters Page
2.
Accept the Default Setpoints and Thermal Load Parameters by clicking on the appropriate radio
button. The Default Parameters are found on Page 4 and the Default Thermal Load Parameters
are found on Page 5.
Default: Yes
Option: No
Selecting Yes skips you to Page 6 - Emergency Shutdown.
Selecting No moves you to Page 4 - Setpoint Configuration.
3.
5-8
Click
Rev 5.4
HEAT PUMP WIZARD PAGE 4 - SETPOINT CONFIGURATION
This page sets the Heating and Cooling setpoints for the Occupied, Economy, and Unoccupied modes, and also
sets a User Offset. All of these settings are for the Intelligent/TSO STAT. The Setpoint Configuration page is
1.
2.
3.
4.
5.
Default: 2.00°F (1.11°C).
this screen do not change. For more information, see the Heat Pump Engineering Guide.
6.
Click
to advance to Page 5 - PID Parameters For Thermal Load.
5-9
Rev 5.4
HEAT PUMP WIZARD PAGE 5 - PID PARAMETERS FOR THERMAL LOAD
Figure 14. PID Parameters for Thermal Load Page
1.
Default: 4° F
control.
Default: 0
2.
Default:
Cooling = 6 Seconds
Heating = 7 Seconds
3.
stat.
Default: 50%
4.
5-10
Click
to advance to Page 6 - Local Emergency Shutdown.
Rev 5.4
HEAT PUMP WIZARD PAGE 6 - LOCAL EMERGENCY SHUTDOWN
This page enables or disables a digital input, wired to an external sensor, used to trigger a Local Emergency
Shutdown. When this page is enabled, and certain conditions have been met, an Emergency Shutdown for the
local controller is performed. Emergency operation mode begins and only effects the local unit. The Local
Emergency Shutdown page is displayed below (Figure 15).
Figure 15. Local Emergency Shutdown Page
1.
Select whether to Enable or Disable Local Emergency Shutdown function.
Default: Disable
2.
Click
Option: Enable
to advance to Page 7 - Economizer Type.
HEAT PUMP WIZARD PAGE 7 - ECONOMIZER TYPE
This page determines the economizer type. The Economizer Type page is displayed below (Figure 16).
Figure 16. Economizer Type Page
1. Click on the appropriate radio button to select the Economizer Type.
Selecting None disables the Economizer sequence.
Selecting Floating enables modulated damper control.
Selecting 2-Position enables 2-position damper control.
Default: None
Options: Floating, 2-Position
Selecting None or 2-Position skips you to Page 12 - Fan Controller.
Selecting Floating moves you to Page 8 - Economizer Enable.
2.
Click
5-11
Rev 5.4
HEAT PUMP WIZARD PAGE 8 - ECONOMIZER ENABLE
This page is used to select whether the Economizer sequence is determined locally (by the Heat Pump controller) or through the network (by an FSC). The Economizer Enable page is displayed below (Figure 17).
Figure 17. Economizer Enable Page
1.
Click on the appropriate radio button to select either Local or Network Economizer.
Selecting Local enables the Local Economizer.
Selecting Network enables the LON Economizer.
Default: Local
Option: Network
Selecting Local moves you to Page 9 - Local Economizer.
Selecting Network skips you to Page 10 - Mixed Air Parameters.
2.
Click
HEAT PUMP WIZARD PAGE 9 - LOCAL ECONOMIZER
This page is used to set the Setpoint and Deadband for the Local Economizer. The Local Economizer page is
Figure 18. Local Economizer Page
1.
Enter the Setpoint. This is the outside air temperature(OAT) and is dependent on your geographical
location. This is the temperature at which the economizer sequence is enabled.
Default: 55.00°F
5-12
Rev 5.4
2.
Enter the OAT Deadband. This is the range the OAT must pass in order to enable or disable the
economizer sequence. For example, if the OAT deadband was set at 2°F and the OAT setpoint was
set at 55°, then the economizer sequence would not ENABLED until 53°F and would not be DISABLED until the OAT setpoint had reached 57°F.
Default: 2.50°F
3.
Click
to advance to Page 10 - Mixed Air Parameters.
HEAT PUMP WIZARD PAGE 10 - MIXED AIR PARAMETERS
This page’s settings are used to calculate a Mixed Air PID damper position in percent. Mixed Air Parameters
takes the Setpoint of either the Mixed Air Temperature or the Discharge Air Temperature and outputs a Mixed
Air PID damper position in percent. This is not the absolute damper position because this position is based only
on the Discharge Air Temp and the Mixed Air Setpoint. This output is then fed to the Economizer Controller and
the exact damper position is determined. The Mixed Air Parameters page is displayed below (Figure 19).
Figure 19. Mixed Air Parameters Page
1.
Enter the Minimum Damper Percent. This is the minimum percent the damper will close to.
Default: 10%
2.
Accept the Temperature Source default or choose a different one from the drop-down list box. The
Temperature Source determines if the Setpoint for the Mixed Air PID is from the Mixed Air Temperature or the Discharge Air Temperature.
Default: Mixed_Air_Temp
3.
Options: Discharge_Air_Temp
Enter the Setpoint, for the Temperature Source selected above, in the Setpoint field. This setpoint
serves as the desired value in the PID loop.
Default: 12.79
4.
Enter the Air PID Values: Prop. Integ. Derv. A PID loop always requires two values (actual and
readings, etc., and generates a command to correct the error between them. Typically, this command
is then used with some other point for a final action. In this case, the point takes either the actual
Mixed Air Temp or the actual Discharge Air Temp, and the desired Setpoint and outputs a value to
the Economizer.
Proportional gain is always in the engineering units of the input variables, in this case ° C. Decreasing
Default: 2.2° C
5-13
Rev 5.4
The Derivative (Deriv.) controls based on how fast the temperature is changing, and attempts to sense
rapid changes. The derivative gain is always in seconds. Increasing the derivative gain, decreases
control.
Default: 0 Seconds
NOTE 1: It is recommended that the derivative gain always be 0.
5.
Enter the Scan Time. This is how often the Mixed Air PID loop is recalculated.
Default: 10 Seconds
6.
, the time defaults
Click on the appropriate radio button to select either Enable or Disable the Low Limit Shutdown.
Default: Enable
Options: Disable
Selecting Enable moves you to Page 11 - Low Limit Shutdown Parameters.
Selecting Disable skips you to Page 12 - Fan Controller Parameters.
7.
Click
HEAT PUMP WIZARD PAGE 11 - LOW LIMIT SHUTDOWN PARAMETERS
This point determines if conditions are met to perform a low limit shutdown. This is determined by comparing
either the Mixed Air Temp or the Discharge Air Temp to the Low Limit Setpoint. If the Mixed Air Temp/
Discharge Air Temp is below the Low Limit Setpoint, then a low limit shutdown is performed and the unit
undergoes an Emergency Shutdown. Low Limit Shutdown is used for equipment protection, mainly to prevent
coil freeze-up. The Low Limit Shutdown Parameters page is displayed below (Figure 20).
Figure 20. Low Limit Shutdown Parameters Page
1.
Temperature Source determines if the Setpoint for the Low Limit Shutdown is from the Mixed Air
Temperature or the Discharge Air Temperature.
2.
Enter the Setpoint. This is the Low Limit Setpoint and is used in comparison to the Mixed Air
Temp/Discharge Air Temp to determine if there is a Low Limit Shutdown condition.
Default: 39.99°F
5-14
Rev 5.4
3.
Enter the Deadband. This is the range the Mixed Air Temp must pass in order to enable or disable a
Low Limit Shutdown. For example, if the deadband was set at 2°F and the Low Limit Setpoint was
40°F, then the Low Limit Shutdown would activate and shutdown the controller at 38°F. At 42°F the
Low Limit Shutdown would be off and the delay time (Step 7) would be started.
Default: 2.00°F
4.
Enter the Delay Time. This is the amount of time that must elapse before the systems attempts a
Reset. For example, using the conditions in Step 6, a delay time of 2 minutes is entered. Therefore,
once the temperature reaches 42°F, the system delays 2 minutes before it attempts a reset.
Default: 0 Minutes
NOTE: At 0 the timer will not run and therefore the system will not reset itself. A manual reset
must be performed.
8.
Click
to advance to Page 12 - Fan Controller Parameters.
HEAT PUMP WIZARD PAGE 12 - FAN CONTROLLER PARAMETERS
This page sets the Fan Type(if any), Minimum Run Time, Fan Status Enable/Disable, and the Fan Status Delay.
The output is sent to the Fan Output which is the control point for the fan.
NOTE: This point is only the state of the fan as the sequence of operation determines it to be. Fan
Status can be used as a feedback to determine the actual status of the fan.
The Fan Controller Parameters page is displayed below (Figure 21).
Figure 21. Fan Controller Parameters Page
1.
Accept the default or enter a new Fan Type. Fan type choices for the Heat Pump system are either
Automatic or Continuous . An automatic fan turns ON with compressor stage 1. A continuous fan is
ON continuously during occupied mode.
Default: Fan_Automatic
2.
Options: Fan_Continuous
Accept the default or use the spin boxes to set the Minimum Run Time for the fan. This is the
minimum amount of time the fan runs before compressor stage 1 turns ON. This is also the minimum
amount of time the fan runs after the compressor stage turns OFF.
Default: 1 minute 30 seconds
, the time defaults
5-15
3.
The Fan Status Enable box enables feedback to determine the status of the fan. This requires
hardware in the field to verify the status of the fan. Fan Status Enable choices for the Heat Pump
system are either Fan_No_Feedback or Fan_Status_Feedback. Fan_No_Feedback or
Fan_Status_Feedback. An automatic fan turns ON with compressor stage 1. A continuous fan is ON
continuously during occupied mode.
Default: Fan_No_Feedback
4.
Options: Fan_Status_Feedback
Accept the default or use the spin boxes to set the Fan Status Delay time. The Fan Status Delay is
the minimum amount of time that must elapse after there is a change in the Fan Status. This delay
allows for no false readings on the Fan Status.
Default: 15 seconds
5.
Click
to advance to Page 13 - Number of Stages For Compressor.
HEAT PUMP WIZARD PAGE 13 - NUMBER OF STAGES FOR COMPRESSOR?
This page sets whether the Heat Pump compressor is a 1, 2, or 3 stage compressor.
The Number of Stages For Compressor page is displayed below (Figure 22).
Figure 22. Number of Compressor Stages
1.
Click a radio button to set the Number of Stages for the compressor.
Default: 2
2.
5-16
Rev 5.4
Click
Options: 1 or 3
to advance to Page 14 - Compressor Controller.
Rev 5.4
HEAT PUMP WIZARD PAGE 14 - COMPRESSOR CONTROLLER
This page sets if emergency heat is needed for the control sequence. This point looks at the output of the Mixed
Air PID Controller (Point #19), the output of the Emergency Command Controller (Point #20), the output of the
Loop Enable Controller (Point #27), and the Fan Status (Point #5) and determines if Compressor Stage 1, 2, 3 or
Emergency Heat is needed. The output is sent to the appropriate stage for the control output. The Compressor
Controller page is displayed below (Figure 23).
Figure 23. Compressor Controller Page
1.
Select whether or not there is Emergency Heat. This determines if the Heat Pump system uses
Emergency Heat.
Default: NO_EMERGENCY_HEAT Options: EMERGENCY_HEAT_ENAB
2.
Enter the Holdoff. The Emergency Heat Holdoff is an additional deadband that allows the system to
hold off before initiating Emergency Heat. Once all calculations are completed to determine if
Emergency Heat is needed, this parameter is checked to see if the current temperature is within this
deadband. If it is in the deadband, Emergency Heat is not initiated. For example, if the Holdoff is 2°
and the Heating Setpoint is 68°F, after all calculations for Emergency Heat have been made the
current temperature is looked at and determined to be 67°F. Because the Holdoff is 2°, Emergency
Heat would not be initiated because the temperature is still in the 2° deadband. If the current temperature was 65°F, then Emergency Heat would be initiated.
Default: 1.01°F
3.
Use the spin boxes or enter a value to set the Min. On Time and the Min. Off Time. The Min. On
Time is the minimum amount of time that the compressor must remain ON before it turns OFF. This
prevents short cycling. The Min. Off Time is the minimum amount of time that the compressor must
remain OFF before it turns ON. This is used for equipment protection.
Min On Time Default: 1 minute
Min OffTime Default: 4 minutes
4.
Click
, the time defaults
to advance to Page 15 - Reverse Valve Setup.
5-17
Rev 5.4
HEAT PUMP WIZARD PAGE 15 - REVERSE VALVE SETUP
This page sets the reverse valve for either cooling or heating. Polarities on valves vary so determine your
specific valve’s operation.. The HPU-01 controller is set up for Cooling to be NORMAL and Heating to be
INVERT. The Reverse Valve Setup page is displayed below (Figure 24).
Figure 24. Reverse Valve Setup
1.
Select whether the Direction of the reversing valve is Reverse_Valve_Normal or
Reverse_Valve_Invert. This determines if the reversing valve is set for cooling or heating. If you
want Cooling to be ON and Heating to be OFF, select Reverse_Valve_Normal. If you want Heating
to be ON and Cooling to be OFF, select Reverse_Valve_Invert.
Default: REVERSE_VALVE_NORMAL
2.
Option: REVERSE_VALVE_INV
Enter a value to set the Delay Time. This is the minimum amount of time after the reversing valve
changes state before it can change state again. For example, if the Delay Time is 5 minutes, and the
reversing valve changes state and is currently set for cooling mode, there will be a delay of 5 minutes
before the reversing valve can change to heating mode.
Default: 5 minutes
defaults to 1 Hour 49 Minutes and 13 Seconds.
3.
5-18
Click
to advance to Page 16 - Loop Enable.
, the time
Rev 5.4
HEAT PUMP WIZARD PAGE 16 - LOOP ENABLE
This page sets whether the Heat Pump System uses an Air or Water source heat pump.
The Loop Enable page is displayed below (Figure 25).
Figure 25. Loop Enable Page
1.
Click a radio button to set if the Heat Pump System uses an Air or Water source.
Default: Water
2.
Click
Option: Air
to advance to Page 17 - Broadcast Output For Damper.
HEAT PUMP WIZARD PAGE 17 - BROADCAST OUTPUT FOR DAMPER?
This is the hardware analog output of the Economizer Controller and is already broadcast to the network. The
Broadcast Output For Damper page is displayed below (Figure 26).
Figure 26. Broadcast Output For Damper Page
1.
Default: No
Option: Yes
Note: It is highly suggested that this be set to No. This point receives the Economizer Controller
output and is always broadcast to the network.
If the binding was broken between the Economizer Controller and the Analog Output, and the
Analog Output was bound to a point on an FSC, then you might want to broadcast this
point.
2.
Click
to advance to Page 18 - Broadcast Output For Fan Output.
5-19
Rev 5.4
HEAT PUMP WIZARD PAGE 18 - BROADCAST OUTPUT FOR FAN OUTPUT?
This is the hardware output of the Fan Controller and is already broadcast to the network. The Broadcast Output
For Fan Output page is displayed below (Figure 27).
Figure 28. Broadcast Output For Fan Output? Page
1.
Default: No
Note: It is highly suggested that this be set to No. This point receives the Fan Controller output
and is always broadcast to the network.
If the binding was broken between the Fan Controller and the Digital Output, and the Digital Output
was bound to a point on an FSC, then you might want to broadcast this point.
2.
Click
to advance to Page 19 - Broadcast Output For Reverse Valve.
HEAT PUMP WIZARD PAGE 19 - BROADCAST OUTPUT FOR REVERSE VALVE?
This is the output of the Reverse Valve and is already broadcast to the network. The Broadcast Output For
Reverse Valve page is displayed below (Figure 29).
Figure 29. Broadcast Output For Reverse Valve? Page
1.
Default: No
Option: Yes
Note: It is highly suggested that this be set to No. This point receives the Reverse Valve output
If the binding was broken between the Reverse Valve and the Digital Output, and the Digital Output
2.
5-20
Click
to advance to Page 20 - Broadcast Output For Compressor 1.
Rev 5.4
HEAT PUMP WIZARD PAGE 20 - BROADCAST OUTPUT FOR COMPRESSOR 1?
This is the output of the Compressor Controller and is already broadcast to the network. The Broadcast Output
For Compressor 1 page is displayed below (Figure 30).
Figure 30. Broadcast Output For Compressor 1? Page
1.
Default: No
Option: Yes
Note: It is highly suggested that this be set to No. This point receives the Compressor Controller
If the binding was broken between the Compressor Controller and the Digital Output, and the
Digital Output was bound to a point on an FSC, then you might want to broadcast this point.
2.
Click
to advance to Page 21 - Broadcast Output For Compressor 2.
HEAT PUMP WIZARD PAGE 21 - BROADCAST OUTPUT FOR COMPRESSOR 2?
For Compressor 2 page is displayed below (Figure 31).
Figure 31. Broadcast Output For Compressor 2? Page
1.
Default: No
Option: Yes
2.
Click
to advance to Page 22 - Broadcast Output For Compressor 3/EH.
5-21
Rev 5.4
HEAT PUMP WIZARD PAGE 22 - BROADCAST OUTPUT FOR COMPRESSOR 3/EH?
For Compressor 3/EH page is displayed below (Figure 32).
Figure 32. Broadcast Output For Compressor 3/EH? Page
1.
Default: No
Option: Yes
Note: This is the last page in the Heat Pump Configuration Wizard.
2.
Press
Click
to save your changes and exit the Heat Pump Wizard.
Click
to abandon your changes and exit the Heat Pump Wizard. You will be prompted
to confirm your desire to cancel.
5-22
Chapter Six
Setting Up a PEC
Setting Up A PEC
Defining A PEC
Commissioning A PEC
Configuring A PEC
Setting Up a PEC
Rev 5.4
SETTING UP A PEC
The NXA-PEC-01 is an Application Specific Controller (ASC) in the MCL Tool product line. The Packaged
Equipment Controller (PEC) is designed to support four types of packaged equipment systems: Fan Coil Units
(FCUs) and Roof Top Units (RTUs), Unit Ventilators (UVs), and Air Handling Units (AHUs). This ASC
communicates on the same LONWORKS network with all of the other MCL Tool controllers. The NXA-PEC-01 is
designed for standoff or snap-track installation.
ADDING A PEC TO THE PHYSICAL TREE
Adding a PEC to the Physical Tree requires three steps to be carried out in order. These three steps are Defining,
Commissioning, and Configuring.
Defining - The Add Node Menu is used to install the PEC on the tree, define the PEC’s name and Program ID.
The PEC being defined can be either off-line or on-line and does not have to be physically attached to the
network until the commissioning stage. You can define multiple devices and then commission them all at once.
network image, Neuron ID, and Program ID to a database. The defined PEC must be on-line and physically
Configuring - The PEC Configuration Wizard is the editor used to configure a commissioned PEC. The PEC
Wizard works at the panel level to assign basic configuration settings and customize the PEC to your requirements.
DEFINING A PEC
The first step to adding a PEC is the defining process.
To add a PEC to the Physical Tree:
1.
Right click on the Node or Router where the PEC will be located. The Node pop-up menu (Figure 1)
appears. Click Add to display the secondary menu, then choose Node, then either Before or After to
set the PEC’s placement on the tree. The Add Node menu (Figure 2) appears.
2.
3.
6-2
Click
Rev 5.4
Setting Up a PEC
COMMISSIONING THE PEC
The second step is to commission the PEC. Any PEC that has not yet been commissioned will have (Never
Commissioned) after the PEC’s name on the tree.
1.
Figure 4. Node Menu
2.
specific to the PEC controller you are setting up and is given to the MCL Tool when the service pin is
3.
6-3
Setting Up a PEC
Rev 5.4
4.
Click
configure.
The checkboxes on Figures 6, 7, and 8 are described on the next page.
6-4
Rev 5.4
Setting Up a PEC
Choose carefully how you use these commands. If used incorrectly, it is possible to overwrite default values
that are not recoverable.
Get Config. Data - Gets the device’s CPs from the device and sends them to the LNS database. This is used as
a backup in the event the device requires reconfiguration.
Close window when configuring node done - Closes the configuration window and displays the tree as soon
5.
Click
to save your changes to the Node Setup Menu, close the wizard and display
the tree. This will complete the commissioning process and remove the Never Commissioned label
from the PEC on the tree. Click
to abandon your changes to the Node Setup Menu.
If you cancel you will be prompted to confirm your cancellation. Confirming the cancellation
closes the wizard and returns to the tree display. Abandoning the cancellation returns you to the
wizard.
6-5
Setting Up a PEC
Rev 5.4
CONFIGURATION WIZARD (PEC)
The PEC Configuration Wizard is used to configure a newly commissioned PEC. It steps you through a series
of editor pages and allows you to accept the default settings or enter your own settings. As you move through the
Configuration Wizard the editor pages presented will vary, based on your preceding choices. For example, if you
select Thermistor instead of Intelligent/TSO, you will automatically skip past the pages for thermostat configuration, since the thermistor requires no configuration. The PEC flowchart (Figure 9) shows each of the pages in the
Wizard. The Wizard pages have been numbered to simplify following the configuration process.
A
Open The
PEC Wizard
Page 1
Intelligent/
TSO?
Page 12
Fan
Controller
Parameters
Page 2
Obtain:
Balance Password
Stat Password
Stat Units
Time Display
Yes
Page 13
Discharge Air
Reset from
Thermal Load?
No
Page 3
Accept Default
Load Parameters?
Page 15
Number Of
Valves?
Page 5
Obtain
Thermal Load
Parameters
Yes
Page 17
Local
Winter/Summer
Setpoint and
Deadband
Page 8
Economizer
Enable?
Page 9. PEC Wizard Flowchart
Page 22
Floating Cooling
Parameters
LON
Discrete
Page18
Heating Type?
Floating
Page 19
Floating Heating
Parameters
A
Page 24
Broadcast Damper
Output?
Low Limit?
Page 29
Broadcast Heating
Decrement?
Page 21
Cooling Type?
Floating
No
Page 10
Mixed Air
Parameters
Finish
Page 20
Discrete Heating
Parameters
None
or
2-Position
Network
Discrete
Local SWT
or
Local OAT
Floating
6-6
Page 23
Discrete Cooling
Parameters
Page 16
Winter/Summer
Controller
Page 7
Economizer
Type?
Local
Two Valve (2)
One Valve (1)
Page 6
Local Emergency Shutdown:
Enable/Disable
Page 9
Local Economizer
Parameters
Page 14
Temperature PID
Parameters
No
Page 4
Obtain
Setpoints
No
Yes
Yes
Page 11
Low Limit
Parameters
Page 28
Broadcast Heating
Increment?
Page 27
Broadcast Cooling
Decrement?
Page 25
Broadcast Fan
Output?
Page 26
Broadcast Cooling
Increment?
Rev 5.4
Setting Up a PEC
To enter the Configuration Wizard:
1.
Right click on the commissioned PEC to be configured (Figure 10) to bring up the Node Menu
(Figure 11).
Figure 10. Highlighted Commissioned PEC
2.
Select Configuration Wizard to bring up the Configuration Wizard’s first editor page, Room
Sensor Type (Figure 12).
PEC WIZARD PAGE 1 - ROOM SENSOR TYPE
The first page to display in the PEC Configuration Wizard is the Room Sensor Type page. On this page you
choose whether the PEC will use either an Intelligent/TSO STAT or a thermistor to determine space temperature.
If you are using an Intelligent/TSO STAT, you have the option to use an auxiliary space temperature. If you are
using a thermistor, you do not have the option of an auxiliary space temperature. The Room Sensor Type page is
shown below.
1.
Selecting Intelligent/TSO moves you to Page 2 - Thermostat Configuration .
Selecting Thermistor will skip you to Page 4 - Setpoint Configuration.
2.
Press
6-7
Setting Up a PEC
Rev 5.4
PEC WIZARD PAGE 2 - THERMOSTAT CONFIGURATION
Engineering Units, Time Display and Override Time. The Thermostat Configuration page for the Intelligent/
TSO STAT is displayed below (Figure 13).
1.
Default: 4999
2.
Default: 5001
3.
Range: 0-9999
Range: 0-9999
Default: English
Option: Metric
4.
Default: AM/PM
Option: Military
5.
Default: 50 minutes
6.
6-8
Click
to advance to the next page.
Rev 5.4
Setting Up a PEC
PEC WIZARD PAGE 3 - DEFAULT SETPOINTS AND THERMAL LOAD PARAMETERS
Setpoints and Thermal Load Parameters page for the Intelligent/TSO STAT is displayed below (Figure 14).
Figure 14. Default Setpoints and Thermal Load Parameters Page
1.
Click on the Yes radio button to accept the Default Setpoints and Thermal Load Parameters.
Click on the No radio button to set your own Setpoint and Thermal Load Parameters.
Default: Yes
Option: No
Selecting Yes skips you to Page 6 - Local Emergency Shutdown.
Selecting No moves you to Page 4 - Setpoint Configuration, then Page 5 -Thermal Load Parameters.
2.
Click
PEC WIZARD PAGE 4 - SETPOINT CONFIGURATION
This page sets the Intelligent/TSO STAT’s Heating and Cooling setpoints for the Occupied, Economy, and
Unoccupied modes. The Setpoint Configuration page for the Intelligent/TSO STAT and Thermistor is displayed
below (Figure 15).
1.
6-9
Setting Up a PEC
2.
Rev 5.4
3.
4.
Default: 2.00°F (1.11°C).
this screen do not change. For more information, see the PEC Engineering Guide.
5.
Click
to advance to Page 5 -Thermal Load Parameters.
PEC WIZARD PAGE 5 - PID PARAMETERS FOR THERMAL LOAD
Figure 16. PID Parameters for Thermal Load Page
1.
Default: 4° F
6-10
Rev 5.4
Setting Up a PEC
control.
Default: 0
2.
Default:
Cooling = 6 Seconds
Heating = 7 Seconds
, the time defaults
3.
thermostat.
Default: 50%
4.
Click
to advance to Page 6 - Local Emergency Shutdown.
PEC WIZARD PAGE 6 - LOCAL EMERGENCY SHUTDOWN
This page enables or disables a digital input, wired to an external sensor, used to trigger a Local Emergency
Shutdown. When this page is enabled, and certain conditions have been met, an Emergency Shutdown for the
local controller is performed. Emergency operation mode begins and only effects the local unit. The Local
Emergency Shutdown page is displayed below (Figure 17).
Figure 17. Local Emergency Shutdown Page
1.
Select whether to Enable or Disable Local Emergency Shutdown function.
Default: Disable
2.
Click
Option: Enable
to advance to Page 7 - Economizer Type.
6-11
Setting Up a PEC
Rev 5.4
PEC WIZARD PAGE 7 - ECONOMIZER TYPE
This page determines the economizer type. The Economizer Type page is displayed below (Figure 18).
Figure 18. Economizer Type Page
1. Click on the appropriate radio button to select the Economizer Type.
Selecting None disables the Economizer sequence.
Selecting Floating enables modulated damper control.
Selecting 2 Position enables 2 position damper control.
Default: None
Options: Floating, 2 Position
Selecting None or 2-Position skips you to Page 12 - Fan Control Parameters.
Selecting Floating moves you to Page 8 - Economizer Enable.
2.
Click
PEC WIZARD PAGE 8 - ECONOMIZER ENABLE
This page is used to select whether the Economizer sequence is determined locally (by the PEC controller) or
through the network (by an FSC). The Economizer Enable page is displayed below (Figure 19).
Figure 19. Economizer Enable Page
1.
Click on the appropriate radio button to select either Local or Network Economizer.
Selecting Local enables the Local Economizer.
6-12
Rev 5.4
Setting Up a PEC
Selecting Network enables the LON Economizer.
Default: Local
Option: Network
Selecting Local moves you to Page 9 - Local Economizer Parameters.
Selecting Network skips you to Page 10 - Mixed Air Parameters.
2.
Click
PEC WIZARD PAGE 9 - LOCAL ECONOMIZER
This page is used to set the Setpoint and Deadband for the Local Economizer. The Local Economizer page is
Figure 20. Local Economizer Page
1.
Enter the Setpoint. This is the outside air temperature(OAT) and is dependent on your geographical
location. This is the temperature at which the economizer sequence is enabled.
Default: 55.00°F
2.
Enter the OAT Deadband. This is the range the OAT must pass in order to enable or disable the
economizer sequence. For example, if the OAT deadband was set at 2°F and the OAT setpoint was
set at 55°, then the economizer sequence would not ENABLED until 53°F and would not be DISABLED until the OAT setpoint had reached 57°F.
Default: 2.50°F
3.
Click
to advance to Page 10 - Mixed Air Parameters.
6-13
Setting Up a PEC
Rev 5.4
PEC WIZARD PAGE 10 - MIXED AIR PARAMETERS
This page’s settings are used to calculate a Mixed Air PID damper position. Mixed Air Parameters takes the
Setpoint of either the Mixed Air Temperature or the Discharge Air Temperature and outputs a Mixed Air PID
damper position in percent. This is not the absolute damper position because this position is based only on the
Discharge Air Temp and the Mixed Air Setpoint. This output is then fed to the Economizer Controller and the
exact damper position is determined. The Mixed Air Parameters page is displayed below (Figure 21).
Figure 21. Mixed Air Parameters Page
1.
Enter the Minimum Damper Percent. This is the minimum percent the damper will close to.
Default: 10%
2.
Temperature Source determines if the Setpoint for the Mixed Air PID is from the Mixed Air Temperature or the Discharge Air Temperature.
3.
Enter the Setpoint, for the Temperature Source selected above, in the Setpoint field. This setpoint
serves as the desired value in the PID loop.
Default: 12.79° C (55°F)
4.
the Economizer.
Default: 2.2° C (4°F)
control.
Default: 0 Seconds
6-14
Rev 5.4
Setting Up a PEC
5.
Enter the Scan Time. This is how often the Mixed Air PID loop is recalculated.
Default: 10 Seconds
6.
Click on the appropriate radio button to select either Enable or Disable the Low Limit Shutdown.
Default: Enable
7.
, the time defaults
Options: Disable
Select the Temperature Source. This sets whether the controller uses Mixed_Air_Temp or
Discharge_Air_Temp in its PID calculations.
Option: Discharge_Air_Temp
Selecting Enable in Step 6 above moves you to Page 11 - Low Limit Shutdown Parameters.
Selecting Disable in Step 6 above skips you to Page 12 - Fan Control Parameters.
8.
Click
PEC WIZARD PAGE 11 - LOW LIMIT SHUTDOWN PARAMETERS
This page determine if conditions are met to perform a low limit shutdown. This is determined by comparing
either the Mixed Air Temp or the Discharge Air Temp to the Low Limit Setpoint. If the Mixed Air Temp/
Discharge Air Temp is below the Low Limit Setpoint, then a low limit shutdown is performed and the unit
undergoes an Emergency Shutdown. Low Limit Shutdown is used for equipment protection, mainly to prevent
coil freeze-up. The Low Limit Shutdown Parameters page is displayed below (Figure 22).
Figure 22. Low Limit Shutdown Parameters Page
1.
Enter the Setpoint. This is the Low Limit Setpoint and is used in comparison to the Mixed Air
Temp/Discharge Air Temp to determine if there is a Low Limit Shutdown condition.
Default: 39.99°F
2.
Enter the Deadband. This is the range the Mixed Air Temp must pass in order to enable or disable a
Low Limit Shutdown. For example, if the deadband was set at 2°F and the Low Limit Setpoint was
40°F, then the Low Limit Shutdown would activate and shutdown the controller at 38°F. At 42°F the
Low Limit Shutdown would be off and the delay time (Step 7) would be started.
Default: 2.00°F
6-15
Setting Up a PEC
3.
Rev 5.4
Enter the Delay Before Restart time. This is the amount of time that must elapse before the system
attempts a Restart. For example, if a delay time of 2 minutes is entered and the system has executed
an Emergency Shutdown, once the temperature reaches setpoint, the system delays 2 minutes before
it attempts a reset.
Default: 0 Minutes
NOTE: At 0 the timer will not run and therefore the system will not reset itself. A manual reset
must be performed.
4.
Select the Temperature Source. This sets whether the controller uses Mixed_Air_Temp or
Discharge_Air_Temp in its calculations.
5.
Click
Option: Discharge_Air_Temp
to advance to Page 12 - Fan Controller Parameters.
PEC WIZARD PAGE 12 - FAN CONTROLLER PARAMETERS
This page’s settings determine when the fan should be ON or OFF. The settings look at the output of the Manual
Occupancy Controller and the output of the Emergency Command Controller to determine if the fan should be
ON or OFF. The output of this point is sent to the Fan Output which is the control point for the fan.
Status can be used as a feedback to determine the actual status of the fan.
The Fan Controller Parameters page is displayed below (Figure 23).
Figure 23. Fan Controller Parameters Page
1.
Accept the default or enter a new Fan Type. Fan type choices for the PEC system are either Automatic or Continuous . An automatic fan turns ON with compressor stage 1. A continuous fan is ON
continuously during occupied mode.
Default: Fan_Automatic
2.
Options: Fan_Continuous
Accept the default or use the spin boxes to set the Minimum Run Time for the fan. This is the
minimum amount of time the fan runs before compressor stage 1 turns ON. This is also the minimum
amount of time the fan runs after the compressor stage turns OFF.
3.
The Fan Status Enable box enables feedback to determine the status of the fan. This requires
hardware in the field to verify the status of the fan.
Default: Fan_No_Feedback
6-16
, the time defaults
Options: Fan_Status_Feedback
Rev 5.4
4.
Setting Up a PEC
Accept the default or use the spin boxes to set the Fan Status Delay time. The Fan Status Delay is
the minimum amount of time that must elapse after there is a change in the Fan Status. This delay
allows for no false readings on the Fan Status.
Default: 15 seconds
5.
Click
, the time defaults
to advance to Page 13 - Discharge Air Reset From Thermal Load.
PEC WIZARD PAGE 13 - DISCHARGE AIR RESET FROM THERMAL LOAD
This page’s settings determine if the Discharge Air Reset sequence is activated based on Space Temperature or
Thermal Load. The Discharge Air Reset From Thermal Load page is displayed below (Figure 24).
Figure 24. Discharge Air Reset From Thermal Load Page
1.
Click on the appropriate radio button to select either NO (Space Temperature Control) or Yes
(Thermal Load).
Default: No
Options: Yes
Selecting No skips you to Page 15 - Number of Valves.
Selecting Yes moves you to Page 14 - Temperature PID Parameters.
2.
Click
6-17
Setting Up a PEC
Rev 5.4
PEC WIZARD PAGE 14 - DISCHARGE AIR RESET
The Discharge Air Reset page uses Space Temp control to initiate a The Discharge Air Reset page is displayed
below (Figure 25).
Figure 25. Page 14 - Discharge Air Reset
1.
Enter the Minimum Reset Temperature. This is the minimum temperature .
Default: 12.77 °C
2.
Enter the Maximum Reset Temperature. This is the maximum temperature .
Default: 35 °C
3.
the Economizer.
Default: 2.2° C
control.
Default: 0 Seconds
4.
6-18
Click
to advance to Page 15 - Number of Valves.
Rev 5.4
Setting Up a PEC
PEC WIZARD PAGE 15 - NUMBER OF VALVES
This page is used to select whether the system is a 1 Valve (two-pipe) or 2 Valve (four-pipe) system. A 1 Valve
(two-pipe) has only one supply pipe and only one return pipe. This system supplies hot water or chiller water
and it has to be one or the other, never both. A 2 Valve (four-pipe) system has both hot and chilled water at the
same time (supply and return chilled water and supply and return hot water). In order for the PEC-01 to provide
proper control, the controller needs to be configured to match the mechanical system you are setting up. The
Number of Valves page is displayed below (Figure 26).
Figure 26. Number of Valves Page
1.
Click on the appropriate radio button to select whether the system is a 1 Valve (two-pipe) or 2 Valve
(four-pipe) system.
Default: 2 (4 pipe)
Option: 1 (2 pipe)
Selecting 1 Valve(2 pipe) moves you to Page 16 - Winter/Summer Controller.
Selecting 2 Valve(4 pipe) skips you to Page 21 - Cooling Type.
2.
Click
PEC WIZARD PAGE 16 - WINTER/SUMMER CONTROLLER
This determines the Winter or Summer mode for a two-pipe system. This mode is determined by looking at the
Supply Water Temp/Outside Air Temp. The output of the Winter/Summer Controller is fed to the Heating/
Cooling Controller. The Winter/Summer Controller page is displayed below (Figure 27).
Figure 27. Winter/Summer Controller Page
6-19
Setting Up a PEC
1.
Rev 5.4
Click on the appropriate radio button to select whether the Winter/Summer mode is determined by
either the Local SWT (Supply Water Temperature), the Local OAT (Outside Air Temperature) or the
LON. Local means you want to determine the season using the Outside Air/Supply Water Temp on
the PEC-01 controller. If you are getting this temperature from an FSC and binding it to this PEC-01,
then you would choose LON.
Default: Local SWT Options: Local OAT, LON
Selecting either Local SWT or Local OAT moves you to Page 17 - Local Winter/Summer Controller.
Selecting LON skips you to Page 21 - Cooling Type.
2.
Click
PEC WIZARD PAGE 17 - LOCAL WINTER/SUMMER CONTROLLER
This page determines the Setpoint and Deadband for the Local Winter/Summer Controller. The Local Winter/
Summer Controller page is displayed below (Figure 28).
Figure 28. Local Winter/Summer Controller Page
1.
Enter the Setpoint for the Local Winter/Summer Controller. This is the setpoint that determines when
the system is in Winter or Summer mode.
Default: 32.00°F
2.
Enter the Deadband for the Local Winter/Summer Controller. This is the range the setpoint must
pass in order to enable or disable the summer or winter mode. For example, if the deadband was set
at 2°F and the Setpoint was 55°F, then the summer mode would not be ENABLED until 57°F and
would not be DISABLED until 53°F. Likewise, winter mode would not be ENABLED until 53°F and
would not be DISABLED until 57°F.
Default: 0.00°F
3.
6-20
Click
to advance to Page 18 - Heating Type.
Rev 5.4
Setting Up a PEC
PEC WIZARD PAGE 18 - HEATING TYPE
This page determines if the heating type for the system uses a modulated device (Floating) or a discrete device
(Discrete). The Heating Type page is displayed below (Figure 29).
Figure 29. Heating Type Page
1.
Select the Heating Type by clicking on the appropriate radio button.
Default: Floating
Option: Discrete
Selecting Floating moves you to Page 19 - Floating Heating Parameters.
Selecting Discrete skips you to Page 20 - Discrete Heating Parameters.
2.
Click
PEC WIZARD PAGE 19 - FLOATING HEATING PARAMETERS
This page sets the Drive Time, Direction, and Emergency Default The Floating Heating Parameters page is
Figure 30. Floating Heating Parameters Page
1.
Use the spin boxes or enter a value to set the heating Drive Time. This is the amount of time it takes
for the modulating device for heating to go from full open to full closed.
Default: 1 minute and 30 seconds.
6-21
Setting Up a PEC
Rev 5.4
faults to 1 Hour 49 Minutes and 13 Seconds.
2.
, the time de-
Use the drop-down list box to select the damper Direction. This determines if the damper is moving
in its direct direction or the reverse direction. This is useful if the device has been wired wrong in the
field.
Default: Clockwise Option: Counter clockwise
3.
Select the Emergency Default. This is the default setting that the floating actuator will go to when
any Emergency mode other than Normal occurs.
Default: Close
4.
Click
PEC WIZARD PAGE 20 - DISCRETE HEATING PARAMETERS
This page sets the Interstage Delay, Minimum On Time and Minimum Off Time. The Discrete Heating Parameters page is displayed below (Figure 31).
Figure 31. Discrete Heating Parameters Page
1.
Enter a value to set the Heating Interstage Delay. This is the minimum amount of time that must
elapse between successive stages of compressor activation.
Default: 1 minute and 30 seconds
, the time defaults
2.
Enter a value to set the Heating Min. On Time. This is the minimum amount of time that the
compressor must remain ON before it turns OFF. This prevents short cycling.
Default: 1 minute
3.
Enter a value to set the Heating Min. Off Time. This is the minimum amount of time that the
compressor must remain OFF before it turns ON. This is used for equipment protection.
Default: 1 minute
4.
6-22
Click
Rev 5.4
Setting Up a PEC
PEC WIZARD PAGE 21 - COOLING TYPE
This page determines if the cooling type for the system uses a modulated device (Floating) or a discrete device
(Discrete). The Cooling Type page is displayed below (Figure 32).
Figure 32. Cooling Type Page
1.
Select the Cooling Type by clicking on the appropriate radio button.
Default: Floating
Option: Discrete
Selecting Floating moves you to Page 22 - Floating Cooling Parameters.
Selecting Discrete skips you to Page 23 - Discrete Cooling Parameters.
2. Click
PEC WIZARD PAGE 22 - FLOATING COOLING PARAMETERS
The Floating Cooling Parameters page is displayed below (Figure 33).
Figure 33. Floating Cooling Parameters Page
1.
Enter a value to set the cooling Drive Time. This is the amount of time it takes for the modulating
device for cooling to go from full open to full closed.
Default: 1 minute and 30 seconds
faults to 1 Hour 49 Minutes and 13 Seconds.
, the time de-
6-23
Setting Up a PEC
2.
Rev 5.4
Use the drop-down list box to set drive Direction. This determines if the cooling device is moving in
its direct direction or the reverse direction. This is useful if the device has been wired wrong in the
field.
Default: Clockwise Option: Counter clockwise
3.
Select the Emergency Default. This is the default setting that the floating actuator will go to when
any Emergency mode other than Normal occurs.
Default: Close
4.
Click
Option: Open
to skip to Page 18 - Heating Type.
PEC WIZARD PAGE 23 - DISCRETE COOLING
This page sets the Interstage Delay, Minimum On Time, and Minimum Off Time for Discrete Cooling. The
Discrete Cooling page is displayed below (Figure 34).
Figure 34. Discrete Cooling Page
1.
Enter a value to set the Discrete Cooling Interstage Delay. This is the minimum amount of time that
must elapse between successive stages of compressor activation.
Hour 49 Minutes and 13 Seconds.
2.
Enter a value to set the Min. On Time and the Min. Off Time. The Min. On Time is the minimum
amount of time that the compressor must remain ON before it turns OFF. This prevents short cycling.
The Min. Off Time is the minimum amount of time that the compressor must remain OFF before it
turns ON. This is used for equipment protection.
Default - Min. On Time: 1 minute
3.
6-24
, the time defaults to 1
Click
Default - Min. Off Time: 5 minutes
to skip to Page 18 - Heating Type.
Rev 5.4
Setting Up a PEC
PEC WIZARD PAGE 24 - BROADCAST OUTPUT FOR DAMPER?
This is the hardware output of the Economizer Controller and is already broadcast. It receives the economizer
damper position as a percent (0% to 100%) from the Economizer Controller and supplies an output signal of 0 to
10 VDC to control the economizer damper actuator. The Broadcast Output For Damper? page is displayed
below (Figure 35).
Figure 35. Broadcast Output For Damper Page
1.
Default: No
Option: Yes
If the binding was broken between the Economizer Controller and the Analog Output, and the
Analog Output was bound to a point on an FSC, then you might want to broadcast this
point.
2.
Click
to advance to Page 25 - Broadcast Output For Fan Output.
PEC WIZARD PAGE 25 - BROADCAST OUTPUT FOR FAN OUTPUT?
This is the hardware output of the Fan Controller and controls the state of the Fan (On or Off). The Broadcast
Output For Fan Output? page is displayed below (Figure 36).
Figure 36. Broadcast Output For Fan Output? Page
1.
Default: No
Option: Yes
6-25
Setting Up a PEC
Rev 5.4
Note: It is highly suggested that this be set to No. This point receives the Fan Controller output
If the binding was broken between the Fan Controller and the Digital Output, and the Digital Output
2.
Click
to advance to Page 26 - Broadcast Output For Cooling Increment.
PEC WIZARD PAGE 26 - BROADCAST OUTPUT FOR COOLING INCREMENT?
This is the hardware output of the Heating/Cooling Controller and is already broadcast. If the system uses
floating cooling control, this controls the cooling increment. If the system uses discrete cooling control, this
controls Stage 1 of cooling. The Broadcast Output For Cooling Increment page is displayed below (Figure 37).
Figure 37. Broadcast Output For Cooling Increment? Page
1.
Default: No
Option: Yes
If the binding was broken between the Economizer Controller and the Digital Output, and the
2.
6-26
Click
to advance to Page 27 - Broadcast Output For Cooling Decrement.
Rev 5.4
Setting Up a PEC
PEC WIZARD PAGE 27 - BROADCAST OUTPUT FOR COOLING DECREMENT?
floating cooling control, it controls the cooling decrement. If the system uses discrete cooling control, it controls
Stage 2 of cooling. The Broadcast Output For Cooling Decrement page is displayed below (Figure 38).
Figure 38. Broadcast Output For Cooling Decrement? Page
1.
Default: No
Option: Yes
2.
Click
to advance to Page 28 - Broadcast Output For Heating Increment.
PEC WIZARD PAGE 28 - BROADCAST OUTPUT FOR HEATING INCREMENT?
floating cooling control, this controls the heating increment. If the system uses discrete cooling control, this
controls Stage 1 of heating. The Broadcast Output For Heating Increment page is displayed below (Figure 39).
Figure 39. Broadcast Output For Heating Increment? Page
1.
Default: No
Option: Yes
6-27
Setting Up a PEC
Rev 5.4
2.
Click
to advance to Page 29 - Broadcast Output For Heating Decrement.
PEC WIZARD PAGE 29 - BROADCAST OUTPUT FOR HEATING DECREMENT?
floating cooling control, it controls the heating decrement. If the system uses discrete cooling control, it controls
Stage 2 of heating. The Broadcast Output For Heating Decrement page is displayed below (Figure 40).
Figure 40. Broadcast Output For Heating Decrement? Page
1.
Default: No
Option: Yes
Note: This is the last page in the PEC Configuration Wizard.
2.
Press
Click
to save your changes and exit the PEC Wizard.
Click
to abandon your changes and exit the PEC Wizard. You will be prompted to
confirm your desire to cancel.
6-28
Rev 5.4
Setting Up a PEC
ADVANCED PEC EDITING
EDITING POINTS
All 31 points on the PEC controller are editable and you edit the points to tune your PEC system. Each point has
a predefined point number and point type which are not editable. To edit a point on the PEC controller:
1.
Click on the PEC you want to edit, then click on the Points (Figure 7).
Figure 7. PEC Points Page with Point #11 - User Setpoint Highlighted.
2.
Double click on the point you want to edit. The Point Editor for the selected point displays.
3.
Edit the point, as necessary. Specific procedures for editing points are discussed on the following
pages:
EDITING POINT #1 - DISCHARGE AIR TEMP (ANALOG INPUT)
Point #1 measures the temperature of the discharge air from a thermistor input. This point is used by the Mixed
Air PID (Point #19) in determining the desired damper position.
EDITING POINT #2 - MIXED AIR TEMP (ANALOG INPUT)
Point #2 measures the temperature of the mixed air from a thermistor input. This point is used by the Mixed Air
PID (Point #19) in determining the desired damper position.
EDITING POINT #3 - SPACE TEMP (ANALOG INPUT)
Point #3 is a temperature input. Depending on the exact configuration, this could be either Space Temperature or
an auxiliary temperature, Return Air Temperature. If you are using an ESUSA sensor, this point is Space
Temperature and measures the temperature of the zone under control. If you are using an ESUSA thermostat,
then this point can be used as return air temperature.
6-29
Setting Up a PEC
Rev 5.4
EDITING POINT #4 - OUTSIDE AIR/SUPPLY WATER TEMP (ANALOG INPUT)
Point #4 measures the temperature of the outside air or the supply water from a thermistor input. Depending on
the system configuration, this point could be used by the Winter/Summer Controller (Point 21) in determining
the summer or winter mode of control for a two pipe system. If this point measures outside air temperature, this
point provides the OAT for display on the Intelligent STAT.
EDITING POINT #5 - FAN STATUS INPUT (DIGITAL INPUT)
Point #5 is a discrete input and is used for fan status feedback. The main purpose of this point is to add safety to
the system by allowing verification of the state of the fan for equipment protection.
EDITING POINT #6 - EMERGENCY SHUTDOWN (DIGITAL INPUT)
Point #6 is for the Emergency Shutdown. This input is wired to an external sensor in an area that should be able
to cause an Emergency Shutdown for the local controller.
EDITING POINT #7 - SPACE TEMP CONTROLLER
This point holds the Space Temperature and generates alarms. If you selected Intelligent on the Thermostat Page
for the PEC, then this value comes from an ESUSA STAT. If Thermistor was selected, then this value comes
from the Space Temp (Point #3) or an external LON device.
EDITING POINT #8 - INDOOR AIR QUALITY CONTROLLER
Indoor Air Quality (IAQ) is the quality of the air expressed in a percentage with 0% being the best and 100%
being the worst. This point is used to tell the controller to increase the Minimum Flow Setpoint to compensate
for poor IAQ. The intention is to increase air flow to provide additional fresh air to displace air currently in the
controlled space.
EDITING POINT #9 - OUTSIDE AIR TEMP
This point receives the outside air temperature from another point or another controller. This point is used by the
Analog Output (Point 26) in determining the desired damper position. This point differs from the Outside Air/
Supply Water Temp (Point #4) because Point #4 is an actual hardware point, while Point #9 is a software point.
Point #9 allows you to bind an Outside Air Temperature from another controller.
EDITING POINT #10 - MANUAL OCCUPANCY CONTROLLER
This point determines the state of occupancy for the controller (Occupied, Unoccupied, Economy). The state of
occupancy determines which setpoints are currently in use by the controller. The possible states of occupancy
the controller can be placed in are shown on the Point Command window (Figure 13). Although the list contains
4 states, the PEC controller only responds to 3 different states. The states are:
OCCUPIED - Uses the Occupied Heating and Cooling Setpoints.
UNOCCUPIED - Uses the Unoccupied Heating and Cooling Setpoints.
BYPASS - Not used in the PEC controller.
STANDBY - Uses the Economy Heating and Cooling Setpoints.
EDITING POINT #11 - USER SETPOINT CONTROLLER
This is the user desired setpoint. This point is given to the controller by the user through the Intelligent or TSO
STAT. This point is used in conjunction with the Setpoint Controller (Point # 18) to determine an offset (by
comparing the Occupied Cooling Setpoint to the User Setpoint) and then apply that offset to the current setpoints to determine the Active Setpoint.
6-30
Rev 5.4
Setting Up a PEC
EDITING POINT #12 - OVERRIDE CONTROLLER
This point provides the override function and timing for the controller. Override is used to cause the system to
control to the occupied setpoints when the building is not normally occupied. Override places the controller back
into occupied mode for a specified time (set in the Override Time field). When this time expires, the previous
control (setpoints) resumes.
EDITING POINT #13 - APPLICATION MODE CONTROLLER
This point sets the overall operation mode of the PEC controller. The possible modes the controller can be
placed in are listed below. Although the list contains ten modes, the PEC controller only responds to six different
modes.
The modes are:
AUTO - This is the normal mode for the PEC. The controller cools and heats over the whole range of possible
setpoints. Control is provided between -100% to 100% thermal load.
HEAT - The controller is in heat mode only. Control is provided between -100% and 0% thermal load.
MORNING WARMUP - The economizer damper is fully closed, and then the controller functions as usual.
See the PEC Engineering Guide for more information.
COOL - The controller is in cool mode only. Control is provided between 0% and 100% thermal load.
NIGHT PURGE - The economizer damper is driven to maximum.
PRECOOL - Not used in the PEC controller.
OFF - The controller is not providing control and is fixed at 0% thermal load.
TEST - Not used in the PEC controller.
EMERGENCY HEAT - Not used in the PEC controller.
FAN ONLY - Not used in the PEC controller.
EDITING POINT #14 - MANUAL RESET
This point allows the network to send a manual reset command to the Low Limit Shutdown controller in order to
facilitate a reset.
EDITING POINT #15 - LOW LIMIT SHUTDOWN
This point determines if conditions are met to perform a low limit shutdown. This is determined by comparing
the Mixed Air Temp (Point #2) and the Low Limit Setpoint. If the Mixed Air Temp is below the Low Limit
Setpoint, then a low limit shutdown is performed and the unit undergoes an Emergency Shutdown. Low Limit
Shutdown is used for equipment protection mainly to prevent coil freeze-up.
EDITING POINT #16 - LOCAL EMERGENCY SHUTDOWN
This point determines if conditions are met to perform a local emergency shutdown. This is determined by the
Emergency Shutdown (Point #6) and is used to tell the controller when to assume emergency operation mode
operations and only effects the local unit.
EDITING POINT #17 - LON EMERGENCY SHUTDOWN
This point determines if conditions are met to perform a LON emergency shutdown. This is determined by a
point that is bound from another controller to the PEC-01 controller and is used to tell the controller when to
assume emergency operation mode operations. This point is used for smoke control. The possible states of
emergency the controller can be placed in are shown below:
NORMAL - No emergency operations - the controller is controlling to application mode.
PRESSURIZE - The controller drives the economizer damper to maximum, the fan is turned ON, and the
thermal load is forced to 0%.
6-31
Setting Up a PEC
Rev 5.4
DEPRESSURIZE - The controller drives the economizer damper to full closed, the fan is turned OFF, and
the thermal load is forced to 0%.
PURGE - The controller drives the economizer damper to maximum, the fan is turned ON, and the thermal
load is forced to 0%.
SHUTDOWN - The controller drives the economizer damper to full closed, the fan is turned OFF, and the
EDITING POINT #18 - SETPOINT CONTROLLER
This point determines the setpoint the controller is currently using. This point takes the User Setpoint Controller
(Point #11), compares it to the occupied cooling setpoint entered on this point editor, and determines an offset.
This offset is then added to the occupied heating and cooling and economy heating and cooling setpoints and the
active setpoint is determined. The output of the Manual Occupancy Controller (Point #10), the output of the
Override Controller (Point #12), and the output of the Space Temp Controller (Point #7) are also looked at in the
determination of setpoint.
this screen do not change. For more information, see the PEC Engineering Guide.
EDITING POINT #19 - MIXED AIR PID CONTROLLER
This point is used to determine the mixed air PID damper position. This point takes the Discharge Air Temp
(Point #1) and the Mixed Air Setpoint (entered in this editor) and outputs a Mixed Air PID damper position in
percent. This is not the absolute damper position because this position is based only on the Discharge Air Temp
and the Mixed Air Setpoint. This output is then fed to the Economizer Controller (Point #23) and the exact
damper position is determined.
EDITING POINT #20 - EMERGENCY COMMAND CONTROLLER
This point is used to tell the controller when to assume emergency operation mode operations. This point looks
at the Low Limit Shutdown (Point #15), the Local Emergency Shutdown (Point #16), and the LON Emergency
(Point #17) and determines the emergency mode of operations. The possible states of emergency the controller
can be placed in are shown on the Point Command window (Figure 26). The emergency states are:
NORMAL - No emergency operations - the controller is controlling to application mode.
PRESSURIZE - The controller drives the economizer damper to maximum, the fan is turned ON, and the
DEPRESSURIZE - The controller drives the economizer damper to full closed, the fan is turned OFF, and the
PURGE - The controller drives the economizer damper to maximum, the fan is turned ON, and the thermal load
is forced to 0%.
SHUTDOWN - The controller drives the economizer damper to full closed, the fan is turned OFF, and the
6-32
Rev 5.4
Setting Up a PEC
EDITING POINT #21 - WINTER/SUMMER CONTROLLER
This point determines the summer or winter mode for a two-pipe system. This mode is determined by looking at
the Outside Air/Supply Water Temp (Point #4). The output of the Winter/Summer Controller (Point #21) is fed
to the Heating/Cooling Controller (Point #25).
EDITING POINT #22 - TEMP PID CONTROLLER
This point calculates thermal load for the controller. It takes the actual space temperature from the Space Temp
Controller (Point #7) and the desired space temperature from the Setpoint Controller (Point #18) and outputs a
thermal load value that is fed to the Economizer Controller (Point #23), the Fan Controller (Point #24), and the
Heating/Cooling Controller (Point #25). The output of the Emergency Command Controller (Point #20) and the
output of the Application Mode Controller (Point #13) are also used at in the determination of thermal load.
EDITING POINT #23 - ECONOMIZER CONTROLLER
This point determines the economizer damper position. The damper position is determined by looking at the
Indoor Air Quality Controller (Point #8), the Outside Air/Supply Water Temp (Point #4), the Mixed Air PID
Controller (Point #19), the Manual Occupancy Controller (Point #10), the Emergency Command Controller
(Point #20), and the Temp PID Controller (Point #22).
EDITING POINT #24 - FAN CONTROLLER
This point determines when the fan should be ON or OFF. This point looks at the output the Manual Occupancy
Controller (Point #10) and the output of the Emergency Command Controller (Point #20) to determine if the fan
should be ON or OFF. The output of this point is sent to the Fan Output (Point #27) which is the control point
for the fan.
Status (Point #5) can be used as a feedback to determine the actual status of the fan.
EDITING POINT #25 - HEATING/COOLING CONTROLLER
This point determines whether the system is heating or cooling. Many factors are looked at in this determination.
Depending on what is entered in this point editor, this can determine heating or cooling, discrete or floating
control, 2 or 4 pipe system, etc.
NOTE: The fields on this screen change depending on the Cooling Type and Heating Type selected.
EDITING POINT #26 - ANALOG OUTPUT
NOTE:
This point is used to control the Economizer Damper.
This point is the hardware output of the Economizer Controller (Point #23). This point receives the economizer
damper position as a percent (0 to 100) from the Economizer Controller and supplies an output signal of 0 to 10
VDC to control the economizer damper actuator.
EDITING POINT #27 - DIGITAL OUTPUT #1 FAN ACTUATOR OUTPUT
Point #27 controls the state of the fan (ON or OFF). This point is the hardware output of the Fan Controller
(Point #24) and applies the control.
6-33
Setting Up a PEC
Rev 5.4
EDITING POINT #28 - DIGITAL OUTPUT #2 COOLING STAGE 1/INC OUTPUT
Point #28 controls the cooling increment if the system uses floating cooling control. If the system uses discrete
cooling control, this point controls Stage 1 of cooling. This point is the hardware output of the Heating/Cooling
Controller (Point #25) and applies the control.
EDITING POINT #29 - DIGITAL OUTPUT #3 COOLING STAGE 2/DEC OUTPUT
Point #29 controls the cooling decrement if the system uses floating cooling control. If the system uses discrete
cooling control, this point controls Stage 2 of cooling. This point is the hardware output of the Heating/Cooling
EDITING POINT #30 - DIGITAL OUTPUT #4 HEATING STAGE 1/INC OUTPUT
Point #30 controls the heating increment, if the system uses floating cooling control. If the system uses discrete
cooling control, this point controls Stage 1 of heating. This point is the hardware output of the Heating/Cooling
EDITING POINT #31 - DIGITAL OUTPUT #5 HEATING STAGE 2/DEC OUTPUT
Point #31 controls the heating decrement if the system uses floating cooling control. If the system uses discrete
cooling control, this point controls Stage 2 of heating. This point looks at the output of the Heating/Cooling
6-34
Chapter Seven
Setting Up an NAE
Setting Up An NAE
Defining An NAE
Commissioning An NAE
Setting Up an NAE
Rev 5.4
NAE OVERVIEW
The Network Automation Engine (NAE) with a LONWORKS® network interface serves as a LONWORKS network
integrator within the Metasys® system extended architecture. As a LONWORKS network integrator, the NAE
monitors and supervises LONWORKS enabled devices on a single network segment. Data is presented on a Web
browser that is logged in to the NAE or Application Data Server (ADS) requesting data over the IP network.
MCL Tool is used strictly as a configuration tool to add and setup nodes on the LONWORKS network. Once these
nodes are configured and online, a Web browser, logged in to the NAE is used as the NAE user interface (UI).
An NAE must be commissioned and online on the LONWORKS network to assure communication and control
from the Metasys extended architecture. Once the NAE and any other LONWORKS devices have been added to
the physical tree, a database export file for each device can be created and then imported into the NAE using a
Web browser. See Generate Metasys Export File in the System Setup - Common Node chapter of this document. See the LONWORKS Network Integration With NAE Technical Bulletin (LIT-1201668) for more
information on the NAE and Metasys system extended architecture.
NAE SETUP REQUIREMENTS
The NAE is added to the physical tree and commissioned, just as any other LONWORKS device.
ADDING AN NAE TO THE PHYSICAL TREE
Adding an NAE to the Physical Tree requires two steps to be carried out in order. These steps are Defining and
Commissioning.
Defining - The Add Node Menu is used to install the NAE on the tree, define the NAE’s name and Program ID.
The NAE being defined can be either off-line or on-line and does not have to be physically attached to the
network until the commissioning stage. You can define multiple NAEs and then commission them all at once.
Commissioning - The Node Setup Menu is used to commission the defined NAE. Commissioning writes the
network image, Neuron ID, and Program ID to a database. The defined NAE must be on-line and physically
DEFINING AN NAE
The first step to adding an NAE is the defining process.
To add an NAE to the Physical Tree:
1.
Right click on the Global Node where the NAE will be located. The Node pop-up menu (Figure 1)
appears. Click Add to display the secondary menu, then choose Node, then either Before or After to
set the NAE’s placement on the tree. The Add Node menu (Figure 2) appears.
7-2
Rev 5.4
Setting Up an NAE
2.
Click on the NAE in the list of devices and then enter a name for the NAE in the New Node Name:
area. This should be as descriptive as possible and indicate the purpose and/or location of the NAE. For example, this could be NAE 2nd Floor West Wing.
NOTE: If the NAE is not listed in the Add Node device list see Device Template.
3.
Click
. The uncommissioned NAE has been added to the physical tree (Figure 3).
Figure 3. Physical Tree with Newly Added Uncommissioned NAE
COMMISSIONING THE NAE
The second step is to commission the NAE. An NAE that has not yet been commissioned will have (Never
Commissioned) after the NAE’s name on the tree.
1.
Right click on the uncommissioned NAE to bring up the Node Menu (Figure 4). Select Setup Node
Figure 4. Node Menu
2.
The exact Neuron ID for the NAE should be on a label on the NAE. Type it in the Neuron ID field.
The Neuron ID is specific to the NAE controller you are setting up and is given to the MCLT when
the service pin is pressed on the controller. If you do not know the exact Neuron ID number, do not
type anything in this field. Go to Step 3.
7-3
Setting Up an NAE
3.
Rev 5.4
press the Service Pin on the NAE you are commissioning. This registers the Neuron ID, Program ID
and associated device specific information. Once you press the service pin on the NAE the Setup
Node Menu displays the NAE’s Neuron ID and Program ID information (Figure 6).
Figure 6. Node Setup Menu after pressing the Service Pin on the NAE
4.
Click
to advance to the next Node Setup pages (Figures 7 & 8). Keep the Send Network Image
box checked. This sends the NAE’s device information, including critical binding settings, to refresh
the default NV Configuration Data file in the NAE. This is a required process.
5.
Click the
button to complete the commissioning and bring the NAE online in the
Physical tree (Figure 9).
Figure 9. Newly Commissioned NAE
7-4
Rev 5.4
Setting Up an NAE
Send Network Image - Sends the device’s network address and critical bindings to the LNS database.
Note: This is a critical step for the NAE that must be carried out. The NAE will not be able to
populate its LONWORKS network until this process is carried out. When the network image is
sent it sends critical binding information to the NAE and creates the NV Configuration Data
resource file in the NAE’s Extension Wizard. These bindings allow the resource files for the
LonWorks devices to recognize the NAE.
5.
Click
the NAE on the tree. Click
7-5
Setting Up an NAE
7-6
Rev 5.4
Chapter Eight
Setting Up LN Series Devices
This chapter contains references to:
Setting Up LN Series Device Plug-ins
LN Series Documentation
Setting Up LN Series Devices
Rev 5.4
LN SERIES DOCUMENTATION OVERVIEW
Documentation for the LN Series family of LONWORKS® network devices is provided in a series of device
specific documents. Refer to the Table below for a list of these documents.
LN SERIES DEVICE PLUG-IN DOCUMENTATION
Refer to the Metasys® System LN Series Device Plug-in Installation Quick Start Guide (LIT-1201982) for
details on installing the LN Series device plug-ins.
METASYS SYSTEM LN SERIES DOCUMENTATION
Metasys System LN Series Documentation
LIT. Number
Application Specific Controllers
LN Series Application Specific Controllers Installation Instructions
LN Series Application Specific Controllers Product Bulletin
LIT-1201916
LIT-1201915
LN Series Unit Ventilator Profile Application Controllers User's Guide
LN Series Unit Ventilator Controller Catalog Page
LIT-1201934
LIT-1900287
LN Series Fan Coil Unit Controller User's Guide
LN Series Fan Coil Unit Controller Catalog Page
LIT-1201919
LIT-1900284
LN Series Rooftop Unit Controller User's Guide
LN Series Rooftop Unit Controller Catalog Page
LIT-1201924
LIT-1900285
LN Series Heat Pump Unit Controller User's Guide
LN Series Heat Pump Unit Controller Catalog Page
LIT-1201929
LIT-1900286
LN Series VAV/VVT Controllers User's Guide
LN Series VAV and VVT Profile Application Controllers Catalog Page
LN Series VAV and VVT Profile Application Controllers Product Bulletin
LIT-1201978
LIT-1900283
LIT-1201910
LN Series Two-Door Access Controller Catalog Page
LN Series Two-Door Access Controllers Product Bulletin
LN Series Two-Door Access Controller Installation Instructions
LIT-1900288
LIT-1201935
LIT-1201936
Programmable Controllers
LN Series Controllers Free Programming Plug-In User's Guide
LN Series Free Programmable Controller Product Bulletin
LN Series Rooftop Application Free Programmable Controller Product Bulletin
LN Series VAV and VVT Profile Application Free Controllers Product Bulletin
LIT-1201855
LIT-1201853
LIT-1201873
LIT-1201877
Thermostats
LN Series Thermostat Plug-in User's Guide
LN Series Non-programmable Network Configurable Thermostats Installation
Instructions
LN Series Network Configurable Thermostats for RTU & HPU Controllers
Product Bulletin
Display and Scheduler
LN Series Controllers Display Plug-in User's Guide
LN Series Controllers Scheduler User's Guide
LN Series Controllers Scheduler and Display Product Bulletin
8-2
LIT-1201863
LIT-1201911
LIT-1201938
LIT-1201909
LIT-1201899
LIT-1201903
Rev 5.4
System Setup Index
System Setup Index
A
D
Active Setpoint 4-15
Add 1-8
Adding a PEC 6-2
Adding a Router to the Physical Tree 2-3
Commissioning 2-3
Defining 2-3
Adding Nodes To A Router 2-7
Advanced PEC Editing 6-29
Air Flow 4-14,4-20
Application Mode Controller 4-10,5-10
Application Specific Controller 5-2
ASC 3-2
Damper 4-14
Damper Actuator 4-20
Damper Actuator Increment 4-20
Damper Position 4-20
Deadband 5-15
Decommission Node 1-13
Default Output 4-11,4-15,5-10
Defining a PEC 6-2
Delay Time 5-15,5-18
Derivative Gain 4-11,4-15,5-10,5-14
Direct Action 4-15
Display Order 4-8,5-8
Drive Time 4-15
B
Binding 4-20
Broadcast 4-20,4-21,4-22,5-19,5-20,5-21,5-22
C
checksum I/O boards 3-9
Commissioning a Defined Router 2-6
Commissioning the PEC 6-3
Config Data Set 1-15
Config Password 4-8,4-9,5-7,5-8
Configuration Data Set
Add 1-15
Apply 1-15
Export 1-15
Import 1-15
Configuration Mode 4-8,5-7
Connection Description Template (CDT) 1-28
Adding A Connection Description Template
(CDT) 1-28
Addressing 1-29
Deleting An Existing CDT 1-31
Entering Values
Other 1-30
Service Types 1-29
Timing Parameters 1-29
Modifying An Existing CDT 1-30
Cooling Scan Rate 4-11,5-10
CPL 3-2
E
Economizer
Controller 4-10,5-10,5-13
Economy
Cooling Setpoint 4-9,4-10,5-9
Heating Setpoint 4-9,4-10,5-9
Edit/View Binding 1-14
Emergency
Command 5-17
Command Controller 4-10,5-10
Heat 5-17
Heat Holdoff 5-17
Shutdown 6-30
English Units 4-8,5-8
F
Fan
Controller 4-10,4-21,5-10
Output 4-21,5-15
Status 5-16,5-17
Status Delay 5-16
Far-Side Transceiver Types 2-3
Fiber Optic/Twisted Pair Router 2-3
FLC 3-2
Flow Offset 4-12
FSC 4-20,4-21,4-22,5-21
FSC/FLC 3-2
Add 3-2
FTR 2-3
Index-1
System Setup Index
G
N
Global Node 1-8,3-3,4-2,5-2,7-2
NAE
NV Configuration Data 7-5
Send Network Image 7-5
Network 5-12
Neuron ID 3-4,4-3,5-3,7-3
No Reverse 5-18
Node
Delete 1-15
Move 1-7,1-8
Rename 1-17,1-18
Node Commands 1-2
Offline 1-3
Reset 1-3
Test 1-4
Wink 1-2
Node Menu 1-2
non-checksum I/O boards 3-9
H
Heating
Scan Rate 4-11,5-10
Heating/Cooling Controller 4-10,5-10
Holdoff 5-17
I
I/O Module 3-9
Integral Gain 4-10,4-15,5-10,5-13
Intelligent STAT 4-7,5-7
Interstage Delay 4-18
K
K Factor 4-11,4-12,4-14
K Factor Calibration 4-12
L
LN Series device plug-ins 8-2
LN Series Documentation 8-2
Local 5-12
Local Economizer 5-12
LON Economizer 5-12
Loop Enable 5-17
Low Limit
Setpoint 5-14
M
Maximum Air Flow 4-13
Metric Units 4-8,5-8
Min. Off Time 5-17
Min. On Time 5-17
Min. Reheat Flow 4-13
Minimum Air Flow 4-13
Minimum Run Time 5-15
Mixed Air PID 5-14,5-17
Mixed Air Temperature 5-14
Morning Warmup
Maximum Flow 4-13
Minimum Flow 4-13
Move 1-7,1-8
MultiNode Operations 1-26
MWU Max. Flow 4-13
MWU Min. Flow 4-13
Index-2
O
OAT Deadband 5-13
Occupied Cooling Setpoint 4-9,5-9
Occupied Heating Setpoint 4-9,5-9
Occupied Mode 4-8,5-8
Offline 1-3
Offset 4-10,5-9
P
Parallel Fan 4-16
Password 4-8,5-7,5-8
PEC 3-3,4-2,5-2,7-2
Editors 3-4,4-3,5-3,7-3
Global Information 3-6,4-5,5-6,6-6
Physical Tree 3-3,4-2,5-2,7-2
PID 4-16
PID Loop 4-14
Plug-Ins 1-5
Registering A Plug-In 1-5
Running A Plug-In 1-6
Polarity 5-18
Proportional Gain 4-10,4-15,5-10,5-13
R
Reheat Decrement 4-16
Reheat Increment 4-16
Rev 5.4
Rev 5.4
System Setup Index
Replace Node 1-12
Reset 1-3
Reverse 5-18
Reverse Action 4-15
Router
Bridge Router 2-2
Configured Router 2-2
Learning Router 2-2
Permanent Bridge Router 2-2
Permanent Repeater Router 2-2
Repeater Router 2-2
Router Classification Types 2-2
Running A Plug-In 1-6
S
Scan Rate 4-11,4-15,5-10
Scan Time 5-14
Send Network Image 7-5
Serial Fan 4-16
Service Pin 3-4,4-3,5-3,7-3
Set Time/Day On Node 1-17
Setpoint 5-14
Setpoint Controller 4-10,5-10
Setup Node 1-9
Space Temperature 3-7,4-7,5-7
Stages 5-16
Standby State 6-30
Status Send Interval 3-7
T
Test 1-4
Thermal Load 4-10,5-10
Thermistor 4-7,5-7
Time Broadcast Interval 3-7
Time Mode 4-8,5-8
Time Zone Offset 3-7
U
Units 4-8,5-8
Unoccupied Cooling Setpoint 4-10,5-9
Unoccupied Heating Setpoint 4-10,5-9
User Mode 4-8,5-8
W
Wink 1-2
Index-3
System Setup Index
Index-4
Rev 5.4
MCL TOOL 5.4 - SECTION FOUR
Programming
Chapters
1. Binding Network Variables
2. Using CPL
3. CPL Blocks
4. Schedules
Programming Introduction
Rev 5.4
FSC®, CPL® and MCL Tool® are trademarks of Johnson Controls, Inc.
All Rights Reserved
Published in U.S.A.
2
Section 4 - Programming
Rev 5.4
Programming Table of Contents
Chapter One - Binding Network Variables
1-1
Overview ........................................................................................................................... 1-2
Editing and Viewing Bindings ................................................................................. 1-2
Refresh ........................................................................................................ 1-3
Adding A Bind .............................................................................................. 1-4
Deleting a Bind ............................................................................................ 1-5
Chapter Two - Using CPL
2-1
Overview ........................................................................................................................... 2-2
CPL Pages Subtree ................................................................................................ 2-2
Working With Individual Pages .................................................................... 2-3
CPL Page Menu Commands ....................................................................... 2-3
CPL Blocks ........................................................................................................................ 2-5
Block Types .................................................................................................. 2-6
Arithmetic Blocks .............................................................................. 2-6
Comparison Blocks ........................................................................... 2-6
Constant Blocks ................................................................................ 2-6
Function Blocks ................................................................................. 2-6
Global Variable Blocks ...................................................................... 2-6
Logical Blocks ................................................................................... 2-6
Point Blocks ...................................................................................... 2-7
Time Blocks ....................................................................................... 2-7
Block Colors ................................................................................................. 2-7
CPL Editor ......................................................................................................................... 2-7
CPL Editor Toolbar .................................................................................................. 2-8
Selection Mode ............................................................................................ 2-8
Zoom Modes ................................................................................................ 2-8
Best Fit......................................................................................................... 2-8
Show Grid .................................................................................................... 2-8
Monitor Mode ............................................................................................... 2-9
Status/Command Point Function .................................................... 2-10
Export CPL Page to DXF ........................................................................... 2-11
Zoom Control Box ................................................................................................. 2-11
CPL Block Menu ................................................................................................... 2-12
Creating and Editing CPL Pages ..................................................................................... 2-12
To Add A New CPL Page: ..................................................................................... 2-12
Adding CPL Blocks .................................................................................... 2-13
Editing CPL Blocks ............................................................................................... 2-13
Editing Multiple Blocks ............................................................................... 2-14
Status/Command Point Menu Command................................................... 2-15
Direct/Reverse Acting ..................................................................... 2-15
Deleting A Block ........................................................................................ 2-16
Deleting Multiple Blocks ............................................................................. 2-16
Moving A Block .......................................................................................... 2-17
Moving Multiple Blocks .............................................................................. 2-17
3
Rev 5.4
Block Connections ........................................................................................................... 2-17
Connecting Blocks ................................................................................................ 2-17
Multiple Inputs ............................................................................................ 2-18
Deleting A Block Connection ..................................................................... 2-18
CPL User Library ............................................................................................................. 2-19
CPL Library Window ............................................................................................. 2-19
Accessing the CPL Library from MCLT ...................................................... 2-20
Closing The CPL Library ............................................................................ 2-20
Library Pages Window .......................................................................................... 2-20
Library Pages Toolbar ................................................................................ 2-21
CPL Library Block Editor Window ......................................................................... 2-21
Creating A New CPL Library Page ............................................................ 2-21
Importing AN Existing CPL Library Page ................................................... 2-22
Exporting A CPL library page To A DXF File ............................................. 2-22
Summary Of Blocks .............................................................................................. 2-23
Chapter Three - CPL Blocks
3-1
CPL Blocks ........................................................................................................................ 3-2
CPL Block Settings ................................................................................................. 3-2
Ignore Error Check Box ............................................................................... 3-3
Entering Block Information - Constants .................................................................. 3-3
Analog Constant .......................................................................................... 3-4
Settings ............................................................................................. 3-4
Digital Constant ........................................................................................... 3-4
Settings ............................................................................................. 3-4
Entering Block Information - Functions ................................................................... 3-5
2-Position ..................................................................................................... 3-6
Settings ............................................................................................. 3-6
Accumulator ................................................................................................. 3-7
Settings ............................................................................................. 3-7
Calculation ................................................................................................... 3-7
Settings ............................................................................................. 3-8
Counter ........................................................................................................ 3-9
Settings ............................................................................................. 3-9
Dial Provider ................................................................................................ 3-9
Settings ............................................................................................. 3-9
Enthalpy ..................................................................................................... 3-10
Settings ........................................................................................... 3-10
Error - Analog (A-error) .............................................................................. 3-10
Settings ........................................................................................... 3-10
Error - Digital (D-Error)............................................................................... 3-11
Settings ........................................................................................... 3-11
Hi/Lo/Average ............................................................................................ 3-11
Settings ........................................................................................... 3-11
Lead/Lag .................................................................................................... 3-12
Settings .......................................................................................... 3-12
4
Rev 5.4
Min/Max ..................................................................................................... 3-13
Settings ........................................................................................... 3-13
Minimum On/Off ......................................................................................... 3-14
Settings ........................................................................................... 3-14
One Shot.................................................................................................... 3-15
Settings ........................................................................................... 3-15
PID Loop .................................................................................................... 3-16
Settings ........................................................................................... 3-16
Timing ............................................................................................. 3-16
Psychro ...................................................................................................... 3-17
Settings ........................................................................................... 3-17
Ramp ......................................................................................................... 3-17
Settings ........................................................................................... 3-18
Timing ............................................................................................. 3-18
Relay - Analog .......................................................................................... 3-18
Settings ........................................................................................... 3-18
Relay - Digital............................................................................................ 3-19
Settings ........................................................................................... 3-19
Reset ......................................................................................................... 3-19
Settings ........................................................................................... 3-20
Rolling Average .......................................................................................... 3-20
Settings ........................................................................................... 3-20
Timing ............................................................................................. 3-20
Runtime ..................................................................................................... 3-21
Settings ........................................................................................... 3-21
Schedule .................................................................................................... 3-22
Settings ........................................................................................... 3-22
Timing ............................................................................................. 3-23
Example .......................................................................................... 3-23
Sequencer ................................................................................................. 3-24
Settings ........................................................................................... 3-25
Descriptor ........................................................................................ 3-25
Example .......................................................................................... 3-25
Startup ....................................................................................................... 3-26
Settings ........................................................................................... 3-26
Start/Stop ................................................................................................... 3-27
Settings ........................................................................................... 3-27
Time Event ................................................................................................. 3-27
Settings ........................................................................................... 3-28
Entering Block Information - Global Variables ...................................................... 3-28
Settings ........................................................................................... 3-28
Global Analog Input ................................................................................... 3-29
Global Digital Input .................................................................................... 3-29
Global Analog Output ................................................................................ 3-29
Global Digital Output .................................................................................. 3-29
5
Rev 5.4
Entering Block Information - Logical ..................................................................... 3-29
AND ........................................................................................................... 3-30
Settings ........................................................................................... 3-30
OR ............................................................................................................. 3-30
Settings ........................................................................................... 3-31
NOT ........................................................................................................... 3-31
Settings ........................................................................................... 3-31
XOR ........................................................................................................... 3-31
Settings ........................................................................................... 3-32
Entering Block Information - Comparison ............................................................. 3-32
A-Equal ...................................................................................................... 3-33
Settings ........................................................................................... 3-33
A-Not Equal .............................................................................................. 3-33
Settings ........................................................................................... 3-33
D-Equal ...................................................................................................... 3-34
Settings ........................................................................................... 3-34
D-Not Equal ............................................................................................... 3-34
Settings ........................................................................................... 3-34
Greater Equal ............................................................................................ 3-34
Settings ........................................................................................... 3-34
Greater Than .............................................................................................. 3-35
Settings ........................................................................................... 3-35
Less Equal ................................................................................................. 3-35
Settings ........................................................................................... 3-35
Less Than .................................................................................................. 3-36
Settings ........................................................................................... 3-36
Entering Block Information - Arithmetic ................................................................ 3-36
Add ............................................................................................................ 3-37
Settings ........................................................................................... 3-37
Divide ......................................................................................................... 3-37
Settings ........................................................................................... 3-37
Modulus ..................................................................................................... 3-37
Settings ........................................................................................... 3-37
Multiply ....................................................................................................... 3-38
Settings ........................................................................................... 3-38
Negate ....................................................................................................... 3-38
Settings ........................................................................................... 3-38
Sq. Root (Square Root) ............................................................................. 3-38
Settings ........................................................................................... 3-38
Subtract ..................................................................................................... 3-39
Settings ........................................................................................... 3-39
Entering Block Information - Points ...................................................................... 3-39
AI (Analog Input) ........................................................................................ 3-40
Settings ........................................................................................... 3-40
DI (Digital Input) ......................................................................................... 3-40
Settings ........................................................................................... 3-40
6
Rev 5.4
AO (Analog Output) ................................................................................... 3-40
Settings ........................................................................................... 3-40
D0 (Digital Output) ..................................................................................... 3-40
Settings ........................................................................................... 3-40
MAI (Multiple Analog Input) ....................................................................... 3-41
Settings ........................................................................................... 3-41
MDI (Multiple Digital Input) ........................................................................ 3-42
Settings ........................................................................................... 3-42
Point State ................................................................................................. 3-42
Settings ........................................................................................... 3-43
SNVT State Input ....................................................................................... 3-44
Settings ........................................................................................... 3-44
SNVT State Output .................................................................................... 3-45
Settings ........................................................................................... 3-45
Entering Block Information - Time ........................................................................ 3-46
Constant Time............................................................................................ 3-46
Settings ........................................................................................... 3-46
Convert Time ............................................................................................. 3-47
Settings ........................................................................................... 3-47
Current Time .............................................................................................. 3-47
Settings ........................................................................................... 3-47
Chapter Four - Schedules
4-1
Scheduling ........................................................................................................................ 4-2
The Schedule Subtree ............................................................................................ 4-2
Viewing Individual Schedules ...................................................................... 4-2
Creating A New Schedule ...................................................................................... 4-3
Adding A New Schedule: ............................................................................. 4-3
Entering Values For A New Schedule: ......................................................... 4-4
Editing An Existing Schedule.................................................................................. 4-6
Renaming A Schedule ............................................................................................ 4-6
Deleting A Schedule ............................................................................................... 4-6
Copying Schedules To Another FSC ...................................................................... 4-7
Refresh Schedules ................................................................................................. 4-7
Programming Index
I-1
7
8
Rev 5.4
Chapter One
Binding Network Variables
● Editing and Viewing Bindings
● Adding a Bind
● Deleting a Bind
Binding
Rev 5.4
OVERVIEW
Binding is the process that defines connections between LONWORKS Devices. These connections define the data
that devices on the network share with one another. To share this data, MCLT connects (or “binds”) a point on a
device to another point that needs that same data. This point can either be on the same device or it can be a
different device on the network.
NOTE: The words bind and connection can be used interchangeably.
Binding is accomplished by connecting Network Variables (NVs). MCLT uses the Bind Editor to bind Network
Variable Outputs (NVOs) to Network Variable Inputs (NVIs). As stated above, Network Variables can be bound
from one node to another node, or bound internally on the same node. For more information on Points and
Network Variables, please see Section Five, Operations - Chapter One.
Binding gives the User the ability to use Network Variables over the LON instead of physical wiring between the
FSC and the VAV. In Figure 1, a temperature NVO on one node (a VAV controller) is bound to a temperature
NVI on another node (in this example, an FSC). When the temperature from the VAV is broadcast on the LON, it
is received by the FSC. Thus, the VAV controller shares the temperature reading from its temperature sensor with
the FSC without the need for any physical connection between the two devices.
VAV Controller
Flexible System Controller
Temp Sensor
Temp NVO
55°
95
75
55
Temp NVI
Binding
55°
Figure 1. Binding Between Nodes.
EDITING AND VIEWING BINDINGS
All Bindings for a node are accessed through the Binding Editor (Figure 2). The Binding Editor Window
consists of three smaller windows:
•
NV - The NV window (Figure 3) displays a scrollable list of all NVs available on the node.
•
Connects To - When an NV is selected from the NV Window, the Connects To Window (Figure 4)
displays the NV it is connected to, if the connection (binding) exists.
•
Binding Summary - The Binding Summary Window (Figure 5) displays a scrollable list of all the
bindings for the selected node.
Figure 2. Binding Editor Window
1-2
Rev 5.4
Figure 3. NV Window
Binding
Figure 4. Connects To Window
Figure 5. Binding Summary Window
REFRESH
Click
to receive the most current binding information from the network. You can also use this
feature to update changes you have made if MCLT fails to update the Binding Editor automatically.
To access the Binding Editor:
1.
Right click on the selected node. Select Edit/View Binding from the node pop-up menu (Figure 6).
2.
The Binding Editor Window opens.
1-3
Binding
Rev 5.4
Figure 6. Node Pop-Up Menu
ADDING A BIND
To add a new bind, there must be matching NVs available to connect to. The steps for adding a bind are:
1.
Right click on the selected node. Select Edit/View Binding from the node pop-up menu.
2.
The Binding Editor Window opens.
3.
Select the NV you wish to bind from, and click
.
NOTE: Only NVOs can be bound from, and only NVIs can be bound to.
4.
5.
The Bind To Editor Window (Figure 7) opens. The top of the window displays the name of the
NVO you are binding from (Figure 8).
The bottom window shows the matching NVs available (Figure 9). Select the NVI you wish to bind
to and click
to return to the Binding Editor Window. The new bind be displayed in the
appropriate windows
NOTE: When binding NVs, you must bind matching SNVTs. If no matching NVs exist, the task bar
at the bottom of the window gives an error message (Figure 10).
6.
Click
Figure 7. Bind To Editor
1-4
to close the Binding Editor Window.
Figure 8. Point Bound From
Rev 5.4
Figure 9. Available NVIs
Binding
Figure 10. Error Message Task Bar
DELETING A BIND
To delete an existing bind:
1.
Right click on the selected node. Select Edit/View Binding from the node pop-up menu.
2.
The Binding Editor Window opens. You can view the bindings listed in the Binding Summary
window to determine which NVs you will need to select.
3.
Select the NVO you wish to delete the bind from.
4.
The corresponding NVI will be displayed in the Bind To Window, and the
button will
be visible. Select the corresponding NVI (Figure 11).
NOTE: Not all binds can be deleted. If the
button is grayed out, then that bind can
not be deleted.
5.
Click
to delete the binding.
6.
You will be returned to the Binding Editor. The bind will no longer be displayed
7.
Click
to close the Binding Editor Window.
Figure 11. NVO And NVI Selected And Delete Button Visible
1-5
Binding
1-6
Rev 5.4
Chapter Two
Using CPL
z Creating CPL Blocks
z Creating CPL Pages
z Editing CPL Pages
z Printing CPL Pages
z Exporting CPL Pages to DXF Format
z Using the CPL Library
Using CPL
Rev 5.4
OVERVIEW
MCL Tool’s CPL (Control Programming Language) provides the User with the means to create and edit graphical programs. CPL programming allows the User to build a ‘picture’ of their desired control strategy. These
programs, called CPL Pages, can then be stored on the FSC (Flexible System Controller) or in the CPL Library.
The CPL Library is available for storing common programs for exporting, importing.
Using the MCL Tool CPL Editor, the User builds a ‘picture’ of their control strategy using graphical objects
called ‘CPL Blocks’. The User places these objects on a CPL Page, and then enters specific values and settings
for that block. The User defines the proper control flow by using lines to represent connections. The resulting
‘picture’ becomes a working program. A sample control block (Figure 1) is shown below in Edit mode. In the
Monitor mode, the program is enabled, and values would be display at the inputs/outputs of each block.
MCL Tool 5.2 introduced the ability to export CPL pages to a DXF (Drawing Interchange File) format. This
allows viewing and printing to a number of software packages. The printouts provide a hardcopy of your CPL
files.
Hot Deck Temperature Control Sample Program
Figure 1. Sample CPL Program
CPL PAGES SUBTREE
The CPL Pages subtree (Figure 2) is located within the FSC controller node. All CPL functions (except CPL
Library functions) are accessed through this subtree. When you select CPL Pages from the Physical Tree, the
CPL Page List panel opens to the right.
The CPL Page List panel (Figure 3) shows the status and index numbers of all CPL Pages residing on the node.
The Status indicates whether the page is enabled (currently running) or disabled. The Index number is the
internal number assigned to the page by MCLT.
Figure 2. CPL Pages Subtree
2-2
Section 4 - PROGRAMMING
Rev 5.4
Using CPL
Figure 3. CPL Page List
The CPL Pages subtree popup menu (Figure 4) has five commands:
•
Add – Allows the User to add new CPL pages. See Creating and Editing CPL Pages in this chapter
for more detail.
•
Refresh – Updates the CPL Pages subtree to agree with data on the LNS database.
•
Create Page From Library – Allows the User to add a CPL Page from the CPL Library to the CPL
Pages residing on the controller node.
Figure 4. CPL Pages Popup Menu
WORKING WITH INDIVIDUAL PAGES
To access the CPL Pages:
to open the desired FSC Controller node.
1.
From the Physical Tree, click
2.
To view the individual CPL Pages, click
on the CPL Pages subtree.
CPL PAGE MENU COMMANDS
Each CPL Page has a popup menu (Figure 5) with the following six commands:
•
Enable/Disable – Tells the FSC to begin running (Enable) or stop running (Disable) the page.
Note: If the CPL Page is already enabled, the popup menu will show Disable instead of Enable for
the command (Figure 6)
•
Rename – Opens the Rename Page (Figure 7). Enter the new name for your page in the text field,
and click
to apply.
•
Copy to Library – Opens the Copy Page to Library window (Figure 8). Select the file path for the
CPL Library you wish to save to, and enter a name for the new Library Page. Click
.
•
Copy to FSC - Allows you to copy the page to another FSC on the network. When you select this
command, the Copy Page to FSC window opens (Figure 9). Select the FSC to copy to, and click
•
Delete – Allows you to delete the selected CPL Page. When you select this command, a Warning
window (Figure 10) will prompt you. Click
to delete the page.
2-3
Using CPL
•
Export to DXF – Allows you to export the selected CPL Page to a DXF file. This opens the Export
to DXF window (Figure 10A). Select the file path you wish to save to, and enter a name for the new
DXF file. Click
.
Figure 5. CPL Page Popup Menu
Figure 6. Popup Menu For Enabled Point
Figure 7. Rename Page Window
Figure 8. Copy Page To Library Window
2-4
Rev 5.4
Figure 9. Copy Page To FSC Window
Rev 5.4
Figure 10. Delete Page Warning Box
Using CPL
Figure 10A. Export CPL Page to DXF Window
CPL BLOCKS
CPL Blocks are graphical representations of points and functions within a control system. The User can specify
values, settings, and connections for that block to implement the desired control strategy. Each CPL Block has a
pop-up menu (Figure 11) that is used to set or change parameters (Edit command) or delete the block from the
page (Delete command).
CPL Blocks make available a variety of functions to the User. They are also color-coded by block type for ease
of use (Figure 12).
Figure 11. Block Pop-up
12. Block Type Color Codes
2-5
Using CPL
Rev 5.4
BLOCK TYPES
There are eight basic block types, each listed below, with all possible selections for each category. Refer to
Table 1 at the end of this chapter for an overview of the blocks and their functions.
ARITHMETIC BLOCKS
Arithmetic blocks are used for mathematical operations.
Add (+)
Multiply (*)
Divide (/)
Negate
Modulus
Square Root
Subtract (-)
COMPARISON BLOCKS
Comparison blocks are used to compare values and select an output state in logical control sequences.
Equal - Analog
Less Equal
Equal - Digital
Less Than
Greater Equal
Not Equal - Analog
Greater Than
Not Equal - Digital
CONSTANT BLOCKS
Constant blocks are used where a constant value is needed.
Analog
Digital
FUNCTION BLOCKS
Function blocks are used to perform higher level calculations.
2-Position
Min/Max
Rolling Average
Accumulator
Min. On/Off
Runtime
Counter
One Shot
Schedule
Calculation
PID Loop
Select Hi/Lo/Avg
Dial Provider
Psychro
Sequencer
Enthalpy
Ramp
Startup
Error - Analog
Relay - Analog
Start/Stop
Error - Digital
Relay - Digital
Time Event
Lead/Lag
Reset
GLOBAL VARIABLE BLOCKS
Global variable blocks have input or output values taken from system devices operating in the field, and can be
used with multiple CPL pages.
Analog Input
Digital Input
Analog Output
Digital Output
LOGICAL BLOCKS
Logical blocks are used for creating logic control sequences.
AND
OR
NOT
XOR
2-6
Rev 5.4
Using CPL
POINT BLOCKS
Point blocks are actual field input or output values.
Input Analog
Multiple Digital Input
Point State
Input Digital
Output Analog
SNVT_state Input
Multiple Analog Input
Output Digital
SNVT_state Output
TIME BLOCKS
Time blocks are time related blocks.
Constant Time
Convert Time
Current Time
BLOCK COLORS
Block colors are used to differentiate block types (see Figure 12 on the previous page). The following list shows
what each block color will be:
Math Blocks -
Orange
Comparison Blocks Constant Blocks -
Pink
Yellow
Function Blocks -
Green
Global Variable Blocks - White
Logical Blocks -
Turquoise
Point Blocks -
Grey
Time Blocks -
Blue
CPL EDITOR
The CPL Editor (Figure 13) window is used to create and edit CPL Pages. The CPL Editor window consists of
the CPL Toolbar, the Zoom Control Box, the Block Menu, and the CPL Page. The
and
buttons are located below the CPL Page. The CPL editor opens each time a new or existing CPL
Page is selected.
All CPL Page creating and editing is done in the Selection Mode. You can also use the CPL Editor in Monitor
mode to view current activity on the node. See the CPL Editor section in this chapter for more information on
Modes.
NOTE: You can not add blocks while the CPL Editor is in Monitor Mode.
Figure 13. CPL Editor Window
2-7
Using CPL
Rev 5.4
CPL EDITOR TOOLBAR
The CPL Editor Toolbar (Figure 14) features seven buttons: Selection Mode, Zoom Mode (In), Zoom Mode
(Out), Best Fit, Show Grid, Monitor Mode, and Export CPL to DXF.
•
To activate a Toolbar button, place the mouse pointer on it and click.
•
To deactivate a Toolbar button, place the mouse pointer over it, and click.
Figure 14. CPL Editor Toolbar
SELECTION MODE
You must be in Selection Mode to add or delete blocks, and to make or delete connections.
•
To activate Selection Mode, click
from the Toolbar. The mouse pointer will be the arrow shape.
Note: You will remain in Selection Mode when using all other toolbar buttons EXCEPT Monitor
Mode.
ZOOM MODES
When a CPL page becomes large and filled with many blocks, viewing the page becomes increasingly difficult.
Use the Zoom Mode Toolbar buttons to zoom in and out on the page as needed. (You also have the option of
using the Zoom Control Box on the right side of the window. See the Zoom Control Box section in this chapter
for details.)
•
Click
to increase magnification, and
to decrease it. The mouse pointer will display as the
zoom magnifying glass icon.
•
Each click of the mouse doubles the amount of magnification (Zoom In or Zoom Out).
•
To return to the mouse pointer, click the
button located on the Toolbar next to the Zoom
Mode buttons.
BEST FIT
When you select the Best Fit mode, MCL Tool automatically resizes your CPL Page to optimal viewing size.
•
Click
to activate.
SHOW GRID
The Show Grid Toolbar button places a grid on your CPL Page. This grid helps you to place blocks on the CPL
Page in an orderly, easy-to-understand manner.
•
2-8
Click
to activate.
Rev 5.4
Using CPL
MONITOR MODE
Monitor Mode displays the current values of the block outputs of an enabled CPL Page. You can edit a CPL
Block while in Monitor Mode, but you cannot add or delete blocks, or change input connections.
Monitor Mode allows you to view the status of and/or command the value of a point. When the Monitor mode is
activated, a green Monitor light displays on the Toolbar (Figure 15).
1.
To activate Monitor Mode, click
. The green Monitor light displays on the Toolbar, and begins
to flash.
2.
The CPL Editor will display a Status Task Bar directly below the CPL Page (Figure 16). Verify that
the FSC is loaded, and that the page is loaded and enabled.
3.
The block outputs will initially display question marks (Figure 17) as MCL Tool polls the FSC. When
all the data has been received by MCL Tool, the current values will display (Figure 18).
Figure 15. Green Monitor Mode Light
Figure 17. Question Marks During Polling
4.
Figure 16. CPL Editor Status Task Bar
Figure 18. Output Values Displayed
If there is an error on your CPL Page or the Page is disabled, an Error message will display (Figure
19). Click
to deactivate it. MCL Tool automatically places you in Selection Mode so you can
troubleshoot your Page.
Figure 19. Error Messages Displayed
2-9
Using CPL
5.
Rev 5.4
Use the block popup menu Edit command (Figure 20) to make changes to the block’s settings. (See
Editing CPL Blocks in this chapter for more information). Click
to save the changes.
An Abort button will display below the Status Bar. If the Page becomes locked up, you can click
to escape.
Figure 20. Block Popup Menu Edit Command
6.
To deactivate Monitor Mode, you must click
again. You will be returned to Selection Mode.
Figure 20. Block Popup Menu Edit Command
STATUS/COMMAND POINT FUNCTION
While monitoring a CPL page, the Status/Command Point function allows you to adjust point values (command
the point), and then observe the immediate impact on the program. The Status/Command Point function is
available in all modes, but is specifically meant for use with system design and testing while in the Monitor
Mode.
To invoke the Status/Command Point function:
1.
Right click on the point CPL block to be commanded. Select Status/Command Point from the popup menu (Figure 21).
Figure 21. Status/Command Point Menu
2.
Figure 22. Status/Command Point Window
The Status/Command window opens (Figure 22). The Status/Command Window features five
command buttons:
Fix - Locks the value entered in the Command text field (Figure 23) until released by
the Release button. Point value is removed from automatic control.
Release - Releases the value from the Fix command, and returns the point value to
automatic control.
Set - Sets the point value as specified in the Command text field. Value can be overrode by automatic control.
Reset - Resets the priority level of the point back to zero, allowing the network to
transmit and receiver higher priority messages as needed (normal state).
2-10
Rev 5.4
Using CPL
Get Status - Gets the current status (value) of the point, and displays it in
the Status text field (Figure 24). When the button is selected, the LEDs turn green, indicating
that the field device is being polled.
Figure 23. Command Text Field
Figure 24. Status Text Field
The Point Status LED Panel (Figure 25) has three LEDs to indicate the state of the point:
• Point Fixed - Selected point is ”locked” to the entered value. Disables automatic control.
• Point in Hand Mode - Point is controlled by a manual “hand” switch on either the
4DO/4AO or 8DO I/O module. Disables automatic control.
• Point In Alarm - Selected point is in an alarm condition.
Figure 25. Point Status LED Panel
3.
Command the values for your point using the buttons explained in Step 2. View the current status of
the point by selecting the Get Status button.
4.
Select
to close the window when you are finished.
EXPORT CPL PAGE TO DXF
The Export CPL Page to DXF Toolbar button exports the current CPL Page to a DXF(Drawing Interchange File)
file format. This DXF file can then be viewed, edited, or printed using Visio®, AutoCAD®, VoloView®, and a
number of other programs.
•
Click
to activate.
ZOOM CONTROL BOX
In addition to the Zoom Mode Toolbar buttons, you can also use the Zoom Control Box (Figure 26) located on
the right side of the CPL Editor Window to adjust your view of a CPL Page.
•
Use your mouse pointer to drag the diamond-shaped drag handles towards (to zoom in) or away from
(to zoom out) the center of the control. The percent of the picture you are viewing is displayed at the
top of the Zoom Control Box.
Figure 26. Zoom Control Box
2-11
Using CPL
Rev 5.4
CPL BLOCK MENU
The CPL Block Menu (Figure 27) is located on the right side of the CPL Editor Window, directly beneath the
Zoom Control Box:
The CPL Block Menu has eight command bars, each corresponding to the eight CPL Block types (see CPL
Blocks at the beginning of this chapter). Each command bar is color-coded according to the block type it
represents.
Click on the command bar of the block type you wish to use. A scrollable drop-down menu (Figure 28) opens,
listing symbols for each of the available functions. Each of these symbols can be dragged to the open CPL Page.
Figure 27. CPL Block Menu
Figure 28. Drop-Down Menu
CREATING AND EDITING CPL PAGES
NOTE: You must be in Selection Mode to add or delete blocks, or make connections. It is best not
to enable your CPL Page until you have completely finished making changes.
TO ADD A NEW CPL PAGE:
1.
Click
to open the FSC node you wish to control with.
2.
Click
to open the CPL Pages subtree.
3.
Right click on the CPL Pages subtree, and select Add.
4.
The Add CPL Page window (Figure 29) opens. Enter the name of your new CPL Page in the text
field, and click
5.
The CPL Editor opens on the right, displaying that page.
6.
Use the CPL Editor to make needed changes, using methods described below in this section.
7.
To save your changes, click
CPL Page, click
2-12
.
. If you wish to return to the previous saved version of your
.
Rev 5.4
Using CPL
Figure 29. Add CPL Page Window
To open and edit an existing CPL Page:
1.
Click
to open the FSC node you wish to control with.
2.
Click
to open the CPL Pages subtree.
3.
Select the page from the list under CPL Pages subtree. The CPL Editor opens on the right, displaying
that page.
4.
Use the CPL Editor to make needed changes, using methods described below in this section.
5.
your CPL Page, click
. If you wish to return to the previous saved version of
.
ADDING CPL BLOCKS
To add CPL blocks to your page:
1.
Click on the command bar of the block type you want to open the scroll-down list.
2.
Click on the desired block, and move the cursor to the CPL Page.
3.
The point will turn into crosshairs. Click where you want the block to appear. The pointer will remain
as crosshairs, allowing you to enter as many of the same block as needed.
4.
To stop adding blocks, right click the pointer. It will return to the arrow shape.
6.
your CPL Page, click
. If you wish to return to the previous saved version of
.
EDITING CPL BLOCKS
Each CPL Block has an Edit window available from the popup menu Edit command (Figure 30) . The MCL
Tool CPL Editor also allows the User to edit, delete, and move multiple blocks at the same time.
NOTE: When editing CPL Point blocks, the pop-up menu will also feature a Status/Command function (Figure 31). Please see Monitor Mode - Command /Status Function in
this chapter for more information.
Through the CPL Block Edit window (Figure 32), the User can select settings and values for each block on the
page. Different blocks will have different settings required. Some blocks may not require any information
(Figure 33).
2-13
Using CPL
Rev 5.4
There are two ways to access the Edit Window:
1.
Double click on the block you wish to edit
OR:
1.
Right click on the block you wish to edit.
2.
Select Edit from the popup menu. The Edit Window will open.
3.
Enter values and settings from available options.
4.
Click
to accept.
5.
Click
to save changes.
Figure 30. Edit Command
Figure 32. CPL Block Edit Window
Figure 31. Status/Command Point Command
Figure 33. CPL Block Edit Window With No Options
EDITING MULTIPLE BLOCKS
To edit multiple blocks at the same time:
1.
Hold down the left mouse button, and use the mouse pointer to draw a box around the blocks you
wish to include.
NOTE: The sides of the box must not be touching any of the blocks.
2.
When you release the mouse button, a blue dashed line appears around the grouped blocks (Figure 34).
3.
Right click inside the group, and select Edit from the pop-up menu (Figure 35).
4.
The Edit windows for all the selected blocks open simultaneously.
5.
After you have made all changes and closed all the Edit windows, click
work.
2-14
to save your
Rev 5.4
Using CPL
To remove the grouping from a selected group of CPL blocks:
1.
Click the left mouse button anywhere in the Edit window.
Figure 34. Grouped CPL Blocks
Figure 35. Edit Menu Command
STATUS/COMMAND POINT MENU COMMAND
When the Status/Command Point menu option (Figure 31) is selected, the Status/Command window (Figure 36)
opens. You can enter a value for the block, view the current status of the point, and command the point to fix,
release, or reset the value. For more information on this command, please see the Status/Command Point
Function section in this chapter.
DIRECT/REVERSE ACTING
Direct acting blocks produce the output value directly as calculated, whereas reverse acting blocks produce the
exact opposite (the reverse) of the calculated value. For example, if a direct acting block outputs a true, then the
same block, set to reverse acting, would output false.
•
All blocks having the direct or reverse acting capabilities default to direct acting.
•
A check box is provided on the Settings page for reverse acting operation (Figure 37).
Figure 36. Status/Command Point Window
Figure 37. Reverse Acting Option Selected
2-15
Using CPL
Rev 5.4
DELETING A BLOCK
There are two ways to delete a block from your CPL Page:
1.
Select the block and press Delete on your keyboard
OR:
1.
Right click inside the block you wish to delete.
2.
Select Delete from the pull-down menu (Figure 38). The block will disappear.
Figure 38. Delete Option On CPL Block Popup Menu
3.
. If you decide to keep the block after all, click
to return to the previous saved version of your CPL Page.
DELETING MULTIPLE BLOCKS
To delete multiple blocks at the same time:
1.
wish to include.
2.
When you release the mouse button, a blue dashed line appears around the grouped blocks (Figure
39).
3.
Right click inside the group, and select Delete from the pop-up menu (Figure 40).
4.
All the grouped blocks are deleted. Click
to save your work.
1.
Figure 39. Grouped Blocks
2-16
Figure 40. Delete Command
Rev 5.4
Using CPL
MOVING A BLOCK
To move a CPL Block on the page:
1.
In Selection Mode, click on the block you want to move. A dotted blue line will appear around the
block (Figure 41) to indicate selection.
2.
Press and hold the left mouse button. Drag the block to the desired location. To deselect the block,
click your mouse again or select another block. The dotted blue lines will disappear.
3.
Figure 41. Selected CPL Block
.
Figure 42. Analog Connection
Figure 43. Digital Connection
MOVING MULTIPLE BLOCKS
To move multiple blocks at the same time:
1.
wish to include.
2.
When you release the mouse button, a blue dashed line appears around the grouped blocks (Figure
39, previous page).
3.
Hold down the left mouse button on the grouped blocks, and drag them to the new location on the
page.
4.
Release the mouse button, and click
to save your work.
1.
BLOCK CONNECTIONS
Block connection line types are selected for you automatically and are used as a simple method of displaying
analog or digital connections. There are two line types used to connect blocks. All analog connections are made
using a solid line (Figure 42), and all digital connections are made using a dashed line (Figure 43).
CONNECTING BLOCKS
To connect a CPL block to another block:
1.
Right-click the mouse pointer on the output tab of the first block.
2.
Select New Connection from the pop-up menu (Figure 44). A connection line appears from the output
tab to the mouse pointer
3.
Move the mouse pointer to the input tab of the block you are connecting to and click to complete the
connection. If the connection you are attempting to make is not allowed by MCL Tool, you will be
unable to complete the connection and the Prohibited symbol appears (Figure 45).
4.
Click
to save your changes.
2-17
Using CPL
Figure 44. New Connection
Rev 5.4
Figure 45. Prohibited Symbol
MULTIPLE INPUTS
Some of the CPL Blocks allow up to 15 inputs. An Add block (Figure 46) with 12 inputs is shown below:
•
When you first select a multiple input block, it will display with only two input tabs. As you complete a block connection for an input, one additional input tab is automatically added to the block.
•
This will repeat until the maximum number of inputs for the block are used.
Figure 46. Add Block With A Total of 12 Inputs
DELETING A BLOCK CONNECTION
If you want to delete a block connection:
1.
You can disconnect a block connection using the popup menu from either the output of the block you
are connecting from (Figure 47) or the input of the block you are connecting to (Figure 48).
2.
Select Delete Connection from the pop-up menu.
3.
Click
to save your changes.
Figure 47. Delete Connection From Output
2-18
Figure 48. Delete Connection From Input.
Rev 5.4
Using CPL
CPL USER LIBRARY
The CPL Library is a repository for your CPL pages. This library allows you to:
•
Store CPL programs for use with multiple nodes. The user need only edit specific block values for
each node.
•
Import CPL programs from other MCL Tool applications into the CPL Library.
•
Create and store new CPL programs.
•
Edit CPL programs stored in the CPL Library.
The MCL Tool installation includes pre-programmed CPL Library pages for the User convenience. The pages
cover a variety of standard control system functions, and can be used “as is”, or modified as needed. The pages
are stored in a default directory on the same drive as MCL Tool (Figure 49).
The default file path is: (Drive):\NexSys2\CPL\EsusaLib\...
Figure 49. Directory Of Stored CPL Library Pages
CPL LIBRARY WINDOW
The CPL Library Window (Figure 50) consists of two sub-windows: the Library Pages Window on the left, and
the CPL Block Editor on the right. You can create or edit CPL Library Pages in the CPL Block Editor in the
same manner as when using the CPL Editor in the CPL Pages subtree, except that there is no Monitor Mode
available for the CPL Library. See the CPL Editor in this chapter for information.
Figure 50. CPL Library Window
2-19
Using CPL
Rev 5.4
ACCESSING THE CPL LIBRARY FROM MCLT
To access the CPL Library from the MCLT Main Window:
1.
From the Menu Bar, click MCLT > CPL Library (Figure 51) OR:
2.
Click the Open The Local CPL Library button
on the Toolbar.
CLOSING THE CPL LIBRARY
To close the CPL Library:
1.
Right click on the Title Bar and select Close (Figure 52) OR:
2.
Click the
button on the Title Bar (Figure 53).
Figure 51. Open From Menu Bar
Figure 52. Closing the CPL Library With Title Bar Menu
Figure 53. Title Bar Close Button
LIBRARY PAGES WINDOW
The Library Pages Window (Figure 54) is a scrollable listing of all your CPL Library pages. You can export
these pages to the FSC node, or save them to disk.
To select a page from the Library Pages list:
1.
2.
3.
Use the mouse pointer to select the desired page. Use the scroll bar on the right side as needed to
view the entire list.
To view the complete page name, resize the window horizontally, using the mouse pointer to enlarge
as needed.
Click on the desired page. The page will open in the CPL Block Editor window.
Figure 54. Library Pages Window
2-20
Rev 5.4
Using CPL
LIBRARY PAGES TOOLBAR
Three buttons are available on the Library Pages Toolbar (Figure 55):
Figure 55. CPL Library Toolbar
Create New Library Page - Creates a new page (see Importing a CPL Library Page below).
Import Existing Library Page – Opens up the Open window (Figure 57), allowing you to select a
page from another node or database and save it in the CPL Library.
Remove Library Page – Removes the selected Library Page from the Library Pages
window. The Library Page file is not erased from the hard drive.
NOTE: If you delete a CPL page, and then wish to place it back in the Library Pages window,
click
and re-import the page.
CPL LIBRARY BLOCK EDITOR WINDOW
Use the CPL Block Editor to create or change the page you’ve selected from the Library Pages window. You can
create or edit CPL Library Pages in the CPL Block Editor in the same manner as when using the CPL Editor in
the CPL Pages subtree, except that there is no Monitor Mode available for the CPL Library.
For complete instruction on creating and editing CPL Pages, see the section CPL Editor in this chapter.
CREATING A NEW CPL LIBRARY PAGE
To create a new CPL page:
1.
Click the
2.
An Open dialog box (Figure 56) prompts you for the filename and directory you want it saved in.
Click
3.
located on the Tool Bar.
to save the new page.
The page is added to the Library Pages listing. Click on the filename in the Library Pages window.
The new page will open in the CPL Block Editor window. You can now add blocks and create your
page.
Figure 56. Creating A New CPL Library Page
2-21
Using CPL
Rev 5.4
IMPORTING AN EXISTING CPL LIBRARY PAGE
You can import existing CPL pages from other directories, from a floppy disk, or CD-ROM:
button located on the Tool Bar.
1.
Click on the
2.
An Open dialog box (Figure 57) prompts you for the filename and directory you want to select.
Select the file you wish to import and click
.
Figure 57. Importing An Existing CPL Library Page
3.
The page is added to the Library Pages listing. Click on the filename in the Library Pages window.
The page will open in the CPL Block Editor window. You can now edit your page as needed.
EXPORTING A CPL LIBRARY PAGE TO A DXF FILE
CPL Library pages can be exported to a DXF(Drawing Interchange File) file format. Programs such as Visio®,
AutoCAD®, or VoloView® can then be used to view, edit, and print these DXF files. Printed files can be used as
a hardcopy backup method for CPL pages.
To export a CPL Library Page to a DXF file:
1.
With the CPL page open, click on the
Page to DXF window (Figure 58). Use the
2.
Click
button to browse to the desired directory.
to save the DXF file.
Figure 58 Export CPL Pageto DXF Screen
2-22
button in the CPL Editor Toolbar to display the Export CPL
Rev 5.4
Using CPL
SUMMARY OF BLOCKS
The following tables give a brief overview of all the CPL Blocks with descriptions.
MCL Tool CPL Blocks
Block Type
Arithmetic
Color
Yellow
Comparison
Pink
Constants
Yellow
Functions
Green
Block Title
Description
Title
Add (+)
Add
Divide (/)
Divide
Multiply (*)
Multiply
Modulus
Modulus
Negate
Negate
Square Root
Sq. Root
Subtract (-)
Subtract
A-Equal
D-Equal
Greater Equal
Greater Than
Less Equal
Less Than
A-Not Equal
Description
Adds the values of up to 15 inputs
Divides the dividend by the divisor
Multiplies the values of up to 15 inputs
Divides the dividend by the divisor and outputs the remainder
Multiplies the input by (-1)
Outputs the square root of the input value
Subtracts the second input (the subtrahend) from the first input value and
outputs the difference
Outputs a True if the two analog inputs are equal
Outputs a True if the two digital inputs are equal
Outputs a True if the first input is greater than or equal to the second input
Outputs a True if the first input is greater than the second input
Outputs a True if the first input is less than or equal to the second input
Outputs a True if the first input is less than the second input
Outputs a True only if the two analog inputs are not equal
D-Not Equal
Outputs a True only if the two digital inputs are not equal
A-Constant
D-Constant
2 Pos.
Outputs a constant analog value that you enter after placing the block
Outputs a constant digital value that you enter after placing the block
Uses two inputs: an input value and a setpoint. Outputs a True if the input
value is greater than the setpoint
Samples the input at a user-defined interval and adds it to the previous
sample for the output
Multi-function block for complex mathematical or logical formulas
Counts the number of times the input goes high
When the input is high, the controller may dial out; when the input is low,
dial out capability is inhibited
Calculates enthalpy using dry bulb as Input 1 and either relative humidity,
dew point, or wet bulb as Input 2
Selects a second, alternate analog input if the first analog input is in error
Selects a second, alternate digital input if the first digital input is in error
Controls staged heating or cooling based on the runtime of the HVAC units
Monitors the input for either a minimum or maximum value to output
Maintains a minimum On and/or Off time for the output
Equal - Analog
Equal - Digital
Greater Equal
Greater Than
Less Equal
Less Than
Not Equal Analog
Not Equal Digital
Analog Constant
Digital Constant
2-Position
Accumulator
Accum.
Calculation
Counter
Dial Provider
Calculation
Counter
Dial Provider
Enthalpy
Enthalpy
Error - Analog
Error - Digital
Lead/Lag
Min/Max
Minimum On/Off
A-Error
D-Error
Lead/Lag
Min/Max
Min. On/Off
One Shot
1 Shot
Outputs a pulse of a user-defined duration following a trigger. You select
whether the output follows a Make or Break trigger, and define the retrigger
action (Useful for lag time delays)
PID Loop
PID
Psychro
Psychro.
Ramp
Relay - Analog
Relay - Digital
Reset
Rolling Average
Runtime
Ramp
A-Relay
D-Relay
Reset
Roll Avg.
Runtime
Performs Proportional-Integral-Derivative control based upon the Input,
Setpoint, and Enable inputs and control values entered by the user
Calculates relative humidity, dew point, wet bulb, or enthalpy based upon
the wet bulb temperature input and either the relative humidity, dew point,
or wet bulb
Limits the amount an input can increase or decrease in a given time period
Uses a digital input to select between two analog inputs
Uses a digital input to select between two digital inputs
Produces a scaled and offset output based on the selected input
Averages a user-defined number of samples from the input
Monitors the input for a high signal and outputs the total time the input is
high
Table 1. CPL Block Information (continued on next page)
2-23
Using CPL
Rev 5.4
MCL Tool CPL Blocks
Block Type
Color
Function (cont.) Green
Global Variables White
Block Title
Description
Title
Schedule
Schedule
Select Hi/Lo/Avg
Sequencer
Hi/Lo/Avg
Sequencer
Startup
Start/Stop
Time Event
Start
Start/Stop
Time Event
Analog Input
GAI
Logical
Analog Output
Digital Input
Digital Output
Turquoise AND
OR
NOT
XOR
GAO
GDI
GDO
And
Or
Not
Xor
Points
Grey
AI
DI
AO
DO
MAI
Input - Analog
Input - Digital
Output - Analog
Output - Digital
Multiple Digital Input MDI
Time
Blue
Allows a number of digital points to be bound together. The output can be selected as the
number or percent of inputs in a specified state.
Point State
Pt. State
Provides a means of examining information about a selected point
SNVT State Input
SNVT_State Input
Outputs a discrete value corresponding to the value of a selected bit number.
SNVT State Output
SNVT_State Output Indicates which of the 16 bits to which the input value will be transferred to the actual point.
Constant
Convert
Current
Constant Time
Convert Time
Current Time
Table 1. CPL Block Information
2-24
Description
Used to set up a temporary schedule, including settings for optimum start and stop,
heat/cool mode, and the temporary schedule to be called based on the inputs
Selects the highest, lowest, or the average of up to 15 inputs
Controls up to 15 outputs based on a deadband, an interstage delay, and a control signal
crossing defined setpoints
When a CPL page is started, this block outputs a True for one cycle of the page
Provides a simple schedule, with one start and stop time for selected days of the week
Upon detecting a user-defined time event, this block outputs a True for one cycle of the
CPL page
Global variables are used to share data among CPL pages on a single panel. This block
must be assigned to the index number of a Global Analog Output
Allows an analog value to be shared with other CPL pages
Must be assigned to the index number of a Global Digital Output
Allows a digital value to be shared with other CPL pages
Accepts up to 15 inputs and outputs a logical AND
Accepts up to 15 inputs and outputs a logical OR
Outputs a logical NOT of the input
Accepts up to 15 inputs and outputs a logical XOR (True only if an odd number of inputs is
True)
Used to select an analog input point from a drop-down list
Used to select a digital input point from a drop-down list
Used to define an analog point's value using a drop-down list
Used to define a digital point's value using a drop-down list
Allows a number of analog points to be bound together. The output can be selected as the
lowest, highest, or average of all the inputs or the number or percent of inputs above or
below a selected value.
Outputs a single time value entered by the user
Converts the input value in minutes to an output value in seconds, minutes, hours, or days
Outputs the current number of seconds since midnight
Chapter Three
CPL Blocks
z Constant Blocks
z Function Blocks
z Global Variable Blocks
z Logical Blocks
z Math Blocks
z Point Blocks
z Time Blocks
CPL Blocks
Rev 5.4
CPL BLOCKS
All CPL Blocks are accessed from the CPL Block Menu located on the right side of the CPL Editor (Figure 1).
The CPL Block Menu has eight types of block types (Figure 2), each with its own scrollable drop-down list. The
User uses the mouse pointer to click and drag blocks from the CPL Block Menu to the CPL Page. For information on using the CPL Editor, see Section Four, Programming - Chapter Two.
Connections made to the inputs and outputs of the selected block can be made before or after settings are
defined. For information on connecting CPL Blocks, see Section Four, Programming - Chapter Two.
Figure 1. The CPL Editor
Figure 2. The Eight CPL Block Types
NOTE: Both inputs and outputs are referred to as High and Low.
A High input can also be referred to as: Logical 1 or True.
A Low input can also be referred to as: Logical 0 or False.
CPL BLOCK SETTINGS
Each CPL Block has a Setting Window that is used to enter values specific to that block. Figure 3 shows the
Settings window for the Analog Relay block.
To enter settings for a selected block:
1.
Right click on the selected block. Select Edit from the pop-up menu (Figure 4).
2.
Enter any values required into the appropriate text fields. Click
to save settings.
NOTE: Not all CPL Blocks require settings information. If no settings information is required,
the edit window will contain only the message No Setting Info (Figure 5).
3-2
Rev 5.4
Figure 3. Analog Relay Setting Window
CPL Blocks
Figure 4. Edit Command On Block Pop-up Menu
Figure 5. No Setting Info. Setting Window
Figure 6. Ignore Error Checkbox
IGNORE ERROR CHECK BOX
When the Ignore Error box is checked (Figure 6), the CPL Block will continue to operate as long as there is
one valid input. If the output is required to be an Average, the block will output the average of the valid inputs,
and ignore the inputs in error. If the Ignore Error option is not selected, the block will cease operating when it
receives an error message from any of its inputs.
ENTERING BLOCK INFORMATION - CONSTANTS
The Constants drop-down menu (Figure 7) allows the User to choose Analog and Digital Constant blocks.
Figure 7. Constants Drop Down Menu
3-3
CPL Blocks
Rev 5.4
ANALOG CONSTANT
The Analog Constant block (Figure 8) outputs a constant analog value that you enter after placing the block.
There are no inputs required for this block.
A-Constant
0.000
User selected value
Figure 8. Analog Constant Block.
Figure 9. Analog Constant Settings Page
SETTINGS
On the Settings page (Figure 9), enter the value for the Analog Constant.
DIGITAL CONSTANT
The Digital Constant block (Figure 10) outputs a constant digital value that you enter after placing the block.
There are no inputs required for this block.
D-Constant
0
User selected value
Figure 10. Digital Constant Block
SETTINGS
On the Settings page (Figure 11), enter data:
1.
Choose a SNVT type from the drop-down list.
2.
If necessary, select an engineering unit.
3.
Select the desired state from the Value field.
NOTE: Refer to Table 1 in Section Six, Appendices - Appendix A for a complete listing of
available SNVT types.
NOTE: If the Snvt Type selected is No Snvt, select a value between 0 and 255 for the Value field
(Figure 12).
3-4
Rev 5.4
Figure 11. Digital Constant Settings Page
CPL Blocks
Figure 12. No Snvt Type Selected
ENTERING BLOCK INFORMATION - FUNCTIONS
The Functions drop-down menu (Figure 13) is shown as it will appear on the CPL Block Menu. Use the arrows
at the top and bottom of the menu to view all available functions. A Function is a predefined mathematical
operation used to perform higher level calculations for control systems.
Many of the Function blocks use identical settings windows. Two of the most commonly used windows are the
Timing Window (Figure 14) and the Descriptor Window (Figure 15).
The Timing Window prompts for two values:
1.
The desired interval (value of time that an action waits and then repeats) in hours, minutes,
and seconds.
2.
The desired offset of the interval in hours, minutes, and seconds.
Note: All CPL Function Blocks are referenced to 2400 hours 00 seconds of the current day.
The Descriptor Window requires a descriptive name for the block that allows the User to easily
identify it. A maximum of 32 characters is allowed. This descriptor will display above the block, and
also moves with it around the CPL Page.
Click on tab of the settings page desired to bring it to the foreground.
Figure 13. Functions Menu
Figure 14. Timing Window
3-5
CPL Blocks
Rev 5.4
Figure 15. Descriptor Window
2-POSITION
The 2-Position block (Figure 16) uses two inputs, with Input 1 being a connected input and Input 2 being the
setpoint value. A True will be outputted if Input 1 is greater than the setpoint value.
2 Pos. (DA)
Input
Setpoint
Figure 16. 2-Position Block
Figure 17. 2-Position Settings Window
SETTINGS
On the Settings page (Figure 17) you must enter the deadband value. The default setting for a 2-Position block
is direct acting.
The settings consist of:
3-6
1.
Enter the Deadband value.
2.
To set the output as Reverse Acting, click the Reverse Acting box.
Rev 5.4
CPL Blocks
ACCUMULATOR
The Accumulator block (Figure 18) samples the input for the designated interval and outputs the value of that
sampling. Each time the interval is repeated, the value of the current sample is added to the previous values for
an accumulative output (Output = Previous sample +current sample).
The optional Reset input resets the output to zero, and the accumulation process begins again at the next
interval.
Accum.
Input
Reset
Figure 18. Accumulator Block
SETTINGS
The settings consist of
1.
Enter the sampling Interval and Offset values in the standard Timing Window.
CALCULATION
The Calculation block (Figure 19) calculates User-defined complex mathematical or logical operations in a
single block, reducing the size of the CPL Page. The User can define a sequence of calculations that will provide
a specific output value. Up to 15 universal inputs is allowed as variables, and the output may be selected as
analog or digital.
Note:
Once the output is chosen and the block is connected, however, the type of output
may NOT be changed unless the connection is first broken.
The Calculation Block has two settings windows, the CPLCalcBlockEditor (Figure 20) is used to create
formulas, and the Descriptor Window is used to name the block.
Calculation
Input 1
Input 2
Figure 19. Calculation Block
Figure 20. CPLCalcBlockEditor Window
3-7
CPL Blocks
Rev 5.4
SETTINGS
The CPLCalcBlockEditor Window consists of four text fields. The large field at the top of the page is used to
enter the desired formulas for the block. The three fields at the bottom are Variables, Constants, and Operations:
•
Variables - Variables include V1-V15, and Output. Variables V1-V15 correspond to inputs 1-15.
•
Values are used in comparison equations. Values include Year, Month, Day, Hour, Minute, True,
False, and other common control system considerations.
•
Operations are the mathematical and logical to be made on the variables and constants. Operations
include a comprehensive list of Boolean (AND, OR, NOT, etc.), comparative (Greater Than, Less
Than, Equal, etc.), and mathematical operations (Addition, Subtraction, Square Root, etc.).
To enter values in the CPLCalcBlockEditor:
1.
Use the Output radio button (Figure 21) located above the text fields to select the output type.
2.
The text field in the upper portion of the page is used for entering the equation information. Three
ways are available to enter the equation:
1. Place the cursor in the text field and type the formula in. This way is not recommended due to
the possibility of typing errors.
2. Double click on items in the text fields at the bottom of the window to select and enter the
information.
3. Select the value with your mouse pointer, and press Enter on your keyboard.
Note: If your equation has an error, an error message is generated in the center of the page
to pinpoint the problem. The error will be high-
(Figure 22). Click
lighted in the text field.
4. Click
to save the information. If an error exists in the formula, the program dis-
plays a Invalid Data message (Figure 23). You will not be allowed to close the window until
the error is corrected.
3.
Click on the Descriptor Window tab to bring it to the foreground. Enter a descriptive name for the
block, and click
.
Figure 21. Error Message Displayed With Error Highlighted
Figure 22. Error Message Displayed With Error Highlighted
3-8
Rev 5.4
CPL Blocks
Figure 23. Invalid Data Message For Calculation Block
COUNTER
The Counter block (Figure 24) counts the number of times the Input goes high, and outputs that number. If the
Reset input goes high, the count is reset to zero, and begins again. The reset input must be connected to a digital
source.
SETTINGS
No setting information is required.
Counter
Input
Reset
Figure 24. Counter Block
DIAL PROVIDER
The Dial Provider block (Figure 25) allows networks using CTI Dial-Up NCBs (Network Combiner Modules) to
communicate with remote NCBs. When the Enable input goes high, the associated NCB dials the telephone
number of the target NCB previously configured in the Software Installation procedure. Please see Section
Two,Installation and Startup, Chapter One for more information.
SETTINGS
Dial Provider
Enable
Figure 25. Dial Provider Block
3-9
CPL Blocks
Rev 5.4
ENTHALPY
This block (Figure 26) will calculate Enthalpy. The Dry Bulb Temperature is a required input. You can select
from one of the following for the second input: RH, Dew Point or Wet Bulb as Input 2.
Enthalpy
Dry Bulb Temp.
Input
Figure 26. Enthalpy Block
Figure 27. Enthalpy Setting Window
SETTINGS
On the Settings page (Figure 27) :
1.
2.
Select one of the following Input Types:
•
Relative Humidity
•
Dew Point
•
Wet Bulb.
Select the Mode for the output as either
•
English
•
Metric
ERROR - ANALOG (A-ERROR)
The Analog Error block (Figure 28) will select the Alternate Input if the first analog Input is in error. Functioning as a switch, this block allows the current operation to shift inputs and continue running, rather than shutting
down due to problems with the first input.
A-Error
Input
Alternate Input
Figure 28. Analog Error Block
SETTINGS
3-10
Rev 5.4
CPL Blocks
ERROR - DIGITAL (D-ERROR)
The Digital Error block (Figure 26) will select the Alternate Input if the first digital Input is in error. Functioning as a switch, this block allows the current operation to shift inputs and continue running, rather than shutting
down due to problems with the first input.
D-Error
Input
Alternate Input
Figure 29. Digital Error Block
SETTINGS
HI/LO/AVERAGE
The Hi/Lo/Average Block (Figure 30) will output the highest, lowest, or average value of up to 15 inputs,
depending on the function selected from the Setting Window. The current selected function is displayed in
parentheses next to the title of the block.
Hi/Lo/Avg. (L)
Input 1
Input 2
Figure 30. Hi/Lo/Avg. Block
Figure 31. Hi/Lo/Avg. Block Setting Window
SETTINGS
1.
The Settings page (Figure 31) allows you to select between one three functions that determines the
value of the output:
Low - Outputs the lowest value of all the inputs.
High - Outputs the highest value of all the inputs.
Average - Calculates and then outputs the average value of all the outputs.
2.
Select the Ignore Error checkbox to have the block ignore any input errors.
3-11
CPL Blocks
Rev 5.4
LEAD/LAG
The Lead/Lag Block (Figure 32) monitors the runtimes of grouped HVAC equipment and equalizes the runtimes
of each machine. The block output acts as a switch to turn each piece of equipment on and off according to the
amount of usage. This block prevents excessive wear and tear on any one machine. It also allows the User to set
an Interstage Delay time, preventing multiple pieces of equipment from powering up at the same time and
causing excessive power drain.
The Lead/Lag Blocks supports up to 12 outputs. It accepts up to 12 Runtime inputs. The Lead/Lag block
requires 3 inputs in additional to the Runtime inputs of the equipment. These are:
Control - This value is compared to the setpoints of the Control Points, and activates the outputs
according to the Setpoint and Deadband values selected on the Setting Window.
Enable - When high, allows the Block to begin operating.
Set Sequence - This input is used to lock in the current control time for a specified interval. The
control sequence remains locked in while the Set Sequence input remains high, and then
resets.
Lead/Lag
Control
Enable
Set Seq.
Runtime 1
Runtime 2
Figure 32. Lead/Lag Block
Figure 33. Lead/Lag Setting Window
SETTINGS
The Lead/Lag Block contains both the Settings Window (Figure 33) and the Descriptor Window. On the Settings
Window text fields, you can type in the values requested, or use the spin boxes to select a value.
1.
Enter a number in the Number of Control Points field. This value determines the number of
setpoints the block recognizes, and also the number of outputs available.
2.
Enter a Deadband value. If the value of the control signal reaches the setpoint + or - the half the
deadband, the associated output point will change state. The state of the output depends on:
•
If the block has been defined as direct (default value) or reverse acting (see Step 4 below)
•
Whether the control signal value is rising or falling.
The output state does not change while the value of the control signal remains in the deadband zone.
3-12
3.
The Interstage Delay interval is the time after a output is initialized that the Block waits before
initializing the next output, preventing excessive power drainage.
4.
The Reverse Acting option causes the output points to energize as the control signal decreases
below the setpoint value. The outputs will deactivate as the control signal rises about the setpoint
value. This is the opposite action of the Direct Acting default setting.
5.
The Control Lowest First option causes the output with the lowest runtime to run first. The default
value is that the output with the highest runtime starts first.
Rev 5.4
CPL Blocks
6.
The Ignore Runtime Errors option allows the block to use the last valid runtime inputs if a runtime
input is in error, preventing the entire operation from being halted because of one input error.
7.
The Off Condition menu allows you to select the criteria for how the equipment will be turned off
once the control point value crosses the setpoint:
Runtime - The output with the longest runtime will turn off first.
First On/First Off - The first output to be turned on will be the first output to be turned off.
Last On/First Off - The last output to be turned on will be the first output to be turned off.
8.
Enter the Setpoint value for each output. The Setpoint number corresponds to both the Runtime input
and the output numbers. The number of Setpoints is equal to the number of Control Points.
9.
Click on the tab for the Descriptor Window and enter a easily identifiable descriptive name for your
block. Click
.
MIN/MAX
The Min/Max block (Figure 34) will output either the Minimum or Maximum value of the input, depending on
which output is selected on the Setting Window. The default output is Minimum. The block displays in parentheses next to its title which option is currently selected.
The block outputs the minimum/maximum value until the input drops below/exceeds its current output. It then
outputs the new value. The second input is used to Reset the output value to the current input value.
Min/Max (Min)
Input
Reset
Figure 34. Min/Max Block
Figure 35. Min/Max Setting Window
SETTINGS
On the Settings page (Figure 35), select Minimum or Maximum. Click
.
3-13
CPL Blocks
Rev 5.4
MINIMUM ON/OFF
The Minimum On/Off Block (Figure 36) output matches the input, but with a timing delay. It will hold the output
high (On) or low (Off) for a specified interval before changing to reflect input changes. The values (On/Off)
and the interval times are selected in the Setting Window (Figure 37). You can select both the Minimum On and
the Minimum Off functions.
The timing chart below (Figure 38) show a Minimum On input where the minimum On time has been set to 4
seconds. The output forces a minimum 4-second On time value before resetting. This action repeats each time
the input triggers On.
Min. On/Off
Input
Figure 36. Minimum On/Off Block
Figure 37. Minimum On/Off Block Setting Window
0utput
Input
Time
Min. ON Time
Figure 38. Minimum On Timing Chart
SETTINGS
On the Settings page (Figure 37), select the following:
3-14
1.
For Minimum On, select the Minimum On checkbox and enter the interval values.
2.
For Minimum Off, select the Minimum Off checkbox and enter the interval values.
Rev 5.4
CPL Blocks
ONE SHOT
The One Shot block (Figure 39) forces the length (duration) of the output pulse to be a specified value. You
have the option of starting the pulse on either the Make (rising edge) or the Break (falling edge) of the input
pulse. The chart below (Figure 40) shows a typical input pulse and the resulting output pulse with a 2 second
pulse length specified.
Break
Make
Input
Time
1 Shot (B)
Trigger
One
Shot
2 sec.
w/o reset duration on trigger
Figure 39. One Shot Block
Figure 40. One Shot Chart Without Reset Duration On Trigger
You can additionally select a Retrigger Action of the input pulse. The Retrigger function will allow the output
to ignore, reset to, or cancels the output in response to changes in the input occurring during the length of the
output pulse. The second chart (Figure 41) shows a typical input pulse and the resulting output pulse with a 5
second pulse length specified, and a Retrigger Action of Reset Duration. The circled areas show where a reset
occurs due to a make/break in the input pulse before the 5 second one shot interval has expired:
1.
On Make - The Reset Duration On Make Trigger restarts the 5 second timer as the input signal goes
high again. Since the second high occurred with only 4 out of 5 seconds completed, the output pulse
resets for another 5 seconds interval. The total output pulse length is 9 seconds.
2.
On Break - The Reset Duration On Break Trigger restarts the 5 second timer as the input signal
goes low again. Since the break occurred with only 3 out of 5 seconds completed, the output pulse
resets for another 5 seconds interval. The total output pulse length is 8 seconds (not shown).
Break
Make
Input
Time
One Shot
5 sec.
w/ reset duration on trigger
reset occurs here
Figure 41. One Shot Chart With Reset Duration
Figure 42. One Shot Setting Window
SETTINGS
On the Settings page (Figure 42) you select:
1.
One Shot On triggering on either Make (rising edge) or Break (falling edge) of the input pulse.
2.
The Retrigger Action has three options:
Ignore - Ignores changes in the input pulse and there is no retrigger action taken.
Reset Duration - Resets the output pulse on the trigger edge of the input pulse and begins the
duration interval over again.
Cancel Output - Cancels the output pulse on the trigger edge of the input pulse.
3.
Enter the desired Duration of the output pulse.
3-15
CPL Blocks
Rev 5.4
PID LOOP
The PID (Proportional Integral Derivative) Loop Block (Figure 43) will calculate and output a PID Loop value
based on the User-defined three inputs and parameters selected for calculation purposes. The inputs required are:
Input -
This first input is used a control value, against which the Setpoint is compared and PID Loop
calculations are made.
Setpoint -
This input is used as the Setpoint value for PID Loop calculations.
Enable -
This input allows the PID Loop function to begin operating.
PID (DA)
Input
Setpoint
Enable
Figure 43. PID Loop Block
Figure 44. PID Loop Setting Window
SETTINGS
On the Setting Window (Figure 44), enter the following values:
1.
Enter the values for Proportional (Prop), Integral (Integ), and Derivative (Deriv).
2.
Enter the Disabled Output Value. This is the output of the PID when the Enable input goes to
False.
3.
Enter the Minimum Output and the Maximum Output values for the connected device. These are
the range limits for the output.
4.
Enter the Output Offset value that is added to the calculated output of the PID.
5.
Click the check box if the output is to be Reverse Acting.
TIMING
Click on the tab of the Timing Window to bring it to the foreground. In this window you enter the Interval and
Offset values.
•
Intervals are based on a repeating 12-hour period and say when the PID Loop will execute.
•
The Offset is the time after midnight (2400 hours) or noon (1200 hours) that the Interval will start.
1. Enter the Interval and Offset values and click
3-16
.
Rev 5.4
CPL Blocks
PSYCHRO
The Psychro block (Figure 48) is used for calculating the relative humidity, dew point, wet bulb, or enthalpy of
the controlled area. This block has the following features:
•
The Dry Bulb Temperature is the first input. The User selects the second input type (Relative
Humidity, Dew Point, or Wet Bulb).
•
The User also selects the output type (Relative Humidity, Dew Point, Wet Bulb, Enthalpy).
•
The User selects the Mode of measurement (English, Metric).
Psychro.
Dry Bulb Temp.
Input
Figure 45. Psychro Block
Figure 46. Setting Window for Psychro Block
SETTINGS
On the Setting Window (Figure 46), the User:
1.
Selects an Input Type.
2.
Selects an Output Type.
3.
Selects the Mode of Measurement (Engineering Units).
RAMP
The Ramp block (Figure 47) limits the amount an output can change in a specified interval. This block acts as a
filter, smoothing out rapid increases and decreases in output levels, thereby preventing damage to field equipment. The User selects the ramp speeds, the sampling Interval rate, and any offset required. The User can select
values for both increases and decreases in output if desired.
Ramp
Input
Figure 47. Ramp Block
Figure 48. Setting Window
3-17
CPL Blocks
Rev 5.4
SETTINGS
On the Setting Window (Figure 48), the User enters values for the desired ramps. On the Timing Window, enter
values for the sampling Interval rate and an Offset value, if needed.
1.
For Ramping Up, click the Ramp Up check box and enter the increment rate in minutes.
2.
For Ramping Down, click the Ramp Down check box and enter the decrement rate in minutes.
NOTE: You can enter values for both ramps if desired.
TIMING
The Interval value indicates how often the block’s out is updated. The Offset will stagger the Interval start time.
1.
Enter the Interval sampling rate desired.
2.
Enter the Offset value desired.
RELAY - ANALOG
The Analog Relay block (Figure 49) acts as a relay switch for analog inputs. The state of the Select input
determines whether the output is a 0 (Input - False) or a 1 (Input - True). The User can select a delay in how
fast the output reflects changes in the input.
A-Relay
Input - False
Select
Input - True
Figure 49. Analog Relay Block
Figure 50. Analog Relay Setting Window
SETTINGS
On the Settings page (Figure 50):
1.
3-18
Select a delay type and enter the value of the delay:
•
The Delay on Make will cause a delay in the output when the input is True.
•
The Delay on Break will cause a delay in the output when the input is False.
Rev 5.4
CPL Blocks
RELAY - DIGITAL
The Digital Relay block (Figure 51) acts as a relay switch for digital inputs. The state of the Select input
determines whether the output reflects the value of the False Input (Input - False) or of the True Input (Input True). The User can select a delay in how fast the output reflects changes in the Select input.
NOTE: Echelon digital values can be in the range of 0-255.
D-Relay
Input - False
Select
Input - True
Figure 51. Digital Relay Block
Figure 52. Digital Relay Setting Window
SETTINGS
On the Settings page (Figure 52):
1.
Select a delay type and enter the value of the delay:
•
The Delay on Make will cause a delay in the output when the input is True.
•
The Delay on Break will cause a delay in the output when the input is False.
RESET
The Reset Block (Figure53) re-scales the input voltage to a proscribed output range defined by the User:
•
The User defines an input range using Low and High values. An output range is defined the same
way.
•
The Reset block calculates a linear interpolation of the input value:output value.
•
The value for both ranges are display under the block title:
X/X:Y/Y = Input Low / Input High : Output Low / Output High
Input
Reset
0/0:0/0
Figure 53. Reset Block
Figure 54. Reset Setting Window
3-19
CPL Blocks
Rev 5.4
SETTINGS
On the Setting Window (Figure 54):
1.
Enter the High and Low Input values into the text fields.
2.
Enter the High and Low Output values into the text fields.
ROLLING AVERAGE
The Rolling Average Block (Figure 55) continually samples the input at a selected interval and outputs the
average of those samples.
•
The Number of Samples X is defined by the User.
•
The block is continuously calculating and then outputting the average of the most recent X samples,
resulting in a “rolling output” that drops the oldest sample value each time a new sample value is
taken.
•
The number of samples averaged is always X.
•
The User also defines the Interval values and any Offset values required.
The Rolling Average Block requires three inputs:
Input -
The control input from which the samples are taken.
Enable -
The input that tells the block to begin operating.
Clear -
This input resets the output to zero
Roll Avg.
Input
Enable
Clear
Figure 55. Rolling Average Block
Figure 56. Rolling Average Setting Window
SETTINGS
1.
TIMING
1.
2.
3-20
Enter the value of the Number of Samples required.
Enter the Interval values required.
Enter the Offset values, if needed.
Rev 5.4
CPL Blocks
RUNTIME
The Runtime block (Figure 57) tracks the amount of time a piece of equipment has been running continuously.
The Input remains high while the machine is running, and the block outputs the total time in minutes the input
remains high. The User has three options to select from for the Reset input configuration (Figure 58).
The User selects how the Reset input (when high) will clear the output (Clear Output):
Never -
The output begins counting on the rising edge of the input pulse, and never resets to zero.
Instead, it retains the last value counted during the reset period, and when the input pulse goes
high again it continues with the interrupted count.
On Make - The output begins counting on the rising edge of the input pulse, and when reset retains the
last value counted. When the input pulse goes high again, it begins the count over again
beginning with the number “1”
On Break - The output begins counting on the rising edge of the input pulse, and resets to zero on the
falling edge of the reset pulse.
NOTE: The default output value of the block when the page is started is zero.
Never 0 0 0 1 2 3 4 5 5 5 5 5 5 6 7 8 8 8 8
Break 0 0 0 1 2 3 4 5 0 0 0 0 0 1 2 3 0 0 0
Make 0 0 0 1 2 3 4 5 5 5 5 5 5 1 2 3 3 3 3
Runtime
Input
Time
Reset
Runtime Output is the total count while the Input is High.
A Reset Input signal resets the count to 0.
Figure 57. Runtime Block
Figure 58. Runtime Output Chart
Figure 59. Runtime Setting Window
SETTINGS
1.
Select a setting from Clear Output:
•
Never
•
On Make
•
On Break.
3-21
CPL Blocks
Rev 5.4
SCHEDULE
The Schedule Block (Figure 60) inserts a control schedule stored on the FSC into a CPL page. The schedule can
be activated/deactivated by the date/time parameters defined in the schedule, or by User-defined inputs within
the CPL Page.
NOTE: For more information on Scheduling, see Section Four, Programming - Chapter Four.
The Schedule Block has two inputs that can be used as control inputs, and three outputs designed to control and
provide the User with event information.
The two inputs are:
Monitor Temp -
The temperature point used as a control value.
OAT -
The Outside Air Temperature point also used as a control value.
The three outputs are:
Digital Schedule Output (T/F) -
Outputs to the controlled device per the schedule calculations.
Minutes Until Start -
Outputs the value in minutes remaining before the schedule begins.
Minutes Until Stop -
Outputs the value in minutes remaining until the schedule ends.
The Schedule Block features the Optimum Start/Optimum Stop function. This function first defines a window
of time referenced to the Occupied time value defined in the schedule selected in the Schedule Index field. The
control system cannot begin or end a schedule outside of this window, regardless of all input values. Once inside
the time window, the block samples the inputs and calculates the optimum time to start/stop controlling. Although it may sometimes take slightly longer for the control system to reach setpoint value, this function reduces
energy costs.
Schedule
MonitorTemp.
Digital Schedule Output (T/F)
OAT
Minutes until Start
Minutes until Stop
Figure 60. Schedule Block
Figure 61. Schedule Setting Window
SETTINGS
On the Setting Window (Figure 61) is used to enter scheduling information:
1.
Select a schedule from the Schedule Index drop-down list.
2.
Click inside the check boxes to select an option:
Optimum Start - Defines the amount of time a schedule can begin prior to entering the
Occupied Mode.
Optimum Stop - Defines the amount of time a schedule can end prior to entering the Unoccupied Mode.
Heat Mode - Tells the controlled device to operate in Heat mode.
Cool Mode - Tells the controlled device to operate in Cool mode.
Ignore Error - Tells the block to ignore any input errors and continue operating.
3-22
Rev 5.4
CPL Blocks
3.
If you selected Optimum Start, enter a value in the Opt. Start Window.
4.
If you selected Optimum Stop, enter a value in the Opt. Stop Window.
5.
Enter the Heat SPT (Heating Setpoint) - The temperature at which heating is turned on.
6.
Enter the Cool SPT (Cooling Setpoint) - The temperature at which cooling is turned on.
7.
Enter the Heat Design Temp - The building design temperature value compiled by ASHRAE.
8.
Enter the Cool Design Temp - The building design temperature value compiled by ASHRAE.
9.
Enter the Opt. Stop Drift Temp (Optimum Stop Drift Temperature) - The maximum allowable
temperature variance, from heating or cooling comfort temperature, used for calculating Optimum
Stop.
TIMING
On the Timing Window:
1.
Enter the Interval time (repeating time value that when expired, the block polls its inputs).
2.
Enter the Offset time (time value that action is delayed from the designated start time), if needed.
EXAMPLE
The sample CPL page (Figure jEX1) shows a schedule block controlled by the Outside Air Temperature and
Inside Air Temperature. On the Setting page (Figure EX2):
•
the block is using the Coolers On - Optimized schedule stored on the FSC (Figure EX3).
•
the Optimal Start/Optimal Stop time window is set for up to two hours prior to Occupied Mode,
and thirty minutes prior to Unoccupied Mode.
•
Cool Mode has been selected.
•
the Cooling SPT (Setpoint) has been set to 72 degrees, and the Cool Design Temp value is 90
degrees.
NOTE: The Heat SPT and Heat Design Temp fields are grayed out because Cool Mode was
selected.
•
the Opt. Stop Drift Temp has been set to 4 degrees.
•
on the Timing page (Figure EX4), the Interval has been set for for 1 minute. The block will poll the
inputs every 60 seconds. No Offset has been requested.
Figure EX1. Sample Of Schedule Block On CPL Page
3-23
CPL Blocks
Rev 5.4
Figure EX2. Setting Page
Figure EX3. Schedule Stored On FSC
Figure EX4. Timing Page
SEQUENCER
The Sequencer Block (Figure 62) is a staging block used for staged heating or cooling. The Sequencer block
uses a User-defined Interstage Delay value to prevent multiple pieces of equipment from initializing simultaneously, thus preventing excessive and damaging power drains and surges. This block is normally used for
cooling while in the direct mode, and for heating when the Reverse Acting mode is selected on the Setting Page.
The block uses two inputs (described below), and can control up to 15 outputs. These outputs are activated by
the control input rising above (or falling below if in Reverse Acting Mode) the corresponding setpoints. The
order of the staging sequence is fixed and can not be changed. The controlled devices can be of different
capacities.
The Sequencer Block has two inputs:
3-24
•
The Control input is compared against the selected settings of each setpoint to calculate the
value of the corresponding output.
•
The Enable input turns the Sequencer Block on, allowing it to begin operating.
Rev 5.4
CPL Blocks
Sequencer
Control
Enable
Figure 62. Sequencer Block
Figure 63. Sequencer Setting Window
SETTINGS
On the Setting Window (Figure 63) you define the number of control setpoints, the deadband, the interstage
delay, and the direct/reverse acting nature of the block:
1.
Enter a value for the Number of Control Points. This value will determine how many setpoints the
block will recognize, and the total number of outputs.
2.
Enter a Deadband value. If the value of the control signal reaches the setpoint plus or minus half the
deadband, the associated output point will change state in accordance with the selected settings. The
output status will not change while the value of the control signal remains inside the deadband zone.
3.
Enter an interval value for the Interstage Delay. This value is the amount of time after a stage is
activated that the next stage in sequence must wait before also activating. No delay is imposed on the
stages as the control signal value decreases and the output points are deactivated.
4.
The Reverse Acting option is used for heating staging. It causes the corresponding output points to
activitate as the control signal decreases below the selected setpoint values. When the control signal
rises above the setpoint value of a stage, the output will deactivate.
5.
Enter the Setpoint values. The number of control points selected determines the number of setpoints
available.
DESCRIPTOR
Click on the tab of the Descriptor Window to bring it to the foreground.
1.
Enter a uniquely descriptive name for the block that will make it easy to locate on the CPL Page. The
descriptor name can be up to 32 characters in length, and is displayed above the block.
EXAMPLE
Figure EX5 below shows a typical use of the Sequencer block within a CPL Page. The block uses a PIDLoop
block as the Control input, and a switch as the Enable input. The Descriptor for the Sequencer block is shown
above the block.
On the Setting page, four controls points have been added, with the setpoint values. The deadband value is + or
- one degree, theInterstage Delay interval is ten minutes, and the block is Direct Acting.
When the block is enabled, the Control input is compared to Setpoint 1. If cooling is required, Stage 1 device
will turn on first. If the control input shows a change of greater than one degree, Stage 2 device will turn on after
the ten minute Interstage Delay interval has passed. This pattern can continue until all four stages have been
turned on. If the control shows a negative change of greater than one degree, each stage will turn off in the
reverse order. No interstage delay is needed for the shut-down.
3-25
CPL Blocks
Rev 5.4
Figure EX5. Sample CPL Page using Sequencer Block
STARTUP
When a CPL Page is first enabled, all the outputs will be in error. The Startup Block (Figure 64) is used to
“kickstart” the page, outputting a True for the first cycle of the page.
Start
Figure 64. Startup Block
SETTINGS
No setting information available.
3-26
Rev 5.4
CPL Blocks
START/STOP
The Start/Stop Block (Figure 65) is a simple scheduling control block with one Start/Stop Time available. You
can set the block to control for one or more days of the week. This block is generally used when the more
complex Schedule Block is not required. The User wants only to add time/date control for a specific application.
No inputs are required for this block.
Start/Stop
Figure 65. Start/Stop Block
Figure 66. Start/Stop Setting Window
SETTINGS
On the Setting Window (Figure 66), select the days and times you would like for the schedule to run.
1.
Select the days you want the Start/Stop schedule to run.
2.
Enter a value for the Start Time.
3.
Enter a value for the Stop Time.
TIME EVENT
Upon detecting a time event, the Time Event block (Figure 67) will output a True digital state for one cycle of
the CPL page. The time event is defined as a new minute, hour, day, week, month, or year. On the Settings page
for this block, you may select which time event will trigger the output. An application for this block could be to
determine a new day so that all of the runtime blocks could be reset. Additional information provided in the
setup is an offset time which serves as a delay before the output can change. For instance, if the event is new
hour, the offset could be 10 minutes so that programmed actions can occur in a staggered state. There is no
Inputs page for this block.
Time Event
Figure 67. Time Event Block
Figure 68. Time Event Setting Window
3-27
CPL Blocks
Rev 5.4
SETTINGS
On the Setting Window (Figure 68), select the event and any offset time required.
1.
Select the desired Event.
2.
Enter a value for the Offset Time, if needed.
ENTERING BLOCK INFORMATION - GLOBAL VARIABLES
A Global Variable is a CPL block value from a single control panel that will be accessed frequently on the CPL
Pages for that panel. Global Variables reduce the number of software points needed, and serve as a timesaving
device for creating CPL Pages. They allow the User to save the specified value to a global variable block, and
the global variable block is used thenceforth to represent that value. The value could be data from a single
control point, the result of complex CPL calculations, or any other situation where using a global variable is
faster and easier than using the original CPL block programming.
The Global Variables drop-down menu (Figure 69) has four CPL blocks available to the User:
•
GAI (Global Analog Input)
•
GAO (Global Analog Output)
•
GDI (Global Digital Input)
•
GDO (Global Digital Output)
The Global Digital Output (GDO) is used to communicate values from one CPL page to multiple other pages.
This minimizes the number of software digital output points required for operation. A GDO must be receiving
data from at least one Global Digital Output (GDI).
MCL Tool allows 100 analog variables and 100 digital variables. As you create each variable, you will assign it
an Index number (1-100). This index number is displayed on each block below the title for easy reference. This
way, a GAO in one location can become a GAI at other locations, provided both analog variables are assigned
the same index number.
WARNING: USE GLOBAL VARIABLES WITH EXTREME CAUTION. RE-USING A PREVIOUSLY ASSIGNED INDEX NUMBER WILL RESULT IN UNDESIRABLE PROGRAM
OPERATION.
Figure 69. Global Variable Menu
Figure 70. Global Variable Setting Window
SETTINGS
All global variable blocks use the same Setting Window (Figure 70). An Index number is the only setting
required:
1.
3-28
Enter an Index value.
Rev 5.4
CPL Blocks
GLOBAL ANALOG INPUT
The GAI (Global Analog Input) block (Figure 71) is assigned an index number on the Setting Window. No
input is required.
GAI
VAR #1
Figure 71. Global Analog Input
GLOBAL DIGITAL INPUT
The GDI (Global Digital Input) block (Figure 72) is assigned an index number on the Setting Window. No input
is required.
GDI
VAR #1
Figure 72. Global Digital Input
GLOBAL ANALOG OUTPUT
The GAO (Global Analog Output) block (Figure 73) is assigned an index number on the Setting Window.
GAO
VAR #1
Figure 73. Global Analog Output
GLOBAL DIGITAL OUTPUT
The GDO (Global Digital Output) block (Figure 74) is assigned an index number on the Setting Window.
GDO
VAR #1
Figure 74. Global Digital Output
ENTERING BLOCK INFORMATION - LOGICAL
Logical Blocks use standard logical operators to define relationships between elements. Logical Blocks are used
to perform logic control sequences. The Logical drop-down menu (Figure 75) has four logical blocks available:
•
AND
•
NOT
•
OR
•
XOR
3-29
CPL Blocks
Rev 5.4
Figure 75. Logical Menu
AND
The AND Block (Figure 76) accepts up to 15 digital inputs. It begins with two inputs, adding an additional input
(up to 15) each time a connection is made. It uses the following logic:
If all inputs equal True, then Output equals True.
Else Output equals False.
And
Input 1
Input 2
Input 3
Figure 76. AND Block
Figure 77. AND Setting Window
SETTINGS
1.
Click the Ignore Error check box if you want the block to ignore any input errors.
OR
The OR Block (Figure 78) accepts up to 15 digital inputs. It uses the following logic:
If any Input equal True, then Output equals True.
Else Output equals False.
3-30
Rev 5.4
CPL Blocks
Or
Input 1
Input 2
Input 3
Figure 78. OR Block
Figure 79. OR Setting Window
SETTINGS
1.
Click the Ignore Error check box if you want the block to ignore any input errors.
NOT
The NOT Block (Figure 80) acts as an inverter. It accepts a digital input, and outputs its logical opposite. It uses
the following logic:
If Input1 equal True, then Output equals False.
If Input1 equal False, then Output equal True.
Not
Input 1
Figure 80. NOT Block
SETTINGS
XOR
The XOR Block (Figure 81) accepts up to 15 digital inputs. It uses the following logic:
If Input x or Input y equal True, then Output equals True.
If Input x and Input y equal True, then Output equals False.
More simply stated, an odd number of inputs must be True for the XOR output to be True.
3-31
CPL Blocks
Rev 5.4
XOr
Input 1
Input 2
Input 3
Figure 81. XOr Block
Figure 82. XOr Setting Window
SETTINGS
1.
Check the Ignore Error box if this function is desired.
ENTERING BLOCK INFORMATION - COMPARISON
CPL Comparison Blocks use Boolean logical operators to compare two inputs and output either a True or False,
depending on the logic applied. All Comparison Blocks have a digital (True/False) output. The Comparisons
drop-down menu (Figure 83) offers eight blocks:
•
A-Equal
•
A-Not Equal
•
D-Equal
•
D-Not Equal
•
•
Greater Equal
Greater Than
•
Less Equal
•
Less Than
NOTE: The CPL Comparison blocks treat a digital input as a logical 1 or 0. All digital outputs
greater than 1 will be treated as a 1.
3-32
Rev 5.4
CPL Blocks
Figure 83. Comparison Drop-Down Menu
A-EQUAL
The A-Equal (Analog Equal) Block (Figure 84) applies the following logic:
If Input 1 equals Input 2, then Output equal True
Else, Output equal False
This block accepts only analog inputs.
A-Equal
Input 1
Input 2
Figure 84. A-Equal Block
SETTINGS
A-NOT EQUAL
The A-Not Equal (Analog Not Equal) Block (Figure 85) applies the following logic:
If Input 1 is not equal to Input 2, then Output equal True
A-Not Equ.
Input 1
Input 2
Figure 85. A-Not Equal Block
SETTINGS
3-33
CPL Blocks
D-EQUAL
The D-Equal (Digital Equal) Block (Figure 86) applies the following logic:
If Input 1 equals Input 2, then Output equal True
This block accepts only digital inputs.
D-Equal
Input 1
Input 2
Figure 86. D-Equal Block
SETTINGS
D-NOT EQUAL
The D-Not Equal (Digital Not Equal) Block (Figure 87) applies the following logic:
If Input 1 not equal to Input 2, then Output equal True
This block accepts only digital inputs.
D-Not Equ.
Input 1
Input 2
Figure 87. D-Not Equal Block
SETTINGS
GREATER EQUAL
The Greater Equal Block (Figure 88) applies the following logic:
If Input 1 is greater than or equal to Input 2, then Output equal True
Greater Equal
Input 1
Input 2
Figure 88. Greater Equal Block
SETTINGS
3-34
Rev 5.4
Rev 5.4
CPL Blocks
GREATER THAN
The Greater Than Block (Figure 89) applies the following logic:
If Input 1 is greater than Input 2, then Output equal True
A-Equal
Input 1
Input 2
Figure 89. Greater Than Block
SETTINGS
LESS EQUAL
The Less Equal Block (Figure 90) applies the following logic:
If Input 1 is less than or equal to Input 2, then Output equal True
Less Equal
Input 1
Input 2
Figure 90. Less Equal Block
SETTINGS
3-35
CPL Blocks
Rev 5.4
LESS THAN
The Less Than block (Figure 91) applies the following logic:
If Input 1 is less than Input 2, then Output equal True
Less Than
Input 1
Input 2
Figure 91. Less Than Block
SETTINGS
ENTERING BLOCK INFORMATION - ARITHMETIC
The Arithmetic CPL Blocks are used to perform basic arithmetic operations on elements. The Arithmetic dropdown menu (Figure 92) offers seven blocks:
•
Add
•
Divide
•
Modulus
•
Multiply
•
Negate
•
Square Root
•
Subtract
The Arithmetic Blocks accept analog inputs only. No setting information is required.
Figure 92. Arithmetic Menu
3-36
Rev 5.4
CPL Blocks
ADD
The Add Block (Figure 93) adds together the values of the inputs and outputs the sum. The Add Block will
accept up to fifteen analog inputs.
Add
Addend 1
Addend 2
Addend 3
Figure 93. Add Block
SETTINGS
No setting information required.
DIVIDE
The Divide Block (Figure 94) divides the first input (the Dividend) by the second input (the Divisor), and then
outputs the quotient. The block accepts two analog inputs.
Divide
Dividend
Divisor
Figure 94. Divide Block
SETTINGS
MODULUS
The Modulus Block (Figure 95) performs a similar operation as the Divide Block, but outputs the remainder of
the quotient instead:
The Modulus Block divides the first input (the Dividend) by the second input (the Divisor),
and the remainder becomes the output value.
The block accepts two analog inputs.
Modulus
Dividend
Divisor
Figure 95. Modulus Block
SETTINGS
3-37
CPL Blocks
Rev 5.4
MULTIPLY
The Multiply Block (Figure 96) multiplies the values of up to 15 analog inputs, and outputs the product of the
selected values.
Multiply
Multiplier 1
Multiplier 2
Multiplier 3
Figure 96. Multiply Block
SETTINGS
NEGATE
The Negate Block (Figure 97) multiplies the input by -1, thereby outputting the negative value of that input. The
block accepts an analog input.
Negate
Input
Figure 97. Negate Block
SETTINGS
SQ. ROOT (SQUARE ROOT)
The Sq. Root (Square Root) Block (Figure 98) outputs the square root of the input value. The block accepts an
analog input.
Sq. Root
Input
Figure 98. Sq. Root Block
SETTINGS
3-38
Rev 5.4
CPL Blocks
SUBTRACT
The Subtract Block (Figure 99) subtracts the second input value (Subtrahend) from the first input value
(Input), and outputs the difference between the two input values. The Subtract block accepts two analog inputs.
Subtract
Input
Subtrahend
Figure 99. Subtract Block
SETTINGS
ENTERING BLOCK INFORMATION - POINTS
A Point is a single piece of data on a controller. A point can be hardware or software, analog or digital, and an
input or output. A CPL Point Block is a graphical representation on the CPL Page of a hardware/software input
or output value. The Point Block drop-down menu (Figure 100) has nine blocks available:
AI -
Analog Input
DI -
Digital Input
AO -
Analog Output
DO -
Digital Output
MAI -
MDI -
Multiple Digital Input
Pt. State -
Point State
SNVT-state Input -
SNVT State Input
SNVT_state Output - SNVT State Output
After the Point Block is placed on the CPL Page, the User selects the data source and other values from the
Setting Window (Figure 101).
NOTE: The MAI, MDI, and Pt. State blocks have a Setting Window specific to their function.
Figure 100. Points Menu
Figure 101. Point Setting Window
3-39
CPL Blocks
Rev 5.4
AI (ANALOG INPUT)
The AI (Analog Input) Block (Figure 102) represents a analog point, and outputs its value. The data source that
you select for the point will be displayed below the block’s title.
AI
Undefined
Figure 102. Analog Input Block
SETTINGS
1.
Select a point data source from the Point drop-down listing.
DI (DIGITAL INPUT)
The DI (Digital Input) Block (Figure 103) represents a digital point, and outputs its value. The data source that
DI
Undefined
Figure 103. Digital Input Block
SETTINGS
1.
AO (ANALOG OUTPUT)
The AO (Analog Output) Block (Figure 104) represents an analog point, and inputs its value. The data source
that you select for the point will be displayed below the block’s title.
AO
Undefined
Figure 104. Analog Output Block
SETTINGS
1.
D0 (DIGITAL OUTPUT)
The DO (Digital Output) Block (Figure 105) represents a digital point, and inputs its value. The data source that
DO
Undefined
Figure 105. Digital Output Block
SETTINGS
1.
3-40
Rev 5.4
CPL Blocks
MAI (MULTIPLE ANALOG INPUT)
The MAI (Multiple Analog Input) Block (Figure 106) allows the User to compare multiple inputs against each
other simultaneously, and output the results of that comparison. The MAI is an FSC point type that allows for the
multiple analog points from the panel to be bound to this one point for evaluation. The status of this point can
only be viewed on the CPL page.
The output of the MAI is determined by the output function selected. The MAI block allows the User a choice of
six Output Functions:
•
Low -
Lowest of all inputs
•
High -
Highest of all inputs
•
Average -
Average of all inputs
•
Number Above* -
Number of inputs above a specified value
•
Number Below* -
Number of inputs below a specified value
•
Percent Above* -
Percentage of inputs above a specified value
•
Number Above* -
Percentage of inputs below a specified value
NOTE: Output Functions with an asterisk (*) require a value enter in the Setting Window.
The selected output function is displayed on the block next to the block title.
MAI (Low)
Undefined
Figure 106. MAI Block
Figure 107. MAI Setting Window
SETTINGS
On the Setting Window (Figure 107), you must select a point, choose an output function, and enter a value, if
needed.
1.
Select a Point from the drop-down list.
2.
Select an Output Function.
3.
Enter a control *Value for your output function, if required.
4.
Select the check box for Ignore Error, if necessary.
3-41
CPL Blocks
Rev 5.4
MDI (MULTIPLE DIGITAL INPUT)
The MDI (Multiple Digital Input) Block (Figure 108) allows the User to compare multiple inputs against each
other simultaneously, and output the results of that comparison. The MDI is an FSC point type that allows for the
multiple analog points from the panel to be bound to this one point for evaluation. The status of this point can
only be viewed on the CPL page.
The output of the MDI is determined by the State and Output Function selected. The MDI block allows the
User a choice of two Output Functions:
•
Number In State* -
Number of inputs above a specified value
•
Percent In State* -
Number of inputs below a specified value
The selected Output Function is displayed on the block next to the block title.
MDI (Number in State)
Undefined
Figure 108. MDI Block
Figure 109. MDI Setting Window
SETTINGS
On the Setting Window (Figure 109), you must select a point, choose an output function, and enter a value, if
needed.
1.
2.
Select an Output Function.
3.
Enter the desired State.
4.
Select the check box for Ignore Error, if necessary.
POINT STATE
The Pt. State (Point State) Block (Figure 110) examines the state of a selected point. If the state of the point
matches the values defined by the User, the block outputs a True. For any other condition, the block outputs
False. There are two Output options:
•
Alarm Condition
•
Mode
When the User selects an Output from the Setting Window (Figure 111), the list of states available for that
option is listed in the scrollable text box. The state selected is the criteria for the block output. The selected state
is displayed on the block next to the block title.
3-42
Rev 5.4
CPL Blocks
Pt. State (Alarm)
Undefined
Figure 110. Pt. State Block
Figure 111. Point State Setting Window
SETTINGS
In the Setting Window (Figure 111):
1.
2.
Select an Output.
3.
Select the desired state from the scrollable list displayed in the text box.
3-43
CPL Blocks
Rev 5.4
SNVT STATE INPUT
The SNVT State Input Block (Figure 112) examines the state of a selected software point. The software point
must be a RAW Software Input point or a RAW Software Output point. The SNVT type must be SNVT_state.
The output of the block is a discrete value that corresponds to the value of the selected bit number. The selected
bit is the value you want to monitor.
Note: Panel level alarm generation and panel level trending are not available for this point type.
When you select a Point from the Setting Window (Figure 113) Point drop-down box, the list of available points
is displayed. The State radio-buttons allow one choice of Bit 0 thru Bit 15. The selected bit number is displayed
on the block next to the block title. Entering a name in the Descriptor tab page will display the descriptor above
the block.
Figure 112. SNVT State Input Block
Figure 113. SNVT State Input Setting Window
SETTINGS
1.
2.
Select a Bit by clicking the corresponding radio button.
3.
Enter a Descriptor for the block.
Refer to the RAW I/O CPL program and its related documentation for detailed SNVT_state programming
information. It is located in the CPL Library that is included with MCL Tool.
3-44
Rev 5.4
CPL Blocks
SNVT STATE OUTPUT
The SNVT State Output Block (Figure 114) examines the state of a selected software point. The software point
must be a RAW Software Output point only. The SNVT type must be SNVT_state.
The bit number will indicate to the CPL program, which of the 16 bits to which the input value will be transferred to the actual point. The selected bit is the value you want to control.
Note: Panel level alarm generation and panel level trending are not available for this point type.
When you select a point from the Setting Window (Figure 115) Point drop-down box, the list of available points
is displayed. The State radio-buttons allow one choice of Bit 0 thru Bit 15. The selected bit number is displayed
on the block next to the block title. The input of the block is a discrete value that corresponds to the selected bit
number. Entering a name in the Descriptor tab page will display the descriptor above the block.
Figure 114. SNVT State Input Block
Figure 115. SNVT State Input Setting Window
SETTINGS
1.
2.
Select a Bit by clicking the corresponding radio button.
3.
Enter a Descriptor for the block.
Refer to the RAW I/O CPL program and its related documentation for detailed SNVT_state programming
information. It is located in the CPL Library that is included with MCL Tool.
3-45
CPL Blocks
Rev 5.4
ENTERING BLOCK INFORMATION - TIME
Time Blocks provide time values for CPL Programming. The Time Blocks drop-down menu (Figure 116) has
three blocks available:
Constant Time -
Outputs a constant time value.
Convert Time -
Converts a time value input into a different time mode (unit) for output.
Current Time -
Outputs the current time.
Figure 116. Time Menu
CONSTANT TIME
The Constant Time block (Figure 117) outputs a constant (unchanging) time value selected by the User. The
value is displayed below the block title.
Constant Time
00:00:00
Figure 117. Constant Time Block
SETTINGS
1.
3-46
Enter the Time value desired.
Figure 118. Constant Time Setting Window
Rev 5.4
CPL Blocks
CONVERT TIME
The Convert Time block (Figure 119) converts an (analog) time value input to an output in the selected time
Mode. The selected mode is displayed on the block below the block title. Four modes are available:
•
Seconds
•
Minutes
•
Hours
•
Days
Convert Time
Minutes
Figure 119. Convert Time Block
Figure 120. Convert Time Setting Window
SETTINGS
1.
Select the Mode desired.
CURRENT TIME
The Current Time Block (Figure 121) outputs the current number of minutes that have transpired since midnight of the current day.
Current Time
Figure 121. Current Time Block
SETTINGS
3-47
CPL Blocks
3-48
Rev 5.4
Chapter Four
Schedules
z Adding a New Schedule
z Editing Existing Schedules
z Deleting Schedules
Schedules
Rev 5.4
SCHEDULING
MCL Tool provides the User with the capability to create, edit, and reuse energy management schedules. All
scheduling is handled through the FSC (Flexible System Controller) node. Scheduling can also be implemented
using a LonWorks compatible third-party scheduling node. All schedules reside on the node where they were
created. MCL Tool allows the User to copy schedules from one FSC controller node to another.
Although the completed schedules are stored on the FSC, they must be incorporated into a CPL Page in order to
begin operating. MCL Tool uses the Schedule CPL Block to implement the schedules. For more information on
the Schedule CPL Block, please see Section Four, Programming - Chapter Three.
THE SCHEDULE SUBTREE
Scheduling allows you to design and implement a customized on/off control program, designed for use on
specific days, seasons, or other criteria. There are two types of data concerning the Schedule information:
•
The Summary Schedule List contains the listing of all the individual schedules on a given panel.
The Schedule list provides a systematic control over the schedules. From the list of schedules, new
schedules can be added and old schedules deleted.
•
The second source of data is the actual schedule(s). The individual schedules have day/time entries.
There are MCLT data sources defined to handle this information.
VIEWING INDIVIDUAL SCHEDULES
Schedules are found on the Physical Tree beneath the FSC controller node on which they reside (Figure 1). To
view the available schedules on the Schedules subtree:
1.
Click
to expand the FSC controller node you are working with.
2.
Click
to expand the Schedules subtree. All schedules residing on the FSC node will be listed.
When you expand the Schedules subtree, the Summary Schedule List panel (Figure 2) opens on the right. The
schedules listed in the Summary Schedule List panel matches the schedules listed under the Schedules subtree.
Figure 1. Schedules Subtree
4-2
Section 4- Programming
Rev 5.43
Schedules
Figure 2. Summary Schedule List
SCHEDULES POP-UP MENU
The Schedules Pop-up menu (Figure 3) has two commands:
•
Add – Allows you to create new CPL schedules.
•
Refresh – Updates the Summary Schedule List to reflect all changes.
Figure 3. Schedules Pop-up Menu
CREATING A NEW SCHEDULE
Creating a new schedule is accomplished in two main steps – Adding A New Schedule, and Entering Values.
ADDING A NEW SCHEDULE:
1.
Click
to expand the scheduling node.
2.
Right click on Schedules and select Add.
3.
The Add CPL Schedule window (Figure 4) opens. Enter the name of your new schedule and click
(okay).
4.
Right click on Schedules and select Refresh. The name of your new schedule should appear under
this node.
Figure 4. Add CPL Schedule Window
4-3
Schedules
Rev 5.4
ENTERING VALUES FOR A NEW SCHEDULE:
1.
Verify that your new schedule is still selected from the Schedules subtree. The FSC Schedules panel
(Figure 5) will be open on the right.
2.
Enter the Start Time, Stop Time, and Days of the week in the appropriate text fields (Figure 6).
3.
Click
. The schedule updates and displays with the new values. The window at the top of
the panel will show the current values highlighted (Figure 7).
4.
To enter another value, arrow down to the next blank line in the FSC Schedule Window (Figure 8)
and repeat steps two and three.
Figure 5. FSC Schedules Panel
Figure 6. Start/Stop Times and Days Of The Week
Figure 7. Current Schedule Values Highlighted
4-4
Rev 5.43
Schedules
Figure 8. Enter New Schedule Values Text Field
5.
Repeat steps two, three, and four as often as needed. If you wish to delete a value, highlight it in the
FSC Schedules Window, and click
6.
Click
. To delete all the parameters, click
.
. This saves the schedule to the scheduling node.
NOTE: If you do not click
before exiting the FSC Schedules panel, a Unsaved
Changes warning box appears (Figure 9). Click
to save your changes to the
scheduling node.
Figure 9. Unsaved Changes Warning Box
Figure 10. Editing An Existing Schedule
4-5
Schedules
Rev 5.4
EDITING AN EXISTING SCHEDULE
1.
Select the schedule you wish to edit from the Schedules subtree. The FSC Schedules panel will open
on the right.
2.
Select the value text field you wish to edit from the top window and enter the new values for the
Start Time, Stop Time, and Days of the week (Figure 10).
3.
Click
4.
If you wish to delete a value, highlight it in the Schedules window, and click
. The schedule updates and displays with the new parameters.
the parameters, click
5.
Click
. To delete all
.
. This saves the schedule to the scheduling node.
RENAMING A SCHEDULE
1.
Right click on the schedule you wish to rename, and select Rename from the popup menu (Figure
11).
2.
The Rename CPL Schedule dialog box opens. Enter the new name for your schedule (Figure 12)
and click
. The new schedule name appears in the subtree.
Figure 11. Rename Command
Figure 12. Rename CPL Schedule Window
DELETING A SCHEDULE
1.
Right click on the schedule you wish to delete and select Delete from the popup menu (Figure 13).
2.
The Warning window appears. Click
Figure 13. Delete Schedule Command
4-6
to delete the schedule.
Rev 5.43
Schedules
Figure 14. Copy To FSC Schedule Command
COPYING SCHEDULES TO ANOTHER FSC
Copy to FSC - Copies the selected schedule to another FSC node on the network (Figure 14). When selected:
1.
The Copy Schedule To FSC window (Figure 15) opens.
2.
Selected the desired FSC to copy to and click
.
Figure 15. Copy To FSC Window
REFRESH SCHEDULES
The Refresh command requests the LNServer database for the most current CPL and/or Schedule information.
You should Refresh each time you use the Enable, Disable, and Copy to FSC commands.
1.
Click
to expand the scheduling node.
2.
Right click on Schedules and select Refresh (Figure 16).
Figure 16. Refresh Menu Command
4-7
Schedules
4-8
Rev 5.4
Rev 5.4
Programming Index
Programming Index
A
Accumulator Block 3-7
Add Block 3-37
Analog Constant Block 3-4
Analog Equal Block 3-33
Analog Input Block 3-40
Analog Not Equal Block 3-33
AND Block 3-30
Arithmetic 3-36
B
Binding 1-2
Refresh 1-3
Binding Editor 1-2
Refresh Button 1-3
Block Connections 2-17
Connecting Blocks 2-17
Deleting A Block Connection 2-18
Multiple Inputs 2-18
Prohibited 2-17
C
Calculation Block 3-7
Constant, Analog Block 3-4
Constant, Digital Block 3-4
Constant Time Block 3-46
Convert Time Block 3-46
Counter Block 3-9
CPL Block 3-2
2-Position 3-6
Accumulator 3-7
Add 3-37
Analog Constant 3-4
Analog Input 3-29
Analog Output 3-29
AND 3-30
Calculation 3-7
Constant Time 3-46
Convert Time 3-46
Counter 3-9
Current Time 3-47
Dial Provider 3-9
Digital Constant 3-4
Digital Input 3-29
Digital Output 3-29
Divide 3-37
Enthalpy 3-10
Equal - Analog 3-33
Equal - Digital 3-34
Error - Analog 3-10
Error - Digital 3-11
Greater Equal 3-34
Greater Than 3-35
Input - Analog 3-40
Lead/Lag 3-12
Less Equal 3-35
Less Than 3-36
Min/Max 3-13
Minimum On/Off 3-14
Modulus 3-37
Multiple Analog Input 3-41
Multiple Digital Input 3-42
Multiply 3-38
Negate 3-38
NOT 3-31
Not Equal - Analog 3-33
Not Equal - Digital 3-34
One Shot 3-15
OR 3-30
Output - Digital 3-40
PID Loop 3-16
Psychro 3-17
Ramp 3-17
Relay - Analog 3-18, 3-19
Relay -Digital 3-19
Reset 3-19
Rolling Average 3-20
Runtime 3-21
Schedule 3-22
Select Hi/Lo/Average 3-11
Sequencer 3-24
Square Root 3-38
Start/Stop 3-27
Index-1
Programming Index
Startup 3-26
Subtract 3-39
Time Event 3-27
XOR 3-31
CPL Blocks
Adding CPL Blocks 2-13
Arithmetic Blocks 2-6
Block Colors 2-7
Block Connections 2-17
Block Types 2-5
Constant Blocks 2-6
Constants 3-3
CPL Block Settings 3-2
Ignore Error Check Box 3-3
Settings Window 3-2
Deleting A Block 2-16
Direct/Reverse Acting Blocks 2-15
Function Blocks 2-6
Global Variables Blocks 2-6
Logical Blocks 2-6
Moving A Block 2-17
Multiple Input Block 2-18
Point Blocks 2-7
Time Blocks 2-7
CPL Editor 2-7
Best Fit 2-8
CPL Block Menu 2-12
CPL Editor Toolbar 2-8
Deleting Multiple Blocks 2-16
Editing Multiple Blocks 2-14
Monitor Mode 2-9
Activate 2-9
Deactivate 2-10
Moving Multiple Blocks 2-17
Show Editor 2-8
Zoom Control Box 2-11
Zoom Modes 2-8
CPL Pages
Adding A New CPL Page 2-12
CPL Page Menu
Export to DXF 2-4
CPL Page Menu Commands 2-3
Copy To FSC 2-3
Copy To Library 2-3
Enable/Disable 2-3
CPL Pages Subtree 2-2
Popup Menu 2-3
Index-2
Creating CPL Pages 2-12
Editing CPL Pages 2-12
Individual Pages 2-3
CPL User Library 2-19
Accessing 2-20
Closing 2-20
CPL Block Editor Window 2-21
Creating A New CPL Library Page 2-21
Importing A CPL Library Page 2-22
Library Pages Toolbar 2-21
Library Pages Window 2-20
Pre-programmed Pages 2-19
Current Time Block 3-47
D
D-Not Equal 3-34
Dial Provider Block 3-9
Digital Constant Block 3-4
Digital Equal Block 3-34
Digital Output Block 3-40
Divide Block 3-37
E
Editing and Viewing Bindings 1-2
Editing and Viewing Binds 1-4, 1-5
Enthalpy Block 3-10
Error - Analog Block 3-10
Error - Digital Block 3-11
F
FSC Schedules
Copying FSC Schedules 4-7
FSC Schedules Panel 4-4, 4-5
Refresh 4-7
Function Blocks 3-5
Functions
Descriptor Window 3-5
Timing Window 3-5
G
Global Analog Input Block 3-29
Global Analog Output Block 3-29
Global Digital Input Block 3-29
Global Digital Output Block 3-29
Global Variables Blocks 3-28
Greater Equal Block 3-34
Greater Than Block 3-35
Rev 5.4
Rev 5.4
L
Runtime Block 3-21
Lead/Lag Block 3-12
Less Equal Block 3-35
Less Than Block 3-36
Logical Blocks 3-29, 3-32
S
M
Min/Max Block 3-13
Minimum On/Off Block 3-14
Modulus Block 3-37
Monitor Mode
Status Command Function 2-10
Multiple Analog Input Block 3-41
Multiple Digital Input Block 3-42
Multiply Block 3-38
N
Negate Block 3-38
Network Variable Inputs 1-2
Network Variable Outputs 1-2
Network Variables 1-2
NOT Block 3-31
O
One Shot Block 3-15
OR Block 3-30
P
PID Loop Block 3-16
Point Blocks 3-39 to 3-45
Point State Block 3-42
Psychro Block 3-17
R
Ramp Block 3-17
RAW Software Input point 3-44
RAW Software Output point 3-44
Refresh 1-3
Refresh Schedules 4-7
Relay - Analog Block 3-18, 3-19
Relay -Digital 3-19
Reset Block 3-19
Reverse Acting Block 3-16
Rolling Average Block 3-20
Programming Index
Schedule
Add 4-3
Copying FSC Schedules 4-7
Create 4-3
Entering Values 4-4
Delete 4-6
Edit 4-6
Pop-up Menu 4-3
Rename 4-6
Viewing 4-2
Schedule Block 3-22
Scheduling 4-2
Schedule Subtree 4-2
Summary Schedule List 4-2
Section Four - Programming 1
Select Hi/Lo/Average Block 3-11
Sequencer Block 3-24
SNVT State Input 3-44
SNVT State Output 3-45
Square Root Block 3-38
Start/Stop Block 3-27
Startup Block 3-26
Status Command Function
Status Command Window 2-10
Status Command Window 2-10
Fix Button 2-10, 2-11
Get Status Button 2-11
Point Status LED Panel 2-11
Release Button 2-10
Reset Button 2-10
Set Button 2-10
Subtract Block 3-39
T
Time Blocks 3-46
Time Event Block 3-27
Two Position Block 3-6
X
XOR Block 3-31
Index-3
Programming Index
Index-4
Rev 5.4
MCL TOOL 5.4 - SECTION FIVE
OPERATIONS
Chapters
1. Workstation Basics
Operations Introduction
Rev 5.4
Windows® 2000 and Windows® XP are registered trademarks and service marks of companies other than
Johnson Controls, Inc. FSC®, CPL® and MCL Tool® are trademarks of Johnson Controls, Inc.
All Rights Reserved
Published in U.S.A.
2
Section 5 - Operations
Rev 5.4
Operations Table of Contents
Chapter One - Workstation Basics
1-1
MCLT Window Overview ................................................................................................... 1-2
Menu Bar ................................................................................................................ 1-3
Tool Bar .................................................................................................................. 1-5
Physical Tree ..................................................................................................................... 1-6
MCL Tool Network Interface .................................................................................... 1-6
Editing The MCL Tool Network Interface ...................................................... 1-7
To Access The MCL Tool Network Interface Editor: .......................... 1-7
MCL Tool Network Interface Editor Options: ..................................... 1-7
Connection Description Template (CDT) ...................................................... 1-8
Adding A Connection Description Template ...................................... 1-9
Modifying Connection Description Templates ................................. 1-11
Deleting Connection Description Templates .................................... 1-11
Multi-Node Operations ............................................................................... 1-12
Selecting the node(s): ..................................................................... 1-12
Selecting the options ....................................................................... 1-13
Confirming your selections .............................................................. 1-13
Routers ................................................................................................................. 1-13
Controller Nodes ................................................................................................... 1-14
Node Pop-up Menu Commands ........................................................................... 1-14
Points .................................................................................................................... 1-22
Adding FSC/FLC points ............................................................................. 1-23
Add FSC Point Window............................................................................... 1-23
Editing FSC/FLC Points ............................................................................. 1-23
Deleting FSC/FLC Points ........................................................................... 1-25
LMOs (LonMark Objects) ..................................................................................... 1-26
Network Variables ................................................................................................. 1-26
Binding: Connecting NVOs To NVIs .......................................................... 1-27
Configuration Properties ....................................................................................... 1-27
Point, LMO, NV, and CP Working Panels .............................................................. 1-27
Additional FSC Subtrees ...................................................................................... 1-30
CPL Pages ................................................................................................. 1-30
Schedules .................................................................................................. 1-32
Node Working Panels ...................................................................................................... 1-35
Detail Panel .......................................................................................................... 1-36
Query Options ........................................................................................... 1-36
Trend Setup Panel ................................................................................................ 1-37
Trend During Occupancy ................................................................ 1-37
Sampling .................................................................................................... 1-38
Trend Setup For ASCs .................................................................... 1-38
Trend Setup For FSCs .................................................................... 1-39
3
Rev 5.4
Trend Harvest Panel ............................................................................................. 1-40
Trend Channels Window ........................................................................... 1-40
Trend Samples Window ............................................................................ 1-41
Trend Harvest Graph Window .................................................................... 1-41
The Harvest Button .................................................................................... 1-43
To View Trending Data: .............................................................................. 1-43
The Export Button ...................................................................................... 1-44
To Export Trend Data: ................................................................................ 1-44
ASG (Application Specific Graphics) Panel .......................................................... 1-45
Occupancy Modes ..................................................................................... 1-45
Occupied ......................................................................................... 1-45
Unoccupied ..................................................................................... 1-46
Economy ......................................................................................... 1-46
Controller Status Data ............................................................................... 1-46
Line Graph ................................................................................................. 1-47
Operations Index
4
I-1
Chapter One
Workstation Basics
MCLT Main Window Overview
Menu and Tool Bars
Physical Tree
Node Working Panels
Workstation Basics
Rev 5.4
MCLT WINDOW OVERVIEW
This chapter provides you with an overview of the MCLT window environment. The MCLT window consists of
two sub-windows: the Physical Tree window, and the Node Working Panels window. First is introduced the
MCLT Main Menu and Task Bars. Then the Physical Tree, its subtrees, and associated menu commands and
capabilities are covered. The final section introduces the MCLT Working Panels, covering each panel in detail.
NOTE: For operating instructions, please see Section Two, Installation and Startup, Chapter
Three.
For Binding, Scheduling, and CPL Programming instructions, please see Section Four, Programming.
For a detailed explanation of MCL Tool Architecture, please see Section Six, Appendices Appendix C.
All MCLT functions are accessed from the main window (Figure 1) through the Menu Bar, the Tool Bar, the
Physical Tree, and the Node Working Panels. Within the main window the left window displays the expandable
Physical Tree representing your control system. The right window displays the working panels for the currently
selected node on the Physical Tree. The left-hand corner of the bottom task bar displays the status of the server.
Figure 1. MCLT Main Window
1-2
Rev 5.4
Workstation Basics
MENU BAR
The Menu Bar (Figure 2) has three options: MCLT, View, and Help. To access the pull-down menus for each of
these options, click on the name.
Figure 2. Menu Bar
Figure 3. MCLT Menu Commands
The MCLT pull-down menu (Figure 3) has five commands:
Physical Tree – This command opens up a new Physical Tree window showing the Physical Tree and
Working Panels (Figure 4). Click on the tree node you wish to expand or collapse, or use the
Expand All and
Collapse All Tool Bar buttons for viewing the tree.
CPL Library – This command opens up a window showing the CPL Library (Figure 5). You can select an
existing program to edit, or create a new Library Page. For more information, please see Section
Four, Programming - Chapter Two.
Alarm - This command opens the Alarm View window (Figure 6), which displays a record of previous
alarms, up to 300. The User can select:
• Always on top - The Alarm View window remains open and on top of all other open windows,
so the User can constantly monitor alarm activity.
• Visible on New Alarm - The Alarm View window opens automatically each time a new alarm
is generated.
• Beep on new alarm - MCLT will beep to alert the User each time a new alarm is generated.
Database Print – This command opens the Database Print program. For more information, please see
Section Six, Appendices, Appendix H - Database Print.
Exit – Select this command to exit MCLT.
Figure 4. Physical Tree Window
1-3
Workstation Basics
Rev 5.4
Figure 5. CPL Library Window
Figure 6. Alarm View Window
The View menu (Figure 7) has one command:
Toolbar – Click on the check box to view the Toolbar, or, if it is already checked, click on the check box to
hide the Toolbar.
Figure 7. View Menu Commands
The Help menu (Figure 8) has two commands:
About – This command opens a window (Figure 9) that shows the name, version number, and copyright of
your MCL Tool software.
MCL Tool Help – This command opens the On-line Help dialog box. You can find help topics through the
Help Table of Contents (Figure 10), the Help Index (Figure 11), or through a search engine using the
Find Setup Wizard (Figure 12).
NOTE: You can access context-sensitive Help at anytime using the F1 key. Pressing the F1
function key at the top of your keyboard will open the context-sensitive Help screen for the
currently selected object.
1-4
Rev 5.4
Figure 8. Help Menu
Figure 10. Table of Contents
Workstation Basics
Figure 9. MCL Tool About... Screen
Figure 11. Help Index
Figure 12. Help Find Setup Wizard
TOOL BAR
The MCLT Tool Bar (Figure 13) features shortcut buttons for the commands available in the Menu Bar MCLT
pull-down menu.
Figure 13. MCLT Tool Bar
Listed below are the buttons available on the Tool Bar:
– Exit MCLT
– Open The List Of Physical Trees
– Open The Local CPL Library
– Open Alarm Window
– Database Print
1-5
Workstation Basics
Rev 5.4
PHYSICAL TREE
The Physical Tree is a representation of the nodes connected on the LON (LONWORKS control networking
technology). Each node contains all the points for the designated hardware device (if available), and also the
LMOs (LONMARK Objects) if the device is LONMARK-compliant. The entire Physical Tree can be collapsed into
the MCL Tool Network Interface Node, or expanded from this same point.
•
To expand the tree, click
at the node you wish to view. To collapse, click
at the node
you wish to close.
The Physical Tree consists of the system node represented as MCL Tool Network Interface (Figure 14),
controller nodes, and routers. Figure 15 shows the VAV-01 node on the Physical Tree expanded to display its
points, and corresponding NVs (Network Variables) and CPs (Configuration Parameters) for, in this example,
the Node Object point on the node.
Figure 14. MCL Tool Network Interface Node
Figure 15. Expanded VAV-01 Node
MCL TOOL NETWORK INTERFACE
The MCL Tool Network Interface node (Figure 14) is the system, or root node for your control system. It
represents the physical interface card to the LONWORKS network (the PCLTA 10/20 or PCC-10 interface card
installed on your PC or laptop). It will always be the first node on the Physical Tree, and is also known as the
Global Node.
1-6
Rev 5.4
Workstation Basics
EDITING THE MCL TOOL NETWORK INTERFACE
The MCL Tool Network Interface uses the Editing: MCL Tool Network Interface dialog box (Figure 16) to
configure operating properties for your control system. The dialog box displays general information on your
system, as well as text fields for with default values that define interval rates.
Figure 16. Editing MCL Tool Network Interface Dialog Box
Figure 17. MCL Tool Network Interface Pop-up Menu
TO ACCESS THE MCL TOOL NETWORK INTERFACE EDITOR:
1.
Right click on the MCL Tool Network Interface node, and select Edit from the pop-up menu (Figure
17).
MCL TOOL NETWORK INTERFACE EDITOR OPTIONS:
NSI Timeout (sec) - Indicates how long the system waits for remote LNS clients to respond to a ping.
Discovery Interval (sec) - Contains the new device discovery interval (in seconds) in which LCA Object
Server scans the network for newly attached, unconfigured devices. An interval value of 0 (the
default value) turns off the background discovery process. A value of 65535 means “Do Not
Change”. All other values indicate the minimum interval between discoveries.
Update Interval (sec) - Indicates the interval (in seconds) in which NSS retries updating (in the background) any changes made to devices in the field. A value of 0 indicates that the background process
is turned off. Setting this property to 0 will turn off the background process.
Transmit Timer (sec) - The interval (in seconds) that the LON retries to send Request and Acknowledged
messages.
Register Nodes on Receipt of Service Pin - Tells MCL Tool to register the node in the database when it
receives a service pin.
Ignore Pending Update - Tells MCL Tool to ignore any pending updates when receiving the remote client
request to go OnNet, avoiding potential delays due to a large backlog of updates.
1-7
Workstation Basics
Rev 5.4
OnNet - When this box is checked, you are in OnNet Mode, and are now communicating with the LNS
database and the devices in the field. OnNet Mode is a management mode in which the NSS updates
both its on-board database and the configuration of devices in the network. When the NSS is first
placed in the OnNet mode it also updates any changes made while it was in the OffNet management
mode.
Licensing - Displays the licensing information for your system:
• If you have purchased a Standard LNS License
• The amount of Credits In License equals the amount of devices that can be installed on the
system.
• The Licensed Credits Used is the amount of devices installed in the system.
• Deficit Credits are devices installed that exceed the legal number of credits allowed.
• The Maximum Deficit Credits is the maximum number of devices that you can install during
the Deficit Days Remaining grace period.
• Deficit Days Remaining is the amount of time given by LNS to resolve your licensing deficits
before LNS shuts down completely. LNS will notify you by message screens when you are in
deficit condition.
Channel Delay (Backbone) - The average number of milliseconds required for a packet to get onto the
channel once it has been queued.
Default Engineering Units - Checking the Display SI Units check-box will display all “available” analog
points in SI engineering units. Checking the Display English Units check-box will display all
“available” analog points in English engineering units. “Available” analog points are LNS database
points not “set” using the Configuration Wizard SI checkbox, point editor or status/command screen.
CONNECTION DESCRIPTION TEMPLATE (CDT)
The Connection Description Template (CDT) is the template used to define the parameters of a binding. The
CDT determines the type of addressing and message service to be used, timing parameters, use of authentication
and priority slots, etc. The User can create a new template, or modify existing templates.
The CDT uses five different types of Addressing:
Broadcast - Addresses all the nodes in a subnet or domain.
Neuron ID - Refers to a single node by its unique 48-bit ID
Group -
Refers to numbered group of nodes in the system.
Subnet/Node - Refers to a single node by its domain, subnet, or node (DSN) address (assigned when the
network image is sent to the node for the first time).
Turnaround - Used for connections that take place only within a node.
The CDTs created on the MCL Tool Network Interface node are displayed in the Connection Description
Template List (Figure 19). They will also appear in a scrollable Connection Template list in the Bind To Editor
for the User to select when adding a new bind (please see Section 4, Programming - Chapter One for more
information on Binding).
To access the CDTs:
1-8
1.
Right click on the MCL Tool Network Interface node. The pop-up menu will open.
2.
Select the Connection Template command (Figure 18).
3.
The Connection Description Template List (Figure 19) opens.
Rev 5.4
Figure 18. Connection Template Command
Workstation Basics
Figure 19. Connection Description Template List
ADDING A CONNECTION DESCRIPTION TEMPLATE
To add a new CDT:
1.
Open the Connection Description Template List (described above.)
2.
Click
3.
Enter the Name and a Descriptor (if desired) for the CDT in the appropriate text fields (Figure 21).
This information will be displayed in the CDT List (Figure 22). You must enter a Name.
to open the Add Connection Description Template Setting Window (Figure 20).
Figure 20. Add CDT Setting Window
Figure 21. Name and Descriptor Text Fields
Figure 22. Name and Descriptor as displayed in the CDT List
1-9
Workstation Basics
4.
Rev 5.4
Enter values for the following parameters:
Addressing:
Force Unicast - Forces LNS to use DSN (domain/subnet/node) or NID (Neuron ID) addressing
where it would normally use group (or broadcast) addressing.
No broadcast - Tells LNS to fail if there is no other way to address the message besides broadcast.
Fail group to broadcast - Tells LNS to use broadcast addressing if it has trouble using group
addressing.
Always broadcast - Tells LNS to always use broadcast addressing.
Service Types
Service Type Override - Tells LNS that you will choose the service type explicitly rather than
allowing LNS to determine it.
Acknowledged - The message is sent out and acknowledged by the receiver (not to be used for large
group bindings causing failure to received Acknowledge messages.
Unacknowledged repeated - The message is sent out many times to ensure the probability of it
reaching its destination.
Unacknowledged - The message is sent out once.
Request Response - Used only for out-and-back messages (e.g.,. NV polls), not used for binds.
Timing Parameters
Repeat Count Override - Enter a value for the number of times LNS should repeat an unacknowl
edged-repeated message.
Retry Count Override - Enter a value for the number of times LNS should retry an acknowledged
message if it does not receive an acknowledgment in time.
Transmit Timer Override - Enter a value for the interval rate LNS waits between retries of
acknowledged and request/response messages.
Receive Timer Override - Select a value that tells LNS the time period within which receiving
devices will treat messages from the same source with the same reference ID as
duplicate messages. Repeats of messages using the above service types all use the
same reference ID as the original to identify them as duplicates.
Repeat Timer Override - Select a value for the interval LNS waits between repeats for unacknowl
edged-repeated messages.
Other
Authentication Override - Manually overrides control of the LNS message Authentication option.
Use Authentication - Turns the message Authentication option on, telling MCL Tool to begin
sending
and receiving authentication packets for messages on the network.
Priority Override - Manually overrides control of the LNS message Priority Override option.
Use Priority - Tells LNS that the binding should use a reserved time slot on the network,
helping the message to arrive more quickly to its destination.
Suppress Source Address - Tells LNS to suppress the source address.
1-10
Rev 5.4
Workstation Basics
MODIFYING CONNECTION DESCRIPTION TEMPLATES
To modify an existing CDT:
1.
2.
Click
to open the Modify Connection Description Template Setting Window (Figure
23). The Name of the selected CDT appears in the title bar, and both the Name and Descriptor appear
in the associated text fields (Figure 24) of the window.
3.
Make changes to settings as desired.
Figure 23. Modify CDT Setting Window
Figure 24. Selected CDT Name and Descriptor
DELETING CONNECTION DESCRIPTION TEMPLATES
To delete an existing CDT:
1.
2.
Select the CDT you wish to delete, and click
3.
A Warning box (Figure 25) appears, asking you to confirm the deletion. Click
.
to delete.
Figure 25. Delete CDT Warning Box
1-11
Workstation Basics
Rev 5.4
MULTI-NODE OPERATIONS
The Multi-Node Operations window (Figure 26) allows you to perform operations on more than one node
simultaneously. The Multi-Node function is available for the MCL Tool Network Interface node only. Three
steps are involved in this process: Selecting the Nodes, Selecting the Options, and Confirming Your Selections.
SELECTING THE NODE(S):
a.
Select a node from the Available Nodes window and Click
to add it to the Selected
Nodes window (Figure 27).
b.
Click
to move all available nodes to the Selected Nodes window.
c.
Click
to remove a node from the Selected Nodes window.
d.
Click
e.
If you wish to add all nodes of a particular device type (Figure 28), select one of the
to remove all nodes from the Selected Nodes window.
nodes from the Available Nodes window and click
1-12
.
Figure 26. Multi-Node Operations Window
Figure 27. Adding a Node
Figure 28. Adding All This Type
Figure 29. Select Options Window
Rev 5.4
Workstation Basics
SELECTING THE OPTIONS
a.
Click the
to open the Select Options window (Figure 29). Select the desired options
and click
to continue, or click
to return to the previous screen
CONFIRMING YOUR SELECTIONS
a.
MCL Tool displays the Confirm Selections window (Figure 30). If all the information shown in the
table is correct, click
b.
The Multi-Node Status window (Figure 31) will open, displaying the process and then providing
a
c.
.
message when the operation is successfully completed.
Should you wish to make changes, click the
Figure 30. Confirm Selections Window
to return to the previous screens.
Figure 31. Multi-Node Status Window
ROUTERS
A router (Figure 32) is a device that forwards information from one network/subnetwork to another using an
established protocol. Routers do not normally store messages that they are routing. Routers receive a message
and make a decision as to whether the message needs to be forwarded, and if so, to whom. You can also use
routers for network traffic control and for partitioning sections of the network traffic from traffic in other
sections, increasing the efficiency of your network.
A router may be one of four general types: bridge; repeater; configured; and a learning router.
•
A bridge router filters by domain ID only.
•
A repeater router forwards all messages, without any filter at all. It makes no decisions at all, it
simply receives a signal at one end, and broadcasts it out the other. It has limited capability to restore
weak signals to their former power level.
•
A configured router filters messages by domain, subnet, node, or group using configured tables
supplied by the network management tool.
•
A learning router also filters by domain subnet, node or group. The router starts out initially as a
bridge router, and increases the level of filtering as it learns the topology. Learning routers can fail if
configured devices are incorrectly moved within the network.
1-13
Workstation Basics
Rev 5.4
CONTROLLER NODES
Controller nodes (Figure 32) are hardware devices that actually perform a control or support function. These
devices are intelligent devices that can communicate with other devices on the LONWORKS network, using
LonTalk protocol over one or more communication channels (the path between devices). Each device has a
microprocessor that provides the intelligence, and implements the protocol. The device publishes information
specific to its application, and the protocol defines the format of the messages being sent and received. The
device uses a transceiver installed in the circuitry to electrically interface to the communication channel. All
devices connected to a specific channel must have compatible transceivers with compatible configuration.
Each controller node is configured with a Configuration Data Set (CDS). A CDS is a set of configuration
parameter values associated a particular device template. Third-party devices require a manufacturer plug-in
providing the CDS for the device. Each node pop-up menu has two different commands available for selecting
the CDS:
•
The user can select the default CDS or use any other CDSs that are available for that device with the
Setup Node command.
•
The Config. Data Set command allows the user to add a new CDS, or to apply an existing one.
Figure 32. Router Nodes
Figure 33. Controller Nodes
NODE POP-UP MENU COMMANDS
Right clicking on a node will bring up its pop-up menu. Different commands will be available depending on the
device specified for each node.
A brief explanation for available commands follows. For more detailed information, please see Section Three,
System Setup - Chapter Two.
•
Add – Gives you the option of adding of adding a node or router to your Physical Tree. You will also
select where you want the new node placed (Figure 34).
NOTE: An additional Add command is available only for routers. The command At End (Figure
35) places a device on the output of the router.
Figure 34. Add Node Pop-up Menu
1-14
Figure 35. Add Router Pop-up Menu With At End Command
Rev 5.4
•
Workstation Basics
Config. Data Set – Allows you to Add, Apply, Export, or Import Configuration Data Sets (CDS).
The Config. Data Set pop-up menu is shown below (Figure 36).
1. Add - Creates a new CDS file using the selected FSC or ASC.
2. Apply - Applies the selected CDS file to the selected FSC or ASC.
3. Export - Exports the config data of the selected FSC or ASC, to the selected hard drive directory.
Note: Exported config data sets must be imported into the CDS database before it can be applied.
4. Import - Imports previously exported device config data sets into the CDS database.
Note: You can’t import a CDS to a dissimilar device type. Attempting to do so will result in a Program ID mismatch error message.
• To Add a CDS, click Config. Data Set > Add. The Add CDS window opens (Figure 37),
displaying a list of device templates with their corresponding CDS. Click the appropriate item,
and click
.
• To Apply a CDS, click Config. Data Set > Apply. The Apply CDS window opens (Figure 38),
displaying a list of CDSs applicable to the selected node. Click the appropriate item, and click
. A prompt appears, warning you that the existing configuration parameters on the node
will be overwritten. Click
Figure 36. Config. Data Set Pop-up Menu
to proceed.
Figure 37. Add CDS Window
Figure 38. Apply CDS Window
1-15
Workstation Basics
Rev 5.4
•
To Export a CDS, click Config. Data Set > Export. The Export CDS window opens (Figure 39),
displaying a list of CDSs applicable to the selected node. Check the Current Device Configuration checkbox if
to export the CDS to the
you want to export the selected device. Rename the CDS if you want to. Click
selected directory. It must be imported into the CDS database before it can be applied to a device.
•
To Import a CDS into the CDS database so it can be applied later, click Config. Data Set > Import. The
Import CDS window opens (Figure 40), displaying a list of CDSs exports available for import. Rename the CDS if
to import the CDS into the selected directory.
you want to. Click
Figure 39. Export CDS Window
•
Figure 40. Import CDS Window
Configuration Wizard – Available only for controller nodes, this command opens the devicespecific Configuration Dialog box (Figure 41). Use the
available options for the device. Click
and
when done, or click
to select from
to exit without
making any changes.
NOTE: For further information on using the Node Configuration Wizards, please see the appropriate chapter in Section Three, System Setup.
Figure 41. Configuration Dialog Box
•
Figure 42. Connection Description Template List Window
Connection Template – Available only from the MCL Tool Network Interface node, this command
opens the Connection Description Template (CDT) List window (Figure 42), allowing you to Add,
Modify, or Delete items from this list.
NOTE: For more information, see the section on MCL Tool Network Interface - Connection
Description Templates in this chapter, and Section Four, Programming - Chapter One.
1-16
Rev 5.4
Workstation Basics
•
Decommission Node - Disassociates the node from its Neuron ID by removing it from the Database.
•
Delete – Allows you to delete the selected node.
•
Device Template - Available only from the MCL Tool Network Interface node, this command opens
the Device Templates window (Figure 43), allowing you to Add, Modify, or Delete items from this
list.
Figure 43. NNI Device Template Window
•
Edit - Available from the MCL Tool Network Interface and Router nodes, this command opens the
Editing: MCL Tool Network Interface window (Figure 44) or the Editing Router window (Figure
45), allowing you to make changes to the device parameters.
Figure 44. Editing: MCL Tool Network Interface Window
Figure 45. Editing Router Window
1-17
Workstation Basics
•
Rev 5.4
Edit/View Binding – Opens the Binding Editor (Figure 46) for that node, allowing you to view, Add,
or Delete bindings. For more information on binding network variables, Please see Section Four,
Programming - Chapter One.
Figure 46. Binding Editor
•
Load Firmware – Opens the Load Firmware dialog box (Figure 47), allowing you to select and load
additional firmware for the node device.
•
Move – Available for controller and router nodes, this command allows you to change the node’s
position on the physical tree (Figure 48).
Figure 47. Load Firmware Dialog Box
•
Figure 48. Move Menu Command
Node Commands – Commands the node to Wink, Offline/On-line, Reset, or Test. (Figure 49).
• The Wink command allows you to identify a node in the field by lighting the Wink led. This
command is available for ASCs only.
• The Offline command causes the node to go offline, stopping it from executing its application.
If the node is already offline, the command will be On-line, causing the node to go on-line and
execute its application.
• The Reset command causes the node to reset, returning to its original starting parameters.
1-18
Rev 5.4
Workstation Basics
• The Test command opens the Node Command Window (Figure 50), and verifies the Neuron
ID, Program ID, and node address of the selected node.
•
Figure 50. Node Command Test Window
Plug-In – The Plug-In menu command has two options: Run and Register (Register is available
only on the MCL Tool Network Interface node).
• Select Plug-In > Run (Figure 49). The Run Plug-In window (Figure 50) opens, showing all
available plug-ins for the node. Select the plug-in you wish to run, and click
Figure 51. Plug-In Run Menu Command
.
Figure 52. Run Plug-In Window
• The Register command is available on the MCL Tool Network Interface (Global) node only.
Select Plug-In > Register (Figure 53). The Plug-In Register window (Figure 54) opens,
showing all available plug-ins for the node, and their status. Select the plug-in you wish to
register, and click
.
NOTE: You can also use this window to Unregister a plug-in by selecting the plug-in and clicking
.
NOTE: Refer to the Metasys LN Series Plug-in Installation Quick Start Guide (LIT-1201982) for
information on registering and running the Metasys System LN Series device plug-ins.
1-19
Workstation Basics
Figure 53. Plug-In Register Command
•
Figure 54. Plug-In Register Window
Rename - Opens the Rename a Panel window (Figure 55). Enter the new name for the panel, and
click
•
Rev 5.4
.
Replace Node - Allows you to directly replace one node on the Physical Tree with another. When
selected, the Replace Node window (Figure 56) opens, allowing you to select another device by
Neuron ID and commission it.
Figure 55. Rename A Panel Window
Figure 56. Replace Node Window
•
Set Time/Date on Node – This menu command opens the Set Time/Date window (Figure 57) for the
selected node. Not available for router nodes, and not applicable to the MCL Tool Network Interface.
•
Set Time Provider – This command, available only on nodes capable of date/time processing, opens
the Set System Time Provider window (Figure 58), allowing you to change the system Time
Provider from one node to another.
Note: Setting an LN Series device as the time provider requires a binding change for proper
operation. Refer to the Readme.txt file for the LN Series device you want to use as a time
provider.
Figure 57. Set Time/Date On Node Window
•
1-20
Figure 58. Set System Time Provider Window
Setup Node – Used to commission nodes or routers added using the Add command, or to change
configuration parameters on commissioned nodes:
Rev 5.4
Workstation Basics
1. Click on this command to open the Node Setup window (Figure 59).
2. Use the
to select configuration options (Figure 60).
3. You can click
(Figure 61), and click
the node.
Figure 59. Node Setup Window
at this point, or click
again to the next window
from there to send the configuration parameters to
Figure 60. Window to Select Node Options
Figure 61. Complete Node Actions Window
1-21
Workstation Basics
•
Rev 5.4
Time Provider – Available only on the MCL Tool Network Interface node, this command opens the
Current System Time Provider window (Figure 62) allowing you to view or remove the current
time provider.
Figure 62. Current System Time Provider Window
POINTS
A node is a controller in the field, and the Physical Tree displays an element representing that device. Each
controller node on the Physical Tree can be expanded to display a list of its points and LMOs (Figure 63).
A Point is a single element of data in the system. Points can be:
•
Hardware (a physical point with an actual value)
•
Software (data bound in by software, often by a CPL program).
•
Analog or digital
•
Inputs (network variable inputs, or NVIs) or outputs (network variable outputs, or NVOs).
•
Points can be predefined on the device, as for ASCs, or can be set up by the User, as with FSCs and
FLCs.
Figure 63. Controller Node Points and LMOs
1-22
Rev 5.4
Workstation Basics
ADDING FSC/FLC POINTS
You must define the points for an FSC (Flexible System Controller) or FLC (Flexible Lighting Controller). The
procedure is identical for both devices. To add points to an FSC:
1.
Right click on the FSC Points subtree, and select Add (Figure 64).
2.
The Add FSC Point dialog box opens (Figure 65). Enter a name for the point, and use the drop down
lists to select values for the text fields.
3.
Click
to add the point.
Figure 64. Add FSC Point
Figure 65. Add FSC Point Window
EDITING FSC/FLC POINTS
1.
Click on the point you wish to edit.
2.
Select the Edit FSC Point working panel (Figure 66) to display the General screen.
Depending on the point type selected, there are a number of screens available inside the Edit FSC Point panel
for point configuration. Most are listed below:
General - The General screen displays the point’s settings.
Broadcast - Select the Max Send Time, Min Send Time, and for some points, the Min Delta or NV Update
Timeout time.
Value - Analog Points - Set the Valid Min value, Valid Max value, and for some points Cal offset value.
Alarm - Select the alarm type, alarm state, and alarm set time.
Alarm Limit - Sets High and Low values for Alarm State and Alarm Deadband. Sets Alarm Set Time.
Feedback - Select a digital point from a dropdown list, then set the Command Fail Time.
Actions - Select Direct or Reverse action, Normal Open or Normal Close, etc.
Digital Lockout - Analog Points - Select a digital point from a dropdown list, set a Lockout State, then set
the Lockout Time.
I/O Module - Sets the I/O module and point number for the point.
Broadcast Screen Detail
The Broadcast screen has a number of settings.
Name - This is the name the point will display in the Physical Tree.
1-23
Workstation Basics
Rev 5.4
Point Type - This can be set to any of the following point types:
DI
Software Multi. DI
Software DO
Momentary Output
Software AI
Software Multi. AI
Thermistor AI
Platinum 1K AI
Nickel 1K AI
0-5 V DC AI
0-10 V DC AI
Totalizer AI
Software AO
0-10 V DC AO
Floating Output
Security
Software Raw Input
Software Raw Output
SNVT Type - The SNVT type is based on the selected point type. All available SNVTs for the selected point
type are listed in the dropdown list.
Eng. Units - Engineerng units are based on the SNVT type selected. All available Engineering Unit types are
listed in the dropdown list.
FSC Point Number - The next unused point number is shown in the dropdown list. You can choose any point in
the available list.
Input NV Name - Shows the NVI name for the point. The NVI name consists of nvi, plus the selected FSC
point number, plus the selected Name. Example: nvi_007_Storage Area Temp would be the NVI name for FSC
point 7 of the point named Storage Are Temp. If the NVI Name is greyed out it means there is not a valid NVI
for that point type.
Output NV Name - Shows the NVO name for the point. The NVO name consists of nvo, plus the selected FSC
point number, plus the selected Name. Example: nvo_007_Storage Area Temp would be the NVO name for FSC
point 7 of the point named Storage Area Temp. If the NVO Name is greyed out it means there is not a valid
NVO for that point type.
I/O Module - Allows you to select any available I/O module to assign the point to.
I/O Point - Allows you to assign any available point from the selected I/O module.
Allow Multiple Adding - Allows you to add multiple points to the same FSC without leaving the menu.
1-24
Rev 5.4
3.
Enter the new values for the point, and click
Workstation Basics
.
Figure 66. Edit FSC Point Working Panel
DELETING FSC/FLC POINTS
1. Right click on the point you wish to delete (Figure 67).
2. The Delete FSC Point confirmation dialog box opens (Figure 68). Click
Figure 67. Delete FSC Point Menu Command
to accept.
Figure 68. Delete FSC Point Confirmation Box
1-25
Workstation Basics
Rev 5.4
LMOS (LONMARK OBJECTS)
LMOs ( LONMARK Objects) are a collection of network variables, configuration properties, and associated
behaviors defined by Echelon’s LONMARK functional profiles. These functional profiles, as well as the interface
to application programs, are implemented as LONMARK objects on individual devices (Figure 69).
LONMARK objects define standard formats and semantics for how information is exchanged between devices on a
network. Object definitions contain both mandatory and optional network variables and configuration properties,
and may also contain manufacturer-specific network variables and configuration properties.
Figure 69. Expanded LMOs Subtree
Figure 70. NVs List of NVOs And NVIs
NETWORK VARIABLES
Points consist of network variables (NVs). A network variable (NV) is a data item that a device uses to communicate with other devices on the network. Network variables are used in networked control systems because they
eliminate all of the low-level and tedious work of building and sending downlink messages, and receiving and
responding to uplink messages.
•
An NVI (network variable input) is a data item (NV) that the device expects to get from other
devices on the network.
•
An NVO (network variable output) is a data item (NV) that the device expects to provide to other
devices on the network. Use to communicate with one another.
The application specific to that device determines the types, functions, and number of network variables in each
node. Expand the NV to view its NVOs and NVIs (Figure 70).
Figure 71. Binding Editor
1-26
Rev 5.4
Workstation Basics
BINDING: CONNECTING NVOs TO NVIs
Binding is a process that configures the device firmware to know the logical address of the other devices that it
will be sending NVO data to and receiving NVI data from. A bind, also referred to as a connection, creates
logical connections between the NVO of the selected device to the NVI of the other device(s) on the network it
is communicating with. Binding is handled through the Binding Editor (Figure 71). For more information on
Binding, please see Section Four, Programming - Chapter One.
MCL Tool uses the Connection Description Template (CDT) to define the parameters of a bind. The CDT will
include information on what sort of addressing and message service type it should use, timing parameters, use of
authentication and priority slots, etc. Please see MCL Tool Network Interface - Connection Description
Templates in this chapter for more information on CDTs.
CONFIGURATION PROPERTIES
When a network variable (NV) is expanded (Figure 72), it displays the list of its configuration properties (CPs).
Configuration properties are data values used to modify the operation of a device or LONMARK object. They may
belong to a device, a LONMARK object, or a NV (Network Variable). Configuration properties may be implemented using configuration network variables, a configuration file, or in a direct memory access data block.
There are two types of configuration property types: Standard Configuration Property Types (SCPTs, called
“skip-its), and User-defined Configured Property Types (UCPTs, called “you-keep-its). UCPTs are generally
given a descriptive name by the User.
Figure 72. NV List of Configuration Properties
POINT, LMO, NV, AND CP WORKING PANELS
The Detail and Status/Command working panels are used for viewing and commanding values on Points,
LMOs, NVs, and CPs. An FSC node has additional panels available for scheduling and CPL pages
The Detail panel displays a listing of all the items contained in the Points, LMO, NV, or CP subtree. A Detail
working panel is also available for each individual item in the subtree.
The Status/Command working panel allows you to adjust the value (command) of the item, and also to monitor
the status of the item. MCL Tool features two types of Status/Command working panels, one for use with Points,
and the other for use with LMOs, CPs, and NVs.
To view and/or command a single item:
1.
Click on the item you wish to access.
2.
The Detail and Status/Command panels display. Click on the tab of the window you wish to open
(Figure 73):
1-27
Workstation Basics
Rev 5.4
• Detail Working Panel - Displays information about the selected item. If you select one of the
node subtree headings (Points, LMOs, NVs, CPs), the Details working panel provides a listing
of all the items contained in that subtree (Figure 74). If you select a single item under one of
these subtrees, the panel displays information particular to that item (Figure 75).
Figure 73. Panel Tabs
Figure 74. Points Subtree Detail Panel
Figure 75. Detail Working Panel
•
LMOs, NVs, and CPs Status/Command Working Panel – This panel (Figure 76) is available only
for single items selected under the LMOs, NVs, and CPs subtrees.
• To request the current Status, click
located on the bottom of the window.
The button LEDs will display green as the device in the field is being polled.
• To Command a value, enter the value(s) in the appropriate text field, and click
located at the bottom of the window.
1-28
Rev 5.4
Workstation Basics
NOTE: If the Command button is grayed out (Figure 77), the item can not be commanded. Not all
items can be commanded e.g., NVIs are command-able, but NVOs are not.
Figure 76. Status/Command Working Panel
•
Figure 77. Status/Command Working Panel
Points Status/Command Working Panel – This panel (Figure 77) is available only for individual
points.
The Status/Command Window features five command buttons:
Fix - Locks the value entered in the Command text field (Figure 78) until released by
the Release button. Point value is removed from automatic control.
Release - Releases the value from the Fix command, and returns the point value to
automatic control.
Set - Sets the point value as specified in the Command text field. Value can be overrode by automatic control.
Reset - Resets the priority level of the point back to zero, allowing the network to
transmit and receiver higher priority messages as needed (normal state).
Get Status - Gets the current status (value) of the point, and displays it in
the Status text field (Figure 79). When the button is selected, the LEDs turn green, indicating
that the field device is being polled.
Figure 78. Command Text Field
Figure 79. Status Text Field
The Point Status LED Panel (Figure 80) has three LEDs to indicate the state of the point:
• Point Fixed - Selected point is ”locked” to the entered value. Disables automatic control.
• Point in Hand Mode - Point is controlled by a manual “hand” switch on either the
4DO/4AO or 8DO I/O module. Disables all system control.
• Point In Alarm - Selected point is in an alarm condition.
Figure 80. Point Status LED Panel
1-29
Workstation Basics
3.
Rev 5.4
Command the values for your point using the buttons explained in Step 2. View the current status of
the point by selecting the Get Status button.
An additional working panel is available for FSC Points only:
•
Edit FSC Point - Allows you to change values for a Point on the FSC Node. Please see Editing
FSC/FLC Points previously covered in this chapter.
ADDITIONAL FSC SUBTREES
An FSC node contains two additional subtrees in addition to the Points and LMOs subtrees; CPL Pages and
Schedules (Figure 81):
•
The CPL Pages subtree allows you to add CPL pages and create new pages from the CPL Library.
•
The Schedules subtree allows you to create new schedules, or modify an existing one.
Figure 81. CPL Pages And Schedules Nodes
CPL PAGES
When you select the CPL Pages node, the CPL Page List (Figure 82) working panel opens to the right of the
Physical Tree. The panel lists all existing CPL Pages that you can select from. You can also click
on the
node, and the same pages will be listed below the main subtree.
NOTE: For more information on CPL (Control Programming Language), please see Section
Four, Programming.
Figure 82. CPL Page List
Figure 83. CPL Pages Pop-up Menu
Right click on the CPL Pages node to open the pop-up menu (Figure 83). MCL Tool gives you three commands:
•
Add –This command adds a new CPL page. When selected, the Add CPL Page window opens
(Figure 84). Type in the name of your new page, and click
node and CPL Page List.
1-30
. The page will be added to the
•
Refresh - Select Refresh to update the node with any changes occuring since the last Refresh.
•
Create Page From Library - This command adds a page from the CPL Library to your CPL Page
List. To add a CPL Library Page:
Rev 5.4
Workstation Basics
1. Select the Create Page from Library command from the pop-up menu.
2. The Create Page from Library Window opens (Figure 85). Select the page you would like to
add, and click
Figure 84. Add CPL Page Window
. The page will be added to the node and CPL Page List.
Figure 85. Create Page From Library Window
When you select one of the pages listed under the CPL Pages node, the CPL Editor panel (Figure 86) opens to
the right of the Physical Tree, replacing the CPL Page List . Using the CPL Editor, you can create, edit, and
monitor CPL programs. Please see Section Four, Programming - Chapter Two for further information.
Figure 86. CPL Editor Panel
The individual CPL Pages also have a pop-up menu (Figure 87), with five commands:
•
Enable/Disable – The Enable command allows the page to begin operating. The page must be
enabled to view values while in Monitor Mode. The Disable command replaces Enable as a menu
command when the page is currently enabled.
•
Rename – This command allows you to rename your CPL Page. When selected:
1. The Rename Page window opens (Figure 88).
2. Enter your new page name in the text field, and click
•
.
Copy to Library – This command copies the selected CPL Page from the FSC to your CPL Library.
When this command is selected:
1-31
Workstation Basics
Rev 5.4
1.
The Copy Page To Library window (Figure 89) opens.
2.
Select the desired file path, and enter a name for your page in the Page Name text field. Click
.
•
Copy to FSC - Copies the selected page to another FSC node. When selected:
1. The Copy Page To FSC window (Figure 84) opens.
2. Selected the desired FSC to copy to and click
•
.
Delete – This command will delete the selected CPL Page. When selected:
1. A Warning dialog box appears (Figure 91) asking you to confirm your action.
Figure 87. CPL Pages Pop-Up Menu
Figure 88. CPL Rename Page Window
Figure 89. CPL Copy Page to Library Window
Figure 90. CPL Copy Page to FSC Window
Figure 91. Warning Dialog Box
SCHEDULES
Scheduling allows you to design and implement a customized on/off control program, designed for use on
specific days, seasons, or other criteria.
NOTE: For more information on Scheduling, please see Section Four, Programming - Chapter
Four.
1-32
Rev 5.4
Workstation Basics
There are two types of data concerning the Schedule information:
•
The Summary Schedule List (Figure 92) contains the listing of all the individual schedules on a
given panel. The Schedule list provides a systematic control over the schedules. From the list of
schedules, new schedules can be added and old schedules deleted.
•
The second source of data is the actual schedule(s). The individual schedules have day/time entries.
There are MCLT data sources defined to handle this information.
The Schedules pop-up menu (Figure 93) has two commands: Add and Refresh.
•
Add – Allows you to create new CPL schedules. When this command is selected:
1. The Add CPL Schedule window (Figure 94) opens. Enter the name of your new schedule in
the Name text field, and click
.
2. Select Refresh from the pop-menu to update the Summary Schedule List.
To enter the values for a new schedule:
1. Select the schedule. The FSC Schedule window (Figure 95) opens on the right.
2. Enter the desired values and click
•
and then
.
Refresh – Requests the LNServer database for the most current CPL and/or Schedule information.
You should Refresh each time you use the Enable, Disable, and Copy to FSC commands.
Figure 92. Summary Schedule List
Figure 94. Add CPL Schedule Window
Figure 93. Schedules Pop-up Menu
Figure 95. FSC Schedules Window
1-33
Workstation Basics
Rev 5.4
The individual schedules also have a pop-up menu (Figure 96), with three commands:
•
Rename – This command allows you to rename your schedule. When selected:
1. The Rename CPL Schedule window opens (Figure 97).
2. Enter your new schedule name in the text field, and click
•
.
Delete – This command will delete the selected schedule. When selected:
1. A Warning dialog box appears (Figure 98) asking you to confirm your action.
•
Copy to FSC - Copies the selected schedule to another FSC node on the network. When selected:
1. The Copy Schedule To FSC window (Figure 99) opens.
2. Selected the desired FSC to copy to and click
1-34
.
Figure 96. Schedule Pop-Up Menu
Figure 97. Rename CPL Schedule Window
Figure 98. Warning Dialog Box
Figure 99. Copy Schedule to FSC Window
Rev 5.4
Workstation Basics
NODE WORKING PANELS
The MCL Tool Node Working Panels (Figure 100) allow the User to view data on a node selected on the
Physical Tree. Each device type (VAV, FSC, PEC, etc.) has a specific set of working panels available to the User.
The Working Panels provide information on the selected node, enter values for the node, set up and monitor
trending schedules, command points, view data graphically, etc.
To view the working panels for each device on your network:
1.
Select the device from the Physical Tree on the left.
2.
The available working panels for that device appear on the right of the screen. Click on the tab
(Figure 101) of the panel you wish to view.
NOTE: Use the scroll bars at the bottom and right side of the panel to view all the information. Be
sure that the panel window is large enough to display any data on the bottom part of the
window.
Figure 100. MCLT Working Panels
Figure 101. Tabs Of Available Working Panels
Figure 102. Detail Panel
1-35
Workstation Basics
Rev 5.4
DETAIL PANEL
The Detail Panel (Figure 102) allows you to query MCL Tool for detailed information on the node. To query
MCL Tool:
1.
Select the node you wish to query from the Physical Tree.
2.
On the Detail Panel, use the mouse pointer to check the boxes of the queries (Figure 103) you would
like to make, and then click
3.
.
The taskbar at the bottom on the screen briefly displays the query progress. When MCL Tool
is finished accessing the information, it is displayed in the right window.
Figure 103. Query Info. Options
Figure 104. FSC Query Info. Options
QUERY OPTIONS
The Query Options available (Figure 103) are:
•
Query Status: This query gives you information on node activity. This includes the amount of xmit
(transmit) errors, lost and missed messages, the error log, model and version number, etc.
•
Reset Status: This query resets the node to the original parameters. The reset status is also noted in
the right window.
•
Program ID/Neuron ID: This query will list the program and neuron IDs.
•
Hardware/Software Revision: This query gives you the names of the hardware and software
revisions currently installed on the node.
NOTE: Different device types may not have all Query options available
An FSC node will have four additional queries available (Figure 104):
1-36
•
I/O Module: The query lists the I/O Modules that are defined, and the type that are responding.
•
CPU Statistics: This query is used to display up-to-date statistics on the CPU itself, including the
amounts of available RAM, NVS RAM, and Flash memory.
•
CPL: This query lists all the CPL Pages residing on the node, and their current state (enabled or
disabled).
Rev 5.4
Workstation Basics
TREND SETUP PANEL
The Trend Setup Panel (Figure 105) is used to declare trending. The panel is actually a configuration screen, and
allows you to set up your trend to perform a variety of functions. When a trend has been configured, MCL Tool
initiates the trending function as soon as the selected controller begins running. The results of the Trend Setup
are displayed in the Trend Harvest Panel section immediately following.
NOTE: Trending data for ASCs is stored in their internal volatile memory, and is not preserved
across a power loss or other conditions. If the data is critical, then it should be transferred to
the FSC or other means of permanent storage.
Figure 105. Trend Setup Panel
You can select from three types of trending: Interval, Delta, or a Hybrid of these two.
Interval Trending: Interval Trending has its primary emphasis in logging data on a time interval basis, and is
very useful for determining system timing. MCLT logs the data you have requested at the configured time
interval whether or not the data has changed, and results in a very equally spaced graph of data points (see Trend
Harvest Panel).
Delta Trending: Delta Trending has its emphasis in the change of an analog point. Use Delta Trending when
you wish to trend a temperature for an extended period of time, but are interested only in a certain increment of
change. Stable data can be stored for long periods of time. Delta Trending is often used for tracking space
temperature changes during both occupied and unoccupied modes. It results in a Trend Harvest Panel graph of
unequally spaced data, with little detail of what happened between changes (see Trend Harvest Panel following
this section).
Hybrid Trending: You can use a mix of both Interval and Delta Trending in any way desired. A trend can be
declared that gathers data at a specified interval, and at a specified delta. Hybrid Trending provides a middle
ground between the two strategies, and is used when you want periodic data gathered, but also want to note
changes.
TREND DURING OCCUPANCY
This mechanism is based on the status of a digital point. The Trend During Occupancy option (Figure 106)
allows the controller to disable trending when activity is not of interest to the controller.
•
The ASCs will allow Occupancy to be the only digital value for trending enable/disable. When this
option is selected, the ASC will trend when the controller is Occupied, and not trend when the
controller is Unoccupied.
•
The FSC will allow trending to occur on any digital point value that exists locally on the controller
(Figure 107). The status of this digital point can be determined on a different controller, but that point
must be mapped to the FSC selected and bound between the controllers. The FSC will trend when the
selected state is True. If Trend during occupancy is selected, the controller trends only when the
selected State is true and the mode is Occupied.
1-37
Workstation Basics
Rev 5.4
Figure 106. Trend During Occupancy Option Figure 107. FSC Trend Enable/Disable Options
SAMPLING
A sample is the data gathered on a point at the specified interval/delta. A finite amount of samples is available in
the buffer for each node. Each point to be sampled is assigned a trend channel. The number of trend channel
available is device dependent. You can designate how many samples you want allocated to each trend channel if
you are sampling multiple points. If you are only sampling one point per node, the entire sample amount will
default to that point. The memory allocation is as follows:
ASCs
•
Number of Trend Channels = 6
•
Total Number of Samples = 880
FSCs
•
Number of Trend Channels = 100
•
Total Number of Samples = 5000
TREND SETUP FOR ASCS
To configure an Interval trend:
1.
Select the Point you wish to trend from the drop-down list (Figure 108).
2.
Left click on the Interval check box (Figure 109). A check will appear, and the Hours and Minutes
fields will become active.
3.
Enter the time in hours and minutes of the interval you wish to use.
4.
If you have selected more than one point for trending, enter the amount of samples you are allocating
to this point in the Samples field. The remaining amount of samples available for allocation is shown
underneath the field (Figure 110)
5.
Select
.
Figure 108. Point Drop-Down List
Figure 110. Remaining Samples
1-38
Figure 109. Interval Check Box
Figure 111. Delta Trend Check Box
Rev 5.4
Workstation Basics
To configure a Delta trend:
6.
Select the Point you wish to trend from the drop-down list (Figure 108).
7.
Left click on the Delta check box (Figure 111). A check will appear, and the field to the right will
become active.
8.
Enter in the field to the right the amount of Delta you wish to trend on.
9.
If you choose to enable the point, left click on the Enable Point check box.
TREND SETUP FOR FSCS
MCL Tool provides several features for trending on FSCs that are not available on ASCs:
•
The FSC will allow trending to occur on any digital point value that exists locally on the controller.
The status of this digital point can be determined on a different controller, but that point must be
mapped to the FSC selected and bound between the controllers (see Enable on Digital, above).
•
A start and stop time interval can be provided in the configuration data for the trend channel. This
time interval determines when the trending is enabled (greater than or equal to the first time) and
disabled (greater than or equal to the second time). The time can wrap around midnight (for example,
it can be enabled at 7:00 PM and disabled at 7:30 am).
The Trend Setup Panel for the FSC is configured in the manner as for ASCs, with the addition of the Time Based
Start and Stop fields, and Enable Point State field.
To configure a Time Based trend:
1.
Left click on the Time Based check box (Figure 112). A check will appear, and the Start and Stop
fields will become active.
2.
Enter the time in hours and minutes that you would like the trending to Start.
3.
Enter the time in hours and minutes that you would like the trending to Stop.
Figure 112. Time Based Check Box
Figure 113. Enable Point Check Box
1-39
Workstation Basics
Rev 5.4
To configure a digital Enable Point value and State trend:
1.
Left click on the Enable Point check box (Figure 113). A check will appear, and the Enable Point and
State drop-down lists will become active.
2.
Use the arrow to select the point that you wish the trending to occur on from the Enable Point dropdown list.
3.
Use the arrow to select the point that you wish the trending to occur on from the State drop-down list.
TREND HARVEST PANEL
The Trend Harvest Panel (Figure 114) displays a live graphical representation of the Trending set up by the
Trend Setup Panel. The Trend Harvest Panel consists of three windows: the Trend Point List Window, the
Trend Samples Window, and the Trend Harvest Graph Window. Each window provides the User with
information on a selected point. The Trend Harvest Panel uses the Harvest button to gather data.
Figure 114. Trend Harvest Panel
Figure 115. Trend Point List Window
TREND CHANNELS WINDOW
The Trend Point List window (Figure 115), located in the upper left corner of the panel, displays the channel
number, point number, and the name of the points that have been set up in the Trend Setup panel. The trending
can be viewed in Controller Time or PC Time (Figure 116). These radio buttons are located at the bottom of
the Trend Channels window.
NOTE: The Controller Time will be the time entered using the node drop-down menu Set Time/
Date on Node command.
Figure 116. Clock Selection
1-40
Figure 117. Trend Samples Window
Rev 5.4
Workstation Basics
TREND SAMPLES WINDOW
The Trend Samples window (Figure 117), located in the lower half of the panel, displays the “raw data” of the
samples being taken for the trend. The User can view the channel number, the name of the point, the value of the
point and the engineering unit (Eng. Unit) used, and the date and time of the sample.
Figure 118. Trend Harvest Graph Window
TREND HARVEST GRAPH WINDOW
The Trend Harvest Graph window (Figure 118), located on the upper right side of the panel, is a graphical
version of the data displayed in the Trend Sample window:
•
The X axis of the graph (Figure 119) shows the time and date of the samples being taken.
•
The Y axis of the graph (Figure 120) indicates the value of each point on the line, and the Engineering Unit that the value is calculated in.
Figure 119. Graph X Axis
Figure 120. Graph Y Axis
The User can select any of nine different modes (Figure 121) for viewing the graphed data. The name of the
selected point is displayed directly below the Modes listings.
Figure 121. Trend Harvest Graph Viewing Modes
1-41
Workstation Basics
Figure 122. Graphed Trend Data Line
Rev 5.4
Figure 123. Plot Mode
To select a viewing mode, click on the mode, and then click and hold the mouse pointer on the graphed trend
data line (Figure 122) to move the axes as indicated by the mode function:
•
Plot Mode (Figure 123) activates the graph to begin displaying the data. This is the default mode for
the graph. Select this mode to exit from the other modes, and return to the original display.
NOTE: This mode can only be selected and un-selected. Moving the graphed trend data with the
mouse pointer has no effect.
•
The Scroll X, Scroll Y, and Scroll XY modes (Figure 124) allow the user to move along the axis/
axes as needed.
1. Move the trend data is the direction desired. The selected axis will scroll in the same direction.
•
The Zoom X, Zoom Y, and Zoom XY modes (Figure 125) allow the user to zoom in on graphed data
using the axis/axes as needed.
•
The Cursor option displays data for a single point on the selected graph data line:
1. Move the trend data is the direction desired. The selected axis will scroll in the same direction
1. Select the Cursor option. A vertical cursor the length of the Y axis is displayed on the graph
(Figure 126).
2. Click and drag the cursor along the graph line. The Cursor Mode at the top of the graph
displays the X:Y values for the point on the graph where the cursor rests (Figure 127).
NOTE: If, after using the Zoom mode you cannot drag the cursor to a desired point, you may
need to return to the default graph (by selecting Plot mode) and resize with less Zoom.
Figure 124. Scroll Modes
Figure 125. Zoom Modes
Figure 126. Vertical Cursor
Figure 127. Cursor Point Data Readout
•
Clicking the Zoom Box option (Figure 128) allows you to use the mouse cursor to draw a box
around the part of the display (Figure 129) you would like to see more closely:
1. Click the Zoom Box option at the top of the graph.
2. Hold down the left mouse key as you draw a box around the part of the graph desired.
3. Release the left mouse key and the graph automatically resizes to the defined area.
1-42
Rev 5.4
Figure 128. Zoom Box
Workstation Basics
Figure 129. Zoom Box Drawn On Graph
THE HARVEST BUTTON
The Harvest button (Figure 130) gathers and displays the trend information currently selected in the Trend
Setup Panel. When the Harvest button is selected, it clears the panel of previous data, and then updates each subwindow with the selected trend data.
Figure 130. Harvest Button
Figure 131. Trend Data Status Message
Figure 132. Harvest Completed Message
TO VIEW TRENDING DATA:
1.
Click
. The panel taskbar displays a status message (Figure 131). When all harvesting
has been completed the panel taskbar displays a Done message (Figure 132).
2.
Use the mouse pointer to select the channel you wish to view. The sampling interval selected begins
at this moment.
3.
The Trend Sample displays the value of each sample as it is taken. It will continue until all the
samples have been taken.
NOTE: A complete interval must pass before a trend sample can be displayed in either the Trend
Sample Window or the Trend Harvest Graph.
4.
As the interval is completed, the Trend Harvest Graph begins graphing the trend data.
1-43
Workstation Basics
Rev 5.4
THE EXPORT BUTTON
The Export button (Figure 133), exports selected trend data to a .CSV (Comma Separated Variable) file. The
CSV file can then be used in word processing or spreadsheet programs. You can export just one channel, or all
channels.
Figure 133. Trend Export Screen 1
TO EXPORT TREND DATA:
1.
Click
. The CSV Export screen displays (Figure 134).
2.
Enter a name for the CSV file (Figure 135). Browse to another directory if needed. Click
to save the file.
1-44
Rev 5.4
Workstation Basics
ASG (APPLICATION SPECIFIC GRAPHICS) PANEL
The ASG Panel (Figure 136) displays specific controller status information for the selected node. Each controller device type has a specific ASG Panel.
NOTE: The ASG panel is available only for ASCs (Application Specific Controllers).
The ASG panel consists of Occupancy Mode in the upper left section of the window, a Line Graph (s) on the
right, and Controller Response Data in the lower half of the window.. Each device type has a specific set of
points that are displayed. The User can also adjust the Occupied User Setpoint from this panel.
Figure 136. ASG Panel
OCCUPANCY MODES
The Occupancy section of the ASG Panel displays data for each of the Occupancy Modes: Occupied, Unoccupied, and Economy.
OCCUPIED
The Occupied mode (Figure 137) displays a slidebar for adjusting the User setpoint (Figure 138), and live
values for the Cooling (Cooling SPT), Heating (Heating SPT), and User (User SPT) setpoints. The User SPT
value is the value set using the slidebar.
Figure 137. Occupied Mode
Figure 138. User Setpoint Slidebar
To change the User SPT (Setpoint) from this panel:
1.
Use the mouse pointer to drag the indicator arrow of the User SPT Slidebar (Figure 139) to the
desired temperature.
2.
Verify the exact temperature setting from the User SPT text box to the right of the gauge.
1-45
Workstation Basics
Rev 5.4
UNOCCUPIED
The Unoccupied Mode displays the Heating (HTG) and Cooling (CLG) Setpoints for this mode (Figure 139).
ECONOMY
The Economy Mode displays the Heating (HTG) and Cooling (CLG) Setpoints for this mode (Figure 140).
Figure 139. Unoccupied Mode
Figure 140. Economy Mode
CONTROLLER STATUS DATA
The Controller Status Data section (Figure 141) displays device-specific status information. Included can be
configuration data, occupancy mode, reheat stages, the status of fans, dampers, thermal load, heating and cooling
outputs, etc.
The Controller Status Data is automatically updated each time the node and/or ASG Panel is selected (Figure
142).
Figure 141. Controller Status Data
Figure 142. Controller Status Data Updating
1-46
Rev 5.4
Workstation Basics
LINE GRAPH
The ASG Line Graph (Figure 143) is a graphical representation of data displayed on the ASG Panel. The Line
Graph may have several graphs available, depending on the device (Figure 144).
To select a graph:
1.
Click on the name of the graph displayed on the window tab in the upper left corner of the graph. The
graph will be brought to the foreground.
Figure 143. ASG Line Graph
Figure 144. ASG Graphs Available
•
The X-axis of the graph (Figure 145) represents the number of samples being taken.
•
The Y-axis of the graph (Figure 146) indicates the value of each point on the line, and the Engineering Unit that the value is calculated in.
Figure 145. ASG Graph X-Axis
Figure 146. ASG Graph Y-Axis
The ASG graph uses a color-coded legend (Figure 147) to differentiate between graph data lines. By matching
the color of the data lines to the legend, the User can view multiple readings at one time (Figure 148).
Figure 147. ASG Graph Legend
Figure 148. ASG Graph Data Lines With Legend
The User can select any of nine different modes (Figure 149) for viewing the graphed data. To select a viewing
mode, click on the mode desired:
•
Plot Mode (Figure 151) activates the graph to begin displaying the data. This is the default mode for
the graph. Select this mode to exit from the other modes, and return to the default display.
NOTE: Plot mode can only be selected and unselected.
1-47
Workstation Basics
Rev 5.4
Figure 149. ASG Graph Viewing Modes
Figure 150. Plot Mode
•
The Scroll X, Scroll Y, and Scroll XY modes (Figure 151) allow the user to move
along the graph axis/axes as needed.
1. Move the data is the direction desired. The selected axis will scroll in the same direction.
•
The Zoom X, Zoom Y, and Zoom XY modes (Figure 152) allow the user to zoom in on graphed data
using the axis/axes as needed.
1. Move the data is the direction desired. The selected axis will scroll in the same direction.
Figure 148. Scroll Modes
•
Figure 149. Zoom Modes
The Cursor option displays data for a single point on the selected graph data line:
1. Select the Cursor option. A vertical cursor the length of the Y axis is displayed on the graph
(Figure 150).
2. Select the data line you wish to examine from the graph legend. The selected line will appear
highlighted (Figure 151).
3. Click and drag the cursor along the graph line. The Cursor Mode at the top of the graph
displays the X:Y values for the point on the graph where the cursor rests (Figure 152).
NOTE: If, after using the Zoom mode you cannot drag the cursor to a desired point, you may
need to return to the default graph (by selecting Plot mode) and resize with less Zoom.
Figure 150. Vertical Cursor
Figure 151. Highlighted Selection
Figure 152. Cursor Point Data Readout
1-48
Rev 5.4
•
Workstation Basics
Clicking the Zoom Box option (Figure 153) allows you to use the mouse cursor to draw a box
around the part of the display (Figure 154) you would like to see more closely:
1. Click the Zoom Box option at the top of the graph.
2. Hold down the left mouse key as you draw a box around the part of the graph desired.
3. Release the left mouse key and the graph automatically resizes to the defined area.
Figure 153. Zoom Box
Figure 154. Zoom Box Drawn On Graph
1-49
Workstation Basics
1-50
Rev 5.4
Rev 5.4
Operations Index
Operations Index
C
Configuration Data Set 1-14
Add 1-15
Apply 1-15
Export 1-15
Import 1-15
Adding A Connection Description Template
(CDT) 1-9
Adding A New CDT 1-9
Addressing
Types 1-8
Deleting 1-11
Entering Values 1-10
Addressing 1-10
Other 1-10
Service Types 1-10
Timing Parameters 1-10
Connection Description Templates (CDT)
Deleting An Existing CDT 1-11
Modifying An Existing CDT 1-11
Controller Nodes 1-14
Decommission Node Command 1-17
Pop-up Menu Commands 1-14
Working Panels
Detail Panel 1-27
LMOs, NVs, and CPs Status/Command
Working Panel 1-28
Points Status/Command Working Panel 129
CPL Pages 1-30
Add 1-30
CPL Library
Create Page From Library 1-30
Menu Commands 1-31
Refresh 1-30
Query Options 1-36
FSC Subtrees 1-30
Schedules 1-32
FSC/FLC
Adding FSC/FLC Points 1-23
Deleting FSC/FLC Points 1-25
Editing FSC/FLC Points 1-23
H
Help (Online) 1-4
M
MCL Tool
Licensing 1-8
MCL Tool Network Interface 1-6
Editing 1-7
Editor Options 1-7
MCL Tool Network Interface Node
Accessing the CDT 1-8
CDT Addressing 1-8
Editing Options 1-7
Editing the MCL Tool Network Interface 1-7
Multi-Node Operations 1-12
MCLT Main Window
Menu Bar 1-3
Help Menu 1-4
MCLT Menu 1-3
View Menu 1-4
Node Working Panels 1-35
Overview 1-2
Tool Bar 1-5
Buttons 1-5
Multi-Node Operations
Selecting The Node 1-12
Selecting The Options 1-13
F
FSC
CPL Pages 1-30
Detail Panel
I-1
Operations Index
N
Network Variables
Binding NVs 1-27
Node Working Panels 1-35
Detail Panel 1-36
Query Options 1-36
P
Physical Tree 1-6
Configuration Properties 1-27
Controller Nodes 1-14
Node Pop-up Menus 1-17
Setup Node 1-20
LMOs 1-26
Lon Mark Object (LMO) 1-26
Network Variables 1-26
NexSys Network Interface Node 1-6
Points 1-22
Routers 1-13
Points
Adding FSC/FLC Points 1-23
Deleting FSC/FLC Points 1-25
Detail Panel 1-28
Editing FSC/FLC Points 1-23
Status/Command Panels 1-28
Working Panels 1-27
R
Routers 1-13
Add At End Command 1-14
Configuration Data Sets 1-14
Types of Routers 1-13
S
Schedules 1-32
Add 1-33
Copy To FSC 1-34
Delete 1-34
Rename 1-34
Status Command Function
Status Command Window
Point Status LED Panel 1-29
I-2
Status Command Window
Fix Button 1-29
Release Button 1-29
Reset Button 1-29
Set Button 1-29
T
Trend Setup Panel 1-37
Trending 1-37
Export Button 1-44
Harvest Button 1-43
Types Of Trending 1-37
Rev 5.4
MCL TOOL 5.4 - SECTION SIX
APPENDICES
Appendices
A. Standard Network Variable Types (SNVT)
B. Glossary
C. MCL Tool Architecture
D. LNServer
E. M3/M5/MCL Tool 5.4 System Architecture
F. Error List
G. Database Print
H. CPL Program Examples
Appendices Introduction
Rev 5.4
Echelon ®, Coactive®, and Windows® are registered trademarks and service marks of companies other than
Johnson Controls, Inc. FSC™, CPL™, NexSys® and MCL Tool™ are trademarks of Johnson Controls, Inc.
All Rights Reserved
Published in U.S.A.
A-2
Section 6 - Appendices
Rev 5.4
Appendices Table of Contents
Appendix
ndix A - Standard Network Variable Types
A-1
SNVTss .........................................................................................................................
............................................................................................................................... A-2
Digital SNVTs ...................................................................................................
......................................................................................................... A-2
...................................................................................... A-6
Analog Points And SNVTs ................................................................................
Appendix
ndix B - Glossary
B-1
Glossary
ry ......................................................................................................................
............................................................................................................................ B-2
Appendix
ndix C - MCL Tool Architecture
C-1
Overview
verview
iew Of MCL Tool And LNS Architecture ...................................................................C-2
.............................................................
MCL Tool Software .................................................................................................C-2
...........................................................................................
MCLT ...........................................................................................................C-2
.....................................................................................................
LNServer ......................................................................................................C-3
................................................................................................
LNS 3.0 Architecture ..............................................................................................C-3
........................................................................................
LCA Object Server ActiveX Control .............................................................C-3
.......................................................
Network Services Server (NSS) ..................................................................C-3
............................................................
Network Services Interface (NSI) ................................................................C-3
..........................................................
Example Of MCL Tool Software Interaction ............................................................C-3
......................................................
Appendix
ppendix
ndix D - LNServer
D-1
Overview
verview
iew Of LNServer ......................................................................................................D-2
................................................................................................
Starting LNServer ...................................................................................................D-2
.............................................................................................
Title Bar .......................................................................................................D-3
.................................................................................................
Menu Bar .....................................................................................................D-3
...............................................................................................
User Connection Window ............................................................................D-3
......................................................................
LNServer Messages Window .......................................................................D-4
.................................................................
UI Activity Window .......................................................................................D-4
.................................................................................
Tree Poll Thread Window .............................................................................D-4
.......................................................................
System Status Window ................................................................................D-5
..........................................................................
Exiting LNServer .....................................................................................................D-5
...............................................................................................
Appendix
ppendix
ndix E - M3/M5/MCL Tool System Architecture
E-1
Overview
verview
iew .....................................................................................................................
........................................................................................................................... E-2
Configuration Tools .................................................................................................
...........................................................................................
E-2
Support for LonMark Compliant Field Controllers ..................................................
E-2
............................................
System Requirements ............................................................................................
E-3
......................................................................................
Operating System Support Requirements ...................................................
E-3
.............................................
Computer Requirements ..............................................................................
E-3
........................................................................
Compatibility and Support ......................................................................................
E-3
................................................................................
OPC Servers ................................................................................................
E-3
..........................................................................................
Alarm Message Management ......................................................................
E-3
................................................................
Trending .......................................................................................................
E-3
.................................................................................................
Support for Additional M3/M5 Component Applications ..............................
E-4
........................
M3 and M5 Workstation ..........................................................................................
E-4
....................................................................................
MCL Tool Software .................................................................................................
E-4
...........................................................................................
MCLT ...........................................................................................................
E-4
.....................................................................................................
LNServer ...................................................................................................... E-4
LNS 3.0 Architecture .............................................................................................. E-4
OPC LonWorks Server ........................................................................................... E-4
A-3
Appendix F - Error Messages
Rev 5.4
F-1
Overview
iew
ew ........................................................................................................................... F-2
MCLT Communication Errors .................................................................................. F-2
General Errors ........................................................................................................ F-3
Binding
g Errors ................................................................................................................... F-5
Appendix
ndix G - Database Print
G-1
Overview
iew Of Database Print ............................................................................................. G-2
Viewing Database Print Output ............................................................................. G-2
Database Folders .................................................................................................. G-2
Database File Types .............................................................................................. G-2
XML Files .................................................................................................... G-2
HTML Files ................................................................................................. G-2
To Print A Device’s Database ................................................................................ G-2
Database
ase
se File Information ................................................................................................ G-6
Printing
g Options ................................................................................................................ G-7
Example
ple
le Database File output ......................................................................................... G-7
Node Configuration
onfiguration Printout ............................................................................................. G-7
Trending
................................................................
ng
g Printout ..............................................................................................................
G-8
..................................................................
Binding
g Printout ................................................................................................................
G-9
Schedule
...............................................................
ule Printout .............................................................................................................
G-9
CPL - Tabular
........................................................
abular Printout ....................................................................................................
G-10
CPL- Graphic(DXF)
...............................................
raphic(DXF) Printout ...........................................................................................
G-10
Appendix
ndix H - CPL Program Examples
I-1
Overview
iew
ew Of CPL Program Examples ................................................................................
................................
I-2
..................................................
Provided programs ..................................................................................................
I-2
Appendices
ndices
dices Index
A-4
Index-1
Appendix A
Standard
d Network Variable Types
Digital SNVTs and Points
Analog SNVTS and Points
SNVTs
Rev 5.4
SNVTS
Standard Network Variable Types (SNVTs) are used to transfer application data between nodes. The data files
can contain a wide range of information about the system, including temperature and other measurements, states,
event time and dates, etc. SNVTs, along with Standard Configuration Parameter Types (SCPTs) and LONMARK
objects, form the application-layer interface for LONTALK protocol data communication. These elements are the
standard formats for how system information is sent and received by a node, and how that information is shared
with other nodes on the network.
SNVTS are a standard representation of variable network inputs and outputs. They allow devices from multiple
manufacturers to successfully interpret and exchange data. System measurements are converted to the specifics
definition of the SNVT. In addition, hardware characteristics are hidden from the network. This allows devices
to become interchangeable, as long as they both generate the same SNVT. Each point on a device must select a
SNVT type. There are two types of SNVTs; analong and digital.
DIGITAL
AL SNVTS
The User can select SNVT types (Figure 1) when adding a point to the FSC. The type of SNVTs available will
depend on the type of digital point being added. When adding digital points:
•
Digital points are:
Input or Output
Hardware or Software.
Output hardware points are:
Momentary
Maintained.
•
Hardware points must be assigned to an I/O module and point on the module.
•
The same SNVTs are available to all the digital points.
Figure 1. SNVT Types For Digital Point
Table 1 lists the SNVT # and Type, a brief description of the SNVT, and the range of the SNVT for digital
points.
A-2
Section 6 - Appendix A
Rev 5.4
SNVTs
SNVTs for Digital Points
SNVT # and Type
011 Day of Week
022 Level Discrete
Description
Used to represent days of the week
Range
Sunday
Monday
Tuesday
Wednesday
Thursday
Friday
Saturday
Null
Used to represent a 2, 3, or 4 state device 2 state: Off/ On
3 state: Off/ Low / Medium/ High
4 state: Off/ Low / High/ High/ High
Off/On: Off/ On/ Null
038 Phone State
Used to represent the different phone
states
Not In Use
Off Hook
Dialing
Dial Completed
Ringback
Incoming
Ringing
Answered
Talking
Hanging Up
Hung Up (Remote)
Hold
Unhold
Released
Full Duplex
Blocked
Call Waiting
Destination Busy
Network Busy
Error
Null
069 Installation Source Configuration Source
Local/ External/ Null
083 SNVT State
Used to monitor or control a specified bits Bit 0: 0 or 1
value of a specified point.
Bit 1: 0 or 1
Bit 2: 0 or 1
Bit 3: 0 or 1
Bit 4: 0 or 1
Bit 5: 0 or 1
Bit 6: 0 or 1
Bit 7: 0 or 1
Bit 8: 0 or 1
Bit 9: 0 or 1
Bit 10: 0 or 1
Bit 11: 0 or 1
Bit 12: 0 or 1
Bit 13: 0 or 1
Bit 14: 0 or 1
Bit 15: 0 or 1
095 Switch
Used to represent a 2, 3, or 4 state device 2 state: Off/ On
Closed/ Open
False/ True
Access/ Secure
3 stage: Off/ Stage 1/ Stage 2/ Stage 3
4 stage: Off/ Stage 1/ Stage 2/ Stage 3/ Stage 4
Normal/Alarm: Normal/ Alarm
Security: Normal/ Alarm / Tamper/ Access
Table 1. SNVTs and Ranges for Digital Points (continued on following pages)
A-3
SNVTs
SNVT # and Type
097 Override
103 HVAC Emergency
108 HVAC Mode
109 Occupancy
118 Evaporation State
119 Thermostat Mode
120 Defrost Mode
Description
Override State
Range
Retain
Specified
Default
Null
Used to represent device states that are Normal
used for Smoke Control
Pressurize
Depressurize
Purge
Shutdown
Used by FSC to set application mode of
Auto
an ASC under its control
Heat
Morning Warm-up
Cool
Night Purge
Precool
Off
Test
Emergency Heat
Fan Only
Free Cool
Ice
Null
Used to transmit the occupancy state of a Occupied
room or zone
Unoccupied
Bypass
Standby
Null
Used to represent the evaporation state
No Cooling
Cooling
Emergency Cooling
Null
Used to represent the thermostat mode
No Control
In/ Out
Modulating
Null
Used to represent the defrost mode
Ambient
Forced
Synchronized
Null
Table 1. SNVTs and Ranges for Digital Points (continued on following page)
A-4
Rev 5.4
Rev 5.4
SNVT # and Type
132 Fire Test / Fire
Initiator
SNVTs
Description
Range
Used to represent the Fire Test or the Fire Fire Test: Normal
Initiator Mode
Reset
Test
No Test
Null
Fire Initiator: Undefined
Thermal Fixed
Smoke-Ion
Multi-Ion-Thermal
Smoke-Photo
Multi-Photo-Thermal
Multi-Photo-Ion
Multi-Photo-Ion-Thermal
Thermal and ROR
Multi-Thermal and ROR
Manual Pull
Water Flow
Water Flow and Tamper
Status Only
Manual Call
Fireman Call
Universal
133 Fire Indicator
Used to represent the Fire Indicator
145 HVAC Unit Type
Used to represent the HVAC unit type
Undefined
Strobe Unsync
Strobe Sync
Horn
Chime
Bell
Sound
Speaker
Universal
Null
Generic
Fan Coil
VAV
Heat Pump
Rooftop Unit
Unit Ventilator
Chilled Ceiling
Radiator
Air Handling Unit
Self-Contained Unit
Null
Table 1. SNVTs and Ranges for Digital Points (end)
A-5
SNVTs
Rev 5.4
ANALOG POINTS AND SNVTS
The User can select SNVT types (Figure 2) when adding a point to the FSC. There are many different SNVT
types available for analog points. The type of SNVTs available will depend on the type of analog point being
added. When adding analog points:
•
Analog points are input or output, hardware or software.
Output hardware points are:
0-10VDC
Floaters.
Input hardware points are:
0-5VDC
0-10VDC thermistors
0-20mA
4-20mA
Totalizers.
•
Hardware points must be assigned to a I/O module and point on the module.
•
The same SNVTs are available to all the analog points.
Figure 2. SNVT Types For Analog Point
Table 2 lists the SNVT # and Type, a brief description of the SNVT, and the range of the SNVT for analog
points.
A-6
Rev 5.4
SNVTs
SNVT Types for Analog Points
SNVT # and Type
Description
Units and Range
001 Ampere
Used to measure electrical current
Amps: -3276.8 to 3276.7
Accuracy
0.1
005 BTU (Kilo)
Used to measure heat energy
KBTU: 0 to 65535
1
006 BTU (Mega)
Used to measure heat energy
MBTU: 0 to 65535
1
008 Count
Used to keep a count of changes of Count(s): 0 to 65,535
state or other values
009 Count Increment Used to store an offset for a count Count(s): -32768 to 32768
0
013 Electrical Energy Used to measure electrical energy
0
015 Flow
1
kWH: 0 to 65,535
016 Flow (Mil)
Used to measure the flow of volume CFM: 0 to 138,859
LPS: 0 to 65,534
Used to measure the flow of volume mLPS: 0 to 65,535
2.119
1
1
017 Length
Used to measure length
m: 0 to 6,553.5
018 Length (Kilo)
km: 0 to 6,553.5
0.1
019 Length (Micr)
µm:
0.1
020 Length (Mil)
mm: 0 to 6,553.5
0.1
023 Mass
Mass in grams
g: 0 to 6,553.5
0.1
024 Mass (Kilo)
Mass in kilograms
025 Mass (Mega)
Mass in metric tons
026 Mass (Mil)
Mass in milligrams
Lbs: 0 to 14,447.994
Kg: 0 to 6553.5
KLbs: 0 to 14,447.994
Mg: 0 to 6553.5
mg: 0 to 6,553.5
0.22
0.1
0.22
0.1
0.1
0.1
0 to 6,553.5
021 Level Cont
028 Electrical Pow er Used to measure electrical pow er
kW: 0 to 6,553.5
1
029 PPM
Used to measure Parts Per Million
PPM: 0 to 65535
1
030 Pressure
Used to measure pressure
PSI: -475.26 to 475.25
KPascals: -3276.80 to 3276.70
2
051 Count F
Used to keep a count of changes of
state or other values (float)
Used to store an offset for a count
(float)
Used to measure flow of volume
(float)
Counts: 0 to 1E38
1
Count: -1E38 to 1E38
1
052 Count Inc F
053 Flow (Float)
054 Length (Float)
Used to measure length (float)
056 Mass (Float)
Used to measure mass
GPM: -5.3935852E39 to
5.3935852E39
KGPM: -5.3935773E36 to
5.3935773E36
LPS: -3.4028235E36 to
3.4028235E36
Ft: 0 to 1.1164119E39
m: 0 to 3.4028235E38
g: 0 to 3.4028235E38
Table 2. SNVTs and Ranges for Analog Points
A-7
SNVTs
A-8
Rev 5.4
Appendix B
Glossary
MCL Tool Terminology
Glossary
Rev 5.4
GLOSSARY
A
Acknowledged Messaging - Provides end-to-end acknowledgment, where a message is sent to each designated
receiver, and the sender expects to receive an acknowledgment message from each. If the send does not receive
an acknowledgment, it times out and retries the transaction at the end of the Transaction Timer interval.
Action: Reverse/Direct. - See Direction Reverse.
Active Alarm Window - Displays only the current or unacknowledged alarms in the MCL Tool system.
Active X Control - A 32-bit, language-independent programmable objects that can be used in a variety of
software development tools.
Address Table Entry - Used with point binding, the address table entry tells the NV sending the data the
address to send to, and sometimes also telling the receiver where the data is being sent.
AI - Analog Input.
AHU - Air Handling Unit.
Alarm History window - Gives the history of all alarms from all nodes as they are sent to the MCLT.
Alarm Hysteresis - The range an item in alarm must pass in order to generate a return to normal.
Alarm Inhibit Time - The length of time - in hours, minutes, and seconds- that must elapse, after the controller
is activated, before an alarm is generated for a particular point. This prevents unwanted alarms on start-up or
when the controller is powered up.
Alarm Set Time - The length of time - in hours, minutes, and seconds- a point must be in alarm state before it is
broadcast.
Alarm Type - You may define an alarm for certain points. Only one alarm type may be defined for each point,
but that type may apply to as many of that point’s states as you wish. You also have the option of selecting one
of several Alarm Types to make the alarm more descriptive.
Alias - An alternative name for an object, such as a variable, file, or device. The alias increases binding flexibility by allowing an NV (Network Variable) to use more than one selector and/or address table entry.
Analog - Point data which has a numerical value. (e.g. 35°F, 10 minutes, 1000 CFM)
AO - Analog Output.
ASC - Application Specific Controller.
Automatic Fan - An HVAC fan which cycles off and on, running only during compressor stage 1.
B
Bind - The act of connecting NVs on one node with NVs of another node. NVOs are bound to NVIs.
Broadcast Addressing - Addressing all nodes in a subnet or domain.
BTU - British Thermal Unit. Measurement of heat.
C
Calibration Offset - An increment of error set by the factory used to calibrate a particular hardware device, like
a thermistor.
Channel - The communications medium that is used to connect network devices.
Channel Delay - Indicates the average amount of time (in milliseconds), for a message packet to get on the
channel, once it has been queued. This delay allows expected traffic patterns to be input to the system, with timer
calculations being affected accordingly.
Command Fail Time - See Feedback Time.
Configure (to configure a node) - The transfer of all point setup information from the editors to the hardware
device, the transfer of binding information to the hardware device, and the assigning of a network address to the
hardware device.
B-2
Section 6 - Appendix B
Rev 5.4
Glossary
Configuration Data Set (CDS) - A set of configuration parameter values associated with a particular device
template. The user can choose to use the default values, or use a different set of values available for the template.
CDSs allow a user to save a set of values for a particular setup of a type of device, and apply it to other similar
devices of the same type.
Configuration Properties (CPs) - Configuration properties are data values used to configure the operation of a
device or LONMARK object. Configuration properties may be implemented using configuration network variables, or they may be implemented as configuration parameters stored in a data block.
Connection Description Template (CDT) - Defines the parameters of a bind (also referred to as a connection).
The CDT will include information on what sort of addressing and message service type it should use, timing
parameters, use of authentication and priority slots, etc.
Continuous Fan - An HVAC fan which runs continually during Occupied Mode.
CPL - MCL Tool’s Control Programming Language.
D
DA - Discharge Air.
DAT - Discharge Air Temperature.
Data Server - An engine for system monitoring and control, it interfaces with the LNS Server to automatically
monitor network data points. It also converts network data in binary data or formatted strings for direct display.
Deadband - Range an input variable may pass through without initiating any change in the output variable.
Default Gateway - A network card (router) at the end of a local trunk allowing access to a remote host.
Default Value - A value in SNVT units of the point used in such specific instances as Send Default on Error and
Override Behavior. This is also used as the initial value at start-up if the point is not fixed.
Delta Send - Increment by which an AI must change before sending its status to the LON.
DHCP - Dynamic Host Configuration Protocol. A method of assigning IP addresses to client PCs on a network
which doesn’t use static IP addresses.
DI - Digital Input or Discrete Input.
Dial Provider - The FSC at a remote side, connected via NCB, which has the responsibility for monitoring that
site and dialing the main system if an alarm occurs.
Digital - Traditionally, point data which can have one of two states. (e.g. off/on, open/closed, true/false.) On
occasion, a digital point with a feedback will have three states. (e.g. on/off/auto). In the MCLT, however, a
digital point can have several “integer” states. For example, the HVAC mode SNVT has eight modes or states.
Digital Lockout - Prevents unwanted alarms by locking out alarms from a point. Once you select a Digital
Lockout point, you must specify the lockout state and time (if desired). This is commonly done with temperature sensors in conditioned spaces so that they do not generate nuisance alarms when the conditioning equipment
is not active.
Digital Lockout Point - DO points whose status dictates whether alarms should be generated for a particular AI.
Digital Lockout State - States of DO Lockout Point for which AI alarms are to be locked out.
Digital Lockout Time - The time - in hours, minutes, and seconds- that must elapse after a DO switches from a
digital lockout state to a non-digital lockout state before alarms can be generated on a particular AI. This
prevents unwanted alarms from being generated on the AI the first few moments after a DO changes out of a
Digital Lockout State.
Direction Reverse - If you select YES, this parameter reverses increment/decrement points. (Note: On an I/O
Module page, the increment/decrement points are reversed when you select YES. Therefore, instead of using
this function to correct an error, you may want to switch the increment/decrement I/O Module point preferences.) For DO hardware points and discrete hardware points, this is called Action: Reverse/Direct.
Discovery Interval - Indicates the minimum interval rate (in seconds) at which the LCA Object Server scans the
network for newly attached, unconfigured devices.
DNS - Domain Name System. A method for resolving host names and IP addresses used in the Internet.
DO - Digital Output.
B-3
Glossary
Rev 5.4
DO Momentary - DO point used to control latching devices like motor starters and lighting relays.
Double click - Click twice with the left mouse button.
Download - The transfer of data from the MCLT to the panel.
DP - Differential Pressure.
Drag - Click and hold the right mouse button, reposition the cursor and let go of the mouse button. This is used
when moving items on the computer screen.
Drive Time - The time - in hours, minutes, and seconds - for the actuator being controlled to move from
completely closed to completely open. This is only used on floating (three state) actuator motors.
DST - Daylight Savings Time.
Duct Size - Cross sectional area of a duct in square feet.
DXF - Data Interchange Format - A standard ASCII file format used to transfer CAD vector files between
programs like AutoCAD® and Visio®.
E
Enthalpy - Thermodynamic value for the total heat content (BTU/lb).
F
FCU - Fan Coil Unit.
Feedback - A DI point is often used to read the status of a device controlled by a DO point. If the DI does not
have the same state as the DO, there may be a problem. If so, an alarm is generated using the Feedback option.
Feedback takes precedence over state-based alarming via the “alarm” page.
Feedback Point - DO point which the DI point should match or else generate an alarm.
Feedback Time - Time - in hours, minutes, and seconds- the FSC will wait before generating an alarm when the
status of the DI does not match that of its DO feedback point. Feedback Time may also be called “Command
Fail Time” in the editors.
Field Minimum - Lowest temperature, pressure, GPM, or etc. the sensor can measure. This will typically
correspond to the lowest voltage or current value on the sensor. This is FSC specific.
Field Maximum - Highest temperature, pressure, GPM, or etc. the sensor can measure. This will typically
correspond to the highest voltage or current value on the sensor. This is FSC specific.
Floating Actuator - A device that moves a damper, valve, or other similar physical device which is controlled
by timed increase and decrease signals. Applying voltage to the “increase” input of the actuator will cause it to
move in the “increase” direction. The same is true for the “decrease” input. The actuator only moves while
voltage is applied to one of its inputs. These devices are generally slow with no position feedback.
Floating Control - Actuator/Valve control signal consisting of pulses from 0.1-10 seconds on “increase” and
“decrease” lines that cause the actuator to move the desired direction while the pulse is present. The actuator
will remain at that point until the next pulse.
Front End - Controlling software for the system; MCLT.
FSC - Flexible System Controller.
FTP - File Transfer Protocol. A TCP/IP protocol allowing the transfer of files between computers.
FTT 10 - A twisted pair, free or bus topology, with a speed of 78K Baud. Basic length for bus topology is 8500
ft. For free topology, length is 1600 ft. This system is polarity insensitive.
G
Global Node - The primary node on the physical tree. This node defines common information for the LON, and
all other nodes attach to this one.
Group Addressing - Refers to a numbered group of nodes in the system.
GUI - Graphical User Interface.
B-4
Rev 5.4
Glossary
H
Hardware Address - A unique alphanumeric code found on the Network Interface Card, also call the MAC
address.
High Alarm Limit - A value set on an analog point. When the value of the point, as seen in the point status
window, rises above the limit, the point will generate an alarm.
Highlight - Used to select text. Place the cursor left of the first character, press and hold down the left mouse
button, and drag the mouse to the end of the text to be selected.
Host - An individual PC, server, router, etc. on a network.
Host Name - The network name of a particular host. In Windows®, it can be found by opening the control
panel and double clicking on the Network icon.
Host Table - A file stored on a local PC which maps known IP addresses and network names.
HP - Heat Pump.
HTML - Hypertext Markup Language. Language used for creating WWW documents enabling hyperlinking to
other places in the document or different sites on the web.
Hysteresis - See Alarm Hysteresis.
I
IAQ - Indoor Air Quality. The quality of air expressed as a percentage.
Intelligent STAT - A microcontroller based thermostat which allows an occupant to adjust the setpoint, display
User Mode parameters, and put the controller in override. The LCD can display the room temperature, time,
outside air temperature, and setpoint.
Internet - A group of connected networks. The global Internet is referenced with a capital letter. A lower case
“i” indicates a group of connected networks.
Interval - Repeating time value that when expired, the defined action is taken.
IP - Internet Protocol. A network protocol which the Internet is based on.
IP Address - A 32 bit (4 byte) binary code used to identify individual hosts on a network.
K
K Factor - Factor of thermal conductivity. The rate that heat flows through a given area of a certain matter,
usually air or water.
L
LAN - Local Area Network.
LCA (LONWORKS Component Architecture) - The LNS application programming interface for Microsoft
Windows 2000® Professional or Windows XP® Professional operating systems.
LCA (LONWORKS Component Architecture) Object Server - An ActiveX control that converts LNS objects
(e.g., devices, routers, channels) managed by the NSS into standard OLE objects, and enables sharing of
information and objects between multiple tools and components.
LED -Light Emitting Diode.
LNS (LONWORKS Network Services) - Echelon’s network management and monitoring software, LNS allows
tools from multiple manufacturers to work together in a single control system by providing a single network
management tool.
LNS Server - Software engine consisting of a library and tools that performs network services.
LNServer - The software interface that allows MCLT to communicate with LNS, and through LNS, devices in
the field.
Lockout - Amount of time which must elapse after a point goes active before alarms will no longer be locked
out.
B-5
Glossary
Rev 5.4
Logical Tree - Map of the MCL Tool system where all points are user defined and may be pulled from any
physical node in the system. For example, all space temps may be grouped in one logical node.
LON (Local Operating Network) - Echelon’s LONWORKS Local Operating System. The LON is designed to
move very brief sensor and control messages containing commands and status information, used to trigger
actions.
LonMark - An independent organization to establish a higher level of interoperability between nodes.
LonMark Object (LMO) - Functional groupings of network variables (NVs) and configuration parameters.
LonTalk - Communication protocol for an Echelon system.
Low Alarm Limit - A value set on an analog point. When the value of the point, as seen in the point status
window, falls below the limit, the point will generate an alarm.
M
MA (Mixed Air) - The combined outside air and re-circulated air.
MAC (Media Access Control) Address - Media Access Control Address. A unique alphanumeric code found
on a Network Interface Card, also known as the hardware address.
MAI (Multiple Analog Input) - A point type that allows the user to get information from a number of analog
points in the system without using a large number of points on the FSC when the user is not concerned about
which specific controller the value comes from. MAI points have no point status. They are reported in CPL
only. MAIs may be used for such things as finding the average space temperature from a group of sensors, or
finding the minimum/maximum thermal load from a group of VAV controllers in order to control an AHU’s
output.
Maintenance Time - The time - in hours, minutes, and seconds- in which the actuator will be driven an extra
amount at its endpoints to ensure that it reaches the endpoint. Since a floating actuator has no feedback, this is
the primary way it can be automatically re-zeroed, whenever it is sent to one extreme or the other. This applies
to the FSC only. Normally, this will be set at 1.5 times the drive time.
Max Receive Time - See NV Update Time.
Max Send Time - The maximum time - in hours, minutes, and seconds- that will elapse between status broadcasts of a particular point, regardless of whether or not it has changed value. This ensures occasional updates in
case the change of state broadcast was missed. NV updates are broadcast to bound connections only, not to the
front end.
Max Value - Maximum value the point’s status can be. If the point is commanded above the Max Value, its
status will be equal to the Max Value. For hardware analog points, this is the value that matches the field max
value in engineering units.
MCL Tool (Metasys Connectivity to LONWORKS networks) - An LNS binding software tool used for binding
and configuring LONWORKS networks.
MCLT (Metasys Connectivity to LONWORKS TOOL) - The graphical user interface (GUI) component of MCL
Tool.
MDI (Multiple Discrete Input) - A point type that allows the user to get information from a number of discrete
points in the system without using a large number of discrete points on the FSC when the user is not concerned
about which specific controller the value comes from. MDI points have no point status. They are reported in
the CPL only. MDIs may be used for such things as monitoring the number of AHU requests from a set of VAV
controllers so that the FSC can decide whether to turn on.
Min Delta - The minimum change that must occur in a particular analog point for it to be broadcast. Used to
limit network traffic. The Min Delta must be valid for a broadcast to occur.
Minimum Move - The time - in hours, minutes, and seconds- that constitutes the minimum move that will be
imposed on the floating actuator. This prevents minor back-and-forth hunting or tiny movements which cause
wear and tear on an actuator without improving control.
Min Send Time - The minimum time - in hours, minutes, and seconds- that must elapse between status broadcasts of a particular point, regardless of how often its value changes. This is used to limit network traffic,
especially on a point that may change frequently. The send time must be valid for a broadcast to occur. Analog
points do not broadcast to the front end for any reason but alarms.
B-6
Rev 5.4
Glossary
Min Value - The minimum value a point’s status can be. If a point is commanded below the minimum value, its
status will be equal to the Min Value. For hardware analog points, this is the values that matches the field Min
Value. The value is in the engineering units of the appropriate SNVT.
MIP - Microprocessor Interface Program.
Momentary (Latching) Relay - A relay that mechanically “latches” into a desired state. These relays have two
coils, an “on” and an “off.” If voltage is applied to one of the coils, the relay moves to that position and remains
there until voltage is applied to the opposite coil. This is often Magnetic Relay.
N
NAE - Network Automation Engine - A Web-enabled network controller with BACnet protocol, LONWORKS
network, and N2 Bus communications. The NAE monitors and supervises Heating, Ventilation, and AirConditioning (HVAC) equipment, lighting, security, smoke control, and access control.
NCB - Network ComBiner. A router manufactured by CTI Products, Inc. which allows the linking of LonWorks
networks over dial up or leased telephone lines. It is connected to the LONWORKS network via modem. NCBs
come in pairs, the local and remote, on either end of the phone line.
NetBEUI - Network BIOS Extended User Interface. In Windows®, it’s the fastest LAN transport protocol.
NetBIOS - An early (1980s) mechanism for client/server communication which can be used across different
platforms.
Network Manager - Allows communication to and from the field, and creates and maintains Echelon specific
databases.
Neuron ID - Unique, 48-bit, factory-assigned identification number associated with every neuron chip.
Neuron ID Addressing - The most basic form of addressing, refers to a node by it’s Neuron ID number.
MCL Tool Server - Server for MCL Tool. Handles communication between MCLT and the Network Manager.
NIC - Network Interface Card. A hardware card which is installed in the PC’s expansion bus slot and connects
the PC with the network.
Node - The MCLT Network Interface, a router, or a controller in the field, or the Physical Tree element
representing the item.
Node History Window - A MCLT window which displays information on the on-line/off-line nature of devices
in the MCL Tool system, modifications, configuration updates, and firmware updates.
NSI (Network Services Interface) - The component in the LNS architecture that provides the physical connection to the LONWORKS network. The NSI is the interface between MCLT (through LNServer) and the field
devices network.
NSI Timeout - The value ( in seconds) that indicates how long the system will wait for remote LNS clients to
respond to a ping.
NSS (Network Services Server) - The LNS network management service that processes network services,
maintains the network database, and enables and coordinates multiple points of access.
Number of Inputs (MAI/MDI) - The number of connections to be made from other panels to this point. This
value cannot be 0. The value must be exactly the number of connection you are going to make to the point. If
too few are specified, all values will not be used. If too many are specified, the point will stay in error, since all
of its inputs do not have current information.
NV - Network Variable. Variable on one node that can be connected to network variables on one or more
additional nodes. This allows sharing of data in a distributed application.
NVI - Network Variable Input.
NVO - Network Variable Output.
NV Update Time - Maximum time the panel will wait for a status from a point on another panel such as Remote
I/O or VAV before the FSC considers it in error. You may want to set this time slightly higher than the Max Send
Time of the output point to which it is bound.
B-7
Glossary
Rev 5.4
O
OA - Outside Air Temperature
OAT - Outside Air Temperature.
OEM - Original equipment manufacturer.
OffNet Mode - A management mode in which the NSS makes network configuration changes in it’s on-board
database but does not update the nodes in the field. The saved updates are queued for later processing when the
NSS is placed in the OnNet management mode.
OnNet Mode - A management mode in which the NSS updates both its on-board database and the configuration
of devices in the field. When the NSS is first placed in the OnNet mode it also updates any changes that were
made while it was in the OffNet management mode.
Offset - Time value that an action is delayed from the designated start time.
Operator - Any individual who operates the workstation.
P
PCLTA - Personal Computer LonTalk Adapter. Hardware/PC interface board which converts data to/from the
field.
PEC - Packaged Equipment Controller.
Physical Tree - Map of the MCL Tool system as it is configured on the LON. All points are grouped according
to the hardware device where they reside.
PID Loop - Proportional, Integral, Derivative loop. Used to fine tune control of an HVAC system.
Ping - Packet Internet Groper. Echo method of determining if a host destination is reachable.
Plug-Ins - An ActiveX control for manipulating data within the LNS database. Most commonly used for OEM
node configuration.
Point - A single piece of data on a controller (software/hardware, input/output)
Points List - A Details working panel that lists information on points in the system.
Program ID - The identification number from Echelon indicating the type of device, manufacturer, etc.
Properties - Attributes of the devices in the network that the user can view and modify.
Protocol - A defined set of messages between two software applications allowing each application to both
specify requests, and respond to the other application’s requests.
Purge - Remove old data from the system. Data may be stored to disk. Alarm and trend data may be purged.
R
Resource Catalog Files - Resource files define how node information is displayed in LNServer. LNServer uses
this information to decode and extract information about network variables (NVs) and configuration parameters
(CPs).
Reheat - A system used to provide local space heating when required by turning on a hot water heat exchanger
or electric heater in a duct to warm the airflow.
Repeater - A simple router used to increase the network length or switch to a new channel.
Reset (to reset a node) - Resets the neuron on the CPU of the hardware device.
Restore - Place previously removed data back in the workstation database. Purged alarm and trend data which
has been stored to disk may be restored.
RH - Relative Humidity.
Right click - Click once with the right mouse button.
Router - Hardware device allowing communication between different media types, or the Physical Tree element
representing it. It will selectively filter information and can increase the network length.
RTU - Roof Top Unit.
B-8
Rev 5.4
Glossary
S
Samples - The number of data points available. It can refer to the total amount of space in the buffer, or the
amount of space allocated to a single trend channel.
Schedules - A series of start and stop times used in conjunction with a group of days. Schedules are set up in
CPL and used for building control.
Security File - Profile set up in MCL Tool limiting an operator to certain system command options.
Selector - Used during point binding, the selector is a 14-bit number that LNS assigns to the bind so that both
ends (NVs) what is being updated.
Send Default on Error - Determines whether or not to send the defined Default Value - instead of “Error” when the point is in error.
Send Time - Amount of time a point waits prior to broadcasting its data to the LON.
Sensor - A device used to measure a variable, usually, a space temperature.
Service Pin - Physical input to an Echelon node that is used when configuring a node. Activating the service pin
broadcasts the neuron ID to the MCLT.
Setpoint - The desired value of a control point.
SNVT (Standard Network Variable Type) - Format of a point using predefined ranges, allowing data to be
exchanged between controllers. A standardized engineering unit.
Space Temperature - Current temperature recorded in a zone by a thermistor or sensor.
SCPT (Standard Configuration Property Type) -A SCPT is a LONMARK-standardized definition type of
configuration property (CP) for devices.
Status Send Interval - The interval at which the controller broadcasts a status from one of its points to the MCL
Tool server. The MCL Tool server monitors the traffic to ensure that all controllers are on-line. The default is
30 seconds.
Subnet Mask - A four byte (32 bit) binary value which defines the network ID portion of an IP address and the
host ID portion.
Subnet /Node Addressing - Refers to a single node by its domain/subnet/node (DSN) address assigned when
the network image is sent to the node during its initial setup.
Subtree - The portion of the Physical Tree that is under a node. It can contain points, LONMARK objects, NVs
(Network Variables), and CPs (Configuration Parameters).
System Node - The Physical Tree element that represents the PC used to access the LON. It is also used to
access database-global properties.
SWT - Supply Water Temperature.
T
TCP/IP - Transmission Control Protocol/Internet Protocol. A suite of protocols controlling Internet communications by allowing for host definition and information routing.
Terminal Unit - An end device on the DDC (Direct Digital Control) system. The VAV box is an example of a
terminal unit.
Thermal Load - Heating capacity of a system.
Thermistor - A thermoelectrical element used to measure temperature.
Third Party Node - Any device manufactured by a company other than Johnson Controls, Inc.
Time Broadcast Interval - The interval at which the time provider broadcasts the current time to all controllers.
This is necessary to coordinate all controllers, since most controllers do not have a real time clock and are thus
only accurate to within a few seconds per day. The default is 15 minutes.
Time Provider - The node in the system (designated by the user) which coordinates time for all nodes in the
system by broadcasting the time at an interval. Currently the time provider must be an FSC.
Totalizer (AI) - A point which registers a tally. For example, it could count the number of times a relay opens.
B-9
Glossary
Rev 5.4
TP-1250 - A twisted pair wire with a speed of 1.25 M Baud. TP-1250 can only be used with bus topology, and
the length is limited to 1600 ft. It is polarity insensitive.
Transmit Timer - Indicates the interval in seconds that the LON retries to send Request and Acknowledged
messages.
Trend - Set up on an individual point to monitor its status over time. It may be viewed, printed, and graphed.
Trend Channel - A collection of data that has been gathered on a single point.
Trend Configuration - The relatively small amount of data that configures the controller and determines the
point(s) for which data to be stored, the interval required, and/or the change (delta) that will be monitored.
Trend Data - The entire collection of data gathered on a single point.
Trend List - A list of all points in the MCL Tool system which are currently being trended.
Trend Sample - A single piece of data on a single point. The smallest unit of trend data.
Triac - Discrete electronic device for switching an AC signal. This cannot be used for DC since it will only turn
off when instantaneous current drops to zero.
TSO STAT - A temperature/setpoint/override microcontroller-controlled thermostat.
Turnaround Addressing - Addressing for connections that take place exclusively within the node.
Two-State - Simple “On/Off” or “Open/Closed” signal.
U
UCPT (User-defined Configuration Property Type) - Manufacturer defined configuration properties types.
UI - User Interface.
Update Firmware - To send a new software revision from the PC to the hardware device.
Update Interval - Indicates the interval in seconds that NSS retries to update (in the background) any changes
made on a device that NSS was not able to update during the original transaction.
Upload - The transfer of data from the panel to the front end.
URL - Universal Resource Locator. An alphanumeric name that resolves to the IP address of a site on the
Internet.
User Defined Graphic - The graphic of a node custom designed by the user to display point status data and
access other graphics, editors, or CPL pages.
UV - Unit Ventilator.
V
VAV 01 - Variable Air Volume controller requiring an external damper actuator.
VAV 02 - Variable Air Volume controller with an integrated damper actuator.
W
WAN - A network comprised of multiple locations, usually a group of interconnected LANs.
Wink - To cause the service LED of a hardware device to flash.
WINS - Windows Internet Name Service. A Microsoft service provided for Windows PCs containing Internet
numbers for specific NetBIOS names.
WWW (World Wide Web) - A group of connected computers on the Internet running Hypertext Transfer
Protocol.
B-10
Appendix C
MCL Tool Architecture
Overview of MCL Tool and LNS Architecture
MCL Tool (MCLT)
LNServer
LNS 3.0 Architecture
Example of MCL Tool Software Interactions
Rev 5.4
OVERVIEW OF MCL TOOL AND LNS ARCHITECTURE
MCL Tool 5.4 contains two software programs that interact directly with LNS. These are MCLT, and LNServer.
LNS architecture consists of Network Services Server (NSS), Network Services Interface (NSI), and LONWORKS
Component Architecture (LCA) Object Server Active X Control.
MCLT is the graphical user interface, and LNServer processes information for the MCLT. LNS relays field
information to and from LNServer, and stores information in the database. LNS can be configured as a server
with both NSS and NSI installed, or as a client, which has neither. The LCA Object Server Active X Control
enables communication between MCLT and LNS.
While MCL Tool 5.4 uses LONWORKS® Network Services (LNS) 3.0 Architecture as a network management tool.
LNS allows software tools from different vendors to work together on a network. Users see the MCLT graphical
user interface, but LNS core services are transparent. The LNS architecture exists as an underlying framework,
providing installation, configuration, and maintenance services, as well as node monitoring and control. Figure 1
illustrates the relationship between MCL Tool, the LNS architecture on both main and remote PCs. The M3 and
M5 Workstations connect to the LONWORKS network through the NAE.
Main MCL Tool PC
MCL Tool Software
MCLT
Remote MCL Tool PC
TCP/IP
Connection
LNServer
MCL Tool Software
LONWORKS Network Server
MCLT
TCP/IP
Connection
LNServer
Component Object Model Connection
LONWORKS Software/Hardware
LCA Object Server
LonWorks Network
Services Server
Component Object Model Connection
Database
LONWORKS Software
LCA Object Server
LNS
NSI
Network
Services
Interface
NSS
Network Services
Server
LONWORKS Network
(LON card -i.e. PCLTA-10,
PCLTA-20, or
PCC-10)
LONWORKS Network
NODE
NODE
Ethernet
Connection
NODE
NODE
NODE
NAE
M3 or M5 Workstation
System Configuration Tool (SCT)
Figure 1. Relationships Between MCL Tool 5.4, LNS 3.0 Architecture, and the M3 or M5 Workstation
MCL TOOL SOFTWARE
MCL Tool 5.4 contains two software programs; MCLT, and LNServer. MCLT provides the capability to configure, edit, and program your building control system. LNServer provides access to the LNS architecture, and
gives MCL Tool the ability to interact with Active X component-based software.
MCLT
MCLT is the graphical component of MCL Tool. This is the MCL Tool User Interface (UI), and allows the user
to view and work with information regarding the nodes on the system, set up Control Programming Language
(CPL) programs, use schedules, set up graphical representations of the building system, etc.
C-2
Section 6 - Appendix C
Rev 5.4
LNSERVER
LNServer connects MCLT to LNS. When a request is made, the LNServer communicates with the LONWORKS
Component Architecture (LCA) Object Server Active X Control, which in turn passes the request to LNS. The
LNServer runs concurrent with the MCLT. A copy of LNServer must be installed on every PC; both main and
remote.
LNS 3.0 ARCHITECTURE
LNS architecture has two main components: Network Services Server (NSS) and Network Services Interface
(NSI). NSS provides network management services. It communicates with the field via the LONWORKS interface
card (NSI). NSS and NSI operations are transparent to the user. The LONWORKS Component Architecture (LCA)
Object Server Active X Control provides a programming language-independent interface to LNS.
LNS uses a client/server model. With LNS, the user can setup, configure, or manage the network from any point,
using a variety of tools. LNS automatically performs many networking tasks, including detection of new nodes
and automatic notification of address changes. LNS continually updates all user interfaces that monitor and
control nodes.
All Echelon LNS software is automatically installed during the MCL Tool installation. The main system will
have the Network Services Server (NSS), the network databases, and the LonTalk interface card. Remote
systems will have only LNS client.
LCA OBJECT SERVER ACTIVEX CONTROL
The LONWORKS Component Architecture (LCA) Object Server is an ActiveX control that converts LNS objects
(e.g., devices, routers, channels) managed by the NSS for Windows engine into standard OLE objects. The
object server also provides a network tool kernel that enables sharing of information and objects between
multiple tools and components.
Echelon’s LONWORKS Component Architecture (LCA) Object Server is installed on each MCL Tool PC to
communicate with the Network Services Server (NSS).
NETWORK SERVICES SERVER (NSS)
The Network Services Server (NSS) is the LNS network management service. It processes the data, maintains
the network database, and executes the services requested by the clients from the various points of system
access. Each MCL Tool system will have ONLY one NSS, and it will be located in the main MCL Tool PC. All
IP remote PCs and network tools communicate with the main PC’s NSS via TCP/IP. Individual clients on the
network may monitor the network, but all changes must be made through the single NSS.
The NSS communicates with LNServer (and ultimately, MCLT) through the LCA Object Server Active X
Control. NSS communicates with devices in the field through the NSI ( see below).
NETWORK SERVICES INTERFACE (NSI)
Information is passed to the field network from the NSS through the Network Services Interface (NSI) card. The
Network Services Interface (NSI) is the hardware interface card in the main MCL Tool PC. This interface card
will be either the PCLTA-10, the PCLTA-20, or the PCC-10. The only NSI is located in the main MCL Tool PC.
Remote PCs communicate via TCP/IP with the NSS on the main MCL Tool PC.
EXAMPLE OF MCL TOOL SOFTWARE INTERACTION
MCLT, LNServer, and the Echelon LNS components work together to make up MCL Tool 5.4. The MCLT
allows the user to visually interface with their environmental control system. They can view, enter, or update
information on their nodes and points, CPL programs, schedules, and binding information. LNServer and LNS
manage services carried out by the user requests.
C-3
Rev 5.4
In this example, the user creates a new node. LNServer then communicates this request to LNS through the LCA
Object Server. The NSS creates or accesses the network database for the information entered in the MCLT. The
NSS is also communicating with the device in the field through the NSI card.
When a VAV-02 node is added to the Physical Tree through the MCLT, all the information regarding that VAV
must be downloaded to the actual controller in the field. The interactions listed below take place in the order as
defined:
1.
User adds VAV-02 node to the Physical Tree in MCLT.
2.
MCLT requests service pin from LNServer. User sends service pin from the device in the field,
bypassing the LNS database.
3.
MCLT sends Neuron ID from LNServer, which passes the data to LNS.
4.
MCLT commands the Network Image and Configuration Data to be downloaded to the VAV-02 in the
field. The data is routed through LNServer to LNS, and then downloaded to the device. A “Finished”
message is sent back from the device to MCLT.
Figure 2 below illustrates the software interactions described above:
MCLT
1. Add Node
LNServer
LNS
2. Get
Service
Pin
LNServer
LNS
LNServer
LNS
LNServer
LNS
3. Set
Neuron ID
4. Send
Network
Image
VAV-02 Node
VAV-02 Node
VAV-02 Node
Send
Config.
Data
Figure 2. MCL Tools Software Interactions
C-4
(Sometimes)
Appendix D
LNServer
LNServer
LNServer
Rev 5.4
OVERVIEW OF LNSERVER
LNServer connects MCLT to LONWORKS Network Services (LNS). When a request is made, the LNServer
communicates with the LONWORKS Component Architecture (LCA) Object Server Active X Control, which in
turn passes the request to LNS. The LNServer runs concurrent with the MCLT. A copy of LNServer must be
installed on every PC; both main and remote.
STARTING LNSERVER
1.
Double Click on
LNServer icon OR:
2.
Click
> Programs >MCL Tool 5.4 Main System > LNServer or:
3.
Click
> Programs > MCL Tool 5.4 Start. This option will open both LNServer and
MCLT.
The LNServer Main Window (Figure 1) consists of four windows; a large window on the left, and three smaller
windows on the right.
•
when LNServer first opens, only the LNServer Messages and the UI Activity windows appear.
•
when the Tree Poll Thread window opens, the LNServer is now operational, and you can now start
MCLT. The User Connection Window will remain blank until MCLT is running.
Title Bar
Menu Bar
LNServer
Messages
User
Connection
Window
UI
Activity
Tree
Poll
Thread
System
Status
Window
Figure 1. LNServer Main Window
D-2
Section 6 - Appendix D
Rev 5.4
LNServer
TITLE BAR
The Title Bar (Figure 2) is the horizontal bar at the top of the window. It contains the title of the window, the
LNServer icon and the
(Maximize),
(Minimize), and
(Close) buttons.
Figure 2. LNServer Title Bar
MENU BAR
The Menu Bar (Figure 3) displays the names of LNServer’ menus. It is located below the Title Bar. Each menu
item has a pull-down list of available menu commands (Figure 4).
To open the drop-down menu:
1.
Click the menu name.
Figure 3. LNServer Menu Bar
Figure 4. Example Of LNServer Pull-down Menu From Menu Bar.
USER CONNECTION WINDOW
The User Connection window (Figure 5) allows the user to view all activity as it is being executed in MCLT. The
user can track node commands, bindings, queries, and MCLT system responses.
Figure 5. User Connectivity window
D-3
LNServer
Rev 5.4
LNSERVER MESSAGES WINDOW
The LNServer Messages window (Figure 6) displays the steps LNServer takes as it initializes. The user can
verify which database is being accessed, node activity, etc.
Figure 6. LNServer Messages Window
UI ACTIVITY WINDOW
The UI (User Interface) Activity window (Figure 7) displays the activity being displayed on the user’s computer
monitor. It continually refreshes, or “paints”, as objects are moved, resized, etc., on the viewing screen.
Figure 7. LNServer UI Activity Window
TREE POLL THREAD WINDOW
The Tree Poll Thread window (Figure 8) monitors the communication between the two software applications:
LNServer and MCLT.
Figure 8. LNServer Tree Poll Thread Window
D-4
Rev 5.4
LNServer
SYSTEM STATUS WINDOW
The System Status window (Figure 9) displays the network being used, network connectivity status, the system
and subsystems being accessed, and application interaction.
Figure 9. System Status Window
EXITING LNSERVER
There are four ways to exit the MCLT:
1.
Click on File from the Menu Bar. Select Exit.
2.
Right click anywhere on the Title Bar. Select Close.
3.
Click the
4.
Click on the LNServer icon in the left corner of the Title Bar. Select Close.
(Close) button from Title Bar.
The LNServer button on the Task Bar at the bottom of the screen will appear as in Figure 7.
Figure 7. LNServer Shutting Down
D-5
LNServer
D-6
Rev 5.4
Appendix E
M3/M5/MCL Tool System Architecture
Overview of M3/M5/MCL Tool Architecture
Compatibility and Support
M3 Workstation
MCL Tool User Interface (MCLT)
LNServer
LNS 3.0 Architecture
MCL tool User’s Guide
Rev 5.4
OVERVIEW
The M3/M5/MCL Tool 5.4 System Architecture (Figure 1) consists of 5 software components:
· M3 or M5 Workstation and the Iconix components (M-Graph, M-Alarm, M-Trend)
· MCT, which is the primary tool for interfacing with LNS (LONWORKS Network Services)
· LNServer, which is the direct LCA (LONWORKS Components Architecture) layer interface to
LNS
· LONWORKS OPC Server, which communicates to LNServer to automatically map all point
setup in the LNS database via LNServer and the MCLT
· Echelon’s LNS v3.02 LONWORKS Database
M3/M5/MCL Tool v5.4
M3/M5
M-Graph
Workstation
M-Trend
MCL Tool PC
M-Alarm
Alarm & Event
MCLT LNServer
L-Schedule
Alarm & Trend
Plug-In
Echelon LNS 3.02
Newron OPC Server
Figure 1. M3/M5/MCL Tool 5.4 System Architecture
CONFIGURATION TOOLS
The primary configuration tool for the LONWORKS network is MCL Tool. Any LONMARK standard node can be
set up and configured using the MCL Tool. MCL Tool includes all tools necessary to edit and configure the
LNS database and LONMARK standard nodes. The configuration for the new OPC server will be handled in a
combination of automatic tag generations via the LNServer and through an advanced editor in the MCLT.
SUPPORT FOR LONMARK COMPLIANT FIELD CONTROLLERS
Any LONMARK standard field controller is supported by MCLT. The primary basis for this support is through the
use of Echelon’s LNS, version 3.02.
E-2
Section 6 - Appendix E
Rev 5.4
M3/M5/MCL Tool SystemArchitecture
SYSTEM REQUIREMENTS
The criteria listed below are necessary for the M3/M5/MCL Tool to operate correctly.
OPERATING SYSTEM SUPPORT REQUIREMENTS
The M3/M5/MCL Tool 5.4 is based on the LNS 3.02 core and is limited to the following operating systems:
·
Windows® 2000 operating system with Service Pack (SP) 4
·
Windows® XP Professional operating system with SP1
COMPUTER REQUIREMENTS
The M3/M5/MCL Tool run on any PC platform configuration of the supported operating systems.
Recommended for all MCL Tool, M3, and M5 Workstation applications.
·
2.6 GHz Pentium® 4 processor
·
256 MB Random Access Memory (RAM) (512 MB for high point density networks)
·
40 GB minimum (600 MB of free space on yur hard disk for virtual memory)
·
Super VGA Monitor (800 x 600), (1024 x 768), or (1280 x 1024) screen resolution
·
CD-ROM 4x or higher (CD-RW drive is recommended for backups).
·
LonTalk® Card for connection to the LONWORKS network.(PCLTA-10, PCLTA-20 or PCC-10).
Note: Full-size PCLTA card with piggyback SMX board can not be used.
COMPATIBILITY AND SUPPORT
The M3/M5/MCL Tool is fully compatible with LONWORKS protocol standards. It supports direct connection of
Ethernet NIC to Echelon’s iLON routers through standard TCP/IP network. The system architecture is designed
to support a variety of third party nodes.
OPC SERVERS
·
Supports multiple OPC servers and their associated communication capabilities within a single
platform. This includes all BN/N30 OPC servers developed by Johnson Controls.
·
All applications can support/interact for data accessibility with other OPC servers residing on a
single platform.
·
A LON OPC server configuration that is capable of supporting up to 32,000 OPC tags.
·
Browse the LON OPC database even when the M3/MCLT is offline to the LON network.
ALARM MESSAGE MANAGEMENT
The system architecture supports M-Alarm, the ICONICS AlarmWorX32 OPC Alarm and Event Server, and the
AlarmWorX32 Configuration tool. All alarm management functions of these tools are present, including print
and graphics capabilities.
TRENDING
The M3/M5/MCL Tool has all the trending capabilities provided with the M3 components M-Collector, MHistorian, and M-Trend. It uses the same methods and behaviors as are used with the M3 Workstation, and the
user can define the initial configuration of the conditions and parameters for the default/standard trend recording
with the LON OPC database configuration tool. For all selected LON OPCs, a trend-sampling period of 30
minutes is defined. The trend sample period is modifiable in the M-Collector.
The M3/MCLT archives all trend samples collected from the LON network in the same archive database as the
trend samples collected from the N30 network. Capability is provided to support any ODBC compliant database
that is supported with M3 Release 3 (or later/latest version).
E-3
MCL tool User’s Guide
Rev 5.4
SUPPORT FOR ADDITIONAL M3/M5 COMPONENT APPLICATIONS
The M3/M5/MCL Tool also provides for the LON network the support for additional M3 component applications:
·
Support for all M-Web capabilities as being provided with M-Web Release 3 for the M3 Workstation.
·
Support for all ICONICS AlarmWorX32 MultiMedia Extension capabilities as being planned as an
enhancement for the M-Alarm component.
M3 AND M5 WORKSTATION
The M3 and M5 Workstation both provide the dynamic graphical display for the building control system. The
M3/M5 Workstation provides trending, graphics, and alarm features to assist users in analyzing system efficiency and energy consumption. Users can also add navigation links, issue commands, and set up interactive
displays of the facility. M3/M5 receives information from the field via the OPC Server. For further information,
please consult the appropriate M3 and M5 (M-Series) Workstation documentation.
MCL TOOL SOFTWARE
MCL Tool 5.4 contains two software programs; MCLT, and LNServer. MCLT provides the capability to configure, edit, and program your building control system. LNServer provides access to the LNS architecture, and
gives MCL Tool the ability to interact with Active X component-based software.
MCLT
MCLT is the graphical component of MCL Tool. This is the MCL Tool User Interface (UI), and allows the user
to view and work with information regarding the nodes on the system, set up Control Programming Language
(CPL) programs, use schedules, set up graphical representations of the building system, etc. Please see Section
Six, Appendices - Appendix C for more information.
LNSERVER
LNServer connects MCLT to LNS. When a request is made, the LNServer communicates with the LONWORKS
Component Architecture (LCA) Object Server Active X Control, which in turn passes the request to LNS. The
LNServer runs concurrent with MCLT. A copy of LNServer must be installed on every PC; both main and
remote. Please see Section Six, Appendices - Appendix D for more information.
LNS 3.0 ARCHITECTURE
LNS architecture has two main components: Network Services Server (NSS) and Network Services Interface
(NSI). NSS provides network management services. It communicates with the field via the LONWORKS interface
card (NSI). NSS and NSI operations are transparent to the user. The LONWORKS Component Architecture (LCA)
Object Server Active X Control provides a programming language-independent interface to LNS.
LNS uses a client/server model. With LNS, the user can setup, configure, or manage the network from any point,
using a variety of tools. LNS automatically performs many networking tasks, including detection of new nodes
and automatic notification of address changes. LNS continually updates all user interfaces that monitor and
control nodes.
All Echelon LNS software is automatically installed during the MCL Tool installation. The main system will
have the Network Services Server (NSS), the network databases, and the LonTalk interface card. Remote
systems will only an LNS client. Please see Section Six, Appendices - Appendix C for more information.
OPC LONWORKS SERVER
The OPC LONWORKS® Server is the “plug-and-play” interface between the M3 Workstation and the LNS
Architecture. It utilizes Object Linking and Embedding – for Process Control (OPC) technology for plug-andplay software, providing communications between building control systems. The OPC Server accesses data from
the field through LNS, and provides that data to the M3 Workstation. The multi-tasking OPC LONWORKS® Server
communicates with all LONTALK® media. For more information, please contact the manufacturer.
E-4
Appendix F
Error Messages
MCLT Communication Error Messages
MCLT General Error Messages
MCLT Binding Error Messages
Error Messages
Rev 5.4
OVERVIEW
This chapter provides a listing of some of the more common error messages the User may encounter while
running the MCLT.
MCLT COMMUNICATION ERRORS
Most of the communication error messages generated by MCL Tool are displayed for informational purposes
only and do not require any correctional action to be taken by the User.
Communication errors can be one of three general types:
Type 1 - MCLT is having trouble communicating with a device or server and closes the connection. MCLT
automatically retries to establish the required connection, and the User must resend the message.
Type 2 - An unanticipated internal error has been generated. MCLT automatically retries to establish the
required connection, and the User must resend the message.
Type 3 - Unable to establish a connection because LNServer or LNS is busy. MCLT automatically retries to
establish the required connection, and the User must resend the message.
NOTE: Type 1 and Type 2 errors are very rare. If you are having repeated occurrences of these
messages, please contact Customer Support (see Appendix F, MCL Tools 5.4 Contact
Information).
Table 1 below lists some of the more common MCLT communication errors:
MCLT Communication Errors
Number
Error Message
Received sub-packets (of a large
packet) in the wrong order.
Received a packet with the wrong
message revision.
Received a packet that was too
short.
Error Type
Action Required
1
Resend the message.
1
Resend the message.
1
Resend the message.
2
Resend the message.
104
Sent a packet that was too short.
Memory failure while sending a
packet.
2
Resend the message.
105
Sent a packet that was too big.
2
Resend the message.
106
The reply packet timed out.
3
Resend the message.
107
Failure while sending a packet.
2
Resend the message.
108
Failure while waiting for a reply.
2
Resend the message.
100
101
102
103
Table 1. Common MCLT Communication Errors
F-2
Section 6 - Appendix F
Rev 5.4
Error Messages
GENERAL ERRORS
General errors normally occur when a node is being added or modified. A general error also occurs when the
User tries to initiate an event without completing all necessary prior steps. To correct the error, the User must
recheck device settings, parameters, etc.
Table 2 below lists some of the most common general errors. For further information, please contact Customer
Support (see Appendix F, MCL Tools 5.4 Contact Information).
Error Number:
32805
Error Message:
The device must be assigned a Neuron ID for this operation to complete (LNS NS error 37)
Explanation:
LNS searches by the Neuron ID number, w ithout w hich it can not find the device on the netw ork.
Action Required:
Error Number:
Error Message:
Recheck steps taken prior to last action before error message.
Explanation:
Action Required:
Error Number:
Error Message:
Explanation:
Action Required:
Error Number:
Error Message:
Explanation:
Action Required:
Error Number:
Error Message:
Explanation:
Action Required:
32806
Mismatched program ids (LNS NS error 38)
The program ID of the device indicated by the supplied Neuron ID is different from that of the device in the
database. Either the device type is incorrect, or a w rong softw are revision is installed.
Verify that the device type and softw are revisions in the device are correct.
32827
Program interface does not match previously defined programs's interface (LNS NS error 59).
LNS checks the interface of a device w hen sending a netw ork image to it. This error is generated w hen the
interface does not match the interface defined in the database.
Verify that the device and .XIF file match (set up earlier in the setup). If so, contact the device manufacturer
to verify compatibility w ith LNS.
32881
Could not get value for specified CP (LNS NS error 113).
The device may not have a value defined for the CP (Configuration Parameter).
Verify the device is accessible. Set the CP value individually, or by using the node Setup node menu
command (set CPs to default value).
32961
Warning: Function completed successfully but the nodes have not been successfully updated (LNS NS
error 4030).
This w arning means that the LNS internal time-outs did not allow it to finish updating the device.
Monitor the device status on the Physical Tree for eventual update. If LNS does not complete the update,
verify the device is LNS-compatible and is functioning and communicating correctly w ith LNS.
Table 2. General Errors (continued on next page)
F-3
Error Messages
Error Number:
48785
Error Message:
Can't update w hen offnet. (LNS LCA error 17)
Explanation:
System is offnet. Server may be dow n.
Action Required:
Error Number:
Error Message:
Check the netw ork, and set the system Onnet.
Explanation:
Action Required:
Error Number:
Error Message:
Explanation:
Action Required:
Error Number:
Error Message:
Explanation:
Action Required:
Error Number:
Error Message:
Explanation:
Action Required:
Error Number:
Error Message:
Explanation:
Action Required:
Error Number:
Error Message:
Explanation:
Action Required:
48805
Neuron ID changed--use replace, not commission. (LNS LCA error 37)
The Neuron ID of the node has been modified, and then an attempt w as made to send the netw ork image to
it.
If the Neuron ID has changed, the User must use the Replace Node command, not the Setup Node >
Send Netw ork Im age command.
48870
Neuron ID in use. (LNS LCA error 102)
The Neuron ID specified is already in use by another node.
Verify the correct Neuron ID w as entered. If so, check the other nodes in the system and locate the other
node using that Neuron ID. If no other node contains the Neuron ID, database damage is likely. Send a copy
of the database to Customer Support, w here it w ill be forw arded to Echelon.
53797
Request timed out.
The request to the device timed out.
Verify that the device is communicating on the netw ork, and retry the operation.
53804
The node name specified is the same as an existing node.
Another node on the Physical Tree is already bearing that name.
Change the node name and retry the operation. If the problem continues, find the node w ith the name in
question and rename it. If the problem still persists, database damage is likely. Send a copy of the database
to Customer Support, w here it w ill be forw arded to Echelon.
53805
The router name specified is the same as an existing router.
Another router on the Physical Tree is already bearing that name.
Change the router name and retry the operation. If the problem continues, find the router w ith the name in
question and rename it. If the problem still persists, database damage is likely. Send a copy of the database
to Customer Support, w here it w ill be forw arded to Echelon.
53878
No valid device templates for this transceiver type. Cannot get device from the netw ork due to it being in
engineered mode/offline.
The list of device templates show n in the Add Node box is filtered to match the transceiver type of the
channel to w hich the node is being added. Either the transceiver type is w rong, or there are no device
templates in the system for that transceiver type. The Add device from netw ork option is only available
w hen the system is not in engineered mode and is Onnet.
Verify that the transceiver type selected is correct, and that all needed device templates exist.
Table 2. General Errors (continued from previous page)
F-4
Rev 5.4
Rev 5.4
Error Messages
BINDING ERRORS
Binding errors normally occur when a node is either being commissioned or when the NVs are being bound.
Binding errors safeguard the structure of the control system by preventing duplications and mismatched settings.
To correct the following errors, follow the Action Required instructions shown in Table 3 below:
Error Number:
Error Message:
Explanation:
Action Required:
Error Number:
Error Message:
Explanation:
Action Required:
Error Number:
Error Message:
Explanation:
Action Required:
Error Number:
Error Message:
Explanation:
Action Required:
Error Number:
Error Message:
Explanation:
Action Required:
Error Number:
Error Message:
Explanation:
Action Required:
Error Number:
Error Message:
Explanation:
Action Required:
48379
Priority not configurable--check CDT. (LNS CONN error 11)
The CDT (Connection Description Template) indicates that it is attempting to force the
connection priority messaging option. One or more of the NVs (Network Variables) in the
connection does not allow the tool to configure that.
Check CDT.
48380
Authentication not configurable--check CDT. (LNS CONN error 12)
connection authentication option. One or more of the NVs in the connection does not
allow the tool to configure that.
Check CDT.
48381
Service type not configurable--check CDT. (LNS CONN error 13)
service type option. One or more of the NVs in the connection does not allow the tool to
configure that.
Check CDT.
48383
No more address slots. (LNS CONN error 15)
One or more of the nodes has run out of address table entries.
Determine which node (sender or receiver) and modify the CDT and other bindings to
reduce the number of address table entries needed.
48385
No more NV selectors. (LNS CONN error 15)
There are too many NV connections in the system. (LNS CONN error 17)
Recheck and reduce the number of binds.
48387
Authentication mismatch. (LNS CONN error 19)
Two or more of the nodes in the connection have different authentication specifications.
Check NV setups.
48388
Group too large to use acknowledged service. (LNS CONN error 20)
Groups of more than a few nodes cannot use the acknowledged service option.
Change the service type in the CDT to unacknowledged-repeated, or make the group
smaller.
Table 3. Binding Errors (continued on next page)
F-5
Error Messages
Error Number:
Error Message:
Explanation:
Action Required:
Error Number:
Error Message:
Explanation:
Action Required:
Error Number:
Error Message:
Explanation:
Action Required:
Error Number:
Error Message:
Explanation:
Action Required:
Error Number:
Error Message:
Explanation:
Action Required:
Error Number:
Error Message:
Explanation:
Action Required:
Error Number:
Error Message:
Explanation:
Action Required:
Error Number:
Error Message:
Explanation:
Action Required:
48389
Unacknowledged service not allowed with authentication.
Authentication only works with acknowledged service. (LNS CONN error 21)
Change CDT settings to acknowledged service.
48391
Broadcast subnets differ. (LNS CONN error 23)
Subnet broadcast addressing was specified, but two or more nodes in the connection are
not in the same subnet.
Change the addressing type.
48394
Broadcast service cannot use authentication. (LNS CONN error 26)
Acknowledged service is not allowed when using broadcast addressing.
Change the service type to unacknowledged or unacknowledged-repeated.
48396
Conflicting priority settings--compare CDTs. (LNS CONN error 28)
One or more nodes being modified are in one or more overlapping connections. Priority
settings in the CDTs do not match.
Compare the CDTs for the overlapping connections and change settings to match.
48397
Conflicting authentication settings--compare CDTs. (LNS CONN error 29)
One or more nodes being modified are in one or more overlapping connections.
Authentication settings in the CDTs do not match.
48398
Conflicting service type settings--compare CDTs. (LNS CONN error 30)
One or more nodes being modified are in one or more overlapping connections. Service
type settings in the CDTs do not match.
48399
Conflicting timer settings--compare CDTs. (LNS CONN error 31)
One or more nodes being modified are in one or more overlapping connections. Timer
settings in the CDTs do not match.
48400
Conflicting broadcast settings--compare CDTs. (LNS CONN error 32)
One or more nodes being modified are in one or more overlapping connections.
Addressing settings in the CDTs do not match.
Table 3. Binding Errors (continued from previous page)
F-6
Rev 5.4
Rev 5.4
Database Print
Appendix G
Database Print
Database Print Wizard
Database Print Filetypes
Section 6 - Appendix G
G-1
Database Print
Rev 5.4
OVERVIEW OF DATABASE PRINT
The Database Print feature of MCL Tool allows you to print LNS 3.x database information into a standard
format. The printout consists of database configuration parameters, binding, schedules, trending, and CPL
programming. Output can be in a tabular text format, or a graphical format for CPL files. This documentation
can be used as a hard copy for a job sign off, a reference for system troubleshooting, or as a hardcopy database
backup.
The Database print wizard is a series of screens that allow you to select a node(s) to print, then select specific
node parameters to be included in the printout.
VIEWING DATABASE PRINT OUTPUT
The Database Print output is viewable from standard Internet browser applications such as Internet Explorer® or
Netscape®. The two database output filetypes are HTML and XML.
Note: XML format is only viewable in IE 5.0 or above.
The INDEX.HTML file is the only file you need to run to view all database information. The INDEX.HTML
contains internal links to all associated files so you don’t have to open a large number of files. It is always stored
in the root of the database folder, even when HTML is selected and an HTML subfolder is created.
DATABASE FOLDERS
When you run the Database Print program it creates a number of files for that session, and stores them in a single
folder. The folder is created automatically and is named using the date and time the database file was created.
Example: 20020415_1345 would correspond to a file created on April 15, 2002 at 1:45 P.M.
DATABASE FILE TYPES
XML FILES
The Database Print program, by default, creates a separate XML file for each selected node. These XML files
are automatically named using the selected node’s name. These files are then stored in the main database folder
as described above.
HTML FILES
Checking the HTML checkbox in the wizard will automatically convert the XML files to HTML and store them
in an HTML subfolder created inside the main database folder.
The Database Print is implemented by clicking on the printer icon found on the main toolbar (Figure 1).
Figure 1 Toolbar
TO PRINT A DEVICE’S DATABASE
1.
G-2
Click on the Database Print icon
to open the Available Nodes screen (Figure 2).
Rev 5.4
Database Print
Figure 2 Available Nodes screen
The physical tree, displayed in the left window of the Available Nodes screen, contains all available nodes. You
have several buttons to help you select the nodes to be printed. To select a node, click the node in the physical
tree to highlight it, then click one of the buttons shown below.
The
button adds the currently selected node to the right side window.
The
button adds all nodes on the physical tree to the right side window.
The
button deletes the single selected node from the right side window.
The
button deletes all nodes from the right side window.
The
button adds all devices, of the currently selected node type, to the right side window.
2.
Click on a node in the Available Nodes list, then click the
button. The selected node will
be displayed in the right window of the Database Print screen (Figure 3).
Figure 3 Screen Showing Newly Added Nodes
G-3
Database Print
3.
Rev 5.4
Continue to add nodes as you require. Once you have selected all the nodes you want to print, click
the
button to move to the Select The Option(s) You Want to Print screen (Figure 4).
Figure 4 Select The Option(s) You Want To Print Screen
4.
Click the checkbox of each option you want to print for the previously selected nodes (Figure 5).
Descriptions of each checkbox are shown below:
Node Configuration - This lists the node’s configuration specifics.
Trending - This lists any trending associated with each selected node.
Binding - This lists binding specifics for each selected node.
Schedule - This lists any schedules and their related information.
CPL - This lists, in text form as a default, any CPL programs assigned to each selected node.
Tabular - This lists the information in a tabular format.
Graphic (DXF) - This saves all CPL programs to a DXF file format.
Figure 5 Database Print Showing Selected Options
G-4
Rev 5.4
5.
Database Print
Once you have selected all the options you want to print, click the
button to move to the
File Path screen (Figure 6). This screen allows you to set where the database files will be saved.
The default file type for saving database files is XML. Clicking the Convert to HTML checkbox saves the
database file in the HTML format.
Figure 6 File Path Screen
6. Click the
button if you need to change the current file save location. The Get File Path screen
will appear (Figure 7).
Figure 7 Get File Path Screen
G-5
Database Print
7.
Rev 5.4
Once you have set the file paths and, if desired, chosen Convert to HTML, click the
button to move to the You have selected the following print option(s) screen (Figure 8).
Figure 8 Print Options Screen
This screen shows you the nodes you selected to print, and the information options selected for each node. An x
is displayed under each node print option you previously selected.
8.
Click the
button to begin the database print process. The bottom of the screen shows
the printing status of the each node as it is being saved.
DATABASE FILE INFORMATION
A new database folder is created each time a database is printed. Each new database folder is automatically
named with the following format: YYYY/MM/DD_TTTT where Y= year, M=month, D=day, followed by
_T=time the file was created. Example: A folder (Figure 9) named 20020419_0819 would be a folder that was
created on April 19, 2002 at 8:19 A.M.
Figure 9 XML File Folder Showing Database 20020419_0819
G-6
Rev 5.4
Database Print
PRINTING OPTIONS
The chart below (Figure 10) shows the Database Print capability of each device type.
System
Node
3rd Party
Node
VAV-01
VAV-02
PEC
HPU
FCU
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
CPL
x
x
Schedule
x
x
Node
Config.
Binding
Trending
RTU
FSC-01
FSC-02
FLC-01
FLC-02
Router
x
Figure 10 Printing Options
EXAMPLE DATABASE FILE OUTPUT
The following screens are examples of the five main database print output categories. These files can vary
depending on the device, and how it has been configured.
NODE CONFIGURATION PRINTOUT
Figure 11 Example Node Configuration Screen Showing Points
G-7
Database Print
Figure 12 Example Node Configuration Screen Showing ASCII Name
TRENDING PRINTOUT
Figure 13 Example Trending Screen
G-8
Rev 5.4
Rev 5.4
Database Print
BINDING PRINTOUT
Figure 14 Example Binding Database Printout
SCHEDULE PRINTOUT
Figure 15 Example Schedule Printout
G-9
Database Print
Rev 5.4
CPL - TABULAR PRINTOUT
Figure 16 CPL Tabular Format File
CPL- GRAPHIC(DXF) PRINTOUT
DXF (Drawing Interchange File) files are saved in the directory you selected in the wizard. These files will be a
graphical representation of the CPL page itself. A sample folder with the DXF file is shown below (Figure 17).
Figure 17 DXF File and Folder
Programs such as Visio®, AutoCAD®, or VoloView® can then be used to view, edit, and print these DXF files.
Printed files can be used as a hardcopy backup method for CPL pages.
G-10
Rev 5.4
Database Print
Figure 18 Sample DXF File Screen
G-11
Database Print
G-12
Rev 5.4
Rev 5.4
Database Print
Appendix H
CPL Program Examples
CPL Program Templates
Section 6 - Appendix H
H-1
Database Print
Rev 5.4
OVERVIEW OF CPL PROGRAM EXAMPLES
There are a number of CPL programs included with MCL Tool. They are provided to simplify and speed the
CPL creation process for you. Each program was created for a specific purpose and may not exactly fit your
intended purpose. Changes to these programs may be required to customize them to work on your system.
Johnson Controls provides these programs as example templates and learning aids, and does not warranty them
for any specific purpose.
Each CPL program is provided as a ZIP file and includes a README.TXT and README.PDF file.
PROVIDED PROGRAMS
The list below is current at the time this document was created. Check the README file for additional information or look in the CPL directory.
CPL Application
1. 15 Minute Sliding Average Window
Folder Name
15MINWIN
2. 5 Second Ring Counter Program
H-2
3. Analog - Digital Convertor Program
ADCNVTR
4. Basic Alternator Program
ALTRNATR
5. Central Plant Control
CNTRLPLT
6. Cooling Tower Program
CLGTWR
7. FSC-TSO Program
FSCTSO
8. Sequenced Valve Program
SEQVLV
9. Simple Economizer Program
SMPLECON
10. Scheduling Program
SCHEDULING
Section 6 - Appendix H
Rev 5.4
Appendices Index
Appendices Index
A
G
Additional M-Series Component Apps: E-4
Alarm Message Management
M-Alarm E-3
Analog Points A-6
Input Hardware Points A-6
Output Hardware Points A-6
Analog SNVTS A-6
Glossary B-2
B
Binding Errors F-5
C
Compatibility and Support Requirements E-3
Configuration Tools E-2
D
Database
Binding Printout G-9
CPL - Tabular Printout G-10
CPL- Graphic(DXF) G-10
Database File Types G-2
Database Folders G-2
File Information G-6
File Output G-7
Node Configuration Printout G-7
Overview Of Database Print G-2, I-2
Printing Options G-7
Schedule Printout G-9
Trending Printout G-8
Database Print G-2, I-2
Digital Points A-2
Output Hardware Points A-2
Digital SNVTs A-2
E
Exiting LNServer D-5
L
LNS 3.0
Architecture C-3, E-4
LCA Object Server ActiveX Control C-3
Network Services Interface (NSI) C-3
Network Services Server (NSS) C-3
LNServer C-3, E-4
LNServer Messages Window D-4
LonMark compliant Field Controllers E-2
M
MCL Tool
LNServer E-4
MCL Tool PC (MCLT) C-2
MCL Tool Software E-4
LNServer C-3
MCLT C-2
MCLT and LNS Architecture
Example of Software Interaction C-3
Overview C-2
MCLT Communication Errors F-2
Type 1 F-2
Type 2 F-2
Type 3 F-2
MCLT Error Messages
Overview F-2
MCLT General Errors F-3
MCLT Software C-2
Menu Bar D-3
N
Network Information D-5
O
OPC LonWorks Server E-4
OPC Servers E-3
Index-1
Appendices Index
SAppendices Index
SNVT A-2, A-6
Starting LNServer D-2
System Requirements E-3
Operating System Requirements E-3
Platform Support Requirements E-3
System Status Window D-5
T
Title Bar D-3
Tree Poll Thread Window D-4
Trending Support
M-Collector
M-Historian, and M-Trend. E-3
U
UI (User Interface) Window D-4
User Connection Window D-3
Index-2
Rev 5.4
Rev 2.1

mcl tool 5.4 - Johnson Controls

Transcription

Similar documents

The Mount Chacaltaya Laboratory: past, present and - Ev-K2-CNR

Aneel Paulus MD. MS1, Sharoon Akhtar MPhil1, Kelara

trigger point injections with traumeel® injection solution

2FLYPROPILOT MODULAR.indd - 2Fly Pro

April • 2015 - Pagoda Pacers

event security protection limited

most wanted... - Tulsa Police Department

File

Published in Western Horseman - July, 2001

Rocker Bank Air Eliminator Head for the Air Eliminator Model T2A