Skip to main content
Version: 5.6

Sparkplug Plug-in

!

Sparkplug Settings

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 to log 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


Broker connectionEnter the address of the broker.
PortPort on the server used for the MQTT connection.
SSLUses SSL encryption. The server must support this, and the corresponding port must be set.
Client IDEnter a unique client ID.
Create new client IDGenerates a new unique client ID, which is displayed in the Client ID field.
SSL protocols

Select the algorithms that may be used.

Note: Some Mqtt brokers reject connections if outdated protocols are used.

UsernameUsername for logging in to the server.
PassPassword for logging in to the server.
CertificateSelect a client certificate from the drop-down list, which the OPC Router sends along with the message.
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 reconnectDetermines whether 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 messages for device birth and death.

Metric Storage Options

PropertyDescription
Null Handling

This option is only active if the "Filter" option has been activated 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 change of value behavior

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

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