Skip to main content

Sparkplug plug-in

Sparkplug Settings​

PropertyDescription
NameAssign a unique name to the Sparkplug connection.
VariantSelect the variant Sparkplug A or Sparkplug B
ProfileSpecify the profile of the Sparkplug connection to be used for logging in to the Sparkplug broker
Group ID (Only for Profile: Node)Assign a freely selectable, unique Group ID to be used as the default
Node ID (Only for Profile: Node)Assign a freely selectable, unique Node ID to be used as the default
Application Identifier (Only for Profile: Application)Assign a freely selectable, unique Application Identifier to be used as the default
Keep-alive (s)Specify the keep-alive in seconds

MQTT Connection​


PropertyDescription
Broker ConnectionEnter the broker’s address.
PortPort on the server used for the MQTT connection.
SSLUses SSL encryption. The server must support this, and the corresponding port must be configured.
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 ProtocolsSelect the algorithms that are allowed to be used.
Note: Some MQTT brokers reject connections if outdated protocols might be used.
UsernameUsername for logging in to the server.
PasswordPassword for logging in to the server.
CertificateSelect a client certificate from the drop-down list that the OPC Router sends along with the connection.
Trusted CertificatesSelect which certificates should be accepted. For example, all certificates, only Windows certificates, or only router certificates.

Sparkplug Options​

PropertyDescription
Publish known device metrics on reconnectSpecifies whether metrics from known devices are published upon a new connection.
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​

PropertyDescription
Null Handling

This option is only active if the "Filter" option has been enabled under "Default Change of Value Behavior." The following options are available:

  • Compare: All outgoing metrics are filtered.
  • Ignore: Only metrics that are zero are filtered.
Datetime divisor in millisecondsUsed to round the timestamp when filtering by value and timestamp.
Default behavior for value changes

Defines the default behavior when a value changes. The following options are available:

  • No filter: Disables null handling
  • By value: Enables null handling and filters by value
  • By value and timestamp: Enables null handling and filters by value and timestamp. For this, the datetime divisor must have a value greater than 0.