Page History

...

This opens the 'New Device' configuration page for EFM ABB Totalflow Device. The configuration sections available are General, Device, Connectivity, Auto Setup, Import Policies, DB2 Protocol, RBAC, Date/Time, Records, Records Signature, Common File Exchange (CFX), Sparkplug and Advanced Settings.

...

• Enable auto-discovery
  • Checkbox to enable ABB Totalflow driver to run application auto-discovery at startup and re-configuration. Selected by default.
• Add All Totalflow Application Definitions
  • Checkbox to automatically adding all Totalflow Applications definitions configured within the ABB Totalflow driver module. Selected by default.
• Add All Array-Register Definitions
  • Checkbox to automatically add all the Array-Register definitions configured within the ABB Totalflow driver module. Selected by default.
• Auto-Generate Templates and Poll Groups

  • Checkbox to automatically generate default Array-Register templates and default poll group on startup and reconfiguration. Selected by default.

  • Note that default Array-Register template will be generated for specific application type (enumeration ) if polling is enabled (see

    the

    'Totalflow Applications

    Panel

    ' below) for at

    least

    least one of applications of this type. Another requirement for the default Array-Register template to be generated is that there should not be no any custom template for this application type.

Anchor
ImportPolicies ImportPolicies

Import Policies

...

Anchor
Date/Time Date/Time

Date/Time

• Date Time Offset
  • The date time offset of offset, in seconds, to add to the Totalflow device clock from the Ignition system running this driver in seconds. Default is 0to convert to UTC. For example, if your Totalflow device is set for CST, you would set this parameter to 7200 to convert any timestamps to UTC. 
  • Default is 0

Anchor
Records Records

AnchorRecordsRecordsRecords

• Alarm Source

  • Alarm source selector. Default is PERIODIC_HISTORY_RECORDS

    • PERIODIC_HISTORY_RECORDS - alarms are obtained from Periodic History records.
    • ALARM_LOG_RECORDS - alarms are obtained form Alarm Log records.
• Alarm Scan Rate
  • The rate in seconds that Alarm Log Records are scanned. Set to 0 to poll on notification from the 'Record Info' scanner. To disable Alarm polls, set to -1. Default is -1
• Event Scan Rate
  • The rate in seconds that Event Records are scanned. Set to 0 to poll on notification from the 'Record Info' scanner. To disable Event polls, set to -1. Default is 0
• Periodic History Scan Rate
  • The rate in seconds that Periodic History Records are scanned. Set to 0 to poll on notification from the 'Record Info' scanner. To disable Periodic History polls, set to -1. Default is 0
• Daily History Scan Rate
  • The rate in seconds that Daily History Records are scanned. Set to 0 to poll on notification from the 'Record Info' scanner. To disable Daily History polls, set to -1. Default is 0
• Record Info Scan Rate
  • The rate in seconds for the 'Record Info Registers' (i.e. History, Event and Alarm record capacity, last sequence number, etc.) to be scanned.
    If new Event, History, or Alarm Log records are detected, respective poller(s) will be notified. To disable 'RecordInfo' polls, set to -1. Set to 0 for one-shot 'Record Info' poll. Default is -1
• Max. Records to Read
  • Maximum number of records to read in one poll. Default is 100
• Periodic Mapping
  • The mapping of Totalflow LOG_PERIOD and DAILY structures to Flowcal Meter Periodic Transactions.

...

• Enable Signature

  • Checkbox to enable a digital signature field on all Records. Default is de-selected

• Algorithm
  • The hashing algorithm to use when generating the digital signature.
  • Options SHA_1,SHA_224, SHA_256, SHA_384 and SHA_512
• Password
  • The password used to generate the PBE secret key for encrypting the digital signature.

Anchor
CFX

...

Image Removed

• 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

...

Image Removed

• Use INI Categories
  • Checkbox to enables appending INI Category names to tag folder paths. Default is selected
• Poller Watchdog Rate
  • The rate in seconds that the poller watchdog thread is executed to verify polling threads are running. Set to 0 to disable the poller watchdog. Default is 0 seconds.

With the device now established you must configure the Totalflow Applications, Totalflow Application Definitions, Array-Register Definitions, Array-Register Templates and Poll Groups to use.  

...

CFX

Common Exchange Format (CFX) 

Image Added

• Enable CFX
  • Enables/disables the FLOWCAL Common File Exchange. 
  • When enabled, CFX and associated CFX.MD5 files will be created with a naming convention of meterid.cfx and meter_id.cfx.md5. New Alarm, Event and PeriodicHistory records will be added to the file.
  • Files will be stored on the Ignition instance where the driver is installed under this filepath <ignition folder>/data/modules/com.cirrus-link/efmabbtotalflow/devices/<device id>/meters/<meter id>/
• Flow Computer Brand
  • Free form text field to identify flow computer brand included in the CFX file. Limit of 20 characters
• Flow Computer Model
  • Free form text field to identify flow computer model included in the CFX file. Limit of 20 characters
• Flow Computer Software Version
  • Free form text field to identify the flow computer software version included in the CFX file. Limit of 20 characters
• CFX Publish Time Expression
  • This parameter is used when publishing the files with MQTT Transmission and defines the Quartz Cron expression used to schedule publishing of CFX files
  • This will trigger the CFX file to be copied to the "Publish File Path" configured for the MQTT Transmission File record selected in the "CFX File Transfer" parameter. This file can then be picked up and published automatically by MQTT Transmission and the CFX file remains in the source folder (under ~/data/modules) to be maintained. 
  • Default is "0 0 0/2 * * ?". Reference the Cron Trigger Tutorial for details on this expression and Cron Expression Generator for configuring this expression  
  • This expression can be empty to use the CFX Cutoff Time Expression only
• CFX Cutoff Time Expression
  • This parameter is used when publishing the files with MQTT Transmission and defines the Quartz Cron expression used to schedule publishing of CFX files
  • This will trigger the CFX file to be moved to the "Publish File Path" configured for the MQTT Transmission File record select in the "CFX File Transfer" parameter. This file can then be picked up and published automatically by MQTT Transmission and the EFM driver notified that it needs to collect meter configuration and generate a new set of CFX files.
  • Default is "0 0 0 L * ? *". Reference the Cron Trigger Tutorial for details on this expression and Cron Expression Generator for configuring this expression
  • This expression should never be empty to prevent the CFX file from becoming too large to publish
• CFX File Transfer
  
  • This parameter is used when publishing CFX files with MQTT Transmission and provides a dropdown containing all the File definitions from MQTT Transmission. 
  • A MQTT Transmission File definition defines a location for all the control tags required to publish files including the "Publish File Path". 
  • Default is none. CFX files will be created and maintained but will not be published. New Alarm, Event and PeriodicHistory records will be added to the file until the device connection is removed.

Anchor
Sparkplug Sparkplug

SparkplugImage Added

To publish Records such as Alarms, Events or History, a configured MQTT Transmission Transmitter is used.

If you do not have a Transmitter configured, create an MQTT Transmitter and set the Sparkplug Settings to the unique Group and Edge Node ID values generated by the Device Connection configuration.

If a Transmitter already exists, for example to publish the polled/live data, you can edit the Group and Edge Node IDs to match the existing Sparkplug Edge Node created by the Transmitter.

• 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 (Optional in release 4.0.14 and onward)

Anchor
Advanced Advanced

Advanced

Image Added

• Use INI Categories
  • Checkbox to enables appending INI Category names to tag folder paths. Default is selected
• Poller Watchdog Rate
  • The rate in seconds that the poller watchdog thread is executed to verify polling threads are running. Set to 0 to disable the poller watchdog. Default is 0 seconds.

With the device now established you must configure the Totalflow Applications, Totalflow Application Definitions, Array-Register Definitions, Array-Register Templates and Poll Groups to use.  

Anchor
TotalflowApplications TotalflowApplications

Totalflow Applications

The Totalflow Applications view is populated by the auto-discovery process that takes place on device startup or re-configuration. To view, click the 'More' drop-down button and select 'Totalflow Applications'.

Image Added

An example of the display is shown below and the user can enable or disable polling on any listed application and save the changes.

Image Added

If the device is configured with auto-discovery disabled, use the Import Configuration button to import application information from a 'Totalflow Applications' CSV file that contains correct information on applications instantiated on the Totalflow device the driver is connected to.

Anchor
TotalflowApplicationDefinitions TotalflowApplicationDefinitions

Totalflow Application Definitions

If there are any uploaded global Totalflow applications definition files, they can be applied to this device connection. Do so by clicking The Totalflow Applications view is populated by the auto-discovery process that takes place on device startup or re-configuration. To view, click the 'More' drop-down button and select selecting 'Totalflow Applications Definitions'.

An example of the display is shown below and the user can enable or disable polling on any listed application and save the changes.

Image Removed

If the device is configured with auto-discovery disabled, use the Import Configuration button to import application information from a 'Totalflow Applications' CSV file that contains correct information on applications instantiated on the Totalflow device the driver is connected to.

...

You should now see an empty list of Totalflow applications definitions unless you used the Add All Totalflow Applications Definitions setting.  Click the 'Add Row' link that is shown below. 

Image Added

This will show a new Totalflow application definition with a select box to allow you to select which global application definition you want to associate with this device. Add as many as are appropriate for your device as shown below and select Save.

Image Added

Anchor
ArrayRegisterDefinitions ArrayRegisterDefinitions

Array-Register Definitions

If there are any uploaded global Totalflow applications definition filesArray-Register definitions, they can be applied to this device connection.  Do so by clicking the 'More' drop-down button and selecting 'Totalflow Applications Array-Register Definitions'.

You should now see an empty list of Totalflow applications Array-Register definitions unless you used the Add All Totalflow Applications Array-Register Definitions setting.  Click the 'Add Row' link that is shown below. 

Image RemovedImage Added

This will show a new Totalflow application Array-Register definition with a select box to allow you to select which global application Array-Register definition you want to associate with this device. Add as many as are appropriate for your device as shown below and select Save.

Image Added

Anchor
ArrayRegisterTemplates ArrayRegisterTemplates

Array-Register Templates

With the Array-Register definitions now defined for this device . Add as many as are appropriate for your device as shown below and select Save.

Image Removed

...

If there are any uploaded global Array-Register definitions, they can be applied to this device connection. Do so by clicking the 'More' drop-down button and selecting 'Array-Register Definitions'.

Image Removed

You should now see an empty list of Array-Register definitions unless you used the Add All Array-Register Definitions setting.  Click the 'Add Row' link that is shown below. 

Image Removed

This will show a new Array-Register definition with a select box to allow you to select which global Array-Register definition you want to associate with this device. Add as many as are appropriate for your device as shown below and select Save.

Image Removed

...

With the Array-Register definitions now defined for this device we can create some Array-Register templates to allow creation of Application-Array-Register (AAR) poll groups.

Do so by clicking the 'More' drop-down button and selecting 'Array-Register Templates'.

Image Removed

...

we can create some Array-Register templates to allow creation of Application-Array-Register (AAR) poll groups.

Do so by clicking the 'More' drop-down button and selecting 'Array-Register Templates'.

Image Added

Note that the ABB Totalflow driver is capable of generating default Array-Register templates - one per each enabled application type (i.e. application enumeration). If ABB Totalflow device connection was created with the 'Auto-generate Templates and Poll Group' setting turned on, the following default Array-Register templates will be generated for the Totalflow applications configured.

These default templates for each application type will contain all Array-Register points obtained from applied Array-Register definitions that are applicable for this application enumeration. An example of this default template entry page is shown below:

Image Added

Image Added

Now you can configure these default Array-Templates as needed for your application. Options are:

1. Make no changes. This approach will potentially create too many tags that are not really needed.
   
   
2. Edit default template by either deleting or disabling rows.
   
   
3. Export default templates as CSV file, edit this file (i.e. remove unwanted data points), and import it back. This approach can result in either:
   1. New Array-Register template if original template name was modified in CSV file. In this case original default template will remain untouched.
   2. Same Array-Register template will have less data points given that template name has not been modified in edited CSV file.
      
      
4. Delete default Array-Register template and create a new one from scratch.

...

...

These default templates for each application type will contain all Array-Register points obtained from applied Array-Register definitions that are applicable for this application enumeration. An example of this default template entry page is shown below:

Image Removed

Image Removed

Now you can configure these default Array-Templates as needed for your application. Options are:

...

If the device is configured with Auto Generate Templates and Poll Group disabled, use the Import Configuration button to import template information.

There are two 'export' options for Array-Register Templates:

Export Configuration 

Using this option will export the Array-Register template as an INI backed templates This means that user can only change the following fields: 'Array', 'Register', 'Tag Name', and 'Enabled'. Other fields such as 'Access', 'Data Type', 'Category', and 'Register Name' are read only and obtained from INI files. Reference the ABB Totalflow: Array-Register Templates for an example of an INI-backed_ArrayRegisterTemplate.csv file

Export as 'Free Form'

Using this option will export the Array-Register template that can be used without an INI file. Reference the ABB Totalflow: Array-Register Templates for an example of an free form ArrayRegisterTemplate.csv file

To replace an INI backed Array-Register template by the 'Free-Form' one as shown below:

• Go to the device configuration page and change the 'Array-Register Template Import Policy' from 'UPDATE' to 'REPLACE'.
• Import the Free-Form_ArrayRegisterTemplates.csv file and save configuration.
• The Array-Register template will now show the 'View INI Files' link disabled to reflect that template is not INI backed. Also note that the 'Access', 'Data Type', and 'Category' fields can now be edited.Image Added

Image Added

...

If the device is configured with Auto Generate Templates and Poll Group disabled, use the Import Configuration button to import template information.

Anchor
PollGroups PollGroups

Poll Groups

...

If the device is configured with Auto Generate Templates and Poll Group disabled, use the Import Configuration button to import poll group information.

...