3.12.3.4. Sparkplug
The DataHub program can be configured as a Sparkplug 3.0 or 2.2 client. It supports EoN device or application types for version 3.0, and EoN device, primary application or non-primary application types for version 2.2.
- Sparkplug version
Choose version 2.2 or 3.0.
EoN device
This setting allows a DataHub instance to function as an Edge of Network (EoN) device. In this mode the DataHub instance acts as a data source, effectively acting as a gateway between any supported protocol and Sparkplug.
- EoN group name
An identifier that can be shared among EoN devices. This is commonly used to group similar devices.
![[Note]](images/note_1156523861.png)
The combination of EoN group name and EoN node name (below) identify each EoN device, and must be unique among all Sparkplug clients connected to the same broker.
Sparkplug identifier strings can contain any valid UTF-8 alphanumeric characters except for the plus sign (
+), forward slash (/), and number sign (#).- EoN node name
An identifier that uniquely identifies this device within its group.
- Remove path segments in device name
When the DataHub MQTT client is publishing a data hierarchy as a Sparkplug Edge of Network device, it will use the first branch name in the data point name as the Sparkplug "device" name. The child branches and leaves of this branch will be published as device metrics. In some cases you may have a hierarchy that contains one or more additional branch levels above the branch that is best used as a device name. This option allows you to specify how many branch levels in the data point hierarchy to skip to arrive at a branch in the hierarchy that represents the EoN device name. To use the point name without modification, set this value to zero.
- Use metric aliases
Sparkplug metrics can use numeric aliases to reduce network bandwidth by substituting a number for the metric name, which is typically longer. Some applications do not correctly handle aliases. Disabling this option will cause DataHub EoN connections to send the metric name with each message instead of using aliases.
- Wait for application
Selecting this option and providing an application name causes the DataHub Sparkplug EoN client to wait until the specified application has announced that it is online before the client emits its birth message and begins transmitting data.
Application / Primary application
This setting allows the DataHub instance to function as version 3.0 application or a version 2.2 primary application. This will inform other Sparkplug clients about its current connection status.
| |
The and type settings for versions 3.0 and 2.2 respectively are identical. |
| |
There should be at most one primary application connected to a Sparkplug 2.2 broker at any given time. |
- Application ID
An identifier for this client connection that must be unique among all connections to the MQTT broker.
Sparkplug identifier strings can contain any valid UTF-8 alphanumeric characters except for the plus sign (
+), forward slash (/), and number sign (#).- Output topic prefix
An identifier string that will be added to the name of each data point, after the DataHub domain name (if any), and before the group or node name. In addition to the normal Sparkplug identifier character restrictions, this identifier cannot contain the colon (
:) character.- Read-only
Checking this box will prevent this application from writing values back to EoN devices and clients.
- Live data
Choose whether to process or ignore live data, which is any Sparkplug metric values that are not flagged as historical. The choices are:
: Convert the metric names to DataHub point names and update the point values.
: Do not convert the metrics to DataHub points. The Sparkplug message will still be transmitted to other Sparkplug clients, but they will not appear as DataHub points.
- Historical data
Choose whether to process or ignore historical data, or to process it as live data. Historical data is any data that is explicitly flagged as historical. The choices are:
: Convert the metric names to DataHub point names, and send the values to all External Historian connections that are monitoring those point names. The live DataHub points will not be changed.
: Do not convert the metrics to DataHub points, and do not update External Historian connections. Do not update the live DataHub points. The Sparkplug message will still be transmitted to other Sparkplug clients.
: Treat the metrics as if they were not flagged as historical, and instead process them using the algorithm for live data (see above).
Non-primary application
The non-primary application type is only available for Sparkplug 2.2.
This setting allows the DataHub instance to function as a non-primary application. A non-primary application will not inform other Sparkplug clients about its current connection status. There can be any number of non-primary applications connected to a broker.
The non-primary application type is configured the same as a primary application type except that it has no application ID.
Topic Pattern
The topic pattern for pulling
topics from the MQTT broker should always be set to
spBv1.0/#.
When you are finished, you can configure your MQTT Exchange Data options as documented here.