3000 - 6000 E Firmware and Software User Guide

USER GUIDE
3000/6000-E Firmware and Software

User Guide
January 2016
Revision A
OMNI Flow Computers, Inc.

12320 Cardinal Meadow Drive
Suite 180
Sugar Land, Texas 77478-6218 USA
Copyright © 2016 OMNI Flow Computers, Inc. All rights reserved.
Page 1 of 39
USER GUIDE
Document Revisions
Date Revision Document Changes
05 Feb 2016 A New Release
Page 2 of 39
USER GUIDE
Table of Contents
1 Introduction.............................................................................................................................5
1.1 Purpose...............................................................................................................................5
1.2 Applicable Firmware Revisions...........................................................................................5
2 Security....................................................................................................................................5
2.1 Security Prior to Introduction of Enhancements................................................................5
2.2 Modbus Passwords.............................................................................................................6
2.3 Security after Introduction of Enhancements.....................................................................7
2.4 New OMNI Front Panel Password Maintenance screen...................................................10
2.5 Permissions Tab................................................................................................................11
2.6 Access Type.......................................................................................................................11
2.7 Read Only..........................................................................................................................12
2.8 Operations........................................................................................................................12
2.9 Configurations...................................................................................................................12
2.10 Custom..............................................................................................................................13
2.11 Administrator Functions...................................................................................................14
2.12 Port Security.....................................................................................................................15
3 Checksum Lists.......................................................................................................................18
4 User-programmable Boolean and Variable Statements...........................................................19
5 Historical Alarm Report ..........................................................................................................20
6 Audit......................................................................................................................................20
6.1 Audit Log...........................................................................................................................21
6.2 Audit Variable Statements................................................................................................21
6.3 Audit GC Components......................................................................................................22
7 Products.................................................................................................................................23
7.1 Import / Export Products..................................................................................................23
7.2 Additional Products..........................................................................................................24
7.3 Numeric Product IDs.........................................................................................................25
8. Proving...................................................................................................................................25
8.1 Final Meter Factor............................................................................................................25
9 Virtual Inputs..........................................................................................................................27
9.1 Validation Thresholds.......................................................................................................28
9.2 Signal Type........................................................................................................................30
9.3 Input Type.........................................................................................................................30
9.4 Alarm Limits......................................................................................................................31
9.5 Virtual Input Value............................................................................................................32
9.6 Override Code...................................................................................................................33
9.7 Virtual Inputs Application Examples.................................................................................34
10 OMNICOM Modbus Database Browser...................................................................................36
Page 3 of 39
USER GUIDE
Page 4 of 39
USER GUIDE
1 Introduction
1.1 Purpose
Enhancements were added to the Omni 3000/6000 flow computer firmware

and OMNICOM software for the purpose of meeting the increasing needs of
field applications and to enhance the ease of configuration and use of the flow
computer.
1.2 Applicable Firmware Revisions
The enhancements were implemented beginning with firmware versions

20.75.10, 22.75.10, 23.75.10, 24.76.10, 26.75.10 and 27.75.10.
2 Security
The purpose of the security enhancements is to improve the security features of the Omni
3000/6000 flow computer.
2.1 Security Prior to Introduction of Enhancements
Front Panel
The following 6-character alphanumeric password levels are available via the
front panel keypad in versions of firmware prior to the enhancements:
 Privileged – Allows access to everything.

 Level 1 – Technician access to most entries except I/O point assignments,
Programmable Variables, and Boolean Statements, and assignment or
modification of passwords other than Level 1.
 Level 1A – Technician access to:
o Meter Factors
o K-Factors
o Densitometer Correction Factors
 Level 2 – Access to Operator type entries:
o Transducer manual overrides
o Product Gravity/Density Overrides
o Prove Operations
o Batching Operations
The Privileged level password must be entered at the front panel in order to edit the Level 1, 1A,
and 2 passwords.
Page 5 of 39
USER GUIDE
The OMNI will time out after one (1 hour) of inactivity after a valid password has been entered
and the password will have to be entered again to gain continued access.
There is also a setting from the front panel Password Menu to allow application of the program
lockout switch position (i.e., enable/disable program changes) to each of the Serial and Ethernet
communication ports.
2.2 Modbus Passwords
The following 8-character alphanumeric password levels are available for each
of the independent Serial and Ethernet communication ports:
o Level A – Allows complete access to all entries in the flow computer.
o Level B – Operator and Diagnostic functions . Cannot read or write to

configuration (allows reads of configuration used for Operator
functions).
o Level C – Read/View only.
If the Privileged level password is entered at the front panel, the user may
assign/modify the Level A password for each Serial/Ethernet communication
port. The Level B and C passwords can only be assigned or modified using
OMNICOM, while online with the flow computer, from any OMNICOM screen.
OMNICOM needs to be connected to each port where you wish to assign a Level
B or Level C password.
If the Level A password is used in OMNICOM to go online with the flow

computer, the Level A, B, and C passwords can all be modified using the key
press sequence CTRL+ALT+P from any OMNICOM screen. A Level B user and a
Level C user can modify only their respective level password.
The Omni flow computer will time out after 2 minutes of inactivity on the
communication port and the password will have to be entered again to regain
access.

Page 6 of 39
USER GUIDE
2.3 Security after Introduction of Enhancements
User Security
With the introduction of the enhancements, OMNICOM will always prompt for a
password when attempting to connect to the flow computer. See Figure 1.
Figure 1. OMNICOM Login
The default factory Administrator logon password is OMNI and can be entered in
uppercase or lowercase. When the long horizontal green status bar turns red after
entering the valid Administrator password, it indicates OMNICOM is now online with the
flow computer.
To access the OMNICOM Security menu, connect to an OMNI, and either click on the
“key” icon on the Ribbon menu or use the Toolbar menu to select Actions, then
Security. See Figure 2.

Page 7 of 39
USER GUIDE
Figure 2. Accessing Security
One Administrator and sixteen Users (1-16) are available for configuration.
Independent usernames and passwords for the Administrator and each User can be
configured. A blank password in the configuration is considered an “inactive” User. The
Administrator password cannot be blank.
2.3.1 User Information Tab

The User Information configuration tab under the Administrator and each User
Configuration menu contain the following parameters. See Figure 3.

Page 8 of 39
USER GUIDE
Figure 3. User Information
2.3.2 Password
The factory default Administrator password is OMNI. For the Users, all factory
default passwords are blank, meaning they are disabled. The Administrator
password can be changed by entering an alpha-numeric password up to 6
characters long. The Administrator password cannot be blank.
The password configured here will be the password for the Administrator level
logons from OMNICOM as well as full access from the flow computer front
panel. The configured User passwords will also be used to provide access via
OMNICOM as well as front panel access. The passwords configured here are
limited to the characters that can be entered from the flow computer front
panel keypad.
Note: The Administrator can see all passwords from the security configuration
screen in OMNICOM. If the Administrator has selected the option to allow users
to change their password, the non-Administrator Users will see asterisks for their
particular password and will not have access to other user’s information.

Page 9 of 39
USER GUIDE
2.3.3 User ID
This is a 16-character alpha-numeric User ID for identification and auditing. The
first four characters are always the User ID “Uxx-“ (where xx represents 00 for
Administrator or 01 through 16 for Users) and therefore only up to the last 12 of
the 16 alpha-numeric characters can be entered.
2.3.4 First Name and Last Name

Enter a maximum 16-character alpha-numeric First Name and maximum 16-
character Last Name to identify the Administrator or User. The first and last
names are displayed in the OMNICOM status bar after logon.
2.3.5 Front Panel Access

The Administrator is automatically granted full access to all Front Panel
functions and cannot be changed.
For non-Administrator Users, select the access level this User will have when
entering data at the front panel or when using WINPANEL. The following
selections are available:
 None (default)
 Level 2
 Level 1A
 Level 1
 Privileged
Note: Refer to the “Front Panel” section earlier in this document under “Security
Prior to Introduction of Enhancements” for details of the type of access
permitted by each front panel access level.
2.4 New OMNI Front Panel Password Maintenance screen:
Only the Administrator can access the front panel password menu.
 The front panel “Privileged Password” prompt has been renamed

“Admin”.
 Front panel password Levels 1, 1A and 2 are no longer configurable
from the front panel. They have been replaced by User names and
passwords configurable only from OMNICOM. The appropriate front
panel access level is assigned to each User from OMNICOM.
 Configuration of Level “A” passwords for Serial and Ethernet ports no
longer exists from the front panel. Level A passwords are now
configurable only from OMNICOM. The Level B password has been

Page 10 of 39
USER GUIDE
replaced by “Custom” permissions management and still configurable
only from OMNICOM, but only by the Administrator. The Level C
password must still be configured from OMNICOM, but only by the
Administrator, and now offers several permissions management
options. The “Read Only” option replaces Level C.
 The Program Enable/Lockout switch position can still be applied
individually from the front panel to each Serial or Ethernet port. If the
Program Enable/Lockout Switch is in the Lockout position and is
applied to a Serial or Ethernet port, it overrides any security “write”
permissions granted to Users or devices on that port.
2.5 Permissions Tab
The Permissions tab allows configuration of each individual User’s Access Type
to the Operations functions and the Configuration settings. See Figure 4.
Figure 4. User Permissions
The Administrator is automatically granted, by OMNICOM and the flow

computer, full Read/Write Access to all Operations and Configuration areas and
cannot be changed.
2.6 Access Type
The available Access Type options are:

Page 11 of 39
USER GUIDE
 Full Access (Level A)
 Read Only (Level C)
 Custom
Full Access
Selecting the “Full Access” option automatically provides access to all
Operations functions and Configuration areas and the thus all Operations and
Configuration settings are selected and disabled.
2.7 Read Only
Selecting the “Read Only” option allows the Administrator to enable or

disable only certain Operations functions and access to only certain
Configuration areas.
Note: If the Administrator does not grant access to a specific Operations

or Configuration item, the item will not appear in the OMNICOM tree. If
it is an item on an OMNICOM screen with other items, it will be hidden.
A note will be shown on the OMNICOM screen indicating the User does
not have permission to view the item(s).
With the “Read Only” selection, the following permissions will not be
allowed.
 Operate – Archive Maintenance

 Report Template Editor – Work Online with Individual
Templates
 Transmit configuration to an Omni
2.8 Operations
For Read Only access type, the following Operations items can be
enabled or disabled for an individual User.
 Retrieve Reports
 Retrieve Archives
 Batch Control
 Prove Control
 Test Communications
2.9 Configuration

Page 12 of 39
USER GUIDE
With Read Only access type, the Administrator can determine if the User should
be given permission to “Receive Configuration from the OMNI”. If this
permission is granted, further management of the following areas of the
received configuration are configurable by the Administrator.
 General Setup
 OMNI I/O
 Communications Ports
 Meter Runs
 Station
 Prover
 Products
 PID Control
 Boolean and Variable Statements
 Checksum Lists and Audit Configuration
 K-Factors, Meter Factors, and Density Correction Factors
2.10 Custom
Selecting the “Custom” Access Type option allows the Administrator to

enable or disable any of the Operations functions and access to any of
the Configuration areas.
Note: If the Administrator does not grant access to a specific Operations

or Configuration item, the item will not appear in the OMNICOM tree. If
it is an item on an OMNICOM screen with other items, it will be disabled
and shown in yellow. A note will be shown on the OMNICOM screen
indicating the User does not have permission to edit some items.
2.10.1 Operations
For Custom access type, the following Operations items can be
enabled or disabled for an individual User.
 Retrieve Reports
 Retrieve Archives
 Archive Maintenance
 Batch Control
 Prove Control
 Work online with individual Templates
 Test Communications
2.10.2 Configuration

Page 13 of 39
USER GUIDE
For Custom access type, the following Configuration items can
be enabled or disabled for an individual User.
 Transmit Configuration to the OMNI

 Receive Configuration from the OMNI
2.10.3 Transmit Configuration to the OMNI

Enabling this first option will allow the User to transmit a
configuration file to the flow computer. This assumes that the
“Disable Download?” option is set to N for “No” in the OMNI
flow computer password menu. This setting is accessible only
from the front panel of the flow computer. If set to Y for “Yes”,
the flow computer will not accept an attempt by OMNICOM to
send a configuration file. An Exception Code 06 will be
displayed by OMNICOM indicating Downloads are disabled in
the flow computer.
2.10.4 Receive Configuration from the OMNI

If the Administrator grants this access to the User, further
management of the following areas of the received
configuration is configurable by the Administrator.
 General Setup
 OMNI I/O
 Communications Ports
 Meter Runs
 Station
 Prover
 Products
 PID Control
 Boolean and Variable Statements
 Checksum Lists and Audit Configuration
 K-Factors, Meter Factors, and Density Correction
Factors
2.11 Administrator Functions

The Administrator Functions screen allows the Administrator to manage the changing of
passwords by the Users as well as the ability to import or export security settings. See
Figure 5.

Page 14 of 39
USER GUIDE
Figure 5. Administrator Functions
2.11.1 Allow Users to Change Password

The Administrator can select if Users are able to change their personally
assigned passwords in the system. The default is “No”.
2.11.2 Import
The Administrator can connect to an OMNI flow computer and import a
saved encrypted security settings file from the PC hard disk into
OMNICOM, then transfer the security settings to the flow computer.
The Administrator will be asked if they wish to override the
Administrator settings that are currently in the OMNI. (The
Administrator settings include the Administrator’s user information, the
“allow users to change password” setting, and the port security
settings.) The default is “No”, so that only the User settings will be
overwritten.
2.11.3 Export
The Administrator can read the security settings from an OMNI into
OMNICOM and then export the security settings to an encrypted file on
the PC hard disk.
2.12 Port Security

Page 15 of 39
USER GUIDE
There is port security for each of the configured ports in the system. Security can be
enabled or disabled on every port. The default is disabled.
The Port Security can only be managed by the Administrator.
There are eight (8) password entries configurable for each port. However, It is
important to note that only with Ethernet ports can there be more than one user
connected simultaneously.
The following settings are available for each password entry. See Figure 6.
 Port ID
 Audit ID
 ASCII Password
 Integer Password
 Time Out (seconds)
 Port Security Level
Note: For serial ports on a peer-to-peer Master Omni flow computer or Slave Omni flow
computer, disable security on that port to ensure proper communications.
Figure 6. Port Security
2.12.1 Enable Port Security

Security can be independently enabled or disabled for each of the serial
and Ethernet communication ports in the flow computer. The default is
port security disabled on all ports.

Page 16 of 39
USER GUIDE
Up to eight (8) different passwords can be configured for access for
each port. The following items are associated with the password
configuration:
2.12.2 Port ID
For every physical port’s security configuration, there are 8 Port IDs pre-
assigned with the format “PXY-“where “X” is the port number 1-6 and
“Y” is the password entry 1-8. For example, physical port 1 is
automatically pre-assigned Port IDs P11-P18 and physical port 6 is
automatically pre-assigned P61–P68.
Immediately following a pre-assigned Port ID, enter a 12-character

alphanumeric Audit ID. The pre-assigned Port ID, in combination with
the Audit ID, is used to log changes in the Audit Log when the device
connected to the port makes a change.
2.12.3 ASCII Password

Enter an 8-character alphanumeric password to be used when the
device connects to the flow computer. ASCII passwords are case
sensitive and can be any ASCII character except spaces. ASCII passwords
cannot be duplicated on a port. The device can log in using this
password or the integer password described next.
Note that a blank password is considered as inactive. If a device writes a

blank ASCII password to the OMNI while logged on, it will be logged off.
2.12.4 Integer Password

Enter a 32-bit integer ranging from zero to 9999999 to be used when
the device connects to the flow computer. The default is zero. The
integer passwords cannot be duplicated on a port. The device can log in
using this password or the ASCII password described above.
Note that a zero password is considered as inactive. If a device writes a

zero integer password to the OMNI while logged on, it will be logged off.
2.12.5 Time Out (seconds)

Enter the inactivity time in seconds for this password and this port. It
ranges from zero to 120 with a default of zero. A zero entry means the
password will not time out.
2.12.6 Port Security Level

The port security levels are the same as the levels that exist in prior
firmware. The selections are:

Page 17 of 39
USER GUIDE
 Disabled
 Level A
 Level B
 Level C
Note: Refer to the earlier section in this document titled “Modbus

Passwords” for details of the type of access permitted by each port
security level.
3 Checksum Lists
To enable fast remote auditing or for Change Management purposes, Four (4), user-
configurable lists of Modbus registers for creating checksums have been introduced.
The contents of each register in the individual checksum lists are summed to produce a
unique number or checksum. The Checksum Lists allow the flow computer to determine
when any register specified in a checksum list has changed value.
The flow computer generates and records independent alarms for each of the four lists
to indicate a change has occurred in the value of at least one of the configured registers
in the list. The user would then examine the Audit Report and Alarm Reports to identify
the change and take further appropriate actions. The checksum lists can easily be
configured from the OMNICOM “Configure/Checksum Lists” menu. See Figure 7.
Figure 7. Checksum Lists
The user enters up to 100 configuration registers for each of the four checksum lists.
The flow computer ignores real time variables that usually change constantly (e.g 7101
for Meter 1 Gross Flow Rate). For ease of use, the user should use the Database
Browser feature of OMNICOM to enable simple additions to this feature.

Page 18 of 39
USER GUIDE
The flow computer calculates a checksum based on the values contained inside the
configured registers in each of the four lists. A fifth checksum is automatically calculated
that includes the values inside all the Modbus registers defined in all four of the
configured checksum lists.
The five new checksums can be viewed from the front panel of the flow computer on
the same screen that contains the checksum of the firmware installed in the flow
computer, by pressing STATUS DISPLAY and scrolling to the bottom of the screen.
The following Modbus database registers in Table 1 are associated with the checksum
lists feature and may be read remotely using OMNI’s standard Modbus read commands.
Register Data Type Description

2614 Boolean Configuration List 1 Checksum Change Alarm
2618 Boolean Configuration List Total Checksum Change Alarm
2729 Boolean Configuration List Checksum Change Acknowledge
Command
4641 ASCII-8 Configuration List 1 Checksum
4645 ASCII-8 Configuration List Total Checksum
23300- 16-bit Unsigned Integers Configuration List 1 Entries 1 – 100
23399
23499
23599
23699
Table 1. Checksum Addresses
The “Configuration List Entry” registers in the above Error! Reference source not found.
(e.g. 23300-23399), contain the Modbus register addresses of the registers specified in the
checksum list, not the values contained in the specified registers.
4 User-Programmable Boolean and Variable Statements
The pre-existing number of user-programmable Boolean statements was 64, ranging

from statements 1025 through 1088 and the number of user-programmable Variable

Page 19 of 39
USER GUIDE
statements was also 64, ranging from statements 7025 through 7088. Both have been
increased to 128 statements.
The additional 64 Boolean statements range from statement 11025 through 11088 and
begin as the 65th statement after statement 1088 in the OmniCom configuration screen.
The additional 64 Variable statements range from statement 27025 through 27088 and
begin as the 65th statement after statement 7088 in the OmniCom configuration screen.
See Figure 8.
Figure 8. Boolean and Variable Statements
The following Table 2 is a list of the Modbus registers associated with the pre-existing
and new Boolean and Variable statements after the enhancements.
Boolean and Variable Statements After Enhancements

Statement Numbers (same as Statement Statement Remark
“result” registers) Configuration Registers - ASCII
Registers - ASCII
Booleans 1025-1072 and 1073- 14001-14048 and 14101-14148 and 14241-14256
1088 14201-14216
New Booleans 11025-11088 14401-14464 14501-14564
Variables 7025-7072 and 7073 14051-14098 and 14151-14198 and 14261-14276
– 7088 14221-14236
New Variables 27025-27088 14601-14664 14701-14764
Table 2. Boolean and Variable Addresses

Page 20 of 39
USER GUIDE
5 Historical Alarm Report
The circular Historical Alarm Report has been expanded from storing 500 alarms to
storing 1000 alarms.
6 Audit
6.1 Audit Log

OMNI’s circular Audit Log has been expanded from storing the last 150 events
to storing the last 1,000 events. The Audit Log recording function has also been
updated to include changes to the Modbus registers containing all variables
identified in API MPMS Chapter 21.1 and Chapter 21.2.
In previous versions of firmware where only the last 150 events are recorded,
the Audit Log could be retrieved as a text file or alternately as a comma-
separated file from archive 712. With the enhanced firmware, the Audit Log can
still be retrieved as a text file but archive 712 is no longer available and the
comma-separated file must now be retrieved from archive 713.
6.2 Audit Variable Statements
A new configuration option has been introduced, to record in the Audit Log
when changes are made to any configuration register by the result of user-
programmable custom Variable Statements. “Program Statement” will appear
in the Audit Log as the Source of change. The user should then review the
Program Statements and take any necessary actions. See Figure 9.
Figure 9. Variable Statement Auditing
Select “Audit On” to audit configuration changes made by the Variable Statements.

Page 21 of 39
USER GUIDE
6.3 Audit GC Components

In previous versions of gas firmware R23/27, any changes to the override gas
composition were recorded in the Audit Log only when entered from the front
panel or when using WinPanel.
The user has the option to Record or Not Record changes in the live or override
gas composition. See Figure 10.
Figure 10. GC Component Auditing
If a Gas Chromatograph is configured in the OMNICOM Equipment List tab of the

General Setup configuration menu, then all four options below shall be available and
can be selected as required by the user:
 Audit OFF
 Audit both live and override GC components (default)
 Audit override GC components
 Audit live GC components
If a Gas Chromatograph is not configured in the Equipment List tab, only the following
options are available for selection:
 Audit OFF
 Audit override GC components

Page 22 of 39
USER GUIDE
Note: If a user enables a GC in the Equipment List while the audit override selection is
”Audit override GC components”, OmniCom will automatically change the selection to
“Audit both live and override GC components”. You may change the selection to any of
the other selections if you wish.
Similarly, if a user disables the GC in the Equipment List while the audit override selection
is “Audit both live and override GC components” or “Audit live GC components”,
OmniCom will automatically change the selection to “Audit override GC components”.
You may change the selection to Audit OFF if you wish.
7 Products
7.1 Import/Export Products
Product Configuration files can be imported or exported for Applications 20 and

24 if the Advanced User command line switch "-AU" is used in your OMNICOM
icon properties. See Figure 11.
Figure 11. Advanced User Switch
After starting OMNICOM and ensuring the appropriate configuration file has
been opened, access the Import/Export Product feature by right-clicking on any
product in the Configuration Tree or on any of the individual Product
configuration screens. See Figure 12.

Page 23 of 39
USER GUIDE
Figure 12. Product Configuration
When saving exported files, the default extension is "*. oXXprd", where XX is the
application version (20 or 24). However, the user may enter any extension.
Files may be imported only when offline but may be exported while online or
offline.
The configuration settings for ALL products will be exported. In the case of an
import, use caution, as ALL products will be overwritten with the contents of the
imported file.
7.2 ADDITIONAL PRODUCTS
The number of configurable products has been expanded from 16 to 32

beginning with versions of liquid firmware 20.75.10 and 24.76.10. See Figure
13.

Page 24 of 39
USER GUIDE
Figure 13. Product Tree
7.3 NUMERIC PRODUCT ID
Some polling systems cannot read ASCII string type Modbus registers from flow
computers that identify the configured products. Therefore, a 32-bit Integer
configuration register for each of the 32 products has been introduced in
versions 20.75.10 and 24.76.10 firmware so that in addition to, or instead of the
existing 8-character ASCII string, a meaningful number can be configured to
identify each product. The identifier can be from 1 to 7 digits wide with values
ranging from 1 to 9999999. The addresses are specified in Table 3.
PRODUCT IDs
Products ASCII String Registers New 32-Bit Integer Registers
1 – 16 4820 - 4835 15156 - 15171
17 – 32 4720 - 4735 15383 - 15398
Table 3. Product ID Addresses
8 Proving
8.1 Final Meter Factor
A new option for calculating the Final Meter Factor on the prove sequence
report is introduced in firmware versions 22.75.10 and 26.75.10

Page 25 of 39
USER GUIDE
In some applications with unstable flow rates, it is sometimes difficult to

complete a prove sequence using the Counts run repeatability method and
therefore the less stringent Meter Factor run repeatability method is available.
However, some end-users have requested two options for the Final Meter
Factor when using the Meter Factor run repeatability method.
The “Run Repeatability Based On” selections are still available as “Counts” or
“Meter Factor” and have not changed.
A new configuration setting titled “Final Meter Factor” has been introduced that
becomes available only when “Run Repeatability Based On” is configured as
“Meter Factor” instead of “Counts”. See Figure 14. There are two options
selectable for the Final Meter Factor. They are:
 GSVp/GSVm
 Average of Intermediate Meter Factors
Figure 14. Prover Setup
8.1.1 Run Repeatability Based on Counts
When selecting “Counts” Run Repeatability method, the Final Meter

Factor calculation always uses the formula GSVp/GSVm.

Page 26 of 39
USER GUIDE
8.1.2 Run Repeatability Based on Meter Factor
When selecting “Meter Factor” Run Repeatability method, the Final

Meter Factor calculation depends on the selection:
 GSVp/GSVm
Uses the Meter Factor method for run repeatability
comparisons by calculating an Intermediate Meter Factor
for each prove run. Calculates the Final Meter Factor with
the GSVp/GSVm method instead of using the average of the
Intermediate Meter Factors.
 Average of Intermediate Meter Factors

Uses the Meter Factor method for run repeatability
comparisons by calculating an Intermediate Meter Factor
for each prove run. Calculates an Average Meter Factor
from the Intermediate Meter Factors of the accepted prove
runs. Uses the Average Meter Factor as the Final Meter
Factor.
9 Virtual Inputs
Virtual Input channels 90-98 can be configured from OMNICOM under the Process I/O
section of the OMNI I/O node of the Configure tree. See Figure 15.

Page 27 of 39
USER GUIDE
Figure 15. Virtual Inputs
9.1 Validation Thresholds

The firmware enhancements now introduce “Validation Thresholds” for the
Virtual Input channels 90 – 98. This allows the flow computer to automatically
filter the engineering value sent to each Virtual Input and provide Override
strategies similar to a live transducer.
9.1.1 Validation Thresholds – Percentages

The new Low and High percentage Validation Threshold configuration settings
applicable to all Virtual Inputs are located in OMNICOM under General Setup in
the Factors & Constants screen. See Figure 16.

Page 28 of 39
USER GUIDE
Figure 16. Validation Thresholds
The Modbus registers that hold these user-specified configuration settings are:
17134 = Validation Threshold Low %
17135 = Validation Threshold High %
9.1.2 Validation Thresholds - Calculated
The Low and High Validation engineering values displayed in the Virtual Inputs
configuration screen are Read-Only and are automatically calculated by the flow
computer. See Figure 17.
Figure 17. Virtual Input Validation Thresholds
9.1.2.1 Validation Threshold Low. This value is calculated using the low
percentage setting entered in the OMNICOM Factors and Constants
menu. It is used with the Low Alarm Limit and High Alarm Limit span
configured under the individual Virtual Input channel to calculate a Low

Page 29 of 39
USER GUIDE
Validation Threshold engineering value. When using an engineering
value under the calculated low threshold, a Transducer Fail Low alarm is
raised, resulting in the flow computer using the override strategy
configured for the Virtual Input.
9.1.2.2 Validation Threshold High: This value is calculated using the high
percentage setting entered in the OMNICOM Factors and Constants
menu. It is used with the Low Alarm Limit and High Alarm Limit span
configured under the individual Virtual Input channel to calculate a High
Validation Threshold engineering value. When using an engineering
value above the calculated high threshold, a Transducer Fail High alarm
is raised, resulting in the flow computer using the override strategy
configured for the Virtual Input channel.
9.2 Signal Type

In firmware revisions prior to the enhancement, the Virtual inputs had a
configuration item called ‘Signal type’. This has been removed in the enhanced
firmware since the virtual input does not represent a live analog or pulse type
input signal.
9.3 Input Type

The Input Types are now limited to the following options. See Figure 18.
 Unassigned
 Temperature
 Pressure
 DP
 Density/Gravity
 Auxiliary Input

Page 30 of 39
USER GUIDE
Figure 18. Virtual Inputs Types - Liquid
For Gas Applications, these additional items are available. See Figure 19.
 N2
 CO2
 HV
 SG as 4-20 mA
Figure 19. Virtual Input Types - Gas
9.4 Alarm Limits

Page 31 of 39
USER GUIDE
Although the operating Alarm Limits configuration settings for the Virtual Input
channels are not new configuration settings, they will be discussed here as they
are used by the flow computer along with the new Validation Threshold
percentage settings to calculate the Validation Threshold Low and High
engineering values that establish when to generate Transducer Fail Low or
Transducer Fail High alarms which will then cause the flow computer to
implement the selection for the Virtual Input channel Override strategy.
9.4.1 Alarm Limits
 Low Alarm Limit. Enter the measurement value in engineering units

below which the Low Alarm of the process variable activates.
 High Alarm Limit. Enter the measurement value in engineering units
above which the High Alarm of the process variable actives.
9.5 Virtual Input Value

Each virtual input has an assigned register in which the engineering value of
the Virtual Input is written. See Table 4.
Register Description
7690 Input Value of Virtual Input #90
Table 4. Virtual Input Addresses
OMNICOM displays the register number next to the Tag ID on the Virtual Input
screen. See Figure 20.

Page 32 of 39
USER GUIDE
Figure 20. Virtual Input Modbus Index
9.6 Override Code

The Fail Override strategy for Virtual Input channels 90 – 98 and Remote Input
channel 99 in firmware prior to the enhancements is fixed at “Never Use” and
cannot be changed. However, the effect was the same as using “Always Use” as
the override strategy.
The Override strategy for Remote Input channel 99 has not changed and
effectively still uses the Override value always written to it.
In the enhanced firmware revision the override code selections are:
 Never Use
 Always Use
 Use if validation threshold exceeded
 Use last hour’s average if validation threshold exceeded
9.6.1 Never Use

Using the engineering value written to the Virtual Input channel
Modbus register (e.g. 7698 for Virtual Input 98), the flow computer will
compare the written value to the Low and High operating alarms
settings and if outside the limits will generate a Low or High Alarm. The
same written value will be used to determine if it is outside the
calculated Low and High Validation Thresholds engineering values and if
outside the limits will generate Transducer Fail Low or Transducer Fail
High Alarms. If a Transducer Fail Low or Transducer Fail High alarm is
generated, the flow computer will continue to use whatever value is
being written to the Virtual Input channel. This strategy is not normally
recommended for field use and is mostly used for testing purposes.
9.6.2 Always Use

Page 33 of 39
USER GUIDE
The flow computer will disregard any engineering value written to the
Virtual Input channel Modbus register (e.g. 7698 for Virtual Input 98)
and will instead use the override value configured for the Virtual Input
channel. If the configured override value is outside the Low and High
operating alarm limit settings, the flow computer will generate a Low
Alarm or High Alarm accordingly. Transducer Fail Low or Fail High
Alarms WILL NOT be generated.
9.6.3 Use if validation threshold exceeded

High Alarms. If the Transducer Fail Low or Transducer Fail High alarm is
raised it will use the configured Override value.
9.6.4 Use last hour’s average if validation threshold exceeded

High Alarms. If the Transducer Fail Low or Transducer Fail High alarm is
raised it will use the Weighted Average of the previous “moving” 60
minutes.
Note: The “moving” 60 minutes may not necessarily be the same as the
Weighted Average from the top of one hour to the top of the next hour.
9.7 Virtual Inputs Application Examples
9.7.1 Example #1 Prior to Enhanced Firmware:

Page 34 of 39
USER GUIDE
To determine which Modbus register to write the Override engineering value to
for each of the Virtual Input channels, the Virtual Input channel first has to be
configured, then assigned to a meter (e.g. assign to Meter 1 Temperature).
Once the Virtual Input channel is assigned to Meter 1 Temperature, return to
the Virtual Input configuration screen in OMNICOM and highlight the Override
Value field, pressing ALT+M will reveal the Modbus register to write to. In the
case of Meter 1 Temperature, it is Modbus register 7165.
Modbus register 7165 can be configured with an override value the flow
computer will always use or a value can be written to it via a remote Modbus
write or using a user-programmable Custom Variable statement to transfer the
value from a live input channel (e.g. Auxiliary Input 1 value stored in register
7809). The custom
Variable statement would be written as follows if transferred from Auxiliary

Input #1:
7025: 7165=7809
Remark: M1Temp
The Virtual Input channel Alarm Limits settings are used to generate the M1
Temperature Lo Alarm or M1 Temperature High Alarm. However, if the live
temperature value being received by the Virtual Input channel from Auxiliary
Input #1 falls outside the Virtual Input channel operating alarm limits settings,
no override strategy is available in the firmware prior to the enhancements.
If an unacceptable process input value from a live transducer arrives at the

Virtual Input channel it can sometimes create Calc Out of Range alarms or
possibly generate bad correction factors or even large FWA values. It was
therefore necessary to write additional user-programmable custom Variable
statements and Boolean Statements to filter the engineering value at the
Auxiliary Input channel so that when the Auxiliary Input #1 Transducer Fail Low
or Transducer Fail High alarms are generated, the live value will no longer be
passed to the Virtual Input channel override register by the custom statements
and instead an alternate acceptable value will be passed. In some cases, several
User-programmable custom Variable statements and Boolean statements were
required in order to implement the desired filtering and override strategy.
9.7.2 Example #2 with Enhanced Firmware:

Page 35 of 39
USER GUIDE
Assume Meter 1 Temperature has been assigned Virtual Input channel 98 with
the following setting:
 Validation Thresholds Low and High settings in the Factors &

Constants configuration screen both configured to 20%,
 Virtual Input 98 Temperature Alarm Limits Low and High set to
0 DegF and 100 DegF respectively.
 The Override strategy for Virtual Input 98 is set to “Use if
validation threshold exceeded” and the Override value is
specified as 75.0 DegF.
The Validation Thresholds Low and High values automatically calculated by the
flow computer will be -20.0 DegF and 120.0 DegF respectively.
When the value being written to Virtual Input 98 to Modbus register 7698 falls
to 0.0 DegF the flow computer will raise a Temperature Low Alarm and if it
continues to fall to -20.0 DegF the flow computer will raise a M1 Temperature
Transducer Fail Low alarm and will begin to use the override value of 75.0 DegF
much in the same way the strategy for a non-Virtual input channel can be
configured.
Conversely, when the value being written to Virtual Input 98 to Modbus register
7698 reaches a value of 100 DegF the flow computer will raise a M1
Temperature High alarm and if it continues to rise and reaches 120 DegF, the
flow computer will raise a M1 Temperature Transducer Fail High alarm and will
begin to use the override value of 75.0 DegF per the Override strategy that is
configured.
10 OMNICOM Modbus Database Browser
A searchable Modbus Database Browser has been introduced into OMNICOM. A

configuration file must be open in order for the Browser to be accessible. The Browser
is accessible in OMNICOM by pressing on the magnifying glass icon on the ribbon
menu or by clicking on the menu bar selection labeled “Help”, then selecting “Database
Browser”. See Figure 21.

Page 36 of 39
USER GUIDE
Figure 21. Database Browser Menu Option
Note: If you do not see this selection in OMNICOM, you should upgrade to OMNICOM
version 1.55 or newer, which can be installed from the USB key attached to the device at
shipment.
The top left portion of the Browser screen, under the section “Database Information”
displays the Application version of the Modbus database that is currently being viewed.
To view a Modbus database for a different application version, you must open or create
a configuration file associated with the particular application you want to view. See
Figure 22.

Page 37 of 39
USER GUIDE
Figure 22. Database Browser
A varied selection of “Data Type” search filters can be applied after specifying a “Find”
keyword. See Figure 23.
Figure 23. Database Browser Filtering
The available Data Type filters are:

 All Data Types

Page 38 of 39
USER GUIDE
 Boolean
 Integer (16-bit)
 Integer (32-bit)
 Float (32-bit)
 Double (64-bit)
 ASCII
 Custom Packet
 Archive
 Buffer
If the “Clear Filters” button is pressed, it will default to “All Data Types” as the Data Type
filter.
Secondary filters can also be applied. They are:
 Meter 1
 Meter 2
 Meter 3
 Meter 4
 Station
 System
Press the Search button to execute the search. Once the search is complete, the results
are sorted by register address. They can be resorted in a different order by clicking on
any of the column headers (e.g. Data Type).
The Browser can be invoked from configuration screens that accept Modbus register
addresses, such as Digital I/O or Analog Output configuration screens. To invoke, click
on the configuration entry field, then click on the ellipse (button with 3 dots) located to
the right of the setting to invoke the Browser. You may also right-click and select
Browser from the pop-up menu to invoke the Browser.
Once in the Browser, double-click on the register you want to put in the configuration
entry or highlight the register and press the 'Select' button.
To select multiple registers to put into a configuration list, such as the Archive
Configuration or Custom Packets, double-click on the Modbus register you wish to start
with. Select multiple registers from the Browser by holding the CTRL button and clicking
on the registers. Once all the registers are selected, press the 'Select' button. The
registers selected will be placed sequentially in the list beginning with the starting point
register.

Page 39 of 39

3000 - 6000 E Firmware and Software User Guide

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

3000 - 6000 E Firmware and Software User Guide

Uploaded by

Copyright:

Available Formats

USER GUIDE

3000/6000-E Firmware and Software

OMNI Flow Computers, Inc.

Copyright © 2016 OMNI Flow Computers, Inc. All rights reserved.

Date Revision Document Changes

05 Feb 2016 A New Release

Copyright © 2016 OMNI Flow Computers, Inc. All rights reserved.

4 User-programmable Boolean and Variable Statements...........................................................19

5 Historical Alarm Report ..........................................................................................................20

10 OMNICOM Modbus Database Browser...................................................................................36

Copyright © 2016 OMNI Flow Computers, Inc. All rights reserved.

Copyright © 2016 OMNI Flow Computers, Inc. All rights reserved.

Enhancements were added to the Omni 3000/6000 flow computer firmware

1.2 Applicable Firmware Revisions

The enhancements were implemented beginning with firmware versions

2.1 Security Prior to Introduction of Enhancements

 Privileged – Allows access to everything.

2.2 Modbus Passwords

o Level A – Allows complete access to all entries in the flow computer.

o Level B – Operator and Diagnostic functions . Cannot read or write to

o Level C – Read/View only.

If the Level A password is used in OMNICOM to go online with the flow

Copyright © 2016 OMNI Flow Computers, Inc. All rights reserved.

2.3 Security after Introduction of Enhancements

Figure 1. OMNICOM Login

Copyright © 2016 OMNI Flow Computers, Inc. All rights reserved.

Figure 2. Accessing Security

2.3.1 User Information Tab

Copyright © 2016 OMNI Flow Computers, Inc. All rights reserved.

Figure 3. User Information

Copyright © 2016 OMNI Flow Computers, Inc. All rights reserved.

2.3.4 First Name and Last Name

2.3.5 Front Panel Access

2.4 New OMNI Front Panel Password Maintenance screen:

 The front panel “Privileged Password” prompt has been renamed

Copyright © 2016 OMNI Flow Computers, Inc. All rights reserved.

2.5 Permissions Tab

Figure 4. User Permissions

The Administrator is automatically granted, by OMNICOM and the flow

2.6 Access Type

The available Access Type options are:

Copyright © 2016 OMNI Flow Computers, Inc. All rights reserved.

2.7 Read Only

Selecting the “Read Only” option allows the Administrator to enable or

Note: If the Administrator does not grant access to a specific Operations

 Operate – Archive Maintenance

Copyright © 2016 OMNI Flow Computers, Inc. All rights reserved.

Selecting the “Custom” Access Type option allows the Administrator to

Note: If the Administrator does not grant access to a specific Operations

Copyright © 2016 OMNI Flow Computers, Inc. All rights reserved.

 Transmit Configuration to the OMNI

2.10.3 Transmit Configuration to the OMNI

2.10.4 Receive Configuration from the OMNI

2.11 Administrator Functions

Copyright © 2016 OMNI Flow Computers, Inc. All rights reserved.

Figure 5. Administrator Functions

2.11.1 Allow Users to Change Password

2.12 Port Security

Copyright © 2016 OMNI Flow Computers, Inc. All rights reserved.

The Port Security can only be managed by the Administrator.

Figure 6. Port Security

2.12.1 Enable Port Security

Copyright © 2016 OMNI Flow Computers, Inc. All rights reserved.