CCN DATAPORT
Overview and Configuration Manual
CCN DATAPORT
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.
© 1990, Carrier Corporation, Syracuse, NY 13221
Contents Introduction␣ .......................................................................... 1 General Information ................................................... 1 About this Manual ...................................................... 2
Operating Characteristics␣ .................................................. 3 CIO Module ............................................................... 3 DATAPORT Functions.............................................. 5
Configuration and Maintenance Screens .......................... 13 Configuration Decisions .......................................... 13 Maintenance Decisions ............................................ 17
Off-Network Control␣ .......................................................... 21 Commands ............................................................... 21 Error Codes .............................................................. 25 Figures
Tables
Figure 1
CIO Module ............................................ 3
Figure 2
DATAPORT Configuration Screen...... 14
Figure 3
DATAPORT Maintenance Screen ....... 17
Table 1
Three Digit Units Codes ......................... 8
Table 2
Error and Network Command Conditions Represented by the Three Digit Status Display ................... 15
iii
iv
Introduction General Information
The CCN DATAPORT made by Carrier Corporation is an interface through which certain data from one or more devices connected to a CCN Communications Bus can be transmitted to a non-CCN device. It is for use in applications that require the transfer of status information from a CCN controller to a device, not manufactured by Carrier, that cannot be connected to a CCN Communications Bus. A DATAPORT is a read-only device. It does not convey data from the off-network, non-CCN device onto the CCN bus. This manual describes the purpose, function, and operation of the DATAPORT. It includes descriptions of the DATAPORT’s physical characteristics, the screen displays by which an operator interacts with the DATAPORT from a Building Supervisor or CCN Service Tool, and the command and error codes by which an off-network interacts with the DATAPORT. The data that can be transmitted through a DATAPORT is maintenance and operating information that is contained in a CCN controller’s Point Screen. The DATAPORT reads the data from the controller, converts it into ASCII characters, and transmits it to the off-network device. The off-network device receiving the data may be either a non-Carrier controller that employs the data as input to a control routine, or a personal computer. The CCN controllers from which the DATAPORT can transmit data have to be specified in the DATAPORT’s configuration table, which is accessible by means of a Building Supervisor or CCN Service Tool. The actual transmission of data is controlled by commands sent form the off-network device that is to receive the data. A Building Supervisor or CCN Service Tool can also display a DATAPORT maintenance screen that shows information about how the DATAPORT is operating. The controllers from which the DATAPORT can transmit Point Screen data include PICs and CIO Module-based devices such as the CPOC and the 32MP Gateway. The DATAPORT cannot transmit data from a FID.
1
About This Manual
This manual is intended for use by an operator who has access to both the off-network device that is to receive data from the DATAPORT and the CCN system in which the DATAPORT is installed. It is divided into four sections: • •
•
•
2
Introduction contains brief descriptions of the DATAPORT and the Manual. Operating Characteristics describes the CIO Module in which the DATAPORT runs and the functions that the DATAPORT performs. Configuration and Maintenance Screens describes the decisions that appear on the screens an operator can access from a CCN Building Supervisor or Service Tool to configure a DATAPORT or monitor its operation. Off-Network Control describes the commands that be sent from the off-network device to the DATAPORT to control its operation and the error messages that the DATAPORT can send to the off-network device when a command cannot be carried out.
Operating Characteristics A DATAPORT consists of a CIO Module equipped with specialized software to perform the tasks required of it. Those tasks consist of requesting Point Screen data from the appropriate CCN controllers on the CCN Communications Bus, translating the data into ASCII characters, and outputting those characters through the CIO Module’s RS-232 COMM2 connector.
The CIO Module is shown in Figure 1. When used as a DATAPORT, the CIO Module employs the 4-pin, Phoenix-type connector labeled COMM1 and the 25-pin, D-shell connector labeled COMM2.
1
2
3
1
2
3
Figure 1 CIO Module
R1
R2
2
3
4
PW 1
M1
M CO
MM
4 3 2 1
CIO Module
CO
PW
T# ) EN AL EM IM ELADEC X X (HE X
S1 S2
2
r
rie
r Ca
3
COMM1 is the DATAPORT’s connection to a CCN Communication Bus. The bus, which uses RS-485 signaling, may operate at 1200, 2400, 4800, or 9600 bits per second. It typically operates at 9600. A DATAPORT may reside on any CCN Communications Bus, 0-239, and may be assigned any system element number, 1239. The DATAPORT’s default address is bus 0, system element number 110. The CCN Network Configuration Tool (NCT) may be used to change the DATAPORT’s bus and element numbers and the operating rate for COMM1. COMM2 is the DATAPORT’s connection to the off-network device that is to receive the ASCII characters. It accepts and transmits RS232 signals at a rate of 1200, 2400, 4800, or 9600 bits per second. The operating rate of COMM2 is set from a Building supervisor or a Service Tool by means of a configuration decision in the DATAPORT. The DATAPORT compensates for differences between the operating rates of COMM1 and COMM2. The cable between the off-network device and COMM2 of the DATAPORT can be up to 50 feet in length. Only four pins of the COMM2 connector are used in the DATAPORT’s RS-232 communications: • • • •
Pin 1 - protective ground Pin 2 - transmit data Pin 3 - receive data Pin 7 - signal ground
The DATAPORT employs software control to regulate the transmission of data through COMM2, so RS-232 control signals are not required on the other pins of the connector.
4
DATAPORT Functions
A DATAPORT can be configured with the addresses of up to 15 CCN controllers. The user configures the DATAPORT by entering each controller’s bus number and system element number in the DATAPORT’s configuration table. The DATAPORT maintains a database for its configured controllers that contains the following information (static data) for each point in each controller. • • •
Point name (up to eight alphanumeric characters) Units ( a three-digit code that identifies the unit of measure) Description (up to 24 alphanumeric characters)
There are three conditions that cause the DATAPORT to acquire new static data for its database. First, two minutes after the DATAPORT is powered on, it will poll its configured devices for static data. Second, it will poll automatically when a changed configuration table is downloaded to it. Third, it will poll in response to a Read Configuration command from the off-network device. The DATAPORT database can contain entries for up to 900 points, which works out to 60 points in each of 15 controllers. If controllers are configured that contain more than 60 points apiece, there is an effective reduction in the number of controllers that the DATAPORT can support. For example, if controllers are configured that contain 100 points apiece, all 15 sets of bus and system element numbers may still be entered in the configuration table, but only the first nine controllers will be accessible to a Send Controller Data command. If the offnetwork device were to command the DATAPORT to send data from any of the last six configured controllers, the DATAPORT would respond with an error message of 4, which means Database Full. The CCN controllers are associated by the order in which they are configured with single letter ASCII command A through O (in either upper or lower case). A is the Send Controller Data for
5
Controller 1 command and O is the Send Controller Data for Controller 15 command. Each Send Controller Data command instructs the DATAPORT to perform the following functions: •
• • •
read the dynamic data portion of a Point list display (value and status for each point) from the controller that corresponds to the command letter translate the data into ASCII characters format the characters together with the appropriate static data stored in the DATAPORT database transmit the result through COMM2
When commanded to transmit a CCN controller’s point data, the DATAPORT first transmits an ASCII Form Feed character. Then for each point in the requested controller the DATAPORT transmits a line of data in the following format: Name Value Units Status Description (Carriage Return) Single spaces are transmitted to separate Name, Value, Units, Status, and Description. A second Carriage Return is transmitted following the last point in the controller. The Carriage Return characters transmitted by the DATAPORT do not provide line feed. The point name consists of up to 8 alphanumeric characters. This name appears in the rightmost column on a Building Supervisor Points Screen. The point value may consist of up to ten characters. If the value is analog, it is presented in the same format in which it would appear on a Building Supervisor screen, that is, with the same number of digits and decimal point placement. If an analog point value is outside the range that can be represented by ten characters, the DATAPORT will transmit ten asterisks in place of the value. If the point value is discrete, it is presented as a 1 or a 0. The units designator transmitted through the DATAPORT takes the form of a three digit number. Table 1 explains how the numbers correspond to units of measure.
6
Status is also transmitted as a three digit number. Each status number represents a unique combination of an error condition and a force condition. Table 2 defines how to decode transmitted status numbers into error and force codes. Simply locate the displayed status number in the table. The table’s columns correspond to error conditions and its rows correspond to force conditions. The two lists below the table describe the conditions. The point description consists of up to 24 alphanumeric characters. Transmission of the description field can be suppressed by a command from the off-network device.
7
Table 1 Three Digit Units Codes
Customary US Units
Metric Units
000 001 002 003 004 005 006 007 008 010 011
no units degrees F degrees F percent inches of water milliamps delta degrees F degrees F delta degrees F Volts degrees F
256 257 258
no units degrees C degrees C
260
Pascals
262 263 264
delta degrees C degrees C delta degrees C
267
degrees C
013 014 015 016 017 018
percent inches of water milliamps delta degrees F degrees F delta degrees F
270
Pascals
272 273 274
delta degrees C degrees C delta degrees C
020
pounds per square inch
276
kiloPascals
032 033 034 035 036 037 038 039 040
gallons per minute gallons per hour thousands of gallons per minute thousands of gallons per hour pounds per square inch, gauge pounds per hour thousands of pounds per hour BTUs per hour thousands of BTUs
288 289 290 291 292 293
liters per minute liter per hour cubic meters per minute cubic meters per hour kiloPascals kilograms per hour
295 296
kilowatt hours kilowatts
(continued)
8
Table 1 (Continued) Three Digit Units Codes
Customary US Units
Metric Units
041 042 043 044 045 046 047 048 049 050 051 052
297 298 299 300 301 302 303 304 305 306 307
millimeters of water millimeters of mercury kilowatt hours kilowatts degrees C percent relative humidity amps volts cubic meters per minute cubic meters per hour meters per second
310 311 312 313 314 315
tons tons per hour revolutions per hour percent open hours liters
053 054 055 056 057 058 059
inches of water inches of mercury kilowatt hours kilowatts degrees F percent relative humidity amps volts cubic feet per minute cubic feet per hour feet per minute thousands of cubic feet per minute thousands of cubic feet per hour tons tons per hour revolutions per minute percent open hours gallons
(Continued)
9
Table 1 (Continued) Three Digit Units Codes
10
Units Common to Customary US and Metric 064 065 066 067 068 069 070
on/off input off/on input input pulses on input pulses off seconds normal/alarm Hz
080 081 082
minutes hours revolutions per minute
124
clock
126
ASCII
128
no units
133
milliamp
137 138
pounds per square inch volts
144 145 146
kilowatts kilowatt hours/pulse pulses
192 193 194 195
on/off output off/on output pulsed on output pulsed off output
208
steps
254
ASCII
Table 2 Error and Force Conditions Represented by the Three-Digit Status Display
Force Conditions
A
No Force Fire Safety Service Tool Supervisor Monitor Minimum-off Control BEST Temp Override Loadshed Error Conditions: A B C D E F Force Conditions: No Force Fire Safety Service Tool Supervisor Monitor Minimum-off Control BEST Temp Override Loadshed
000 016 032 048 064 080 096 112 128 144 160
= = = =
Error Conditions B C D
E
F
001 017 033 049 065 081 097 113 129 145 161
004 020 036 052 068 084 100 116 132 148 164
005 021 037 053 069 085 101 117 133 149 165
002 018 034 050 066 082 098 114 130 146 162
003 019 035 051 067 083 099 115 131 147 163
= =
no error hardware or communications error software error low alarm limit exceeded (analog point), or point in alarm (discrete point) high alarm limit exceeded unconfigured point (VVT Gateway only)
= = = = = = = = = =
forced by fire alarm equipment forced by internal safety override forced by CCN Service Tool forced by local Building Supervisor forced by remote Building Supervisor forced by minimum off time requirement forced by System Software Option forced by BEST program forced by temperature override forced by Loadshed System Software Option
11
12
Configuration and Maintenance Screens Configuration Decisions
The user configures the DATAPORT by means of decisions on a configuration table screen reached through the Carrier Controls function of a CCN Building Supervisor or Service Tool. The configuration table is identified by the name DATAPORTCONFIG. More detailed information on working with the Building Supervisor or the Service Tool can be found in their respective manuals. The DATAPORT Configuration Screen is shown on the next page in Figure 2. The figure is followed by explanations of the decisions that appear on the screen.
13
Figure 2 DATAPORT Configuration Screen
DTP_01S - #4
Save Upload Download Copy Edit Quit Modify data; Press F2 to activate menu. DESCRIPTION
Device 1 Bus Number Device 1 Element Number Device 2 Bus Number Device 2 Element Number Device 3 Bus Number Device 3 Element Number Device 4 Bus Number Device 4 Element Number Device 5 Bus Number Device 5 Element Number Device 6 Bus Number Device 6 Element Number Device 7 Bus Number Device 7 Element Number Device 8 Bus Number Device 8 Element Number Device 9 Bus Number Device 9 Element Number Device 10 Bus Number Device 10 Element Number Device 11 Bus Number Device 11 Element Number Device 12 Bus Number Device 12 Element Number Device 13 Bus Number Device 13 Element Number Device 14 Bus Number Device 14 Element Number Device 15 Bus Number Device 15 Element Number Port 2 Baud Rate Update Period
STATUS
0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 10
Carrier Controls 14
MODIFY CONTROLLER CONFIG
POINT
DEV1BUS DEV1ADDR DEV2BUS DEV2ADDR DEV3BUS DEV3ADDR DEV4BUS DEV4ADDR DEV5BUS DEV5ADDR DEV6BUS DEV6ADDR DEV7BUS DEV7ADDR DEV8BUS DEV8ADDR DEV9BUS DEV9ADDR DEV10BUS DEV10ADDR DEV11BUS DEV11ADDR DEV12BUS DEV12ADDR DEV13BUS DEV13ADDR DEV14BUS DEV14ADDR DEV15BUS DEV15ADDR P2BAUD UPDATPER
Device 1 Bus Number through Device 15 Bus Number
Each of these decisions can be used to input the bus number of a controller that can supply data to the DATAPORT. Allowable Entries 0 through 239 = bus numbers Default Value 0
Device 1 Element Number through Device 15 Element Number
Each of these decisions can be used to input the system element number of a controller that can supply data on the DATAPORT. Allowable Entries 0 = no controller configured 1 through 239 = system element numbers Default Value 1 for Device #1 0 for Devices #2 through 15
Port 2 Baud Rate
This decision is used to configure the operating rate, in bits per second, of the COMM2 connector through which the DATAPORT communicates with the off-network device. Allowable Entries 1 = 9600 bps 2 = 4800 bps 3 = 2400 bps 4 = 1200 bps Default Value 1
15
Update Period
The value entered in this decision specifies how frequently data is to be sent to the off-network device in response to a Send Data Periodically command. Allowable Entries 10 through 600 (seconds) Default Value 10
16
Maintenance Decisions
A Building Supervisor or Service Tool can display a maintenance table screen that shows the current state of the DATAPORT’s activities. The table is shown below in Figure 3. Explanations of the table’s maintenance decisions follow the figure. Detailed information on working with the Building Supervisor or the Service Tool can be found in their respective manuals.
Figure 3 Maintenance Screen
DTP_01S - #4
LIST POINT COMMANDS
Press Escape to end Maintenance Display DESCRIPTION
Current Device Number Device Update State Include Description
STATUS
0 0 Enable
POINT
DEV_NUM UPDSTATE INCDESC
Carrier Controls
17
Current Device Number
This maintenance decision displays a number in the range from 0 to 15. The numbers from 1 to 15 correspond to the CCN controllers that can be configured in the DATAPORT. The number 0 represents an idle condition under certain circumstances. If the DATAPORT is currently transmitting data in response to either a Send Controller Data command or a Send Data Periodically command, the number on display indicates the controller from which data is being sent. If the DATAPORT is not transmitting data because it is in between periodic transmissions or because it has completed a one shot transmission, the number on display indicates the last controller from which data was sent. If the DATAPORT is not transmitting data because the last command sent to it was Stop Sending (Escape Key), 0 is displayed. Display Values 0 = transmission stopped 1 through 15
Device Update State
This maintenance decision indicates whether or not the DATAPORT is currently transmitting data, and if it is, whether the transmission is a one-shot transmission in response to a Send Controller Data command or an on-going, periodic transmission in response to a Send Data Periodically command. Display Values 0 = idle 1 = one shot transmission in progress 2= periodic transmissions in progress
18
Include Description
This maintenance dicision indicates whether or not the DATAPORT has been commanded to include point descriptions in the data it transmits to the off-network device. Display Values Disable = descriptions not being transmitted Enable = descriptions being transmitted
19
20
Off-Network Control Commands
There are 22 commands that can be sent from the off-network device to the DATAPORT. Each command may be sent in the form of one ASCII character or its hexadecimal numeric equivalent. The 15 Send Controller Data commands, one for each controller that can be configured in the DATAPORT, are each represented by a single ASCII letter. If a keyboard is used to input commands from the off-network device to the DATAPORT, the letter commands may be sent in either upper or lower case. ASCII code represents the upper and lower case forms of a letter with different hexadecimal values. If commands are programmed into the off-network device as hexadecimal values, the hexadecimal equivalent of either upper or lower case may be used. The other seven commands are represented by ASCII control characters. One of those is the character generated by pressing a keyboard’s Escape (ESC) key. The remaining six are characters that are generated by simultaneously pressing the keyboard’s Control key and a letter key. The hexadecimal equivalents of the Control/ letter combinations are the same for both upper and lower case letters. In the list that appears on the next page, each DATAPORT command is identified by name, by the key or combination of keys used to input the command at a keyboard, and by the hexadecimal equivalent of the character.
21
Send Controller Data Commands
Controller Controller Controller Controller Controller Controller Controller Controller Controller Controller Controller Controller Controller Controller Controller
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
= = = = = = = = = = = = = = =
A B C D E F G H I J K L M N O
(41H) (42H) (43H) (44H) (45H) (46H) (47H) (48H) (49H) (4AH) (4BH) (4CH) (4DH) (4EH) (4FH)
or or or or or or or or or or or or or or or
a b c d e f g h i j k l m n o
(61H) (62H) (63H) (64H) (65H) (66H) (67H) (68H) (69H) (6AH) (6BH) (6CH) (6DH) (6EH) (6FH)
Each Send Controller Data command is a one-shot instruction for the DATAPORT to get point data from the specified controller and transmit it to the off-network device. Transmission of a controller’s point data may made to pause and resume by an XOFF command and an XON command, or stopped completely by a Stop Sending command. If the DATAPORT receives a Send Controller Data command while it is already transmitting data, it will immediately stop the transmission in progress and respond to the newly received command.
Send Data Periodically
Control/P or Control/p (10H) This command instructs the DATAPORT to periodically update and transmit point data from the controller that was specified by the most recent Send Controller Data command. The Update Period configuration decision determines how frequently the transmissions occur. Transmissions begun by this command may be made to pause and resume by the XOFF and XON commands. Transmissions may be stopped completely by a Stop Sending command, after which the DATAPORT will remain inactive until a new Send Controller Data or Send
22
Data Periodically command is issued. If the DATAPORT receives a Send Controller Data command while periodic transmissions are underway, it will immediately stop the transmission in progress and respond to the newly received command.
Stop Sending
Escape (1BH) This command instructs the DATAPORT to stop sending data to the off-network device. The DATAPORT stops at whatever point it has reached when the command is received and does not complete transmitting data from any remaining points in the controller. Once this command has been issued, the DATAPORT will not transmit any further data until it receives a new Send Controller Data or Send Data Periodically command.
XOFF
Control/S or Control/s (13H) This command instructs the DATAPORT to pause in sending data to the off-network device. The DATAPORT pauses at whatever point it has reached when the command is received and does not complete its transmission until it receives an XON command. Once an XOFF command is issued, the DATAPORT will not recognize any command except XON.
23
XON
Control/Q or Control/q (11H) This command instructs the DATAPORT to resume sending data to the off-network device after an XOFF command has made it pause. Transmission resumes from the point it had reached when the XOFF was received. This is the only command that a DATAPORT will recognize after it receives an XOFF command.
Omit 24 Character Description
Control/N or Control/n (0EH) This command instructs the DATAPORT not to include the 24 character point descriptions in the data it transmits. Once this command is issued, the descriptions will be omitted from all future transmissions until an Include 24 Character Description command is issued.
Include 24 Character Description
Control/D or Control/d (04H) This command instructs the DATAPORT to include the 24 character point descriptions in the data it transmits. The DATAPORT’s default condition is to transmit the descriptions, so the only reason to issue this command is to countermand a previous Omit 24 Character Description commnad.
Read Configuration
Control/T or Control/t (14H) This command instructs the DATAPORT to read the static data (point names, units, and descriptions) from all of the up to 15 controllers from which it may transmit data. The DATAPORT stores the static data for each point in its database to be transmitted along with the point’s dynamic data (value and status). The
24
DATAPORT reads static data from the controllers two minutes after it is prowered up, when it is downloaded with a changed configuration table, and in response to this command. This Read Configuration command should be issued from the off-network device any time changes are made to point names, unit designations, or point descriptions in the controller(s) from which the DATAPORT is to transmit data.
Error Codes
If the DATAPORT cannot successfully respond to a command from the off-network device, it will instead return an error code to the offnetwork device. There are six error codes, represented by the ASCII digits 1 through 6. A complete error message from the DATAPORT consists of an ASCII Formfeed control character, followed by the error code, followed by two ASCII Carriage Return control characters. The following paragraphs describe the interpretation of the six DATAPORT error codes.
1 Invalid Command
The digit 1 returned as an error code means that the last ASCII character sent to the DATAPORT by the offnetwork device is not one that the DATAPORT recognizes as a command.
2 No Display Table
The digit 2 returned as an error code means that the offnetwork device has commanded the DATAPORT to transmit data from a controller that is properly configured in the DATAPORT, but the controller does not contain a point display table.
25
26
3 CCN Bus Communication Error
The digit 3 returned as an error code means that the DATAPORT cannot transmit data from the requested controller because a communication error occurred while the DATAPORT was acquiring data from that controller.
4 Database Full
The digit 4 returned as an error code means that the offnetwork device has commanded the DATAPORT to transmit data from a controller that is properly configured in the DATAPORT, but the controller is beyond the 900 point limit. For example, if controllers 1 through 10 each contain 90 points, a command for the DATAPORT to transmit data from controller 11, 12, 13, 14, or 15 will result in error code 4.
5 DATAPORT Busy
The digit 5 returned as an error code means that a static data update is in progress, preventing the DATAPORT from responding successfully to a Send Controller Data Command or a Send Data Periodically command.
6 Controller Not Configured
The digit 6 returned as an error code means that the offnetwork device has commanded the DATAPORT to transmit data from a controller that is not configured in the DATAPORT. For example, if only controllers 1 through 5 are configured in the DATAPORT, a command of 0 (Send Controller Data for Controller 15) will result in error code 6.
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 - 619 1/90
