Learn about data source configuration settings for MQTT Sparkplug
- Last UpdatedJan 14, 2025
- 1 minute read
Each data source can be added to the connector by providing the following parameters.
-
Name
[Required]. The name of the data source.
-
Data source name values for a given connector must be unique.
-
Data source names are not case sensitive. For example, DataSource1 and DATASOURCE1 are considered the same.
Tip: The data source name can be used as the point source for the PI points created. To enable this feature, update the PI Connector Relay to version 2.4 or later. If you do not upgrade to a compatible PI Connector Relay, the data flow will not be interrupted, however, you might see some errors under Relay diagnostics and the point source will display the point name.
-
-
Description
[Optional]. The description of the data source configuration.
-
Host name or IP address
[Required]. The name or IP address of the MQTT server.
-
Port
[Required]. The port of the MQTT server.
-
User
[Optional]. The user for authentication on the MQTT server.
-
Password
[Optional]. The password for the user specified in the User field.
-
TLS only: CA Certificate File
[Optional]. The server's CA Certificate file. Required to use a secure connection.
-
Primary Host ID
[Required]. The ID of the Primary Host. The connector is considered the Primary Application. See SparkplugMQTTTopic &PayloadSpecification Section 8, posted online by Cirrus Link Solutions for details.
-
Topics
[Required]. The CSV file containing the topic(s) filters that you want to subscribe to on the MQTT server. You may put an optional QoS after the topics. The default QoS is 2. For more information about topic rules, see Learn about data source configuration reference for MQTT Sparkplug.