Schneider Electric. DTN Guardian3 Tank Scan for GuardianControl Configuration Guide. November

Transcription

1 Schneider Electric DTN Guardian3 Tank Scan for GuardianControl Configuration Guide November

2 Legal Information The Schneider Electric brand and any registered trademarks of Schneider Electric Industries SAS referred to in this guide are the sole property of Schneider Electric SA and its subsidiaries. They may not be used for any purpose without the owner's permission, given in writing. This guide and its content are protected, within the meaning of the French intellectual property code (Code de la propriété intellectuelle français, referred to hereafter as "the Code"); under the laws of copyright covering texts, drawings and models, as well as by trademark law. You agree not to reproduce, other than for your own personal, noncommercial use as defined in the Code, all or part of this guide on any medium whatsoever without Schneider Electric's permission, given in writing. You also agree not to establish any hypertext links to this guide or its content. Schneider Electric does not grant any right or license for the personal and noncommercial use of the guide or its content, except for a nonexclusive license to consult it on an "as is" basis, at your own risk. All other rights are reserved. As standards, specifications and designs change from time to time, please ask for confirmation of the information given in this publication. 2

3 Table of Contents Tank Scan Support for GuardianControl Configuration Guide Table of Contents Introduction... 5 DTN Guardian3 Client Configuration... 7 Device screen... 7 IO Map screen... 9 Database Destination/Source ID Query Parameters tab GuardianControl.ini AddressAdjustment MasterReadScanRate Technical Appendix Database Table Entries Table G3USER.DB_TABLE Table G3USER.DB_TABLE_COLUMN Table G3USER.DB_TABLE_EVENT Table Relationship Overview

4 Table of Contents 4

5 Introduction Tank Scan Support for GuardianControl Configuration Guide Introduction Previously, a standalone Delphi application has provided the functionality of Tank Scan in the Guardian system. By extending the abilities of the IO Data Server, Tank Scanning is now possible from within the GuardianControl application. The purpose of this guide is to explain the configuration fields of the DTN Guardian3 Client as they pertain to the new Tank Scan feature. 5

6 Introduction 6

7 DTN Guardian3 Client Configuration Tank Scan Support for GuardianControl Configuration Guide DTN Guardian3 Client Configuration Device screen The configuration of Tank Scanning uses the existing Device and IO Map screens of DTN Guardian3 Client. Where noted, additional fields have been added to those screens to facilitate new data fields required to support Tank Scanning. Referring to Figure 1, the existing Device screen in the DTN Guardian3 Client is used to configure the settings of the physical connection required to read Modbus Registers. These registers equate to the attributes of a tank s current condition (Level, Temperatures, etc.). An explanation of the new fields on this screen is defined below. Description A. Interface Type The entry in the combo box previously labeled None has been renamed to IO Alarms to reflect its intended use. B. Sentry ID If it is filled in, the Device is only processed when GuardianControl is controlling that particular Sentry. If the value is left blank, GuardianControl will process this Device regardless of the Station ID that it s controlling. If multiple instances of GuardianControl are being run with more than one defined supporting functionality such as IO Alarms and Master/Slave interfaces, then the use of Sentry should be used. 7

8 DTN Guardian3 Client Configuration Description C. Register Map Correction D. BigEndian on MultiWord Registers A Modbus Register has two related attributes, a Modbus Address and a Register Number. Modbus Addresses are a mapping to access particular Register Numbers. For example, passing a 1 as the Modbus Address may imply reading from Register In this case, that would be a 1-based addressing scheme because Addresses start at the number 1 to get to the first Register. Other Modbus/Devices mappings may have a zero-based address scheme, meaning that 0 is passed as the Address to read Register To account for this variation in Modbus-to-Device implementation, the Register Map Correction value is used. By default, GuardianControl assumes a 1-based address scheme, meaning that Register is referenced by a Modbus address of 1. When that is the case with your implementation, the value placed in this field should be a 0. In a 0-based implementation, i.e. where Register is referenced by Address 1, then a value of 1 must be placed into the Register Map Correction field as shown below. Generally speaking, a Modbus Address of 1 reads the Register Number equal to [ Register Map Correction] In the above examples, the address of has been shown. Addresses that begin with a 4 read from the Holding Registers. Tank Scanning is not limited though to only the Holding Registers and can also read from the Input Registers in the range as well. In addition, the and ranges are also supported where a larger addressing range is needed. Indicates the type of byte-encoding is being used on Registers that are comprised of Multiple 16-bit Words. Options are: Unselect = indicates a binary value of 0x would be encoded as 0x Selected = indicates a binary value of 0x would be encoded as 0x

9 DTN Guardian3 Client Configuration Tank Scan Support for GuardianControl Configuration Guide IO Map screen Figure 1 Device Configuration Referring to Figures 2a through 2d, the existing IO Map screen in DTN Guardian3 Client configures the attributes of each Modbus PLC/Device Register. A Register is the entity that equate to the attributes of a tank s current condition (Level, Temperatures, etc.). An explanation of the new fields on this screen is defined below. Description A. Read/Write Indicates whether GuardianControl is Reading or Writing a Modbus Register. For Tank Scanning, this should always be set to Read to indicate that a Register containing an attribute of the Tank is being Read From the PLC/Device. B. Multiplier/Scaling Contains a number that is multiplied with the value read from the device. This can be used, for instance, to convert between Units. In the example of figure 2a, the value 192 translates from a raw device value indicating a level measured in Feet to a value expressed in 1/16ths of an inch. This field allows positive and negative floating point numbers. 9

10 DTN Guardian3 Client Configuration Description C. Group Designator Specifies an arbitrarily chosen string that is used to logically group registers together. For example, as shown in figure 2a, the value tank- 1 is used to indicate that the register is reading an attribute from Tank Number One. All other registers associated with Tank Number One would have this exact same value. Tank Number Two would then have a string something like Tank-2. GuardianControl uses this value internally in two ways: I/O requests to read registers are always bundled into groups, using the Group Designators (in alphabetical order), to ensure that values for a particular tank are read as close to the same moment in time as possible. The Group Designator determines if all the Reads for a particular tank are complete so that the aggregate data is ready to be written to the database as a summary dataset. Figure 2a IO Map Configuration 10

11 DTN Guardian3 Client Configuration Tank Scan Support for GuardianControl Configuration Guide The Multiplier field of the IO MAP screen can also contain a mathematical expression rather than just a simple multiplier number. Figure 2b demonstrates the use of an expression to convert from Fahrenheit to Centigrade (Fahrenheit = Centigrade * (9/5) + 32). The value read from the physical register, expressed as the variable X, is substituted into the expression and that result is then used to populate the Database Destination (see figure 2c). Database Destination/Source ID Figure 2b IO Map Configuration with Expression The Database Destination/Source ID selection of the IO MAP screen ties the Register s value to the database table s Field that it will be written into. Figure 2c shows the list of the pre-configured database fields available. Figure 2c IO Map Configuration showing Tank Scan Source values 11

12 DTN Guardian3 Client Configuration Query Parameters tab The Query Parameters tab on the IO Map screen is where the Terminal and Tank IDs are defined. This information ties the IO Map s Register to a particular tank being scanned. Figure 2d IO Map Configuration showing Tank Scan Source values 12

13 GuardianControl.ini Tank Scan Support for GuardianControl Configuration Guide GuardianControl.ini AddressAdjustment The operation of GuardianControl TankScan is also affected by settings in the GuardianControl.ini file. The settings that GuardianControl TankScan operates on are found in the [InterfacePLC] group within the ini file. The AddressAdjustment value works in conjunction with the Register Map Correction field in DTN Guardian3 Client. If there is no other reason contrary to this, it s desirable to set both AddressAdjustment and RegisterMapCorrection to 0 (zero). Either way, the following matrix gives the setting relationship between AddressAdjustment, Register Map Correction, the Modbus Register and the GC IOMap Register Address. For example say Modbus register is N. Depending on how Address Adjustment and Register Map Correction are set, GuardianControl s IO Map Register will need to be either N or N-1: AddressAdjustment In GC ini file Device s Register Map Correction GC IO Map Register Address 1 0 N N 0 1 N N MasterReadScanRate The value of MasterReadScanRate specifies the number of seconds between each pass of reading registers from the Modbus/PLC. 1 is the minimum allowable value. 13

14 GuardianControl.ini 14

15 Technical Appendix Tank Scan Support for GuardianControl Configuration Guide Technical Appendix Database Table Entries Table G3USER.DB_TABLE The following information deals with advanced system internals and is presented solely for those who wish to have a deeper understanding of the configuration setup. For most users of the Tank Scan functionality, understanding these details is not necessary. However if the pre-configured database fields are not sufficient to store all the required parameters of a Tank Scan, then the tables described below will need to be extended. As previously required by the IO Data Server setup, database entries need to be added to specific database tables in the same manner as needed to set up IO Alarms and Modbus Slave/Reads. The entries in these tables are what make the generic operations of the IO Data Server perform the specific task of Tank Scanning. These tables are DB_TABLE, DB_TABLE_COLUMN, and a new table called DB_TABLE_EVENT. Referring to Figure 3, the table called DB_TABLE remains mostly unchanged from its usage in IO Alarms and Modbus Slave/Reads. The addition is the new column of EVENT_ID, which will be described below. The table defines the database table into which values read from the PLC/Device s Registers will be stored. The table is pre-populated with the record shown in the screenshot in order to provide an out-of-the-box tank scan setup. 15

16 Technical Appendix An explanation of the important fields is defined below. Description TABLE_ID TABLE_NAME EVENT_ID This value is an arbitrarily defined string that is the key field for the record. Table DB_TABLE_COLUMN will use this value as a foreign key. This is the name of the database table that the values from the Register Reads will be stored into. As each register s value is read, it is written to this table using the Key Fields defined in DB_TABLE_COLUMN. This is a new field which is a foreign key into the DB_TABLE_EVENT table. All values which are part of a particular Tank Scan Data Set should have the same ID. PRIMARY_KEY_FIELDs should have a value of null. Table G3USER.DB_TABLE_COLUMN Figure 3 DB_TABLE Referring to Figure 4, the table called DB_TABLE_COLUMN remains unchanged from its usage in IO Alarms and Modbus Slave/Reads. This table defines the columns of the database table specified in DB_TABLE. The table is pre-populated with the records shown in the screenshot in order to provide an out-of-the-box tank scan setup. An explanation of the important fields is defined below. Description TABLE_ID DB_TABLE_COLUMN_ID COLUMN_NAME This value is a foreign key back to the DB_COLUMN table. These values are arbitrarily created IDs and are used as the key field of records in the table. DB_TABLE_EVENT will use these values as a foreign keys, and the IO_MAP screen s Destination/Source value will reference this ID as well. This value identifies one of the fields within the table specified by DB_TABLE.TABLE_NAME. These are the fields that the Tank Scan s PLC/Device Register s value will be written into. 16

17 Technical Appendix Tank Scan Support for GuardianControl Configuration Guide Description PRIMARY_KEY_FIELD A Y in this column indicates that the column is part of the primary key to the table specified in DB_TABLE.TABLE_NAME. An N indicates that it is a data field for a Register value to be placed into. Table G3USER.DB_TABLE_EVENT Figure 4 DB_TABLE_COLUMN Referring to Figure 5, the table called DB_TABLE_EVENT is new to IODataServer. This table defines the database Stored Procedure that will be called when all the Registers that make up a Group have been Read from the PLC/Device. This Stored Procedure can then process / move the register values from the temporary table defined by DB_TABLE.TABLE_NAME into a more permanent repository (defined within the stored procedure). The table is pre-populated with the records shown in the screenshot in order to provide an out-of-the-box tank scan setup. 17

18 Technical Appendix An explanation of the important fields is defined below. Description EVENT_ID STORED_PROCEDURE_ NAME PROC_ARGS_COLUMN_ IDS This is an arbitrarily defined value that is the key field in the table. It is used as a foreign key in the DB_TABLE_COLUMN table. This value defines the stored procedure to be executed. This field contains a string with the DB_TABLE_COLUMN_IDs that make up the arguments that the Stored Procedure will be invoked with. Note: multiple db_table_column_id values are separated by a comma. Figure 5 DB_TABLE_EVENT 18

19 Technical Appendix Tank Scan Support for GuardianControl Configuration Guide Table Relationship Overview Figure 6 shows the big picture of the relationships between the various IO Data Server tables that were described above. The query parameters shown in the upper right of the figure refer to those found on the Query Parameters tab of the IO MAP DTN Guardian3 Client screen of Figure 2d. They consist of the key Parameters / Values used to update the storage table defined in DB_TABLE.TABLE_NAME. Figure 6 Overview of IODataServer related tables 19

20 Technical Appendix 20

21 Schneider Electric 9110 West Dodge Road Omaha, NE Phone: As standards, specifications, and designs change from time to time, please ask for confirmation of the information given in this publication Schneider Electric. All rights reserved. 21