Configure data source
- Last UpdatedJun 24, 2025
- 2 minute read
- PI System
- Adapter for DNP3 1.2
- Adapters
To use the DNP3 adapter, you must configure the adapter to collect data from one or more DNP3 compliant outstations. The adapter can connect to multiple TCP channels and outstations by defining multiple connections in the configuration. The DNP3 adapter has the ability to perform automatic outstation discovery after some of the initial TCPChannel and MasterStationBehavior configuration is set.
To configure a DNP3 data source:
-
Use the PUT method in conjunction with the api/v1/configuration/<ComponentId>/DataSource REST endpoint to initialize the configuration.
-
Using a text editor, create an empty text file that includes an example configuration for a DNP3 data source.
For examples of configurations for single or multiple outstations, see Data source examples.
-
Update the example with parameters for your environment. For a list of all available parameters, see Data source parameters.
-
Save the file in JSON format. For example, ConfigureDataSource.json.
-
Open a command line session. Change directory to the location of ConfigureDataSource.json.
-
Enter the following cURL command (which uses the PUT method) to initialize the data source configuration.
curl -d "@ConfigureDataSource.json" -H "Content-Type: application/json" -X PUT "http://localhost:5590/api/v1/configuration/DNP3-1/DataSource"
Note: If you installed the adapter to listen on a non-default port, update 5590 to the port number in use. If you use a component ID other than DNP3-1, 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 table below.
-
Configure data selection.
Depending on your data source configuration, your data selection configuration can be pre-populated by discovery. For more information, see Configure data selection and Principles of operation.
REST URLs
|
Relative URL |
HTTP verb |
Action |
|---|---|---|
|
api/v1/configuration/<ComponentId>/DataSource |
GET |
Retrieves the data source configuration. |
|
api/v1/configuration/<ComponentId>/DataSource |
POST |
Creates the data source configuration. The adapter starts collecting data after the following conditions are met:
|
|
api/v1/configuration/<ComponentId>/DataSource |
PUT |
Configures or updates the data source configuration. Overwrites any active data source configuration. If no configuration is active, the adapter starts collecting data after the following conditions are met:
|
|
api/v1/configuration/<ComponentId>/DataSource |
DELETE |
Deletes the data source configuration. After the request is received, the adapter stops collecting data. |
Note: Replace <ComponentId> with the Id of your DNP3 component. For example, DNP3-1.