Skip to main content
Version: 5.3

Sparkplug Plug-in

Sparkplug settings in the Sparkplug Plug-in

You set the following properties in the configuration of the Sparkplug Plug-in:

Sparkplug settings:

Settings nameDescription
NameAssign a unique name to the Sparkplug Connection.
VariantSelect the Sparkplug A or Sparkplug B variant.
ProfileSpecify the profile of the Sparkplug connection to be used to log in to the Sparkplug Broker.
Group ID (Only Profile: Node)Assign a freely selectable unique Group ID to be used as the default.
Node ID (Only by Profile: Node)Assign a freely selectable unique Node ID to be used as the default.
Application Identifier (Only by Profile: Application)Assign a freely selectable unique application identifier that is to be used as the default.
Keep alive (s)Indication of the keep alive in seconds.

MQTT Connection settings in the Sparkplug Plug-in

MQTT connection:


Settings nameDescription
Broker connectionEnter the adress of the broker.
PortPort on the server that is used for the MQTT connection.
SSLUse SSL encryption. The server must support this and the corresponding port must be set.
Client IDEnter a unique Client ID.
Create a new Client IDCreates a new unique Client ID, which is displayed in the Client ID field.
SSL protocol

Select the algorithms that may be used

Note: Some MQTT brokers reject connections if protocols that are too old could be used.

UsernameUser name for logging in to the server.
PasswordPassword for logging in to the server.
Client certificateSelection of a client certificate from the drop-down list, which the OPC Router also sends.
Trusted certificateSelect which certificates are to be accepted. For example, all certificates, only Windows certificates or only router certificates.

Sparkplug Node/Applications Options in the Sparkplug Plug-in

Sparkplug Node/Applications Options:

Settings nameDescription
Publish known Devicemetrics on reconnectDetermines wheter metrics from known devices are published when reconnecting.
Add Session Number to Data MessagesDetermines whether the current session number is added to data messages.
Add Session Number to Device Birth and DeathAdds the current session number to Device Birth and Death messages.

Metric Storage Options in the Sparkplug Plug-in

Metric Storage Options:

Settings nameDescription
Null Handling
Datetime Divisor Milliseconds
Default Change of Value Behavior