Data source parameters

devices

Required

Array of objects

Specifies the list of Modbus TCP devices from which the adapter collects data. Each device definition includes an identifier and connection settings; all configured devices share the data source settings defined at the adapter-component level.

Refer to the Devices table for the properties that make up a device.

streamIdPrefix

Optional

string

Specifies what prefix is used for Stream IDs. The naming convention is {StreamIdPrefix}{StreamId}. An empty string means no prefix will be added to the Stream IDs and names. A null value defaults to ComponentID followed by a period.

Example: Modbus1.{DeviceId}.{UnitId}.{RegisterType}.{RegisterOffset}

Note: Every time you change the StreamIdPrefix of a configured adapter, for example when you delete and add a data source, you need to restart the adapter for the changes to take place. New streams are created on adapter restart and pre-existing streams are no longer updated.

Allowed value: any string
Default value: null

defaultStreamIdPattern

Optional

string

Specifies the default stream Id pattern to use.

Allowed value: any string
Default value: {DeviceId}.{UnitId}.{RegisterType}.{RegisterOffset}.

reconnectInterval

Optional

string

Parameter to specify the TimeSpan to wait before trying to reconnect to the data source when the data source is offline.

Note: You can specify timespans as numbers in seconds. For example, "RequestTimeout": 25 specifies 25 seconds, or "RequestTimeout": 125.5 specifies 2 minutes and 5.5 seconds.

Minimum value: 00:00:00.1
Maximum value: 00:00:30
Default value: 00:00:01

requestTimeout

Optional

string

Parameter to specify the TimeSpan that the adapter waits for a pending request before marking it as timed out and dropping the request. *

Minimum value: must be positive
Maximum value: 48 hours or 02:00:00:00
Default value: 00:00:10

delayBetweenRequests

Optional

string

Parameter to specify the minimum TimeSpan between two successive requests sent to the data source.

Note: You can specify timespans as numbers in seconds. For example, "RequestTimeout": 25 specifies 25 seconds, or "RequestTimeout": 125.5 specifies 2 minutes and 5.5 seconds.

Minimum value: 00:00:00
Maximum value: 00:00:01
Default value: 00:00:00

maxResponseDataLength

Optional

number

Parameter to limit the maximum length (in bytes) of data that can be read within one transaction. This parameter is provided to support devices that limit the number of bytes that can be returned. If there is no device limitation, the request length should be the maximum length of 250 bytes.

Minimum value: 2
Maximum value: 250
Default value: 250

id

Required

string

The ID of the device that is used in data selection to associate a register with a device.

ipAddress

Required

string

The IP address or hostname of the device from which the data is collected using the Modbus TCP protocol.

port

Optional

number

The TCP port of the target device that listens for and responds to Modbus TCP requests. The value ranges from 0 to 65535. If you do not configure it, the default TCP port is 502, which is the default port for Modbus TCP protocol.