ABB Totalflow provides a configuration section to the Ignition Gateway that can be seen in the Configure section of the Ignition Gateway web UI. There is one configuration page - EFM ABB TOTALFLOW → Settings. The page contains two tabs: Array-Register Definitions and EFM Mappings.
Support Files
The Cirrus Link default Array-Register Definitions and EFM Mapping files can be used as a starting point for configuring the EFM ABB Totalflow module.
Download Array-Register Definitions zip file here
Download Meter Periodic Mapper CSV file here
(Note these need to be thoroughly tested and reviewed in your application before they are put into production)
TLP Definitions
The first tab contains settings for creating sets of Array-Register Definitions:
New Array-Register Definitions can be created by following the 'Create new Array-Register Definition' link as shown below:
Main Properties
EFM Mappings
The EFM Mappings are used for publishing EFM Records representing Daily and Periodic History entries that are polled from a device.
Periodic Mappings
The periodic mapping files are used for building up EFM Daily and Periodic History Records. They define column names for record's fields.
Click here for more details on the content of these mapping files.
The Periodic Mappings tab shows all uploaded Periodic Mapping files as shown below.
A new Periodic Mapping can be added by clicking on the "Create new Periodic Mapping..." link.
Main Properties
ABB Totalflow Device Connection
Device connection for ABB Totalflow module can be configured via OPC-UA SERVER. Selecting OPC-UA SERVER → Devices opens respective configuration page as shown below:
New ABB Totalflow device can be created by following the 'Create new Device...' link and choosing 'EFM ABB Totalflow' device as shown below:
This opens the 'New Device' configuration mage for ABB Totalflow Device:
General
Connectivity
- Hostname
- Hostname or IP address of the device
- TCP Port
- Socket Timeout
- TCP socket operation (i.e. connect and read) timeout in seconds. A timeout of zero is interpreted as an infinite timeout. To use system default, set to -1.
- Connection Type
- Connection type selector. Either maintain one connection or establish new connection per each transaction. The ON_DEMAND option is recommended.
- PERSISTENT - The ABB Totalflow driver keeps a TCP connection open and this connection is being shared by all polling threads.
- ON DEMAND - A TCP connection is opened by each polling thread when it needs to poll and closed upon completion. Note that ABB Totalflow device still allows only one connection at a time.
- Enable auto-discovery
- Enables ABB Totalflow driver to run application auto-discovery at startup and re-configuration.
DB2 Protocol
- Station ID
- Station ID of this ABB Totalflow device
- Keep Alive
- Time interval (in seconds) between 'keep-alive' polls that may be required to maintain PERSISTENT connection if ABB Totalflow device is configured to disconnect on inactivity. To disable 'keep-alive' polls, set to 0.
- Host Timeout
- Timeout (in milliseconds) to wait for a reply from the host. The default value is 3000 milliseconds.
- Poll EOT Timeout
- Time (in milliseconds) to wait to ensure there are no more packets to receive. The default value is 700 milliseconds.
- Auto-Discovery EOT timeout
- Time (in milliseconds) to wait to ensure there are no more packets to receive during auto-discovery. The default value is 2000 milliseconds.
- Number Retries
- Number of retries if DB2 request is NAKed.
- Supervisory Frames
- Number of DB2 supervisory frames.
- Password
- DB2 Protocol Security Code. If device is set with default security code of 0000, leave blank.
- Add All Array-Register Definitions
- Automatically add all the Array-Register definitions configured within the ABB Totoalflow driver module.
RBAC
- RBAC Enabled
- Enables Role-Based Access Control (RBAC) is enabled on the device and therefore the X_RBAC frame needs to be included in the DB2 request message.
- Operator ID
- Operator ID. If RBAC is not enabled on the device, leave blank.
- Password
- Operator password. If RBAC is enabled on the device, leave blank.
Records Signature
Sparkplug
- Group ID
- An ID representing a logical grouping of Edge Nodes and Devices
- Edge Node ID
- An ID representing an Edge or Network (EoN) Node
- Device ID
- An ID representing a Device