FieldServer FS-8700-74 Release note

ASierraMonitorCompany
APPLICABILITY & EFFECTIVITY
Effective for all systems manufactured after May 1, 2001
Driver Manual
(Supplement to the FieldServer Instruction Manual)
FS-8700-74 Veeder-Root
Driver Version: 1.01
Document Revision: 3

FS-8700-74 Veeder Root Driver Manual Table of Contents
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: [phone] Fax: [phone] Toll_Free: 888-509-1970 email: [email protected]
TABLE OF CONTENTS
1. Veeder-Root Driver Description..........................................................................................3
2. Driver Scope of Supply........................................................................................................4
2.1. Supplied by FieldServer Technologies for this driver ...................................................4
2.2. Provided by the Supplier of 3
rd
Party Equipment..........................................................4
2.2.1. Required 3
rd
Party Hardware.....................................................................................4
3. Hardware Connections ........................................................................................................5
4. Configuring the FieldServer as a Veeder-Root Client.......................................................6
4.1. Data Arrays...................................................................................................................6
4.2. Client Side Connections ...............................................................................................7
4.3. Client Side Nodes.........................................................................................................8
4.4. Client Side Map Descriptors.........................................................................................8
4.4.1. FieldServer Specific Map Descriptor Parameters .....................................................8
4.4.2. Driver Specific Map Descriptor Parameters..............................................................9
4.4.3. Timing Parameters....................................................................................................9
4.4.4. Map Descriptor Example 1 - Alarms........................................................................10
4.4.5. Map Descriptor Example 2 - Inventory....................................................................11
4.4.6. Map Descriptor Example 3 – Most Recent Delivery Report....................................12
5. Configuring the FieldServer as a (Veeder-Root Driver) Server......................................13
Appendix A. Advanced Topics............................................................................................14
Appendix A.1. Data Type and Required Lengths .................................................................14
Appendix A.2. Supported Functions.....................................................................................15
Appendix A.3. Alarm Types..................................................................................................16
Appendix A.4. Security Codes..............................................................................................20
Appendix B. Trouble Shooting and Driver Error Messages .............................................21
Appendix B.1. Driver Stats....................................................................................................24
Appendix B.2. Table of Module Types..................................................................................25
Appendix C. Advanced Map Descriptor Examples............................................................26
Appendix C.1. Advanced Example 1 – Polling for Tank / Sensor / Input / Relay / Device
Status 26
Appendix C.2. Advanced Example 2 – Resetting Remote Alarms .......................................27
Appendix C.3. Advanced Example 3 – System Configuration..............................................27
Appendix C.4. Advanced Example 4 – System Diagnostics.................................................28
Appendix C.5. Advanced Example 5 – System Revision Level Report................................29
Appendix C.6. Advanced Example 6 – System Revision Level Report II.............................30
Appendix C.7. Advanced Example 7 – Stick Height Report ................................................31
Appendix C.8. Advanced Example 8 – Active Alarm Report................................................31
Appendix C.9. Advanced Example 9 – Cleared Alarm Report .............................................32

FS-8700-74 Veeder Root Driver Manual Page 3 of 33
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: [phone] Fax: [phone] Toll_Free: 888-509-1970 email: [email protected]
1. Veeder-Root Driver Description
The Veeder-Root Serial Driver allows the FieldServer to transfer data to and from devices over
either RS-232 or RS-485 ports using Veeder-Root protocol as defined in Veeder Root
Document 576013-635 Revision J.
The FieldServer emulates a Client.
The Veeder-Root Serial Driver is a poll response driver. Only one query or command can be
processed at a time.
A limited set of the queries and commands defined in the protocol specification have been
implemented. The reason for the limitation is two-fold. Firstly, not all commands/queries will
have any meaning to a downstream device as they are principally defined to configure the
Veeder-Root Device. Secondly some commands return very complex data sets which cannot
be processed in a method suitable for loading into the FieldServer’s Data Arrays.
The driver is capable of exposing its communications statistics. This can be useful if you wish
to monitor them using a downstream device. In this way you can ensure that you are using
valid data and can generate alarms if communication problems arise.

FS-8700-74 Veeder Root Driver Manual Page 4 of 33
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: [phone] Fax: [phone] Toll_Free: 888-509-1970 email: [email protected]
2. Driver Scope of Supply
2.1. Supplied by FieldServer Technologies for this driver
FieldServer Technologies
PART # Description
FS-8915-10 UTP cable (7 foot) for RS-232 use
FS-8917-01 RJ45 to DB25M connection adapter
FS-8700-74 Driver Manual.
2.2. Provided by the Supplier of 3
rd
Party Equipment
2.2.1. Required 3
rd
Party Hardware
PART # DESCRIPTION
Veeder-Root Panel

FS-8700-74 Veeder Root Driver Manual Page 5 of 33
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: [phone] Fax: [phone] Toll_Free: 888-509-1970 email: [email protected]
3. Hardware Connections
The FieldServer is connected to the Veeder-Root Panel as shown below.
Configure the Veeder-Root Panel according to manufacturer’s instructions.
DATE: 1/17/02
BY: MN
(408)-262-2299
BASE NAME:
FILE NAME: FS-T28700-74 .VSD
VEEDER ROOT
CONNECTION DIAGRAM
P4P1
Rx
P2 P3
Tx Rx Tx TxRx Rx P7P5 P6 Tx Rx Tx TxRx Rx P8 R1 Tx Rx Tx Rx Tx
R2 Ne t 1
TxRx RxTx Con
Net 2
Sys
Com
Tx Rx Con
Act Run Pwr
RS485
RS232 10 Base T
ETHERNET
P1 P7 R1P2 R2
P3 P4 P5 P6 P8 N1 N2
8917-07
FieldServer
FIELDSERVER
FUNCTION FROM TO COLOR
RX RJ45-01 DB25M-02 WHITE
CTS RJ45-02 DB25M-05 BROWN
DSR RJ45-03 DB25M-08 YELLOW
GND RJ45-04 DB25M-07 GREEN
DTR RJ45-06 DB25M-20 BLACK
RTS RJ45-07 DB25M-06 ORANGE
TX RJ45-08 DB25M-03 BLUE
TLS-350
8917-07 WIRE LIST
RJ45 CAT 5 Cable
Connect to
RS232 port P1-P8

FS-8700-74 Veeder Root Driver Manual Page 6 of 33
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: [phone] Fax: [phone] Toll_Free: 888-509-1970 email: [email protected]
4. Configuring the FieldServer as a Veeder-Root 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.
This section documents and describes the parameters necessary for configuring the FieldServer
to communicate with a Veeder-Root Device.
The configuration file tells the FieldServer about its interfaces, and the routing of data required.
In order to enable the FieldServer for Veeder-Root Driver 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 Up to 15 alphanumeric
characters
Data_Format Provide data format. Each Data
Array can only take on one format.
FLOAT, BIT, UInt16, SInt16,
Packed_Bit, Byte,
Packed_Byte, Swapped_Byte
Data_Array_Length
Number of Data Objects. Must be
larger than the data storage area
required for the data being placed in
this array.
1-10,000
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

FS-8700-74 Veeder Root Driver Manual Page 7 of 33
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: [phone] Fax: [phone] Toll_Free: 888-509-1970 email: [email protected]
4.2. Client Side Connections
Section Title
Connections
Column Title Function Legal Values
Port Specify which port the device is
connected to the FieldServer P1-P8, R1-R2
1
Baud* Specify baud rate 300 – 9600, standard baud rates
only – Vendor limitation.
Parity* Specify parity Even, Odd, None
Data_Bits* Specify data bits 7, 8
Stop_Bits* Specify stop bits 1, 2
Protocol Specify protocol used Vroot, Veeder
Handshaking* Specify hardware handshaking None
Poll Delay* Time between internal polls 0-32000 seconds, 1 second
Example
// Client Side Connections
Connections
Port, Baud, Parity, Protocol, Handshaking, Poll_Delay
P1, 9600, None, Vroot, 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.

FS-8700-74 Veeder Root Driver Manual Page 8 of 33
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: [phone] Fax: [phone] Toll_Free: 888-509-1970 email: [email protected]
4.3. Client Side Nodes
Section
Title
Nodes
Column
Title Function Legal Values
Node_Name Provide name for node Up to 32 alphanumeric
characters
Node_ID This commonly used parameter is not required for this driver.
Protocol Specify protocol used Vroot, Veeder
Port
Specify which port the device is connected
to the FieldServer
Only one node per port.
P1-P8, R1-R2
2
*Route
This parameter is only required if security
is enabled on the Veeder-Root device.
In this case the route must be set to
contain the 6 digits that form the security
code.
Example. If the security code is 556741
then enter route as
5.5.6.7.4.1
a.b.c.d.e.f
a,b,c,d,e,f must be decimal
digits in the range 0 to 9.
Example
// Client Side Nodes
Nodes
Node_Name, Protocol, Port
VR_Node1 , Vroot , P1
4.4. Client Side Map Descriptors
4.4.1. FieldServer Specific Map Descriptor Parameters
Column Title Function Legal Values
Map_Descriptor_Name Name of this Map Descriptor Up to 32 alphanumeric
characters
Data_Array_Name Name of Data Array where data is to be stored in the
FieldServer
One of the Data Array names
from “Data Array” section
above
Data_Array_Location Starting location in Data Array 0 to maximum specified in
“Data Array” section above
Function Function of Client Map
Descriptor RDBC, WRBC, WRBX
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.

FS-8700-74 Veeder Root Driver Manual Page 9 of 33
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: [phone] Fax: [phone] Toll_Free: 888-509-1970 email: [email protected]
4.4.2. Driver Specific Map Descriptor Parameters
Column
Title Function Legal Values
Node_Name Name of Node to fetch data from One of the node names specified in “Client Node
Descriptor” above
Data_Type Data type
System, Tank, Liquid Sensor,
Vapor Sensor, Input,
Volumetric Line, Groundwater
Sensor, Type-B Sensor,
Universal Sensor, Auto-Dial,
Mech. Dispenser, Elec.
Dispenser, Product, Press.
Line, External, WPLLD
*Address
¥
The address is used to specify the
Tank/Sensor/Input /Relay … Number to
be used in the poll. For some data
types the address has no meaning and
should be set to 1.
Veeder-Root Tanks / Sensors … are
numbered from 1. The maximum tank
number is 12 and the maximum sensor
number if 64.
When zero is used as the value of the
address then (in most cases) the driver
polls for all Tanks/ Sensors belonging
to that data type. This is discussed in
the Advanced Topics Section.
0, 1, 2, 3…
Length
¥
Length of Map Descriptor
The length is used to tell the driver how
many elements of the Data Array are
under the control of the Map Descriptor.
This is important because the driver
uses the length to, for example, clear
Data Array elements when a
Tank/Sensor has no alarms.
1 - 1000
4.4.3. Timing Parameters
Column Title Function Legal Values
Scan_Interval Rate at which data is polled >0.1s
¥
See Appendix A.1 for Data Type, Address and Length Limitations.

FS-8700-74 Veeder Root Driver Manual Page 10 of 33
FieldServer Technologies 1991 Tarob Court Milpitas, California 95035 USA Web:www.fieldserver.com
Tel: [phone] Fax: [phone] Toll_Free: 888-509-1970 email: [email protected]
4.4.4. Map Descriptor Example 1 - Alarms.
This example provides one Map Descriptor to poll for alarm data and many Map Descriptors to store the response from the poll. One
Map Descriptor is required for each tank/sensor/input/device defined for the system. The address of each of these passive Map
Descriptors must correspond to the tank/sensor/input/device number. For example, where 5 tanks are defined as tanks 1,2,3,6,7
then 5 Map Descriptors with the data type ‘Tank’ are required and the address of each of these 5 Map Descriptors must be set to
1,2,3,6,7. The length parameter tells the driver how much array space is reserved for each tank/sensor… for storing alarms.
Map_Descriptors
Map_Descriptor_Name, scan_interval, Data_Array_Name, Data_Array_Offset, Function, node_name, Address, Length, Data_Type,
Poller 1.0s , DA_101 , 0 , rdbc , Node_A , 1 , 30 , System Status
Map_Descriptors
Map_Descriptor_Name, Data_Array_Name, Data_Array_Offset Function, node_name, Address, Length, Data_Type
Sys_alms01 , DA_S1 , 0 , passive , Node_A , 1 , 30 , System
Tank_Alms1 , DA_T1 , 0 , passive , Node_A , 1 , 30 , Tank
LiqSensor_Alm1, DA_L1 , 0 , passive , Node_A , 1 , 30 , Liquid Sensor
VaporSens_Alm1, DA_V1 , 0 , passive , Node_A , 1 , 30 , Vapor Sensor
Input_Alm1 , DA_I1 , 0 , passive , Node_A , 1 , 30 , Input
VolLine_Alm1 , DA_O1 , 0 , passive , Node_A , 1 , 30 , Volumetric Line
GWater_Alms1 , DA_G1 , 0 , passive , Node_A , 1 , 30 , Groundwater Sensor
TypeB_SensALm1 , DA_B1 , 0 , passive , Node_A , 1 , 30 Type-B Sensor
Univ_SensAlm1 , DA_U1 , 0 , passive , Node_A , 1 , 30 , Universal Sensor
AutoDial_Alms1 , DA_F1 , 0 , passive , Node_A , 1 , 30 , Auto-Dial
MechDisp_Alm1 , DA_M1 , 0 , passive , Node_A , 1 , 30 , Mech. Dispenser
ElecDisp_Alm1 , DA_E1 , 0 , passive , Node_A , 1 , 30 , Elec. Dispenser
Product_Alms1 , DA_P1 , 0 , passive , Node_A , 1 , 30 , Product
PressLine_Alm1 , DA_R1 , 0 , passive , Node_A , 1 , 30 , Press. Line
External_Alm1 , DA_X1 , 0 , passive , Node_A , 1 , 30 , External
WPLLD_Alms1 , DA_W1 , 0 , passive , Node_A , 1 , 30 , WPLLD
Only the Map
Descriptor used to
generate the poll
requires a scan
interval.
These Map
Descriptors are
passive because
they do not
generate
messages. They
are used to store
data returned by
the system status
poll.
The address must
correspond to the
tank/sensor/input/device
number.
One Map Descriptor
required for each
tank/sensor/input/device.
The length parameter tells the driver how much array space must be reserved
for storing alarms for a given tank/sensor/input/device.
When an alarm occurs for tank 1 the driver stores the alarm type by setting
the array position corresponding to the alarm type to a non-zero value as well
as setting the first element of the reserved space non-zero as a summary.
See Table 6.3 for alarm type numbers and descriptions.
Example: Tank 1 has two alarms
02 = Tank Leak Alarm
05 = Tank Low Product Alarm
The driver sets array DA_T1 as follows
Index=0 : Value=1 (Summary)
Index=2 : Value=2 (Leak)
Index=5 : Value=5
(
Product
)