FieldServer FS-8700-123 Computer Drive User Manual

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
Driver Version:
1.00
Document Revision: 3
FS-8700-123 MetOne Particle Counter Serial Driver Manual
Table of Contents
TABLE OF CONTENTS
1.
2.
METONE PARTICLE COUNTER SERIAL DESCRIPTION............................................. 3
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: 408 262-2299 Fax: 408-262-2269 Toll_Free: 888-509-1970 email: support@fieldServer.com
FS-8700-123 MetOne Particle Counter Serial Driver Manual
1.
Page 3 of 26
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
Client
1
Server
Comments
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
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: 408 262-2299 Fax: 408-262-2269 Toll_Free: 888-509-1970 email: support@fieldServer.com
FS-8700-123 MetOne Particle Counter Serial Driver Manual
2.
Page 4 of 26
Driver Scope of Supply
2.1.
Supplied by FieldServer Technologies for this driver
FieldServer Technologies
PART #
FS-8915-16
FS-8917-02
FS-8700-123
Description
UTP cable (7 foot) with Pigtail
RJ45 to DB9F connector adapter
Driver Manual.
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.com
FS-8700-123 MetOne Particle Counter Serial Driver Manual
3.
Page 5 of 26
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/07
BY:
MC
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.com
FS-8700-123 MetOne Particle Counter Serial Driver Manual
Page 6 of 26
9-Pin Serial Connector on rear
of 2100 Device
1
Tx
Rx
2
3
GND
4
5
FS-Tx/+
RJ45-01
BROWN
6
7
8
9
FS-COM
FS-Rx/RJ45-04
BLUE/WHITE
RJ45-08
ORANGE/WHITE
9-Pin Serial Connector on rear
of 2100 Device
2
3
4
5
6
7
8
9
RS-232
Port
1
FS-8917-16
OR
(408)-262-2299
SERIAL
FIELDSERVER
2100 PARTICLE COUNTER
CONNECTION DIAGRAM
BASE NAME:
FILE NAME: FS-8700-123
3.1.
DATE: 6/1/07
BY:
MC
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: 408 262-2299 Fax: 408-262-2269 Toll_Free: 888-509-1970 email: support@fieldServer.com
FS-8700-123 MetOne Particle Counter Serial Driver Manual
4.
Page 7 of 26
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
Data_Array_Name
Data_Array_Format
Data_Array_Length
Function
Legal Values
Up to 15 alphanumeric
Provide name for Data Array
characters
Float, Bit, UInt16, SInt16,
Provide data format. Each Data Packed_Bit,
Byte,
Array can only take on one format.
Packed_Byte,
Swapped_Byte
Number of Data Objects. Must be
larger than the data storage area
1-10,000
required by the Map Descriptors for
the data being placed in this array.
Example
//
Data Arrays
Data_Arrays
Data_Array_Name,
DA_AI_01,
DA_AO_01,
DA_DI_01,
DA_DO_01,
Data_Array_Format,
UInt16,
UInt16,
Bit,
Bit,
Data_Array_Length
200
200
200
200
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.com
FS-8700-123 MetOne Particle Counter Serial Driver Manual
4.2.
Page 8 of 26
Client Side Connection Descriptions
Section Title
Connections
Column Title
Function
Specify which port the device
is
connected
to
the
FieldServer
Specify protocol used
Specify baud rate
Specify parity
Specify data bits
Specify stop bits
Specify
hardware
handshaking
Time between internal polls
Port
Protocol
Baud*
Parity*
Data_Bits*
Stop_Bits*
Handshaking*
Poll_Delay*
Legal Values
P1-P8, R1-R21
MetOne
9600 (Vendor limitation).
None (Vendor limitation)
8 (Vendor limitation)
1 (Vendor limitation)
RTS, RTS/CTS, None
0-32000 seconds, 0.05 seconds
Example
//
Client Side Connections
Connections
Port,
Protocol,
P8,
MetOne,
4.3.
Baud,
9600,
Parity,
None,
Handshaking,
None,
Poll_Delay
0.100s
Client Side Node Descriptors
Section Title
Nodes
Column Title
Node_Name
Node_ID
Protocol
Connection
PLC_Type
Function
Legal Values
Provide name for node
Up to 32 alphanumeric characters
The ‘Device’ Number
1-64
Specify protocol used
MetOne.
Specify which port the device is
P1-P8, R1-R21
connected to the FieldServer
“237 Family”
Identifies for the driver the family
“2408” or “Manifold”
of Particle Counters/Manifolds
“4800”
connected to.
“HF CNC”
Example
Nodes
Node_Name,
PLC 1,
Node_ID,
1,
Protocol,
MetOne,
PLC_Type,
237 Family,
Connection
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.
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.com
FS-8700-123 MetOne Particle Counter Serial Driver Manual
4.4.
Page 9 of 26
Client Side Map Descriptors
4.4.1.
FieldServer Related Map Descriptor Parameters
Column Title
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_Array_Name
data is to be stored in the from “Data Array” section
FieldServer
above
Starting location in Data 0 to maximum specified in
Data_Array_Offset
Array
“Data Array” section above
Function of Client Map
Function
RDBC, WRBC, WRBX
Descriptor
4.4.2.
Function
Driver Related Map Descriptor Parameters
Column Title
Legal Values
One of the node names
Node_Name
Name of Node to fetch data from
specified in “Client
Node Descriptor” above
See Map Descriptor
Length
Length of Map Descriptor
Example
for
recommended lengths
"Current Record"
"Hold Time"
"Sample Time"
Specify the function. Additional
"Mode"
notes
and
explanations
are
Met1_Function
"Device Select"
provided in the examples.
“SubDevice/Port
Select”
“Count”
This parameter as well as the
“Device”
“Address” parameter must be
Met1_SubDev_or_Port
“SubDevice”
specified if a SubDevice or Port is
“Port”
being polled.
This parameter is used to specify Port numbers: 0-63
Address
the SubDevice or Port number if SubDevice numbers: 1either is being polled.
64
A method of storing count data
using a 3-character label. Use of
this parameter to allows the driver
Met1_Label
E.g. “LOC” or “0.1”
to know which count to store.
Refer to Section 0 for more
information.
4.4.3.
Function
Timing Parameters
Column Title
Scan_Interval
Function
Rate at which data is polled
Legal Values
≥0.001s
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.com
Map Descriptor Example 1 – Read Hold ( or Sample) Times from a Device.
Page 10 of 26
While
not
mandatory,
giving
each
Map Descriptor
a unique name
will
help
to
diagnose
configuration
problems.
Function,
RDBC,
Length,
3,
Scan_Interval
5.0s
This task must
be
executed
every
5
seconds.
Reserves
3
Data
array
locations
for
storing data.
Met1_Function,
Hold Time ,
Tells the driver
to read the Hold
Time from the
field device.
Node_Name
MET1,
The name of the Node. The driver uses
this name to link the Map Descriptor to a
Node Descriptor (where it finds the Device
Number specified with the Node_ID
parameter). The Node Descriptor provides
a link to the connection.
Tells the driver
to
Read
continuously.
Data_Array_Offset,
0,
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.com
When
a
response
is
received
the
driver extracts
the data and
stores it in the
Data
Array
named
here
starting at the
location
specified by the
offset
parameter.
Data_Array_Name,
DA_TIMES,
Client Side Map Descriptors
Map_Descriptors
Map_Descriptor_Name,
Read_Time,
//
In this example the driver reads the hold time from the field device. The time is stored in 3 consecutive Data Array elements. To
read Sample Times simply change the Met1_Function to ‘Sample Time. The driver extracts the time from the response and stores
the hours at the specified offset, the minutes in the next Data Array location and the seconds in the 3rd location.
4.5.
FS-8700-123 MetOne Particle Counter Serial Driver Manual
Map Descriptor Example 2 – Write Hold (or Sample) Times to a Device.
Page 11 of 26
Map Descriptor Example 3 – Read the operating mode.
Met1_Function,
Hold Time ,
Change
this
to
‘Sample Time’ to
command a sample
time or make two
Map Descriptors –
each with the correct
time function.
Node_Name
MET1,
Tells
the
FieldServer that
one element of
the data array is
reserved for this
Map Descriptor.
Length
1
Data_Array_Offset,
0,
Function,
rdbc,
Node_Name
MET1,
Met1_Function,
Mode ,
Length,
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.com
Data_Array_Name,
DA_MODE,
Client Side Map Descriptors
Map_Descriptors
Map_Descriptor_Name,
Write_Time,
//
Scan_Interval
1.0s
In this example the driver reads the operating mode from the field device. The driver stores a single element of data extracted from
the response. The driver stores a ‘C’ to indicate the field device is counting, a ‘H’ to indicate the device is holding and an ‘S’ to
indicate that it has stopped. If the mode is not recognized the driver store s a ‘?’. If another protocol reads these states from the
FieldServer it will probably display the ASCII value corresponding to each mode letter: ‘C’=67 ‘H’=72 and ‘S’=83
4.7.
The driver will extract the time in
seconds from the Data Array
specified here and use it to form
the command message to the
field device.
Function,
WRBX,
This function ‘wrbx’ tells
the driver to only send the
command each time the
value
found
in
the
specified
DA:offset
is
updated. Update means
each time some other
protocol writes to this
DA:offset
Data_Array_Offset,
0,
The location in
the Data Array
Data_Array_Name,
DA_TIMES,
Client Side Map Descriptors
Map_Descriptors
Map_Descriptor_Name,
Write_Time,
//
In this example the driver writes the hold time to the field device. The time is specified in seconds. A max of 23 hours 59 minutes
and 59 seconds can be specified. To write Sample Times simply change the Met1_Function to ‘Sample Time. The driver extracts
the time from the response and stores the hours at the specified offset, the minutes in the next Data Array location and the seconds
in the 3rd location.
4.6.
FS-8700-123 MetOne Particle Counter Serial Driver Manual
Map Descriptor Example 4 – Start / Stop Counting.
Page 12 of 26
Function,
wrbx,
Command is sent
each time the value
at
DA:offset
is
updated.
Data_Array_Offset,
0,
Met1_Function,
Count ,
Set length to 1 for
this Met1_Function
Node_Name
MET1,
Scan_Interval
1.0s
When the function is
wrbx then the scan
interval parameter is
ignored.
Length,
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.com
Driver extracts one single value from this
DA:Offset and uses the value to send a
command to start counting (non-zero value) or
stop counting (zero value)
Data_Array_Name,
DA_COUNT_CTRL,
Client Side Map Descriptors
Map_Descriptors
Map_Descriptor_Name,
Write_Count_Mode,
//
In this example the driver sends a command to start or stop the field device from counting based on the value found in the Data Array
element. If the value is non-zero, the field device will be commanded to start counting. If the value is zero, the field device will be
commanded to stop counting. In this example the function is set to wrbx which means the command message will be sent each time
the value found at the specified offset in the specified Data Array is updated even if it is not changed.
4.8.
FS-8700-123 MetOne Particle Counter Serial Driver Manual
Map Descriptor Example 5 – Change Mode
Page 13 of 26
Data_Array_Offset,
0,
Function,
wrbx,
Met1_Function,
Mode ,
Set length to 1 for
this Met1_Function
Node_Name
MET1,
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.com
Auto Sample Mode: Value=1
Manual Sample Mode: Value=2
Active Mode : Value = 3
Standby Mode: Value = 4
If the value found is not valid then no command is sent.
Driver extracts one single value from this DA:Offset and uses
the value to send a command to change the mode.
Data_Array_Name,
DA_MODE_CTRL,
Client Side Map Descriptors
Map_Descriptors
Map_Descriptor_Name,
Write_Mode,
//
Length,
1,
In this example the driver sends a command to change the mode of the field device. The command sent is determined by the value
found in the specified Data Array location. In this example the function is set to wrbx. This means the command message will be sent
each time the value found at the specified offset in the specified Data Array is updated even if it is not changed
4.9.
FS-8700-123 MetOne Particle Counter Serial Driver Manual
Map Descriptor Example 6 – Select Device
Page 14 of 26
Function,
wrbx,
Node_Name
MET1,
The Node_Name connects this Map
Descriptor to the Node Descriptor and
that is where the driver finds the
Node_ID parameter.
Data_Array_Offset,
0,
Length,
1,
Set length to 1 for
this Met1_Function
Met1_Function,
Device Select,
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.com
Data_Array_Name,
DA_MODE_CTRL,
Client Side Map Descriptors
Map_Descriptors
Map_Descriptor_Name,
Select Device,
//
The driver uses the Node_ID parameter to learn the address/number of the device to be selected. Valid numbers are in the range
1...64. When the device responds the driver stores the device number the Data Array element specified in the configuration.
Device selection is handled automatically by the driver, and support for this message is provided mainly for testing purposes.
4.10.
FS-8700-123 MetOne Particle Counter Serial Driver Manual
Map Descriptor Example 7 – Read the Current Record
Page 15 of 26
Data_Array_Offset,
0,
Function,
Rdbc,
Node_Name
MET1,
Length,
20,
Scan_Interval
1.0s
The length must be set to a
value large enough to store
the 8 fixed data items and
the variable number of count
fields.
Met1_Function,
Current Record,
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.com
Driver stores the current record information in the Data Array
specified here, starting at the specified offset. The data is
arranged as follows.
0 Status Byte
1 Date - Month
2 Date - Day
3 Date - Year
4 Time - Hours
5 Time - Minutes
6 Time - Seconds
7 Period
8 Count #1
9 Count #2
10 Count #3 …
Data_Array_Name,
DA_DATA,
Client Side Map Descriptors
Map_Descriptors
Map_Descriptor_Name,
Read Record,
//
One of these Map Descriptors is required for each device from which the current record is to be read..
In this example the driver reads the current record and stores the values in the specified Data Array. A single record comprises the
following data: status; date and time and a count for 1 or more locations. The driver has no advance knowledge of the number of
count fields to expect in the response. It simply stores them in consecutive locations in the Data Arrays. To map these counts to an
upstream protocol, the order of the count fields must be known. The driver can store a maximum of 20 count fields. The Map
Descriptor length must be set to a value that allows for enough data to be stored bearing in mind that it requires 8 DA elements to
store the status, date and time and period.
4.11.
FS-8700-123 MetOne Particle Counter Serial Driver Manual
Map Descriptor Example 8 – Dumping the Current Record
Page 16 of 26
Data_Array_Offset,
0,
DA_Byte_Name,
DA_DUMP,
Function,
Rdbc,
A secondary Data Array is specified with the
‘DA_Byte_Name’ parameter. When this is done
the driver stores the read current record
response, byte for byte, in the secondary DA.
Data_Array_Name,
DA_DATA,
Met1_Function,
Current Record,
Length,
20,
The length specified the amount of
Data Array space reserved for
primary storage and has no effect on
the dump. Ensure that dumps don’t
overlap each other.
Node_Name
MET1,
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.com
Map_Descriptors
Map_Descriptor_Name,
Read Record,
Scan_Interval
1.0s
This example is almost identical to the previous one. The one difference is that a secondary Data Array has been specified. When
this is done, each time a response is received, in addition to the storage specified in the previous example, the driver dumps the
response byte for byte the secondary Array. It is important to avoid overlaps in the secondary arrays if this feature is used on
multiple Map Descriptors. We suggest that about 2-300 DA elements is made available for the dump and that the format of the
secondary Data Array is ‘BYTE’
4.12.
FS-8700-123 MetOne Particle Counter Serial Driver Manual
Map Descriptor Example 9 – An alternate way of storing the current record.
Page 17 of 26
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.com
Map_Descriptors
Map_Descriptor_Name ,Scan_Interval ,Data_Array_Name ,Data_Array_Offset ,Length ,Function ,Node_Name ,Met1_Function ,Met1_SubDev_or_Port ,Met1_Label
Rd_CurretVals1
,0s
,DA_CURR_D01_LBL ,0
,1
,passive ,MET1
,Current Record ,Device
,0.1
Rd_CurretVals2
,0s
,DA_CURR_D01_LBL ,1
,1
,passive ,MET1
,Current Record ,Device
,0.3
Rd_CurretVals3
,0s
,DA_CURR_D01_LBL ,2
,1
,passive ,MET1
,Current Record ,Device
,0.5
Rd_CurretVals4
,0s
,DA_CURR_D01_LBL ,3
,1
,passive ,MET1
,Current Record ,Device
,1.0
Rd_CurretVals5
,0s
,DA_CURR_D01_LBL ,4
,1
,passive ,MET1
,Current Record ,Device
,3.0
Rd_CurretVals6
,0s
,DA_CURR_D01_LBL ,5
,1
,passive ,MET1
,Current Record ,Device
,5.0
Rd_CurretVals7
,0s
,DA_CURR_D01_LBL ,6
,1
,passive ,MET1
,Current Record ,Device
,10.
Rd_CurretVals8
,0s
,DA_CURR_D01_LBL ,7
,1
,passive ,MET1
,Current Record ,Device
,FLO
Rd_CurretVals9
,0s
,DA_CURR_D01_LBL ,8
,1
,passive ,MET1
,Current Record ,Device
,LOC
Map_Descriptors
Map_Descriptor_Name ,Scan_Interval ,Data_Array_Name ,Data_Array_Offset ,Length ,DA_Byte_Name ,Function ,Node_Name ,Met1_Function ,Met1_SubDev_or_Port
Rd_CurretVals
,0s
,DA_CURR_D01 ,0
,20 ,DA_DUMP_D01 ,Rdbc ,MET1
,Current Record ,Device
Example: If the current record contained this fragment …0.1 000123 LOC 000009 STA 000101 … then the driver would use passive
Map Descriptors to store the value 123 at offset 0 in the Data Array, store the value 9 at offset 8 in DA= DA_CURR_D01_LBL and
would not perform additional storage of the value 101 because it cannot find a label = “STA” . However all these values would be
stored in the Data Array called DA_CURR_01 as described in example 7.
In this example a number of passive Map Descriptors are related to the active RDBC Map Descriptor in that they belong to the same
device (Node Names are the same and both the active and the passives are ‘Device’) as well as all being ‘Current Record’ Map
Descriptors. When the driver receives a response to the poll sent by the active Map Descriptor, then it also looks for matching
passive Map Descriptors. As it looks at the label information for each count info it searches for a Map Descriptor whose Met1_Label
matches the count label. In this example those labels are “0.1” , “0.3” , “0.5” , “1.0” , “3.0” , “5.0”, “10.” , “FLO” and “LOC”. If there
was a count whose label was different from one of these then the driver would not find a matching Map Descriptor and thus would
not perform this additional storage for that count.
This example is similar to the one in example 7 where the current record was read. Here passive Map Descriptors have been added
to store specifically labeled count records in specific places. In addition to the normal storage of the response data, the driver
examines the label which precedes each count value and looks for a matching Map Descriptor. Examples 7, 8 and 9 can be
combined and the current record stored in all 3 ways.
4.13.
FS-8700-123 MetOne Particle Counter Serial Driver Manual
Map Descriptor Example 10 – Reading from a SubDevice/Port
Page 18 of 26
Map_Descriptors
Map_Descriptor_Name,
Read Record,
Data_Array_Offset,
0,
Function,
Rdbc,
will
select
Address,
3,
‘SubDevice’
Met1_SubDev_or_Port,
SubDevice,
Number SubDevices 1..64
Number Ports 0..63
Use the keyword ‘Port’ to select a
specific port.
Then driver
number 3.
Node_Name
MET1,
Length,
20,
Scan_Interval
1.0s
Then driver will read
the current record.
Met1_Function,
Current Record,
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.com
Driver will select this
device. (Driver finds
the device number by
looking
at
the
definition of the Node
named MET1.)
Data_Array_Name,
DA_DATA,
In this example the current record is read from the Sub Deice #3 on the device named Met1. The driver will use the device name to
look up the Node_ID (or device number) on the device descriptor (see chapter 4.3Client Side Node Descriptors ). The driver will
select the device, select the sub device and finally will read the current record.
If there is a requirement to read data from a specific sub-device or port., any of the preceding examples can be modified by
specifying whether the message must be directed at a Sub Device or Port on a Device and also specifying the Sub Device or Port
number. This is done by specifying the ‘Met1_SubDev_or_Port’ and ‘Address’ parameters. The same technique is used to write
commands or times to SubDevices or Ports.
4.14.
FS-8700-123 MetOne Particle Counter Serial Driver Manual
Map Descriptor Example 11 – Selecting a Sub-Device/Port
Page 19 of 26
DA_MODE_CTRL,
Select Device,
0,
rdbc,
Function,
MET1,
Node_Name
Port,
Met1_SubDev_or_Port,
When using this type of Map Descriptor,
the driver does not send a device select
message first.
Driver will send a port select message to
the port specified with the address
parameter.
Data_Array_Offset,
Met1_Function,
SubDevice/Port
Select,
Set
Met1_Function
‘SubDevice/Port Select’
0,
Address,
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.com
Data_Array_Name,
Map_Descriptors
Map_Descriptor_Name,
=
1,
Length,
The driver uses the Address parameter to learn the number of the Sub-Device or Port to be selected.
When the device responds the driver stores the Sub-Device/ Port number the Data Array element specified in the configuration.
This procedure is automatic. Support for this message is provided for testing purposes only.
4.15.
FS-8700-123 MetOne Particle Counter Serial Driver Manual
FS-8700-123 MetOne Particle Counter Serial Driver Manual
5.
Page 20 of 26
Configuring the FieldServer as a MetOne PC Serial Server
The Server side of the driver was developed to support FST’s QA program. It is not documented
or supported. If you are interested in using the driver to emulate a MetOne Particle Counter then
contact the FST Sales group.
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.com
FS-8700-123_MetOne Particle Counter by Hach Ultra Analytics Manual
Page 21 of 26
Appendix A. Driver Error Messages
Message
MET1:#01 Err. Cant set mode to
state=%d for MD=%s
MET1:#02 Err. Cant set Sample
time to zero. MD=%s
MET1:#03 Err. Cant set Holde
time to zero. MD=%s
MET1:#04a/b Err.
string=%s MD=%s
Invalid
time
Description
An attempt was made to send a mode control command to
a device. The required mode is derived from the Data
Array value. This message is printed when the driver
doesn’t recognize the value found and thus cannot send
the command. This can be resolved by having the
upstream device send a valid value to the DA:offset
associated with the reported MD. Refer to the example in
section 4.9 for more information.
The reported Map Descriptor is being used to send a new
Sample Time to the field device but the time found in the
Data Aarray:offset specified on the Map Descriptor is zero.
The driver cannot send a sample time of zero. This can be
resolved by by having the upstream/other protocol send a
non-zero value to the DA:Offset.
The reported Map Descriptor is being used to send a new
Hold Time to the field device but the time found in the Data
Array:offset specified on the Map Descriptor is zero. The
driver cannot send a sample time of zero. This can be
resolved by by having the upstream/other protocol send a
non-zero value to the DA:Offset.
Message 4a is printed when a response to a poll for the
Sample/Hold time returned a response whose time cannot
be correctly understood by the driver. If this error occurs
rarely it may be a consequence of an occasional
corruption. If it occurs consistently, take a log, ensure this
event occurs at least once during the log and contact Tech
Support. The FieldServer web site provide tools and
instructions for taking logs.
Message 4b is printed when the time is formatted correctly
but found be an invalid time. The same considerations
apply as with 4a.
MET1:#05 FYI. MD=%s too short
This message is printed once and trhen suppressed.
to
store
all.
Ignored
stat
incremented each time this
The Map descriptor is not long enough to store all data
happens. Play safe - set MD
from the record..2 Refer to section 4.11.
length=20.
If a response to a read Current Record contains a
checksum error the driver prints this message.
If this error occurs rarely then it may be a consequence of
MET1:#06 Err. Cant store Current
an occasional corruption. If it occurs consistently, take a
Record. Chksum err.
log, ensure this event occurs at least once during the log
and contact Tech Support. The FieldServer web site
provide tools and instructions for taking logs
2
Update the configuration file, download the modified configuration file and reset the FieldServer for the
changes to take effect.
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.com
FS-8700-123_MetOne Particle Counter by Hach Ultra Analytics Manual
Page 22 of 26
Message
Description
MET1:#07 Err. Cant find DA=%s
to get Mode.
MET1:#07b Err. Cant find DA=%s
Printed by the Server side of the driver. The Server cant
to set Mode.
find the specified DA which will be used to store incoming
data or from which data will be extracted to form a
MET1:#07c Err. Cant find DA=%s
response.3
to get current record.
MET1:#07d Err. Cant find DA=%s
to store times.
MET1:#08a Err. Invalid time
string=%s
Printed by the Server side of the driver. See notes for #4.
MET1:#08b Err. Invalid time
string=%s
The reported MD has a Met1 function not recognized by
MET1:#09a
Err. the driver. This should never happen. Take a log and send
Met1_Function=%d is unknown. a copy of the log and your configuration to Tech Support.
MD=%s
The FieldServer web site provide tools and instructions for
taking logs
This messages is printed a maximum of 15 times and then
suppressed.
Where the label method is being used to store data. (See
section 4.13) then this message is printed if the driver can’t
Met1:#10 FYI. No place to store find an Map Descriptor with a label which matches the
label data. Label=%s MD=%s
reported label found in the message from the field device.
The message is printed simply to alert users to what count
labels are being returned. Passive Map Descriptors can
be created to store the reported data, or the message
could be ignored.
MET1:#11a Err. Diagnostic 6
MET1:#11b Err. Diagnostic 1
MET1:#11c Err. Diagnostic 4
MET1:#11d Err. Diagnostic 2
Printed by the Server side of the driver. These are printed
when internal diagnostics are triggered. This should never
be the case in an operational system. Take a log and
contact Tech Support. The FieldServer web site provide
tools and instructions for taking logs
MET1:#11e Err. Diagnostic 7
MET1:#12 FYI. Use an Array
This message can be ignored. For more information read
called <%s> to expose diagnostic
Appendix A.2
info.
3
Update the configuration file, download the modified configuration file and reset the FieldServer for the
changes to take effect.
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.com
FS-8700-123_MetOne Particle Counter by Hach Ultra Analytics Manual
Page 23 of 26
Message
MET1:#13 Err. Node=%d cant be
selected because not defined in
config.
Description
The reported device could not be selected because there
isnt a node descriptor whose Node_ID matches the
reported device.4
The driver has set the default poll delay to the reported
"Met1:#14
FYI
Poll_Delay
value. This setting can be overridden in the configuration
overridden to %d
file.4
The driver has determined that the Length parameter is
Met1:#15 Err. Set MD Length=%d
too small. The reported length is the driver suggestion. 4
The parameter called Length must be specified for each
Map Descriptor. It tells the FieldServer how much Data
Met1:#16 Err. Set MD Length
Array space to reserve. Review the Map Descriptor
examples in this manual. 4
MET1:#17 Err. MD too long,
Review the Map Descriptor examples in this manual. 4
Max=%u
MET1:#18 Err. Invalid Port=%d.
Invalid entry for port.4
Valid Range=0-63
MET1:#19
Err.
Invalid
SubDevice=%d. Valid Range=1- Invalis entry for SubDevice4
64
MET1:#20 Err. Met1_Function not
The parameter “Met1_Function’ must be specified for
specified
every Map Descriptor. Refer to Section 4.4.2 as well as
MET1:#21
Err.
Map Descriptor examples provided in Chapter 4.4
Met1_Function='%s'
not
recognized
Appendix A.1. Driver Operating and Error Statistics
These notes outline any driver specific use of the normal driver operating stats documented
in the FieldServer Configuration Manual.
•
•
•
•
Timeouts : During normal polling, a timeout can mean that the field device did not
respond to the select message, (or the sub-device select message) or did not respond to
the poll for data or the command poll.
Exception Stats: If the driver select a device , sub-device or port and the return code
from the device is unexpected the this stat is incrmented by 1.
Ignored Stats: If the current record is read and there is more data than can be stored
than specified by the Length of the Map Descritor then this stat is incremented.
The driver does not use the normal operating stats to count message and bytes received
in response to select / sub select messages.
4
Update the configuration file, download the modified configuration file and reset the FieldServer for the
changes to take effect
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.com
FS-8700-123_MetOne Particle Counter by Hach Ultra Analytics Manual
Page 24 of 26
Appendix A.2. Driver Exposed Operating and Error Statistics
In addition to the normal operating stats the driver can expose additional operating/error
stats in a Data Array which can be monitored by a remote device.
A special Data Array name is required. The driver recognizes the Data Array by its name
which must be "met1-stats"
The following example shows how this Data Array can be configured. This section of text
can be copied directly into the CSV file.
Data_Arrays
Data_Array_Name,
Met1-stats,
Data_Format,
UINT32,
Data_Array_Length
1000
The driver stores the following data. The location in the data array is obtained by
multiplying the port number by 100 and then using the location offset indicated in the table
below.
Offset + x
Where x = port_number*100
Physical Port 1 = Port Number 2
Physical Port 2 = Port number 1
Offset
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
Description
Stores the select code of the most recently selected device - This is done by the Server
side of the driver
Stores the select code of the most recently selected sub-device/port - This is done by the
Server side of the driver
Stores the operating command code of the most recently commanded device/subdevice/port - This is done by the Server side of the driver
When the driver stores current record counts by label then the driver stores the 1st
character of the label here. This gets overwritten each time new label data is stored.
See previous. 2nd Character.
See previous. 3rd Character.
See previous. 4th Character.
Increments by 1 each time driver stores using the label method.
Increments by 1 each time internal diagnostic 1 is triggered. Should be zero in operational
systems.
Increments by 1 each time internal diagnostic 4 is triggered. Should be zero in operational
systems.
Increments by 1 each time internal diagnostic 5 is triggered. Should be zero in operational
systems.
Increments by 1 each time internal diagnostic 6 is triggered. Should be zero in operational
systems.
Increments by 1 each time internal diagnostic 7 is triggered. Should be zero in operational
systems.
Increments by 1 each time there is no response to a select message
Increments by 1 each time there is no response to a sub-device/port select message
Increments by 1 each time there is no response to a non select message
Increments by 1 each time a response has a checksum error. Only current record poll
responses contain checksums.
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.com
FS-8700-123_MetOne Particle Counter by Hach Ultra Analytics Manual
Offset
18
19
20
21
22
23
24
25
26
Page 25 of 26
Description
Increments by 1 each time the Client side sends a select message
Increments by 1 each time the Client side sends a sub-device select message
Increments by 1 each time the Client side sends a port select message
Stores the select code of the most recent select message sent by the Client
Stores the sub-device/port select code of the most recent sub-device/port select message
sent by the Client
Each time Client side sends a message this stat increments by 1
Each time Client side sends a message this stat increments by the number of bytes in the
message
Increments by 1 each time a complete response is received from the field device
Increments by the number of bytes contained in a complete response received from the
field device
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.com
FS-8700-123_MetOne Particle Counter by Hach Ultra Analytics Manual
Page 26 of 26
THIS PAGE INTENTIONALLY LEFT BLANK
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.com