advertisement
A Sierra Monitor Company
Driver Manual
(Supplement to the FieldServer Instruction Manual)
FS-8700-74 Veeder-Root
APPLICABILITY & EFFECTIVITY
Effective for all systems manufactured after January 2013
Driver Version: 1.04
Document Revision: 8
FS-8700-74 Veeder Root Driver Manual Table of Contents
TABLE OF CONTENTS
Provided by the Supplier of 3 rd
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: [email protected]
FS-8700-74 Veeder Root Driver Manual Table of Contents
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: [email protected]
FS-8700-74 Veeder Root Driver Manual Page 4 of 41
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 Veeder-
Root Driver supports TLS350 as per Veeder-Root Document 576013-635 Revision Y, and TLS450 as per Veeder-Root
Document 577013-950 Revision G. Since the data protocol is the same for the TLS350+ as for TLS350, it is assumed
connections.
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 Server 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 which allows them to be monitored using a Server device. Thus it is possible to ensure that the data is valid and to generate alarms if communication problems arise.
1.1 Compatibility Matrix
FieldServer Model
FS-x2010
FS-x2011
FSx25
FS-x30
FS-x40
SlotServer
ProtoCessor FPC-FO2
Yes
Yes
ProtoNode Yes
ProtoCessor FPC-FD2 Yes
QuickServer FS-QS-1010 Yes
QuickServer FS-QS-1011 No
Compatible with this driver
Yes
Yes
Yes
Yes
Yes
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: [email protected]
FS-8700-74 Veeder Root Driver Manual
2
DRIVER SCOPE OF SUPPLY
2.1 Supplied by FieldServer Technologies for this driver
FieldServer Technologies PART # Description
FS-8917-07 RJ45 to DB25M connection adapter
FS-8915-10
FS-8917-27 (for TLS-450 panel)
UTP (Cat5) cable (7 foot) for RS-232 use
RJ45 to DB9M Connector
2.2 Provided by the Supplier of 3
rd
Party Equipment
2.2.1 Required 3
r d
Party Hardware
Part # Description
Veeder-Root Panel
Page 5 of 41
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: [email protected]
FS-8700-74 Veeder Root Driver Manual
3
HARDWARE CONNECTIONS
The FieldServer is connected to the Veeder-Root Panel as shown below.
Page 6 of 41
TLS-350
8917-07
RJ45 CAT 5 Cable
FieldServer
8 1
P1
Connector Pinouts
FS-X40 Function RJ45 Pin# DB25M Pin# Color
RX
CTS
1
2
2
5
White
Brown
DSR
GND
3
4
8
7
Yellow
Green
DTR
RTS
TX
6
7
8
20
6
3
Black
Orange
Blue
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: [email protected]
FS-8700-74 Veeder Root Driver Manual
3.1 TLS-450 Connection
Page 7 of 41
TLS-450
3 7-0 91 FS
FS-8917-27
RJ45 to
DB9M
Connector
RJ45 CAT 5 Cable
FS8915-10
8 1
FieldServer
P1
Connector Pinouts
TLS450 Function RJ45 Pin # DB9M Pin # Color
RX 01 03 White
CTS
DSR
GND
02
03
04
08
06
05
Brown
Yellow
Green
DTR
RTS
TX
06
07
08
04
07
02
Black
Orange
Blue
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: [email protected]
FS-8700-74 Veeder Root Driver Manual Page 8 of 41
3.2 Verifying comm. settings at the Veeder Root Panel
From the front screen that shows the time/date, press MODE until “SETUP MODE” menu appears.
Press FUNCTION until “COMMUNICATIONS SETUP” appears.
Press STEP to get to “PORT SETTINGS” menu. Press ENTER to get into “PORT SETTINGS” menu.
The “PORT SETTINGS” menu shows the following parameters:
Comm Board: 1 (RS-232)
Baud Rate:
Parity:
Stop Bit:
Data Length
Code:
To scroll through the parameters, press the STEP button.
To modify a parameter, press the STEP button until the parameter appears on the screen and push
CHANGE to modify. Press ENTER, then follow the prompt by pressing STEP.
If the operator “gets lost” in the menus, press MODE until the front screen showing time/date appears.
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: [email protected]
FS-8700-74 Veeder Root Driver Manual Page 9 of 41
4
DATA ARRAY PARAMETERS
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.
Section Title
Data_Arrays
Column Title Function
Data_Array_Name
Data_Array_Format
Data_Array_Length
Provide name for Data Array
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 by the Map Descriptors for the data being placed in this array.
Legal Values
Up to alphanumeric characters
15
FLOAT, BIT, UInt16,
SInt16, Byte.
1-10, 000
Example
// Data Arrays
Data_Arrays
Data_Array_Name , Data_Array_Format , Data_Array_Length
DA_AI_01 , UInt16 , 200
DA_AO_01
DA_DI_01
DA_DO_01
, UInt16
, Bit
, Bit
, 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: [email protected]
FS-8700-74 Veeder Root Driver Manual Page 10 of 41
5
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.
5.1 Client Side Connection Parameters
Section Title
Connections
Column
Title
Function Legal Values
Port
Baud*
Parity*
Data_Bits*
Stop_Bits*
Protocol
Specify which port the device is connected to the FieldServer
P1-P8, R1-R2
1
Specify baud rate
Specify parity
Specify data bits
Specify stop bits
Specify protocol used
Poll Delay* Time between internal polls
Example
Standard baud rates up to 9600 (TLS-350),
115200 (TLS-450), 9600
Even, Odd, None
7, 8
1, 2
Vroot, Veeder
0-32000 seconds, 1 second
// Client Side Connections
P1 , 9600 , None , Vroot
Connections
Port , Baud , Parity , Protocol
,
Poll_Delay
, 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: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: [email protected]
FS-8700-74 Veeder Root Driver Manual Page 11 of 41
5.2 Client Side Node Descriptors
Section Title
Nodes
Column
Title
Function Legal Values
Node_Name Provide name for node
Protocol
Port
Route*
Plc_Type*
Specify protocol used
Specify which port the device is connected to the FieldServer.
This parameter is only required if security is enabled on the
Veeder-Root device. The route must be set to contain the 6
digits that form the security code. Refer to Appendix A.10
Specify the type of Veeder Root Panel.
Up to 32 alphanumeric characters
Vroot, Veeder
P1-P8, R1-R2
2
Decimal digits in the range 0 to 9 in the format a.b.c.d.e.f,
0.
TLS-450, the default is "-" which defaults to a TLS-350 connection.
Example
// Client Side Nodes
Nodes
Node_Name
VR_Node1
, Protocol , Port , Plc_Type
, Vroot , P1 , TLS-450
5.3 Client Side Map Descriptor Parameters
5.3.1 FieldServer Specific Map Descriptor Parameters
Column Title Function
Map_Descriptor_Name Name of this Map Descriptor
Data_Array_Name
Name of Data Array where data is to be stored in the FieldServer
Data_Array_Location
Function
Starting location in Data Array
Function of Client Map Descriptor
Legal Values
Up to 32 alphanumeric characters
One of the Data Array names from
0 to maximum specified in Section
Rdbc, Wrbc, Wrbx, Passive,
Passive_Client
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: (408) 262 2299 Fax: (408) 262 2269 Toll Free: (888) 509 1970 email: [email protected]
FS-8700-74 Veeder Root Driver Manual Page 12 of 41
5.3.2 Driver Specific Map Descriptor Parameters
Column Title
Node_Name
Data_Type
Function
Name of Node to fetch data from
Data type
Legal Values
One of the Node names
supported Data Types.
Length
Address*
3
Veed_Function
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.
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.
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.
The Veed function number can be specified.
1 – 1000
required lengths for specific
Data Types.
0, 1, 2, 3…
Veeder-Root Tanks / Sensors … are numbered from 1. The maximum tank number is 12 and the maximum sensor number is 64.
Specify using the notation
0xnnn where nnn is the function number, e.g. 0x901
DA_Byte_Name*
DA_Float_Name*
This is an optional Data Array that can be defined to store additional information. The information returned is
specific to the Data Type. Refer to Appendix A.3 and 0 for
examples using this parameter.
This is an optional Data Array that can be defined to store the Current value for the Configuration Data Type. Refer to
One of the Data Array names
One of the Data Array names
5.3.3 Timing Parameters
Column Title Function Legal Values
Scan_Interval Rate at which data is polled >0.1s
3
See Appendix C.1 for Data Type, Address and Length Limitations
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: [email protected]
FS-8700-74 Veeder Root Driver Manual Page 13 of 41
5.3.4 Map Descriptor Example - 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.
Only the Map Descriptor used to generate the poll requires a scan interval.
The address must correspond to the tank/sensor/input/device number.
One Map Descriptor required for each tank/sensor/input/device.
Map_Descriptors
Map_Descriptor_Name , Scan_Interval
Poller , 1.0s
Map_Descriptors
, Data_Array_Name , Data_Array_Offset , Function
, DA_101 , 0 , Rdbc
Map_Descriptor_Name , Data_Array_Name , Data_Array_Offset , Function
, Node_Name , Address , Length
, Node_A , 1 , 30
, Node_Name , Address , Length , Data_Type
Sys_alms01
Tank_Alms1
LiqSensor_Alm1
VaporSens_Alm1
Input_Alm1
VolLine_Alm1
GWater_Alms1
TypeB_SensALm1
Univ_SensAlm1
AutoDial_Alms1
, DA_S1
, DA_T1
, DA_L1
, DA_V1
, DA_I1
, DA_O1
, DA_G1
, DA_B1
, DA_U1
, DA_F1
, 0
, 0
, 0
, 0
, 0
, 0
, 0
, 0
, 0
, 0
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Passive
, Node_A
, Node_A
, Node_A
, Node_A
, Node_A
, Node_A
, Node_A
, Node_A
, Node_A
, Node_A
, 1
, 1
, 1
, 1
, 1
, 1
, 1
, 1
, 1
, 1
, 30
, 30
, 30
, 30
, 30
, 30
, 30
, 30
, 30
, 30
, System
, Tank
, Liquid Sensor
, Vapor Sensor
, Input
, Volumetric Line
, Groundwater Sensor
, Type-B Sensor
, Universal Sensor
, Auto-Dial
, Data_Type
, System Status
MechDisp_Alm1 , DA_M1 , 0 , Passive , Node_A , 1 , 30 , Mech. Dispenser
ElecDisp_Alm1
Product_Alms1
PressLine_Alm1
External_Alm1
WPLLD_Alms1
, DA_E1
, DA_P1
, DA_R1
, DA_X1
, DA_W1
, 0
, 0
, 0
, 0
, 0
, Passive
, Passive
, Passive
, Passive
, Passive
, Node_A
, Node_A
, Node_A
, Node_A
, Node_A
, 1
, 1
, 1
, 1
, 1
, 30
, 30
, 30
, 30
, 30
, Elec. Dispenser
, Product
, Press. Line
, External
, WPLLD
Data is stored in the Data Arrays at the
Passive Map Descriptors do not generate messages. They are used to store data returned by the system status poll.
The length parameter tells the driver how much array space must be reserved for storing alarms for a given tank/sensor/input/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: [email protected]
FS-8700-74 Veeder Root Driver Manual Page 14 of 41
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
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)
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: [email protected]
FS-8700-74 Veeder Root Driver Manual Page 15 of 41
5.3.5 Map Descriptor Example – Poll for System Status (TLS-450)
This example provides one Map Descriptor to poll for system status data and many Map Descriptors to store the response from the poll
Only the Map Descriptor used to generate the poll requires a scan interval.
Map_Descriptors
Map_Descriptor_Name , Scan_Interval
Poller , 5.0s
Map_Descriptors
, Data_Array_Name , Data_Array_Offset , Function
, DA_450_P101 , 0 , Rdbc
Map_Descriptor_Name , Data_Array_Name , Data_Array_Offset , Function
The address must correspond to the tank/sensor/input/device number.
One Map Descriptor required for each tank/sensor/input/device.
, Node_Name , Address , Length
, Node_450 , 1 , 17
, Node_Name , Address , Length , Data_Type
, Data_Type
, System Status
, System SMB_450S1
SMB_450T1
SMB_450L1
SMB_450V1
SMB_450I1
SMB_450G1
SMB_450A1
SMB_450R1
SMB_450B12
SMB_450MC1
SMB_450ED1
SMB_450PR1
SMB_450MS1
SMB_450LPS1
SMB_450PL1
SMB_450PRINT1
SMB_450PUMP1
SMB_450LINE1
SMB_450COMM!
SMB_450CON1
SMB_450AEvent1
SMB_450Exs1
, DA_450S
, DA_450T
, DA_450L
, DA_450V
, DA_450I
, DA_450G
, DA_450A
, DA_450R
, 0
, 0
, 0
, 0
, 0
, 0
, 0
, 0
, DA_450B , 0
, DA_450MC , 0
, DA_450ED
, DA_450PR
, 0
, 0
, DA_450MS , 0
, DA_450LPS , 0
, DA_450PL , 0
, DA_450PRINT , 0
, DA_450PUMP , 0
, DA_450LINE , 0
, DA_450COMM , 0
, DA_450CON , 0
, DA_450AEvent , 0
, DA_450Exs , 0
, Passive_Client
, Passive_Client
, Passive_Client
, Passive_Client
, Passive_Client
, Passive_Client
, Passive_Client
, Passive_Client
, Passive_Client
, Passive_Client
, Passive_Client
, Passive_Client
, Passive_Client
, Passive_Client
, Passive_Client
, Passive_Client
, Passive_Client
, Passive_Client
, Passive_Client
, Passive_Client
, Passive_Client
, Passive_Client
, Node_450 , 1
, Node_450 , 1
, Node_450 , 1
, Node_450 , 1
, Node_450 , 1
, Node_450 , 1
, Node_450 , 1
, Node_450 , 1
, Node_450 , 1
, Node_450 , 1
, Node_450 , 1
, Node_450 , 1
, Node_450 , 1
, Node_450 , 1
, Node_450 , 1
, Node_450 , 1
, Node_450 , 1
, Node_450 , 1
, Node_450 , 1
, Node_450 , 1
, Node_450 , 1
, Node_450 , 1
, 1
, 1
, 1
, 1
, 1
, 1
, 1
, 1
, 1
, 1
, 1
, 1
, 1
, 1
, 1
, 1
, 1
, 1
, 1
, 1
, 1
, 1
, Tank
, Liquid Sensor
, Vapor Sensor
, Input
, Groundwater Sensor
, Type-A Sensor
, Relay Alarm
, Type-B Sensor
, Mech Dispenser
, Elec Dispenser
, Product
, Mag Sensor
, Line Pressure Sensor
, Press. Line
, Printer
, Pump
, Line
, Communication
, Contact
, AutoEvent
, External
Data is stored in the Data Arrays at the
Passive_Client Map Descriptors are used to store data returned by the system status poll.
If the length is set to 1, the system will return a summary of all possible alarms. Length settings >1 can be used to reveal the alarm type.
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: [email protected]
FS-8700-74 Veeder Root Driver Manual Page 16 of 41
5.3.6 Map Descriptor Example - Inventory TLS-350 Device
This example illustrates a poll for Tank Inventory Data. One Map Descriptor is required for each tank. The address should correspond to the tank number. The
Length parameter tells the driver how much storage space to reserve for storing the inventory data. The inventory data is stored as follows.
3.
4.
5.
6.
Index Contents
0. Product Code (Example Array value = 49 indicates product code = ASCII ‘1’)
1.
2.
Tank Status (Bit 1 - (LSB) Delivery in Progress, Bit 2 - Leak Test in Progress, Bit 3 - Invalid Fuel Height Alarm (MAG Probes Only))
Volume
TC Volume
Ullage
Height
Water
7.
8.
.
Temperature
Water Volume
Map_Descriptor_Name , Data_Array_Name , Data_Array_Offset , Function , Scan_Interval , Node_Name , Address , Length , Data_Type
InventoryPoll1 , DA_INVENTORY , 0 , Rdbc , 1.0s , Node_A , 1 , 10 , In-Tank Inventory
Reading the inventory requires an active Map
Descriptor.
Set the address to the tank number. One Map Descriptor per tank.
This is the minimum number of Data
Array elements required to store inventory data.
Tanks 1’s data will be stored in the array DA_INVENTORY starting at the zero’th element (offset=0) and 10 elements of the array are reserved for this data.
Setting the data type generates the correct poll. Ensure that spelling, periods, hyphens in exactly the same as this example.
5.3.7 Map Descriptor Example - Inventory TLS-450 Device
Map_Descriptor_Name , Data_Array_Name , Data_Array_Offset , Function , Node_Name , Address , Length Veed_Function , Data_Type
SMB_IV450 , DA_450INVENT , 0 , Rdbc , Node_450 , 1 , 9 , 0x201 , In-Tank Inventory
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: [email protected]
FS-8700-74 Veeder Root Driver Manual Page 17 of 41
5.3.8 Map Descriptor Example – Most Recent Delivery Report
This example illustrates a poll for Tank Delivery Data. One Map Descriptor is required for each tank. The address should correspond to the tank number. The
Length parameter tells the driver how much storage space to reserve for storing the delivery data. The delivery data is stored as follows. (This function corresponds to the function 20C in the Veeder-Root protocol specification.).
7.
8.
9.
10.
11.
3.
4.
5.
6.
Index Contents
0. Product Code
1.
2.
Number of Deliveries
Start Time
Stop Time
Starting Volume
Starting TC Volume
Starting Water
Starting Temp
Ending Volume
Ending TC Volume
Ending Water
Ending Temp
12.
13.
.
Starting Height
Ending Height
Map_Descriptor_Name , Data_Array_Name , Data_Array_Offset , Function , Scan_Interval , Node_Name , Address , Length , Data_Type
DeliveryPoll01 , DA_DELIVERY , 0 , Rdbc , 1.0s , Node_A , 1 , 30 , In-Tank Delivery
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: [email protected]
FS-8700-74 Veeder Root Driver Manual Page 18 of 41
6
CONFIGURING THE FIELDSERVER AS A (VEEDER -ROOT DRIVER) SERVER
The server functionality of this driver was developed for testing the Client. Its features are not documented and not intended for end-users. It may be possible to extend and document the server at the request of an end-user.
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: [email protected]
FS-8700-74 Veeder Root Driver Manual
Appendix A. Useful Features
Page 19 of 41
Appendix A.1. Polling for Tank / Sensor / Input / Relay / Device Status
This example illustrates the CSV configuration to poll directly for the status of a particular tank. The length parameter reserves space in the array for the driver
to store the possible alarm states for the tank. 0 provides details of the alarm types.
The first element of the array is used to store an alarm summary state. The array element is set non-zero if there are any alarms and is set to zero if there are
Types.
Example:
Tank 1 has two alarms 02 = Tank Leak Alarm; 05 = Tank Low Product Alarm
The driver sets array DA_TANK1_ALMS as follows
Index=0 : Value=1 (Summary) Index=2 : Value=2 (Leak) Index=5 : Value=5 (Product)
Map_Descriptor_Name , Data_Array_Name , Data_Array_Offset , Function , Scan_Interval , Node_Name , Address , Length , Data_Type
Tank1_01_status , DA_TANK1_ALMS , 0 , Rdbc , 1.0s , Node_A , 1 , 30 , Tank
This is an active Map
Descriptor producing a poll
The address must correspond to the tank number (in this example or the sensor / input / relay / device number depending on the data type.)
Amount of array space required to store the alarm types.
Appendix A.2. Resetting Remote Alarms
This example provides a ‘write-on-change’ Map Descriptor used to send the Veeder-Root device a remote alarm reset command. When the value of the first element of the array named DA_COMMANDS changes value, the driver will send the command. The driver stores the Veeder-Root System time in the array on completion of the command.
Map_Descriptor_Name , Data_Array_Name , Data_Array_Offset , Function , Node_Name , Address , Length , Data_Type
Reset_Alms_01 , DA_COMMANDS , 0 , Wrbx , Node_A , 1 , 30 , Remote Alarm Reset
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: [email protected]
FS-8700-74 Veeder Root Driver Manual Page 20 of 41
Appendix A.3. System Configuration
This example reads the configuration of the Veeder-Root Panel. The module type is stored in the location corresponding to the slot number. Slot 1’s data is stored at index location 0, slot 2 at index location1, and if the DA_Byte_Name and DA_Float_Name arrays are defined then the driver also stores the Power on
Reset and Current Values in the corresponding array locations.
Table 6.7 provides a listing of module types.
Map_Descriptor_Name , Data_Array_Name , Data_Array_Offset , Scan_interval
Config_poll_1 , DA_MODULES , 0 , 10.0s
Map_Descriptor_Name , Data_Array_Name , DA_Byte_Name
Config_poll_1 , DA_MODULES , DA_POWER
, DA_Float_Name
, DA_CURRENT
, Function
, Rdbc
, Data_Array_Offset
, 0
, Node_Name
, Node_A
, Scan_interval
, 10.0s
, Address
, 1
, Function
, Rdbc
, Length
, 30
, Node_Name
, Node_A
, Data_Type
, Configuration
, Address
, 1
, Length , Data_Type
, 30 , Configuration
Power-On-Reset and Current values are also stored if the
DA_Byte_Name and the
DA_Float_Name parameters are defined. The data format must be set to UINT32 or
FLOAT.
Appendix A.4. Advanced Example 4 – System Diagnostics
This example reads the System Diagnostics Report from the Veeder-Root Panel. The results are stored in 3 consecutive array elements. If the value is set nonzero then the test FAILED. A value of zero means the test passed.
Index Contents
I/O test result
Ram test result
Prom test result
Map_Descriptor_Name , Data_Array_Name , Data_Array_Offset , Scan_interval , Function , Node_Name , Address , Length , Veed_Function , Data_Type
System1poll_1 , DA_SELF_TEST , 0 , 10.0s , Rdbc , Node_A , 1 , 3 , 0x901 , Misc.
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: [email protected]
FS-8700-74 Veeder Root Driver Manual Page 21 of 41
Appendix A.5. System Revision Level Report I
This example reads the System Revision Level from the Veeder-Root Panel. The result is stored in ASCII using up to 100 consecutive array elements. Use an array format BYTE or STRING for this function.
Map_Descriptor_Name , Data_Array_Name , Data_Array_Offset , Scan_interval , Function , Node_Name , Address , Length , Veed_Function , Data_Type
System1poll_1 , DA_REVISION , 0 , 10.0s , Rdbc , Node_A , 1 , 100 , 0x902 , Misc.
The following string will be returned and can be interpreted as described below.
YYMMDDHHmmSOFTWARE# nnnnnn-vvv-rrrCREATED - YY.MM.DD.HH.mm&&CCCC<ETX>
YYMMDDHHmm - Current Date and Time nnnnnn-vvv - Software version number (ASCII text string) rrr - Software revision level (ASCII text string)
YY.MM.DD.HH.mm - Date and time of software creation
&& - Data Termination Flag
CCCC - Message Checksum
Appendix A.6. System Revision Level Report II
This example reads additional System Revision Level data from the Veeder-Root Panel. The result is stored in ASCII using up to 100 consecutive array elements.
Use an array with format BYTE or STRING for this function. The notes below explain how the data should be interpreted.
Map_Descriptor_Name , Data_Array_Name , Data_Array_Offset , Scan_interval , Function , Node_Name , Address , Length , Veed_Function , Data_Type
System1poll_1 , DA_REVISION2 , 0 , 10.0s , Rdbc , Node_A , 1 , 100 , 0x905 , Misc.
The following string will be returned and can be interpreted as described below. i90500YYMMDDHHmmSOFTWARE# 346abb-Tvv-rrrCREATED - YY.MM.DD.HH.mmnnAABBCCDDEEFFGGHHIIJJS-MODULE# nnnnnn-vvv-r
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: [email protected]
FS-8700-74 Veeder Root Driver Manual Page 22 of 41
YYMMDDHHmm Current Date and Time
346 Software Base number (fixed) a bb
T vv
Platform (0 = Standard CPU, PLLD only 1 = Enhanced CPU 2 = (Unused) 3 = Enhanced CPU 16 Tank 4 = Standard CPU without PLLD &
WPLLD 5 = Standard CPU, WPLLD only )
Version level (eg version "15")
Software Type (1 = "Real" 2 = "Demo" 3 = "IFSF")
Language rrr Revision level (e.g. revision "AX1")
YY.MM.DD.HH.mm Date and time of software creation nn number of 2 byte values to follow (Hex)
AA
BB
CC
DD
EE
FF
PERIODIC IN TANK TESTS (00 = DISABLE, 01 = ENABLE)
ANNUAL IN TANK TESTS (00 = DISABLE, 01 = ENABLE)
CSLD (00 = DISABLE, 01 = ENABLE)
BIR (00 = DISABLE, 01 = ENABLE)
FUEL MANAGER (00 = DISABLE, 01 = ENABLE)
PRECISION PLLD (00 = DISABLE, 01 = ENABLE)
GG
HH
TANKER LOAD (00 = DISABLE, 01 = ENABLE)
0.2 GPH PLLD (00 = DISABLE, 01 = ENABLE)
II PRECISION PLLD ON DEMAND (00 = DISABLE, 01 = ENABLE)
JJ SPECIAL 3 TANK/LINE CONSOLE (00 = DISABLE, 01 = ENABLE)
SEM Info 3 parts, if none "NO SOFTWARE MODULE nnnnnn vvv r
SEM number (ASCII text string)
SEM Software version number (ASCII text string)
SEM Software Revision number (ASCII text string)
Appendix A.7. Stick Height Report
This example reads the Stick height Report from the Veeder-Root Panel. The result is stored as a real number. Scaling may be applied if specified in the Map
Descriptor. Refer to the FieldServer Configuration manual. Use one Map Descriptor per tank.
Map_Descriptors
Map_Descriptor_Name , Data_Array_Name , Data_Array_Offset , Scan_Interval , Function , Node_Name , Address , Length , Data_Type
Poll_Height1 , DA_STICKHEIGHT , 0 , 0.8s , Rdbc , Node_A , 1 , 1 I, n-Tank Stick Height
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: [email protected]
FS-8700-74 Veeder Root Driver Manual Page 23 of 41
Appendix A.8. Active Alarm Report
This example reads the Veeder-Root Panel for active alarms (includes acknowledged and active). If there are any active alarms then the 1 st
element of the Data
Array is set non-zero. If there are no active alarms then the array element is set to zero. A number of passive are required Map Descriptors to store alarms for
the tanks. Sensor / inputs / devices as described in Section 5.3.4
Map_Descriptors
Map_Descriptor_Name , Data_Array_Name , Data_Array_Offset , Scan_Interval , Function , Node_Name , Address , Length , Data_Type
AlarmPoll-11 , DA_ACTIVEALM , 0 , 2.0s , Rdbc , Node_A , 1 , 1 , Active Alarm Report
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: [email protected]
FS-8700-74 Veeder Root Driver Manual Page 24 of 41
Appendix A.9. Cleared Alarm Report
This example reads the Veeder-Root Panel for cleared alarms. If there are any cleared alarms then the 1 st
element of the Data Array is set non-zero. If there are no cleared alarms then the array element is set to zero. A number of passive are required Map Descriptors to store the cleared alarm info for the tanks.
Sensor / inputs / devices as described in Section 5.3.4
The data is stored in the array specified using the DA_Byte_Name parameter of the passive Map Descriptors.
A stored value of “1” indicates Alarm Cleared. A stored value of “1 2” shows alarm occurred.
The value is stored at the location which corresponds to the alarm type.
Thus if a 02 = Tank Leak Alarm was cleared then at index=2 the value stored will be 1. Active alarms are stored in the primary array.
Map_Descriptor_Name Data_ Array _Name Data_Array_Offset Scan_Interval
AlarmPoll-11 DA_ACTIVEALM 0 2.0s
Map_Descriptors
Map_Descriptor_Name Data_Array_Name DA_Byte_Name
Sys_alms01 DA_S1 DA_S1_CLEAR
Tank_Alms1 DA_T1 DA_T1_CLEAR
Function Node_Name Address Length Data_Type
Rdbc Node_A 1 1 Active Alarm Report
Data_Array_Offset Function Node_Name Address Length Data_Type
0
0 passive Node_A passive Node_A
1
1
30 System
30 Tank
The cleared alarm information is stored in the secondary array specified with the DA_Byte_Name
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: [email protected]
FS-8700-74 Veeder Root Driver Manual Page 25 of 41
Appendix A.10. Security Codes
The RS-232 security code is an optional six-digit code used to limit external serial access to the system for security purposes. It can be set to any unique set of characters using either the front panel switches or the external communication interface setup commands. The system will not respond to a command without the proper security code if the DIP switch is set to enable RS-232 security.
A four-position DIP switch is located on the CPU board, which is mounted in the right-back of the console printer compartment beside the battery switch. The DIP switch enables the security code and the switch positions are assigned as follows:
Switch
1
2
Front Panel Setup Security Enable
RS-232 Security Enable
3, 4 Unused
If RS-232 security is enabled then the Route parameter must be specified for the node. Set the route parameter equal to the security code. Use a period to separate each digit of the code.
Example: Security Code=234419
Route = 2.3.4.4.1.9
Alphabetic characters cannot be directly specified in the route field. They need to be specified as ASCII values.
Example : Security Code = 123abc
Route = 1.2.3.97.98.99
If the security feature has been disabled on the panel the set the route to zero
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: [email protected]
FS-8700-74 Veeder Root Driver Manual Page 26 of 41
Appendix B. Troubleshooting
1. The number of messages received should equal the number of messages sent.
2. The number of errors should represent a small percentage of the total number of messages sent (< 5%).
3. Several errors in consecutive messages may cause the FieldServer kernel to place the node offline in which case polling is slowed significantly until good communications are re-established.
4. If the number of messages received is zero and the number of timeouts is equal to the number of messages sent then a. The connection is bad. Check the cables b. The security configuration is invalid c. The port settings are incorrect. Check the baud rate
5. If the number of messages received and sent are roughly equal and the number of errors is small but the Data
Arrays do not update then a. If polling for System Status – Check the 1 st
element of the Data Array associated with the poll Map
Descriptor. The driver sets or clears the element as a summary alarm state for the Veeder-root device. b. Check that the data age is less than the scan interval.
6. If the number of messages ignored is non-zero then this indicates that some data cannot be stored and is being discarded. Generally this arises when the driver cannot find an appropriate Map Descriptor to store data received in response to a poll (for composite data such as system status). For example: A system alarm occurs but Map Descriptors have not been defined to store system alarms.
7. Monitor the error log to see if the driver has reported any errors or important information. These messages arise in two ways. a. Configuration errors and warnings arise from the way that the CSV file has been configured. These should be eliminated during set-up. b. Errors may arise from some run-time condition. Many of these errors are produced in the error log once and then suppressed so that the log does not overflow or hide other meaningful information.
These messages are preceded by an *
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: [email protected]
FS-8700-74 Veeder Root Driver Manual
Appendix C. Reference
Page 27 of 41
Appendix C.1. Supported Functions
Appendix C.1.1. Data Types Supported by the Driver
The Veeder-Root protocol specification defines a large number of enquiries and commands that may be sent to a
Veeder-Root device. This driver supports the following functions for each device type:
TLS-350
System
Tank
Liquid Sensor
Vapor Sensor
Input
Volumetric Line
Groundwater Sensor
Type-B Sensor
Universal Sensor
TLS-450
System
Tank
Liquid Sensor
Vapor Sensor
Input
Groundwater Sensor
Type-A Sensor
Relay Alarm
Type-B Sensor
Auto-Dial
Mech. Dispenser
Elec. Dispenser
Product
Press. Line
External
WPLLD
Smart Sensor
Modbus Alarm
ISD Site
ISD Hose
Mech. Dispenser
Elec. Dispenser
Product
Press. Line
Mag Sensor
Line Pressure Sensor
Printer
Pump
Line
Communication
Contact
ISD Vapor Flow Meter
PMC
Pump Relay Monitor
VMCI Dispensor Interface
VMC
APM
AutoEvent
External
Appendix C.1.2. TLS-350 Device Support
The revision number indicates the minimum Veeder-Root firmware revision required for support of the function.
The function numbers are hexadecimal numbers. Either convert them to decimal or specify them in the CSV file using the notation 0xnnn where nnn is the function number.
Function_ Revision_ Description
SYSTEM REPORTS (7.2.1)
101
102
1
1
System Status Report
System Configuration Report
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: [email protected]
FS-8700-74 Veeder Root Driver Manual
54
81
82
83
84
31
51
52
53
Function_ Revision_ Description
113 14 Active Alarm Report
114 19 Cleared Alarm Report
IN-TANK REPORTS (7.2.2)
201
202
204
20D
1
1
1
15
In-Tank Inventory Report
In-Tank Delivery Report
In-Tank Shift Inventory Report
In-Tank Stick Height Report
SENSOR REPORTS (7.2.3)
301 1 Liquid Sensor Status Report
306
311
341
1
1
2
Vapor Sensor Status Report
Groundwater Sensor Status Report
Type A (2 Wire CL) Sensor Status Report
346
34B
2
4
Type B (3 Wire CL) Sensor Status Report
Universal Sensor Status Report
LINE LEAK REPORTS (7.2.4)
381 7 Pressure Line Leak Status
386 10 WPLLD Line Leak Status
I/O DEVICE REPORTS (7.2.6)
401
406
1
1
Input Status Report
Relay Status Report
SYSTEM DIAGNOSTIC REPORTS (7.4.1)
901 1 Self Test Results Report
902
905
1
15
System Revision Level Report
System Revision Level Report II
2
3
CONTROL FUNCTIONS (7.1)
1 1 System Reset
1
1
Clear Power Reset Flag
Remote Alarm Reset
5
7
7
10
10
1
1
10
1
Confirm Clear Function
Clear In-Tank Delivery Reports
Start In-Tank Leak Detect Test
Stop In-Tank Leak Detect Test
Delete CSLD Rate Table
Start Pressure Line Leak Test (3.0 GPH only in V18)
Stop Pressure Line Leak Test
Start WPLLD Line Leak Test (3.0 GPH only in V18)
Stop WPLLD Line Leak Test
Appendix C.1.3. TLS-450 Device Support
Function_ Revision_ Description
SYSTEM REPORTS
101 1 System Status Report
Page 28 of 41
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: [email protected]
FS-8700-74 Veeder Root Driver Manual Page 29 of 41
Function_ Revision_ Description
IN-TANK REPORTS
201 1 In-Tank Inventory Report
Appendix C.2. Alarm Tables
System
Tank
Data_Type
9
10
11
7
8
5
6
1
2
3
4
20
21
22
23
14
15
16
17
10
11
12
13
18
19
Data Array
Offset
1
2
Description
Printer out of Paper
Printer Error
5
6
3
4
7
8
9
EEPROM Configuration Error
Battery Off
Too Many Tanks
System Security Warning
ROM Revision Warning
Remote Display Communications Error
Autodial Error
Software Module Warning
Tank Test Shutdown Warning
Protective Cover Alarm
BIR Shift Close Pending
BIR Daily Close Pending
PC(H8) Revision Warning
System Self Test Error
System Clock Incorrect Warning
Tank Low Product Alarm
Tank Sudden Loss Alarm
Tank High Product Alarm
Tank Invalid Fuel Level Alarm
Tank Probe Out Alarm
Tank High Water Warning
Tank Delivery Needed Warning
Obsolete
Obsolete
Obsolete
Version 2
Version 2
Obsolete
Obsolete
Obsolete
System Device Poll Timeout
Maintenance Tracker NVMem Removed
Obsolete
Obsolete
Maintenance Tracker Communication Module Obsolete
Removed
Database Error
File System Error
BIR Status Warning
Tank Setup Data Warning
Tank Leak Alarm
Tank High Water Alarm
Tank Overfill Alarm
Version 2
TLS-450
Avaliability
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
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: [email protected]
FS-8700-74 Veeder Root Driver Manual
Input
Data_Type
Liquid Sensor
Vapor Sensor
8
9
10
1
2
3
6
7
4
5
9
10
2
3
4
5
2
3
6
7
8
29
30
31
32
25
26
27
28
18
19
20
21
22
23
24
Data Array
Offset
12
13
Description
Tank Maximum Product Alarm
Tank Gross Leak Test Fail Alarm
14
15
16
17
Tank Periodic Leak Test Fail Alarm
Tank Annual Leak Test Fail Alarm
Tank Periodic Test Needed Warning
Tank Annual Test Needed Warning
Tank Periodic Test Needed Alarm
Tank Annual Test Needed Alarm
Tank Leak Test Active
Tank No CSLD Idle Time Warning
Tank Siphon Break Active Warning
Tank CSLD Rate Increase Warning
Tank AccuChart Calibration Warning
Tank HRM Reconciliation Warning
Tank HRM Reconciliation Alarm
Tank Cold Temperature Warning
Tank Missing Delivery Ticket Warning
Tank/Line Gross Leak Alarm
Delivery Density Warning
Density warning
Fuel Quality Alarm
Sensor Setup Data Warning
Sensor Fuel Alarm
Sensor Out Alarm
Sensor Short Alarm
Sensor Water Alarm
Sensor Water Out Alarm
Sensor High Liquid Alarm
Sensor Low Liquid Alarm
Sensor Liquid Warning
Sensor Setup Data Warning
Sensor Fuel Alarm
Sensor Out Alarm
Sensor Short Alarm
Sensor Water Alarm
Sensor Water Out Alarm
Sensor High Liquid Alarm
Sensor Low Liquid Alarm
Sensor Liquid Warning
Input Setup Data Warning
Input Normal
Input Alarm
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: [email protected]
Page 30 of 41
TLS-450
Avaliability
Version 2
Future
Future
Version 2
Future
Version 3
Version 3
Not Available
Not Available
Not Available
Not Available
FS-8700-74 Veeder Root Driver Manual
Data_Type
Volumetric Line
Groundwater Sensor
Type-A Sensor
7
8
9
10
2
3
5
6
3
4
26
27
28
2
19
20
21
22
23
24
25
15
16
17
18
11
12
13
14
6
7
4
5
8
9
10
Data Array
Offset
4
5
Generator Off
Generator On
2
3
6
1
Input Out Alarm
Description
VLLD Setup Data Warning
VLLD Self Test Alarm
VLLD Shutdown Alarm
VLLD Leak Test Fail Alarm
VLLD Selftest Invalid Warning
VLLD Continuous Handle On Warning
VLLD Gross Line Test Fail Alarm
VLLD Gross Line Selftest Fail Alarm
VLLD Gross Pump Test Fail Alarm
VLLD Gross Pump Selftest Fail Alarm
VLLD Periodic Test Needed Warning
VLLD Annual Test Needed Warning
VLLD Periodic Test Needed Alarm
VLLD Annual Test Needed Alarm
VLLD Periodic Line Test Fail Alarm
VLLD Periodic Line Selftest Fail Alarm
VLLD Periodic Pump Test Fail Alarm
VLLD Periodic Pump Selftest Fail Alarm
VLLD Annual Line Test Fail Alarm
VLLD Annual Line Selftest Fail Alarm
VLLD Annual Pump Test Fail Alarm
VLLD Annual Pump Selftest Fail Alarm
VLLD Pressure Warning
VLLD Pressure Alarm
VLLD Gross Test Fault Alarm
VLLD Periodic Test Fault Alarm
VLLD Annual Test Fault Alarm
VLLD Fuel Out Alarm
Sensor Setup Data Warning
Sensor Fuel Alarm
Sensor Out Alarm
Sensor Short Alarm
Sensor Water Alarm
Sensor Water Out Alarm
Sensor High Liquid Alarm
Sensor Low Liquid Alarm
Sensor Liquid Warning
Sensor Setup Data Warning
Sensor Fuel Alarm
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: [email protected]
Page 31 of 41
TLS-450
Avaliability
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
FS-8700-74 Veeder Root Driver Manual
Type-B Sensor
Universal Sensor
Auto-Dial
Mech. Dispenser
Elec. Dispenser
Product
Data_Type
Pressure Line
7
8
9
10
1
2
3
5
6
3
4
8
9
10
2
10
2
3
4
5
6
7
Data Array
Offset
4
5
Description
Sensor Out Alarm
Sensor Short Alarm
8
9
6
7
Sensor Water Alarm
Sensor Water Out Alarm
Sensor High Liquid Alarm
Sensor Low Liquid Alarm
Sensor Liquid Warning
Sensor Setup Data Warning
Sensor Fuel Alarm
Sensor Out Alarm
Sensor Short Alarm
Sensor Water Alarm
Sensor Water Out Alarm
Sensor High Liquid Alarm
Sensor Low Liquid Alarm
Sensor Liquid Warning
Sensor Setup Data Warning
Sensor Fuel Alarm
Sensor Out Alarm
Sensor Short Alarm
Sensor Water Alarm
Sensor Water Out Alarm
Sensor High Liquid Alarm
Sensor Low Liquid Alarm
Sensor Liquid Warning
Autodial Setup Data Warning
Autodial Failed Alarm
Autodial Service Report Warning
4
1
2
3
2
3
4
5
Autodial Alarm Clear Warning
Autodial Delivery Report Warning
1 (Only at
TLS-450) DIM Setup Data Warning
4
1
2
3
DIM Disabled Alarm
DIM Communication Failure Alarm
DIM Transaction Alarm
BIR Setup Data Warning
BIR Threshold Alarm
BIR Close Shift Warning
BIR Close Daily Warning
PLLD Setup Data Warning
PLLD Gross Test Fail Alarm
PLLD Annual Test Fail Alarm
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: [email protected]
Version 2
Version 2
Version 2
Version 2
Version 2
Obsolete
Obsolete
Page 32 of 41
TLS-450
Avaliability
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Version 2
FS-8700-74 Veeder Root Driver Manual
External
Data_Type
Wireless PLD (WPLLP)
Page 33 of 41
4
5
2
3
16
17
18
1
6
7
9
10
11
12
13
14
15
5
6
3
4
17
18
1
2
7
8
Data Array
Offset
4
5
6
7
8
9
10
11
12
13
14
15
16
Description
PLLD Periodic Test Needed Warning
PLLD Periodic Test Needed Alarm
PLLD Sensor Open Alarm
PLLD High Pressure Alarm (Obsolete V19)
PLLD Shutdown Alarm
PLLD High Pressure Warning (Obsolete V19) Obsolete
PLLD Continuous Handle On Warning (Obsolete Obsolete
V19)
PLLD Periodic Test Fail Alarm
PLLD Annual Test Needed Warning
PLLD Annual Test Needed Alarm
PLLD Low Pressure Alarm
PLLD Sensor Short Alarm (Obsolete V19)
PLLD Continuous Handle On Alarm
TLS-450
Avaliability
Obsolete
Obsolete
PLLD Fuel Out Alarm
PLLD Line Equipment Alarm
WPLLD Setup Data Warning
WPLLD Gross Test Fail Alarm
WPLLD Periodic Test Fail Alarm
WPLLD Periodic Test Needed Warning
WPLLD Periodic Test Needed Alarm
WPLLD Sensor Open Alarm
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
Obsolete
WPLLD Communications Alarm
WPLLD Shutdown Alarm
Obsolete
Obsolete
WPLLD Continuous Handle On Warning Obsolete
(Obsolete V19)
WPLLD Annual Test Fail Alarm
WPLLD Annual Test Needed Warning
Obsolete
Obsolete
WPLLD Annual Test Needed Alarm Obsolete
WPLLD High Pressure Warning (Obsolete V19) Obsolete
WPLLD High Pressure Alarm (Obsolete V19) Obsolete
WPLLD Sensor Short Alarm (Obsolete V19) Obsolete
WPLLD Continuous Handle On Alarm
WPLLD Fuel Out Alarm
WPLLD Line Equipment Alarm
Externally Detected Communication Alarm
Communications - Data Reception Timeout
Communications - Failed Checksum
Communications - Parity Error
Modem - Line Busy
Modem - No Answer
Modem - No Carrier
Obsolete
Obsolete
Obsolete
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: [email protected]
FS-8700-74 Veeder Root Driver Manual
Relay
Data_Type
Smart Sensor Alarm 28
Modbus Alarm 29
ISD Site Alarm 30
Page 34 of 41
9
10
11
12
7
8
5
6
14
15
16
17
1
2
1
10
11
12
13
8
9
6
7
1
2
1
2
3
4
5
Data Array
Offset
8
9
Description
Modem - No Dial Tone
Modem - Modem Error
10
11
12
13
Modem - Modem Not Responding
Modem - Port Not Available
Polling - Could Not Update Queue
Polling - Invalid Data Type Requested
Relay Setup Data Warning
Relay Out Alarm
Smart Sensor Setup Data Warning
Smart Sensor Communication Alarm
Smart Sensor Fault Alarm
Smart Sensor Fuel Warning
Smart Sensor Fuel Alarm
Smart Sensor Water Warning
Smart Sensor Water Alarm
Smart Sensor High Liquid Warning
Smart Sensor High Liquid Alarm
Smart Sensor Low Liquid Warning
Smart Sensor Low Liquid Alarm
Smart Sensor Temperature Warning
Smart Sensor Relay Active
Smart Sensor Install Alarm
Smart Sensor Sensor Fault Warning
Smart Sensor Vacuum Warning
Smart Sensor No Vacuum Warning
Improper Setup Alarm
Communication Loss Alarm
Stage 1 Transfer Monitoring Failure Warning
2
3
4
Containment Monitoring Gross Failure
Warning
Containment Monitoring Gross Failure Alarm
Containment Monitoring Degradation Failure
Warning
Containment Monitoring Degradation Failure
Alarm
Containment Monitoring CVLD Failure Warning
Containment Monitoring CVLD Failure Alarm
Vapor Processor Over Pressure Failure Warning
Vapor Processor Over Presure Failure Alarm
Vapor Processor Status Test Warning
Vapor Processor Status Test Alarm
Missing Relay Setup Alarm
TLS-450
Avaliability
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: [email protected]
FS-8700-74 Veeder Root Driver Manual Page 35 of 41
Data_Type
ISD Hose Alarm 31
ISD Vapor Flow Meter Alarm 32
PMC Alarm 33
Pump Relay Monitor Alarm 34
4
2
3
1
7
1
5
6
Data Array
Offset
13
14
15
16
17
18
19
20
21
22
1
2
3
Description
Missing Hose Setup Alarm
Missing Tank Setup Alarm
Missing Vapor Flow Meter Alarm
Missing Vapor Pressure Sensor Alarm
Missing Vapor Pressure Input Alarm
Setup Fail Warning
Setup Fail Alarm
Sensor Out Warning
Sensor Out Alarm
PC-ISD Offline
Collection Monitoring Gross Failure Warning
Collection Monitoring Gross Failure Alarm
Collection Monitoring Degradation Failure
Warning
2
3
4
5
6
7
8
9
1
2
Collection Monitoring Degradation Failure
Alarm
Flow Performance Hose Blockage Failure
Warning
Flow Performace Hose Blockage Failure Alarm
Vapor Flow Meter Setup Alarm
Locked Rotor Alarm
VFM Setup Data Warning
VFM Device Out Alarm
Vapor Processor Run Time Fault Warning
Processor Monitoring Effluent Emissions Failure
Warning
Processor Monitoring Effluent Emissions Failure
Alarm
Processor Monitoring Over Pressure Failure
Warning
Processor Monitoring Over Pressure Failure
Alarm
Processor Monitoring Duty Cycle Failure
Warning
Processor Monitoring Duty Cycle Failure Alarm
PMC(Stand alone mode only) Setup Warning
PMC Out Alarm
Setup Data Warning
Pump Relay Alarm
TLS-450
Avaliability
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: [email protected]
FS-8700-74 Veeder Root Driver Manual
Contact
Data_Type
MAG Sensor
Line Pressure Sensor
Printer
Pump
Line
Communication
Auto Event
VMCI Dispensor Interface 35
VMC Alarm 36
APM Alarm 37
Page 36 of 41
4
1
2
3
2
3
2
1
1
1
8
9
6
7
1
2
2
1
3
4
5
2
1
2
1
15
1
2
1
8
9
10
11
12
13
14
Data Array
Offset
2
3
Description
MAG Sensor Setup Data Warning
MAG Sensor Communicaiton Alarm
6
7
4
5
MAG Sensor Fault Alarm
MAG Sensor Fuel Warning
MAG Sensor Fuel Alarm
MAG Sensor Water Warning
MAG Sensor Water Alarm
MAG Sensor High Liquid Warning
MAG Sensor High Liquid Alarm
MAG Sensor Low Liquid Warning
MAG Sensor Low Liquid Alarm
MAG Sensor Temperature Warning
MAG Sensor Relay Active
MAG Sensor Install Alarm
LPR Sensor Setup Data Warning
LPR Sensor Communication Alarm
Printer Out Of Paper
Printer Error
Pump Setup Data
Pump Out Alarm
Line Setup Data Warning
Line Out Alarm
Communicaiton Set Data Warning
Autodial Setup Data Warning
Autodial Failed Alarm
Autodial Service Report Warning
Autodial Alarm Clear Warning
Autodial Delivery Report Warning
Autodial No DialTone Alarm
Autodial Fax Failed Alarm
Email Failed
SMS Failed
Auto Event Setup Data Warning
Setup Data Warning
Disabled VMCI Alarm
VMC Comm timeout
Future
Future
Meter Not Connected
Shutdown Warning
Shutdown Alarm
Gross Over-Pressure Test Warning
APM Gross Over-Pressure Test Failure warning
APM Gross Over-Pressure Test Failure alarm
Future
Future
TLS-450
Avaliability
Future
Obsolete
Obsolete
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: [email protected]
FS-8700-74 Veeder Root Driver Manual Page 37 of 41
Data_Type
Data Array
Offset
4
5
6
7
8
9
Description
APM Degradation Over-Pressure Test Failure warning
APM Degradation Over-Pressure Test Failure alarm
APM Sensor Test Failure warning
APM Sensor Test Failure alarm
APM Setup Failure warning
APM Sensor Out Failure warning
TLS-450
Avaliability
Appendix C.3. Data Type and Required Lengths
The following table provides a list of possible values for the data type parameter as well as the minimum value that the length parameter should be set to for each Map Descriptor of that data type.
Data Type
Configuration
In-Tank Inventory
Misc.
In-Tank Delivery
System Reset
Clear Power Reset
Remote Alarm Reset
Confirm Clear
Clear Delivery Reports
Start In-Tank Leak Detect Test
Stop In-Tank Leak Detect Test
Delete CSLD Rate Table
Start P-Line Leak Detect Test
Stop In-Tank Leak Detect Test
Start WPLLD Leak Detect Test
Stop WPLLD Leak Detect Test
System status
TLS-350
See Example
9
See examples
14
16
16
16
16
16
16
16
16
17
16
16
16
16
16
16
16
16
N/A
N/A
17
TLS-450
N/A
9
N/A
14
N/A
N/A
16
N/A
N/A
16
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: [email protected]
FS-8700-74 Veeder Root Driver Manual Page 38 of 41
Appendix C.4. Module Types
00 - Not used
01 - FourProbe Module
02 - Vapor Sensor Module
03 - Liquid Sensor Module
04 - FourRelay Module
05 - I/O Combo Module
06 - Printer Module
07 - RS-232 Module
08 - Modem Module
09 - Volumetric Line Leak Module
10 - Type B Sensor Module
11 - Universal Sensor Module
12 - Fax/Modem (1785) Module
13 - Remote/Local Printer Module
14 - Pump Sensor Module
15 - European RS-232 Module
17 - EightProbe Module
18 - Mechanical Dispenser Interface Module
19 - Electronic Dispenser Interface Module
20 - Wireless PLLD AC Interface Module
21 - Wireless PLLD Communications Module
22 - Wireless PLLD Controller Module
23 - Hughes Satellite J-Box Module
24 - Fax/Modem (1786) Module
25 - Serial Satellite Module
26 - Three Probe / Three Liquid Sensor Module
27 - Three PLLD Sensor Module
0A - Four Probe w/ Ground Temp Module
0B - Groundwater Sensor Module
0C - Type A Sensor Module
0D - Remote Display Module
1A - Pressure Line Leak Sensor Module
1B - Pressure Line Leak Controller Module
1D - Remote Printer Module
1E - External Fax/Modem Module
1F - RS-485 Module
Appendix C.5. Error Messages
Error
VRoot:#1 FYI. The mapDesc called <%s> is too short.
4
VRoot:#2 FYI. You could have used a mapDesc called
<%s> to expose diagnostic info.
*VRoot:#3 Err. Data
Type=%d is unknown. Data will be discarded.
Action Required
The length of the Map Descriptor used to expose driver statistics is too short. Set the length to at least 600.
You can safely ignore this message. It is a prompt. Refer to Appendix C.6.
The driver has encountered a message reporting an alarm for an equipment category/data type the driver does not recognize. Refer to FST..
4
Download the CSV file, make the relevant changes, then upload the file and cycle power to the FieldServer.
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: [email protected]
FS-8700-74 Veeder Root Driver Manual Page 39 of 41
Error
VRoot:#4 FYI. If there is more than one VRoot node then connect each node to a dedicated port
VRoot:#5 Err. Data Type invalid for this driver.
VRoot:#6 Err. No Default Poll
Function for this data type.
You may ignore this message if only one Veeder-Root node is connected to the
FieldServer. If more than one node is connected then each node must be connected to a separate port.
VRoot:#7 Err. Length too
The message reports the offending Map Descriptor and the number of array elements required. Adjust the length parameter accordingly. Ensure that the new length coupled with the offset fits in the array size.
VRoot:#11 Err. Command
0x54 cannot specify all
VRoot:#12 Err. Command
0x54. Bad confirmation code.
Action Required
The Data types must be spelled, spaced and punctuated exactly as in Appendix C.1
Some data types require an additional Map Descriptor parameter ‘VEED_Function’ to be specified..
For the Data Type (or Veed_Function) specified the address may not be set to zero.
You need one Map Descriptor per tank/sensor/input/device.
Refer to FST.
*VRoot:#13
*VRoot:#16 Err. Array too short to store. Md=<%s>
Rqd=%d
Err. Device
Rejected message. Md=<%s>
This message is generated the first time that the Error Statistic ‘Function Error’ is produced. This error can arise in several ways.
The firmware version of the Veeder-Root device may not support the poll
generated by the Map Descriptor. Refer to Appendix C.1
The Veeder-Root device may not have the tank/sensor/device specified or the message received by the Veeder-Root device is corrupted. Check the devices configured against the address specified in the Map Descriptor.
When this error is produced incoming data is being discarded and alarm or other data will not be updated. There are a few variations on this message. Some do not report the Rqd length. This message is produced as a run-time error. It may arise from a configuration error that has not been corrected. Check for Error #7 messages. If there are any correct the errors by editing the CSV file. Then reset the
FieldServer. If the driver is still producing error 16 then you should report this to
FieldServer support. Provide a copy of your configuration file and a port log to assist in the diagnosis of this error.
*VRoot:#17 Err. Array too short to store. Md= <%s>
ByteArray
*VRoot:#18 Err. Array too short to store. Md= <%s>
Float Array
This error is similar to #16 except that it applies to the array named in the
DA_Byte_Name parameter for the Map Descriptor.
This error is similar to #16 except that it applies to the array named in the
DA_Float_Name parameter for the Map Descriptor.
VRoot:#19 Err. Cant process msg type= %x
You cannot take any corrective action to eliminate this error. Report the message to FieldServer support. It will assist in the diagnosis of the error if you can take a port log and provide a copy of your CSV file.
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: [email protected]
FS-8700-74 Veeder Root Driver Manual Page 40 of 41
Error
*VRoot:#20 FYI. Incoming data is being abandoned.
Func= %x DT= <%s>
Addr=%d
Action Required
This message is a warning. It indicates that a response to a poll contains data for which a Map Descriptor cannot be found to store the data. For example: The response to poll for System Status returns an alarm for Liquid Sensor #3 but you have not defined a Map Descriptor for Liquid sensor #3. You may be able to use the Data Type and the Address to determine what kind of Map Descriptor is required. If, however, you are satisfied that you have Map Descriptors for the data of interest to you then you may safely ignore this message.
*VRoot:#21 Err. Md=<%s> not bound to a port. Can’t be used.
Vroot:#22 FYI. Config reported zero modules.
*VROOT:#23 Err. Address= 0 invalid for this command.
Md= <%s>
5
*VROOT:#24 Err.
Function=%x not supported.
VROOT:#25 FYI. Node=<%s>
No password. Is security disabled on panel?
VROOT:#26 FYI. Node=<%s>
Password=<%s>. Is security enabled on panel?
Read the notes for Error #4 to see how to correct this problem.
You may ignore this message. The Veeder-Root device reported zero configured modules in response to a configuration enquiry.
Set the address
Check the data type’s spelling spacing and punctuation. If the Veed_Function parameter has been specified in the Map Descriptor, check that the function is
supported by the driver and that it is specified correctly. Refer to 0
This message may be safely ignored. It does not indicate an error. This message is printed once for each node which does not have a password. This message provides confirmation that your configuration is not using a password and suggests that you check the panel configuration for the corresponding node to ensure that the security feature has been disabled. Additional information is provided in
to a positive number corresponding tank/sensor/input/device whose data you are polling for. to the
5
Download the CSV file, make the relevant changes, then upload the file and cycle power to the FieldServer.
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: [email protected]
FS-8700-74 Veeder Root Driver Manual Page 41 of 41
Appendix C.6. Driver Stats
In addition to the standard FieldServer communication statistics described in the FieldServer Configuration
Manual, Veeder-Root Driver can also expose some driver statistics by writing data to a Data Array. A special Map
Descriptor named “vroot-stats” is required.
The following example shows how this special Map Descriptor can be configured. This section of text may be copied directly into your CSV file.
Nodes
Node_Name null_node
Data_Arrays
Data_Array_Name
VROOT_STATS
, Protocol
, VRoot
, Data_Format
, UINT32
, Data_Array_Length
, 1000
Map_Descriptors
Map_Descriptor_Name , Data_Array_Name , Node_Name
VRoot-stats , VROOT_STATS , Null_Node
, Length , Data_Type
, 1000 , Stats
The driver uses the Data Array VROOT _STATS (in this example) to store driver specific statistics. Only one of these
Map Descriptors may be specified per FieldServer.
The driver stores the following data.
1 VEED_MASTER_SENDS_MSG
2 VEED_MASTER_SENDS_BYTES
3 VEED_MASTER_TIMEOUT
4 VEED_MASTER_STREAMING
5 VEED_MASTER_RCVS_NAK
6 VEED_MASTER_RCVS_CHECKSUM
7 VEED_MASTER_RCVS_PROTOCOL
8 VEED_MASTER_COMPLETE_ERR
9 VEED_MASTER_RCVS_MSG
10 VEED_MASTER_RCVS_BYTES
11 VEED_MASTER_IC_TIMEOUT
12 VEED_MASTER_SEND_BAD_MSG
13 VEED_STAT_MSG_IGNORED
14 VEED_MASTER_RCV_BAD_FUNC_RESPONSE
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: [email protected]
advertisement
* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project
advertisement