FieldServer FS-8700-123 User Manual

Driver Version:

1.00

Document Revision:

5

APPLICABILITY & EFFECTIVITY

Effective for all systems manufactured after April 2010

Driver Manual

(Supplement to the FieldServer Instruction Manual)

FS-8700-123 MetOne Particle Counter

HACH Ultra Analytics

(formerly Pacific Scientific Instruments)

Standard Protocol FX (enhanced) - ENG110

A Sierra Monitor Company

FS-8700-123 MetOne Particle Counter Serial Driver Manual Table of Contents

TABLE OF CONTENTS

1 MetOne Particle Counter Serial Description ................................................................................................... 3

2 Driver Scope of Supply ................................................................................................................................... 3

2.1 Supplied by FieldServer Technologies for this driver ..................................................................................... 3

3 Hardware Connections ................................................................................................................................... 4

3.1 Connection to 2100 Particle Counter ............................................................................................................ 4

3.2 Connection to 4308 Particle Counter ............................................................................................................ 5

3.3 Hardware Connection Tips / Hints ................................................................................................................. 5

4 Data Array Parameters ................................................................................................................................... 6

5 Configuring the FieldServer as a MetOne PC Serial Client ............................................................................... 7

5.1 Client Side Connection Descriptions .............................................................................................................. 7

5.2 Client Side Node Descriptors ......................................................................................................................... 8

5.3 Client Side Map Descriptors........................................................................................................................... 9

5.3.1 FieldServer Related Map Descriptor Parameters ................................................................................... 9

5.3.2 Driver Related Map Descriptor Parameters ........................................................................................... 9

5.3.3 Timing Parameters ................................................................................................................................. 9

5.4 Map Descriptor Example 1 – Read Hold ( or Sample) Times from a Device. ............................................... 10

5.5 Map Descriptor Example 2 – Write Hold (or Sample) Times to a Device. ................................................... 11

5.6 Map Descriptor Example 3 – Read the operating mode. ............................................................................. 11

5.7 Map Descriptor Example 4 – Start / Stop Counting. .................................................................................... 12

5.8 Map Descriptor Example 5 – Change Mode ................................................................................................ 12

5.9 Map Descriptor Example 6 – Select Device ................................................................................................. 13

5.10 Map Descriptor Example 7 – Read the Current Record ............................................................................... 14

5.11 Map Descriptor Example 8 – Dumping the Current Record ........................................................................ 14

5.12 Map Descriptor Example 9 – An alternate way of storing the current record. ........................................... 15

5.13 Map Descriptor Example 10 – Reading from a SubDevice/Port .................................................................. 16

5.14 Map Descriptor Example 11 – Selecting a Sub-Device/Port ........................................................................ 16

6 Configuring the FieldServer as a MetOne PC Serial Server ............................................................................ 17

Appendix A. Useful Features ................................................................................................................................ 18

Appendix A.1. Driver Operating and Error Statistics ............................................................................................... 18

Appendix B. Troubleshooting ............................................................................................................................... 19

Appendix B.1. Driver Error Messages ...................................................................................................................... 19

Appendix B.2. Driver Exposed Operating and Error Statistics ................................................................................. 21

Appendix B.3. Sample and Hold Times .................................................................................................................... 22

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

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

FS-8700-123 MetOne Particle Counter Driver Manual Page 3 of 22

FieldServer
mode

Nodes

Comments

Client

1

There can only be one Client node per FieldServer port. The driver can poll any number
of Server nodes provided that they comply with the vendors numbering requirements

Server

Driver as a Server is not documented or supported. Used only for QA purposes.

FieldServer Technologies PART #

Description

FS-8917-16

RJ45 to terminal connector cable.

FS-8917-02

RJ45 to DB9F connector adapter

1 METONE PARTICLE COUN TER SERIAL DESCRIPTION

The MetOne Particle Counter Serial driver allows the FieldServer to transfer data to and from devices over RS-232
or RS-485 using MetOne Particle Counter Serial protocol.

This driver is based on a specification called “Standard Protocol FX (enhanced)” ENG110 Revision A dated 1999 by

Pacific Scientific Instruments. This protocol provides an interface to Particle Counters manufactured by HACH Ultra
Analytics and labeled as METONE products. Pacific Scientific Instruments is a former name of Hach.

The primary purpose of the driver is to obtain the current particle counts but it does allow for limited control and
configuration of some counter parameters. The Server side of the driver is intended to support FieldServer’s
Quality Assurance program and is not intended to provide complete emulation of a MetOne Counter.

When configured as a Client the driver can start/stop a unit from sampling change its mode set and get sample and
hold times startup or standby a unit and retrieve its current sample value. Whenever the driver stores a sample
value it will also store a timestamp of when the record was obtained.

In the configuration of the FieldServer each device is identified by specifying its device number then the sub-device
code or port number and finally by a device type. The device type will be used to interpret the status byte obtained
from the device.

For each configured node each time the FieldServer sends a message to the device it will select the device (and the
select the sub-device or port if specified) and then the message will be sent. If the most recent message sent was
sent to the device the driver will do the selection to ensure the correct device response.

When the current record is read from a device then the driver will store the data extracted from the response in a
range of consecutive Data Array elements so that these values can be served to another protocol. Even though the
record data contains a time stamp the driver will make its own time stamp for new data. If there is no current
record the driver will not update the data.

If the response is invalid in any way – invalid characters or invalid checksum the driver will ignore the message and
not store any data.

Max Nodes Supported

2 DRIVER SCOPE OF SUPP LY

2.1 Supplied by Fiel dServer Technologie s for this driver

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

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

FS-8700-123 MetOne Particle Counter Driver Manual Page 4 of 22

R2 R1

Gnd

_

+

Gnd

FG

_

+

RS-485

Opto

Isolated

FieldServer

P1

18

6

9-Pin Serial Connector on

rear of 2100 Device

1 2

98754

3

Rx

/

-

Tx

/+

COM

FieldServer Part #

8917-16

Pigtail for RJ45

Port

Brown

Blue/white

Orange/White

6

9-Pin Serial Connector on rear

of 2100 Device

1 2 987543

Tx Rx GND

OR

FS Function

RJ45 Pin#

2100 Pin

2100 Function

Color

RX 1 2

Tx

Brown

Tx 2 3

Rx

Orange/White

COM

3 7 GND

Blue/White

3 HARDWARE CONNECTIONS

3.1 Connection to 2100 Particle Counter

Connector Pinouts

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

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

FS-8700-123 MetOne Particle Counter Driver Manual Page 5 of 22

R2 R1

Gnd

_

+

Gnd

FG

_

+

RS-485

Opto

Isolated

FieldServer

P1

18

8

6

13

Part of 4308

Device

Back of Board

3.2 Connection to 4308 Particle Counter

3.3 Hardware Connection Tips / Hints

The 2100 Device auto configures its serial port based on the pins connected. There is no explicit setting or

selector for RS-232/RS-485

Ensure other pins are not connected.
The FS-8917-16 cable is not needed for RS-485 on the X30 and X40 only.

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

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

FS-8700-123 MetOne Particle Counter Driver Manual Page 6 of 22

Section Title

Data_Arrays

Column Title

Function

Legal Values

Data_Array_Name

Provide name for Data Array

Up to 15
alphanumeric
characters

Data_Array_Format

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

FLOAT BIT UInt16
SInt16 Byte.

Data_Array_Length

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

1-10 000
// Data Arrays

Data_Arrays

Data_Array_Name

, Data_Array_Format

, Data_Array_Length

DA_AI_01

, UInt16

, 200

DA_AO_01

, UInt16

, 200

DA_DI_01

, Bit

, 200

DA_DO_01

, Bit

, 200

4 DATA ARRAY PARAMETER S

Data Arrays are “protocol neutral” data buffers for storage of data to be passed between protocols. It is necessary

to declare the data format of each of the Data Arrays to facilitate correct storage of the relevant data.

Example

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

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

FS-8700-123 MetOne Particle Counter Driver Manual Page 7 of 22

Section Title

Connections

Column Title

Function

Legal Values

Port

Specify which port the device is connected to the FieldServer

P1-P8 R1-R21

Protocol

Specify protocol used

MetOne

Baud*

Specify baud rate

9600 (Vendor limitation).

Parity*

Specify parity

None (Vendor limitation)

Data_Bits*

Specify data bits

8 (Vendor limitation)

Stop_Bits*

Specify stop bits

1 (Vendor limitation)

Poll_Delay*

Time between internal polls

0-32000 seconds 0.05s

// Client Side Connections

Connections

Port

, Protocol

, Baud

, Parity

, Poll_Delay

P8

, MetOne

, 9600

, None

, 0.100s

5 CONFIGURING THE FIELDSERVER AS A METONE PC SERIAL 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 MetOne Particle Counter Serial Server.

The configuration file tells the FieldServer about its interfaces and the routing of data required. In order to enable
the FieldServer for MetOne Particle Counter Serial 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.

5.1 Client Side Co nnection Descriptions

Example

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]