Versions Compared

Old Version 8

changes.mady.by.user Wes Johnson

Saved on

compared with

New Version Current

changes.mady.by.user Nathan Davenport

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated IA links to be 7.9 specific.

...

The EFM Emerson ROC module is capable of getting alarm events polling alarms from a ROC device based on a specified polling rate.  With MQTT Transmission, these alarms can be published as Sparkplug records to an MQTT server.  Any client subscribed on Sparkplug RECORD messages can receive these objects.  In addition, MQTT Engine when combined with MQTT Recorder can also receive these messages and store these objects in a configured Ignition database.  The following drawing shows the general architecture used to do this.  This tutorial outlines the process of getting alarms to the central Ignition gateway.

 


Sending ROC Alarms to a Central Ignition Gateway:

...

MQTT Recorder requires that a database be set up in Ignition.  That can be done as described in the 'Connect to a Database' section here.  Note Ignition supports additional database types.  For more detailed information about supported types, take a look at the information provided here.  Once a database is set up, MQTT Recorder can be configured.  Do so by opening the Ignition Gateway Web UI and browsing to the Configure tab at the top of the screen and then selecting 'MQTT Recorder Settings' as shown in the lower left below.

Image RemovedImage Added

Once there, select a Datasource as shown in the image below.  This drop-down will be populated with any database connections you have set up in Ignition.  Optionally you can select a Partition Period if you would like tables segregated by time periods.

Image RemovedImage Added

At this point, the Central Ignition Gateway with MQTT Distributor, MQTT Engine, and MQTT Recorder is fully configured and ready to receive MQTT Sparkplug messages from the Remote/Edge Ignition Gateway.  MQTT Distributor listens on TCP port 1883 by default for inbound MQTT connections.  Make sure your Operating System's Firewall, Antivirus, and Malware protection services allow inbound connections on port 1883/TCP before proceeding.

...

With the Central Ignition Gateway ready to receive MQTT/Sparkplug RECORD objects, the EFM Emerson ROC and MQTT Transmission modules can be configured on the Remote/Edge Ignition Gateway. 

Start by configuring the EFM Emerson ROC module.  This is done as described in the Emerson ROC Configuration manual.  In going through the basic setup and configuration for Alarm configuration you must perform the following steps at a minimum.

...

the

...

  1. The 'Alarm Scan Rate' in this connection configuration must be greater than zero to tell the driver to poll for alarm data at the specified rate
  2. Set the Sparkplug Group ID, Edge Node ID, and Device ID that represent this device.  These will be used again later in the MQTT Transmission configuration.

...

These steps can be skipped if you will not be configuring the driver to poll for TLP data.

  1. Create TLP Template(s) which define groups of TLPs should be polled as a logical group
  2. Create TLP Poll Group(s) which specify the logical parameters associated with a given TLP Template
  3. Use Ignition designer to pull tags into a tag provider

At this point the EFM Emerson ROC driver is configured and is polling for alarm data at the rate specified in the EFM Emerson ROC device configuration.  The next step is to configure MQTT Transmission.  MQTT Transmission module. Do so by opening Ignition Designer and creating a tag structure similar to what is shown below.


Image RemovedImage AddedNote this structure is based on usage of the 'Default Transmitter' in MQTT Transmission.  So, the directory structure is very important.  Note the structure.

  • tag provider/Edge Nodes/Sparkplug [Group ID]/Sparkplug [Edge Node ID]/Sparkplug [Device ID]/...

In the example below this implies the following definitions:

  • Sparkplug [Group ID] = G1
  • Sparkplug [Edge Node ID] = E1
  • Sparkplug [Device ID] = Flow Computer 1

These values must match exact values will be used for the EFM Emerson ROC connection Sparkplug parameters exactly.  This tells to tell the EFM Emerson ROC which MQTT Transmission Transmitter configuration to use and, in turn, which MQTT connection to use to send the alarm data on.

Note at least one tag is also required below the Sparkplug Device ID level.  Often times there would be TLP tags here.  But, any tag such as a memory tag will be enough to trigger MQTT Transmission to send the appropriate BIRTH messages to MQTT Engine.

In addition to setting up an Edge Node with the Default Transmitter as we did above, we must also modify the Next the MQTT Transmission server configuration must be modified to point to the Central Ignition Gateway we set up earlier.  To do so, in the Ignition Gateway Web UI browse to the Configure tab on the top and then to MQTT Transmission Settings in the lower left as shown below.

Image RemovedImage Added

Once in the MQTT Transmission Settings configuration, click the Servers tab.  Then click 'edit' on the Chariot SCADA MQTT Server definition.  Modify the URL to match the URL of the Central Ignition Gateway you have configured.  In this example, MQTT Distributor is installed on a Central Ignition Gateway at the IP address of 192.168.1.532.  You should not have to modify any other parameters because MQTT Distributor and MQTT Engine have been left in their default state.  Once you have modified the URL to match your configuration, you should see a '1 of 1' in the Connected column as shown below.

Image Removed

Image Added

The next step is configuring the EFM Emerson ROC module.  This is done as described in the Emerson ROC Configuration manual.  In going through the basic setup and configuration for Alarm configuration you must perform the following steps at a minimum.

  1. Define the global TLP definitions available for all ROC devices in this Ignition instance
  2. Create the base device connection to the ROC
    1. The 'Alarm Scan Rate' in this connection configuration must be greater than zero to tell the driver to poll for alarm data at the specified rate
    2. Set the Sparkplug Group ID, Edge Node ID, and Device ID that represent this device.  These will be used again later in the MQTT Transmission configuration.
  3. Specify the subset of global TLP definitions that this specific ROC uses

These steps can be skipped if you will not be configuring the driver to poll for TLP data.

  1. Create TLP Template(s) which define groups of TLPs should be polled as a logical group
  2. Create TLP Poll Group(s) which specify the logical parameters associated with a given TLP Template
  3. Use Ignition designer to pull tags into a tag provider

At this point the EFM Emerson ROC driver is configured and is polling for alarm data at the rate specified in the EFM Emerson ROC device configuration.  

At this point, MQTT Transmission is connected to the MQTT Server and as a result MQTT Engine is receiving tag change events.  In addition, because an EFM Emerson ROC device has been created and has been configured with the same Sparkplug Group ID, Edge Node ID, and Device ID, alarm events alarms will also be pushed to the MQTT server as Sparkplug RECORD objects.  When alarm events alarms are discovered by the EFM Emerson ROC driver, they will be published to the MQTT server, consumed by MQTT Engine, passed on to MQTT Recorder, and then inserted into the specified database.  Below is an view of some alarms using a third party database viewing tool.

...