ConfigModel

Type: object

The configuration model for the Modbus plugin

root devices
Type: array

List of Modbus devices Each device is identified by its transport protocol and may have multiple datapoints. Two devices are considered equal if the properties values of their transport protocols are equal.

Example of an invalid configuration: json { "devices": [ { // Unique "transport": { "type": "tcp", "host": "127.0.0.1", "port": 502 }, "datapoints": [] }, { // Unique "transport": { "type": "tcp", "host": "127.0.0.1", "port": 600 }, "datapoints": [] }, { // Unique "transport": { "type": "serial", "serial_interface": "some_interface", "slave_id": 1 }, "datapoints": [] }, { // Duplicate, the entire serial interface is the same. "transport": { "type": "serial", "serial_interface": "some_interface", "slave_id": 1 }, "datapoints": [...] } ] }

All items must be unique

No Additional Items

Each item of this array must be:

root devices DeviceElement
Type: object

Configuration for a Modbus device

root devices devices items datapoints
Type: array Default: []

The mapping between a datapoint and a Modbus memory block Currently a single datapoint that writes to a Modbus device can only be mapped to a single Modbus memory block. Specifying a datapoint to write to multiple modbus memory blocks is considered an invalid configuration.

 No Additional Items

Each item of this array must be:

root devices devices items datapoints DatapointMapping
Type: object

The mapping between a datapoint and a Modbus memory block as described in the specification

root devices devices items datapoints datapoints items oneOf Holding Register

Holding Register


The mapping between a datapoint and a Modbus holding register

root devices devices items datapoints datapoints items oneOf Holding Register oneOf item 0
Type: object

Read-only access, a datapoint/modbus memory block with this access mode will be read from the modbus device and requires that the same datapoint exists as a publisher in the modbus device

root devices devices items datapoints datapoints items oneOf Holding Register oneOf item 1
Type: object

Write access, a datapoint/modbus memory block with this access mode will be written to the modbus device and requires that the same datapoint exists as a subscriber in the modbus device

root devices devices items datapoints datapoints items oneOf Holding Register modbus_data_address
Type: integerFormat: uint16

The address of the holding register in the Modbus device (1-based)

Value must be greater or equal to 1.0

root devices devices items datapoints datapoints items oneOf Holding Register modbus_data_type
Type: object Default: "UInt16"

The data type of the holding register

root devices devices items datapoints datapoints items oneOf Holding Register modbus_data_type oneOf item 0
Type: enum (of string)

Signed 16-bit integer. Uses one register.

Must be one of:

  • "Int16"
root devices devices items datapoints datapoints items oneOf Holding Register modbus_data_type oneOf item 1
Type: enum (of string)

Unsigned 16-bit integer. Uses one register.

Must be one of:

  • "UInt16"
root devices devices items datapoints datapoints items oneOf Holding Register modbus_data_type oneOf item 2
Type: enum (of string)

Signed 32-bit integer. Uses two consecutive registers.

Must be one of:

  • "Int32"
root devices devices items datapoints datapoints items oneOf Holding Register modbus_data_type oneOf item 3
Type: enum (of string)

Unsigned 32-bit integer. Uses two consecutive registers.

Must be one of:

  • "UInt32"
root devices devices items datapoints datapoints items oneOf Holding Register modbus_data_type oneOf item 4
Type: enum (of string)

32-bit floating-point. Uses two consecutive registers.

Must be one of:

  • "Float32"

root devices devices items datapoints datapoints items oneOf Holding Register poll_frequency_ms
Type: integer or nullFormat: uint64

The polling frequency This only takes effect if the access mode is READ. It overrides the pollfrequencyms of the device for this particular datapoint.

root devices devices items datapoints datapoints items oneOf Holding Register swap_bytes
Type: boolean Default: false

Swap bytes within each 16-bit register (default: false). Applies to all data types (16-bit and 32-bit).

root devices devices items datapoints datapoints items oneOf Holding Register swap_register
Type: boolean Default: false

Swap the two 16-bit registers in a 32-bit value (default: false). Only applies to 32-bit types (Int32, UInt32, Float32). This field is ignored for 16-bit types.

root devices devices items datapoints datapoints items oneOf Holding Register type
Type: enum (of string)

Must be one of:

  • "holding_register"
root devices devices items datapoints datapoints items oneOf Input Register

Input Register

Type: object

The mapping between a datapoint and a Modbus input register

root devices devices items datapoints datapoints items oneOf Input Register modbus_data_address
Type: integerFormat: uint16

The address of the input register in the Modbus device (1-based)

Value must be greater or equal to 1.0

root devices devices items datapoints datapoints items oneOf Input Register modbus_data_type
Type: object Default: "UInt16"

The data type of the input register

root devices devices items datapoints datapoints items oneOf Holding Register modbus_data_type oneOf item 0
Type: enum (of string)

Signed 16-bit integer. Uses one register.

Must be one of:

  • "Int16"
root devices devices items datapoints datapoints items oneOf Holding Register modbus_data_type oneOf item 1
Type: enum (of string)

Unsigned 16-bit integer. Uses one register.

Must be one of:

  • "UInt16"
root devices devices items datapoints datapoints items oneOf Holding Register modbus_data_type oneOf item 2
Type: enum (of string)

Signed 32-bit integer. Uses two consecutive registers.

Must be one of:

  • "Int32"
root devices devices items datapoints datapoints items oneOf Holding Register modbus_data_type oneOf item 3
Type: enum (of string)

Unsigned 32-bit integer. Uses two consecutive registers.

Must be one of:

  • "UInt32"
root devices devices items datapoints datapoints items oneOf Holding Register modbus_data_type oneOf item 4
Type: enum (of string)

32-bit floating-point. Uses two consecutive registers.

Must be one of:

  • "Float32"

root devices devices items datapoints datapoints items oneOf Input Register poll_frequency_ms
Type: integer or nullFormat: uint64

The polling frequency It overrides the pollfrequencyms of the device for this particular datapoint.

root devices devices items datapoints datapoints items oneOf Input Register swap_bytes
Type: boolean Default: false

Swap bytes within each 16-bit register (default: false). Applies to all data types (16-bit and 32-bit).

root devices devices items datapoints datapoints items oneOf Input Register swap_register
Type: boolean Default: false

Swap the two 16-bit registers in a 32-bit value (default: false). Only applies to 32-bit types (Int32, UInt32, Float32). This field is ignored for 16-bit types.

root devices devices items datapoints datapoints items oneOf Input Register type
Type: enum (of string)

Must be one of:

  • "input_register"
root devices devices items datapoints datapoints items oneOf Discrete Input

Discrete Input

Type: object

The mapping between a datapoint and a Modbus discrete input

root devices devices items datapoints datapoints items oneOf Discrete Input modbus_data_address
Type: integerFormat: uint16

The address of the discrete input in the Modbus device (1-based)

Value must be greater or equal to 1.0

root devices devices items datapoints datapoints items oneOf Discrete Input poll_frequency_ms
Type: integer or nullFormat: uint64

The polling frequency It overrides the pollfrequencyms of the device for this particular datapoint.

root devices devices items datapoints datapoints items oneOf Discrete Input type
Type: enum (of string)

Must be one of:

  • "discrete_input"
root devices devices items datapoints datapoints items oneOf Coil

Coil


The mapping between a datapoint and a Modbus coil

root devices devices items datapoints datapoints items oneOf Coil oneOf item 0
Type: object

Read-only access, a datapoint/modbus memory block with this access mode will be read from the modbus device and requires that the same datapoint exists as a publisher in the modbus device

root devices devices items datapoints datapoints items oneOf Coil oneOf item 0 modbus_access_mode
Type: enum (of string)

Must be one of:

  • "READ"
root devices devices items datapoints datapoints items oneOf Coil oneOf item 1
Type: object

Write access, a datapoint/modbus memory block with this access mode will be written to the modbus device and requires that the same datapoint exists as a subscriber in the modbus device

root devices devices items datapoints datapoints items oneOf Coil oneOf item 1 modbus_access_mode
Type: enum (of string)

Must be one of:

  • "WRITE"

root devices devices items datapoints datapoints items oneOf Coil modbus_data_address
Type: integerFormat: uint16

The address of the coil in the Modbus device (1-based)

Value must be greater or equal to 1.0

root devices devices items datapoints datapoints items oneOf Coil poll_frequency_ms
Type: integer or nullFormat: uint64

The polling frequency This only takes effect if the access mode is READ. It overrides the pollfrequencyms of the device for this particular datapoint.

root devices devices items datapoints datapoints items oneOf Coil type
Type: enum (of string)

Must be one of:

  • "coil"

root devices devices items poll_frequency_ms
Type: integerFormat: uint64

The frequency at which the plugin should pull data from the Modbus devices

Value must be greater or equal to 1.0

root devices devices items transport
Type: object

The transport protocol used by the Modbus device

root devices devices items transport oneOf TCP

TCP

Type: object

root devices devices items transport oneOf TCP host
Type: stringFormat: ip

Host IP address of the Modbus TCP device (e.g., "127.0.0.1")

root devices devices items transport oneOf TCP port
Type: integerFormat: uint16

Port number of the Modbus TCP device (e.g., 502)

Value must be greater or equal to 0.0

root devices devices items transport oneOf TCP slave_id
Type: integerFormat: uint8 Default: 1

Slave ID from the modbus specification (e.g., 1)

Value must be greater or equal to 0.0

root devices devices items transport oneOf TCP type
Type: enum (of string)

Must be one of:

  • "tcp"
root devices devices items transport oneOf Serial

Serial

Type: object

root devices devices items transport oneOf Serial serial_interface
Type: string

Serial interface name from the device configuration

root devices devices items transport oneOf Serial slave_id
Type: integerFormat: uint8 Default: 1

Slave ID from the modbus specification (e.g., 1)

Value must be greater or equal to 0.0

root devices devices items transport oneOf Serial type
Type: enum (of string)

Must be one of:

  • "serial"