FieldServer FS-8700-123 User Manual

Driver Version:

1.00

A Sierra Monitor Company

Driver Manual

(Supplement to the FieldServer Instruction Manual)

FS-8700-123

HACH Ultra Analytics

(formerly Pacific Scientific Instruments)

Standard Protocol FX (enhanced) - ENG110

Developed for interfaces to

MetOne Particle Counters

APPLICABILITY & EFFECTIVITY

Effective for all systems manufactured after May 1, 2001

Document Revision: 3

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 ........................................................................................ 4

2.1.

Supplied by FieldServer Technologies for this driver.................................................. 4

3.

HARDWARE CONNECTIONS........................................................................................ 5

3.1.

Hardware Connection Tips / Hints.............................................................................. 6

4.

CONFIGURING THE FIELDSERVER AS A METONE PC SERIAL CLIENT .................. 7

4.1.

Data Arrays/Descriptors............................................................................................. 7

4.2.

Client Side Connection Descriptions .......................................................................... 8

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.5.

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

4.6.

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

4.7.

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

4.8.

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

4.9.

Map Descriptor Example 5 – Change Mode..............................................................13

4.10. Map Descriptor Example 6 – Select Device ..............................................................14

4.11. Map Descriptor Example 7 – Read the Current Record.............................................15

4.12. Map Descriptor Example 8 – Dumping the Current Record.......................................16

4.13. Map Descriptor Example 9 – An alternate way of storing the current record. ............17

4.14. Map Descriptor Example 10 – Reading from a SubDevice/Port ................................18

4.15. Map Descriptor Example 11 – Selecting a Sub-Device/Port......................................19

5.

CONFIGURING THE FIELDSERVER AS A METONE PC SERIAL SERVER ...............20

APPENDIX A. DRIVER ERROR MESSAGES .......................................................................21

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

Appendix A.2. Driver Exposed Operating and Error Statistics .............................................24

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

Tel: [phone] Fax: [phone] Toll_Free: 888-509-1970 email: [e-mail]

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

1. MetOne Particle Counter 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. While the driver provides Client
and Server emulation, 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.
Thus the Server side is not fully documented and is not supported. At a customer’s request the
Server side functionality can be documented and enhanced. If you are interested in this
functionality, then please contact FieldServer’s sales group.

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

FieldServer mode Nodes Comments

There can only be one Client node per FieldServer port.

Client 1

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 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldServer.com

Tel: [phone] Fax: [phone] Toll_Free: 888-509-1970 email: [e-mail]

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

2. Driver Scope of Supply

2.1. Supplied by FieldServer Technologies for this driver

FieldServer Technologies
PART #

Description

FS-8915-16 UTP cable (7 foot) with Pigtail
FS-8917-02 RJ45 to DB9F connector adapter
FS-8700-123 Driver Manual.

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

Tel: [phone] Fax: [phone] Toll_Free: 888-509-1970 email: [e-mail]

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

07

3. Hardware Connections

Part of 4308 Device

13

8

6

Back of Board

(408)-262-2299

SERIAL

FIELDSERVER

4803 PARTICLE COUNTER

CONNECTION DIAGRAM

BASE NAME:
FILE NAME: FS-8700-123

DATE: 6/1/
BY: MC

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

Tel: [phone] Fax: [phone] Toll_Free: 888-509-1970 email: [e-mail]

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

07

9-Pin Serial Connector on rear

of 2100 Device

Tx Rx

1 2 987543

GND

6

9-Pin Serial Connector on rear

of 2100 Device

1 2 987543

6

OR

FS-Tx/+

RJ45-01
BROWN

FS-8917-16

Port

RS-232

FS-Rx/-

RJ45-08

ORANGE/WHITE

FS-COM

RJ45-04

BLUE/WHITE

(408)-262-2299

SERIAL

2100 PARTICLE COUNTER

CONNECTION DIAGRAM

FIELDSERVER

BASE NAME:
FILE NAME: FS-8700-123

DATE: 6/1/
BY: MC

3.1. 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: 888-509-1970 email: [e-mail]

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

4. 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.

4.1. Data Arrays/Descriptors

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.

Section Title

Data_Arrays

Column Title Function Legal Values

Data_Array_Name Provide name for Data Array

Up to 15 alphanumeric
characters
Float, Bit, UInt16, SInt16,

Data_Array_Format

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

Packed_Bit, Byte,
Packed_Byte,
Swapped_Byte

Number of Data Objects. Must be

Data_Array_Length

larger than the data storage area
required by the Map Descriptors for

1-10,000

the data being placed in this array.

Example

// 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

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

Tel: [phone] Fax: [phone] Toll_Free: 888-509-1970 email: [e-mail]

FS-8700-123 MetOne Particle Counter Serial Driver Manual Page 8 of 26

4.2. Client Side Connection Descriptions

Section Title

Connections

Column Title Function Legal Values

Specify which port the device

Port

Protocol Specify protocol used MetOne
Baud* Specify baud rate
Parity* Specify parity
Data_Bits* Specify data bits
Stop_Bits* Specify stop bits

Handshaking*

Poll_Delay* Time between internal polls

Example

// Client Side Connections

Connections
Port, Protocol, Baud, Parity, Handshaking, Poll_Delay
P8, MetOne, 9600, None, None, 0.100s

is connected to the
FieldServer

Specify hardware
handshaking

P1-P8, R1-R21

9600 (Vendor limitation).
None (Vendor limitation)
8 (Vendor limitation)
1 (Vendor limitation)

RTS, RTS/CTS, None

0-32000 seconds, 0.05 seconds

4.3. Client Side Node Descriptors

Section Title

Nodes

Column Title Function Legal Values

Node_Name Provide name for node Up to 32 alphanumeric characters
Node_ID The ‘Device’ Number 1-64
Protocol Specify protocol used MetOne.

Connection

PLC_Type

Example

Nodes
Node_Name, Node_ID, Protocol, PLC_Type, Connection
PLC 1, 1, MetOne, 237 Family, P8

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.

Specify which port the device is
connected to the FieldServer

Identifies for the driver the family
of Particle Counters/Manifolds
connected to.

P1-P8, R1-R21

“237 Family”
“2408” or “Manifold”
“4800”
“HF CNC”

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

Tel: [phone] Fax: [phone] Toll_Free: 888-509-1970 email: [e-mail]