Configure Sparkplug B data source

To use the adapter, you must configure the data source from which it polls data.

Postman

To configure the MQTT Sparkplug B data source using Postman:

1. To initialize the configuration, use the PUT method in conjunction with the http://localhost:5590/api/v1/configuration/system/DataSource REST endpoint.

   Note: If you installed the adapter to listen on a non-default port, update 5590 to the port number in use.

2. Copy and paste an example configuration for endpoints into the Body section.

   For sample JSONs, see the Examples section.

3. Update the example JSON parameters for your environment.

4. Select Send to push the configuration to the adapter.

EdgeCmd

To configure the data source using EdgeCmd:

5. Using a text editor, create an empty text file.

6. Copy and paste an example configuration for health endpoints into the file.

7. Update the example JSON parameters for your environment.

   For sample JSONs, see the Examples section.

8. Save the file. For example, ConfigureDataSource.json.

9. Open a command line session. Change directory to the location of your saved file.

10. Use the following edgecmd command with the name of your JSON file. For this example, we will use ConfigureDataSource.json for the saved file.

    edgecmd -port <port number> -cid <ComponentID> set DataSource -file /.ConfigureDataSource.json

    Note: If you use a component ID other than MQTTSparkplugB1, update the endpoint with your chosen component ID

For a list of other REST operations you can perform, like updating or deleting a data source configuration, see the REST URLs section below.

After data source configuration is complete, you must configure data selection to define the streams to collect from the data source.

Runtime changes

When you set up a new data source configuration, the adapter automatically connects to the new data source. When you delete a data source configuration, the adapter automatically disconnects from the data source and stops data collection for all streams associated with that data source. Additionally, when you update existing data source properties, the changes are reflected at runtime.

Note: Runtime changes also handle validation of configuration, which means that an invalid data source configuration is rejected.