FieldServer FS-8700-80 User Manual

Driver Version:

1.03

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

Document Revision: 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

2.2. Provided by Supplier of 3rd Party Equipment..................................................................................5

3.

Hardware Connections .................................................................................................................... 5

4.

Configuring the FieldServer as a McQuay Micro Tech Open Protocol Client............................ 6

4.1. Data Arrays..................................................................................................................................... 6

4.2. Client Side Connection Descriptors................................................................................................ 7

4.3. Client Side Node Descriptors .........................................................................................................8

4.4. Client Side Map Descriptors ...........................................................................................................9

4.4.1. FieldServer Related Map Descriptor Parameters ................................................................... 9

4.4.2. Driver Related Map Descriptor Parameters ............................................................................9

4.4.3. Timing Parameters .................................................................................................................. 9

4.4.4. Map Descriptor Example 1 – Read Everything. ....................................................................10

4.4.5. Map Descriptor Example 2 – Read a particular Data Field................................................... 11

4.4.6. Map Descriptor Example 3 – Write........................................................................................ 11

5.

Configuring the FieldServer as a McQuay Micro Tech Open Protocol Server ........................ 12

5.1. Server Side Connection Descriptors ............................................................................................12

5.2. Server Side Node Descriptors ......................................................................................................13

5.3. Server Side Map Descriptors........................................................................................................ 14

5.3.1. FieldServer Specific Map Descriptor Parameters .................................................................14

5.3.2. Driver Specific Map Descriptor Parameters .......................................................................... 14

5.3.3. Timing Parameters ................................................................................................................ 14

5.3.4. Map Descriptor Example – Strategy 1. ................................................................................. 15

5.3.5. Map Descriptor Example – Strategy 2. ................................................................................. 16

Appendix A.

Appendix A.1. Scaling ..........................................................................................................................17

Appendix A.2. Data Field Name Tables ...............................................................................................18

Appendix A.3. McQuay Equipment Types recognized by the driver.................................................... 27

Appendix A.4. Direct Addressing .........................................................................................................27

5.3.6. Driver Related Map Descriptor Parameters ..........................................................................28

Appendix A.5. Advanced Map Descriptor Example 1– Reading direct address.................................. 29

Appendix A.6. Advanced Map Descriptor Example 2 – Controlling Bytes per Field – Reading ..........29

Appendix A.7. Advanced Map Descriptor Example 3 – Controlling Bytes per Field – Writing ............ 30

Appendix A.8. Statistics .......................................................................................................................31

Appendix B.

Appendix C.

Appendix C.1. Connection Problems ................................................................................................... 35

Appendix C.2. Negative Acknowledgement - NAK .............................................................................. 35

Appendix C.3. Node ID problems ........................................................................................................ 35

Appendix C.4. Server Side Configuration – Consecutive Addresses ..................................................35

Advanced Topics ......................................................................................................... 17

Error Messages ............................................................................................................33

Troubleshooting ...........................................................................................................35

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldServer.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

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 devices
over either RS-232 or RS-485 using McQuay Micro Tech Open Protocol. The FieldServer can emulate
either a Server or Client.

When emulating a Client, the driver enables the FieldServer to request ‘Everything’ from the McQuay
device as well as a number of advanced options which allow specific fields to be read or written and
device scaling to be applied.

When emulating a Server, the driver provides an emulation of the byte memory of a device and responds
to read and write requests.

The following important points and limitations should be noted before proceeding with this manual.

1. Arising from a feature of the McQuay Micro Tech Open Protocol is the peculiarity, that when a multi­byte value is written to a McQuay device, the write is done one byte at a time (one byte of data can
be transferred per poll/response message pair) allowing for the possibility (at least for a short period)
that the multi byte value is only partially correct until all the messages have been completed.

2. The vendor equipment is limited to a maximum of 9600 baud. Given that each message packet can
only transfer one byte of data and that some data of interest is multi-byte, users of this protocol
should expect low data transfer rates.

3. Port expansion is not supported for this driver.

4. A document identified as Ed15050 MicroTech Network Operations contains important information
regarding the connection requirements of 3rd party equipment such as the FieldServer to a Microtech
network. The document also defines a number of limitations for such connections. The following
quotations from this document outline some of this information.

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldServer.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

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.

You can connect two or more PCs to the network, but only one PC can be connected to a particular
controller. The PC that you use most often should be connected to the level-1 controller for best
performance. For example, you may have one PC that you use on site and another PC that you use
off site. In this situation, you may want to connect the on-site PC to the level-1 controller and the
modem for the off-site PC to a level-2 or level-3 controller.
If a PC is connected to a level-2 controller, a level-1 controller must poll that level-2 controller
connected to the PC so that the PC has access to the entire network. Defining a level-2 controller in
the level-1 controller Server list causes the level-1 controller to poll the level-2 controller.
Port Configuration: The communications port that the PC is connected to must be configured as a
TTY port. The default port configuration for most MicroTech controllers sets port A as TTY. The port
configuration is a software setting.
A separate software setting defines the communications rate of each port. In most controllers, the
default rate is 9600 bps.

TTY: A TTY port is used to connect a PC for monitoring purposes. It uses the RS-232C interface
standard and the Data Terminal Communications protocol.

5. The following quote from “MicroTech® Data Terminal Communication Packets, Open Protocol™ Data
Communications Information Packet ” highlights an important limitation of the protocol.

Data terminal communications may be sent via RS-232C or RS-485. Regardless of the electrical
standard used for communications, this protocol is a single ended type (i.e., communications to one
MicroTech controller maximum).

6. Each MicroTech controller is shipped from the factory with a unique job site password. The
passwords are provided by the McQuay International representative at the time of startup.

7. The driver does not validate passwords when configured as a Server. This means that requests to
read or write data will succeed even if the password supplied with the request is incorrect.

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldServer.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

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.

2.2. Provided by Supplier of 3rd 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 according to manufacturer’s instructions.

SERIES 200 CONTROLLER

RJ45-04

BLUE/WHITE

RJ45-08

ORANGE/WHITE

RJ45-01
BROWN

Connect to one of the RS-232

Ports on the FieldServer

FS-8917-16

18

FieldServer

P1

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldServer.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

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 parameters necessary for configuring the FieldServer to
communicate with a McQuay Micro Tech Open Protocol Server.

The configuration file tells the FieldServer about its interfaces, and the routing of data required. In order to
enable the FieldServer for McQuay Micro Tech Open Protocol communications, the driver independent
FieldServer buffers need to be declared in the “Data Arrays” section, the destination device addresses
need to be declared in the “Client Side Nodes” section, and the data required from the Servers needs to
be mapped in the “Client Side Map Descriptors” section. Details on how to do this can be found below.

Note that in the tables, * indicates an optional parameter, with the bold legal value being the default.

4.1. Data Arrays

Section Title

Data_Arrays

Column Title Function Legal Values

Data_Array_Name Provide name for Data Array

Data_Format

Data_Array_Length

Example

// Data Arrays
//
Data_Arrays
Data_Array_Name ,Data_Format ,Data_Array_Length

DA_AI_01 ,UInt16 ,200
DA_AO_01 ,UInt16 ,200
DA_DI_01 ,Bit ,200
DA_DO_01 ,Bit ,200

Provide data format. Each Data Array can
only take on one format.

Number of Data Objects. Must be larger
than the data storage area required for
the data being placed in this array.

Up to 15 alphanumeric
characters
Float, Bit, UInt16, SInt16,
Packed_Bit, Byte,
Packed_Byte,
Swapped_Byte

1-10,000

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldServer.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

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

Port

Baud* Specify baud rate

Parity* Specify parity Even (Vendor limitation)
Data_Bits* Specify data bits 7 (Vendor limitation)
Stop_Bits* Specify stop bits
Protocol Specify protocol used MCQ, McQuay
Handshaking* Specify hardware handshaking
Poll Delay* Time between internal polls

Example

// Client Side Connections

Specify which port the device is
connected to the FieldServer

P1-P8, R1-R21

300, 1200, 2400, 4800 and 9600
baud (Vendor limitation).

1

None

0-32000 seconds, 1 second

Connections
Port ,Baud ,Parity ,Data_Bits ,Protocol ,Handshaking ,Poll_Delay
P1 ,9600 ,Even ,7 ,McQuay ,None ,0.100s

1

Not all ports shown are necessarily supported by the hardware. Consult the appropriate Instruction

manual for details of the ports available on specific hardware.

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldServer.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

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

Network address of the device being polled. If the

Node_ID

Route

Protocol Specify protocol used MCQ, McQuay

Port

PLC_Type

Password Maximum of 8 characters.

Example 1 of 2

// Client Side Nodes
// (No routing device used)

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. The
network address consists of the OPM address and the
unit address.

Specify which port the device is connected to the
FieldServer

The name of the McQuay Equipment type being polled.
Select one from the list on the left. The equipment type
must be known for the driver to operate correctly.

alphanumeric
characters

0-255

P1-P8, R1-R22

200CFC,
100CFC,
050RPC,
001ASC,
000SCU,
Type-Unknown
Ascii characters
only.

Nodes
Node_Name ,Node_ID ,Protocol ,Port ,Password ,PLC_Type
Chiller ,1 ,McQuay ,P1 ,Abcdefgh ,200CFC

Example 2 of 2

// Client Side Nodes
// (Routing device with address 3 used)

Nodes
Node_Name ,Node_ID ,Route ,Protocol ,Port ,Password ,PLC_Type
Chiller1 ,66 ,3 ,McQuay ,P1 ,Abcdefgh ,200CFC

2

Not all ports shown are necessarily supported by the hardware. Consult the appropriate Instruction

manual for details of the ports available on specific hardware.

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldServer.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

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

Map_Descriptor_Name Name of this Map Descriptor

Name of Data Array where

Data_Array_Name

Data_Array_Offset Starting location in Data Array

Function

data is to be stored in the
FieldServer

Function of Client Map
Descriptor

Up to 32 alphanumeric
characters
One of the Data Array names
from “Data Array” section
above
0 to maximum specified in
“Data Array” section above

Rdbc, Wrbc, Wrbx

4.4.2. Driver Related Map Descriptor Parameters

Column Title Function Legal Values

One of the node

Node_Name Name of Node to fetch data from

Length of Map Descriptor. Only one data field can be

Length

Field_Name

Device_Scaling

read or written per poll/response sequence, thus driver
assumes a length of 1.
The name of the data field of interest. Each address
with meaningful data in the McQuay device has a
name. The field names are defined in a specification
for each device type. If the field name is unknown, the
Address can be defined. Refer to Appendix A.4 for
further information.
If set to No then the driver stores the raw values, if set
to Yes, the data is scaled before storing. The device
scaling applied is shown in Table 1. Note that
‘Device_Scaling’ has no meaning when writing to a
McQuay device.

names specified in
“Client Node
Descriptor” above
Set to 1 except
when reading a
direct address.

‘Everything’ or
select a field name
from Table 2

Yes, No

4.4.3. Timing Parameters

Column Title Function Legal Values

Scan_Interval Rate at which data is polled >0.1s

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldServer.com

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

The values will be

scaled before

storage.

Example: The

‘Evaporator

Refrigerant

Pressure’ will be

stored by dividing

the raw value read

by 10.

The driver will

read every data

field known for the

device.

,Chiller1 ,1 ,1.0s ,Everything ,Yes

This parameter

connects the Map

Descriptor to a

node which in turn

connects the Map

Descriptor to a

port.

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

so that all parameters

can be stored.

Array is at least 200,

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldServer.com

4.4.4. Map Descriptor Example 1 – Read Everything.

This parameter does

not affect the

functionality of the

driver, however,

many validation or

error messages

report the name of

the Map Descriptor in

the message and,

thus it is strongly

recommended that

unique names be

McQuay Micro Tech Open Protocol Driver Manual Page 10 of 35

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

Map_Descriptor_Name ,Data_Array_Name ,Data_Array_Offset ,Function ,Node_Name ,Length ,Scan_Interval ,Field_Name ,Device_Scaling

field. There is no way of telling this command to read some fields more often than others. Each field is read in turn and when the end of the list is

reached the driver starts at the beginning again.

Read Chiller 1 ,DA_CHILLER1 ,0 ,Rdbc

used.

The name of the

data field to be

written to.

,Data_Array_Offset ,Function ,Scan_Interval ,Node_Name ,Length ,Field_Name

The data is only written

when the contents of

element zero of the array

named DA_MODES

changes.

Tel: [phone] Fax: [phone] Toll Free: [phone] email: [e-mail]

FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web: www.fieldServer.com

Ensure that you spell and space the field name exactly as it is

printed in table Appendix A.2

This Map Descriptor reads one single value from the McQuay

4.4.5. Map Descriptor Example 2 – Read a particular Data Field.

McQuay Micro Tech Open Protocol Driver Manual Page 11 of 35

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 ,

Chiller10_Op_Mode ,DA_OPERATIONAL_MODES ,10 ,Rdbc ,0s ,Chiller10 ,1 ,Chiller Operation Mode

4.4.6. Map Descriptor Example 3 – Write.

messages are required to transfer the byte values to the McQuay devices. Note that ‘Device_Scaling’ has no meaning when writing to a McQuay

This example illustrates how to write data to control fields in the McQuay device. This example illustrates the use of the Wrbx (write on change)

device. The user must ensure that valid numbers are written to the data fields.

function. A write message will be generated each time the data at index 0 in the Data Array changes. When writing multibyte fields, several

Map_Descriptor_Name ,Data_Array_Name ,Data_Array_Offset ,Function ,Node_Name ,Length ,Field_Name

Chiller1_Op_Mode ,DA_MODES ,0 ,Wrbx ,Chiller1 ,1 ,Chiller Operation Mode