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: Document Revision: 1.
McQuay Micro Tech Open Protocol Driver Manual Table of Contents TABLE OF CONTENTS 1. McQuay Micro Tech Open Protocol Description .......................................................................... 3 2. 2.1. 2.2. Driver Scope of Supply.................................................................................................................... 5 Supplied by FieldServer Technologies for this driver .....................................................................
McQuay Micro Tech Open Protocol Driver Manual 1. Page 3 of 35 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.
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 network.
McQuay Micro Tech Open Protocol Driver Manual 2. Driver Scope of Supply 2.1. Supplied by FieldServer Technologies for this driver FieldServer Technologies PART # FS-8917-16 DESCRIPTION RJ45 to terminal connector cable. Provided by Supplier of 3rd Party Equipment 2.2. PART # 3. Page 5 of 35 DESCRIPTION McQuay Motor Mount Connector for Port A connection Hardware Connections The FieldServer is connected to the McQuay device as shown below.
McQuay Micro Tech Open Protocol Driver Manual 4. Page 6 of 35 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).
McQuay Micro Tech Open Protocol Driver Manual 4.2.
McQuay Micro Tech Open Protocol Driver Manual 4.3. Page 8 of 35 Client Side Node Descriptors Section Title Nodes Column Title Function Legal Values Up to 32 alphanumeric characters Node_Name Provide name for Node Node_ID Network address of the device being polled. If the network address field is set to $00FF, the controller will respond to the packet without regard to its own internal network address This parameter must be used If units are connected to the FieldServer via a routing device e.g.
McQuay Micro Tech Open Protocol Driver Manual 4.4. Page 9 of 35 Client Side Map Descriptors 4.4.1. FieldServer Related Map Descriptor Parameters Column Title Function Map_Descriptor_Name Name of this Map Descriptor Data_Array_Name Name of Data Array where data is to be stored in the FieldServer Data_Array_Offset Starting location in Data Array Function Function of Client Map Descriptor 4.4.2.
Map Descriptor Example 1 – Read Everything. Page 10 of 35 ,Function ,Rdbc ,Node_Name ,Chiller1 This parameter connects the Map Descriptor to a node which in turn connects the Map Descriptor to a port. ,Data_Array_Offset ,0 Each field read has its value stored in this Data Array. The location is dependent on the field name. Ensure that the length of the Data Array is at least 200, so that all parameters can be stored.
Map Descriptor Example 2 – Read a particular Data Field. Page 11 of 35 ,Data_Array_Name ,DA_OPERATIONAL_MODES ,Data_Array_Offset ,10 Map Descriptor Example 3 – Write. ,Function ,Rdbc ,Scan_Interval ,0s ,Node_Name ,Chiller10 ,Length ,1 ,Field_Name ,Chiller Operation Mode The data is only written when the contents of element zero of the array named DA_MODES changes.
McQuay Micro Tech Open Protocol Driver Manual 5. Page 12 of 35 Configuring the FieldServer as a McQuay Micro Tech Open Protocol Server 5.1.
McQuay Micro Tech Open Protocol Driver Manual 5.2. Page 13 of 35 Server Side Node Descriptors Section Title Nodes Column Title Node_Name Function Legal Values Up to 32 alphanumeric characters Provide name for node Network address of the device being polled. If the network address field is set to $00FF, the controller will respond to the packet without regard to its own internal network address This parameter must be used If units are connected to the FieldServer via a routing device e.g. OPM.
McQuay Micro Tech Open Protocol Driver Manual 5.3. Server Side Map Descriptors 5.3.1. FieldServer Specific Map Descriptor Parameters Column Title Function Map_Descriptor_Name Name of this Map Descriptor Data_Array_Name Name of Data Array where data is to be stored in the FieldServer Data_Array_Offset Starting location in Data Array Function Function of Client Map Descriptor 5.3.2.
Map Descriptor Example – Strategy 1. Page 15 of 35 ,Node_Name ,Chiller1 The Node name connects the Map Descriptor to a Node definition and possibly to a port. ,Function ,Passive ,Length ,10000 10,000 is the maximum length of a Data Array so there is no point in making the Map Descriptor longer. ,Address ,1 FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldServer.com Tel: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: support@fieldServer.
Map Descriptor Example – Strategy 2. Page 16 of 35 The same Data Array is used for both Map Descriptors. By using the same Data Array and changing the offset the data can all be packed into a smaller array. ,Data_Array_Name ,DA_CHILLER1 ,DA_CHILLER1 ,Data_Array_Offset ,0 ,256 ,Function ,Passive ,Passive ,Address ,1024 ,2048 A few more Map Descriptors could be added to serve the remaining data field addresses. These two address ranges cover almost all the data fields in a 200 series chiller.
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…..
McQuay Micro Tech Open Protocol Driver Manual Appendix A.2. Page 18 of 35 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.
McQuay Micro Tech Open Protocol Driver Manual Read/ Array Write/ Field Name Location Both 56 r Condenser Water Temperature - Leaving 58 r Cooling Tower Control 59 r Cooling Tower Stage 60 r Cooling Tower Valve Position 61 r Discharge Refrigerant Temperature 63 r Evaporator Approach Temperature 65 r Evaporator Pump Status 66 r Evaporator Pump #1 Operating Hours 68 r Evaporator Pump #2Operating Hours 70 r Evaporator Refrigerant Pressure 72 r Evaporator Refrigerant Temperature 74 r Evaporator Water Flow Rate 7
McQuay Micro Tech Open Protocol Driver Manual Read/ Array Write/ Field Name Location Both 115 b Communications Signal 116 b Outdoor Air Temperature - BAS 117 b Master/Server Setpoint 118 b Lead/Lag Mode Setpoint 119 b Enable Lag Setpoint 120 b Disable Lag Setpoint 121 b Lag Standby Setpoint 122 b Lead/Lag Switch Setpoint (Day) 123 b Lead/Lag Switch Setpoint (Hour) 124 r Lead/Lag Status 125 r Lead Unit 126 r Lead Unit Status 127 r Lag Unit Status 128 r Lead Motor Current 129 r Lag Motor Current 130 r Lead St
McQuay Micro Tech Open Protocol Driver Manual Page 21 of 35 Read/ Device Array Number Base Write/ Field Name Scaling Location of Bytes Address 6 Both Method 30 r Circuit #2 Condenser Pressure 2 0x0469 2 32 r Circuit #2 Alarm Conditions: Condenser Pressure 2 0x082A 2 34 r Circuit #2 Alarm Conditions: Evaporator Pressure 2 0x0828 2 36 r Circuit #2 Alarm Conditions: Liquid Line Tempe 2 0x082E 6 38 r Circuit #2 Alarm Conditions: Suction Temperature 2 0x082C 6 39 r Circuit #2 Current Alarm 1 0x0832 1 41 r Circ
McQuay Micro Tech Open Protocol Driver Manual Page 22 of 35 Table 4 - Equipment Type: 100CFC 100 Series Centrifugal Chiller Read/ Device Array Number Base Write/ Field Name Scaling Location of Bytes Address 7 Both Method 1 r Alarm Contact 1 0x0217 1 2 r Approach Condenser 1 0x0418 1 3 r Calculated Leaving Evaporator Temp Setpoint 1 0x0420 7 4 r Calculated Network Amp Limit Setpoint 1 0x0423 1 5 r Compressor Discharge Temp. 1 0x0407 1 6 r Compressor Suction Temp.
McQuay Micro Tech Open Protocol Driver Manual Page 23 of 35 Read/ Device Array Number Base Write/ Field Name Scaling Location of Bytes Address 7 Both Method 39 r Leaving Evaporator Water Temp. - Hi Resolution 1 0x0419 7 40 r LED Front Panel 1 0x021F 1 41 r Lift Pressure 1 0x0412 1 42 r Liquid Injection Solenoid 1 0x0216 1 43 r Liquid Line Refrigerant Temp. - Lo Resolution 1 0x0404 1 44 r Liquid Line Refrigerant Temp.
McQuay Micro Tech Open Protocol Driver Manual Read/ Array Write/ Field Name Location Both 85 b Leaving Evaporator Temperature Setpoint 86 b Maximum Chilled Water Reset Setpoint 87 b Network Amp Reset 88 b Network Chilled Water Reset 89 b Network Start Stop 90 b Reset Option 91 b Soft Reset 92 b Start Mode 93 b Startup Differential Temp. 94 b Shutdown Differential Temp.
McQuay Micro Tech Open Protocol Driver Manual Read/ Array Write/ Field Name Location Both 43 b Clear Ckt#1 Alarm 44 b Evaporator Entering Water Temperature Setpoint 45 b Evaporator Leaving Water Temperature Setpoint 46 b Maximum Chilled Water Reset Setpoint 47 b Network Command 48 b Network Demand Limit 49 b Network Evaporator Leaving Water Temp Reset 50 b Reset Option Setpoint Page 25 of 35 Device Number Base Scaling of Bytes Address 8 Method 1 0x091A 1 1 0x090D 2 1 0x0905 2 1 0x090C 2 1 0x044F 1 1 0x044D
McQuay Micro Tech Open Protocol Driver Manual Page 26 of 35 Read/ Device Array Number Base Write/ Field Name Scaling Location of Bytes Address 9 Both Method 35 r Fan - High Speed Operating Hours 2 0x08AC 1 37 r Fan - Low Speed Operating Hours 2 0x08A9 1 39 r Fan Operation 1 0x0462 1 40 r Fan Speed 1 0x0436 1 41 r Heat Stage 1 0x043E 1 42 r Heating Control Status 1 0x044C 1 43 r Heating Operating Hours 2 0x08C1 1 45 r Leaving Water Temperature 1 0x042D 1 46 r Mixed Air Temperature 1 0x042B 1 47 r Motor Amp
McQuay Micro Tech Open Protocol Driver Manual Page 27 of 35 Read/ Device Array Number Base Write/ Field Name Scaling Location of Bytes Address 9 Both Method 82 b Economizer (Air) Method 1 0x083B 1 83 b Economizer (Water) Changeover Temperature Offset 1 0x091A 1 84 b Fan On Heating Setpoint 1 0x0939 1 85 b Head Pressure Deadband 1 0x08E1 1 86 b Head Pressure Setpoint 1 0x093A 1 87 b Heating Control Deadband 1 0x0894 1 88 b Heating Control Setpoint 1 0x0905 1 89 b Heating Supply Deadband 1 0x0871 1 90 b Hea
McQuay Micro Tech Open Protocol Driver Manual 5.3.6. Page 28 of 35 Driver Related Map Descriptor Parameters Address* The address in the McQuay device that contains the data of interest. Normally this field is set to 1 or omitted. Bytes_Per_Field* This parameter is used with direct addressing. When reading, up to 4 consecutive address locations in the McQuay device can be combined and stored in a single Data Array element.
Advanced Map Descriptor Example 1– Reading direct address. Page 29 of 35 ,Node_Name ,Chiller1 Specify the address in decimal ,Data_Array_Offset ,0 ,Address ,4096 ,Length ,10 ,Scan_Interval ,1.0s Advanced Map Descriptor Example 2 – Controlling Bytes per Field – Reading ,Data_Array_Name ,DA_CHILLER1 ,Function ,Rdbc ,Node_Name ,Chiller1 Length must be set to 1 when Bytes_per_Field is specified.
Advanced Map Descriptor Example 3 – Controlling Bytes per Field – Writing Page 30 of 35 ,Data_Array_Name ,DA_CHILLER1 ,Address ,4096 ,Length ,1 ,Bytes_Per_Field ,2 A value from 1 to 4 -tells the driver how many consecutive addresses to write to The data value written to each address is based on the single value extracted from offset 0 in the Data Array DA_CHILLER1 ,Node_Name ,Chiller1 Length must be set to 1 when Bytes_Per_Field is specified. ,Data_Array_Offset ,0 ,Scan_Interval ,1.
McQuay Micro Tech Open Protocol Driver Manual Appendix A.8. Page 31 of 35 Statistics The driver reports statistics according to the FieldServer standards. The following notes describe some aspects of standard statistic reporting which are peculiar to this driver. NAK CHECKSUM NOISE NO START PROTOCOL Each time a negative acknowledgement message is received. Each time that a message is received that contains a non-ASCII character. An acknowledgement message contains an unrecognized code.
,Data_Format ,UINT32 ,Data_Array_Name ,DA_MCQ_STATS Data_Arrays Data_Array_Name DA_MCQ_STATS Map_Descriptors Map_Descriptor_Name McQuay-Stats ,Data_Array_Offset ,0 ,Data_Array_Length ,2000 ,Port ,P1 ,Function ,Passive ,Protocol ,McQuay ,Node_Name ,Mcq_stats ,PLC_Type ,200CFC ,Address ,1 Page 32 of 35 ,Length ,2000 FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldServer.
McQuay Micro Tech Open Protocol Driver Manual Page 33 of 35 Appendix B. Error Messages Those messages marked with an * are only printed once even if they occur repeatedly. Error Message McQuay:#1 FYI. The MapDesc called <%s> is too short McQuay:#2 FYI. You could have used a MapDesc called <%s> to expose diagnostic info. McQuay:#3 FYI. Normally passwords are defined for each node. McQuay:#4 Err. Node list if full. Max=%d McQuay:#5 Err. Node=%d has more than one password. *McQuay:#9 FYI.
McQuay Micro Tech Open Protocol Driver Manual Error Message McQuay:#22 Err. Illegal Node_ID [%d] - Set to 1 McQuay:#23 FYI. Config requires non-critical update. Read Manual. McQuay:#24 Err. Illegal Node_ID/Route McQuay:#25 Err. Max Len=1 when Bytes_Per_Field > 1. MD=%s. McQuay:#26 Err. Max Bytes_Per_Field=4. MD=%s. McQuay:#27* Err. Response=NAK. Read Manual. Maybe password or Node_ID McQuay:#28* Err. Device responded with a NAK. Page 34 of 35 Action Check configuration file, a Node_ID is out of range.
McQuay Micro Tech Open Protocol Driver Manual Page 35 of 35 Appendix C. Troubleshooting Appendix C.1. Connection Problems The driver produces a timeout each time a message is sent. If the number of timeouts is the same as the number of messages sent then you know that the McQuay device has never sent a response. The following reasons may be applicable: • Incorrect connection settings - the messages sent by the FieldServer cannot be interpreted by the McQuay device.
