Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

...

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 to 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. 
    • from the Ignition system running this driver in seconds. Default is 0

Anchor
Records
Records
Records

...

  • 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
CFX
Common Exchange Format (CFX)

...

 

Note
Available in release 4.0.15

...

and newer


Note

To view all the CFX parameters below, MQTT Transmission must be installed.

MQTT Transmission is not required to create and maintain the CFX files for each meter. It is required to configure the CFX File Transfer and, if not installed, the "CFX Publish Time Expression", "CFX Cutoff Time Expression" and "CFX File Transfer" fields will not be available. 

...

  • 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 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 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.
Note

The CFX Cutoff Time Expression should be greater than the CFX Publish Time Expression


Anchor
Sparkplug
Sparkplug
Sparkplug

Image Removed

Image 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
      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

    ...