Data selection configuration

DeviceId

Required

string

No

Specifies the DataSource device that this data selection item is read from. The value must match one of the <Id> values specified in the DataSource Devices configuration.

Selected

Optional

Boolean

No

Used to select or clear a measurement. To select an item, set to true. To remove an item, leave the field empty or set to false. If not configured, the default value is true.

Name

Optional

string

Yes

The optional friendly name of the data item collected from the data source. If not configured, the default value will be the stream ID.

UnitId

Required

number

No

Modbus TCP slave device unit ID. This must be a value between 0 and 247, inclusively.

RegisterType

Required

number or string

No

Modbus TCP register type. Supported types are Coil, Discrete, Input16, Input32, Holding16 and Holding32.

Input16 and Holding16 are used to read registers that have a size of 16 bits. For registers that have a size of 32 bits, use the Input32 and Holding32 register types. To represent the types, type the register type ID or the exact name:

• 1 or Coil (Read Coil Status)

• 2 or Discrete (Read Discrete Input Status)

• 3 or Holding16 (Read 16-bit Holding Registers)

• 4 or Holding32 (Read 32-bit Holding Registers)

• 6 or Input16 (Read 16-bit Input Registers)

• 7 or Input32 (Read 32-bit Input Registers)

RegisterOffset

Required

number

No

The 0 relative offset to the starting register for this measurement. For example, if the Holding registers start at base register 40001, the offset to this register is 0. For 40002, the offset to this register is 1.

DataTypeCode

Required

number

No

Represents the data type that Modbus TCP EDS (Edge Data Store) adapter will read starting at the register specified by the offset.

Supported data types are:

• 1 = Boolean

• 10 = Int16

• 20 = UInt16

• 30 = Int32

• 31 = Int32ByteSwap

• 100 = Float32

• 101 = Float32ByteSwap

• 110 = Float64

• 111 = Float64ByteSwap

• 1001 - 1250 = String

• 2001 - 2250 = StringByteSwap

ScanRate

Required

number

No

Defines how often this measurement is read from the device in milliseconds. Acceptable values are from 0 to 86400000. If 0 ms is specified, Modbus TCP EDS (Edge Data Store) adapter will scan for data as fast as possible.

BitMap

Optional

string

Yes

Bitmap used to extract and reorder bits from a word register. The format of the bitmap is uuvvwwxxyyzz, where uu, vv, ww, yy, and zz each refer to a single bit. A leading zero is required if the referenced bit is less than 10. The low-order bit is 01 and high-order bit is either 16 or 32. Up to 16 bits can be referenced for a 16-bit word (data types 10 and 20) and up to 32 bits can be referenced for a 32-bit word (data type 30 and 31). The bitmap 0307120802 will map the second bit of the original word to the first bit of the new word, the eighth bit to the second bit, the twelfth bit to the third bit, and so on. The high-order bits of the new word are padded with zeros if they are not specified.

ConversionFactor

Optional

number

Yes

Used to scale the raw response received from the Modbus TCP device. If this is specified, regardless of the specified data type, the value will be promoted to a float32 (single) when stored. [Result = (Value / Conversion Factor)]

ConversionOffset

Optional

number

Yes

Used to apply an offset to the response received from the Modbus TCP device. If this is specified, regardless of the specified data type, the value will be promoted to a float32 (single) when stored. [Result = (Value - Conversion Offset)]

StreamID

Optional

string

Yes

The custom stream ID that will be used to create the streams. If not specified, the Modbus TCP EDS (Edge Data Store) adapter will generate a default stream ID based on the measurement configuration. A properly configured custom stream ID follows these rules:

• Is not case-sensitive.

• Can contain spaces.

• Cannot start with two underscores ("__").

• Can contain a maximum of 100 characters.

• Cannot use the following characters: / : ? # [ ] @ ! $ & ' ( ) \ * + , ; = % < > |

• Cannot start or end with a period.

• Cannot contain consecutive periods.

• Cannot consist of only periods.