Skip to main content
Modules for Ignition v8.1.x

Polling Alarms, Events, and History to the Central Ignition Gateway

Overview​

The EFM Emerson ROC module can poll Alarm, Event, and History data from an Emerson ROC device at a specified polling rate.

MQTT Transmission can publish this data as Sparkplug RECORD messages to an MQTT server. MQTT Engine receives the records on the central Ignition Gateway, and MQTT Recorder stores them in a configured database.

This tutorial describes how to configure the EFM Emerson ROC and MQTT modules to collect and publish Alarm, Event, and History records from a remote/edge Ignition Gateway to a central Ignition Gateway.

Central Gateway Setup​

The central Ignition Gateway receives Emerson ROC records through MQTT Engine and stores them in a database using MQTT Recorder.

Configure MQTT Distributor​

MQTT Distributor can remain at its default configuration. For production deployments, configure TLS if MQTT connections traverse an untrusted network.

By default, MQTT Distributor listens for MQTT connections on TCP port 1883. Ensure the operating system firewall and security software allow inbound connections on this port.

Configure MQTT Engine​

MQTT Engine can remain at its default configuration.

Configure a Database​

Create an Ignition database connection for MQTT Recorder to use. For instructions, see Connect to a Database.

Configure MQTT Recorder​

  1. In the Ignition Gateway interface, navigate to Config.
  2. Select MQTT Recorder > Settings.
  3. Select the database connection from the Datasource dropdown.
  4. Optionally, configure a Partition Period to separate recorded data into tables by time period.

The Central Ignition Gateway is now configured to receive MQTT Sparkplug RECORD messages from the Remote/Edge Gateway.

Edge Gateway Setup​

The remote/edge Ignition Gateway collects records from the Emerson ROC device and publishes them to the MQTT server.

With the Central Ignition Gateway ready to receive MQTT/Sparkplug RECORD messages, configure MQTT Transmission on the remote/edge Ignition Gateway.

Configure the MQTT Transmission Tag Structure​

If using the Default Transmitter in MQTT Transmission, create a tag structure with the following hierarchy:

[Tag Provider]/Edge Nodes/[Group ID]/[Edge Node ID]/[Device ID]/...

For example:

  • Group ID: G1
  • Edge Node ID: E1
  • Device ID: FB107

The Group ID, Edge Node ID, and Device ID must match the corresponding Sparkplug settings in the EFM Emerson ROC device configuration.

These values associate the Emerson ROC device with the appropriate MQTT Transmission transmitter and MQTT connection.

Configure the MQTT Transmission Server​

Configure MQTT Transmission to connect to the Central Ignition Gateway:

  1. In the Ignition Gateway, select Config.
  2. Select MQTT Transmission > Settings.
  3. Select the Servers tab.
  4. Edit the MQTT server configuration.
  5. Set the server URL to the address of the Central Ignition Gateway.
  6. Verify that the server shows 1 of 1 in the Connected column.

Alarms​

Configure the EFM Emerson ROC device connection to poll Alarm records.

Complete the following steps:

  1. Define the global TLP Definitions available to the Emerson ROC devices on the Ignition Gateway.
  2. Upload the Configuration Mappings for the Emerson ROC devices.
  3. Create a device connection to the Emerson ROC device.
  4. Set the Alarm Scan Rate to a positive value.
  5. Configure the device's Sparkplug Group ID, Edge Node ID, and Device ID to match the corresponding MQTT Transmission configuration.
  6. Specify the subset of global TLP Definitions that apply to the ROC device.

❗ If you are not configuring the driver to poll TLP data, TLP Definitions do not need to be configured for this purpose.

When the Alarm Scan Rate is greater than zero, the EFM Emerson ROC module polls the ROC device for Alarm records at the specified rate.

Events​

Configure the EFM Emerson ROC device connection to poll Event records.

Complete the following steps:

  1. Define the global TLP Definitions available to the Emerson ROC devices on the Ignition Gateway.
  2. Upload the Configuration Mappings for the Emerson ROC devices.
  3. Create a device connection to the Emerson ROC device.
  4. Set the Event Scan Rate to a positive value.
  5. Configure the device's Sparkplug Group ID, Edge Node ID, and Device ID to match the corresponding MQTT Transmission configuration.
  6. Specify the subset of global TLP Definitions that apply to the ROC device.

❗ If you are not configuring the driver to poll TLP data, TLP Definitions do not need to be configured for this purpose.

When the Event Scan Rate is greater than zero, the EFM Emerson ROC module polls the ROC device for Event records at the specified rate.

History​

Configure the EFM Emerson ROC device connection to poll History records.

Complete the following steps:

  1. Define the global TLP Definitions available to the Emerson ROC devices on the Ignition Gateway.

  2. Upload the Configuration Mappings for the Emerson ROC devices.

  3. Upload the Periodic Mappings for the Emerson ROC devices.

  4. Create a device connection to the Emerson ROC device.

  5. Set the following scan rates to positive values for the History data you want to collect:

    SettingDescription
    Minute History Scan RatePolls for Minute History records.
    Periodic History Scan RatePolls for Periodic History records.
    Daily History Scan RatePolls for Daily History records.

  6. Configure the device's Sparkplug Group ID, Edge Node ID, and Device ID to match the corresponding MQTT Transmission configuration.

  7. Specify the subset of global TLP Definitions that apply to the ROC device.

❗ If you are not configuring the driver to poll TLP data, TLP Definitions do not need to be configured for this purpose.

When the configured History Scan Rates are greater than zero, the EFM Emerson ROC module polls the ROC device for the corresponding History records at the specified rates.

Verify Records​

Once the EFM Emerson ROC device is configured and MQTT Transmission is connected to the MQTT server, the configured records are published as Sparkplug RECORD messages.

When new records are collected:

  1. The EFM Emerson ROC module polls the ROC device for new records.
  2. MQTT Transmission publishes the records to the MQTT server.
  3. MQTT Engine receives the records on the Central Ignition Gateway.
  4. MQTT Recorder stores the records in the configured database.

✅ Verify that the expected Alarm, Event, or History records are appearing in the MQTT Recorder database.