Summary of the content on the page No. 1
A Sierra Monitor Company
Driver Manual
(Supplement to the FieldServer Instruction Manual)
FS-8700-80 McQuay Micro Tech
Open Protocol
APPLICABILITY & EFFECTIVITY
Effective for all systems manufactured after May 1, 2001
Driver Version: 1.03
Document Revision: 2
Summary of the content on the page No. 2
McQuay Micro Tech Open Protocol Driver Manual Table of Contents TABLE OF CONTENTS 1. McQuay Micro Tech Open Protocol Description ..........................................................................3 2. Driver Scope of Supply....................................................................................................................5 2.1. Supplied by FieldServer Technologies for this driver.....................................................................5 rd 2.2. Provide
Summary of the content on the page No. 3
McQuay Micro Tech Open Protocol Driver Manual Page 3 of 35 1. McQuay Micro Tech Open Protocol Description This document describes the FieldServer driver used to transfer data between a FieldServer and MicroTech® controllers. Transfers are done using the controller's Data Terminal Communications Protocol. In this document the protocol is referred to as the McQuay Micro Tech Open Protocol. The McQuay Micro Tech Open Protocol driver allows the FieldServer to transfer data to and from d
Summary of the content on the page No. 4
McQuay Micro Tech Open Protocol Driver Manual Page 4 of 35 PC Connection The PC connection to a MicroTech controller is through an available port A that is configured as TTY. It is best to connect the PC to a level-1 controller because data transmission is the fastest. However, a PC can be connected to any level-2 controller that does not have level-3 controllers connected to it or to any MicroTech level-3 controller. Regardless of where you connect the PC, you have access to the entire
Summary of the content on the page No. 5
McQuay Micro Tech Open Protocol Driver Manual Page 5 of 35 2. Driver Scope of Supply 2.1. Supplied by FieldServer Technologies for this driver FieldServer Technologies PART # DESCRIPTION FS-8917-16 RJ45 to terminal connector cable. rd 2.2. Provided by Supplier of 3 Party Equipment PART # DESCRIPTION McQuay Motor Mount Connector for Port A connection 3. Hardware Connections The FieldServer is connected to the McQuay device as shown below. Configure the McQuay device accordin
Summary of the content on the page No. 6
McQuay Micro Tech Open Protocol Driver Manual Page 6 of 35 4. Configuring the FieldServer as a McQuay Micro Tech Open Protocol Client For a detailed discussion on FieldServer configuration, please refer to the FieldServer Configuration Manual. The information that follows describes how to expand upon the factory defaults provided in the configuration files included with the FieldServer. (See “.csv” sample files provided with the FieldServer). This section documents and describes the p
Summary of the content on the page No. 7
McQuay Micro Tech Open Protocol Driver Manual Page 7 of 35 4.2. Client Side Connection Descriptors Section Title Connections Column Title Function Legal Values Specify which port the device is 1 Port P1-P8, R1-R2 connected to the FieldServer 300, 1200, 2400, 4800 and 9600 Baud* Specify baud rate baud (Vendor limitation). Parity* Specify parity Even (Vendor limitation) Data_Bits* Specify data bits 7 (Vendor limitation) Stop_Bits* Specify stop bits 1 Protocol Specify protocol used
Summary of the content on the page No. 8
McQuay Micro Tech Open Protocol Driver Manual Page 8 of 35 4.3. Client Side Node Descriptors Section Title Nodes Column Title Function Legal Values Up to 32 Node_Name Provide name for Node alphanumeric characters Network address of the device being polled. If the network address field is set to $00FF, the controller will Node_ID respond to the packet without regard to its own internal network address 0-255 This parameter must be used If units are connected to the FieldServer v
Summary of the content on the page No. 9
McQuay Micro Tech Open Protocol Driver Manual Page 9 of 35 4.4. Client Side Map Descriptors 4.4.1. FieldServer Related Map Descriptor Parameters Column Title Function Legal Values Up to 32 alphanumeric Map_Descriptor_Name Name of this Map Descriptor characters Name of Data Array where One of the Data Array names data is to be stored in the from “Data Array” section Data_Array_Name FieldServer above 0 to maximum specified in Data_Array_Offset Starting location in Data Array “Data
Summary of the content on the page No. 10
McQuay Micro Tech Open Protocol Driver Manual Page 10 of 35 4.4.4. Map Descriptor Example 1 – Read Everything. In this example the Map Descriptor tells the driver to read all data fields known for the Node. The data fields are read sequentially and the value obtained placed in the Data Array at a location determined by the driver. Appendix A.2 outlines the data read and the Data Array location of each field. There is no way of telling this command to read some fields more often than other
Summary of the content on the page No. 11
McQuay Micro Tech Open Protocol Driver Manual Page 11 of 35 4.4.5. Map Descriptor Example 2 – Read a particular Data Field. This example illustrates how to read data for one particular field of interest. The data is read every 2.0 seconds and the value obtained is stored in the Data Array named DA_OPERATIONAL_MODES at location 10. Map_Descriptor_Name ,Data_Array_Name , D ata_Array_Offset ,Function ,Scan_Interval ,Node_Name ,Length ,Field_Name Chiller10_O
Summary of the content on the page No. 12
McQuay Micro Tech Open Protocol Driver Manual Page 12 of 35 5. Configuring the FieldServer as a McQuay Micro Tech Open Protocol Server 5.1. Server Side Connection Descriptors Section Title Connections Column Title Function Legal Values Specify which port the device is 3 Port P1-P8, R1-R2 connected to the FieldServer 300, 1200, 2400, 4800 and 9600 Baud* Specify baud rate baud (Vendor limitation) Parity* Specify parity Even (Vendor limitation) Data_Bits* Specify data bits 7 (Vendor
Summary of the content on the page No. 13
McQuay Micro Tech Open Protocol Driver Manual Page 13 of 35 5.2. Server Side Node Descriptors Section Title Nodes Column Function Legal Values Title Up to 32 Node_Name Provide name for node alphanumeric characters Network address of the device being polled. If the network Node_ID address field is set to $00FF, the controller will respond to the packet without regard to its own internal network address 0-255 This parameter must be used If units are connected to the Route Field
Summary of the content on the page No. 14
McQuay Micro Tech Open Protocol Driver Manual Page 14 of 35 5.3. Server Side Map Descriptors 5.3.1. FieldServer Specific Map Descriptor Parameters Column Title Function Legal Values Up to 32 alphanumeric Map_Descriptor_Name Name of this Map Descriptor characters Name of Data Array where One of the Data Array names data is to be stored in the from “Data Array” section Data_Array_Name FieldServer above 0 to maximum specified in Data_Array_Offset Starting location in Data Array “Dat
Summary of the content on the page No. 15
McQuay Micro Tech Open Protocol Driver Manual Page 15 of 35 5.3.4. Map Descriptor Example – Strategy 1. This example illustrates how you can configure the FieldServer as a McQuay Micro Tech Open Protocol Server. A single Map Descriptor is used to emulate a McQuay device’s memory as one large single block of bytes. Any requests in the address range 1-0x270F can be serviced by this one Map Descriptor. The strategy is simple but has one drawback; a large Data Array which will be mostly empt
Summary of the content on the page No. 16
McQuay Micro Tech Open Protocol Driver Manual Page 16 of 35 5.3.5. Map Descriptor Example – Strategy 2. This example differs from the previous example, in that it divides the memory being emulated into chunks to avoid having a large sparse array. When a poll is received, the driver looks through the Map Descriptors and finds one with a matching node and one whose address and length cover the poll’s address. Map_Descriptor_Name ,Data_Array_Name ,Data_Array_Offset ,Function ,Node_Name
Summary of the content on the page No. 17
McQuay Micro Tech Open Protocol Driver Manual Page 17 of 35 Appendix A. Advanced Topics Appendix A.1. Scaling User Scaling: The user can specify scaling in the configuration file which allows a value to be scaled before being stored in a Data Array or after being extracted from a data for writing to McQuay device. This scaling is specified by using the following keywords in Map Descriptor definition. Data_Array_Low_Scale, Data_Array_High_Scale, Device_Low_Scale, Device_High_Scale
Summary of the content on the page No. 18
McQuay Micro Tech Open Protocol Driver Manual Page 18 of 35 ♣ ♣ ♣ ♣ Appendix A.2. Data Field Name Tables If you do not know the field name it is possible to read the device by specifying the address only. More information is provided in Appendix A.4 Table 2 – Equipment Type: 200CFC 200 Series Centrifugal Chiller Read/ Device Array Number Base Write/ Field Name Scaling Location of Bytes Address 5 Both Method 1 r Model 3 0x0A08 1
Summary of the content on the page No. 19
McQuay Micro Tech Open Protocol Driver Manual Page 19 of 35 Read/ Device Array Number Base Write/ Field Name Scaling Location of Bytes Address 5 Both Method 56 r Condenser Water Temperature - Leaving 2 0x0434 3 58 r Cooling Tower Control 1 0x0926 1 59 r Cooling Tower Stage 1 0x049A 1 60 r Cooling Tower Valve Position 1 0x049B 1 61 r Discharge Refrigerant Temperature
Summary of the content on the page No. 20
McQuay Micro Tech Open Protocol Driver Manual Page 20 of 35 Read/ Device Array Number Base Write/ Field Name Scaling Location of Bytes Address 5 Both Method 115 b Communications Signal 1 0x047D 1 116 b Outdoor Air Temperature - BAS 1 0x0473 5 117 b Master/Server Setpoint 1 0x093C 1 118 b Lead/Lag Mode Setpoint 1 0x093D 1 119 b Enable Lag Setpoint
