Cleaver Brooks
Interface
Overview and Configuration Manual
COMFORT
NETWORK
Cleaver Brooks
Interface
Overview and Configuration Manual
This document is the property of Carrier Corporation and is delivered on
the express condition that it is not to be disclosed, reproduced in whole
or in part, or used for manufacture by anyone other than Carrier
Corporation without its written consent, and that no right is granted to
disclose or so use any information contained in said document.
Carrier reserves the right to change or modify the information or product
described without prior notice and without incurring any liability.
ControlBus™ is a trademark of Aqua-Chem, Inc.
Cleaver Brooks® is a registered trademark of Aqua-Chem, Inc.
© 1997, Carrier Corporation
Contents
Introduction ................................................................................... 1
About this Manual ...................................................... 1
Product Description .................................................... 2
Hardware Components ............................................... 3
Required Conditions .................................................. 3
Related Documentation .............................................. 4
Operating Characteristics......................................................... 5
Cleaver Brooks Equipment Requirements ................. 5
Cleaver Brooks Terminal Settings .............................. 5
Polling Considerations ............................................... 6
Writing Data ............................................................... 7
Units ........................................................................... 8
Configuration ................................................................................ 9
Configuration Overview ............................................. 9
Controller ID Table .................................................. 10
Alarm Configuration Table ...................................... 10
Point Configuration Tables ....................................... 13
Port Configuration Table .......................................... 16
Maintenance .............................................................................. 19
Configuration Sheets ................................................................ 21
Index ............................................................................................. 23
iii
iv
Introduction
Introduction
About this Manual
This manual contains information about the functions of the Cleaver
Brooks Interface and how you configure it to perform those
functions.
The manual is divided into the following sections:
•
•
•
•
•
Introduction
Operating Characteristics
Configuration
Maintenance
Configuration Sheets
The Introduction consists of this description of the manual and an
overview of the interface.
Operating Characteristics describes how the interface collects and
stores data, and how it responds to requests from other CCN components.
The Configuration section includes a description of each decision in
each configuration table. Each entry includes the decision's purpose,
the range of values that may be entered, and the default values that
will appear in the decision if you do not configure it.
The Maintenance section includes a description of the decisions in
the maintenance tables. Each entry includes the decision's purpose
and the range of values that may be displayed.
The Configuration Sheets section consists of a list of configuration
decisions arranged in a table format. These sheets are provided so
that they may be photocopied for use as worksheets and hard copy
records when configuring the interface.
1
Product
Description
The Cleaver Brooks Interface is a CIO Module which allows
communication between a Carrier Comfort Network (CCN) and
Cleaver Brooks® boiler control equipment. It allows you to map up
to 500 points in the Cleaver Brooks system to a table of userdefined CCN points which is stored in the interface. These points
can then be accessed by BEST/BEST++ programs or Carrier’s
Network Service Tool, Building Supervisor, or ComfortWORKS
software in the same manner as any CCN controller. The interface
provides for both read and write access to the Cleaver Brooks
points.
The interface operates by polling the Cleaver Brooks controller,
then writing updated values to its own tables, where they are stored
in a database and available to other CCN devices. CCN commands
to write to a Cleaver Brooks point are buffered until the point is
polled. The interface provides the following features:
•
•
•
•
•
•
•
•
A database which allows for specification and access of up to
500 Cleaver Brooks points
Both read and write operations (if the particular Cleaver Brooks
point allows)
Support for ComfortWORKS graphics
Programmable CCN names for each point
Individual poll rates for each point
Viewing of both configuration and maintenance tables for each
point
Support for both discrete and analog points
Port communication supervision with alarm
In addition, the interface has tables which allow you to configure
alarm settings and RS-485 communication parameters.
2
Hardware
Components
Your Cleaver Brooks Interface package includes the following
hardware:
•
(1) Cleaver Brooks Interface CIO Module
The following hardware must be customer supplied:
Required
Conditions
Related
Documentation
•
(1) RS-485 cable.
•
(2) 28 Vdc or 18/20 Vac power supplies to provide CIO Module
power. Two power supplies are required because a separate and
isolated power supply must be used for the module's secondary
port, PWR2, to isolate the COMM2 port from the CCN.
•
(1) enclosure (optional). The enclosure should be big enough to
house the CIO Module flush mounted (11.25 in H x 1.875 in W
x 6.30 in D) with ample clearance to allow for access to connectors. The enclosure should also have ventilation holes on each
side.
The location for the interface must meet the following requirements:
•
It must be close enough to the Cleaver Brooks connector so that
the length of the RS-485 cable is less than 1000 feet.
•
The CCN Bus wire must be available to connect the interface to
the CCN.
•
(2) power outlets must be available at the installation location.
•
The optional enclosure must be mounted.
•
You must ensure that the air temperature around the interface is
within 32–120 °F, with from 10–90% relative humidity (noncondensing).
For additional information about the Cleaver Brooks Interface, see
the following:
•
•
Cleaver Brooks Interface Installation Instructions (808-990)
Cleaver Brooks Interface Product Data Sheet (808-985)
3
4
Operating
Characteristics
Operating
Characteristics
The following sections describe in greater detail some of the operating features and requirements of the Cleaver Brooks Interface.
Cleaver Brooks
Equipment
Requirements
Cleaver Brooks
Terminal Settings
The actual device to which the Cleaver Brooks Interface connects is
a Cleaver Brooks General Purpose Interface ControlBus™ Module
(Model 833-2757), equipped with a QS7850 card. This will be
plugged into a CB-Link module, which is then connected to the
Cleaver Brooks control devices. In order for the Cleaver Brooks
equipment to be accessible to a CCN, it must be part of a system
that contains a ControlBus Module.
The interface is designed to work with standard Cleaver Brooks
terminal settings. In order to work properly, the Cleaver Brooks
terminal must have the following settings:
Alarm
Comm
Default
EOL
Binary
ASCII
Mapping
Node
Pacing (0.1s)
Queue size
Reply time-out (sec.)
ASCII time-out (sec.)
Binary time-out (sec.)
Turnaround (ms.)
Listen interval (ms.)
Zapped
ROM version
Note:
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
=
0
41
00
CRLF
ON
ON
ON
0
5
20
6
30
1
6
40
NO/YES
1.6 (or later)
You cannot configure or change the Cleaver Brooks
terminal settings from the CCN; see your Cleaver Brooks
documentation if you need to change the settings for your
equipment.
5
Note that the RS-485 communication settings are configured separately; see the Port Configuration Table section in this manual's
Configuration chapter for details.
Polling
Considerations
Polling is the central operation performed by the interface. The CCN
points configured in the interface do not reflect changes in the
Cleaver Brooks points in real-time. Instead, the interface polls the
Cleaver Brooks controllers at regular intervals, and writes updated
data to its own tables. The polling interval is individually specified
for each CCN point.
The polling process is as follows (for simplicity, this list does not
take into account writing data to Cleaver Brooks points, described in
the next section):
1. The interface continuously scans a table of all the points.
2. When it comes to a point that is configured, it compares the time
it was last polled to the polling interval specified for that point.
3. If the elapsed time since the last read is less than the polling
interval, it does nothing and moves on to the next point (Step 1).
If the elapsed time since the last read exceeds the polling interval (or if the point has never been read), it will read the point
from the Cleaver Brooks controller.
4. The interface then updates its maintenance tables as appropriate
with the new data.
Due to the limitations of RS-485 serial communication, it takes
approximately 3 seconds per point to poll the Cleaver Brooks
controller (in Step 3 above). Thus, for interfaces with more than a
few points configured, the length of time required to poll all the
points can be substantial, and can quickly become greater than the
desired polling interval for any particular point. For example, if
you’ve configured 100 points, the interface would need 300 seconds
(100 times 3) to complete a polling operation; therefore, a poll rate
for any point of less than 300 seconds could not be reliably executed.
6
If you have critical points that need to be polled more frequently,
though, you can “free up” polling time for those points by specifying a greater polling time for the other points. In a 100-point system,
if most of the points had a polling time of 750 seconds, for example,
you could have a couple of selected points polled more frequently—
say, every 20 seconds—since in Step 3 most of the points would be
skipped over most of the time.
The Communication Status field in the Maintenance Table
(MAINT) has a flag which indicates whether or not the last polling
operation for that point was successful; see the Maintenance chapter
for more information.
Note that you can also disable polling for any point by specifying a
poll rate of 0. For any such point, if the point has been successfully
polled before the poll rate of 0 was entered, the maintenance table
will show the last value read. The point will not be polled again
until the poll rate is changed to a non-zero value.
Writing Data
The interface can also write data to Cleaver Brooks points in response to requests from other CCN devices. When the interface
receives a CCN request to write data to a particular point, the request and the data to be written are both stored in the interface’s
maintenance table.
The following describes how write requests are incorporated in the
polling process:
1. Before the interface compares the last-read time to the polling
interval, it checks to see if a write request is pending.
2. If there is a write request, it writes the specified value to the
point, and then immediately does a read.
3. If the time since the last read exceeds the poll interval, it reads
the point again; otherwise, it moves on to the next point in its
database.
The interface maintains a write-status field in the Maintenance
Table (MAINT).
7
Because Step 2 actually involves both a write and a read operation, a
write request actually takes approximately 5–6 seconds to complete.
Note that not all Cleaver Brooks points will allow write operations;
see your Cleaver Brooks documentation if you are not sure about a
particular point.
Units
8
The interface does not keep track of the units for any point. It is
your responsibility to know the units for each point you wish to
access.
Configuration
Configuration
The Cleaver Brooks Interface contains four tables of configuration
information:
Ctlr-ID
ALARMDEF
PORTCFG
PTCNFG
Controller Identification Table
Alarm Configuration Table
Port Configuration Table
Point Configuration Table
Once the interface is installed, use Carrier’s Network Service Tool
or ComfortWORKS to configure these tables. Each table is described
in a following section. Be sure to read the Configuration Overview
section below first.
Configuration
Overview
Follow the steps below to configure the Cleaver Brooks Interface. A
complete description of each configuration table, along with accompanying table decision descriptions, follows this overview.
1.
Note the address settings of each ControlBus Module in the
Cleaver Brooks system. For each ControlBus Module, note the
node number of its CB-Link; the slot number inside the CBLink; and the device number of the component to which it
connects.
2.
Decide which Cleaver Brooks points you wish to configure as
CCN points. For each point, note the following:
•
•
•
•
•
Cleaver Brooks point number
type of point (discrete vs. analog)
data type and format
scaling factor
the settings for the ControlBus Module which connects to
its controller.
Use the CONFGnn Table configuration sheet at the back of
this manual to record the settings. See your Cleaver Brooks
documentation if you need help identifying the above information for any point.
3.
If necessary, use the Network Service Tool to change the
interface’s CCN address (the default address is 0, 145).
4.
Use the Service Tool, Building Supervisor, or ComfortWORKS to add the interface to your CCN’s database.
9
Controller
ID Table
5.
Configure, download, and save the Controller ID (Ctlr-ID)
Table.
6.
Configure, download, and save the Alarm Configuration
(ALARMDEF) Table.
7.
Configure, download, and save the RS-485 Port Configuration
(PORTCFG) Table.
8.
Use the worksheets you completed in Step 2 to configure,
download, and save the Point Configuration (PTCNFG)
Tables.
The Controller ID Configuration (Ctlr-ID) Table identifies the
interface to the rest of the CCN. You can enter a Name (of no more
than 8 characters), Description, and Location. The Description and
Location can be any text you wish.
The Alarm Configuration (ALARMDEF) Table, shown in Figure 1,
Alarm Configuration determines the handling of alarms generated by the interface. The
Table
interface will generate an alarm after 10 consecutive communication
time-outs when polling the configured points. The interface returns
to normal after the first complete scan without 10 consecutive timeouts. The following paragraphs describe each of the table’s decisions.
Alarm Routing Control
This decision determines which CCN elements will receive and
process alarms sent by the interface. Input for the decision consists
of eight digits, each of which can be set to either 0 or 1. Setting a
digit to 1 specifies that alarms will be sent to the system element
that corresponds to that digit. Setting all digits to 0 disables alarm
processing. The digits correspond to CCN system elements in the
following manner:
Alarm Printer Interface Module
Autodial Gateway
Local Building
Supervisor(s)/ComfortWORKS
11010000
unused
10
Figure 1
Alarm Configuration
Screen
CB_ALARM
Alarm routing control
Value
11000000
0
Description
Alarm routing control
Equipment priority
Comm failure retry time
10
255
Re-alarm time
Alarm system name
Alarm Equipment
Priority
Units
Name
ALRM_CNT
min
min
RETRY_T
Notes
EQP_TYPE
CLVRBRKS
RE-ALARM
ALRM_NAM
Allowable Entries
0 = enabled
1 = disabled
Default Value
11000000
ComfortWORKS or Building Supervisor uses the value in this
decision when sorting alarms by level. When commanded to sort by
level, the alarms are first arranged according to their alarm levels.
(The alarm level for each CCN controller is a hard-coded value that
cannot be changed.) Within any group of alarms that all have the
same level, the alarms are sorted by Alarm Equipment Priority.
When alarms of the same level are arranged by priority, those with a
priority of 0 appear first and those with a priority of 7 appear last.
Equipment priority numbers are pre-assigned based on equipment
type, and you are advised not to change them.
Communication Failure
Retry Time
Allowable Entries
0–7 (priority numbers)
Default Value
0
In this decision specify the amount of time that will be allowed to
elapse between alarm retries. Retries occur when an alarm is not
acknowledged by a network alarm acknowledger, which may be
either a Building Supervisor, an Autodial Gateway, or Comfort-
11
WORKS. If acknowledgment is not received, the alarm will be retransmitted after the number of minutes specified in this decision.
Realarm Time
Allowable Entries
1 to 240 (minutes)
Default Value
10
In this decision specify the amount of time that will be allowed to
elapse between realarms. A realarm occurs when the condition that
caused the initial alarm continues to persist for the number of
minutes specified in this decision. Realarming will continue to occur
at the specified interval until the condition causing the alarm is
corrected.
Realarm should be disabled (set to 255).
Alarm System Name
12
Allowable Entries
1 to 254 (minutes)
255 = realarming disabled
Default Value
255
This decision specifies the system element name that will appear in
alarm messages generated by the interface.
Allowable Entries
Up to 8 alphanumeric characters
Default Value
CLVRBRKS
Point
Configuration
Tables
The Point Configuration (PTCNFG) Table consists of 20 tables
named CONFG01 through CONFG20. Each of these can contain up
to 25 points, for a total of 500 points.
The way that the Cleaver Brooks points are organized, grouped, and
distributed among the different tables is user configurable.
After you select one of the twenty different tables, you will see a
Point Configuration Screen similar to the one shown in Figure 2,
which will display the configuration values for the first point in the
file, or default values if the first point has not been defined.
CCN Point Name
Cleaver Brooks
Node No.
Use this decision to assign a CCN name to the Cleaver Brooks
point. BEST/BEST++ programs and other CCN system elements
will have no access to the Cleaver Brooks point name, and will use
this name instead. Each point must have a unique CCN Point Name.
Allowable Entries
Up to 8 ASCII characters (letters,
numbers, symbols, but no spaces)
Default Value
None
Use this decision to specify the node number of the CB-Link that
houses the ControlBus Module to which the interface is connected.
See your Cleaver Brooks documentation for more information about
nodes and node numbers.
Allowable Entries
0–255
Default Value
0
13
Figure 2
Point Configuration
Screen
PTCNFG01
CCN Point Name
DESCRIPTION
CCN Point Name
Cleaver Brooks Node No
VALUE
POINT_3
0
Cleaver Brooks
Device No.
14
CB_DA
CB_POINT
3
Analog
PT_TYPE
POLLRATE
120
Point Poll Rate
Cleaver Brooks Slot No.
CB_NN
20
Cleaver Brooks Device No
NOTES
PT_NAME
CB_NODE
1
Cleaver Brooks Slot No
Cleaver Brooks Point
Point Type
NAME
UNITS
Use this decision to specify the CB-Link slot into which the
ControlBus module is plugged. See your Cleaver Brooks documentation if you need help in identifying the slot number.
Allowable Entries
0–255
Default Value
0
Use this decision to specify the number of the Cleaver Brooks
device connected to the CB-Link. See your Cleaver Brooks documentation if you need help in identifying the device number.
Allowable Entries
0–255
Default Value
0
Cleaver Brooks Point
Point Type
Point Poll Rate
Use this decision to specify the number of the Cleaver Brooks point
referred to by this CCN point definition. See your Cleaver Brooks
documentation for a list of the point numbers in your Cleaver
Brooks device.
Allowable Entries
0–65535
Default Value
0
Use this decision to specify whether the point is analog or discrete.
Use the spacebar to toggle between Analog and Discr.
Allowable Entries
Analog or Discr
Default Value
Discr
The poll rate determines the length of time (in seconds) between
queries of the ControlBus Module for the value of the point. Setting
the poll rate to 0 disables polling for that point. Read the Polling
Considerations section of this manual’s Operating Characteristics
chapter for important information about polling and polling intervals.
Allowable Entries
0–65535
Default Value
0
15
Port Configuration
Table
Baud Rate
Parity
The Port Configuration (PORTCFG) Table lets you set the communication characteristics of the interface’s RS-485 port. The settings
you enter in this table must agree with the RS-485 settings on the
ControlBus Module. You cannot modify the ControlBus Module’s
settings from the CCN.
Use this decision to specify the baud rate for communication between the two devices.
Allowable Entries
1 (1200 baud); 2 (2400 baud);
3 (4800 baud); 4 (9600 baud)
Default Value
4 (9600 baud)
Use this decision to specify a parity-check method.
Allowable Entries
0 (no parity); 1 (odd parity);
2 (even parity)
Default Value
0 (no parity)
Figure 3
Port Configuration
Screen
PORTCFG
Baud Rate
DESCRIPTION
Baud Rate
UNITS
No. of Data Bits
4
0
8
No. of Stop Bits
1
Parity
16
VALUE
NAME
BAUDRATE
PARITY
DATABITS
STOPBITS
NOTES
No. of Data Bits
No. of Stop Bits
Use this decision to specify the word-length.
Allowable Entries
7 or 8
Default Value
8
Use this decision to specify the number of stop bits.
Allowable Entries
1 (1 stop bit); 2 (2 stop bits);
3 (1.5 stop bits)
Default Value
1
17
18
Maintenance
Maintenance
The data that the interface reads from the Cleaver Brooks equipment
is stored in the Maintenance (MAINT) Table. This consists of 20
separate tables named PTMAIN01 through PTMAIN20, each of
which displays the data for up to 25 points. The order of points in
these tables mirrors that of the configuration tables described in the
Configuration chapter. Figure 4 shows a sample maintenance table
screen.
CCN Point Name
This field displays the name assigned to the CB point for CCN
purposes. BEST/BEST++ programs and other CCN products have
no access to the Cleaver Brooks point name, but use this name
instead.
Up to 8 ASCII characters (letters,
numbers, symbols, but no spaces)
Valid Display
Cleaver Brooks Point
This field displays the number of the Cleaver Brooks point referred
to by this CCN point definition. See your Cleaver Brooks documentation for a list of the point numbers in your Cleaver Brooks device.
0–65535
Valid Display
Figure 4
Maintenance
Table Screen
PTMAIN01
CCN Point Name
DESCRIPTION
CCN Point Name
Cleaver Brooks Point
Data Type
Scaling
Point Type
Point Value
VALUE
POINT_3
1
1
0
Analog
2.0
UNITS
NAME
NOTES
PT_NAME
CBPT
DT_TYPE
SCALING
PT_TYPE
VALUE
WR_STAT
Write Status
Write Value
0.0
WR_VALUE
Communication Status OK
No
COMMSTAT
19
Data Type
This field displays the point’s data type. Data types range from 1byte signed integer to 4-byte unsigned integer.
Valid Display
Scaling
This field displays the scaling factor which is to be applied to the
point value to calculate the proper data.
Valid Display
Point Type
-99999.9–999999.9
This field indicates whether the last polling operation was concluded successfully or not.
Valid Display
20
24-character ASCII string
This field displays the value which is to be written to the Cleaver
Brooks point, which the interface has received from another CCN
element or BEST/BEST++ program.
Valid Display
Communication
Status OK
-99999.9–999999.9
This field indicates whether a write request is pending for that point,
or the results returned by a write operation.
Valid Display
Write Value
Analog or Discr
This field displays the most recent value returned by the polling
operation for the given point.
Valid Display
Write Status
-127–127
This field indicates whether the point is analog or discrete.
Valid Display
Point Value
0–10
YES or NO
Configuration
Sheets
1 of 1
COMFORT
NETWORK
Controller Name:_____________________________________
Bus #___________ Element #___________
Table Description:___________________________________________________ Table Name: ALARMDEF
ALARM (ALARMDEF) CONFIGURATION SHEET
Description
Limits
Units
Alarm Routing Control
00000000-11111111
Binary
Alarm Equipment Priority
0-7
Priority #s
Comm Failure Retry Time
1-240
Minutes
Realarm Time
1-255
Minutes
Alarm System Name
8 Characters
Text
Value
21
COMFORT
Sheet 1 of 1
NETWORK
Controller Name:_______________________________
Bus #___________ Element #___________
Table Description:______________________________________________ Table Name: CONFG_____
CLEAVER BROOKS INTERFACE POINT CONFIGURATION TABLE
DESCRIPTION
LIMITS
CCN Point Name
8 characters
Cleaver Brooks Node No.
0 to 255
Cleaver Brooks Slot No.
0 to 255
Cleaver Brooks Device No.
0 to 255
Cleaver Brooks Point
0 to 65535
Point Type
0/1
Poll Rate
0 to 65535
DESCRIPTION
22
LIMITS
CCN Point Name
8 characters
Cleaver Brooks Node No.
0 to 255
Cleaver Brooks Slot No.
0 to 255
Cleaver Brooks Device No.
0 to 255
Cleaver Brooks Point
0 to 65535
Point Type
0/1
Poll Rate
0 to 65535
UNITS
VALUE
seconds
UNITS
seconds
VALUE
Index
Index
P
A
Alarm Definition Table 10
ALARMDEF Configuration Table
Alarms
alarm system name 12
re-alarm time 12
retry time 11
routing 10
C
Cleaver Brooks Equipment
device number 14
requirements 5
Cleaver Brooks Points
reading data from 6
writing data to 7, 20
Communication Status 20
Configuration
procedure overview 9
Configuration Tables
ALARMDEF 10
Ctlr_ID 10
PORTCFG 16
PTCNFG 13
ControlBus Module 5
node 13
slot 14
terminal settings 5
Controller ID Table 10
Ctlr-ID Configuration Table 10
10
Point Configuration Table 13
Point Type 15, 20
Points
analog/discrete 15, 20
CB point number 15, 19
CCN name 13
configuring 9
data types 20
point name 13, 19
polling rate 15
scaling 20
units 8
value 20
writing values to 7, 20
Polling 6
polling rate 15
success/fail flag 20
PORTCFG Configuration Table 16
Power Requirements 3
PTCNFG Configuration Table 13
R
RS-485 Port
configuration table
settings 16
16
S
Scaling Factor
D
U
Data Types 20
Device Number
CB equipment
Units 8
20
W
14
E
Writing to CB points 7, 20
write status 20
Environmental Requirements
3
H
Hardware
3
I
Installation
hardware
3
M
MAINT Maintenance Table 19
Maintenance Tables
MAINT 19
23
24
Reader's
Comments
Your comments regarding this manual will help us improve future
editions. Please comment on the usefulness and readability of this
manual, suggest additions and deletions, and list specific errors and
omissions.
Document Name:
Publication Date:
Usefulness and Readability:
Suggested Additions and Deletions:
Errors and Omissions (Please give page numbers):
Date:
Name:
Title or Position:
Organization:
Address:
Fold so that the mailing address is visible, staple closed,
and mail.
Carrier Corporation
Carrier World Headquarters Building
One Carrier Place
Farmington, CT 06034-4015
Attn: CCN Documentation
SCP
Printed in U.S.A.
808 - 984 12/97