Page History

...

...

There are four main types of data that the EFM ABB Totalflow driver is capable of getting from an ABB Totalflow device.  These are:

• Application-Array-Register (AAR) data
• Alarm Data
• Event Data
• History Data

AARs are polled at a specified interval based on a poll rate and then made available via the OPC-UA interface.  Alarms, events, and history are made available to MQTT Transmission to be published as immutable Record objects to an MQTT server.  Typically these would be received by the MQTT Engine and MQTT Recorder modules running on a central Ignition Gateway and inserted into a database for later use or to be made available to other third party systems.

The quickstart will guide you through setting up the EFM ABB Totalflow driver module and configuring the device connection to:

• connect to the Totalflow device
• auto-discover applications running on the device,
• generate default Array-Register Templates for all TUBE application enumerations based on information obtained from respective INI file(s),
• generate default poll group that contains entries for all instantiated TUBE applications
• poll default poll group

It will also describe how to use the default Array-Register templates to generate custom templates and poll groups and how to view Alarm, Event, and Periodic and Daily History data

...

• Knowledge of Ignition and Cirrus Link Module Installation process
• Knowledge of MQTT Engine and MQTT Transmission configurations
• Installation of MQTT Engine, MQTT Transmission and MQTT Recorder (v4.0.x if using Ignition 8.1.x)
• Installation of latest compatible ABB Totalflow Driver

...

The global Array-Register definitions made available to the EFM ABB Totalflow module.  They are uploaded to the Ignition instance either as individual INI files or as ZIP archives that contain INI files.  Note that INI files are text files that are read by PCCU or WinCCU to determine how to display data within an application. These global Array-Register definitions can be referenced by the configurations of the individual ABB Totalflow devices that they apply to. A single Ignition Gateway may contain multiple global Array-Register definitions files that are used to configure Array-Register Templates (i.e. templates that contain array, register, access type, data type, and register name info) for available application types (enumerations)

...

The global Totalflow Applications Definitions are uploaded to the Ignition instance as individual CSV files and contain the following information about Totalflow applications:

• • Enumeration number
  • Name
  • Type
  • An optional flag (SU) that indicates that this is a 'Selectable Unit' application 
  • Part number(s)

...

...

The periodic mapping files are used for building up EFM Periodic and Daily History records.  They map various record fields to database column names so that user can adjust those column names to match requirements.  Periodic mappings also allow to exclude certain record fields to be used. They are uploaded to the Ignition instance in the form of specifically formatted CSV files

...

Totalflow Applications

...

This is a list of applications (fields include respective name, slot number, enumeration, revision and type) that are currently installed on a Totalflow device. This list is obtained either by 'auto-discovery' process that takes place on  configuration/restart or by importing specifically formatted CSV file

...

These are a subset of the global Totalflow Applications Definition files that apply to a specific device

...

Array-Register Definitions (Device)

...

...

There are 12 basic steps to getting all of the data available from an ABB Totalflow into Ignition

...

From the EFM ABB Totalflow Settings, define/upload the global Totalflow applications definitions available for all Totalflow devices in this Ignition instance.

...

Navigate to the 'Array-Register Templates' configuration panel. If 'Auto-Generate Templates and Poll Group' is enabled, verify the default templates are added to this device definition. If this configuration option is disabled, manually import the templates that apply.

...

At this point, the ABB Totalflow device should be fully configured.  To view data in Ignition launch Ignition Designer and open the OPC Tag Browser as shown below.  You should see the tags being polled from the ABB Totalflow device as shown below.  You can use these tags as any standard OPC tags in Ignition.

Image Removed

...

This section will describe how to use default Array-Register templates to generate custom templates and poll groups.

For the purpose of this exercise, lets assume that we only want to poll the AGA3-1 application, and we are interested in 'Current Values' and 'Fixed Analysis' data points only. Here is how to do it:

• Navigate to to the Auto Setup section of the device configuration and disable 'Auto-discovery' and 'Auto-generate Templates and Poll Group' as shown below.

Image Removed

...

Image Removed

Image Removed

• Go to the 'Poll Group' configuration panel and add a poll group to point to the custom template as shown below:

Image Removed

Image Removed

...

Image Removed

...

To view record data which includes ABB Totalflow alarms, events, and history data you must have MQTT Transmission installed on the instance with the EFM ABB Totalflow driver.

In addition, the following must be set up:

At the Central Gateway:

• Setup an SQL database connection
• Configure MQTT Engine
  • Add/update the Server configuration to point to the MQTT server
• Configure MQTT Recorder and configure it to use SQL database connection (previously set up in the Ignition Gateway)

At the Edge Gateway:

• Configure MQTT Transmission
  • Add/update the Transmitter configuration and/or the Tag folders so that an Edge Node is reporting with a Group ID, Edge Node ID, and Device ID (for example: G1, E1, D1)
  • Add/update the Server configuration to point to the MQTT server
  • From Ignition Designer, use the MQTT Transmission 'Refresh' Mechanism to make sure it is connected and reporting.
• Configure EFM ABB Totalflow ROC module
  
  • The Alarm, Event, and/or History poll rates in the Emerson ROC driver device configuration must be greater than zero depending on which data you wish to collect

OR

...

When all of these conditions are met, alarm, event, and/or history data will be collected, published, and stored via MQTT Recorder in the configured database.

...

The Array-Register definition archive file may contain lots of INI files - for example, the Array-Register Definitions zip file above contains 1477 files.

So it worth explaining how the ABB Totalflow driver selects which files to parse to create Array_Regsiter Templates. When global Array-Register definitions are applied to a device connection, the driver uses application revision information obtained during the 'auto-discovery' process and selects INI file names that match application revision and variant numbers.  As an example, below is application information obtained during the auto-discovery:

Image Removed

Note that since the revision number for the AGA3-1 meter application is 2101306-006, the INI parser will look for the 2101306-006.ini file in submitted ZIP archive.

If no direct match is found, it will look for the another possible match based on the revision number (i.e. 2101306) and revision variant (i.e. 005 and lower).

A user can check what INI files were picked by the driver as a source of Array-Register definitions. This information can be obtained form default Array-Register template generated by the driver by following the 'View INI Files' link as shown below:Image Removed

Below is an example that shows a portion the 2101306-006.ini file for the AGA3 Tube Application:

[Live Analysis Data] ExtHlp 5000 Help 1171 #Columns=2,Description=300,Value=100
dsc:Last Update from THERMS;cmd:4.5.1;typ:S;rwa:1;
dsc:Last Update from Other Source;cmd:4.2.2;typ:D;rwa:1;
dsc:Heating Value Live @ Tb and Pb;cmd:4.3.45;typ:F;
dsc:Real Relative Density Live @ Tb and Pb;cmd:4.3.44;typ:F;
dsc:N2 Live;cmd:4.3.46;typ:F;
dsc:CO2 Live;cmd:4.3.47;typ:F;
dsc:Methane Live;cmd:4.3.51;typ:F;
dsc:H2S Live;cmd:4.3.48;typ:F;
dsc:H2O Live;cmd:4.3.49;typ:F;
dsc:Helium Live;cmd:4.3.50;typ:F;
dsc:Ethane Live;cmd:4.3.52;typ:F;
dsc:Propane Live;cmd:4.3.53;typ:F;
dsc:N-Butane Live;cmd:4.3.54;typ:F;
dsc:I-Butane Live;cmd:4.3.55;typ:F;
dsc:N-Pentane Live;cmd:4.3.56;typ:F;
dsc:I-Pentane Live;cmd:4.3.57;typ:F;
dsc:N-Hexane Live;cmd:4.3.58;typ:F;
dsc:N-Heptane Live;cmd:4.3.59;typ:F;
dsc:N-Octane Live;cmd:4.3.60;typ:F;
dsc:N-Nonane Live;cmd:4.3.61;typ:F;
dsc:N-Decane Live;cmd:4.3.62;typ:F;
dsc:Oxygen Live;cmd:4.3.63;typ:F;
dsc:Carbon Monoxide Live;cmd:4.3.64;typ:F;
dsc:Hydrogen Live;cmd:4.3.65;typ:F;
dsc:Argon Live;cmd:4.3.66;typ:F;

The ABB Totalflow driver parses selected INI file and uses the info (Array-Register definitions) to generate Array-Register templates as shown below.

Note how highlighted (bold) lines shown above correlate to Array-Register Templates shown below.

Let's look at the 'dsc:N2 Live;cmd:4.3.46;typ:F;' line in more detail. The point description (i.e. N2 Live) is being used as a tag name. The 'typ:F' is the data type (i.e. floating point). Finally, the '4.3.46' defines the AAR (i.e. application, array, and register). 

As a result, a default Array-Register Template is generated by the driver for a specific application enumeration, and it contains all Array-Register points found in appropriate INI files.Image Removed

...