1
Download Varec 8300 series Instruction manual
Transcript
Dispatch and Fuels Accounting IOM032GVAE1313 8303 Tank Gate Interface Installation and Operations Manual The 8303 scans up to 62 intelligent devices (32 per channel) via serial RS-485 (MODBUS or GSI ASCII) communications, including tank gauges, sensors, PC and PLC systems. DVR Firmware Version : MDTG1_15 DVR Firmware Version : GSTG1_10 Automation Solutions for oil & gas, defense and aviation applications 8303 Copyright All rights reserved. Printed in the United States of America. Except as permitted under the United States Copyright Act of 1976, no part of this publication may be reproduced, stored in a retrieval system or transmitted in any form or by any means electronic, mechanical, photocopying, recording, or otherwise - without the prior written permission of the Publisher: Varec, Inc. 5834 Peachtree Corners East Norcross (Atlanta), Georgia 30092 Phone: (770) 447-9202 Fax: (770) 662-8939 Trademarks Acknowledged Varec, Inc. recognizes all other trademarks. Trademarks of other products mentioned in this manual are held by the companies producing them. FuelsManager® and Varec® are registered trademarks of Varec, Inc. Acrobat Reader® is a registered trademark of Adobe Systems Incorporated. MODBUS® is a registered trademark of Modicon, Inc. All other product and service names mentioned are the trademarks of their respective companies. Disclaimer of Warranties The contract between the Seller and the Buyer states the entire obligation of the Seller. The contents of this instruction manual shall not become part of or modify any prior or existing agreement, commitment, or relationship between the Seller and Buyer. There are no express or implied warranties set out in this instruction manual. The only warranties that apply are those in the existing contract between the Seller and Buyer. The 8300 TGI has not been tested by Varec under all possible operational conditions, and Varec may not have all the data relative to your application. The information in this instruction manual is not all inclusive and does not and cannot take into account all unique situations. Consequently, the user should review this product literature in view of his or her application. If you have any further questions, please contact Varec for assistance. Limitations of Seller's Liability In the event that a court holds that this instruction manual created some new warranties, Seller's liability shall be limited to repair or replacement under the standard warranty clause. In no case shall the Seller's liability exceed that stated as Limitations of Remedy in the contract between the Seller and Buyer. Use of parts that are not manufactured or supplied by Varec voids any warranty and relieves Varec of any obligation to service the product under warranty. Varec recommends the use of only Varec manufactured or supplied parts to maintain or service the 8300 TGI. Varec, Inc. i Tank Gate Interface Terms of Use The information provided in this document is provided "as is" without warranty of any kind. Varec, Inc. disclaim all warranties, either express or implied, including the warranties of merchantability and fitness for a particular purpose. In no event shall Varec, Inc. or its suppliers be liable for any damages whatsoever including direct, indirect, incidental, consequential, loss of business profits or special damages, even if Varec, Inc. or its suppliers have been advised of the possibility of such damages. This manual is solely intended to describe product installation and functions and should not be used for any other purpose. It is subject to change without prior notice. This manual was prepared with the highest degree of care. However, should you find any errors or have any questions, contact one of our service offices or your local sales agent. ii Installation and Operations Manual 8303 Safety Precaution Definitions Caution! Damage to equipment may result if this precaution is disregarded. Warning! Direct injury to personnel or damage to equipment which can cause injury to personnel may result if this precaution is not followed. Safety Precautions Read this manual carefully and make sure you understand its contents before using this product. Follow all instructions and safety guidelines presented in this manual when using this product. If the user does not follow these instructions properly, Varec cannot guarantee the safety of the system. Note Comply with all applicable regulations, codes, and standards. For safety precautions, the user should refer to the appropriate industry or military standards. Caution! Electrical Hazard! Read and understand static and lightning electrical protection and grounding described in API 2003. Make certain that the installation, operation, and maintenance conforms with the practice set forth therein. Warning! Striking the product with a metal object could cause a spark to occur. When removing or replacing the product in flammable or hazardous liquid storage areas, take necessary measures to protect it from impact. Warning! Sparks or static charge could cause fire or explosion! Mechanical connections, worker activity and worker clothing may accumulate electrostatic charges. Care should be used in flammable environments to avoid the hazard. Varec, Inc. iii Tank Gate Interface iv Installation and Operations Manual Contents 1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.1 Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.2 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.3 Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 1.4 Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 1.4.1 System Design . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 1.4.2 Software Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 1.4.3 Host Communication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 1.4.4 Modbus Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 1.4.5 Power Supply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 1.4.6 Power consumption . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 1.4.7 Surge protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 1.4.8 Operating temperature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 1.4.9 Humidity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 1.4.10 Storage temperature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 1.4.11 Mechanical Construction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 2 Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 2.1 Hardware Block Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 2.2 Motherboard Description. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 2.2.1 Power Supply . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 2.2.2 Switches and Indicators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 2.2.3 Communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 3 8203 Dual RS-485 Communications Interface Module . . . . . . . . . . 15 3.1 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 3.2 Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 3.2.1 ID DIP Switch (SW1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 3.2.2 LED Indicators (D1-D4) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Field wiring terminal block (J2,J4) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 3.2.3 Surge/Shield Ground Connector (J3) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 3.2.4 Network terminating resistor jumpers (W4 & W5) . . . . . . . . . . . . . . . . . . . . 18 3.3 Hardware Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 3.3.1 Modbus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 4 Software Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 4.1 Software Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 4.1.1 Real-Time / Multitasking Executive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 4.1.2 Real-Time Clock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 4.1.3 Automatic Fault Recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Varec, Inc. v Contents 4.1.4 Communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 4.1.5 Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 4.1.6 Data Scanning Task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 4.1.7 Database Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 4.1.8 System Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 4.1.9 Tank Gate Interface Software Blocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 4.2 Database Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 4.2.1 Point Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 4.2.2 Parameter Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 4.3 Gathering Point Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 4.3.1 Standard Request-Response Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 4.3.2 Change of State Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 4.3.3 Change of State-Related Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 4.3.4 Modbus Communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 4.3.5 Fixed Modbus Map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 4.3.6 GWBLK method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 4.4 Common Software Blocks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 4.4.1 Clock (CLK) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 4.4.2 Communications (COM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 4.4.3 Floating Point Register (FPREG) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 4.4.4 Emulator (EMU). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 4.4.5 EMU Gateway (EMUGW) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 4.4.6 Gateway Block (GWBLK) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 4.4.7 Integer Register (IREG) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 4.4.8 Modbus Gateway (MODGW) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 4.4.9 Scaler Point (SCALER) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 4.4.10 System Information (SYS). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 5 Dual RS-485 (MODBUS) Software Blocks . . . . . . . . . . . . . . . . . . . . . . . 41 5.1 Varec 453x series Average Temperature Converter (ATC) Interface (AT4530) 43 5.1.1 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 5.1.2 Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 5.2 Saab Data Acquisition Unit (DAU) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 5.2.1 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 5.2.2 Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 5.3 GSI Model 2000 Modbus Interface (GSIMB) . . . . . . . . . . . . . . . . . . . . . . . . . . 51 5.3.1 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 5.3.2 Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 5.4 Varec Multi-Function Transmitter (Modbus) (MBMFT) . . . . . . . . . . . . . . . . . . . 53 5.4.1 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 5.4.2 Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 5.5 Varec Modbus Level Transmitter Interface (MBTX) . . . . . . . . . . . . . . . . . . . . . 59 5.5.1 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 5.5.2 Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 vi Installation and Operations Manual Tank Gate Interface 5.6 Modbus I/O (MFIO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 5.6.1 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 5.6.2 Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 5.7 MTG Tank Gauge Interface (MG5000) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 5.7.1 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 5.7.2 Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 5.8 Modbus Floating Point Register (MFPREG) . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 5.8.1 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 5.8.2 Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 5.9 Modbus Scanner (MSCAN) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 5.9.1 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 5.9.2 Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 5.10 SAAB REX Radar (REX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 5.10.1 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 5.10.2 Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 5.11 Varec 7xxx Radar Tank Gauge (RG7000) . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 5.11.1 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 5.11.2 Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 5.12 Saab Radar Tank Gauge (RTG) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 5.12.1 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 5.12.2 Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 5.13 Varec 6000 Servo Gauge (STG) Interface (SG6000) . . . . . . . . . . . . . . . . . . . 85 5.13.1 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 5.13.2 Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 5.14 Varec 4590 Tank Side Monitor (TSM) Interface (TM4590) . . . . . . . . . . . . . . . 91 5.14.1 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 5.14.2 Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 5.15 Ronan X76CTM (X76CTM). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 5.15.1 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 5.15.2 Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 6 Dual RS-485 (GSI ASCII) Software Blocks . . . . . . . . . . . . . . . . . . . . . . 97 6.1 Gauging Systems Inc. Model 2000 ASCII Tank Trasmitter Interface (GSI) . . . 99 6.1.1 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 6.1.2 Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 6.2 Gauging Systems Inc. ASCII Scanner (GSISCN) . . . . . . . . . . . . . . . . . . . . . . 101 6.2.1 Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 6.2.2 Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 7 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 7.1 General Safety Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 Varec, Inc. vii Contents 7.2 Installation Safety Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 7.3 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 7.3.1 Mounting the Tank Gate Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 7.3.2 Select the Unit Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 7.3.3 Wiring Up Power . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 7.3.4 Grounding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 7.3.5 Installing Communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 8 Using ViewRTU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 8.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 8.2 System Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 8.3 Installing ViewRTU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 8.4 Executing ViewRTU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 8.4.1 ViewRTU window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 8.5 The ViewRTU Menu Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 8.5.1 The File Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 8.5.2 The Point Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 8.5.3 The Config Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 8.5.4 The Communications Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 8.5.5 The Options Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 8.5.6 The Help Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118 8.6 Using ViewRTU . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 8.6.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 8.6.2 Configuring Single Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 8.6.3 To modify a Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 8.6.4 Configuring Multiple Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 8.6.5 Creating and Editing Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 9 Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 9.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 9.2 Troubleshooting the Tank Gate Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 9.2.1 LED Displays under normal conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 9.2.2 LED Displays under Abnormal Conditions . . . . . . . . . . . . . . . . . . . . . . . . 134 9.2.3 Using the Tank Gate Interface Push-buttons . . . . . . . . . . . . . . . . . . . . . . . 134 9.2.4 Performing a Hard Reset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 9.3 Maintenance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 A viii Appendix - Order Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 Installation and Operations Manual 8303 1 Overview Overview The 8300 series Tank Gate Interface acts as a tank gauge interface for data acquisition and host gateway for tank farm, pipeline or refinery applications. Options are available for interfacing to nearly any brand of tank gauge equipment or technologies, making it possible to integrate float and tape transmitters, HTG, servo, magnetostrictive and radar gauges. Each 8300 series Tank Gate Interface unit has a built-in motherboard and specific communications module based on the local field protocol or tank gauging instrumentation requirements. The motherboard contains a serial data link to enable communication to a host PC, PLC, or DCS. Note! Each intelligent module is identified by a 82xx designation that matches the product designation, for example, the 8303 TGI contains a 8203 communications module. Each module contains its own processor for fast and reliable field data scanning. Compatibility of every module also makes configuration of the internal database simple and straightforward. 1.1 Versions The 8300 series Tank Gate Interface is available in a number of versions that can interface to a variety of field devices and intelligent instrumentation via interface modules listed below: 1.2 Varec, Inc. • 8303-2 Dual RS-485 (MODBUS) Communications Tank Gate Interface • 8303-6 Dual RS-485 (GSI ASCII) Communications Interface Module • 8310 Varec Mark/Space (Varec 1800, 1900, 4000) Tank Gate Interface • 8311-1 Current Loop (Whessoe Bus) Tank Gate Interface • 8311-2 Current Loop (GPE) Tank Gate Interface • 8312 Saab (TRL/2) Tank Gate Interface • 8314 Enraf (811, 802/812, 854, 873) Tank Gate Interface • 8315 L&J Tankway (MCG 1000, MCG 1500, MCG 2000) Tank Gate Interface • 8316 LON (Prime Measurement 3500 ATG) Tank Gate Interface • 8317 Dual RS-232 Veeder Root (TLS 350) Tank Gate Interface • Inputs are reported to Host Computer by Exception or Scanned Poll • Built-in Software Function Library • Surge Protection Conforming to ANSI/IEEE C37.90a-1974 • Host Communication via RS-232, RS-485, radio, modem or fiber optic link • Industry Standard Protocol: Modbus • Quick-Disconnect I/O Terminations • Modular Construction for Optimum Expandability • Non-Volatile Database Features 1 Overview 1.3 Tank Gate Interface Applications The 8300 series Tank Gate Interface is ideally suited for Tank Farm, Terminal, Pipeline and Refinery applications. It is an effective solution used in SCADA applications. • 1.4 Specifications 1.4.1 System Design • 16-bit processor with optional intelligent communication modules • Intelligent field device communications • 128K bytes Non-Volatile Database Memory • Serial RS-232 • Visual indication - 4 LEDs on main board indicate power and status 1.4.2 Software Functionality • Tank gauge scanning - Data acquisition of measured values from connected tank gauges/ transmitters • Service & diagnostics* • Gauge diagnostics • Read level, temperature and status data from gauge/transmitter 1.4.3 Host Communication • Host comm. ports - 2 • Comm. type: • COM 0: RS-232C • COM 1: RS-232C or RS485 • Baud Rate - selectable baud rate depending on equipment parameters • Protocol - Modbus™ RTU protocol • Mode - RTU mode, master and slave • Media access - Master/Slave 1.4.4 Modbus Functionality • Modbus™ commands - 3, 4, 5, 6, 15, 16 • Modbus™ mapping - Configurable 1.4.5 Power Supply • 1.4.6 Supply 100...240 Vac, 50/60 Hz Power consumption • 2 Level, temperature, pressure, flow, local indication, and alarms 50 VA max (500 mA) Installation and Operations Manual 8303 Overview 1.4.7 Surge protection • 1.4.8 Gas Discharge Tubes (GDTs) and clamping diodes on all field inputs, power supply inputs and communications channels Operating temperature • 1.4.9 -40...+185 °F (-40...+85 °C) Humidity • 5...95% (non-condensing) 1.4.10 Storage temperature • -40...+212 °F (-40...100 °C) 1.4.11 Mechanical Construction • Dimensions (HxDxW) - 2.5" (64 mm) x 8.6" (220 mm) x 5.2" (133 mm) • Material - Aluminum Powder coated *Gauge/transmitter Dependent Varec, Inc. 3 Overview 4 Tank Gate Interface Installation and Operations Manual 8303 2 Hardware Hardware The Tank Gate Interface consists of an enclosure, motherboard, single tank gauge interface module and connectors. 2.1 Hardware Block Diagram A Tank Gate Interface hardware functional block diagram is shown below. This diagram shows the relationship between major subsystems and components in the Tank Gate Interface. The heart of the Tank Gate Interface is an Intel 80C188EB microprocessor operating at 18.432 MHz. Designed specifically for real-time embedded applications, the µP includes timer/ counters, an interrupt controller, and chip-select circuitry. It also includes 2 serial channels that are designated as COM0 and COM1. 2.2 Motherboard Description The motherboard description is broken into three sections. Each section identifies the location of the components on the motherboard. When necessary, a brief description of the component is provided. These sections are listed below: • Power Supply • Switches and Indicators • Communications Figure 2-1: Varec, Inc. Tank Gate Interface Hardware Components 5 Hardware Tank Gate Interface HARDWARE HANDSHAKING A EARTH B NEUTRAL LINE SURGE GND RESET VFIELD + RS232 COM1 A/TXD B/RXD RS485 COM1 GND RTS CTS TXD COM 0 RXD GND VFIELD=24V +15V +5V GND AUX POWER VFIELD=48V -15V Figure 2-2: The Tank Gate Interface Motherboard Tank Gauge Interface Circuitry NOVRAM 128 K PROM 256 k Serial 1 uP Serial 0 Figure 2-3: 6 COM 0 RS-232 Tank Gate Interface Functional Block Diagram Installation and Operations Manual 8303 Hardware 2.2.1 Power Supply • Unit AC Power terminal block (J2) • Surge Protection terminal block (J4) • Field Power terminal block (J3) • Auxiliary DC Power Output terminal block (J8) • AC Power fuses (500 mA - 250V 5x20 mm) (F1, F2) • Field Voltage Selection Jumper (W3) 2.2.1.1 Unit AC Input Power terminal block (J2) The Unit AC power terminal block is used to provide AC power to the Tank Gate Interface. The power requirements for the Tank Gate Interface are 100-240 VAC, 50/60 Hz. The AC Input Power terminal block is shown in the figure below. J2 EARTH HARDWARE HANDSHAKING A EARTH B NEUTRAL LINE SURGE GND NEUTRAL RESET VFIELD + RS232 COM1 A/TXD B/RXD RS485 COM1 GND LINE RTS CTS TXD COM 0 RXD GND +15V +5V GND AUX POWER VFIELD=48V VFIELD=24V J4 SURGE GND -15V - Figure 2-4: VFIELD + AC Input Terminal Block 2.2.1.2 Surge Protection (Surge Gnd) terminal block (J4) The Surge Gnd terminal block is used to connect the surge protection components (gas tubes, MOVs) to earth ground. Ensure there is a low impedance path (< 1ohm) to earth ground (a ground rod or grounding system). Varec, Inc. 7 Hardware Tank Gate Interface 2.2.1.3 Field Power (VFIELD) terminal block (J3) The Field Power terminal block, referred to as VFIELD, is used to provide power for field instruments. The output is configurable using jumpers (Jumper W3, discussed below). LINE J4 SURGE GND HARDWARE HANDSHAKING A EARTH B NEUTRAL J3 LINE VFIELD + RS232 COM1 A/TXD B/RXD RS485 COM1 GND VFIELD + - SURGE GND RESET RTS CTS TXD COM 0 RXD GND A/TXD AUX POWER VFIELD=48V +15V VFIELD=24V +5V GND -15V B/RXD Figure 2-5: COM1 GND Field Power Terminal Block 2.2.1.4 Auxiliary DC Output Power terminal block (J8) The Auxiliary power terminal block is used when external equipment must be powered from the Tank Gate Interface’s internal power supply. The triple output power supply provides +5, +15 and -15 Volts. These are rated 210 mA, 50 mA, and 5 mA, respectively. The DC Power terminal block is shown below. T CTS TXD A EARTH B RXD NEUTRAL LINE SURGE GND GND RESET VFIELD + RS232 - J7 COM1 A/TXD B/RXD RS485 RTS +15V CTS TXD COM 0 RXD GND VFIELD=24V +15V +5V GND +5V AUX POWER VFIELD=48V -15V GND J8 Figure 2-6: 8 AUX POWER COM1 GND COM 0 HARDWARE HANDSHAKING -15V DC Input Voltage Terminal Block Installation and Operations Manual 8303 Hardware 2.2.1.5 AC Power Fuses (F1,F2) The AC Power Fuses provide protection for the AC input power. The two fuses, F1 and F2, are rated at 500 mA, 250 V. F1 HARDWARE HANDSHAKING A EARTH B NEUTRAL LINE SURGE GND RESET VFIELD + RS232 COM1 A/TXD B/RXD RS485 COM1 GND RTS CTS TXD COM 0 RXD GND +15V +5V GND AUX POWER VFIELD=48V VFIELD=24V -15V F2 Figure 2-7: AC Power Fuse 2.2.1.6 Field Voltage Selection Jumper (W3) The Field Voltage Selection Jumper W3 determines the voltage available at the VFIELD terminals (J3). The Field Voltage can be configured for +24 VDC or +48VDC. At +24VDC, there is 230 mA of field power available. At +48VDC, there is 230 mA of field power available. HARDWARE HANDSHAKING A EARTH B NEUTRAL LINE J7 SURGE GND RESET VFIELD + RS232 COM1 VFIELD=48V A/TXD B/RXD RS485 COM1 GND RTS VFIELD=24V CTS TXD COM 0 RXD GND +15V +5V GND AUX POWER VFIELD=48V VFIELD=24V W3 -15V J8 Figure 2-8: 2.2.2 Selection Jumper W3 Switches and Indicators 2.2.2.1 Reset push-button (SW3) The RESET Switch is used to re-initialize the system hardware by causing it to go to a known starting state. This switch may be pressed at any time; however, it will do the following: Varec, Inc. 9 Hardware Tank Gate Interface • Re initialize System Hardware • Clear Scratch Memory • Verify Database and Re initialize if Invalid • Reset All Timers • Enable Communications HARDWARE HANDSHAKING A EARTH B NEUTRAL LINE SURGE GND RESET VFIELD + RS232 - RESET COM1 A/TXD B/RXD RS485 COM1 GND RTS CTS TXD COM 0 RXD GND VFIELD=24V +15V +5V GND AUX POWER VFIELD=48V SW3 -15V Figure 2-9: Switches SW3 on the Tank Gate Interface Motherboard 2.2.2.2 Hard Reset A special form of Reset is available for occasions when the battery backed-up data base must be re-initialized. This type of reset, the Hard Reset, can be performed before a database is downloaded from a host PC. Caution! The Hard Reset should be used as a last resort if the Tank Gate Interface is not functioning. A Hard reset clears the installed database. For the Hard Reset procedure, refer to the Troubleshooting and Maintenance chapter. 2.2.3 Communications The Communications installation requires connection of the appropriate communication cable to one of two connectors. The available options include RS-232 and RS-485 communications. • COM0 (RS-232) (J7) • COM1 (RS-232 or RS-485) (J5) • COM1 Transmit Control (RS-232) (J6) • COM1 Hardware Handshaking Switch (SW1) • COM1 RS-232/RS-485 Selection Switch (SW2) • COM1 RS-485 Terminating Resistor Jumper (W2) Note 10 COM1 is not available on the 8315 Tank Gate Interface Installation and Operations Manual 8303 Hardware VFIELD + - J5 A/TXD HARDWARE HANDSHAKING A EARTH B B/RXD NEUTRAL LINE VFIELD + RS232 COM1 A/TXD J6 B/RXD RS485 COM1 GND RTS COM1 GND SURGE GND RESET RTS CTS TXD COM 0 RXD CTS GND +15V +5V GND AUX POWER VFIELD=48V VFIELD=24V -15V TXD COM 0 RXD GND J7 +15V D=24V +5V AUX POW D=48V Figure 2-10: COM1 J5 Terminal Block 2.2.3.1 COM0 (J7) COM0 is an RS-232 port for use in diagnostic testing/local programming or communications to a host system. The protocol defaults to Tank Gate Interface Slave at the 9600 baud, 8 data bits, and no parity (for use with ViewRTU or FuelsManager). CTS TXD A EARTH B RXD NEUTRAL LINE SURGE GND GND RESET VFIELD + RS232 - J7 COM1 A/TXD B/RXD RS485 RTS +15V CTS TXD COM 0 RXD GND VFIELD=24V +15V +5V GND +5V AUX POWER VFIELD=48V -15V GND J8 AUX POWER COM1 GND COM 0 HARDWARE HANDSHAKING -15V Figure 2-11: COM0 J7 Terminal Block 2.2.3.2 COM1 (RS-232/RS-485) (J5) Note COM1 is not available on the 8315 Tank Gate Interface RS-232 is one of the two types of high-speed serial communications channels available to interface to Host systems using several different protocols. RS-232 will operate at distances up to 100 feet, while RS-485 allows multidrop communications at distances up to 4000 feet. RS232 can be used for flexibility in configuring other types of communications links. Other variations of RS-232 communications interfaces include radio, modem and fiber optic interfaces. Varec, Inc. 11 Hardware Tank Gate Interface The choice of RS-232 or RS-485 is determined by the COM RS-232/RS-485 Selection Switch SW2. 2.2.3.3 COM1 RS232/RS-485 Selection Switch (SW2) Note COM1 is not available on the 8315 Tank Gate Interface Switch SW2 determines whether RS-232 or RS485 is used. Note that the Hardware Handshaking Switch SW1 affects the operation of COM1. HARDWARE HANDSHAKING A EARTH B NEUTRAL RS232 LINE SURGE GND RESET VFIELD + RS232 COM1 A/TXD B/RXD RS485 COM1 GND RTS COM1 CTS TXD COM 0 RXD SW2 GND +15V +5V GND AUX POWER VFIELD=48V VFIELD=24V RS485 -15V Figure 2-12: COM1 SW2 Switch 2.2.3.4 COM1 Hardware Handshaking Switch (SW1) Note COM1 is not available on the 8315 Tank Gate Interface For RS-232, there are two different settings. One setting is used if hardware handshaking (RTS/ CTS) is required. The other setting eliminates the need for hardware handshaking. Set the Hardware Handshaking Switch to the ‘A’ position to use RTS/CTS when a modem or signal converter is involved and requires RTS/CTS to operate. The RTS and CTS signals will be available on terminal block J6. If the connection is direct using RS-232, jumper RTS to CTS by setting SW1 to the ‘B’ position. HARDWARE HANDSHAKING A EARTH B NEUTRAL HARDWARE HANDSHAKING LINE SURGE GND RESET VFIELD + RS232 COM1 A A/TXD B/RXD RS485 COM1 GND RTS CTS B SW1 TXD COM 0 RXD GND +15V +5V GND AUX POWER VFIELD=48V VFIELD=24V -15V Figure 2-13: COM1 SW1 Switch 12 Installation and Operations Manual 8303 Hardware For RS-485, set the Hardware Handshaking Switch SW1 to the ‘A’ position. Refer to the following table:. Comm. Physical Layer Hardware Handshake SW1 Setting SW2 Setting Notes RS-232 No A UP (towards the RS-232 side) Use with a PC. Signals at terminal block J5 will be RS-232 RS-232 Yes B UP (towards the RS-232 side) Use to communicate to systems that require Request To Send (RTS) in order to transmit (Modems, Radios, etc.) RTS and CTS signals will be available at terminal block J6 RS-485 Table 2-1: Yes A DOWN (towards the RS-485 side) Always SW1 set to the A position when using RS-485.. Tank Gate Interface Communications Cable The layout for the RS-232 cable between the PC and the Tank Gate Interface is shown in the following illustrations. Varec, Inc. 13 Hardware Tank Gate Interface PC TANK GATE 2 TXD COM0 (RS-232) Pin Signal 2 3 RXD 5 GND RXD 3 TXD 5 GND J7 DB9 Female R5485 / R5238 Converter TANK GATE PC A A COM1 (RS485) B B GND GND J6 NOTE! Signals on RS485 / RS232 converter may have different designations. Refer to OFM manual for the converter for more information. PC TANK GATE 2 COM1 without RTS / CTS (RS-232) Pin Signal TXD 3 2 5 3 TXD 5 GND RXD GND RXD J6 DB9 Female DCE TANK GATE 3 TXD 2 RXD COM1 with RTS / CTS (RS-232) Pin Signal 2 5 GND J6 7 RTS RXD 3 TXD 5 GND 7 RTS 8 CTS 8 CTS J7 DB9 Male Figure 2-14: COM1 Cable without RTS/CTS Note 14 COM1 is not available on the 8315 Tank Gate Interface. Installation and Operations Manual 8303 3 8203 Dual RS-485 Communications Interface Module 8203 Dual RS-485 Communications Interface Module This communications interface module is the processing card that mounts on the Tank Gate Interface (TGI) motherboard. The firmware installed on this card determines which protocol is provided. 3.1 Firmware Version Protocol Software Blocks MDTG1_15 Dual RS-485 (MODBUS) See section 5 on page 41 GSTG1_10 Dual RS-485 (GSI ASCII) See section 6 on page 97 Features • Dual high-speed communications channels • Optically isolated • Up to 32 devices per channel • ANSI/IEEE surge protection The 8203 interfaces with the following tank gauge transmitters using either Dual RS-485 (MODBUS) or Dual RS-485 (GSI ASCII) protocol including: • Varec 2900 & 2910 Float & Tape Transmitter (FTT) using Modbus protocol • 4000 Advanced Technology Transmitter (ATT) using Modbus protocol • 4200 Multi-Function Transmitter (MFT)/Hydrostatic Interface Unit using Modbus protocol • 5010 Magnetostrictive Tank Gauge (MTG) using Modbus protocol • GSI 2000 Tank Gauge Transmitters using GSI ASCII protocol Note 3.2 The 8303 Tank Gate Interface uses the 8203 communications module. Description The components of the 8203 communications module are illustrated in the following figure. This section explains how to connect field wiring and how to configure jumper settings. Varec, Inc. • ID DIP Switch (SW1) • LED indicators (D1 – D4) • Field wiring terminal block (J2, J4) • Surge/Shield ground connector (J3) • Network terminating resistor jumpers (W4 & W5) • Firmware 15 8203 Dual RS-485 Communications Interface Module Tank Gate Interface ID DIP Switch (SW1) Firmware LED indicators (D1 – D4) Network terminating resistor jumpers (W4 & W5) Field wiring terminal block (J2, J4) Surge/Shield ground connector (J3) Network terminating resistor jumpers (W4 & W5) Figure 3-1: 3.2.1 Dual RS-485 Tank Gate Interface Module ID DIP Switch (SW1) The dip switch is used for setting the ID number (1-14). The ID is a binary number representing the address of the Tank Gate Interface. 1 2 3 4 CLOSED OPEN Address 1 Shown Binary 8 4 2 1 Binary 8 4 2 1 Switch # 1 2 3 4 Switch # 1 2 3 4 Address 1 o o o c Address 8 c o o o Address 2 o o c o Address 9 c o o c Address 3 o o c c Address 10 c o c o Address 4 o c o o Address 11 c o c c Address 5 o c o c Address 12 c c o o Address 6 o c c o Address 13 c c o c Address 7 o c c c Address 14 c c c o Figure 3-2: 16 ID DIP Switch settings Installation and Operations Manual 8303 8203 Dual RS-485 Communications Interface Module 3.2.2 LED Indicators (D1-D4) The LEDs indicate the status of the 8203 Dual RS-485 Communications Interface Module. • D1: Indicates CPU activity • D2: Indicates communications between the 8303 TGI motherboard and the 8203 Dual RS-485 Communications Interface Module • D3: A transmission is being sent • D4: A response is being received Figure 3-3: LED Indicators Field wiring terminal block (J2,J4) Caution! Connect the ground terminal (J2) to a good earth ground before connecting ANY other wires. Refer to the Surge/Shield Ground Connector (J3) section. The 8203 Dual RS-485 Communications Interface Module has 3 termination points per channel. The following schematic illustrates the terminal channels of the COM channels: W4 DATA DATA SIGNAL COMMON COM Channel A G G W5 SURGE GND DATA DATA COM Channel B Figure 3-4: Note 3.2.3 SIGNAL COMMON COM channels schematic Refer to table at the end of this section. Surge/Shield Ground Connector (J3) Caution! This ground connection is important for system safety. Varec, Inc. • Connect a copper wire (minimum size of 14 AWG) between the ground terminal (J3) and a good earth ground. Perform this step before connecting ANY other wires. • Verify that the resistance in this connection does not exceed 1 ohm. 17 8203 Dual RS-485 Communications Interface Module 3.2.4 Tank Gate Interface Network terminating resistor jumpers (W4 & W5) Verify that the network terminating resistor jumpers (W4 & W5) are installed. 3.3 Hardware Interface 3.3.1 Modbus The following diagram shows how to use the 8203 Dual RS-485 Communications Interface Module with Modbus devices such as the 4100 MFT, 4000 ATT, 2900 FTT, and 2910 FTT. Power Supply VAREC Model 4200 HIU or Model 4100 MFT Common +48 VDC VAREC Model 4000 ATT VAREC Model 2900FTT T82 B- 1 B- 9 B+ 6 B+ 2 B+ 10 C1 5 EIA485+ 3 EIA485- 11 C2 4 EIA485- Earth Gnd 4 EIA485+ 12 B- Terminate with bias resistor 120 ohm on farthest device from the RTU if required. Switch selectable on N2900. 3 2 1 Figure 3-5: Modbus Application The last transmitter on the communication network should be terminated. Refer to the transmitter user manual for more information. 18 Installation and Operations Manual 8303 4 Software Description Software Description The Tank Gate Interface software platform is based on a real-time, multi-tasking operating system. The software consists of I/O scanning functions for data acquisition, a database/ database manager and communication functions for data transfer. Note Figure 4-1: 4.1 COM1 is not available on the 8315 Tank Gate Interface. Software Block Diagram Software Features 4.1.1 Real-Time / Multitasking Executive The operation of the Tank Gate Interface is based on a highly reliable, field-proven real-time multitasking executive. It provides task switching based on real-time events and interrupts, message passing and task priorities. Its capabilities also include timed suspension of tasks, queue handlers and interrupt processing tasks. 4.1.2 Real-Time Clock Integral to the real-time executive is the system’s real-time clock. All timed events of the Tank Gate Interface are coordinated by this clock. In addition to the real-time executive interaction, all field data scanning is coordinated by the real-time clock. 4.1.3 Automatic Fault Recovery The Tank Gate Interface has a watchdog timer that is periodically strobed by the microprocessor. Should the processor suffer a lapse due to hardware or software failure, the watchdog timer will time out and the Tank Gate Interface will then be reset and normal operation will resume. Varec, Inc. 19 Software Description Tank Gate Interface 4.1.4 Communications There are two communications tasks - one for each of the communication channels. COM ports 0 and1 are used to interface to external devices or host systems. Refer to the Hardware Chapter for the location of these ports. Note COM1 is not available on the 8315 Tank Gate Interface. COM0 and COM1 COM 0 and 1 can be configured for communications to Host systems using a variety of protocols. For COM 0 and 1 the communication interfaces include the following: • RS-485 for use in multi-drop configurations or long cable runs (or both) • RS-232 for flexibility in configuring other types of communications links such as radio and fiber optic interfaces • RTS/CTS lines are available for hardware handshaking. 4.1.5 Protocols The Tank Gate Interface is fully compatible with FuelsManager® software. It is also compatible with a variety of other Host systems including through Modbus protocol. • RS-485 for use in multi-drop configurations or long cable runs (or both), with an RS232to-RS485 converter. • RS-232 for flexibility in configuring other types of communications links such as radio and fiber optic interfaces. The default communication settings for the COM ports are as follows: COM Port Protocol Baud Rate Data Bits Parity Stop Bits COM0 RTU Slave or Modbus - Auto-sensing 9600 8 N 0 COM1 Modbus 9600 8 N 0 Note 4.1.6 COM1 is not available on the 8315 Tank Gate Interface. Data Scanning Task The Data Scanning Task is dedicated to the scanning of field input data from tank gauges. The input data is stored in arrays that are subsequently accessed by the Point Executive. 4.1.7 Database Manager The Database Manager is a collection of programs and data. The Database Manager allows the Tank Gate Interface system executive to access data from the database in an organized and program-independent manner. It resides in non-volatile RAM. The Database Manager also contains a Database Dictionary. This dictionary describes how the database is organized and also provides information describing how data should be presented to the operator. After power-up or system reset, a CRC verification of each point in the database is performed. If the CRC does not have a match for the point, then it is disabled and a flag is set indicating that the point is invalid. 20 Installation and Operations Manual 8303 Software Description 4.1.8 System Tasks System tasks include the Calendar Task, which manages Time and Date functions. Other system tasks include utility routines for checksum calculations, diagnostics, start-up and initialization. 4.1.9 Tank Gate Interface Software Blocks The user can configure pre-defined subprograms known as Software Blocks. These software blocks program the Tank Gate Interface to perform various tasks, such as scaling an analog input value, or scanning level, temperature and status information from a tank gauge. Various software blocks are available depending on the communication module. Each Software Block contains all the logic, constants and data to perform a particular function. Every system function of the Tank Gate Interface is accessible via a Software Block. The user only has to add Software Blocks using ViewRTU and then configure a few parameters in order to perform a desired function. 4.2 Database Organization Points are the individual instances of software blocks. Examples include Whessoe Varec 1900 (MSTX) and SCALER points. In both cases the user configures the Config parameters and is provided real time data through the Dynamic parameters. 4.2.1 Point Format Data parameters in the Tank Gate Interface are addressed using a “Type.Number.Parameter” format. For example, “MSTX.02.Level” refers to MSTX Tank Gauge #2’s IEEE floating point level. This format and corresponding fields are described below. The TYPE field represents the Point Type. There are many different point Types in the Tank Gate Interface, referred to generically as Tank Gate Interface Software Blocks. Some of the point types include the COM (Communications), SYS (System), MSTX (MSTX Tank Gauge) point types. Each Type performs a different function. The NUMBER field represents the instance of the point type. For example, the AI point may have up to 32 instances, which are addressed using the NUMBER field. Each instance shares the same data structure definition, yet each point has unique data values. In the case of the AI software block, each point manages a single input channel. The PARAMETER field represents the items in the data structure of the point type. Examples of parameters include Value, Status, PntRef and RawValue. This field is explained in greater detail in the following section. 4.2.2 Parameter Description Each parameter is defined by its Parameter Class and Data Type. The following subsections describe Parameter Classes, Parameter Data Formats and Common Parameters. Parameter Classes Each parameter, such as Value or Channel, is classified as one of the following classes: Varec, Inc. Parameter Class Description Config Configuration parameters such as channel numbers, tags, descriptions, ranges, operating modes, point references, constants for formulas and timing information. Dynamic Real-time data such as the value or the status. Dynamic data is calculated or measured during point execution scans, which occur every 250 msec. 21 Software Description Tank Gate Interface Parameter Class Description Command Output command data Constant Weights & Measures parameter Scratch Temporary data that is typically hidden from the user System System data (should not be changed by the user) The user-related parameters are the Config, Command and Dynamic parameters. These parameters are available in the Edit Point window of ViewRTU. The remaining parameters are internal to the Software Block. Note ViewRTU inserts default values for the Config parameters when the point is first defined. It is usually only necessary to fill in a few configuration parameters, such as channel numbers, to configure references and to configure links to other points. Parameter Data Formats Data is stored in the Tank Gate Interface as one of the following formats: Data Format Description Byte 8-bit value (-127 to 128) Unsigned Byte 8-bit value (0 to 255) Coded Unsigned Integer representing a digital state such as ‘On,’ ‘Off,’ ‘Open,’ ‘Closed,’ etc. Integer 16-bit value (-32766 to 32767) Unsigned Integer 16-bit value (0 to 65535) IEEE floating point 32-bit value with mantissa and exponent Time Unsigned Long Integer representing the number of milliseconds since Jan. 1, 1970. Tag ASCII character strings, variable in length. Used for Tag and Description parameters Point Reference Reference to a point parameter. Format is TYPE.NUMBER.PARAM where TYPE is AI, DI, DO, etc. NUMBER is point number, 0-255 PARAM is the parameter of interest, such as Value or Command. example: AI.00.Value 22 Unsigned Long Integer 32-bit value (0 to 4,294,967,295) Pointer 32-bit value representing a pointer to another parameter or memory location. Long Integer 32-bit value Integer (Hex format) Integer in Hex (0x0000 to 0xFFFF) Time HH:MM:SS Unsigned Long Integer representing the number of milliseconds since midnight. Time MM/DD/YY Unsigned Long Integer representing the number of milliseconds since Jan. 1, 1970. Unsigned Long Integer (Hex format) Unsigned Long Integer in Hex (0x00000000 to 0xFFFFFFFF) Installation and Operations Manual 8303 Software Description Common Parameters The following parameters are found in almost all point types. These parameters are described below: PntCheckSum Parameter The PntCheckSum is a CRC-16 checksum of the Configuration Parameters of a point. Most points have the PntCheckSum parameter; a few like the CLK (Clock) Point, DIAG (Diagnostics) Point, and the register points (BREG, IREG, and DREG) do not. Any time a Configuration Parameter is changed, the Tank Gate Interface re-calculates the checksum. The PntCheckSum is used at initialization to validate each point in the database. PntStatus Parameter The PntStatus parameter gives information about point execution. Refer to the information provided for each Software Block about the particular use of the PntStatus parameter. Elapse Parameter The Elapse parameter usually indicates the time of the last point execution. It is used as the basis for automatic Change of State notifications. Value Parameter The Value parameter indicates the real-time value of the point. In the case of DI points, the Value represents a Coded value (i.e., On, Off, Opened, Closed, etc.) AI points represent the Value in an IEEE floating point format. In most cases, the Value parameter is one of the most important parameters for a point. Level & Temp Parameters The Level & Temp parameters indicate the real-time tank level and temperature of the tank gauge point. There are many Software Blocks available in the Tank Gate Interface associated with tank gauge communications, including Software Blocks for every major tank gauge manufacturer. 4.3 Gathering Point Data For Host to Tank Gate Interface communications, there are two primary methods for gathering point data. These methods are listed below: 4.3.1 Standard Request-Response Format The Host issues scan requests, and the Tank Gate Interface responds with the data. The Scan method has the advantage of being deterministic, the response time to a particular request will always be the same. This method has the limitation that if there are many points defined in the Tank Gate Interface, it often takes several requests to obtain all of the data. Most of the time data has not changed since the last request, so this results in inefficiencies in update times. This situation is often the case in systems where there are many digital points that do not change frequently. 4.3.2 Change of State Format The Host issues scan requests based on a Change of State condition. Some systems refer to this as Event Mode. The Tank Gate Interface keeps track of the items that have changed since the last Host request. The Host can issue a single request of ‘tell me what has changed since my last request.’ The Tank Gate Interface will respond with the results, which include addressing Varec, Inc. 23 Software Description Tank Gate Interface information about the data. In a typical system, this results in a significant improvement in the throughput rate for data. When FuelsManager is the Host system, the Change of State method has the advantage of being very efficient. Only the data that has changed is reported. Change of State is not available when using Modbus. 4.3.3 Change of State-Related Parameters In order to support the Change of State method, many points have additional configuration parameters included. Parameter Description Value One of the parameters which will be returned to a Change of State request by the Host. Most Software Blocks are designed so that the Value parameter is the main parameter of interest. Report Is used for Change of State processing only Causes automatic notification to the Host (in response to a Change of State Request) when the Value Changes State. Valid values are High, Low or No. Report = No disables notification. Points with Report = High have higher priority than points with Report = Low. Maxtime Is used for Change of State processing only Specifies the maximum time (in secs) between automatic Change of State data being sent to the Host in response to a Change of State Request. When the Maxtime period expires, the Value to is forced appear as if it has changed even if is has not, ensuring that data is sent to the host periodically. Setting Maxtime to 0 disables this option. The maximum is 255 seconds. Deadband LevelDeadband Affects the Change of State processing. It allows users to filter out insignificant changes, freeing the communications link to send other data. TempDeadban d Note Not all Host protocols support the Change of State method. The RTU Slave protocol used with FuelsManager supports either method. Note The Modbus protocol is Scan-based. Therefore, the Report and Maxtime parameters have no meaning. 4.3.4 Modbus Communications Some versions of the Tank Gate Interface are capable of communicating with Modbus compatible devices with both Modbus Masters and Slave devices. The Tank Gate Interface is flexible, allowing communications with devices that strictly comply with the Modicon Modbus protocol, as well as devices with more advanced Modbus implementations such as Honeywell’s APM-SIO. The Modbus Slave protocol handler responds to read and write requests from a Modbus master system. A detailed description of the Modbus Slave protocol handlers follows. Modbus Slave The Modbus Slave protocol handler is enabled by setting the Protocol parameter of a COM point to Modbus Slave. COM 0 of the Tank Gate Interface is auto sensing. If a Modbus Master requests data from the Tank Gate Interface, the Tank Gate Interface will automatically detect that Modbus is being used and invoke the Modbus Slave protocol handler. The Modbus Slave protocol handler responds to requests from Modbus masters. A MODGW point is automatically created to provide 24 Installation and Operations Manual 8303 Software Description user access to the operation of the protocol handler. The MODGW point also provides dynamic information about the communications requests from the Modbus master. The Modbus Slave protocol handler is flexible, allowing the user to set options for handling several aspects of Modbus communications. The Modbus Slave uses the GWBLK Gateway Block as a lookup table for data addresses. The Gateway Block allows the user to specify data address and point reference combinations. This allows the Tank Gate Interface to be used with an existing system that is already configured. The user defines a GWBLK point and specifies which parameter in the Tank Gate Interface will be used for a particular address. When a request from a master is received, the Modbus Slave protocol handler will first search for any GWBLK points and determine if the data address of the request is specified in one of the GWBLK points. If the data address is contained in a GWBLK point, then the corresponding point reference is used to provide the data for the reply to the master. COM 0 will automatically sense whether the host system is ViewRTU or a Modbus Master. The communications parameters for COM 0 are 9600 baud, 8 data bits and No Parity. When switching between ViewRTU and Modbus communications, it is necessary to wait 60 seconds for the current protocol to time-out. The Tank Gate Interface will go back to the auto sensing mode and wait for a request. When a request is received, the Tank Gate Interface will determine if the request is from ViewRTU or a Modbus Master. If the Tank Gate Interface has problems switching, press the Reset button and this will force the Tank Gate Interface back into the auto sensing mode. Note COM 1 (if available) is always a Modbus Slave. The communications parameters for COM 1 are 9600 baud, 8 data bits and No Parity. COM1 is not available on the 8315 Tank Gate Interface Note The Tank Gate Interface uses the ID switch in determining to which address on the communications bus to respond. Tank Gate Interface responds to the following Function Codes: Function Code Description Comments 3 Read Output Register FC 3 and FC 4 are treated the same. Use either FC 3 or FC 4 to read data from the Tank Gate Interface 4 Read Input Register 5 Force Single Output Status 6 Preset Single Register 15 Force Multiple Outputs 16 Preset Multiple Registers FC 4 and FC 6 are treated the same. Use either FC 5 or FC 6 to write data to the Tank Gate Interface FC 15 and FC 16 are treated the same. Use either FC 15 or FC 16 to write multiple registers to the Tank Gate Interface There are two methods for data addressing within the Tank Gate Interface Varec, Inc. • The Tank Gate Interface has a fixed Modbus Map of selected parameters • Gateway Block (GWBLK) software blocks can be configured to set the data address 25 Software Description Tank Gate Interface 4.3.5 Fixed Modbus Map For each version of the Tank Gate Interface, there is a fixed map of data registers. A partial example is shown below: Address Number Parameter Data Type 5000 MSTX 0 Command CODED 5001 MSTX 0 Level REAL 5003 MSTX 0 Temp REAL 5005 MSTX 0 Value REAL 5007 MSTX 0 Status HEX 5008 MSTX 0 PntStatus IHEX 5009 MSTX 0 Elapse TIME 5011 MSTX 1 Command CODED 5012 MSTX 1 Level REAL 5014 MSTX 1 Temp REAL 5016 MSTX 1 Value REAL 5018 MSTX 1 Status HEX 5019 MSTX 1 PntStatus IHEX 5020 MSTX 1 Elapse TIME Table 4-1: 4.3.6 Type Fixed map of data registers GWBLK method The GWBLK is the preferred means to address data in the Tank Gate Interface. The GWBLK has a great deal of flexibility. Data can be scaled, or grouped using the GWBLK. The Gateway Block (GWBLK) allows the user to specify data address and point reference combinations. This allows the Tank Gate Interface to be used with an existing system that is already configured. The Tank Gate Interface can be tailored to meet the needs of the Host. In some cases, the Host system may have some constraints in the use of its Modbus scanner that make it necessary to use a GWBLK. In this mode, the user defines a GWBLK point and specifies which database parameter will correspond to a particular data address. When a request from a master is received, the Modbus Slave protocol handler will first search for any GWBLK points and determine if the data address of the request is specified in one of the GWBLK points. If the data address is contained in a GWBLK point, then the corresponding point reference is used to provide the data for the reply to the master. If the data address is not in any GWBLK point, then data will be read using the prevailing Address Mode. The Gateway Block (GWBLK) allows the user to specify data address and point reference combinations. The GWBLK acts as a lookup table for data items in the Tank Gate Interface. The user defines a GWBLK point and specifies which database parameter will correspond to a particular data address. When a request from a master is received, the Modbus Slave protocol handler will search for any GWBLK points and determine if the data address of the request is specified in one of the GWBLK points. If the data address is contained in a GWBLK point, then the corresponding point reference is used to provide the data for the reply to the master. The procedure for using the GWBLK is given below: 26 • Add a GWBLK point. Depending upon the addressing requirements of the host system, it may be necessary to add additional GWBLKs. • Configure the GWBLK by setting the Address, PntRef and Size parameters to the parameters of interest in the Tank Gate Interface. Refer to the following examples: Installation and Operations Manual 8303 Varec, Inc. Software Description Figure 4-2: Adding a GWBLK point in View RTU Figure 4-3: Configure the GWBLK in View RTU 27 Software Description Tank Gate Interface In this example, the Modbus register map is configured according to the following table: Data Address Parameter Comments 100-101 MSTX.00.Level Level is in IEEE Floating point format. 102-103 MSTX.01.Level 104-105 MSTX.02.Level . . . . . . 138-139 MSTX.19.Level 200-201 MSTX.00.Temp 202-203 MSTX.01.Temp 204-205 MSTX.02.Temp . . . . . . 238-239 MSTX.19.Temp 300 MSTX.00.PntStatus 301 MSTX.01.PntStatus 302 MSTX.02.PntStatus . . . . . . .319 .MSTX.19.PntStatus Table 4-2: 28 Temperature is in IEEE Floating Point Format. PntStatus is in Integer format. Example Modbus register map Installation and Operations Manual 8303 Software Description 4.4 Common Software Blocks This section describes Software Blocks included with the base unit of the 8303. 4.4.1 Clock (CLK) The Clock point provides access to the System Clock. Standard time format is in the form of MM/DD/YY HH:MM:SS. Parameters The database parameters used by the CLK point are listed and described below: Configuration Parameters TZ Function Time Zone string Dynamic Parameters Function SysTime System Time in the form MM/DD/YY HH:MM:SS. Writing to this value will change the system time SysTicks Time if “ticks” format. Ticks are incremented every 10 msec, with the initial value of 0 equal to Jan. 1, 1970 at 00:00:00. timezone Time zone relative to GMT. The timezone is entered in seconds. Example: Eastern Time Zone = 18000; Pacific = 28800 daylight 4.4.2 Daylight Saving Flag Communications (COM) The Communications point reports the status and controls the operation of the communications interfaces. COM points are automatically created by the system at initialization. Parameters The database parameters used by the COM point are listed and described below: Configuration Parameters Protocol Function Protocol handler assigned to the ComPort. Valid values are: Disabled RTU Slave Modbus Slave TSU Slave The defaults are: COM 0: RTU Slave - 9600 Baud COM 1: Modbus Slave- 9600 Baud Mode ComPort Varec, Inc. The Mode parameter is used in conjunction with the Protocol. Different protocols will use the Mode in different ways, depending on the needs of the protocol. Communications Port number. Valid values are 0-3. You should never modify the ComPort parameter. 29 Software Description Tank Gate Interface Configuration Parameters BaudRate Function Baud Rate for communications to either the Host or Slave system. Valid values are: 1200, 2400, 2400, 9600, 19200. Changing the BaudRate parameter will immediately change the configuration of the ComPort. The default is 9600. ComParams Defines the number of data bits and the parity used by the com port. Examples include: 8O - 8 Data Bits Odd Parity 8E - 8 Data Bits, Even Parity 8N - 8 Data Bits, No Parity 7O - 7 Data Bits, Odd Parity 7E - 7 Data Bits, Even Parity 7N - 7 Data Bits, No Parity TI - TIWAY The default is ‘8N’. TimeOut Time in seconds that indicates a time-out of communications. If no Host or Slave communications is received for the length of time specified by the TimeOut, the CommStatus parameter will indicate Off Line and communications failure processing will take place. ErrCheck Error checking used by the protocol. Valid values are: LRC - Longitudinal Redundancy Check CRC - Cyclical Redundancy Check RespDelay Time in milliseconds for which the 8303 TGI will delay a response to the Host. The default is 50 msec. SynchMax The SynchMax is used by some slave protocols for autosynchronization of the BaudRate. The SynchMax is used to determine if the BaudRate is correct. If the SynchMax is zero, then no synchronization is attempted. DirectPort The DirectPort is used then the Protocol is set to Direct. Dynamic Parameters CommStatus State Command Status CommErrors NumTrans Elapse PntCheckSum Function Coded variable indicating the On-line/Offline status of the COM point. Current state of the message being sent/received. Current command being processed. Status if the last message. The number of communication errors. The number of transactions. Time of the last Change of State. CRC-16 Checksum of point's static Configuration Parameters. Application The COM point controls the operation of Host and Slave communications. The Baud Rate, Communications Parameters and Protocol may be changed by assigning values to the appropriate parameter. Each Com port is independent of the other and completely flexible in its use. For example, you may configure the system to communicate with a single host redundantly using the same protocol. Alternatively, the 8300 series Tank Gate Interface can communicate to different hosts using different protocols, allowing the 8300 series Tank Gate Interface to act as 30 Installation and Operations Manual 8303 Software Description a bridge. Other options include assigning one COM point to communicate with a Slave device while communicating to a Host system on the other. 4.4.3 Floating Point Register (FPREG) The Floating Register point provides four bytes of storage in IEEE floating point format. It is often used for inter-point communications where no other means is provided. Parameters The database parameters used by the FPREG point are listed and described below: Configuration Parameters Tag Function Point tag Dynamic Parameters Function Value1 through Value50 Real (4 bytes) value PntStatus Integer HEX value indicating status of point. Values are: 0x0001: Gauge Not Responding. The first time the gauge does not respond, the 0x8000 bit is set. On the second try, the 0x01 bit is set. 0x0002: Data Invalid (General Data Error) 0x0004: Bad Level 0x0008: Temp OverRange 0x0010: Temp UnderRange 0x0020: A/D Error 0x0040: Filtering Level 0x0800: Filtering Temp 4.4.4 Elapse Time of the last Change of State. PntCheckSum CRC-16 Checksum for point’s static Configuration Parameters. Emulator (EMU) The Emulator point allows the to emulate a Whessoe-Varec Model 6820 Tank Scanning Unit (TSU). This point provides access for level, temperature data, and gauge status information from any type of tank gauge interface supported by the 8203 Dual RS-485 Communications Interface Module. Parameters The database parameters used by the EMU point are listed and described below: Configuration Parameters Tag Varec, Inc. Function The point description can contain 30 bytes of data and can include any printable ASCII character. Descriptions can be used as information relevant to any aspect of the point, such as its use, location, operating information, etc. The default description is set to “EMU.00”. 31 Software Description Tank Gate Interface Configuration Parameters LevelUnits Function Specifies the engineering units for the level data. F: feet, m: Millimeters M: Meters I: Inches P: ft-in-16ths The LevelUnits need to match the units specified during the gauge setup. TempUnits Specifies the engineering units for the temperature data. TempUnitsSpecifies the engineering units for the temperature data. F: Fahrenheit C: Celsius The TempUnits needs to match the units specified during the gauge setup. DensityUnits Specifies the engineering units for the density data. DensityUnitsSpecifies the engineering units for the density data. K: kg/m3 A: API L=lbs/cu ft The DensityUnits needs to match the units specified during the gauge setup. Offset Specifies the offset to the first address. PntRef1 - 20 Input point reference for the EMU point to monitor. The PntRef parameter is set to the Level parameter for the tank gauge point. The temperature will be read at the same time as the level. The EMU point interfaces tank gauge interface points: WV1900 - Whessoe-Varec Model 1900 Dynamic Parameters Function PntStatus Byte value indicating status of point Values are: Dynamic ParametersFunction PntStatusByte value indicating status of point Values are: 0: No error 15: Invalid Type for PntRef 16 Invalid Number for PntRef 17 Invalid Param for PntRef 19: PntRef point does not exist 25: PntRef is not defined PntCheckSum CRC-16 Checksum for point's static Configuration parameters. Application The Emulator point (EMU) provides a communication interface between older tank gauging system and point blocks within the 8203 Dual RS-485 Communications Interface Module . Currently, the 8203 Dual RS-485 Communications Interface Module can emulate a Whessoe Varec Model 6810 Tank Scanning Unit (TSU). The EMU point associates a tank gauge point with an address to by used by TankView. EMU.0 provides point references for TankView System Addresses 1-50. EMU.1 is associated with System Addresses 51-100. A EMUGW gateway point is automatically created when the protocol for a COM point is set to TSU Slave. 32 Installation and Operations Manual 8303 Software Description 4.4.5 EMU Gateway (EMUGW) The EMU Gateway point is used to manage scanning functions for the EMU point. Statistics are maintained for the communications between the Series 8130 and the tank gauging software (TankView or System IV). Special firmware is required on the 8203 Dual RS-485 Communications Interface Module to support the emulation functions. Parameters The database parameters used by the EMUGW point are listed and described below: Configuration Parameters Protocol Function Protocol to emulate. Valid values are: TSU Slave ID Address to respond to Mode Operational Mode BaudRate Baud Rate used to communicate with TankView ComParams Defines the number of data bits and the parity used by the com port. Examples include: ID: Address to respond to Mode: Operational Mode BaudRate: Baud Rate used to communicate with TankView ComParamsDefines the number of data bits and the parity used by the com port. Examples include: 8O - 8 Data Bits Odd Parity 8E - 8 Data Bits, Even Parity 8N - 8 Data Bits, No Parity 7O - 7 Data Bits, Odd Parity 7E - 7 Data Bits, Even Parity 7N - 7 Data Bits, No Parity The default is ‘8N’. Varec, Inc. LevelConvert Determines the units in which the level data will be displayed. F: feet, M: Millimeters. If no value is specified, no conversion will be performed. TempConvert Determines the units in which the temperature data will be displayed. F: Fahrenheit, C: Celsius. If no value is specified, no conversion will be performed. DensityConvert Determines the units in which the density data will be displayed. A: API, L: lbs/cu ft, K: kgs/m3. If no value is specified, no conversion will be performed. Dynamic Parameters Function Message Hex representation of the request sent by the host Command Current Command Addr Displays the tank number of the currently selected tank. LevelRef The reference point for level and temperature data for the tank currently requested by TankView Flags Hex value representing the operational status NumRequests Number of requests from TankView or Entis NumComErrors Number of errors 33 Software Description Tank Gate Interface Dynamic Parameters Function Elaspe Time of last request PntCheckSum CRC-16 Checksum for point’s static Configuration Parameters. Application The EMUGW point is automatically created when the TankView (TSU Slave) protocol is initiated. In order to use the TSU Slave protocol, set the Protocol parameter of the COM point to TSU Slave. At that time, an EMUGW and an EMU point will be created to provide a user interface for configuration and control of communications with TankView or System IV. The baud rate and data link parameters are set in the COM point as well. The default is 9600, 8 data bits, No parity. The EMUGW point keeps track of the number of requests and number of errors associated with the EMU Slave protocol. The current tank number (ID) and the point associated with the tank number (LevelRef) are updated as requests from TankView are processed. The PntRefs correlate to the SYS ADR parameter in TankView or IDs in System IV. 4.4.6 Gateway Block (GWBLK) The Gateway Block point is used for compatibility with Modbus Master devices. Rather, you configure a GWBLK to function as a look-up table. The GWBLK point lets you specify which point references will respond to data addresses in the request from a Host. The GWBLK point contains a cross-reference table for database parameters and data addresses. Parameters The database parameters used by the GWBLK point are listed and described below: Configuration Parameters Tag Function A Tag can contain 15 bytes of data and can include any printable ASCII character. Tags can be used to identify points indicating the use of the point such as “Modbus Slave” or “Register Value1.” The default tag is set to “GWBLK.00”. Protocol Protocol that the GWBLK point is used with. Valid values are: Modbus Slave ComPort Bit mask to enable address referencing. If a bit corresponding to the com port, then address referencing is enabled for the channel. The default is 0xFF (all COM ports). DataMode Integer HEX value that controls the data returned to a Modbus Host 0: Use parameter values 0x01: Convert to Integer 0x02: Return 0xFF if the data is invalid. 0x04: Convert to Integer using only the Scale If the DataMode is 0x01, the PntRef data will be converted to an integer using the Offset, Scale, ValueMin and ValueMax. If the DataMode is 0x04, the Scale parameter is used to convert to an integer. 34 RegSet Register Set size Offset Input range Offset used for scaling the output to an integer value when DataMode=1. Scale Input range Scale used for scaling the output to an integer value when DataMode=1. Installation and Operations Manual 8303 Software Description Configuration Parameters Function ValueMin Output range Offset used for scaling the output to an integer value when DataMode=1. ValueMax Output range Scale used for scaling the output to an integer value when DataMode=1. CommFailValue Addr1-10 PntRef1-10 Size1-10 Filter1-10 Value to set all of the output registers to when there is a communications or other failure. The CommFailValue works in conjunction with the Filter values. If the PntStatus of the PntRef has bits set that match the Filter, the reference value is declared invalid and the output value will be set to the CommFailValue. This mode is overridden by DataMode = 0x02. Addr1 is the Data Address and PntRef1 is the corresponding database parameter that will be used for a response. The default Size is 1. See the discussion below for more detail on the Size parameter. The Filter is used to determine if the data is valid. The PntStatus of the point specified by the PntRef is read and if there are bits set that match the Filter, the source data is considered invalid. The output registers will be set to the value determined by the CommFailValue. Dynamic Parameters PntStatus Function Byte value indicating status of point Values are: 0: No error pntCheckSum CRC-16 Checksum of point's static Configuration Parameters Application The GWBLK point is a look-up table used by the Modbus Slave protocol handler. Up to sixteen address-point reference pairs may be used per GWBLK point. Multiple GWBLK points may be used if necessary. The Addr parameter specifies the data address. The corresponding PntRef parameter specifies the database parameter for the request. The Gateway Block point allows you to use the 8300 series Tank Gate Interface easily in retrofit applications. It is not necessary to re-configure an existing HMI or Host system. You can configure the 8300 series Tank Gate Interface to match the addresses used in the Host system. When the Modbus Slave protocol handler receives a request, it searches the GWBLK points to determine if any of the Addr parameters match the request. If a match is found, the data referenced by the PntRef parameter will be used for the response. There are three data modes: DataMode=0, which returns the data in the default format, and DataMode=1, which returns the data in an integer format. DataMode=1 will scale IEEE floating point data to an integer value, using the Offset, Scale, ValueMin and ValueMax parameters. If DataMode = 4, the data will be scaled to an integer by multiplying the data value times the Scale parameter. The DataMode can also control if the data is changed to 0xFFFF if the data is invalid. The Filter parameter is compared to the PntStatus of the PntRef parameter. If bits in the PntStatus match bits in the Filter, the data is considered invalid and the a read from a modbus host will result in the data being set to 0xFFFF. When Block Read or Write requests are received, then the way in which the Modbus Slave protocol handler responds is determined by the Size parameter. Size Parameter A range of addresses can be specified by setting the Size parameter. This sets the indexing mode to Number Indexing, which means that Block Read/Write requests from the Hosts are handled by stepping through the points number by number. For example, if Addr1 is 100, and PntRef1 is MSTX.00.RawValue, then a Block Read to address 100 with a length of 8 will return Varec, Inc. 35 Software Description Tank Gate Interface the values, MSTX.00.RawValue, MSTX.01.RawValue, ... MSTX.07.RawValue. Setting the Size to 1 does not limit the read to 1 parameter, rather it indicates that block operations will be processed by stepping through points by incrementing the number, starting with parameter specified by the PntRef. 4.4.7 Integer Register (IREG) The Integer Register point provides two bytes of storage. It is often used for interpoint communications where no other means is provided. Parameters The database parameters used by the IREG point are listed and described below: Configuration Parameters Tag Function A Tag can contain 15 bytes of data and can include any printable ASCII character. Tags can be used to identify points indicating the use of the point. Configuration Parameters Value 4.4.8 Function Integer (2 bytes) value Modbus Gateway (MODGW) The Modbus Gateway provides dynamic and statistical information for the communications between the 8300 series Tank Gate Interface and the Modbus masters. Parameters The database parameters used by the MODGW point are listed and described below: Configuration Parameters Function ID Slave Address that the Modbus Slave protocol handler will respond to. The default is to match the Unit Address of the 8300 series Tank Gate Interface. Mode Operational Mode. The Mode is a hex value, with individual bits controlling various aspects of the operation of the Modbus Slave protocol handler. The bits have the following meanings: 0x01 – Set Param Indexing mode 0x02 - Integer Swap mode 0x04 – Swap CRC bytes 0x08 - ASCII mode 0x20 – Wonderware Mode 0x80 - Ignore any trailing nulls in the request The default is 0. BaudRate 36 Baud Rate for communications to the Host system. Valid values are: 1200, 2400, 2400, 9600 and 19200. Changing the BaudRate parameter will immediately change the configuration of the ComPort. Installation and Operations Manual 8303 Software Description Configuration Parameters Function ComParams Defines the number of data bits and the parity used by the com port. Valid values include: 8N - 8 data bits, No parity 8O - 8 data bits, Odd parity 8E - 8 data bits, Even parity 7O - 7 data bits, Odd parity 7E - 7 data bits, Even parity The default is ‘8N’. DetectTime Modbus RTU Mode character timer (in 1/100s of a second). Dynamic Parameters Message Command Function Current request message, displayed in hex format. Current command. Values include: 1 - Read Output Status 2 - Read Input Status 3 - Read Output Registers 4 - Read Input Registers 5 - Force Single Coil 6 - Preset Single Register 15 - Force Multiple Coils 16 - Preset Multiple Registers Addr Elapse PntCheckSum Data Address for current request. Time of the last request from the master CRC-16 Checksum of point's static Configuration Parameters Application The MODGW point provides status information for the communications with any Modbus masters used with the 8300 series Tank Gate Interface. On the 8300 series Tank Gate Interface Motherboard, the MODGW point is created automatically whenever the Modbus Slave protocol is defined for a COM point. The point number created will correspond to the ComPort such that MODGW.1 is created for COM 1. Use the Upload command from the Config Menu to retrieve the data from the MODGW point or any other points created automatically by the RTU. The MODGW point provides information about the current command and data address requested by the Modbus master system. The MODGW provides assurance that requests are being received and processed. 4.4.9 Scaler Point (SCALER) The Generic Scaling point allows you to perform math functions in the 8300 series Tank Gate Interface. The SCALER point monitors one or more database reference values and performs an equation in the form: Value = Ax + By + Cz + K Varec, Inc. Note A, B, C & K are user-entered constants. Note x, y & z are inputs from other database points. 37 Software Description Tank Gate Interface Parameters The database parameters used by the SCALER point are listed and described below: Configuration Parameters Tag PntRef1 PntRef2 PntRef3 Function A Tag can contain 15 bytes of data and can include any printable ASCII character. Tags can be used to identify points indicating the use of the point such as “Eng Converter” . The default tag is set to “SCALER.00”. The PntRef parameters determine the input source for the SCALER point to monitor. Up to three references may be specified. RefValue1 is the X term, PntRef2 is the Y term, and PntRef3 is the Z term. If a reference is not specified, then it is not used in the equation. A Constant that is multiplied with RefValue1 B Constant that is multiplied with RefValue2 C Constant that is multiplied with RefValue3 K Constant K Deadband Change of State deadband Report Causes automatic notification to the Host (in response to a Change of State Request) when the Value changes State. Parameter value can be High, Low or No. Report=No disables notification. Points with Report = High will be sent before points with Report = Low. The default is No. Maxtime Specifies the maximum time (in secs) between automatic Change of State responses being sent to the Host. Report must be set to either Low or High for the Value parameter to be sent in response to a Change of State Request. A value of 0 disables this option. Non-zero values cause responses to be sent although the value may have not changed since the last message. The default is 60. Dynamic Parameters Function Value Output value for the SCALER point. Value = Ax + By + Cz + K. x corresponds the RefValue1, y is RefValue2, and z is RefValue3. RefValue1 RefValue2 RefValue3 Value1 PntStatus RefValue1 - 3 are the values of the PntRef1 - 3 parameter references. The references can be to any point that produces a floating point value. Value parameter converted to Integer format Byte value indicating status of point Values are: 0: No error 15: Invalid Type for PntRef 16 Invalid Number for PntRef 17 Invalid Param for PntRef 19: PntRef point does not exist 25: PntRef is not defined Elapse PntCheckSum Time the SCALER point last executed. CRC-16 Checksum of point's static Configuration Parameters Application The SCALER point allows you to perform simple math functions such as conversion of units. The SCALER point takes the value from user-specified database references, multiplies each by a 38 Installation and Operations Manual 8303 Software Description constant and adds the three product terms. A constant K may also be factored in. The SCALER point works in conjunction with parameters that are in floating point format. 4.4.10 System Information (SYS) The System Information Point lists the hardware and software specifications of the system. Other information includes the hardware version and any connected devices. Parameters The database parameters used by the SYS point are listed and described below: Configuration Parameters RTUTag Function RTUTag can contain 15 bytes of data and can include any printable ASCII character. DBFile The database file name. DBFile is the name of the RCF database configuration file DBVer The database version. PntEnable Disable/Enable execution of points. Default is Enable. Dynamic Parameters UnitAddr The Unit Address (SW1) for the 8300 series Tank Gate Interface. DBPnts The number of database points defined. DBSize The size of the database in bytes. DBChangeTime The time of last database modification. SysVer The firmware version. SysCheckSum The system checksum. HardVer The PCB hardware version. PSDVer The programmable logic version. PntCheckSum Varec, Inc. Function CRC-16 Checksum for point's static Configuration Parameters. 39 Software Description 40 Tank Gate Interface Installation and Operations Manual 8303 5 Dual RS-485 (MODBUS) Software Blocks Dual RS-485 (MODBUS) Software Blocks This chapter describes the Software Blocks that are included in the 8303 Tank Gate Interface (Dual RS-485), excluding those common to all the 8300 TGI software versions. The Software Blocks are listed in alphabetical order by acronym. GSI ACII Software Blocks are described in section 6 on page 97. Common Software Blocks are described in section 4.4 on page 29. Varec, Inc. 41 Dual RS-485 (MODBUS) Software Blocks 42 Tank Gate Interface Installation and Operations Manual 8303 5.1 Varec 453x series Average Temperature Converter (ATC) Interface (AT4530) The AT4530 point provides an interface to Varec 453x series Average Temperature Converter (ATC) temperature transmitter. This point provides average temperature and individual temperature element data. Other information, such as point and transmitter status, is also available in this Software Block. The AT4530 point does not communicate directly to Prothermo devices. All communication must be made via a Varec 6000 Servo Gauge (STG) or a 4590 Tank Side Monitor. 5.1.1 Parameters The database parameters used by the AT4530 point are listed and described below: Config Parameters Function WMSeal Coded Value that enables Weights & Measures password protection Tag A Tag can contain 15 bytes of data and can include any printable ASCII character. Tags can be used to identify points indicating the use of the point such as “Tank 22.” The default tag is set to “AT4530.00”. Chan Communications channel to which the gauge is connected. For an 8203 Dual RS485 Communications Interface Module Chan is either 1 or 2. ID The Device ID of the Varec 6000 Servo Gauge (STG) or 4590 Tank Side Monitor connected to the AT4530. Mode Parameter used to control the operation of the AT4530 point. 0x0 - Average Thermometer data (8311 Module) 0x100 - AT4530 is connected to a SG6000 (Not a 4590 TSM) BaudRate 8203 Dual RS-485 Communications Interface Module: Valid values are: 2400, 4800, and 9600. The default is 9600. Comms Params Defines the number of data bits and the parity used by the AT4530. Examples include: 8N - 8 data bits, No parity 8O - 8 data bits, Odd parity 8E - 8 data bits, Even parity 7O - 7 data bits, Odd parity 7E - 7 data bits, Even parity The default is 8N. TempUnits Specifies the engineering units for the temperature data. F: Fahrenheit C: Celsius The TempUnits needs to match the units specified during the gauge setup. The Temp can be converted from Metric to English (or vice-versa) by setting the TempConvert parameter in the appropriate MSCAN, RKSCN or WBSCN point. Varec, Inc. TempDeadband The TempDeadband is used to set the Change Of State deadband for temperature. The default is .25 degrees. FastScanMode Places the AT4530 point in the Fast Scan mode. Values are Enable or Disable. 43 Tank Gate Interface 44 Config Parameters Function Report Causes automatic notification to the Host (in response to a Change of State Request) when the Level, Temp, Position changes. Parameter value can be High, Low or No. Report=No disables automatic notification. Points with Report = High will be sent before points with Report = Low. The default is High. Maxtime Specifies the maximum time (in secs) between automatic Change of State responses being sent to the Host. Report must be set to either Low or High for the Value parameter to be sent in response to a Change of State Request. A value of 0 disables this option. Non-zero values cause responses to be sent even if the value has not changed since the last message. The maximum is 65535 seconds. The default is 600. Watchdog Enables the watchdog task on the Motherboard. The watchdog task monitors the AT4530 point on the 8203 Dual RS-485 Communications Interface Module and verifies it is scanning for gauges. Dynamic Parameters Function AvgTemp IEEE Floating point value representing the average temperature. The data is returned in the format specified during the configuration of the gauge. The AvgTemp can be converted from Metric to English (or vice-versa) by setting the TempConvert parameter of the appropriate MSCAN, RKSCN or WBSCN point. Vaportemp Floating point value representing the gas temperature. The data is returned in the format specified during the configuration of the gauge. The Temperature can be converted from Metric to English (or vice-versa) by setting the TempConvert parameter of the appropriate MSCAN, RKSCN or WBSCN point. Temp1-Temp16 Floating point value representing the product temperature at various levels. The data is returned in the format specified during the configuration of the gauge. Temp1-Temp16 can be converted from Metric to English (or vice-versa) by setting the TempConvert parameter of the appropriate MSCAN, RKSCN or WBSCN point. AverageNum Number of active temperature elements. Level Level Data from Varec 6000 Servo Gauge (STG) or 4590 Tank Side Monitor. ErrorCode Error Code. Refer to the N453x manual for further explanation. Status Hart Command 48 Status. Refer to manufacturer for additional information. DiagCode Diagnostic code CustodyMode Weights and Measures Status DeviceStatus 4590 TSM Internal Status Elapse Time of last scan. Interval Amount of time (in HR:MIN:SEC) between scans of the gauge Installation and Operations Manual 8303 Dynamic Parameters Function PntStatus Byte value indicating status of point. Values are: 0x0000: No Error 0x0001: Gauge is offline 0x0002: Data is invalid 0x0004: Command Timeout 0x8000: Gauge did not response to last request (pre-fail) For 8211 Whessoe Bus Communications Interface Module values are: 0x10 - Gauge is offline 0x20 - CRC Error0x40 - Invalid Command0x80 - Motherboard Watchdog Timeout 5.1.2 PntCheckSum CRC-16 Checksum for point’s static Configuration Parameters. WMCheckSum Weights and Measures Checksum. This parameter is calculated when the WMSeal parameter is set to enable. Application The Varec 453x series Average Temperature Converter (ATC) (AT4530) point must communicate via a Varec 6000 Servo Tank Gauge or a 4590 Tank Side Monitor (TSM). All communication parameters such as ID, Chan, BaudRate, etc., must be set to communicate to the SG6000 or 4590 TSM. Once communication is established through the SG6000 or 4590 TSM, the AT4530 point then automatically retrieves all data. The AT4530 point can operate using one of three protocols: Modbus Protocol Using Modbus protocol, AT4530 temperature transmitters are connected to a Varec 6000 Servo Tank Gauge or a 4590 Tank Side Monitor. The Varec 6000 Servo Tank Gauge or 4590 TSM is connected to an 8203 Dual RS-485 Communications Interface Module (Modbus). The 8203 Dual RS-485 Communications Interface Module is automatically detected at startup, and an MSCAN point is automatically created to manage the scanning task. The Chan parameter determines to which 8203 Dual RS-485 Communications Interface Module channel the Varec 6000 Servo Tank Gauge/4590 TSM/AT4530 is connected. The ID must match the Device ID of the Varec 6000 Servo Tank Gauge or 4590 TSM. General All three interface methods provide a software interface to the Varec 453x series Average Temperature Converter (ATC). 8203 TGI software points may begin scanning when the point is created, or when the correct Channel number is assigned. Which of these events begins the scanning process varies with each point. The TempUnits must match the engineering units of the AT4530 temperature transmitter. Conversion from Metric to English (or vice-versa) can be performed be setting the TempConvert parameters in the MSCAN, RKSCN or WBSCN point associated with the AT4530 point. Varec, Inc. 45 Tank Gate Interface 46 Installation and Operations Manual 8303 5.2 Saab Data Acquisition Unit (DAU) The Saab Data Acquisition Unit point provides an interface to Saab Model 2100 Data Acquisition Units. The DAU point interfaces to Saab DAUs using Modbus through a Saab FCU. The 8203 Dual RS-485 Interface Module is used to connect to the FCU. The 8212 Saab (TRL/2) Communications Interface Module is used to directly connect to the DAU over the TRL/2 bus. 5.2.1 Parameters The database parameters used by the DAU point are listed and described below: Configuration Parameters Function Tag A Tag can contain 15 bytes of data and can include any printable ASCII character. Tags can be used to identify the name of the tank being monitored. The default tag is set to “DAU.00”. Description The point description can contain 30 bytes of data and can include any printable ASCII character. Descriptions can be used as information relevant to any aspect of the point, such as its use, location, operating information, etc. The default description is set to “DAU.00” Chan Physical channel number to which the DAU is connected. On the 8203 Dual RS-485 Communications Interface Module, the Chan can be set to 1 or 2. ID Physical Address of the Data Acquisition Unit (0-999). Addr FCU Address (if Mode = 0x02) Mode Operational Mode. Values are: 0x01: Swap Mode 0x02: Communication via FCU 0x04: Read REX Temperature 0x08: FCU - Read 0x8000 Data Addresses 0x10: SAAB Swap Mode 0x80: ASCII Mode BaudRate Baud Rate for communications to the DAU device. Valid values are: 1200, 2400, and 4800. ComParams Defines the number of data bits and the parity used by the com port. Valid values include: 8N - 8 data bits, No parity 8O - 8 data bits, Odd parity 8E - 8 data bits, Even parity 7O - 7 data bits, Odd parity 7E - 7 data bits, Even parity The default is 8N. TempUnits Specifies the engineering units for the temperature data read from the DAU. F: Fahrenheit C: Celsius The TempUnits needs to match the units specified during the DAU setup. The default is C TempConvert Determines the units in which the temperature data will be displayed. F: Fahrenheit C: Celsius If no value is specified, no conversion will be performed. The default is C Varec, Inc. 47 Tank Gate Interface Configuration Parameters Function TempDeadband Specifies the amount of change in the Temp that must occur for the level to be updated each Change of State period. The default is 0.25. TempInterleave Temperature Interleave. Determines how often the temperature is read from the DAU. The default is 10, which means that every tenth scan of the DAU, the temperatures will be read. Report Causes automatic notification to the Host (in response to a Change of State Request) when the Value changes State. Parameter value can be High, Low or No. Report=No disables notification. Points with Report = High will be sent before points with Report = Low. The default is High. Maxtime Specifies the maximum time (in secs) between automatic Change of State responses being sent to the Host. Report must be set to either Low or High for the Value parameter to be sent in response to a Change of State Request. A value of 0 disables this option. Non-zero values cause responses to be sent even if the value has not changed since the last message. The maximum is 65535 seconds. The default is 240. Watchdog Enables the Motherboard watchdog task for the DAU point. The watchdog task monitors the DAU point and verifies it is scanning for devices. If the DAU point stops execution, the PntStatus will be set to 0x4000 to indicate a failure. Dynamic Parameters Function Temp1-Temp14 Floating point value representing the temperature of each temp sensor configured. TempFilter Temp in Liquid parameter. Bits 0 – 13 indicate if Temp sensors 1 – 14 are submerged in liquid. Bit 14 indicates a System Error. Bit 15 indicates a Temp calibration error. 0x0001: Temp 1 is in Liquid 0x0002: Temp 2 is in Liquid 0x0004: Temp 3 is in Liquid 0x0008: Temp 4 is in Liquid 0x0010: Temp 5 is in Liquid 0x0020: Temp 6 is in Liquid 0x0040: Temp 7 is in Liquid 0x0080: Temp 8 is in Liquid 0x0100: Temp 9 is in Liquid 0x0200: Temp 10 is in Liquid 0x0400: Temp 11 is in Liquid 0x0800: Temp 12 is in Liquid 0x1000: Temp 13 is in Liquid 0x2000: Temp 14 is in Liquid 0x4000: System Error 0x8000: Temp Calibration error 48 Installation and Operations Manual 8303 Dynamic Parameters Function TempStatus Temp status parameter (blocked). This parameter indicates the blocked status of each temperature sensor. 0x0001: Temp 1 blocked 0x0002: Temp 2 blocked 0x0004: Temp 3 blocked 0x0008: Temp 4 blocked 0x0010: Temp 5 blocked 0x0020: Temp 6 blocked 0x0040: Temp 7 blocked 0x0080: Temp 8 blocked 0x0100: Temp 9 blocked 0x0200: Temp 10 blocked 0x0400: Temp 11 blocked 0x0800: Temp 12 blocked 0x1000: Temp 13 blocked 0x2000: Temp 14 blocked 0x4000: Legal NMI-temperature 0x8000: NMI approved DAU TempDiagCode Temp diagnostic code parameter. This parameter indicates the error status of each temperature sensor. 0x0001: Temp 1 error 0x0002: Temp 2 error 0x0004: Temp 3 error 0x0008: Temp 4 error 0x0010: Temp 5 error 0x0020: Temp 6 error 0x0040: Temp 7 error 0x0080: Temp 8 error 0x0100: Temp 9 error 0x0200: Temp 10 error 0x0400: Temp 11 error 0x0800: Temp 12 error 0x1000: Temp 13 error 0x2000: Temp 14 error 0x4000: Master (set if using an FCU and DAU does not respond) 0x8000: Temp average error. No temperature sensor is in liquid. AvgTemp Floating point value representing the average tank temperature. This value is the average of all sensors below the liquid level. PntStatus Integer HEX value indicating status of point. Values are: 0x0001: DAU Not Responding 0x0010: No response (set if using an FCU and DAU does not respond) 0x4000: Failure of the 8203 or 8212 module. This bit is set if the Watchdog task on the Motherboard determines that the 8203 or 8212 module has stopped updating. Varec, Inc. Elapse Time of the last scan PntCheckSum CRC-16 Checksum for point's static Configuration Parameters 49 Tank Gate Interface 5.2.2 Application The DAU point provides an interface to Saab Data Acquisition Units (DAU) via an FCU, using a 8203 Dual RS-485 Communications Interface Module or the 8212 Saab (TRL/2) Communications Interface Module. If the Data Acquisition Units are connected to a Saab FCU, then an 8203 Dual RS-485 Communications Interface Module or the 8212 Saab (TRL/2) Communications Interface Module is used to read data. The 8203 Dual RS-485 Communications Interface Module or the 8212 Saab (TRL/2) Communications Interface Module automatically detects startup, and an MSCAN point is automatically created to manage the scanning task. Chan determines which Channel is used for communications to the slave device. The Chan parameter must match the channel used to communicate with the Saab DAU. A DAU point is needed for each DAU connected to the 8303 TGI or the 8212 Saab (TRL/2) Communications Interface Module. The ID must match the unit address of the Saab DAU. The BaudRate and ComParams values must match the communications parameters of the Data Acquisition Unit. The communications parameters are set as each DAU point is processed. 8203 TGI or the 8212 Saab (TRL/2) Communications Interface Module software points may begin scanning when the point is created, or when the correct Channel number is assigned. Which of these events begins the scanning process varies with each point. The DAU point works in conjunction with the Modbus Master protocol handler (MSCAN). MSCAN points are automatically created so you only have to set the Chan, BaudRate, ComParams and ID parameters in order to establish communications with the Saab DAU. The Mode parameter determines whether the DAU point reads the data from the Saab FCU’s holding registers. If the Mode is 0x02, then the data is read from the holding registers. The Addr parameter determines the FCU address and the ID is not used. If the Mode is 0, then the FCU sends the request to the DAU and sends the response back to the 8303 TGI or the 8212 Saab (TRL/2) Communications Interface Module. The ID is used and the Addr parameter is ignored. This mode is sometimes referred to as “pass-through’ mode. 50 Installation and Operations Manual 8303 5.3 GSI Model 2000 Modbus Interface (GSIMB) The GSI Model 2000 Modbus (GSIMB) point provides an interface to GSI Modbus transmitters. The point provides both level and temperature data. Information such as point and gaugestatus, is also available in this point block.. 5.3.1 Parameters The database parameters used by the GSIMB point are listed and described below: Config/Constant Parameters Function Tag A Tag can contain 15 bytes of data and can include any printable ASCII character. Tags can be used to identify the name of the tank being monitored. The default tag is set to “RTG.00”. ID Physical Address of the tank gauge transmitter (0-999). Chan Communications channel to which the gauge is connected. For an 8203 Dual RS-485 Communications Interface Module Chan is either 1 or 2. BaudRate 8203 Dual RS-485 Communications Interface Module: Valid values are: 2400, 4800, and 9600. The default is 9600. ComParams Defines the number of data bits and the parity used by the com port. Valid values include: 8N - 8 data bits, No parity 8O - 8 data bits, Odd parity 8E - 8 data bits, Even parity 7O - 7 data bits, Odd parity7E - 7 data bits, Even parity The default is 8N. LevelDeadband The LevelDeadband sets the deadband for the Change of State mode. The default is 0. LevelOffset Specifies the amount of offset to add to the Level. The default is 0. TempMode F: Fahrenheit C: Celcius Varec, Inc. TempDeadband The TempDeadband is used to set the Change Of State deadband for temperature. The default is .25 degrees. TempOffset Specifies the amount of offset to add to the Temp. The default is 0. Report Causes automatic notification to the Host (in response to a Change of State Request) when the Level, Temp, Position changes. Parameter value can be High, Low or No. Report=No disables automatic notification. Points with Report = High will be sent before points with Report = Low. The default is High. Maxtime Specifies the maximum time (in secs) between automatic Change of State responses being sent to the Host. Report must be set to either Low or High for the Value parameter to be sent in response to a Change of State Request. A value of 0 disables this option. Non-zero values cause responses to be sent even if the value has not changed since the last message. The maximum is 65535 seconds. The default is 600. 51 Tank Gate Interface Dynamic Parameters Function Level IEEE Floating point value representing the tank level. The data is returned in the format specified during the configuration of the gauge. Temp Floating point value representing the product temperature. The data is returned in the format specified during the configuration of the gauge. PntStatus Byte value indicating status of point. Values are: 0x0000: No Error 0x0001 No Response from transmitter 0x0002: Data is invalid 0x0004: Command Timeout 0x8000: Gauge did not response to last request (pre-fail) GaugeStatus Byte value indicating status of the gauge. Refer to the transmitter manual for details on the GaugeStatus 5.3.2 Reserved Reserved. Reserved2 Reserved Value (32 bit Register 0048) Elapse Time of the last scan Interval Amount of time (in HR:MIN:SEC) between scans of the gauge PntCheckSum CRC-16 Checksum for point’s static Configuration Parameters. Application The GSIME point provides an interface to GSI Model 2000 Tank Gauge Transmitters. Tank gauges are connected directly to a 8303 Dual RS-485 Communications Interface Module. The ID must match the unit address of the GSI transmitter and the Baud Rate must match the Baud Rate of the gauge. The DataMode must match the engineering units of the gauge. Conversion from Metric to English (or vice-versa) can be performed be setting the LevelConvert and the TempConvert parameters in the MODSCAN point associated with the GSIMB point. The Level can be offset by entering a value for the LevelOffset parameter. The LevelOffset is added to the Level after any conversion have be performed. Likewise, the TempOffset can be used to provide a temperature offset. 52 Installation and Operations Manual 8303 5.4 Varec Multi-Function Transmitter (Modbus) (MBMFT) The Varec Multi-Function Transmitter (Modbus) (MFT) Tank Gauge point provides an interface to Varec 4200 Multi-Function Transmitters (MFT). The 4200 MFT can communicate using a number of different protocols, including Mark/Space and Modbus. The MBMFT point interfaces to 4200 MFTs using Modbus. This point provides level, temperature, density and volume data. Point and gauge status information is also available in this point block. 5.4.1 Parameters The database parameters used by the MBMFT point are listed and described below: Configuration Parameters Function Tag A Tag can contain 15 bytes of data and can include any printable ASCII character. Tags can be used to identify the name of the tank being monitored. The default tag is set to “MBMFT.00”. Chan Physical channel number the MBMFT is connected to. On the 8203 Dual RS-485 Communications Interface Module, the Chan can be set to 1 or 2. On the 8303 TGI motherboard, the Chan can be set to 1 or 2. BaudRate Baud Rate for communications to the Slave device. Valid values are: 1200, 2400, 2400, 9600 and 19200. The BaudRate is set prior to scanning the device. The default is 9600 ComParams Defines the number of data bits and the parity used by the com port. Valid values include: 8N - 8 data bits, No parity 8O - 8 data bits, Odd parity 8E - 8 data bits, Even parity 7O - 7 data bits, Odd parity 7E - 7 data bits, Even parity The default is ‘8O’. Varec, Inc. ID Physical Address of the tank gauge transmitter (0-999). Mode Operation Mode. Valid values are: 0x80: Swap Mode. Swap the order of integer and floating point values. LevelOffset Specified the amount of offset to add to the Level. The default is 0. TempOffset Specified the amount of offset to add to the Temperature. The default is 0. LevelDeadband Specifies the amount of change in the Level that must occur for the level to be updated each Change of State period. The default is 0. TempDeadband Specifies the amount of change in the Temp that must occur for the temperature to be updated each Change of State period. The default is 0.25. Report Causes automatic notification to the Host (in response to a Change of State Request) when the Value changes State. Parameter value can be High, Low or No. Report=No disables notification. Points with Report = High will be sent before points with Report = Low. The default is High. Maxtime Specifies the maximum time (in secs) between automatic Change of State responses being sent to the Host. Report must be set to either Low or High for the Value parameter to be sent in response to a Change of State Request. A value of 0 disables this option. Non-zero values cause responses to be sent even if the value has not changed since the last message. The maximum is 65535 seconds. The default is 600. 53 Tank Gate Interface Configuration Parameters Function Watchdog Enables the watchdog task on the Motherboard. The watchdog task monitors the MBMFT point on the 8203 Dual RS-485 Communications Interface Module and verifies it is scanning for gauges. If the 8203 Dual RS-485 Communications Interface Module fails, the 0x0010 and the 0x0001 bits of the PntStatus will be set to indicate the failure. Dynamic Parameters Function Command The Command parameter allows you to issue a single command to the gauge. Valid commands include: Cancel Clear Mods Restart Save to EEPROM Calibrate Enc Battery Off 54 LevelRef Calibration Level. The LevelRef provides a means to calibrate the level in the tank gauge transmitter. Set the LevelRef and then issue a Calibrate command. Mass Floating point value representing the Effective Mass (32 bit Register 0025). NetMass Floating point value representing the True Mass (32 bit Register 0026). Density Floating point value representing the Density (32 bit Register 0027). CorrDensity Floating point value representing the Standard Density (32 bit Register 0028). Reserved Reserved Level Floating point value representing the Tank Level (32 bit Register 0030). WaterLevel Floating point value representing the Water Level (32 bit Register 0031). GrossVolume Floating point value representing the Product Volume (32 bit Register 0032). NetVolume Floating point value representing the Standard Product Volume (32 bit Register 0033). WaterVolume Floating point value representing the Water Volume (32 bit Register 0034). Ullage Floating point value representing the Remaining Volume (32 bit Register 0035). Temp Floating point value representing the Product Temperature (32 bit Register 0036). AmbientTemp Floating point value representing the Ambient Temperature (32 bit Register 0037). Tb Floating point value representing the Bottom Temperature (32 bit Register 0038) Tm Floating point value representing the Middle Temperature (32 bit Register 0039) Tt Floating point value representing the Top Temperature (32 bit Register 0040) TimeToFill Floating point value representing the Time to Fill (32 bit Register 0041) FlowRate Floating point value representing the Flow Rate (32 bit Register 0042) RoofMass Floating point value representing the Roof Mass (32 bit Register 0043) HeadPress Floating point value representing the Head Pressure (32 bit Register 0044) Pb Floating point value representing the Bottom Pressure (32 bit Register 0045) Pm Floating point value representing the Middle Pressure (32 bit Register 0046) AvlInventory Floating point value representing the Available Inventory (32 bit Register 0047) Installation and Operations Manual 8303 Dynamic Parameters Function Reserved2 Reserved Value (32 bit Register 0048) FlowPeriod Floating point value representing the Flow Period (32 bit Register 0049) RTD1 Floating point value representing the RTD Resistance (32 bit Register 0050) Current Floating point value representing the 4-20 mA Current (32 bit Register 0051) AlarmStatus Integer value indicating the Alarm Status (Integer Register 76). Values are: 0x0001: Critical Low Level 0x0002: Advisory Low Level 0x0004: Advisory High Level 0x0008: Critical High Level 0x0010: Unauthorized Mass Movement 0x0020: Standard Density Alarm 0x0040: Critical Zone Alarm 0x0080: Critical Low Temperature 0x0100: Critical High Temperature 0x0200: Hardware Alarm Input 1 0x0400: Hardware Alarm Input 2 0x0800: Reserved 0x1000: Reserved 0x2000: Reserved 0x4000: Advisory Low Temperature 0x8000: Advisory High Temperature Alarm0 Reserved (Integer Register 77). Alarm1 Reserved (Integer Register 78). StatusFlag Integer value indicating the System Diagnostics (Integer Register 79). Values are: 0x0001: Top Transmitter Failure 0x0002: Top Transmitter Communication Failure 0x0004: Middle Transmitter Failure 0x0008: Middle Transmitter Communication Failure 0x0010: Bottom Transmitter Failure 0x0020: Bottom Transmitter Communication Failure 0x0040: Bad Product Temperature 0x0080: RTD Resistance out of range 0x0100: Bad Level 0x0200: HART Encoder Communication Failure 0x0400: Pb < Pm 0x0800: Pb < Pt 0x1000: Pm < Pt 0x2000: Pb uncovered 0x4000: Pm uncovered 0x8000: Reserved Varec, Inc. 55 Tank Gate Interface Dynamic Parameters Function GaugeStatus Integer value indicating the MBMFT Status (Integer Register 80). Values are: 0x0001: Offline Mode 0x0002: Constant Data Modified 0x0004: Not Calculating Density 0x0008: Level out of Strap Table Range 0x0010: RTD not immersed 0x0020: Not Calculating 0x0040: Constant data incomplete or incorrect 0x0080: Calculation Error 0x0100: API Correction Error 0x0200: Reserved 0x0400: CPU Board Failure 0x0800: Reserved 0x1000: Water Level Sensor Failure 0x2000: Communications Board Failure 0x4000: Level Mismatch 0x8000: HART Encoder Battery Low PntStatus Byte value indicating status of point. Values are: 0x0001: Gauge Not Responding 0x0010: Failure of the 8203 Dual RS-485 Communications Interface Module. This bit is set if the Watchdog task on the Motherboard determines that the 8203 Dual RS-485 Communications Interface Module has stopped updating. 0x4000: Aux Switch status 0x8000: High Level Switch status 5.4.2 Elapse Time of the last scan PntCheckSum CRC-16 Checksum for point's static Configuration Parameters Application The MBMFT point provides an interface to Varec 4200 Multi-Function Transmitters that operate in Modbus mode. 4200 MFTs are connected directly to a 8203 Dual RS-485 Communications Interface Module Dual RS-485 Interface Module. The 8203 Dual RS-485 Communications Interface Module is automatically detected at startup, and an MSCAN point is automatically created to manage the scanning task. Chan determines which 8203 Dual RS-485 Communications Interface Module Channel is used for communications to the slave device. The Chan parameter must match the channel used to communicate with the 4200 MFT. An MBMFT point is needed for each device connected to the 8303 TGI. The ID must match the unit address of the 4200 MFT. 8203 TGI software points may begin scanning when the point is created, or when the correct Channel number is assigned. Which of these events begins the scanning process varies with each point. The BaudRate and ComParams values must match the communications parameters of the slave device. The communications parameters are set as each MBMFT point is processed. This allows slaves with different baud rates and data link settings to exist on the same bus (this practice is allowed but not recommended). The MBMFT point works in conjunction with the Modbus Master protocol handler (MSCAN). If an 8203 Dual RS-485 Interface Module fitted with the Modbus Master firmware, MSCAN points are automatically created and you only have to set the Chan, BaudRate, ComParams and ID parameters in order to establish communications with the 4200 MFT. If one of the two RS-485 communications on the 8303 TGI motherboard is used, then the Modbus Master Protocol 56 Installation and Operations Manual 8303 Handler (MSCAN) for that channel must be started. The default protocol for COM 0, 1 and 2 after a “hard reset” is 8130 RTU Slave, which is the protocol used to communicate with ViewRTU and FuelsManager. In order to change the protocol, set the Protocol parameter in the COM point to Modbus Master. Use the Upload command in ViewRTU’s Config menu to upload the MSCAN point that manages the Modbus Master Protocol Handler (MSCAN). The protocol will be automatically rescheduled after a power up or a “soft reset”. Varec, Inc. 57 Tank Gate Interface 58 Installation and Operations Manual 8303 5.5 Varec Modbus Level Transmitter Interface (MBTX) The Varec Modbus Level Transmitter point provides an interface to Varec 4000 Advanced Technology Transmitters (ATT), the Varec 2900 Float and Tape Transmitter (2900FTT), and the Varec 2910 Float and Tape Transmitter (2910 FTT). The 4000 ATT, 2900FTT, 2910 FTT can communicate using a number of different protocols, including Mark/Space and Modbus. The WV4000 point interfaces to 4000 ATTs and 2900FTTs using Modbus. The MBTX point provides both level and temperature data. Point and gauge status information is also available in this point block. 5.5.1 Parameters The database parameters used by the MBTX point are listed and described below: Configuration Parameters Function Tag A Tag can contain 15 bytes of data and can include any printable ASCII character. Tags can be used to identify the name of the tank being monitored. The default tag is set to “MBTX.00”. Chan Physical channel number the transmitter is connected to. On the 8303 TGI motherboard, the Chan can be set to 1 or 2. BaudRate Baud Rate for communications to the Slave device. Valid values are: 2400, 2400 and 9600. The BaudRate is set prior to scanning the device. The default is 9600 ComParams Defines the number of data bits and the parity used by the com port. Valid values include:8N - 8 data bits, No parity 8O - 8 data bits, Odd parity 8E - 8 data bits, Even parity 7O - 7 data bits, Odd parity 7E - 7 data bits, Even parity The default is 8O. ID Physical Address of the tank gauge transmitter (1-1655). Mode Operational Mode: Valid values are: 0x01: Swap Mode – Swap integers The default is 0x00. LevelUnits Specifies the engineering units for the level data read from the MBTX. F: Feet m: millimeters The LevelUnits needs to match the units specified during the gauge setup. Default is F LevelConvert Determines the units in which the level data will be displayed. F: Feet m: millimeters Default is F. TempUnits Specifies the engineering units for the temperature data read from the MBTX. F: Fahrenheit C: Celsius The TempUnits needs to match the units specified during the gauge setup. The default is F. TempConvert Determines the units in which the temperature data will be displayed. F: Fahrenheit C: Celsius If no value is specified, no conversion will be performed. The default is F. Varec, Inc. 59 Tank Gate Interface Configuration Parameters Function LevelOffset Specifies the amount of offset to add to the Level. The default is 0. TempOffset Specifies the amount of offset to add to the Temp. The default is 0. LevelDeadband Specifies the amount of change in the Level that must occur for the level to be updated each Change of State period. The default is 0.1. TempDeadband Specifies the amount of change in the Temp that must occur for the temperature to be updated each Change of State period. The default is 0.25. Report Causes automatic notification to the Host (in response to a Change of State Request) when the Value changes State. Parameter value can be High, Low or No. Report=No disables notification. Points with Report = High will be sent before points with Report = Low. The default is High. Maxtime Specifies the maximum time (in secs) between automatic Change of State responses being sent to the Host. Report must be set to either Low or High for the Value parameter to be sent in response to a Change of State Request. A value of 0 disables this option. Non-zero values cause responses to be sent even if the value has not changed since the last message. The maximum is 65535 seconds. The default is 600. Watchdog Enables the watchdog task on the Motherboard. The watchdog task monitors the MBTX point on the Model 8310 and verifies it is scanning for gauges. If the 8203 Dual RS-485 Communications Interface Module fails, the 0x4000 and the 0x0001 bits of the PntStatus will be set to indicate the failure. Dynamic Parameters Function Command MBTX Command. Valid values are: Calibrate: Calibrate the ATT Cancel: Cancel (4000 ATT only) Clear Mods: Clear Modifications (4000 ATT only) Enc Battery Off: Turn off Encode Battery (4000 ATT only) Restart: Restart ATT (4000 ATT only) Save to EEPROM: Save the ATT database to EEPROM (4000 ATT only) Level Floating point value representing the tank level (Floating point Register 0). The Level will be presented in decimal feet. Temp Floating point value representing the tank temperature (Floating point Register 1). The Temperature will be presented in Fahrenheit. RTD1 Floating point value representing the RTD resistance, represented in Ohms (Floating point Register 2). AlarmStatus Integer value indicating the Alarm Status (Integer Register 5). Values are: 0x0001: Critical Low Level 0x0002: Advisory Low Level 0x0004: Advisory High Level 0x0008: Critical High Level 0x0010: Critical Low Temperature 0x0020: Advisory Low Temperature 0x0040: Advisory High Temperature 0x0080: Critical High Temperature 0x0100: Hardware Input 1 0x0200: Hardware Input 2 60 Installation and Operations Manual 8303 Dynamic Parameters GaugeStatus Function Integer value indicating status of the gauge (Integer Register 6). Values are: 0x0001: Bad Level 0x0002: Bad Temp 0x0004: Bad EE 0x0008: Bad EE Checksum 0x0010: Bad RAM 0x0020: Bad EEPROM 0x0040: Local Modifications 0x0080: No Calculation 0x0100: CFG Error 0x0200: Calc Error 0x0400: Bad CPU Board 0x0800: Bad Comm Board 0x1000: Low Encoder Battery LevelRef Calibration Level. The LevelRef provides a means to calibrate the level in the tank gauge trasmitter. Set the LevelRef and then issue a Calibrate command. PntStatus Integer HEX value indicating status of point. Values are: 0x0001: Gauge Not Responding 0x0008: Bad Level 0x0010: Bad Temp 0x0020: Bad EE 0x0040: Bad EE Checksum 0x0080: Bad RAM 0x0100: Bad EEPROM 0x0200: Local Modifications 0x0400: No Calculation 0x0800: CFG Error 0x1000: Calc Error 0x2000: Bad CPU Board 0x4000: Bad Comm Board 0x8000: Low Encoder Battery 5.5.2 Elapse Time of the last scan PntCheckSum CRC-16 Checksum for point's static Configuration Parameters Application The MBTX point provides an interface to Varec Model 4000 Advanced Technology Transmitters (ATT) and the Varec 2900 Float and Tape Transmitter (2900FTT) that operate in Modbus mode. 4000 ATTs and 2900FTTs are connected directly to an 8303 Dual RS-485 Communications Interface Module. The 8303 Dual RS-485 Communications Interface Module is automatically detected at startup, and an MSCAN point is automatically created to manage the scanning task. Chan determines which 8303 Dual RS-485 Communications Interface Module Channel is used for communications to the slave device. The Chan parameter must match the channel used to communicate with the 4000 ATT or the 2900FTT. A MBTX point is needed for each device connected to the 8303 TGI. The ID must match the unit address of the 4000 ATT and 2900FTT. 8303 TGI software points may begin scanning when the point is created, or when the correct Channel number is assigned. Which of these events begins the scanning process varies with each point. The BaudRate and ComParams values must match the communications parameters of the 4000 ATT or 2900FTT. The communications parameters are set as each MBTX point is processed. This Varec, Inc. 61 Tank Gate Interface allows slaves with different baud rates and data link settings to exist on the same bus (this practice is allowed but not recommended). The MBTX point scans the following Modbus data from the 4000 ATT: Command Address Data # of Registers 65 0 Level, Temp 2 Floating point 4 5 AlmStat, DiagStat 2 Integers 65 21 Level Reference 1 Floating point It is possible to calibrate the ATT from the MBTX point. Set the LevelRef to the desired level in the tank. Issue a Calibrate command (set the Command parameter to Calibrate). The Level will be offset by the LevelRef. 62 Installation and Operations Manual 8303 5.6 Modbus I/O (MFIO) The Modbus I/O Module point is used for communicating with Allen Bradley Flex I/ O Modules. The MFIO point lets you specify what Modbus data is read from the Allen Bradley Module and it also allows data configuration. 5.6.1 Parameters The database parameters used by the MFIO point are listed and described below: Configuration Parameters Function Tag A Tag can contain 15 bytes of data and can include any printable ASCII character. Tags can be used to identify points indicating the use of the point such as “Modbus Slave” or “Register Value1.” The default tag is set to “MFIO.00” Chan Physical channel number the Allen Bradley is connected to. On the 8203 Dual RS-485 Communications Interface Module the Chan can be set to 1 or 2. On the 8303 TGI motherboard, the Chan can be set to 0, 1 or 2. BaudRate Baud Rate for communications to the Slave device. Valid values are: 1200, 2400, 4800, 9600 and 19200. The default is 19200. ComParams Defines the number of data bits and the parity used by the com port. Valid values include: 8N - 8 data bits, No parity 8O - 8 data bits, Odd parity 8E - 8 data bits, Even parity 7O - 7 data bits, Odd parity 7E - 7 data bits, Even parity The default is 8N. ID Physical Address of the Allen Bradley Module. ReadCmd Command used to Read data from the Allen Bradley. Usually 3 or 4. Default is 3. WriteCmd Command used to Write data to the Allen Bradley. Usually 5 or 6. Default is 6. Addr1 Data Address and Size. This is the register data read from the Allen Bradley Module. Addr1 is the register start address. The Size1 parameter determines how many values are read. Default is 8. The values can be seen in the Value1-8 parameters. Consult the Allen Bradley documentation for more information Size1 Addr2, Value_2 Addr3, Value_3 Addr4, Value_4 Varec, Inc. These parameters are used to send data to the Configuration Registers of the Allen Bradley Module. They are written to the Allen Bradley as soon as communication is established. AddrX determines the Address of the point, while Value_X is the actual data written to AddrX. For more information on the configuration registers, consult the Allen Bradley documentation. Offset Input range offset used for scaling the input values. Scale Input range scale used for scaling the input values. ValueMin Output range offset used for scaling the output values. ValueMax Output range scale used for scaling the output values. Report Causes automatic notification to the Host (in response to a Change of State Request) when a value changes. Parameter value can be High, Low or No. Report=No disables automatic notification. Points with Report = High will be sent before points with Report = Low. The default is High. 63 Tank Gate Interface Configuration Parameters Function Maxtime Specifies the maximum time (in secs) between automatic Change of State responses being sent to the Host. Report must be set to either Low or High for the Value parameter to be sent in response to a Change of State Request. A value of 0 disables this option. Non-zero values cause responses to be sent even if the value has not changed since the last message. The maximum is 65535 seconds. The default is 240. Watchdog Enables the watchdog task on the Motherboard. The watchdog task monitors the MBMFT point on the 8203 Dual RS-485 Communications Interface Module and verifies it is scanning for gauges. If the 8203 Dual RS-485 Communications Interface Module fails, the 0x0010 and the 0x0001 bits of the PntStatus will be set to indicate the failure. Dynamic Parameters Function Value1 Analog Value 1 Value2 Analog Value 2 Value3 Analog Value 3 Value4 Analog Value 4 Value5 Analog Value 5 Value6 Analog Value 6 Value7 Analog Value 7 Value8 Analog Value 8 PntStatus Byte value indicating status of point. Values are: 0x0001: Gauge Not Responding 0x0010: Failure of the Model 8203. This bit is set if the Watchdog task on the Motherboard determines that the Model 8203 has stopped updating. 5.6.2 Elapse Time of last scan. PntCheckSum CRC-16 Checksum for point’s static Configuration Parameters Application The MFIO point continually scans the Allen Bradley Flex I/O device, using the ID parameter. Chan determines which 8203 Dual RS-485 Communications Interface and Channel is used for communications to the Allen Bradley. An MFIO point is needed for each device connected to the 8303 TGI. Up to 8 Registers can be read with each MFIO point. The BaudRate and ComParams values must match the communications parameter of the Allen Bradley module. Each point can read up to 8 consecutive register values, and write to 3 configuration addresses. The ReadCmd parameter determines the command to read data and the WriteCmd parameter is the command used for write operations. The Addr1 and Size1 parameters determine the read register values, while the Addr2-4 and Value2-4 determine the configuration values that can be written to the Allen Bradley. Set the Addr1 and Size1 parameters to read the data from the device. The response will be placed in the Value1-Value8 parameters. For example, if Addr1 = 1000 and Size1 = 6, then the MFIO point will read 6 values and place the data in Value1- Value6. Likewise, if configuration data needs to be set, Addr2 - Addr4 sets the address to be written to, and Value_2 – Value_4 is the data written to that address. For example, if Addr2 = 1201 and Value_2 is 0x2222, a value of 0x2222 will be placed in the register address 1201. 8203 TGI software points may begin scanning when the point is created, or when the correct Channel number is assigned. Which of these events begins the scanning process varies with each point. 64 Installation and Operations Manual 8303 5.7 MTG Tank Gauge Interface (MG5000) The MG5000 Tank Gauge point provides an interface to a MTS Magnetostrictive Tank Gauge (MTG) that uses the Modbus protocol. The MTS MTG consist of magnetostrictive level and RTD temperature sensors providing highly accurate digital output data. This data is transmitted over an EIA-485 communication data bus which allows multi-drop connection, eliminating the requirement for individual cable runs to each gauge. The MG5000 point provides product level, product water interface level, and temperature data, as well as gauge status information. Configuration and diagnostic information is also available from the MG5000, and can be modified if necessary. The MG5000 point can execute on the Model 8203 Dual RS-485 Interface Module. The Model 8203 provides 2 EIA-485 data busses which can interface to a maximum of 16 MTS MTG gauges per bus. A MG5000 point is needed for each tank being monitored. To use this point, you must have a Tank Gate Interface with the Model 8203 Dual RS-485 Interface Module with MDTGx_xx series firmware, version MDTG1_10 or later. 5.7.1 Parameters The database parameters used by the MG5000 point are listed and described below: i Configuration Parameters Function Tag A Tag can contain 15 bytes of data and can include any printable ASCII character. Tags can be used to identify the name of the tank being monitored The default tag is set to the number, i.e., point 0 = “MG5000.00”. Description The point description can contain 30 bytes of data and can include any printable ASCII character. Descriptions can be used as information relevant to any aspect of the point, such as its use, location, operating information, etc. The default description is set to “MG5000.00” Chan 8203 channel. ID Physical Address (0x01-0xF7) [decimal equivalent 1 - 274]. The default is 0xF7. LevelUnits Specifies the engineering units for the level data. F: feet m: Millimeters M: Meters I: Inches The LevelUnits needs to match the units specified during the gauge setup. The Level can be converted from Metric to English (or vice-versa) by setting the LevelConvert parameter in the appropriate MSCAN or RKSCN point. LevelConvert Determines the units in which the level data will be displayed. F: Feet M: Meters Default is F. TempUnits Specifies the engineering units for the temperature data. F: Fahrenheit C: Celsius The TempUnits needs to match the units specified during the gauge setup. The Temp can be converted from Metric to English (or vice-versa) by setting the TempConvert parameter in the appropriate MSCAN or RKSCN point. Varec, Inc. 65 Tank Gate Interface Configuration Parameters Function TempConvert Determines the units in which the temperature data will be displayed. F: Fahrenheit C: Celsius If no value is specified, no conversion will be performed. The default is F. TempOffset Specified the amount of offset to add to the Temperature. The default is 0. WaitResp This is a floating point number which scales the time period calculated for the MTS MTG gauge to respond after performing level and temperature calculations. If the gauge is slow in performing calculations and responding, this value can be incremented to avoid time-outs. The default is 1.0 which represents 100%. TempDeadband Change of state temperature deadband value. If the temperature changes by a value greater than or equal to the TempDeadband, a Change of State occurs and the host is automatically notified. If the temperature change is less than the TempDeadband, then no Change of State occurs. The TempDeadband does not affect the Temp value read, only the automatic notification to the Host system. The default is 0.25. LevelDeadband Change of state level deadband value. If the level changes by a value greater than or equal to the LevelDeadband, a Change of State occurs and the host is automatically notified. If the level change is less than the LevelDeadband, then no Change of State occurs. The LevelDeadband does not affect the Level value read, only the automatic notification to the Host system. The default is 0. Report Causes automatic notification to the Host (in response to a Change of State Request) when the Value Changes State. Parameter value can be High, Low or No. Report=No disables notification. Points with Report = High will be sent before points with Report = Low. The default is High. Maxtime Specifies the maximum time (in secs) between automatic Change of State data being sent to the Host in response to a Change of State Request. Report must be set to either Low or High for the Value parameter to be sent in response to a Change of State Request. A value of 0 disables this option. Non-zero values cause responses to be sent even if the value has not changed since the last message. The maximum is 65535 seconds. The default is 120. Watchdog Enables the Motherboard watchdog task for the MG5000 point. The watchdog task monitors the MG5000 point and verifies it is scanning for gauges. If the MG5000 point stops execution, the PntStatus will be set to 0x4000 to indicate a failure. Dynamic Parameters Function TestCmd MTS MTG test commands. Valid commands are: 0x02: change gauge address 0x41: RAM Read / Write Test 0x42: ROM data checksum test 0x44: EEPROM Data Checksum Test 0x45: Counter Integrity Test 0x46: Analog Converter Test 0x47: Communication Hardware Test 0x48: Waveguide Driver / Amplifier / Comparator Test When these test are completed the ReplyData parameter will display an ‘OK’, ‘ABCDE...’, or an error code ‘Exxx.’ 66 Installation and Operations Manual 8303 Dynamic Parameters ReadCmd Function MTS MTG High level memory read commands. Valid commands are: 0x4B: Read number of floats and number of RTDs. 0x4C: Read gradient control variable. 0x4D: Read float zero position data. 0x4E: Read RTD position data. 0x4F: Read factory serial number and software version data 0x50: Read firmware control code 0x51: Read hardware control code When these test are completed the ReplyData parameter will display the data transmitted from the MTS MTG gauge. WriteCmd MTS MTG High level memory write commands. These commands are used in conjunction with the WriteData parameter to write data to the MTS MTG gauge. The data must first be written in the proper format to the WriteData parameter, then the WriteCmd can be executed. Valid commands are: 0x55: Write number of floats and number of RTDs. 0x56: Write gradient control variable. 0x57: Write float zero position data. 0x58: Write float zero position data using MTS MTG calibrate mode. 0x59: Write RTD position data. 0x5A: Write firmware control code 0x5B: Write hardware control code 0x5E: Write (update) reference magnet position Once these test are completed the ReplyData parameter will display the written data. The WriteStatus parameter will display ‘OK’ if the write was completed successfully, or an error code ‘Exxx.’ Varec, Inc. CmdStatus Coded value indicating the status of the current command being issued to the tank. ReplyData The reply from issuing a TestCmd, ReadCmd, or WriteCmd is given in the ReplyData WriteData The data to be written to the MTS MTG gauge issuing a WriteCmd is given in the WriteData WriteStatus Value indicating the status of the WriteCmd being issued to the gauge. Level Floating point value representing the product level measured by the MTS MTG. The value is in feet if the LevelConvert parameter of the associated MSCAN point is ‘F’. To convert to meters, set the LevelConvert parameter of the MSCAN point to ‘M’. The default is decimal feet. WaterLevel Floating point value representing the product water interface level. The value is in feet if the LevelConvert parameter of the associated MSCAN point is ‘F’. To convert to meters, set the LevelConvert parameter of the MSCAN point to ‘M’. The default is decimal feet. Temp Floating point value representing the product average temperature calculated by the MTS MTG. The value is in degrees Fahrenheit if the TempConvert parameter of the associated MSCAN point is ‘F’. To convert to Celsius, set the TempConvert parameter of the MSCAN point to ‘C’. RTD1 Floating point value representing the temperature measured by the MTS MTG from RTD1. The value is in degrees Fahrenheit if the TempConvert parameter of the associated MSCAN point is ‘F’. To convert to Celsius, set the TempConvert parameter of the MSCAN point to ‘C’. RTD2 Floating point value representing the temperature measured by the MTS MTG from RTD2. RTD3 Floating point value representing the temperature measured by the MTS MTG from RTD3. 67 Tank Gate Interface Dynamic Parameters Function RTD4 Floating point value representing the temperature measured by the MTS MTG from RTD4. RTD5 Floating point value representing the temperature measured by the MTS MTG from RTD5. PntStatus Integer HEX value indicating status of point. Values are: 0: No Error 0x0001: Gauge not responding 0x0002: Data from gauge is invalid (CRC or Parity error) 0x0004: Invalid command 0x4000: Failure of the Model 8203. This bit is set if the Watchdog task on the Motherboard determines that the Model 8203 has stopped updating. 5.7.2 ErrorCode Displays MTS MTG Error Codes. The format is ‘E’ followed by the code number (Exxx). Elapse Time of last scan. PntCheckSum Database Checksum for point's static Configuration Parameters. Application The MG5000 point continually scans data from an associated MTS Magnetostrictive Tank Gauge (MTG). Each MG5000 point corresponds to a gauge connected to the Model 8203 Dual RS-485 Interface Module programmed with the MDTGx_xx series firmware. The ID must be assigned to the MTS MTG gauge address. The Chan parameter must be set to the channel number (1 or 2) of the physical connector on the Model 8203 to which the gauge is connected. 68 Installation and Operations Manual 8303 5.8 Modbus Floating Point Register (MFPREG) The Modbus Floating Point Register point provides an interface to Modbus compatible slave devices. When used with an MSCAN point, the MFPREG connects to up to four blocks of floating point data, allowing access to a total of 64 register values. 5.8.1 Parameters The database parameters used by the MFPREG point are listed and described below: Configuration Parameters Function Tag A Tag can contain 15 bytes of data and can include any printable ASCII character. Tags can be used to identify points indicating the use of the point such as “Modbus Slave” or “Register Value1.” The default tag is set to “MFPREG.00” Chan Physical channel number the slave device is connected to. On the 8203 Dual RS-485 Communications Interface Module, the Chan can be set to 1 or 2. On the 8303 TGI motherboard, the Chan can be set to 0, 1 or 2. BaudRate Baud Rate for communications to the Slave device. Valid values are: 1200, 2400, 2400, 9600 and 19200. The BaudRate is set prior to scanning the device ComParams Defines the number of data bits and the parity used by the com port. Valid values include: 8N - 8 data bits, No parity 8O - 8 data bits, Odd parity 8E - 8 data bits, Even parity 7O - 7 data bits, Odd parity 7E - 7 data bits, Even parity The default is ‘8N’. ID Slave Address of the device to be scanned. Mode HEX byte value for the Operational Mode: 0x01 – Swap mode ReadCmd Command to use to Read data from the slave device WriteCmd Command to use to Write data to the slave device Data Address and Block Size pairs. The MFPREG point will read data from the slave device, starting at Addr1 and request Size1 registers. Up to four blocks may be defined. If the Size is zero, then no read operation is performed. The data is returned to the Value array. Addr1, Size1 Addr2, Size2 Addr3, Size3 Addr4, Size4 Varec, Inc. Report Causes automatic notification to the Host (in response to a Change of State Request) when the Value Changes State. Parameter value can be High, Low or No. No disables notification. Points with Report = High will be sent before points with Report = Low. The default is High. Maxtime Specifies the maximum time (in secs) between automatic Change of State data being sent to the Host in response to a Change of State Request. Report must be set to either Low or High for the Value parameter to be sent in response to a Change of State Request. A value of 0 disables this option. Non-zero values cause responses to be sent even if the value has not changed since the last message. The maximum is 65535 seconds. The default is 600. 69 Tank Gate Interface Dynamic Parameters Function Value0 Value63 Register values from slave device. Value0 will always correspond to the first register read from the slave device using the Addr1 and Size1 parameters. You can read up to 64 registers from the slave device. The meaning of the Value array depends upon the definition of the blocks. PntStatus Byte value indicating status of point Values are: 0x0000: No Error 0x0001: No Response from Device 5.8.2 Elapse Time of the last request from the master PntCheckSum CRC-16 Checksum of point's static Configuration Parameters Application The MFPREG point continually scans Modbus slave devices, using the ID parameter. Chan determines which 8203 Dual RS-485 Communications Interface Module Channel is used for communications to the slave device. An MFPREG point is needed for each device connected to the 8303 TGI. Up to 64 registers may be read with each MFPREG point. Multiple MFPREG points can be used with a single slave device if necessary. The BaudRate and ComParams values must match the communications parameters of the slave device. The communications parameters are set as each MFPREG point is processed. This allows slaves with different baud rates and data link settings to exist on the same bus (not recommended). 8203 TGI software points may begin scanning when the point is created, or when the correct Channel number is assigned. Which of these events begins the scanning process varies with each point. A total of four blocks may be read or written. The ReadCmd determines the command to read data and the WriteCmd is the command used for write operations. The Addr and Size parameters determine the addresses. Set the Addr1 and Size1 parameters to read a data block from the slave device. The response will be placed in the Value0 - Value63 parameters. For example, if Addr1 = 100 and Size1 = 10, then the MFPREG point will read 10 register values and place the data in Value0 - Value9. If a second block is defined, then the data response will start in Value10. If the Size is 0, then that block is disabled. The Mode parameter can be used to swap the byte order of the floating point values. 70 Installation and Operations Manual 8303 5.9 Modbus Scanner (MSCAN) The Modbus Scanner point provides communication between the 8303 TGI and Modbus compatible slave devices represented by MG5000, MIREG, MFPREG, or any other Modbus slave interface points. It includes parameters for configuring that communication, and It provides dynamic and statistical information related to connected devices. Two MSCAN points (one for each channel) are automatically created when the motherboard detects the Model 8203. 5.9.1 Parameters The database parameters used by the MSCAN point are listed and described below: Configuration Parameters Function Chan The physical channel (J2 or J4) used on the Model 8203. One MSCAN point is created automatically for each channel by the system. The Chan parameter is set in each MSCAN point and should not be changed. For more information about the Model 8203 COM channels, see section 2.2.3 on page 10. MaxRetry Value between 1-10 indicating the number of times the scanner will retry a request to a slave device. Default is 2. Timeout Time (in milliseconds) that a Device must respond to a request. Default is 2000. ScanDelay Time in milliseconds for the delay between scans. The default is 500. BaudRate Baud Rate for communications to the slave device. Valid values are: 1200, 2400, 4800, 9600 and 19200. LevelConvert Determines the units in which the level data will be displayed. F: Feet M: Meters Default is F. TempConvert Determines the units in which the temperature data will be displayed. F: Fahrenheit C: Celsius If no value is specified, no conversion will be performed. The default is F. DensityConvert Determines the units in which the density data will be displayed. A: API L: lbs/cu ft K: kgs/m3. If no value is specified, no conversion will be performed. The default setting for this point is A. Varec, Inc. Dynamic Parameters Function ScanCmd Allows the user to Enable, Disable, or Reset Scanning. ID Address of slave device. 71 Tank Gate Interface Dynamic Parameters Function Cmd Current command. Values include: 1 - Read Output Status 2 - Read Input Status 3 - Read Output Registers 4 - Read Input Registers 5 - Force Single Coil 6 - Preset Single Register 15 - Force Multiple Coils 16 - Preset Multiple Registers 5.9.2 Pnt Point currently being scanned. Examples include the MG5000, MIREG or MFPREG points. NumRequests Number of scan requests since the last reset NumTrans Number of completed transactions NumComErrors Number of requests with communications or context errors. NumTimeouts Number of requests that did not receive a response. NumScanList Number of devices in the Scan List PntCheckSum CRC-16 Checksum of point's static Configuration Parameters Application The MSCAN point provides status information for the communications with any Modbus devices used with the 8303 TGI or the 8212 TRL/2. For the Model 8203, two MSCAN points are created at initialization when the motherboard detects the Model 8203. The point number created for each MSCAN point will correspond to the following table (the Module number is 1): Channel Point Number Chan 1 MSCAN.01 Chan 2 MSCAN.02 Note The 8212 TRL/2 only has ONE MSCAN. Chan 1 is MSCAN.01. Use the Upload command from the Config Menu to retrieve the data from the MSCAN point or any other points created automatically by the 8303 TGI. The MSCAN point acts as a Modbus Master Protocol Handler (MSCAN) and works in conjunction with MIREG, MFPREG, MG5000, and other Modbus slave points. The Modbus Master Protocol Handler (MSCAN) sequentially processes these points, issuing data requests according to the ID, Addr and Size parameters. The MSCAN point provides dynamic information regarding the current request and total number of requests and errors. The Chan parameters of the Modbus slave interface points must correspond with the Chan parameters of the applicable MSCAN point. For example, assume that switch SW1 on the Model 8203 is set to address 1. If a MTS MTG gauge is physically connected to terminal connector J2 (COM Channel A) on the Model 8203, the MG5000 point for that gauge must be set to Chan 1. The NumRequests parameter gives the total number of requests attempted, while the NumTrans gives the number of completed transactions. The ID represent the current device address being scanned. The Pnt parameter is the Tag of the point being scanned. 72 Installation and Operations Manual 8303 5.10 SAAB REX Radar (REX) The The Saab REX Radar Gauge point provides an interface to Saab REX Radar Gauges. The REX point interfaces to Saab 3900 Series REXs using Modbus. If communicating directly to the gauge, the REX point executes on the 8212 Saab TRL/ 2 Interface. The REX point can also be used with a Saab FCU. The 8203 Dual RS-485 Interface Module can be used to read tank data from the Saab FCU. 5.10.1 Parameters The database parameters used by the REX point are listed and described below: Config Parameters Function Tag A Tag can contain 15 bytes of data and can include any printable ASCII character. Tags can be used to identify the name of the tank being monitored. The default tag is set to “REX.00”. Description The point description can contain 30 bytes of data and can include any printable ASCII character. Descriptions can be used as information relevant to any aspect of the point, such as its use, location, operating information, etc. The default description is set to “REX.00”. WMSeal Coded Value that enables Weights & Measures password protection. Chan Communications channel to which the gauge is connected. For an 8203 Dual RS-485 Communications Interface Module Chan is either 1 or 2. ID Physical Address of the tank gauge transmitter (0-999). Addr FCU Address (if Mode = 0x02) LevelUnits Specifies the engineering units for the level data. s: sixteenths m: millimeters The LevelUnits needs to match the units specified during the gauge setup. Default is m. LevelConvert Determines the units in which the level data will be displayed. F: Feet m: millimeters Default is m. TempUnits Specifies the engineering units for the temperature data. F: Fahrenheit C: Celsius The TempUnits needs to match the units specified during the gauge setup. The Temp can be converted from Metric to English (or vice-versa) by setting the TempConvert parameter in the appropriate MSCAN or RKSCN point. TempConvert Determines the units in which the temperature data will be displayed. F: Fahrenheit C: Celsius If no value is specified, no conversion will be performed. The default is C. Varec, Inc. AI1LowRange Analog Input #1 Low Range. AI1HighRange Analog Input #1 High Range AI2LowRange Analog Input #2 Low Range. AI2HighRange Analog Input #2 High Range AI3LowRange Analog Input #3 Low Range. 73 Tank Gate Interface Config Parameters Function AI3HighRange Analog Input #3 High Range ValueMin Minimum Analog Input Integer Value ValueMax Maximum Analog Input Integer Value LevelDeadband The LevelDeadband sets the deadband for the Change of State mode. The default is 0.1. Mode Parameter used to control the operation of the AT4530 point. 0x100 - AT4530 is connected to a SG6000 (Not a TM4590) Temperature Floating point value representing the product temperature. The data is returned in the format specified during the configuration of the gauge. BaudRate 8203 Dual RS-485 Communications Interface Module: Valid values are: 4800. The default is 4800. ComParams Defines the number of data bits and the parity used by the com port. Valid values include: 8N - 8 data bits, No parity 8O - 8 data bits, Odd parity 8E - 8 data bits, Even parity 7O - 7 data bits, Odd parity7E - 7 data bits, Even parity The default is 8N. 74 Report Causes automatic notification to the Host (in response to a Change of State Request) when the Level, Temp, Position changes. Parameter value can be High, Low or No. Report=No disables automatic notification. Points with Report = High will be sent before points with Report = Low. The default is High. MaxTime Specifies the maximum time (in secs) between automatic Change of State responses being sent to the Host. Report must be set to either Low or High for the Value parameter to be sent in response to a Change of State Request. A value of 0 disables this option. Non-zero values cause responses to be sent even if the value has not changed since the last message. The maximum is 65535 seconds. The default is 600. Watchdog Enables the watchdog task on the Motherboard. The watchdog task monitors the MBMFT point on the 8203 Dual RS-485 Communications Interface Module and verifies it is scanning for gauges. If the 8203 Dual RS-485 Communications Interface Module fails, the 0x0010 and the 0x0001 bits of the PntStatus will be set to indicate the failure. Installation and Operations Manual 8303 Dynamic Parameters Function Level IEEE Floating point value representing the tank level. The data is returned in the format specified during the configuration of the gauge. GaugeStatus Integer value indicating status of the gauge (Integer Register 6). Values are: 0x0001: Bad Level 0x0002: Bad Temp 0x0004: Bad EE 0x0008: Bad EE Checksum 0x0010: Bad RAM 0x0020: Bad EEPROM 0x0040: Local Modifications 0x0080: No Calculation 0x0100: CFG Error 0x0200: Calc Error 0x0400: Bad CPU Board 0x0800: Bad Comm Board 0x1000: Low Encoder Battery Rate Level Rate. TankLevel Tank Level. Ullage Measured Distance. Distance from radar to product. Analog1 through Analog3 4 to 20 mA value % Temp1 through Temp5 Floating point value representing the product temperature at various levels. The data is returned in the format specified during the configuration of the gauge. Temp1-Temp16 can be converted from Metric to English (or vice-versa) by setting the TempConvert parameter of the appropriate MSCAN or RKSCN point. TempFilter Temp in Liquid parameter. Bits 0 – 13 indicate if Temp sensors 1 – 14 are submerged in liquid. Bit 14 indicates a System Error. Bit 15 indicates a Temp calibration error. 0x0001: Temp 1 is in Liquid 0x0002: Temp 2 is in Liquid 0x0004: Temp 3 is in Liquid 0x0008: Temp 4 is in Liquid 0x0010: Temp 5 is in Liquid 0x0020: Temp 6 is in Liquid 0x0040: Temp 7 is in Liquid 0x0080: Temp 8 is in Liquid 0x0100: Temp 9 is in Liquid 0x0200: Temp 10 is in Liquid 0x0400: Temp 11 is in Liquid 0x0800: Temp 12 is in Liquid 0x1000: Temp 13 is in Liquid 0x2000: Temp 14 is in Liquid 0x4000: System Error 0x8000: Temp Calibration error Varec, Inc. 75 Tank Gate Interface Dynamic Parameters Function TempStatus Temp status parameter (blocked). This parameter indicates the blocked status of each temperature sensor. 0x0001: Temp 1 blocked 0x0002: Temp 2 blocked 0x0004: Temp 3 blocked 0x0008: Temp 4 blocked 0x0010: Temp 5 blocked 0x0020: Temp 6 blocked 0x0040: Temp 7 blocked 0x0080: Temp 8 blocked 0x0100: Temp 9 blocked 0x0200: Temp 10 blocked 0x0400: Temp 11 blocked 0x0800: Temp 12 blocked 0x1000: Temp 13 blocked 0x2000: Temp 14 blocked 0x4000: Legal NMI-temperature 0x8000: NMI approved DAU TempDiagCode Temp diagnostic code parameter. This parameter indicates the error status of each temperature sensor. 0x0001: Temp 1 error 0x0002: Temp 2 error 0x0004: Temp 3 error 0x0008: Temp 4 error 0x0010: Temp 5 error 0x0020: Temp 6 error 0x0040: Temp 7 error 0x0080: Temp 8 error 0x0100: Temp 9 error 0x0200: Temp 10 error 0x0400: Temp 11 error 0x0800: Temp 12 error 0x1000: Temp 13 error 0x2000: Temp 14 error 0x4000: Master (set if using an FCU and DAU does not respond) 0x8000: Temp average error. No temperature sensor is in liquid. 76 Temp Floating point value representing the average product temperature. The data is returned in the format specified during the configuration of the gauge. Elapse Time of the last scan Installation and Operations Manual 8303 Dynamic Parameters Function PntStatus Byte value indicating status of point. Values are: 0x0000: No error 0x0001: Gauge Not Responding 0x0010: FCU is offline (if Mode =0x02) 0x1000: Weights & Measure Seal is Enabled 0x4000: Failure of the Model 8212. This bit is set if the Watchdog task on the Motherboard determines that the Model 8212 has stopped updating. PntCheckSum CRC-16 Checksum for point’s static Configuration Parameters. WMCheckSum Weights and Measures Checksum. This parameter is calculated when the WMSeal parameter is set to enable. 5.10.2 Application The REX point provides an interface to Saab Radar Tank Gauges (REX) using two methods: •Directly to the TRL/2 bus using a Model 8212 •Via an FCU, using a Model 8203 (MODx_xx firmware) Model 8212 TRL/2 Interface The Model 8212 provides the means to connect directly to the TRL/2 bus. The Model 8212 is automatically detected at startup, and an MSCAN point is automatically created to manage the scanning task. The Module and Chan determine which Module and Channel are used for communications to the slave device. Module = 1 corresponds to the Model 8212 set to address 1, Module = 2 corresponds to the Model 8212 set to address 2, etc. The Chan parameter must match the channel used to communicate with the Saab REX. Model 8203 Dual RS-485 Interface If the REX Gauges are connected to a Saab FCU, then a Model 8203 is used to read data, The Model 8203 is automatically detected at startup, and an MSCAN point is automatically created to manage the scanning task. The Module and Chan determine which Module and Channel are used for communications to the slave device. Module = 1 corresponds to the Model 8203 set to address 1, Module = 2 corresponds to the Model 8203 set to address 2, etc. The Chan parameter must match the channel used to communicate with the Saab REX. An REX point is needed for each device connected to the 8130 RTU. The ID must match the unit address of the Saab REX. Scanning begins when the Module is assigned. The BaudRate and ComParams values must match the communications parameters of the Radar Tank Gauge. The communications parameters are set as each REX point is processed. The REX point works in conjunction with the Modbus Master protocol handler. MSCAN points are automatically created and the user only has to set the Module, Chan, BaudRate, ComParams and ID parameters in order to establish communications with the Saab REX. The Mode parameter determines whether the REX point reads the data from the Saab FCU’s holding registers. If the Mode is 0x02, then the data is read from the holding registers. The Addr parameter determines the FCU address and the ID is not used. If the Mode is 0, then the FCU sends the request to the REX and sends the response back to the 8130 RTU. The ID is used and the Addr parameter is ignored. This mode is sometimes referred to as “pass-through’ mode. Weights & Measures Protection The REX point can be sealed when used in a Weights & Measures application. Only certain parameters can be sealed. These parameters will be shown in blue (CONSTANT parameters) Varec, Inc. 77 Tank Gate Interface when unlocked and will be greyed out when locked. To seal the point, set the WMSeal to Enable. Note that FuelsManager must be active in order to seal or unseal a point. 78 Installation and Operations Manual 8303 5.11 Varec 7xxx Radar Tank Gauge (RG7000) The RG7000 point provides an interface to the Micropilot FMR radar gauge. This point provides level and interface information. Other information, such as point and gauge status, is also available in this Software Block. This point does not communicate directly to the FMR radar gauge. All communication must be made via a Varec 4590 Tank Side Monitor (TSM) (TM4590). 5.11.1 Parameters The database parameters used by the RG7000 point are listed and described below: Config/Constant Parameters Function WMSeal Coded parameter value that enables Weights & Measures password protection. Tag A Tag can contain 15 bytes of data and can include any printable ASCII character. Tags can be used to identify points indicating the use of the point such as “Tank 22.” The default tag is set to “RG7000.00”. Chan Communications channel to which the gauge is connected. For a 8203 Dual RS485 Communications Interface Module Chan is either 1 or 2. ID The Device ID of the TM4590 connected to the RG7000 radar. BaudRate Baud Rate for communications to the Slave device. Valid values are: 1200, 2400, 4800, 9600 and 19200 . The default is 9600. ComParams Defines the number of data bits and the parity used by the com port. Valid values include: 8N - 8 data bits, No parity 8O - 8 data bits, Odd parity 8E - 8 data bits, Even parity 7O - 7 data bits, Odd parity 7E - 7 data bits, Even parity The default is 8N. Varec, Inc. Mode Parameter used to control the operation of the RG7000 point. Default is 0x0000. LevelDeadband The LevelDeadband sets the deadband for the Change of State mode. The default is 0. Report Causes automatic notification to the Host (in response to a Change of State Request) when a Value Changes State. Parameter values can be High, Low or No. Report=No disables notification. Points with Report= High will be sent before points with Report = Low. Default is High. Maxtime Specifies the maximum time (in secs) between automatic Change of State responses being sent to the Host. Report must be set to either Low or High for the Value parameter to be sent in response to a Change of State Request. A value of 0 disables this option. Non-zero values cause responses to be sent even if the value has not changed since the last message. The maximum is 65535 seconds. The default is 240. Watchdog Enables the watchdog task on the Motherboard. The watchdog task monitors the RG7000 point on the 8203 Dual RS-485 Communications Interface Module and verifies it is scanning for gauges. 79 Tank Gate Interface Dynamic Parameters Function Level IEEE Floating point value representing the corrected tank level. The data is returned in the format specified during the configuration of the gauge. Status Hart Command 48 Status. Refer to manufacturer for additional information. Level1 Floating point value representing the uncorrected tank level. Ullage Measured Distance. Distance from radar to product. CustodyMode Weights & Measures Status MediaType Dielectric constant (DC) of the product. Device Status TM4590 Internal Status Elapse Time of last scan. Interval Amount of time (in HR:MIN:SEC) between scans of the gauge PntStatus Byte value indicating status of point. Values are: 0x0000: No Error 0x0001: No Response from Device 0x1000: W&M Seal is enabled 0x4000: Failure of the 8203 Dual RS-485 Communications Interface Module. This bit is set if the Watchdog task on the Motherboard determines that the 8203 Dual RS-485 Communications Interface Module has stopped updating. PntCheckSum CRC-16 Checksum for point’s static Configuration Parameters. WMChecksum Weights & Measures Checksum. This parameter is calculated when the WMSeal parameter is set to Enable. 5.11.2 Application The Varec 7xxx Series Radar Tank Gauge (RTG) (RG7000) point must communicate via a Varec 4590 Tank Side Monitor (TSM) (TM4590). All communication parameters such as ID, Chan, BaudRate, etc., must be set to communicate to the TSM. Once communication is established through the TM4590, the RG7000 point then automatically retrieves all data. Modbus Protocol Using the Modbus Protocol, RG7000s are connected to a 8303 Dual RS-485 Communications Interface Module Dual RS-485 Module configured with Modbus firmware (MDTGx_xx). The 8203 Dual RS-485 Communications Interface Module is automatically detected at startup, and a MSCAN point is automatically created to manage the scanning task. The Chan parameter determines to which channel on the 8203 module the tank gauge is connected. The ID must match the Device ID of the Varec 4590 Tank Side Monitor (TSM) (TM4590) connected to the RG7000. 8203 TGI software points may begin scanning when the point is created, or when the correct Channel number is assigned. Which of these events begins the scanning process varies with each point. Weights & Measures Protection The RG7000 point can be sealed when used in a Weights & Measures application. Only certain parameters can be sealed. These parameters will be shown in blue (CONSTANT parameters) when unlocked and will be grayed out when locked. To seal the point, set the WMSeal to Enable. Note that FuelsManager must be active in order to seal or unseal a point. 80 Installation and Operations Manual 8303 5.12 Saab Radar Tank Gauge (RTG) The Saab Radar Tank Gauge point provides an interface to Saab Radar Tank Gauges. The RTG point interfaces to Saab 2920, 2930, 2940, 2960, 3920. 3930, 3940 and 3960 RTGs using Modbus. The RTG point executes on the 8312 Saab (TRL/2) Interface Module . The RTG point can also be used with a Saab FCU. The 8203 Dual RS-485 Interface Module can be used to read tank data from the Saab FCU. 5.12.1 Parameters The database parameters used by the RTG point are listed and described below: Configuration Parameters Function Tag A Tag can contain 15 bytes of data and can include any printable ASCII character. Tags can be used to identify the name of the tank being monitored. The default tag is set to “RTG.00”. Description The point description can contain 30 bytes of data and can include any printable ASCII character. Descriptions can be used as information relevant to any aspect of the point, such as its use, location, operating information, etc. The default description is set to “RTG.00”. WMSeal Coded value that enables Weights & Measures password protection. Module Not used. Chan Physical channel number the RTG is connected to. On the 8312 Saab (TRL/2) Interface Module or 8303 Dual RS-485 Communications Interface Module, the Chan can be set to 1 or 2. ID Physical Address of the tank gauge transmitter (0-999). Addr FCU Address (if Mode = 0x02) LevelConvert Convert Level to standard F: Feet M: Meters m: millimeters. Default is millimeter. Varec, Inc. LevelDeadband The LevelDeadband sets the deadband for the Change of State mode. The default is 0.1. AI1LowRange Analog Input #1 Low Range. AI1HighRange Analog Input #1 High Range AI2LowRange Analog Input #2 Low Range. AI2HighRange Analog Input #2 High Range AI3LowRange Analog Input #3 Low Range. AI3HighRange Analog Input #3 High Range ValueMin Minimum Analog Input Integer Value ValueMax Maximum Analog Input Integer Value LevelUnits Specifies the engineering units for the level data. F: feet, m: Millimeters, s: sixteenths of inches. The LevelUnits needs to match the units specified during the gauge setup. The Level can be converted from Metric to English (or vice-versa) by setting the LevelConvert parameter . 81 Tank Gate Interface Configuration Parameters Function Mode Parameter used to control the operation of the TM4590 point. It has different meanings, depending on whether the 8303 Dual RS-485 Communications Interface Module is used. 8303 Dual RS-485 Communications Interface Module: 0x0010: Use old NMS operational status codes 8211 Current Loop (Whessoe Bus) Interface Module: Mode 0: Task 1, Task 36, Task 17, Task 30 Mode 0x01: Task 1 only Mode 0x02: Task 36 only Mode 0x04: Task 17 only Mode 0x08: Task 30 only BaudRate Baud Rate for communications to the Slave device. 8203 Dual RS-485 Communications Interface Module: Valid values are: 4800 The default is 4800. 8211 Current Loop (Whessoe Bus) Interface Module: Valid values are: 1200, 2400. ComParams Defines the number of data bits and the parity used by the com port. Valid values include: 8N - 8 data bits, No parity 8O - 8 data bits, Odd parity 8E - 8 data bits, Even parity 7O - 7 data bits, Odd parity7E - 7 data bits, Even parity The default is 8N. 82 Report Causes automatic notification to the Host (in response to a Change of State Request) when the Level, Temp, Position changes. Parameter value can be High, Low or No. Report=No disables automatic notification. Points with Report = High will be sent before points with Report = Low. The default is High. MaxTime Specifies the maximum time (in secs) between automatic Change of State responses being sent to the Host. Report must be set to either Low or High for the Value parameter to be sent in response to a Change of State Request. A value of 0 disables this option. Non-zero values cause responses to be sent even if the value has not changed since the last message. The maximum is 65535 seconds. The default is 600. Watchdog Enables the watchdog task on the Motherboard. The watchdog task monitors the MBMFT point on the 8203 Dual RS-485 Communications Interface Module and verifies it is scanning for gauges. If the 8203 Dual RS-485 Communications Interface Module fails, the 0x0010 and the 0x0001 bits of the PntStatus will be set to indicate the failure. Dynamic Parameters Function Level IEEE Floating point value representing the tank level. The data is returned in the format specified during the configuration of the gauge. Installation and Operations Manual 8303 Dynamic Parameters Function GaugeStatus Integer value indicating status of the gauge (Integer Register 6). Values are: 0x0001: Bad Level 0x0002: Bad Temp 0x0004: Bad EE 0x0008: Bad EE Checksum 0x0010: Bad RAM 0x0020: Bad EEPROM 0x0040: Local Modifications 0x0080: No Calculation 0x0100: CFG Error 0x0200: Calc Error 0x0400: Bad CPU Board 0x0800: Bad Comm Board 0x1000: Low Encoder Battery Rate Level Rate TankLevel Tank Level Ullage Ullage Analog1 Analog Current 1 Analog2 Analog Current 2 Analog3 Analog Current 3 PntStatus Byte value indicating status of point. Values are: 0x0000: No error 0x0001: Gauge Not Responding 0x0010: FCU is offline (if Mode =0x02) 0x1000: Weights & Measure Seal is Enabled 0x4000: Failure of the 8312 Saab (TRL/2) Interface Module . This bit is set if the Watchdog task on the Motherboard determines that the 8312 Saab (TRL/2) Interface Module has stopped updating. Elapse Time of the last scan WMCheckSum Weights and Measures Checksum. This parameter is calculated when the WMSeal parameter is set to enable. PntCheckSum CRC-16 Checksum for point's static Configuration Parameters 5.12.2 Application The RTG point provides an interface to Saab Radar Tank Gauges (RTG) using two methods: • Directly to the TRL/2 bus using a 8312 Saab (TRL/2) Interface Module • Via an FCU, using a 8303 Dual RS-485 Communications Interface Module (MDTGx_xx firmware) 8312 Saab (TRL/2) Interface Module The 8312 Saab (TRL/2) Interface Module provides the means to connect directly to the TRL/2 bus. The 8212 Saab (TRL/2) Interface Module is automatically detected at startup, and an MSCAN point is automatically created to manage the scanning task. Chan determines which Channel is used for communications to the slave device. The Chan parameter must match the channel used to communicate with the Saab RTG. Varec, Inc. 83 Tank Gate Interface 8303 Dual RS-485 Communications Interface Module If the Radar Tank Gauges are connected to a Saab FCU, then a 8303 Dual RS-485 Communications Interface Module is used to read data, The 8303 Dual RS-485 Communications Interface Module is automatically detected at startup, and an MSCAN point is automatically created to manage the scanning task. Chan determines which Channel is used for communications to the slave device. The Chan parameter must match the channel used to communicate with the Saab RTG. 8303 TGI software points may begin scanning when the point is created, or when the correct Channel number is assigned. Which of these events begins the scanning process varies with each point. An RTG point is needed for each device connected to the 8303 TGI. The ID must match the unit address of the Saab RTG. The BaudRate and ComParams values must match the communications parameters of the Radar Tank Gauge. The communications parameters are set as each RTG point is processed. The RTG point works in conjunction with the Modbus Master Protocol Handler (MSCAN). MSCAN points are automatically created and you only have to set the Chan, BaudRate, ComParams and ID parameters in order to establish communications with the Saab RTG. The Mode parameter determines whether the RTG point reads the data from the Saab FCU’s holding registers. If the Mode is 0x02, then the data is read from the holding registers. The Addr parameter determines the FCU address and the ID is not used. If the Mode is 0, then the FCU sends the request to the RTG and sends the response back to the 8303 TGI. The ID is used and the Addr parameter is ignored. This mode is sometimes referred to as “pass-through’ mode. Weights & Measures Protection The RTG point can be sealed when used in a Weights & Measures application. Only certain parameters can be sealed. These parameters will be shown in blue (CONSTANT parameters) when unlocked and will be grayed out when locked. To seal the point, set the WMSeal to Enable. Note that FuelsManager must be active in order to seal or unseal a point. 84 Installation and Operations Manual 8303 5.13 Varec 6000 Servo Gauge (STG) Interface (SG6000) The SG6000 point provides an interface to Varec 6000 Servo Tank Gauge transmitter. This point provides level, temperature, interface and density data. Other information, such as point and gauge status, is also available in this Software Block. 5.13.1 Parameters The database parameters used by the SG6000 point are listed and described below: Config/Constant Parameters Function Tag A Tag can contain 15 bytes of data and can include any printable ASCII character. Tags can be used to identify points indicating the use of the point such as “Tank 22.” The default tag is set to “SG6000.00”. WMSeal Coded value that enables Weights & Measures password protection. Chan Communications channel to which the gauge is connected. For an 8203 Dual RS-485 Modbus Communications Interface Module Chan is either 1 or 2. ID The Device ID of the SG6000. Mode Parameter used to control the operation of the SG6000 point. 8203 Dual RS-485 Modbus Communications Interface Module: 0x2- SG6000 Odd Parity 0x400 - SG6000 Even Parity 0x100 - SG6000 Read Density from Average Profile Density 0x1000 - SG6000 Density Profile flag - clear for Modbus For 8211 Whessoe Bus Communications Interface Module: 0x0: Level, Temp, Pressure, % level, Status, Density, ISH 0x01: Status only 0x02: Level, Temp, % Level, Pressure, ISH only 0x04: Density only 0x08: Level, Temp, %level, pressure only LevelUnits Specifies the engineering units for the level data. F: feet m: Millimeters M: Meters I: Inches The LevelUnits needs to match the units specified during the gauge setup. The Level can be converted from Metric to English (or vice-versa) by setting the LevelConvert parameter in the appropriate MSCAN or RKSCN point. TempUnits Specifies the engineering units for the temperature data. F: Fahrenheit C: Celsius The TempUnits needs to match the units specified during the gauge setup. The Temp can be converted from Metric to English (or vice-versa) by setting the TempConvert parameter in the appropriate MSCAN or RKSCN point. Varec, Inc. 85 Tank Gate Interface Config/Constant Parameters Function DensityUnits Specifies the engineering units for the density data. K: kg/m3 A: API L=lbs/cu ft G= g/ml The DensityUnits needs to match the units specified during the gauge setup. The Density can be converted from Metric to English (or vice-versa) by setting the DensityConvert parameter in the appropriate MSCAN or RKSCN point. LevelDeadband The LevelDeadband sets the deadband for the Change of State mode. The default is 0. TempDeadband The TempDeadband is used to set the Change of State deadband for the temperature. The default is .25 degrees. FastScanMode Places the SG6000 point in the Fast Scan mode. Values are Enable or Disable. BaudRate The default is 19200. Report Causes automatic notification to the Host (in response to a Change of State Request) when the Level, Temp, Position changes. Parameter value can be High, Low or No. Report=No disables automatic notification. Points with Report = High will be sent before points with Report = Low. The default is High. Maxtime Specifies the maximum time (in secs) between automatic Change of State responses being sent to the Host. Report must be set to either Low or High for the Value parameter to be sent in response to a Change of State Request. A value of 0 disables this option. Non-zero values cause responses to be sent even if the value has not changed since the last message. The maximum is 65535 seconds. The default is 240. Watchdog Enables the watchdog task on the Motherboard. The watchdog task monitors the SG6000 point and verifies it is scanning for gauges. Dynamic Parameters Function Command The Command parameter allows you to issue a single command to the gauge. Valid commands include: Bottom: Commands the gauge to find and follow the tank bottom Find Wtr Level: Commands the gauge to find the water level (upper interface), then return to product level Run Immed Profile: Commands the gauge to perform a density profile (manual I/F profile) Test: Commands the gauge to perform the Repeatability test Mid Int Level: Commands the gauge to find and follow the middle interface level Middle Density: Commands the gauge to perform a measurement of the middle density Follow Level: Commands the gauge to find and follow the product interface level Raise: Causes the servo to raise Reset: Resets any command issued and commands the servo to Follow Level Stop: Stops the servo from raising or lowering Follow Wtr Lvl: Commands the gauge to find and follow the water interface (upper interface) level Upper Density: Commands the gauge to perform a measurement of the upper density, then return to product level Download: Upload: 86 Installation and Operations Manual 8303 Varec, Inc. Dynamic Parameters Function WriteData The data used in issuing a Download Command is retrieved form the WriteData parameter. Not used on the Modbus SG6000 point. ReplyData The reply data from issuing an Upload Command is stored in the ReplyData parameter. Not used on the Modbus SG6000 point. CmdStatus The status of the Command. The SG6000 point will acknowledge receipt of the command by setting the CmdStatus to Start. When the command has finished, the CmdStatus will be Complete. If it is not possible to perform the command, the CmdStatus will be Error. Level IEEE Floating point value representing the tank level. The data is returned in the format specified during the configuration of the gauge. The Level can be converted from Metric to English (or vice-versa) by setting the LevelConvert parameter of the appropriate MSCAN or RKSCN point. Position Floating point value representing the position of the displacer. The data is returned in the format specified during the configuration of the gauge. The Position can be converted from Metric to English (or vice-versa) by setting the LevelConvert parameter of the appropriate MSCAN or RKSCN point. Temp Floating point value representing the product temperature. The data is returned in the format specified during the configuration of the gauge. The Temp can be converted from Metric to English (or vice-versa) by setting the TempConvert parameter of the appropriate MSCAN or RKSCN point. UpperIntLevel Floating point value representing the upper interface level/water level. This data is obtained with a Find Wtr Level or Follow Wtr Lvl. The UpperIntLevel can be converted from Metric to English (or vice-versa) by setting the LevelConvert parameter of the appropriate MSCAN or RKSCN point. MidIntLevel Floating point value representing the middle interface level. This data is obtained with a Mid Int Level command issued at the servo. The MidIntLevel can be converted from Metric to English (or vice-versa) by setting the LevelConvert parameter of the appropriate MSCAN or RKSCN point. BottomLevel Floating point value representing the tank bottom. This data is obtained with a Bottom command. The BottomLevel can be converted from Metric to English (or vice-versa) by setting the LevelConvert parameter of the appropriate MSCAN or RKSCN point. UpperDensity Floating point value representing the upper product density or average product density. This data is obtained with a Upper Density command or Run Immed Profile. The UpperDensity can be converted from Metric to English (or vice-versa) by setting the DensityConvert parameter of the appropriate MSCAN or RKSCN point. MiddleDensity Floating point value representing the middle product density. This data is obtained with a Middle Density command issued at the servo. The MiddleDensity can be converted from Metric to English (or vice-versa) by setting the DensityConvert parameter of the appropriate MSCAN or RKSCN point. BottomDensity Floating point value representing the bottom product density. This data is obtained with a Bottom Density command issued at the servo. The BottomDensity can be converted from Metric to English (or vice-versa) by setting the DensityConvert parameter of the appropriate MSCAN or RKSCN point. DensityTemp The temperature when a density measurement was made using a Run Immed Profile, Bottom Density, Middle Density or Upper Density command. Elapse Time of last scan. Interval Amount of time (in HR:MIN:SEC) between scans of the gauge DiagCode Diagnostic code 87 Tank Gate Interface Dynamic Parameters Function GaugeStatus. Coded value indicating status of the gauge. The GaugeStatus can have the following values: Upper Int Level - Searching or following the upper interface level Mid Int Level - Searching or following the middle interface level Bottom - Searching or following the bottom Following Level - Displacer is following product level Calibration Act – Automatic gauge calibration is in progress Bottom Density – Measuring the Bottom Density Middle Density – Measuring the Middle Density Upper Density – Measuring the Upper Density Raising – The displacer is raising Stopped – The displacer is stopped Rel Over Tens – The displacer cable tension has exceeded the maximum value PntStatus Byte value indicating status of point. 8203 Dual RS-485 Modbus Communications Interface Module values are: 0x0000: No Error 0x0001: Gauge is offline 0x0002: Data is invalid 0x1000: Weights & Measure Seal is Enabled 0x4000: Failure of the 8203 Dual RS-485 Modbus Communications Interface Module. This bit is set if the Watchdog task on the Motherboard determines that the module has stopped updating. 0x8000: Gauge did not response to last request (pre-fail) For 8211 Whessoe Bus Communications Interface Module values are: 0x10 - Gauge is offline 0x20 - CRC Error 0x40 - Invalid Command 0x80 - Motherboard Watchdog Timeout PntCheckSum CRC-16 Checksum for point’s static Configuration Parameters. WMChecksum Weights & Measures Checksum. This parameter is calculated when the WMSeal parameter is set to Enable. 5.13.2 Application The SG6000 point can operate using one of two protocols: Modbus Protocol Using Modbus, SG6000 tank gauges are connected to a 8203 Dual RS-485 Communications Interface Module configured with Modbus firmware (MDTGx_xx). The 8203 Dual RS-485 Communications Interface Module is automatically detected at startup, and an MSCAN point is automatically created to manage the scanning task. The Chan parameter determines which 8203 Dual RS-485 Communications Interface Module channel will be used. The ID must match the Device ID of the SG6000. Rackbus Protocol Using Rackbus Protocol, SG6000 tank gauges are connected to a 8203 Dual RS-485 Communications Interface Module configured with Rackbus firmware. The 8203 Module is automatically detected at startup, and a RKSCN point is automatically created to manage the scanning task. The Chan parameter determines which channel will be used. The ID must match the Device ID of the SG6000. 88 Installation and Operations Manual 8303 Whessoe Bus Protocol Using Whessoe Bus Protocol, SG6000 tank gauges are connected to a 8211 Current Loop Communications Interface Module configured with Whessoe Bus firmware. The 8211 Module is automatically detected at startup, and a WBSCN point is automatically created to manage the scanning task. The Chan parameter determines which channel will be used. The ID must match the Device ID of the SG6000. General Both interface methods provide a software interface to the Varec 6000 Servo Gauge (STG). 8203 TGI software points may begin scanning when the point is created, or when the correct Channel number is assigned. Which of these events begins the scanning process varies with each point. The LevelUnits and TempUnits must match the engineering units of the gauge. Conversion from Metric to English (or vice-versa) can be performed be setting the LevelConvert and the TempConvert parameters in the MSCAN or RKSCN point associated with the SG6000 point. Commands can be issued to the gauge by setting the Command parameter. You may raise or lower the servo, or read/write information from the gauge’s internal data matrix. Gauge Commands The SG6000 point provides access to the Proservo’s gauge commands, allowing configuration of gauge parameters and control of the servo motor and displacer. SG6000.00: Varec 6000 Servo Gauge (STG) SG6000 Issue gauge command Figure 5-1: Varec 6000 Servo Gauge (STG) Tank Point edit dialog box Weights & Measures Protection The SG6000 point can be sealed when used in a Weights & Measures application. Only certain parameters can be sealed. These parameters will be shown in blue (CONSTANT parameters) when unlocked and will be grayed out when locked. To seal the point, set the WMSeal to Enable. Note that FuelsManager must be active in order to seal or unseal a point. Varec, Inc. 89 Tank Gate Interface 90 Installation and Operations Manual 8303 5.14 Varec 4590 Tank Side Monitor (TSM) Interface (TM4590) The TM4590 point provides an interface to the Varec 4590 Tank Side Monitor. This point provides level, temperature, interface and density data. Other information, such as point and gauge status, is also available in this Software Block. The 4590 TSM can communicate using a number of different protocols, including Modbus & Whessoe Bus. 5.14.1 Parameters The database parameters used by the TM4590 point are listed and described below: Config/Constant Parameters Function WMSeal Coded parameter value that enables Weights & Measures password protection. Tag A Tag can contain 15 bytes of data and can include any printable ASCII character. Tags can be used to identify points indicating the use of the point such as “Tank 22.” The default tag is set to “TM4590.00”. Chan Communications channel to which the gauge is connected. For an 8303 Dual RS485 Communications Interface Module or 8311 Current Loop (Whessoe Bus) Interface Module Chan is either 1 or 2. ID The Device ID of the 4590 TSM. BaudRate Baud Rate for communications to the Slave device. 8203 Dual RS-485 Communications Interface Module: Valid values are: 2400, 4800, and 9600. The default is 9600. 8211 Current Loop (Whessoe Bus) Interface Module: Valid values are: 1200, 2400. ComParams Defines the number of data bits and the parity used by the com port. Valid values include: 8N - 8 data bits, No parity 8O - 8 data bits, Odd parity 8E - 8 data bits, Even parity 7O - 7 data bits, Odd parity7E - 7 data bits, Even parity The default is 8N. Mode Parameter used to control the operation of the TM4590 point. It has different meanings, depending on 8300 TGI is used. 8303 Dual RS-485 Communications Interface Module: 0x0010: Use old NMS operational status codes For 8211 Whessoe Bus Communications Interface Module: 0x0: Level, Temp, Pressure, % level, Status, Density, ISH 0x01: Status only 0x02: Level, Temp, % Level, Pressure, ISH only 0x04: Density only 0x08: Level, Temp, %level, pressure only Varec, Inc. LevelDeadband The LevelDeadband sets the deadband for the Change of State mode. The default is 0. TempDeadband The TempDeadband is used to set the Change of State deadband for the temperature. The default is .25 degrees. FastScanMode Places the TM4590 point in the Fast Scan mode. Values are Enable or Disable. 91 Tank Gate Interface 92 Config/Constant Parameters Function Report Causes automatic notification to the Host (in response to a Change of State Request) when a Value Changes State. Parameter values can be High, Low or No. Report=No disables notification. Points with Report= High will be sent before points with Report = Low. Default is High. Maxtime Specifies the maximum time (in secs) between automatic Change of State responses being sent to the Host. Report must be set to either Low or High for the Value parameter to be sent in response to a Change of State Request. A value of 0 disables this option. Non-zero values cause responses to be sent even if the value has not changed since the last message. The maximum is 65535 seconds. The default is 600. Watchdog Enables the watchdog task on the Motherboard. The watchdog task monitors the TSM point on the 8303 Dual RS-485 Communications Interface Module and verifies it is scanning for gauges. Dynamic Parameters Function Level IEEE Floating point value representing the tank level. The data is returned in the format specified during the configuration of the gauge. Level1 Floating point value representing the uncorrected Tank Level. Temp Floating point value representing the product temperature. The data is returned in the format specified during the configuration of the gauge. TopPress Floating Point value representing the Top Pressure MidPress Floating Point value representing the Middle Pressure BotPress Floating Point value representing the Bottom Pressure Density Floating point value representing the density. Water Level Floating point value representing the Bottom Water level AmbientTemp Outside Air Temperature. Device Status TSM Internal Status. See the TSM documentation for more information. Analog1 4 to 20 mA value % VaporTemp Air/Gas Temperature Value Digital Inputs Value. Installation and Operations Manual 8303 Dynamic Parameters Function GaugeStatus Coded value indicating status of the gauge. The GaugeStatus can have the following values: Upper Int Level - Searching or following the upper interface level. Mid Int Level - Searching or following the middle interface level. Bottom - Searching or following the bottom. Following Level - Displacer is following product level. Calibration Act – Automatic gauge calibration is in progress. Bottom Density – Measuring the Bottom Density. Middle Density – Measuring the Middle Density. Upper Density – Measuring the Upper Density. Raising – The displacer is raising. Stopped – The displacer is stopped. Rel Over Tens – The displacer cable tension has exceeded the maximum value. 0x1 - Gauge Servo bit 0 0x2 -Gauge Stowed bit 0 0x4 -Stow Received on Port 1 bit 0 0x8 -Stow Received on Port 2 bit 0 0x10 - NOVRAM corrupted bit 0 0x40 - Multi-element Thermometer fitted 0x80 - Element 1 Selected 0x100 - Element 2 Selected 0x200 - Element 3 Selected 0x400 - Element 4 Selected CustodyMode Weights & Measures Status Elapse Time of last scan. Interval Amount of time (in HR:MIN:SEC) between scans of the gauge PntStatus Byte value indicating status of point. Values are: 8303 Dual RS-485 Communications Interface Module: • 0x0000: No Error • 0x0001: No Response from Device For 8211 Whessoe Bus Communications Interface Module values are: 0x10 - Gauge is offline 0x20 - CRC Error 0x40 - Invalid Command 0x80 - Motherboard Watchdog Timeout PntCheckSum CRC-16 Checksum for point’s static Configuration Parameters. WMChecksum Weights & Measures Checksum. This parameter is calculated when the WMSeal parameter is set to Enable. 5.14.2 Application The 4590 TSM can operate with a variety of protocols including: L&J Tankway, Modbus, Mark/ Space, or Whessoe Bus. However the TM4590 point is only used when communicating via Modbus or Whessoe Bus. Modbus Protocol Using Modbus Protocol, 4590 TSMs are connected to an 8303 Dual RS-485 Communications Interface Module configured with Modbus firmware. An MSCAN point is automatically created to Varec, Inc. 93 Tank Gate Interface manage the scanning task. The Chan parameter determines to which channel the 4590 TSM is connected. The ID must match the Device ID of the 4590 TSM. Whessoe Bus Protocol Using Whessoe Bus Protocol, 4590 TSMs are connected to an 8311 Current Loop Communications Interface Module configured with Whessoe Bus firmware. An WBSCN point is automatically created to manage the scanning task. The Chan parameter determines to which channel the 4590 TSM is connected. The ID must match the Device ID of the 4590 TSM. General All three interface methods provide a software interface to the 4590 TSM. 8303 TGI software points may begin scanning when the point is created, or when the correct Channel number is assigned. Which of these events begins the scanning process varies with each point. The LevelUnits and TempUnits must match the engineering units of the gauge. Weights & Measures Protection The TM4590 point can be sealed when used in a Weights & Measures application. Only certain parameters can be sealed. These parameters will be shown in blue (CONSTANT parameters) when unlocked and will be grayed out when locked. To seal the point, set the WMSeal to Enable. Note that FuelsManager must be active in order to seal or unseal a point. 94 Installation and Operations Manual 8303 5.15 Ronan X76CTM (X76CTM) The X76CTM point provides an interface to the Ronan X76CTM tank monitoring system. This point provides both level and temperature data. Information such as volume, leak rate, point and gauge status, is also available in this point block. 5.15.1 Parameters The database parameters used by the X76CTM point are listed and described below: Config Parameters Function Tag A Tag can contain 15 bytes of data and can include any printable ASCII character. Tags can be used to identify points indicating the use of the point such as “Tank 22.” The default tag is set to “X76CTM.00”. Description The point description can contain 30 bytes of data and can include any printable ASCII character. Descriptions can be used as information relevant to any aspect of the point, such as its use, location, operating information, etc. The default description is set to “X76CTM.00”. Module Valid values 1-4. Default value is 255. Chan Communications channel to which the gauge is connected. For an 8203 Dual RS-485 Communications Interface Module Chan is either 1 or 2. BaudRate 8203 Dual RS-485 Communications Interface Module: Valid values are: 2400, 4800, and 9600. The default is 9600. ComParams Defines the number of data bits and the parity used by the com port. Valid values include: 8N - 8 data bits, No parity 8O - 8 data bits, Odd parity 8E - 8 data bits, Even parity 7O - 7 data bits, Odd parity7E - 7 data bits, Even parity The default is 8N. ID Ronan System Modbus Address cTankNumber Tank Number in the Ronan System LevelConvert Determines the units in which the level data will be displayed. F: Feet m: millimeters Default is I. TempConvert Determines the units in which the temperature data will be displayed. F: Fahrenheit C: Celsius If no value is specified, no conversion will be performed. The default is F. Varec, Inc. TempDeadband The TempDeadband is used to set the Change Of State deadband for temperature. The default is .25 degrees. LevelDeadband The LevelDeadband sets the deadband for the Change of State mode. The default is 0.001. 95 Tank Gate Interface Config Parameters Function Report Causes automatic notification to the Host (in response to a Change of State Request) when the Level, Temp, Position changes. Parameter value can be High, Low or No. Report=No disables automatic notification. Points with Report = High will be sent before points with Report = Low. The default is High. Maxtime Specifies the maximum time (in secs) between automatic Change of State responses being sent to the Host. Report must be set to either Low or High for the Value parameter to be sent in response to a Change of State Request. A value of 0 disables this option. Non-zero values cause responses to be sent even if the value has not changed since the last message. The maximum is 65535 seconds. The default is 240. Watchdog Enables the watchdog task on the Motherboard. The watchdog task monitors the X76CTM point on the 8203 Dual RS-485 Communications Interface Module and verifies it is scanning for gauges. If the 8203 Dual RS-485 Communications Interface Module fails, the 0x0010 and the 0x0001 bits of the PntStatus will be set to indicate the failure. Dynamic Parameters Function Level IEEE Floating point value representing the tank level. The data is returned in inches during the configuration of the gauge. WaterLevel Floating point value representing the product water interface level. Level is returned in inches. GrossVolume Floating point value representing the Product Volume. Units are gallons. TotalGVolume Units are gallons. Temp Floating point value representing the product temperature. The data is returned in the format specified during the configuration of the gauge. NetVolume Floating point value representing the Standard Product Volume. Units are gallons. LeakRate Units are gallons per hour (gph). Value Last Leak test rate in gallons per hour (gph). Last_Stop Time of last test. StatusFlag Tank Status. A field with different flags that correspond to tank alarms. Consult X76CTM manual for data. PntStatus Byte value indicating status of point. Values are: 0x0000: No Error 0x0001: Gauge is offline 0x0002: Data is invalid 0x0004: Command Timeout 0x8000: Gauge did not response to last request (pre-fail) Elapse Time of the last scan PntCheckSum CRC-16 Checksum for point’s static Configuration Parameters. 5.15.2 Application The X76CTM point provides an interface to Ronan X76CTM Continuous Tank Monitor. The Ronan system is connected directly to a 8303 Dual RS-485 Communications Interface Module. The ID must match the unit address of the X76CTM. The Baud Rate must match the Baud Rate of the interface. The individual tank data address is entered in the cTankValue field. Conversion from Metric to English (or vice-versa) can be performed be setting the LevelConvert and the TempConvert parameters. 96 Installation and Operations Manual Dual RS-485 (GSI ASCII) Software Blocks 6 Dual RS-485 (GSI ASCII) Software Blocks This chapter describes the Software Blocks that are included in the 8303 Tank Gate Interface (Dual RS-485), excluding those common to all the 8300 TGI software versions. The Software Blocks are listed in alphabetical order by acronym. MODBUS Software Blocks are described in section 5 on page 41. Common Software Blocks are described in section 4.4 on page 29. 97 Dual RS-485 (GSI ASCII) Software Blocks 98 Tank Gate Interface Installation and Operations Manual 8303 6.1 Gauging Systems Inc. Model 2000 ASCII Tank Trasmitter Interface (GSI) The GS2000 point provides an interface to GSI 2000 ASCII Tank Gauge transmitters. This point provides both level and temperature data. Point and gauge status information is also available in this point block. This Software Block executes on the 8303 Tank Gate Interface. 6.1.1 Parameters The database parameters used by the GS2000 point are listed and described below: Varec, Inc. Configuration Parameters Function Tag The point description can contain 30 bytes of data and can include any printable ASCII character. Descriptions can be used as information relevant to any aspect of the point, such as its use, location, operating information, etc. The default description is set to “GS2000.00”. Description The point description can contain 30 bytes of data and can include any printable ASCII character. Descriptions can be used as information relevant to any aspect of the point, such as its use, location, operating information, etc. The default description is set to “GS2000.00”. ID Physical Address of the tank gauge transmitter (0-999). Chan Channel Number. LevelDeadband Specifies the amount of change in the Level that must occur for the Value to be updated each Change of State period. The default is 0. LevelOffset Specifies the amount of offset to add to the Level. The default is 0. TempDeadband Specifies the amount of change in the Temp that must occur for the Value to be updated each Change of State period. The default is 0.25. TempOffset Specifies the amount of offset to add to the Temp. The default is 0. Report Causes automatic notification to the Host (in response to a Change of State Request) when the Value changes State. Parameter value can be High, Low or No. Report=No disables notification. Points with Report = High will be sent before points with Report = Low. The default is High. Maxtime Specifies the maximum time (in secs) between automatic Change of State responses being sent to the Host. Report must be set to either Low or High for the Value parameter to be sent in response to a Change of State Request. A value of 0 disables this option. Non-zero values cause responses to be sent even if the value has not changed since the last message. The maximum is 255 seconds. The default is 60. Dynamic Parameters Function Level Floating point value representing the tank level. The Level will be presented in decimal feet or meters, depending upon the LevelConvert parameter of the GSISCN point. Temp Floating point value representing the tank temperature. The Temperature will be presented in Fahrenheit or Celsius, depending upon the TempConvert parameter of the GSISCN point Alarm Gauge Alarms. Not used for the GS2000 point. 99 Tank Gate Interface Dynamic Parameters Function PntStatus Integer HEX value indicating status of point. Values are: 0x0001: Gauge Not Responding. The first time the gauge does not respond, the 0x8000 bit is set. On the second try, the 0x01 bit is set. 0x0002: Data Invalid (General Data Error) 0x0004: Bad Level 0x0008: Temp OverRange 0x0010: Temp UnderRange 0x0020: A/D Error 0x0040: Filtering Level 0x0800: Filtering Temp 6.1.2 GaugeStatus Byte value indicating status of the gauge. Refer to the transmitter manual for details on the GaugeStatus Elapse Time of the last Change of State Interval This parameter displays the number of hours:minutes:seconds since the point was last updated. Raw1 Raw data from gauge. Value reported as hexidecimal value. Raw2 Raw data from gauge. Value reported as hexidecimal value. Application The GS2000 point provides an interface to GSI Model 2000 Tank Gauge Transmitters. Tank gauges are connected directly to a 8303 Dual RS-485 Communications Interface Module. The ID must match the unit address of the GSI Model 2000. The Baud Rate must match the Baud Rate of the gauge. The DataMode must match the engineering units of the gauge. Conversion from Metric to English (or vice-versa) can be performed be setting the LevelConvert and the TempConvert parameters in the GSISCN point associated with the GS2000 point. The Level can be offset by entering a value for the LevelOffset parameter. The LevelOffset is added to the Level after any conversion have be performed. Likewise, the TempOffset may be used to offset the Temp value. 100 Installation and Operations Manual 8303 6.2 Gauging Systems Inc. ASCII Scanner (GSISCN) The GSISCN point provides an interface to GSI 2000 ASCII Tank Gauge transmitters. This point provides both level and temperature data. Point and gauge status information is also available in this point block. This Software Block executes on the 8303 Tank Gate Interface. 6.2.1 Parameters The database parameters used by the GSISCN point are listed and described below: 6.2.2 Configuration Parameters Function Chan Communications channel to which the gauge is connected. For a 8203 Dual RS-485 Communications Interface Module Chan is either 1 or 2. MaxRetry Value between 1-10 indicating the number of times the scanner will attempt to poll a tank transmitter that has not responded. Default is 2. Timeout Value between 0-30000 indicating the number of milliseconds the scanner will wait for a response from a tank transmitter. Default is 1000. ScanDelay Value between 0-30000 indicating the number of milliseconds the scanner will delay between each poll. Default is 500. LevelConvert Determines the units in which the level data will be displayed. F: feet, M: Millimeters. If no value is specified, no conversion will be performed. TempConvert Determines the units in which the temperature data will be displayed. F: Fahrenheit, C: Celsius. If no value is specified, no conversion will be performed. Dynamic Parameters Function ScanCmd Allows you to Enable scanning, Disable scanning, or Reset statistical values (Num Trans, Num Comm Error, etc.). ID Physical Address of the tank gauge transmitter (0-999). Pnt Point currently being executed. ReplyData The reply data from the gauge. NumRequest Number of gauge polls since last reset. NumTrans Number of transactions. NumComErrors Number of gauge polls which resulted in an error. NumTimeouts Number of scan time-outs. NumScanList Number of points in the scan list. PntCheckSum CRC-16 Checksum for point’s static Configuration Parameters. Application The GSISCN point provides a method for monitoring the communications between the 8303 Dual RS-485 Communications Interface Module and the GSI Transmitter. This point provides statistical data describing the performance of the communications bus. This point also displays the point being scanned as well as the response data from the transmitter. This point is also used to set the level and the temperature units transmitted by the Tank Gate Interface. Varec, Inc. 101 Tank Gate Interface 102 Installation and Operations Manual 8303 7 Installation Installation Before attempting installation, review the Safety Precautions below. Installation and maintenance personnel should become familiar with any hazards present as well as any agency requirements before working with any equipment. 7.1 General Safety Guidelines The user should follow safety guidelines provided by the Occupational Safety and Health Administration (OSHA) for additional protection. Information may be obtained from the following sources: • National Electric Code (NEC) • National Fire Protection Association (NFPA) • Instrument Society of America (ISA) • Factory Mutual Research Corporation (FM) • Underwriters’ Laboratories Incorporated (UL) • Canadian Standards Association (CSA) When in doubt about the safety of an area, the user should check with the local safety authorities. Always observe warning signs posted in the area and all labels on equipment. 7.2 Installation Safety Guidelines • Never attempt to make voltage measurements within the Tank Gate Interface in the field. • Maintenance should be performed only by authorized personnel. • Always turn off the power before removing the case cover. • Before installing/repairing any wiring to the Tank Gate Interface, make sure that the power is turned off at the main circuit breaker or switch. The power switch should be locked in the OFF position and labeled to prevent other personnel from turning the power on during installation. • Before turning on power when installation is complete, make sure the cover of the Tank Gate Interface case is in place and tightly closed. NEVER REMOVE ANY COVERS WITHOUT FIRST TURNING OFF THE POWER. • To prevent shock hazards, the housing of all units should be properly grounded in accordance with the National Electric Code. A grounding conductor should be wired to the grounding terminal provided on the Tank Gate Interface. • In some applications, a substantial amount of heat is produced by other equipment inside or outside the enclosure. To assist in air circulation, place blower fans inside the enclosure. • To prevent excessive heat, several steps can be taken. For most applications, normal convection cooling will keep the device components in the enclosure within the operating range. Proper spacing of components within the enclosure is usually sufficient for heat dissipation. • Caution should be exercised when entering any area that is posted or otherwise assumed to contain hazardous gases. Always follow the guidelines provided by the Occupational Safety and Health Administration for your own protection. Caution! Do not bring in unfiltered outside air. It may introduce harmful contaminants that could damage the Tank Gate Interface and components. Caution! Never perform maintenance with power applied. Varec, Inc. 103 Installation 7.3 Tank Gate Interface Installation Standard systems are shipped with the motherboard and tank gauge interface module installed. The Tank Gate Interface installation procedure includes the installation of these individual components. Tank Gate Interface installation includes the following steps: 1. Mounting the Tank Gate Interface (section 7.3.1 on page 104) 2. Selecting the Unit Address (section 7.3.2 on page 104) 3. Wiring up Power (section 7.3.3 on page 104) 4. Grounding the Tank Gate Interface (section 7.3.4 on page 106) 5. Installing Communications (section 7.3.5 on page 106) 7.3.1 Mounting the Tank Gate Interface Before mounting the Tank Gate Interface, make certain that any enclosure used can house the Tank Gate Interface. Refer to the dimensional drawing below (all dimensions are in inches). The recommended standard housing for the Tank Gate Interface is a NEMA TYPE 4 enclosure. This enclosure is suitable for both indoor and outdoor applications. 7.3.2 Select the Unit Address Switch SW1 sets the Tank Gate Interface’s one byte, binary address (0-15). Switch SW1-1 is the most significant bit (MSB) while switch SW1-4 is the least significant bit (LSB). When a switch is in the ON or CLOSED position, the resulting bit is a one. Figure 7-1: Switch SW-1 setting for ID 1 1 2 3 4 CLOSED OPEN Address 1 Shown 7.3.3 Wiring Up Power The Tank Gate Interface operates from AC power. Wiring 120 or 220 VAC Power The Tank Gate Interface is powered by an isolation transformer with a 5 volt regulator. 104 • Remove cover if it is in place • Connect the two power leads to terminals L and N of connector J2. • Ensure that a ground connection is connected to the G terminal ground of connector J2. (see below) • Install cover. Installation and Operations Manual 8303 Installation 197 125 204 s Figure 7-2: Varec, Inc. Tank Gate Interface Dimensions 105 Installation Tank Gate Interface 7.3.4 Grounding To allow use in harsh industrial environments, the Tank Gate Interface incorporates ANSI/IEEE surge protection. In solid-state control systems, grounding helps limit the effects of noise due to electromagnetic interference (EMI) and provides additional surge protection when high voltage switching circuits are connected to the unit. The grounding path for the Tank Gate Interface and its enclosure is provided by the equipment grounding connector. The resistance from the Tank Gate Interface ground to the grounding electrode must not exceed 1 ohm. Additional ground wires should be connected as required for each I/O module. Caution! All applicable codes and ordinances must be observed when wiring the Tank Gate Interface. 7.3.5 Installing Communications 7.3.5.1 RS-232 Communications • To install the RS-232 communication option, connect an RS-232 cable to connector J7 (COM0). Note The 8311 TGI only supports communication on COM0. 7.3.5.2 Power-Up Before the field cables are attached, perform an initial system verification. 7.3.5.3 Initial system verification • Connect the power cable to power connector P1, then connect an RS-232 cable from a PC with ViewRTU to J7 (COM0). • Power up the unit. The CPU LED on the tank gauge interface module should toggle on and off. If the CPU indicator is not flashing, turn off system power and proceed with the Troubleshooting and Calibration chapter. 7.3.5.4 Establishing Host Communications When the main system power is turned on, the Host communications status is set to On-line by default. The Tank Gate Interface then waits for a valid poll from the Host computer. If the communication cable is installed and the Host is running, a communications link is established. Verify this condition with a hand-held terminal or ViewRTU. 7.3.5.5 Verifying Host Communications • 106 Display the COM Point and verify that an On-line condition is indicated. Installation and Operations Manual 8303 8 Using ViewRTU Using ViewRTU 8.1 Overview This chapter describes the software used to configure the Tank Gate Interface. This chapter describes each of the menus found in the menu bar. Additionally, the chapter describes the system requirements and the installation procedure. Use this chapter in accordance with the Tank Gate Interface Software Blocks section. ViewRTU software, a Microsoft Windows application, is designed to configure and view data points in the Tank Gate Interface. ViewRTU is a utility program that can be used for configuration, diagnostics, data acquisition and control. Since ViewRTU follows the Windows standard, the user that is familiar with Windows will be able to learn the program quickly. ViewRTU supports the Windows standard of selecting commands from a series of pull-down menus. If the user is not familiar with Windows-based programs, then refer to the Microsoft Windows manual for basic instruction. 8.2 System Requirements The minimum requirements needed to run the ViewRTU application are listed below: 8.3 • 386/486/Pentium Personal Computer • Microsoft Windows NT, 2000, or XP • 96 MB RAM • 2 MB free disk space • 1 Com Port Installing ViewRTU To install the ViewRTU application, follow the steps listed below. Installing ViewRTU 8.4 • Insert the CD into the CDROM or DVDROM drive. • Select the drive that contains the disk from the Windows File Manager. • Double click on the SETUP.EXE file. The setup program prompts the user for the drive and directory used to install the software. • Select the drive and type in the directory name. Once the drive and directory are selected, the setup program copies all of the files to the chosen destination. • When all of the files have been copied to the destination, the setup program automatically builds a program group with corresponding program items in the Windows Program Manager. Executing ViewRTU This section describes how to start up the ViewRTU program. The components of the window are also described in this section. To execute the ViewRTU program, follow the steps below: Varec, Inc. 107 Using ViewRTU Tank Gate Interface Execute the ViewRTU program, 1. Select the ViewRTU program group from the Windows Program Manager. 2. Double-click on the icon to execute the ViewRTU application. If more than one Tank Gate Interface definition file (DVR) exists, the following dialog box is displayed. Figure 8-1: ViewRTU Version Selection dialog Each version file contains setup information that matches the firmware in the Tank Gate Interface. This information allows a single version of ViewRTU to configure multiple versions of the Tank Gate Interface. For example, MSTG1_00.DVR is a definition file that is compatible with Tank Gate Interface firmware version 1.00. Select the version that matches the version of firmware in the Tank Gate Interface. Note that you can determine the firmware version by viewing the SysVer parameter of the SYS point. 3. Choose the desired version and select OK. If only one Tank Gate Interface definition file (DVR) exists, the main window appears instead. The main window is seen below. When the ViewRTU program is opened, a new file appears in the window. The components of this window are explained below. Figure 8-2: Main ViewRTU window with descriptions 108 Installation and Operations Manual 8303 Using ViewRTU 8.4.1 ViewRTU window This main window allows the user to perform the commands necessary to configure the Tank Gate Interface. The ViewRTU window contains the standard Windows components such as the Application Control menu, minimize/maximize icon buttons, title bar and menu bar. The System Status area Displays the system version as well as general information about the configuration file. The Tank Gate Interface file name is found in both the System Status area and the title bar. The Tabular Contains several push-button icons used to execute frequently used commands found in the menu bar. In the menu description below, each appears next to its associated menu option. The Spreadsheet summary Lists all the point types and corresponding number defined in the file. The Spreadsheet Mode can be used as a quick method for creating and editing the contents of each point by doubleclicking on the desired point type. The parameters listed in the Spreadsheet summary directly correlate with each defined point. Point Icon Selection Area All the point icons are displayed in the Point Icon Selection Area. Point icons are visual representations of various software functions. When a new file is opened, several default point icons are displayed in the Point Icon Selection Area. These points are described in the Tank Gate Interface Software Blocks chapter. 8.5 The ViewRTU Menu Bar This section describes all the menus found in the ViewRTU menu bar. The push-button icons found in the Toolbar are shown next to each associated menu option. This section primarily describes the functionality of each menu option. ViewRTU applications are presented in the Application section at the end of the chapter. 8.5.1 The File Menu The File menu allows the user to create, open, and save configuration files. This menu also allows the user to save the current configuration to a different file name Figure 8-3: The File menu Varec, Inc. 109 Using ViewRTU Tank Gate Interface New The user is able to create a new configuration file by clicking on the New push-button from the tool bar or by selecting New from the File menu. When selected, a dialog box appears displaying a list of configuration definition files. The user selects the desired file from this list. Open The user is able to select an existing configuration file by clicking on the Open pushbutton from the tool bar, or by selecting Open from the File menu. When selected, a dialog box appears displaying a list of configuration files. All configuration files are identified by the RCF extension. Once a file is selected, the point configuration data of the selected file is displayed. If the directory is empty, the user has the option of creating a new file by typing in the file name. Save The user is able to save the opened configuration file by clicking on the Save pushbutton from the tool bar or by selecting Save from the File menu. The user can save the file anytime the configuration has changed. If the file exists in the directory, the configuration is stored to the disk using the current file name. If the file has not been saved before or the name does not exist in the directory, the user is prompted to enter a configuration file name. Save As The Save As option is used to save the currently opened file under a different name. When selected, a dialog box appears prompting the user to enter a file name. If the selected file name already exists, the user has the option of overwriting the file. Otherwise, the user can create a separate file containing all the current configuration data of the present file. If the user chooses to create a separate file, the current file is automatically closed. Only one file may be open at a time. Exit The Exit option is used to close the ViewRTU application. If the current configuration file has not been saved, the user is prompted to save the file or cancel the option. 8.5.2 The Point Menu Figure 8-4: The Point Menu Add The user is able to add a point to the current configuration. The user is able to add a point by clicking on the Add Point push-button from the tool bar or by selecting Add from the Point menu. The Select Point to Add dialog box appears: 110 Installation and Operations Manual 8303 Using ViewRTU Figure 8-5: Dialog viewed when adding a new point Select Point to Add dialog box This dialog box displays a list of available point types, the point number, quantity and the corresponding point icon. The point icon is then added to the Point Icon Selection Area if it does not already exist. The Point Type lists the currently selected point. The user can select the desired point by selecting the point from the scroll list. The Point Number defaults to “0” if the point type has just been defined. The maximum number of points entered depends on the selected point type. Once entered, the point quantity is displayed in the Summary Spreadsheet. Multiple points of the selected type may be created simultaneously by entering the number in the Quantity edit box. Edit This option is used to modify the contents of a selected point. The user is able to edit an existing point by clicking on the Edit push-button from the toolbar or by selecting Edit Point from the Point menu. The Select Point to Edit dialog box appears: Figure 8-6: Edit Point selection dialog Edit Point selection dialog This dialog box displays a list of defined point types and corresponding point numbers. The point icon is also displayed for identification as well as the tag, if a tag has been assigned. Once a point is selected, the Edit Point dialog box appears: Varec, Inc. 111 Using ViewRTU Tank Gate Interface Figure 8-7: Edit Point dialog Edit Point dialog This dialog box contains all dynamic and configurable field information. The user is able to edit point data. Exiting this dialog box returns the user to the main window. Note Several other methods can be used to display the Edit Point dialog box. These methods and other information are explained in greater detail in the Application section. Delete This option lets the user delete one point at a time. The user is able to delete an existing point by clicking on the delete push-button from the toolbar or by selecting Delete Point from the Point menu. The Select Point to Delete dialog appears: Figure 8-8: Point deletion dialog Point deletion dialog This dialog box displays a list of defined point types and corresponding point numbers. The point icon is also displayed for identification as well as the tag, if a tag has been assigned. The user selects the point type and the corresponding number to be deleted. 112 Installation and Operations Manual 8303 Using ViewRTU 8.5.3 The Config Menu Figure 8-9: The Configuration Menu Download Database to RTU The Download Database to RTU option is used to download configuration data to the Tank Gate Interface. The following dialog box appears: Figure 8-10:Dialog used to download Tank Gate Interface data Click the Download push-button to download data to the Tank Gate Interface Upload Database from Tank Gate Interface The Upload option is used to upload configuration data from the Tank Gate Interface. The following dialog box appears: Figure 8-11:Dialog used to upload Tank Gate Interface data Click the Upload push-button to download data from the Tank Gate Interface. Once the upload is complete, the main window changes to display the uploaded configuration. Spreadsheet The Spreadsheet option is used to configure, download, and upload point data points in spreadsheet mode. Varec, Inc. 113 Using ViewRTU Tank Gate Interface Figure 8-12:Spreadsheet Mode Edit window Password The user can use the Password option to gain access to a protected file. Once a password has been assigned, the user must enter the password when attempting to edit the Tank Gate Interface configuration file. This password is only entered once in the duration of the ViewRTU program. To enter the password • Select Config and click on Password. • Click on the edit box in the Password dialog. Type in the password. • Click on OK. Figure 8-13:Configuration Password dialog Modify Password The user can use the Modify Password function to protect all Tank Gauge Configuration files by issuing and changing a password. Creating a Password • Select Config and click on Password. The Change Password dialog appears. • In the New Password edit box, enter the password. If no password currently exists, leave the Old Password field blank. • In the Retype New Password edit box, confirm the entry by reentering the password. • Click on OK. Figure 8-14:Change Password dialog 114 Installation and Operations Manual 8303 Using ViewRTU Note Make sure that you write down the password and store it in a secure place. Changing the Password • Select Config and click on Modify Change Password. The Change Password dialog appears, as illustrated in ‘creating a password’. • In the Old Password edit box, enter the current password. • In the New Password edit box, enter the new password. • In the Retype New Password edit box, confirm the entry by reentering the new password. • Click on OK. Note 8.5.4 Make sure that you write down the password and store it in a secure place. The Communications Menu Figure 8-15:The Communications Menu PC Setup The PC Setup option allows the user to define the communications channel and data rate characteristics of the communications port. When selected, the following dialog box appears. This example dialog box contains the default settings for communications setup. Figure 8-16:Port Communications Setup dialog Varec, Inc. 115 Using ViewRTU Tank Gate Interface Port Communications Setup dialog This dialog box allows the user to enter the specifications of the Tank Gate Interface’s communication port. When OK is selected, the setup data is stored as the default setup next time ViewRTU is executed. Status The Status option is provided so the user is able to observe communications data. The following dialog box appears when this option is selected. Figure 8-17:Communications Diagnostics dialog Connect The Connect option is used when the user needs to search for a specific Tank Gate Interface. The following dialog box appears when the option is selected. Figure 8-18:Tank Gate Interface search dialog Tank Gate Interface search dialog This dialog box lists the address, description and current status of each Tank Gate Interface. From this dialog box the user can select an Tank Gate Interface and establish communications with the selected Tank Gate Interface. 116 Installation and Operations Manual 8303 Using ViewRTU 8.5.5 The Options Menu Figure 8-19:The Options Menu Convert Configuration Files The Convert Configuration Files option is used once the Download Firmware option has been executed. This option converts configuration files from one version to another. When selected, the following dialog box appears. Figure 8-20:Convert ViewRTU versions dialog Convert ViewRTU versions dialog This dialog box allows the user to convert a file. The user has the option of first analyzing the effects of converting the file. A script file can also be selected to alter the behavior of the conversion. Script files are provided on the upgrade disk. Export All The Export All option allows the user to export all of the database in the Tank Gate Interface. Each point type is exported to a file in the CSV file format. For example, the Analog Input points are all exported to the file ‘AI.CSV’. This means that the user can not specify each file name as the data is exported. The user does have the ability to specify the directory to export the data to. The user must create and then select the subdirectory for the export operation. We suggest Varec, Inc. 117 Using ViewRTU Tank Gate Interface that you organize the directories with names corresponding to the Tank Gate Interface address. If you have two Tank Gate Interface’s, use the Windows File Manager program to create subdirectories \VIEWRTU\RTU1 and \VIEWRTU\RTU2. All of the files for Tank Gate Interface #1 should be written to \VIEWRTU\RTU1; Tank Gate Interface #2’s data would go to \VIEWRTU\RTU2 and so on. The exported data can be edited using a spreadsheet program such as Microsoft Excel, or a database program like Microsoft Access. Many programs can read and write data in the CSV file format. You can make backups of your RCF file by exporting the data in the CSV file format. The exported data can be read back with the Import All option. The Spreadsheet Mode also has an option to import CSV file data. Import All The Import All option allows the user to import the entire Tank Gate Interface database. Each point type must have been exported previously in order to import data. This can be accomplished using the Export All option, or by point type using the Spreadsheet Mode. The data is read from files in the CSV file format. For example, all of the Analog Input points are imported from the file ‘AI.CSV’. The user must select the subdirectory to import the data from. The CSV file data can also be imported using the Spreadsheet mode. View I/O List The View I/O List option allows the user to create a list of the I/O points connected to the Tank Gate Interface. The list is limited by listing points that have the Chan or Module parameters. These parameters are always used in cases where I/O is involved. The list is created by writing to the file ‘POINTLST.TXT’ and launching the Notepad program. The user can print this file using Notepad, or exit and return to ViewRTU. Set Time in RTU The Set Time in RTU option sets the time in the CLK point to the same time as the PC running ViewRTU. 8.5.6 The Help Menu Figure 8-21:The Help Menu Contents The Contents option opens the table of contents of the ViewRTU on-line help. Index The Index option opens the index for the ViewRTU on-line system. This index lists all the help screens contained in the help system. About VRTU The About RTU... option displays a dialog box describing the copyright information and the application version number. 118 Installation and Operations Manual 8303 Using ViewRTU 8.6 Using ViewRTU By using ViewRTU, the user is able to define or modify sub-programs called Software Blocks. Software blocks are used to configure the Tank Gate Interface. Note Refer to the Tank Gate Interface Software Blocks chapter for specific examples. The chapter provides a description of the parameters for each point as well as examples of the connections to other points. Tank Gate Interface software blocks are functions that the user can configure to perform various tasks. Software Blocks are available to scan data from a slave device, control a pump, serve data to other Host systems or perform calculations. Each function type contains both the code and data necessary to perform the function. Software Blocks are identified by their type (example: AI, DI, LJ2000 and PUMP). Points are individual instances of software blocks. Each point must be added and then configured. Adding a point makes the point available for configuration. All defined points appear in both the Point Icon Selection area and the Spreadsheet Summary in the main window. Configuring the point involves entering configuration parameters. In some cases, connections to other points are required in order to perform a task. Creating connections involves setting references to allow data to be transferred between points. 8.6.1 Overview An outline of the section is listed below: Configuring Single Points This section describes the method used to configure individual points including: • Adding a Point • This section describes how to define a point from the Main window. • Entering Point Data • This section describes how to enter the point’s parameters. Parameters are entered from the Edit Point Window. • Modifying Strap Tables • This section describes how to modify strap tables in ViewRTU. Configuring Multiple Points This section describes the spreadsheet mode. The principles involved in point configuration are the same, but the methods are slightly different. • Adding Multiple Points • This section describes how to define a point from either the Main window or the Spreadsheet Mode window. • Entering Point Data • This section describes how to enter a point’s parameters. Parameters are entered from the Spreadsheet Mode window. Creating and Editing Connections This section describes how to create connections between various points. Points may be used to retrieve and/or deliver data from other points. Varec, Inc. 119 Using ViewRTU Tank Gate Interface 8.6.2 Configuring Single Points Configuring the point involves entering configuration parameters. In some cases, connections between points must also be required in order to perform a function. All of these steps can be implemented from the Point Connections window. To display the Point Connections window, follow one of the methods listed below: Adding a Point The user is able to add a point or point type by clicking on the Add Point push-button from the toolbar or by selecting Add from the Point menu.Once the point is added, the user is then able to configure the point. Defined point types appear in the Point Icon Selection Area and in the Spreadsheet Summary of the main window. Entering Point Data This section describes how to configure the parameters of any point. Each point has its own Edit Point window that requires some degree of configuration. Both the configuration and dynamic attributes of the point are found in the Edit Point Window. From this window, the user is able to view and edit database parameters. Several methods can be used to display this window depending on the user’s current location in the program: • If in the Main window, select Edit from the Point menu. Select the desired point type and corresponding point number. • If in the main window, double-right click on the point icon. • If in the Point Connections window, double-left click on the focus point icon. • If in the Point Connections window, double-right click on a point icon other than the focus point icon. The following example window appears. Figure 8-22:Edit (Digital) Point dialog 120 Installation and Operations Manual 8303 Using ViewRTU Edit (Digital) Point dialog This window is used to view and modify the Dynamic and Configuration parameters of the selected point. The Edit Point window is identified by the Point Description and associated current Point Number listed at the top of the window. This window contains two list boxes and a series of push-buttons. The top list box contains the configuration parameters of the point, while the bottom list box contains Dynamic and Command parameters. The first column contains the name of the parameter and the second column contains descriptions of the parameters. The third column of the Configuration parameters section contains the default data. The user can change a value by double-clicking an entry and entering the new variable. If a Tank Gate Interface is connected and on-line, the third column of the Dynamic parameters will update in real-time. Edit Point Window Push-buttons The user is able to perform a series of functions from selecting the push-buttons found in the bottom of the Edit Point window. Each push-button is described below. Minimize The Minimize push-button creates a “mini window” of selected parameters. This push-button enables the user to observe relationships between dynamic parameters and how the changes affect the point. Clicking the Minimize shrinks the window so that only one or more selected list box parameters are displayed. The user may have multiple minimize windows opened simultaneously. This capability is useful for testing and debugging. Minimizing the Edit Point Window • Highlight by single-clicking the left mouse button on one or more parameters. • Click on the Minimize push-button. A following example window appears: Figure 8-23:Edit Point dialog minimized Note Parameters can be edited in the minimized mode by double-clicking the right mouse button on the desired selection. • To maximize the window, click on the maximize icon or click on the Application Control menu of the window and select the Maximize menu option. Connections The Connections push-button allows the user to switch back to the Point Connections dialog box. Next The Next push-button allows the user to step through the list of points. The user is able to view the Edit Point window of the following point number. Selecting Next at the end of the point number list wraps to the beginning. Varec, Inc. 121 Using ViewRTU Tank Gate Interface Previous The Previous push-button allows the user to step through multiple points of a point type. The user is able to view the data in the Edit Point window of the previous point. Selecting Previous at the first point number wraps to the last point number of the list. Examine The Examine push-button is used to go to the Point Connections window of the reference point in the list box. Opening a point connection window • Highlight the desired reference data parameter from the Edit Point window. • Click on the Examine push-button. The user is taken to that reference point’s Point Connections window. Exit The Exit push-button exits the current point configuration and returns the user to the main menu. Download The Download push-button allows the user to download the entire point data to the Tank Gate Interface. Upload The Upload push-button allows the user to upload the entire point data from the Tank Gate Interface. 8.6.3 To modify a Value Figure 8-24:Edit Point dialog (adding a value) 122 Installation and Operations Manual 8303 Using ViewRTU To modify a value • Double-click the desired parameter to enter a new value. The following example Modify Point dialog box appears. Figure 8-25:Edit point parameter value dialog Edit point parameter value dialog From this dialog box, the user is able to enter a value for the selected parameter. The dialog box varies according to the selected parameter. In some dialog boxes the user is able to enter the name or data directly in the edit box. Other dialogs contain a scroll list from which the user selects a value. The new value can then be downloaded to the Tank Gate Interface or stored locally if the Tank Gate Interface is off-line. To modify a Reference There are two ways to modify a reference. One method is performed from the Edit Point window, and the other method is performed from the Point Connections window. For convenience, both methods are listed below: To modify a Reference • In the Edit Point Window Double-click the desired reference parameter to enter a new value. The following dialog box appears. • In the Point Connections Window drag and drop the point icon onto the PntRef. The following dialog box appears. Figure 8-26:Edit point parameter reference dialog Edit point parameter reference dialog This dialog box is used to select a new point reference, corresponding point reference number, and/or parameter. If displayed from the Edit Point window, the selection lists the default value. If displayed from the Point Connections window, the most consistent value is selected as the default. Varec, Inc. 123 Using ViewRTU Tank Gate Interface Only valid references appear in the list boxes contained in this dialog box. The new reference can then be downloaded to the Tank Gate Interface or stored locally if the Tank Gate Interface is off-line. 8.6.4 Configuring Multiple Points The spreadsheet mode is one of the methods used to configure points. This method is the most beneficial when editing and viewing multiple points of the same type. Spreadsheets of each defined point are found in the Spreadsheet Summary section in the main window. There are some differences between the regular and spreadsheet methods. First, the user is not able to view the Point Connections window in Spreadsheet Mode. This mode is used mainly for viewing and entering point data. Second, the spreadsheet focuses on points of a single type; it does not offer a “big picture” view of multiple point types. Adding Multiple Points The user is able to add a point by using the same method used to add single points. The user can click on the Add Point icon or push-button from the toolbar or by selecting Add from the Point menu in the Main window. Once the point is added, the user is then able to define the point. Defined points appear in the Point Icon Selection Area and in the Spreadsheet Summary of the Main window. Note The user can add a point by selecting Add from the Point menu in the Spreadsheet Mode window. This menu is described later in the section. Adding Multiple Points • Double-click on the desired point type in the Spreadsheet Summary. The following example Spreadsheet Mode window appears. Figure 8-27:Spreadsheet Mode Window Note Refer to the following Entering Point Data section for a description of the Spreadsheet Mode window. Entering Point Data This section explains the window used to configure multiple points of a single point type. When the user double-clicks on a point type, the following example dialog box appears: 124 Installation and Operations Manual 8303 Using ViewRTU Figure 8-28:Spreadsheet Mode: Entering point parameter data Spreadsheet Mode This window displays a list of all the point numbers of a selected point type. The user is able to add, configure, and edit points. The user is able to select and enter the parameters for each point or group of points. The user can also export/import files and control the selection of displayed parameters. Compare this window to the Edit Point window (see Figure 8-7 on page 112). The two windows contain the same parameters. In the spreadsheet mode, the user is able to view and modify all the points of the selected type. In the Edit Point window, the user steps through a window for each point number using the Next and Previous push-buttons. The left two columns, D and U are used to download and upload, respectively, the information found in the corresponding row(s). The third column lists the point numbers. The Spreadsheet Mode menu bar contains menus used to perform various functions to one or more points. Each of the Spreadsheet Mode menus is described below. The Point Menu This menu contains the same menu options found in the main window’s menu bar. Refer to The Point Menu section for a description of the menu options. Figure 8-29:Spreadsheet Mode: The Point Menu This option is useful for creating, deleting and editing points without having to exit out of the Spreadsheet mode. Varec, Inc. 125 Using ViewRTU Tank Gate Interface The Edit Menu Figure 8-30:Spreadsheet Mode: The Edit Menu Copy The Copy option allows the user to copy data from a one or more selected cells. 1. Select one or more cells to copy. To select one or more rows, click on the number(s). To select one or more columns, click on the parameter(s). 2. Select the Copy option from the Edit menu. The selected cells outline changes from black to red. Note To undo the Copy option, press the Esc key. Pressing the Esc key removes the selection outline from the selected cells. Paste The Paste option allows the user to paste the copied group of cells (red outline) to the currently selected group of cells (black outline). 126 1. Select the cells on which the copied cells will be pasted. 2. Select the Paste option from the Edit menu. Installation and Operations Manual 8303 Using ViewRTU Figure 8-31:Spreadsheet Mode: Copying and Pasting point parameter data rows. Note If the number of rows and columns in both selections do not match, the extra copied cells are truncated. Incompatible cells containing different data types are not copied; instead a warning is displayed. Paste & Dnld The Paste & Dnld option is very similar to the Paste menu selection. The only difference is that the Paste & Dnld selection downloads the updated data parameters. Set Value The Set Value option allows the user to enter or select a value for a parameter. 1. Click on the desired cell or column. 2. Select Set Value from the Edit menu. The Modify Value dialog box appears: Figure 8-32:Spreadsheet Mode: Editing point parameter values 3. Enter or select a value from the scroll list. Set Value (with Auto Increment) This option can also be used for numeric parameters such as channels to auto increment the value. Follow the procedure below: Varec, Inc. 127 Using ViewRTU Tank Gate Interface 1. Click on each desired cell or column. 2. Select Set Value from the Edit menu. The following dialog box appears: Figure 8-33:Spreadsheet Mode: Editing point parameter values using auto increment Each value in the column is incremented by one for the range of rows selected. All cells that are selected and match the data type of the value are set to the value. The Options Menu Figure 8-34:Spreadsheet Mode: The Options Menu Import The Import option allows the user to import a point or group of points that match the current point type. The imported file is named according to the point type with the ‘CSV’ file extension. Export The Export option allows the user to export a selected point or all the points that match the current point type to the default directory. The export file is saved in a file named according to the point type with the ‘CSV’ file extension Note The user is able to change the source directory in the INI file. View The View option allows the user to display selected parameter types. Selecting this option displays the following View Point Parameters dialog box. 128 Installation and Operations Manual 8303 Using ViewRTU Figure 8-35:Spreadsheet Mode: Viewing selected parameter types dialog The user is able to select any combination of parameter types. The user is able to select any combination of classifications. The classifications are described briefly below. . Parameter Type Description Dynamic Real-time data such as status Config General specifications such as tag and description Constant Data that does not change and/or can not be changed Scratch Temporary data that is typically hidden from the user Command Output command data System System data (should not be changed by the user) Note The default View setting is the Config parameter type. Hide Row/Col The Hide Row/Col option allows the user to hide selected rows or columns. Note The Copy and Paste operations do not affect hidden rows and columns. 1. Select one or more rows or columns. 2. Select the Hide Row/Col option from the Options menu. The selected rows or columns are indicated by a ‘+’ in the row or column buttons heading. The following dialog box illustrates this feature. Varec, Inc. 129 Using ViewRTU Tank Gate Interface Figure 8-36:Spreadsheet Mode: Hiding columns The user can unhide a row or column by clicking on the associated ‘+’. To unhide all the rows/ columns, the user can select the Unhide All option from the Options menu. Unhide All The Unhide All option allows the user to reveal all of the rows or columns that are currently hidden. 8.6.5 Creating and Editing Connections Several methods can be used to display this window depending on the user’s current location in the program. These methods are listed below: • If in the Main window, double-left click on the point icon. • If in the Edit Point window, click on the Connections push-button. • If in the Point Connections window, double-left click on a point icon other than the focus point to view the Point Connections window for the selected point. Note If multiple points exist, a selection window is displayed showing all the available points. Figure 8-37:Edit Point selection window 130 Installation and Operations Manual 8303 Using ViewRTU Displaying the Point Connections window. • Double-click on one of the icons to display the Point Connections window. The following example Point Connections window appears. Figure 8-38:Point Connections Window Point Connections Window This graphic display visually illustrates the reference connections of the focus point. From this display, the user is able to select reference points, create connections between these points, and enter configuration parameters. The point icons located in the Icon Bar utilize the drag-and-drop features of Windows. The user is able to connect the output data of one point to the input of another point. The connections are made through point references and links. Not all points have references, but any parameter of a point can be referenced. Some references are incompatible with some types of data. The program can determine if a reference is valid, but it cannot determine if the reference is meaningful. The Input Data parameters, which are located on the left side of the software block, are references. The Output Data parameters, which are located on the right side, are most commonly referenced by other points. To create a Connection: 1. 2. Select the desired point icon from the Icon Bar and drag it onto the desired data parameter. • If the point dropped does not exist, then the user needs to define the point as described in the previous section. The same configuration process is used to define the point. • If multiple points exist, the user is prompted to select the point number. • If the point dropped already contains a reference to another input reference, a dialog box will appear inquiring whether or not to overwrite the existing reference. The point icon will appear to the right or left of the selected arrow as seen Figure 8-38. Note Double-left clicking on a focus point icon allows the user to view the point’s Edit Point window. Varec, Inc. 131 Using ViewRTU Tank Gate Interface Note Double-left clicking on the input source or the output destination icon allows the user to step through each corresponding Point Connections window, if applicable. Note Double-right clicking on the input source or the output destination icon allows the user to view the point’s Edit Point window. 132 Installation and Operations Manual 8303 9 Troubleshooting Troubleshooting 9.1 Overview This chapter describes the procedures used to isolate hardware faults. Three push-buttons and eight status Led provide verification of Tank Gate Interface proper operation. If the Tank Gate Interface is not functioning normally, the user is able to troubleshoot the device by performing one or more procedures using the three push-buttons. These push-buttons and indicators are also described in the Motherboard & I/O ExpansDual RS-485ion Module Configuration chapter. Caution! Not all troubleshooting instructions are valid for all Communications Modules. 9.2 Troubleshooting the Tank Gate Interface 9.2.1 LED Displays under normal conditions Operations are normal if the Run, I/O and On-line indicators are flashing. the table below represents the normal conditions for the Run, Output and On-line indicators. Figure 9-1: LED Indicators Indicator Condition Run Flashes once every second. Com Toggles when the system is receiving data. Idle when not receiving data. TXD Every P011 causes the TXD LED to toggle RXD Lights when a response is received Run indicator The RUN Indicator provides the single most important feedback of proper system operation. When the system functions properly, the RUN Indicator is constantly flashing at a 0.5Hz rate. If this indicator ever goes to a steady state condition, either on or off, some malfunction has occurred. In addition, relative processor loading can be determined by observing the RUN Indicator duty cycle. Under normal conditions, this indicator flashes once every second. Communications indicator The Communications indicator provides communication line status. When it is toggling, the system is exchanging data. As the system receives a valid message from the Host, this indicator toggles. If the indicator is idle, the system is off-line. TXD/RXD LEDs When these LEDs are flashing, the system is exchanging data between the Tank Gate Interface and any tank gauge. Varec, Inc. 133 Troubleshooting Tank Gate Interface 9.2.2 LED Displays under Abnormal Conditions The table below lists the abnormal conditions of the four indicator lights. From this table the user should be able to pinpoint the cause and derive a solution to the problem. Indicator Condition Cause Solution Run Does not flash (even after hard reset) Bad database Perform Hard Reset then reload database Steady ON/OFF system failure Steady state DIP switch setting Check unit ID DIP switch setting: set ID number and reset system COM point Check COM point with diagnostics terminal or ViewRTU COM parameters Verify time-out, baud, and protocol parameters have the correct values set bad communications Check for bad communication line, modem board or main circuit board wrong jumper settings Check SW1 & SW2 for proper settings Communication 9.2.3 Bad main circuit board Replace main circuit board Using the Tank Gate Interface Push-buttons Reinitializing System Hardware To reinitialize the system hardware Press the RESET Switch. • This action causes it to go to a known starting state. This switch may be pressed at any time; however, the following will also occur: 9.2.4 • Reinitialize System Hardware • Clear Working Memory • Reinitialize Data Base • Reset All Timers • Disable Outputs • Enable Communications • Present Sign-on Message to Diagnostic Terminal Performing a Hard Reset A ‘Hard Reset’ clears the Tank Gate Interface’s database. The following procedure describes the steps necessary to perform a Hard Reset: 1. 134 Set the ID DIP switch to 15 (all switches Closed/On). This action initiates the Hard Reset Procedure. Installation and Operations Manual 8303 Troubleshooting ID = 15 Figure 9-1: Set the ID DIP switch to 15 2. Press the Reset button HARDWARE HANDSHAKING A EARTH B NEUTRAL LINE SURGE GND RESET VFIELD + RS232 - RESET COM1 A/TXD B/RXD RS485 COM1 GND RTS CTS TXD COM 0 RXD GND +15V +5V GND AUX POWER VFIELD=48V VFIELD=24V SW3 -15V Figure 9-2: Switches SW3 on the Tank Gate Interface motherboard 3. The Tank Gate Interface will perform its memory test. When it has completed the memory test, all LEDs will be on. 4. Set the ID DIP Switch to the desired address (1-14). At this point, there is no further action required by the user. ID = 1 Figure 9-3: Set the ID DIP switch to the desired addresses 5. Varec, Inc. The LEDs will light (and remain steady) to indicate the address. For example, if the ID DIP Switch is set to 1, LEDS D1 will on. If the ID DIP Switch is set to 3, LEDS D1 and D2 will be on. 135 Troubleshooting Tank Gate Interface D1 ON D2 D3 D4 ID = 1 Figure 9-4: Address indication from the LEDs 6. After 10 seconds, the address of the Tank Gate Interface will be set to the ID DIP Switch setting. The LEDS will flash for 5 seconds to indicate that the address is about to be set. D1 FLASHES D2 D3 D4 ID = 1 Figure 9-5: Set the ID addresses 7. 9.3 After the address is set, the Tank Gate Interface will begin normal operation with a blank database: • CPU LED: Flashing once per second • COM LED: Toggles when communicating to PC • TXD: Off when there is no database. When tank gauges are being scanned, the TXD LED will flash • RXD: Off when there is no database. When tank gauges are being scanned, the RXD LED will flash when a response is received. Maintenance Field maintenance of the Tank Gate Interface is simplified by several built-in features. The modular design of the computer control system, in conjunction with quick-disconnect connectors, allows for on-site replacement of questionable components. The following standard procedure can be used for repairing the Tank Gate Interface: Replacing a defective component or module 136 • Turn off main power. • Open the enclosure door. Remove the case cover of the Tank Gate Interface. • Replace the defective component or module using the instruction supplied with the spare part. • Replace and tighten the case cover. • Turn on power and test with PC and ViewRTU. • Close the enclosure door. Installation and Operations Manual 8303 A Appendix - Order Codes Appendix - Order Codes 10 Interface Module 032 Dual RS-485 MODBUS™ Communications Interface Module 036 Dual RS-485 GSI ASCII Communications Interface Module 101 Varec Mark/Space Micro 4-wire (Varec 1800, 1900, 6500) Interface Module 111 Current Loop (Whessoe Bus) Interface Module 112 Current Loop (GPE) Interface Module 120 SAAB (TRL/2) Interface Module 140 Enraf (811, 802/812, 854, 873) Interface Module 150 L&J Tankway (MCG 1000, MCG 1500, MCG 2000) Interface Module 161 Prime Measurement (3500 ATG) Interface Module 171 Dual RS-232 Veeder Root (TLS 350) Interface Module 20 Enclosure A No Enclosure (Note 1) B 16x16x6 inch NEMA 4 enclosure 30 Power Supply 0 No DC Power Supply (Note 1, 2) 1 120VAC input, 48VDC, 1 Amp Power Supply (Note 3) 2 240VAC input, 48VDC, 1 Amp Power Supply (Note 3) 3 120VAC input, 24VDC, 1 Amp Power Supply (Note 3, 4) 4 240VAC input, 24VDC , 1 Amp Power Supply (Note 3, 4) Complete product designation N83- Note 1: If 'No Enclosure' is selected, then 'No DC Power Supply' must be selected. Note 2: Not available for Mark/Space or Current Loop Interface Modules unless 'No Enclosure' option selected Note 3: Not available for SAAB, Enraf, L&J Tankway, Prime Measurement, or Veeder Root (TLS 350) Interface Modules Note Varec, Inc. 4: Only available with Dual RS 485 Interface Modules with enclosure 137 Appendix - Order Codes 138 Tank Gate Interface Installation and Operations Manual Document Code IOM032GVAE1313 Varec, Inc. • 5834 Peachtree Corners East, Norcross (Atlanta), GA 30092 USA Tel: +1 (770) 447-9202 • Fax: +1 (770) 662-8939 www.varec.com © 2006 Varec, Inc. All Rights Reserved. This document is for information purposes only. Varec, Inc. makes no warranties, express or implied, in this summary. The names of actual companies and products mentioned herein may be the trademarks of their respective owners.
