A Sierra Monitor Company
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
Page 1: ...r Company 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 ...
Page 2: ...or 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...
Page 3: ...sponse 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 ...
Page 4: ...509 1970 email support fieldserver com 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 3rd Party Equipment 2 2 1 Required 3rd Party Hardware PART DESCRIPTION Veeder Root Panel ...
Page 5: ...2 BY MN 408 262 2299 BASE NAME FILE NAME FS T28700 74 VSD VEEDER ROOT CONNECTION DIAGRAM P4 P1 Rx P2 P3 Tx Rx Tx Tx Rx Rx P7 P5 P6 Tx Rx Tx Tx Rx Rx P8 R1 Tx Rx Tx Rx Tx R2 Net 1 Tx Rx Rx Tx Con Net 2 Sys Com Tx Rx Con Act Run Pwr RS485 RS232 10 Base T ETHERNET P1 P7 R1 P2 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 ...
Page 6: ...iver 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 wi...
Page 7: ...pecify 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 Handsha...
Page 8: ...tain 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 Na...
Page 9: ...k 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 T...
Page 10: ...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 ElecD...
Page 11: ... indicates product code ASCII 1 1 Tank Status Bit 1 LSB Delivery in Progress Bit 2 Leak Test in Progress Bit 3 Invalid Fuel Height Alarm MAG Probes Only 2 Volume 3 TC Volume 4 Ullage 5 Height 6 Water 7 Temperature 8 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...
Page 12: ... the driver how many tanks to process but it does tell 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 Index Contents 0 Product Code 1 Number of Deliveries 2 Start Time 3 Stop Time 4 Starting Volume 5 Starting TC Volume 6 Starting Water 7 Startin...
Page 13: ... 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com 5 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 ...
Page 14: ...ta Type Length Parameter Setting Normal 1 System 30 Tank 30 Liquid Sensor 30 Vapor Sensor 30 Input 30 Volumetric Line 30 Groundwater Sensor 30 Type A Sensor 30 Type B Sensor 30 Universal Sensor 30 Auto Dial 30 Mech Dispenser 30 Elec Dispenser 30 Product 30 Press Line 30 WPLLD 30 External 30 Relay 30 Configuration 1 In Tank Inventory 10 Misc 20 In Tank Delivery 100 System Reset 20 Clear Power Reset...
Page 15: ...5 1 In Tank Status Report 20C 15 In Tank Most Recent Delivery Report 20D 15 In Tank Stick Height Report SENSOR REPORTS 7 2 3 301 1 Liquid Sensor Status Report 306 1 Vapor Sensor Status Report 311 1 Groundwater Sensor Status Report 341 2 Type A 2 Wire CL Sensor Status Report 346 2 Type B 3 Wire CL Sensor Status Report 34B 4 Universal Sensor Status Report LINE LEAK REPORTS 7 2 4 381 7 Pressure Line ...
Page 16: ... Shift Close Pending 1 System 14 BIR Daily Close Pending 1 System 15 PC H8 Revision Warning 1 System 16 System Self Test Error 1 System 17 System Clock Incorrect Warning 1 System 18 System Device Poll Timeout 2 Tank 1 Tank Setup Data Warning 2 Tank 2 Tank Leak Alarm 2 Tank 3 Tank High Water Alarm 2 Tank 4 Tank Overfill Alarm 2 Tank 5 Tank Low Product Alarm 2 Tank 6 Tank Sudden Loss Alarm 2 Tank 7 ...
Page 17: ...ng 6 Volumetric Line Leak 2 VLLD Self Test Alarm 6 Volumetric Line Leak 3 VLLD Shutdown Alarm 6 Volumetric Line Leak 4 VLLD Leak Test Fail Alarm 6 Volumetric Line Leak 5 VLLD Selftest Invalid Warning 6 Volumetric Line Leak 6 VLLD Continuous Handle On Warning 6 Volumetric Line Leak 7 VLLD Gross Line Test Fail Alarm 6 Volumetric Line Leak 8 VLLD Gross Line Selftest Fail Alarm 6 Volumetric Line Leak ...
Page 18: ... Sensor Fuel Alarm 12 Type B Sensor Alarm 4 Sensor Out Alarm 12 Type B Sensor Alarm 5 Sensor Short Alarm 12 Type B Sensor Alarm 6 Sensor Water Alarm 12 Type B Sensor Alarm 7 Sensor Water Out Alarm 12 Type B Sensor Alarm 8 Sensor High Liquid Alarm 12 Type B Sensor Alarm 9 Sensor Low Liquid Alarm 12 Type B Sensor Alarm 10 Sensor Liquid Warning 13 Universal Sensor Alarm 2 Sensor Setup Data Warning 13...
Page 19: ...LD 4 WPLLD Periodic Test Needed Warning 26 Wireless PLLD 5 WPLLD Periodic Test Needed Alarm 26 Wireless PLLD 6 WPLLD Sensor Open Alarm 26 Wireless PLLD 7 WPLLD Communications Alarm 26 Wireless PLLD 8 WPLLD Shutdown Alarm 26 Wireless PLLD 9 WPLLD Continuous Handle On Warning Obsolete V19 26 Wireless PLLD 10 WPLLD Annual Test Fail Alarm 26 Wireless PLLD 11 WPLLD Annual Test Needed Warning 26 Wireles...
Page 20: ...ounted in the right back of the console printer compartment The DIP switch is next to the battery switch The DIP switch enables the security code and the switch positions are assigned as follows Switch 1 Front Panel Setup Security Enable 2 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 sec...
Page 21: ...ot update then If you are polling for System Status Check the 1st 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 Check that the data age is no more than the scan interval If the number of messages ignored is non zero then this indicates that some data cannot be stored and is being discarded...
Page 22: ...f a node to a port Connections Port Protocol P1 VRoot Nodes Port Protocol N1 P1 Vroot VRoot 5 Err Data Type invalid for this driver Md s The Data types must be spelled spaced and punctuated exactly as in Appendix A 1 VRoot 6 Err No Default Poll Function for this data type Md s Some data types require an addition Map Descriptor parameter VEED_Function to be specified Read the notes example in the A...
Page 23: ... Err Array too short to store Md s ByteArray This error is similar to 16 except that it applies to the array named in the DA_Byte_Name parameter for the Map Descriptor 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_Float_Name parameter for the Map Descriptor VRoot 19 Err Cant process msg type x You cannot take ...
Page 24: ... Is security enabled on panel This message may be safely ignored It does not indicate an error This message is printed once for each node which does have a password configured in the CSV file This message provides confirmation that your configuration is using a password and suggests that you check the panel configuration for the corresponding node to ensure that the security feature has been enabl...
Page 25: ...robe Module 0B Groundwater Sensor Module 02 Vapor Sensor Module 0C Type A Sensor Module 03 Liquid Sensor Module 0D Remote Display 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 1A Pressure Line Leak Sensor Module 11 Universal Sensor Module 1B Pressure Line Leak Controller Module 12 Fax Modem 1...
Page 26: ...o if there are any alarms and is set to zero if there are none The remaining array elements are set non zero based on the types of alarms active for the tank 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_Offs...
Page 27: ...ystem 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 you define the DA_Byte_Name and DA_Float_Name arrays then the driver also stores the Power on Reset and Current Values in the corresponding array locations Table 6 7 ...
Page 28: ...nostics 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 non zero 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_Fu...
Page 29: ...ay elements Use an array whose format is BYTE or STRING for this function The notes below explain how the data should be interpreted YYMMDDHHmmSOFTWARE nnnnnn vvv rrrCREATED YY MM DD HH mm CCCC ETX Notes 1 YYMMDDHHmm Current Date and Time 2 nnnnnn vvv Software version number ASCII text string 3 rrr Software revision level ASCII text string 4 YY MM DD HH mm Date and time of software creation 5 Data...
Page 30: ...d CPU without PLLD WPLLD 5 Standard CPU WPLLD only bb Version level egg version 15 T Software Type 1 Real 2 Demo 3 IFSF vv 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 PERIODIC IN TANK TESTS 00 DISABLE 01 ENABLE BB ANNUAL IN TANK TESTS 00 DISABLE 01 ENABLE CC CSLD 00 DISABLE 01 ENABLE DD BIR 00 DISABLE 01...
Page 31: ...Scan_Interval Function node_name Address Length Data_Type Poll_Height1 DA_STICKHEIGHT 0 0 8s rdbc Node_A 1 1 In Tank Stick Height Appendix C 8 Advanced Example 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 1st element of the Data Array is set non zero If there are no active alarms then the a...
Page 32: ...using the DA_Byte_Name parameter of the passive 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 Map_Descriptors Map_Descriptor_Name Data_Array_Name DA_Byte_Name Data_Array_Offset Function node_name Address Length Data_Type Sys_alms01 DA_S1 DA_S1_CLEAR...
Page 33: ...ual Page 33 of 33 FieldServer Technologies 1991 Tarob Court Milpitas California 95035 USA Web www fieldserver com Tel 408 262 2299 Fax 408 262 9042 Toll_Free 888 509 1970 email support fieldserver com This page intentionally left blank ...
