Data selection parameters

deviceId

Required

string

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

See Configure data source for more information.

selected

Optional

boolean

Selects or clears a measurement. To select an item, set to true. To remove an item, leave the field empty or set to false.

Allowed value: true or false
Default value: true

name

Optional

string

The optional friendly name of the data item collected from the data source.

Default value: stream ID

unitId

Required

number

Modbus TCP slave device unit ID.

Allowed values: 0-247 and 255

registerType

Required

number or string

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

Input16 and Holding16 are used to read registers that have a size of 16 bits. To represent the types, you can type in the register type ID or the exact name:

Allowed values:
1 or Coil (Read Coil Status)
2 or Discrete (Read Discrete Input Status)
3 or Holding16 (Read 16-bit Holding Registers)
6 or Input16 (Read 16-bit Input Registers)

For more information, see the Register types table.

registerOffset

Required

number

The 0 relative offset to the starting register for this measurement.

For example, if your 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

An integer representing the data type that the adapter will read starting at the register specified by the offset.

Supported data types:
1 = Boolean
10 = Int16
20 = UInt16
30 = Int32
31 = Int32ByteSwap
40 = UInt32
41 = UInt32ByteSwap
100 = Float32
101 = Float32ByteSwap
110 = Float64
111 = Float64ByteSwap
1001 - 1250 = String
2001 - 2250 = StringByteSwap

scheduleId

Required

string

The ID of an existing schedule for reading values.

bitMap

Optional

string

The bitmap is 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 maps 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

Use this numerical value to scale the raw response received from the Modbus TCP device.

If you specify conversionFactor, regardless of the specified data type, the value is promoted to a float32 (single) when stored. [Result = (Value / Conversion Factor)]

conversionOffset

Optional

number

Use this numerical value to apply an offset to the response received from the Modbus TCP device.

If you specify conversionOffset, regardless of the specified data type, the value is promoted to a float32 (single) when stored. [Result = (Value - Conversion Offset)]

dataFilterId

Optional

string

The ID of the data filter.

Allowed value: any string
Default value: null

Note: If the specified dataFilterId does not exist, unfiltered data is sent until that dataFilterId is created.

streamID

Optional

string

The custom stream ID that is used to create the streams. If you do not specify the StreamID, the adapter generates a default stream ID based on the measurement configuration.

A custom streamId has a maximum character limit of 250 characters, is not case-sensitive and can include spaces and forward slashes (/).

However, it must not:

• Start with two underscores (__)

• Start or end with a period

• Contain consecutive periods

• Consist only of periods

  Additionally, the streamId cannot contain any of the following special characters:

  : ? # [ ] @ ! $ & ' ( ) { } \ * + , ; = % < > |

  The default ID automatically updates when there are changes to the measurement and follows the format of <DeviceId>.<UnitId>.<RegisterType>.<RegisterOffset>.