System components configuration
- Last UpdatedSep 25, 2025
- 3 minute read
Edge Data Store () components are adapter, adapter, and the Storage component. These components are only active if they are configured for the system to use them. itself needs only a small amount of configuration - the list of components and the Port used for calls.
Definition: Modbus TCP, Transmission Control Protocol, is a Modbus variant used for communications over TCP/IP networks, connecting over port 502. It does not require a checksum calculation, as lower layers already provide checksum protection.
The default System_Components.json file for the System component contains the following information:
[
{
"ComponentId": "Storage",
"ComponentType": "Storage"
}
]
The Storage component is required for to run and only one Storage component instance is supported. Each device needs a separate adapter component instance to connect to , and each device needs a separate adapter component instance to connect to . Multiple adapter component instances and the adapter component instances are supported.
Definition: Modbus TCP, Transmission Control Protocol, is a Modbus variant used for communications over TCP/IP networks, connecting over port 502. It does not require a checksum calculation, as lower layers already provide checksum protection.
Definition: Modbus TCP, Transmission Control Protocol, is a Modbus variant used for communications over TCP/IP networks, connecting over port 502. It does not require a checksum calculation, as lower layers already provide checksum protection.
Definition: Modbus TCP, Transmission Control Protocol, is a Modbus variant used for communications over TCP/IP networks, connecting over port 502. It does not require a checksum calculation, as lower layers already provide checksum protection.
Add system components
To add system components:
-
Using any text editor, create a file with a ComponentId and ComponentType. The following example adds a adapter instance.
Definition: Modbus TCP, Transmission Control Protocol, is a Modbus variant used for communications over TCP/IP networks, connecting over port 502. It does not require a checksum calculation, as lower layers already provide checksum protection.
{
"ComponentId": "Modbus1",
"ComponentType": "Modbus"
}
Note: The ComponentId must be a unique value. This example uses the ComponentId "Modbus1," since it is the first adapter.
Definition: Modbus TCP, Transmission Control Protocol, is a Modbus variant used for communications over TCP/IP networks, connecting over port 502. It does not require a checksum calculation, as lower layers already provide checksum protection.
-
Save the file with the name AddComponent.json.
-
From the same directory where the file exists, run the following script or EdgeCmd utility:
curl -d "@AddComponent.json" -H "Content-Type: application/json" http://localhost:5590/api/v1/configuration/system/components
edgecmd add components -type Modbus -id Modbus1
After the command completes successfully, the new component is available for configuration and use.
Parameters for system components
The following parameters are used to define system components.
|
Parameters |
Required |
Type |
Nullable |
Description |
|---|---|---|---|---|
|
ComponentId |
Required |
string |
Yes |
The unique ID of the component instance. It can be any alphanumeric string, for example Storage. |
|
ComponentType |
Required |
string |
Yes |
The type of the component, for example Storage. There are three types of components: Storage identified by Storage, OPC UA EDS Adapter identified by OpcUa, and Adapter identified by Modbus. Definition: Modbus TCP, Transmission Control Protocol, is a Modbus variant used for communications over TCP/IP networks, connecting over port 502. It does not require a checksum calculation, as lower layers already provide checksum protection. |
System components example
[
{
"componentId": "OpcUa1",
"componentType": "OpcUa"
},
{
"componentId": "Modbus1",
"componentType": "Modbus"
},
{
"componentId": "Storage",
"componentType": "Storage"
}
]