• Authentication
• Master Parameters
  • getGet general parameters of masters
  • putModify all general parameters of masters
  • patchModify some general parameters of masters
• Master TCP Interfaces
  • getGet all of master TCPs' configurations
  • getGet specific master TCP's configuration
  • putModify all of master TCP configuration
  • patchModify some of specific master TCP configuration
• Master Serial Interfaces
  • getGet all of master ports' configurations
  • getGet specific master port's configuration
  • putModify all of master port configuration
  • patchModify some of specific master port configuration
• Remote Devices
  • getGet all of remote devices' configurations
  • postAdd remote device(s) configuration
  • delDelete all remote devices configuration
  • getGet specific remote device's configuration
  • delDelete specific remote device's configuration
  • putModify all of remote device configuration
  • patchModify some of specific remote device configuration
• Master Commands
  • getGet all of master commands' configurations
  • postAdd master command(s) configuration
  • delDelete all master command configuration
  • getGet specific master command's configuration
  • delDelete specific master command's configuration
  • putModify all of master command configuration
  • patchModify some of specific master command configuration
• Tags
  • getGet all of tags' configurations
  • postAdd tag(s) configuration
  • delDelete all tags configuration
  • getGet specific tag's configuration
  • delDelete specific tag's configuration
  • putModify all of tag configuration
• Control
  • putStart the Modbus module, configuration will reload
  • putStop the Modbus module
  • putRestart the Modbus module, configuration will reload
  • putReset the configuration of Modbus module
  • putApply the Modbus configuration(it will restart the modbus daemon)
  • putUndo the Modbus configuration for un-applied status.
  • getexport the configuration of Modbus masters
  • postimport a configuration file into Modbus masters
  • getexport the configuration of master commands
  • postimport a configuration file into master commands for a remote device
  • getGet current modbus daemon system log level
• Diagnose
  • putset modbus dameon system log level
  • getGet all of TCP connection diagnose information (include masters and slaves)
  • getGet all of serial connection diagnose information (include masters and slaves)
  • postStart traffic modbus log.
  • postStop traffic modbus log.
• Operate
  • puttrigger the tag's related command to polling and get the tag data result
  • puttrigger the tag's related command to polling and post the tag data
• Status
  • getGet status of Modbus database was modified or not
  • getGet overview of Modbus master
• Platform
  • getGet tag list of Modbus master

Documentation Powered by Redocly

Modbus Master App API (2.2.0)

Download OpenAPI specification:Download

Modbus Master App API

Authentication

bearerAuth

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"JWT"

Master Parameters

Get general parameters of masters

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/modbusmaster/config/master-params

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "masterParamId": 0,
  • "configId": 0,
  • "enableTcpMasters": 0,
  • "enableSerMasters": 0,
  • "enableDevFailEvent": 0,
  • "enableCmdFailEvent": 0

  }

]

Modify all general parameters of masters

The configuration which does not belong to the request would be the default value.

Authorizations:

bearerAuth

Request Body schema: application/json

Array

masterParamId	integer Unique master parameters ID.
configId	integer Used as foreign key for master parameters table.
enableTcpMasters	integer Default: 1 Enum: 0 1 Enable of all TCP masters.
enableSerMasters	integer Default: 1 Enum: 0 1 Enable of all serial masters.
enableDevFailEvent	integer Default: 1 Enum: 0 1 Enable of devices' fail event alarm.
enableCmdFailEvent	integer Default: 1 Enum: 0 1 Enable of commands' fail event alarm.

Responses

https://127.0.0.1/api/v1/modbusmaster/config/master-params

Request samples

• Payload

Content type

application/json

Example

modbus_put_enable_ser_mastersmodbus_put_enable_tcp_mastersmodbus_put_enable_device_failed_eventmodbus_put_enable_command_failed_eventmodbus_put_enable_ser_masters

{

• "enableSerMasters": 1

}

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "masterParamId": 0,
  • "configId": 0,
  • "enableTcpMasters": 0,
  • "enableSerMasters": 0,
  • "enableDevFailEvent": 0,
  • "enableCmdFailEvent": 0

  }

]

Modify some general parameters of masters

The configuration which does not belong to the request would not be changed.

Authorizations:

bearerAuth

Request Body schema: application/json

Array

masterParamId	integer Unique master parameters ID.
configId	integer Used as foreign key for master parameters table.
enableTcpMasters	integer Default: 1 Enum: 0 1 Enable of all TCP masters.
enableSerMasters	integer Default: 1 Enum: 0 1 Enable of all serial masters.
enableDevFailEvent	integer Default: 1 Enum: 0 1 Enable of devices' fail event alarm.
enableCmdFailEvent	integer Default: 1 Enum: 0 1 Enable of commands' fail event alarm.

Responses

https://127.0.0.1/api/v1/modbusmaster/config/master-params

Request samples

• Payload

Content type

application/json

Example

modbus_patch_enable_ser_mastersmodbus_patch_enable_tcp_mastersmodbus_patch_enable_device_failed_eventmodbus_patch_enable_command_failed_eventmodbus_patch_enable_ser_masters

{

• "enableSerMasters": 1

}

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "masterParamId": 0,
  • "configId": 0,
  • "enableTcpMasters": 0,
  • "enableSerMasters": 0,
  • "enableDevFailEvent": 0,
  • "enableCmdFailEvent": 0

  }

]

Master TCP Interfaces

Get all of master TCPs' configurations

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/modbusmaster/config/master-tcp-ifaces

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "masterTcpIfaceId": 0,
  • "tcpMasterId": 0,
  • "initialDelay": 0,
  • "retryCount": 3,
  • "responseTout": 1000,
  • "remoteDevs": [

    • {

      • "remoteDevId": 0,
      • "masterTcpIfaceId": 0,
      • "name": "device",
      • "enable": 0,
      • "slaveId": 1,
      • "slaveIpaddr": "0.0.0.0",
      • "slaveTcpPort": 502,
      • "mcmds": [

        • {

          • "mcmdId": 1,
          • "remoteDevId": 2,
          • "name": "read_command_1",
          • "mode": 1,
          • "func": 3,
          • "readAddress": 0,
          • "readQuantity": 10,
          • "writeAddress": 0,
          • "writeQuantity": 1,
          • "pollInterval": 100,
          • "swap": 0,
          • "fpFunc": 0,
          • "fpTout": 60000,
          • "fpData": "00 00",
          • "scalingFunc": 0,
          • "interceptSlope": 1,
          • "interceptOffset": 0,
          • "pointSourceMin": 0,
          • "pointSourceMax": 1,
          • "pointTargetMin": 0,
          • "pointTargetMax": 1,
          • "tags": {

            • "tagId": 1,
            • "szoneId": 1,
            • "mcmdId": 1,
            • "name": "read_command_tag1",
            • "dataType": "raw",
            • "dataUnit": "%",
            • "access": "r",
            • "dataSize": 20,
            • "offset": 0

            }

          }

        ]

      }

    ]

  }

]

Get specific master TCP's configuration

Authorizations:

bearerAuth

path Parameters

masterTcpIfaceId required

string ID of TCP.

Responses

https://127.0.0.1/api/v1/modbusmaster/config/master-tcp-ifaces/{masterTcpIfaceId}

Response samples

• 200
• 400

Content type

application/json

{

• "masterTcpIfaceId": 0,
• "tcpMasterId": 0,
• "initialDelay": 0,
• "retryCount": 3,
• "responseTout": 1000,
• "remoteDevs": [

  • {

    • "remoteDevId": 0,
    • "masterTcpIfaceId": 0,
    • "name": "device",
    • "enable": 0,
    • "slaveId": 1,
    • "slaveIpaddr": "0.0.0.0",
    • "slaveTcpPort": 502,
    • "mcmds": [

      • {

        • "mcmdId": 1,
        • "remoteDevId": 2,
        • "name": "read_command_1",
        • "mode": 1,
        • "func": 3,
        • "readAddress": 0,
        • "readQuantity": 10,
        • "writeAddress": 0,
        • "writeQuantity": 1,
        • "pollInterval": 100,
        • "swap": 0,
        • "fpFunc": 0,
        • "fpTout": 60000,
        • "fpData": "00 00",
        • "scalingFunc": 0,
        • "interceptSlope": 1,
        • "interceptOffset": 0,
        • "pointSourceMin": 0,
        • "pointSourceMax": 1,
        • "pointTargetMin": 0,
        • "pointTargetMax": 1,
        • "tags": {

          • "tagId": 1,
          • "szoneId": 1,
          • "mcmdId": 1,
          • "name": "read_command_tag1",
          • "dataType": "raw",
          • "dataUnit": "%",
          • "access": "r",
          • "dataSize": 20,
          • "offset": 0

          }

        }

      ]

    }

  ]

}

Modify all of master TCP configuration

The configuration which does not belong to the request would be the default value.

Authorizations:

bearerAuth

path Parameters

masterTcpIfaceId required

string ID of TCP.

Request Body schema: application/json

Array

masterTcpIfaceId	integer master TCP interface ID.
tcpMasterId required	integer Used as foreign key for master TCP table.
initialDelay	integer [ 0 .. 30000 ] Default: 0 When Modbus module start, activate the TCP master after initial delay time (ms).
retryCount	integer [ 0 .. 5 ] Default: 3 Modbus retry count. When Modbus command does not get response, resend the command by define times.
responseTout	integer [ 10 .. 120000 ] Default: 1000 Modbus response timeout. Modbus master wait the request command time for response (ms).
	Array of objects (remoteDevsForTcp) [ items ]

Responses

https://127.0.0.1/api/v1/modbusmaster/config/master-tcp-ifaces/{masterTcpIfaceId}

Request samples

• Payload

Content type

application/json

{

• "tcpMasterId": 1,
• "initialDelay": 0,
• "retryCount": 3,
• "responseTout": 1000

}

Response samples

• 200
• 400

Content type

application/json

{

• "masterTcpIfaceId": 0,
• "tcpMasterId": 0,
• "initialDelay": 0,
• "retryCount": 3,
• "responseTout": 1000,
• "remoteDevs": [

  • {

    • "remoteDevId": 0,
    • "masterTcpIfaceId": 0,
    • "name": "device",
    • "enable": 0,
    • "slaveId": 1,
    • "slaveIpaddr": "0.0.0.0",
    • "slaveTcpPort": 502,
    • "mcmds": [

      • {

        • "mcmdId": 1,
        • "remoteDevId": 2,
        • "name": "read_command_1",
        • "mode": 1,
        • "func": 3,
        • "readAddress": 0,
        • "readQuantity": 10,
        • "writeAddress": 0,
        • "writeQuantity": 1,
        • "pollInterval": 100,
        • "swap": 0,
        • "fpFunc": 0,
        • "fpTout": 60000,
        • "fpData": "00 00",
        • "scalingFunc": 0,
        • "interceptSlope": 1,
        • "interceptOffset": 0,
        • "pointSourceMin": 0,
        • "pointSourceMax": 1,
        • "pointTargetMin": 0,
        • "pointTargetMax": 1,
        • "tags": {

          • "tagId": 1,
          • "szoneId": 1,
          • "mcmdId": 1,
          • "name": "read_command_tag1",
          • "dataType": "raw",
          • "dataUnit": "%",
          • "access": "r",
          • "dataSize": 20,
          • "offset": 0

          }

        }

      ]

    }

  ]

}

Modify some of specific master TCP configuration

The configuration which does not belong to the request would not be changed.

Authorizations:

bearerAuth

path Parameters

masterTcpIfaceId required

string ID of TCP.

Request Body schema: application/json

Array

masterTcpIfaceId	integer master TCP interface ID.
tcpMasterId required	integer Used as foreign key for master TCP table.
initialDelay	integer [ 0 .. 30000 ] Default: 0 When Modbus module start, activate the TCP master after initial delay time (ms).
retryCount	integer [ 0 .. 5 ] Default: 3 Modbus retry count. When Modbus command does not get response, resend the command by define times.
responseTout	integer [ 10 .. 120000 ] Default: 1000 Modbus response timeout. Modbus master wait the request command time for response (ms).
	Array of objects (remoteDevsForTcp) [ items ]

Responses

https://127.0.0.1/api/v1/modbusmaster/config/master-tcp-ifaces/{masterTcpIfaceId}

Request samples

• Payload

Content type

application/json

{

• "tcpMasterId": 1,
• "initialDelay": 0,
• "retryCount": 3,
• "responseTout": 1000

}

Response samples

• 200
• 400

Content type

application/json

{

• "masterTcpIfaceId": 0,
• "tcpMasterId": 0,
• "initialDelay": 0,
• "retryCount": 3,
• "responseTout": 1000,
• "remoteDevs": [

  • {

    • "remoteDevId": 0,
    • "masterTcpIfaceId": 0,
    • "name": "device",
    • "enable": 0,
    • "slaveId": 1,
    • "slaveIpaddr": "0.0.0.0",
    • "slaveTcpPort": 502,
    • "mcmds": [

      • {

        • "mcmdId": 1,
        • "remoteDevId": 2,
        • "name": "read_command_1",
        • "mode": 1,
        • "func": 3,
        • "readAddress": 0,
        • "readQuantity": 10,
        • "writeAddress": 0,
        • "writeQuantity": 1,
        • "pollInterval": 100,
        • "swap": 0,
        • "fpFunc": 0,
        • "fpTout": 60000,
        • "fpData": "00 00",
        • "scalingFunc": 0,
        • "interceptSlope": 1,
        • "interceptOffset": 0,
        • "pointSourceMin": 0,
        • "pointSourceMax": 1,
        • "pointTargetMin": 0,
        • "pointTargetMax": 1,
        • "tags": {

          • "tagId": 1,
          • "szoneId": 1,
          • "mcmdId": 1,
          • "name": "read_command_tag1",
          • "dataType": "raw",
          • "dataUnit": "%",
          • "access": "r",
          • "dataSize": 20,
          • "offset": 0

          }

        }

      ]

    }

  ]

}

Master Serial Interfaces

Get all of master ports' configurations

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/modbusmaster/config/master-ser-ifaces

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "masterSerIfaceId": 0,
  • "serMasterId": 0,
  • "portValue": 0,
  • "format": 0,
  • "initialDelay": 0,
  • "retryCount": 3,
  • "responseTout": 1000,
  • "frameInterval": 0,
  • "charInterval": 0,
  • "remoteDevs": [

    • {

      • "remoteDevId": 0,
      • "masterSerIfaceId": 0,
      • "name": "device",
      • "enable": 0,
      • "slaveId": 1,
      • "slaveIpaddr": "0.0.0.0",
      • "slaveTcpPort": 502,
      • "mcmds": [

        • {

          • "mcmdId": 1,
          • "remoteDevId": 2,
          • "name": "read_command_1",
          • "mode": 1,
          • "func": 3,
          • "readAddress": 0,
          • "readQuantity": 10,
          • "writeAddress": 0,
          • "writeQuantity": 1,
          • "pollInterval": 100,
          • "swap": 0,
          • "fpFunc": 0,
          • "fpTout": 60000,
          • "fpData": "00 00",
          • "scalingFunc": 0,
          • "interceptSlope": 1,
          • "interceptOffset": 0,
          • "pointSourceMin": 0,
          • "pointSourceMax": 1,
          • "pointTargetMin": 0,
          • "pointTargetMax": 1,
          • "tags": {

            • "tagId": 1,
            • "szoneId": 1,
            • "mcmdId": 1,
            • "name": "read_command_tag1",
            • "dataType": "raw",
            • "dataUnit": "%",
            • "access": "r",
            • "dataSize": 20,
            • "offset": 0

            }

          }

        ]

      }

    ]

  }

]

Get specific master port's configuration

Authorizations:

bearerAuth

path Parameters

masterSerIfaceId required

string ID of port.

Responses

https://127.0.0.1/api/v1/modbusmaster/config/master-ser-ifaces/{masterSerIfaceId}

Response samples

• 200
• 400

Content type

application/json

{

• "masterSerIfaceId": 0,
• "serMasterId": 0,
• "portValue": 0,
• "format": 0,
• "initialDelay": 0,
• "retryCount": 3,
• "responseTout": 1000,
• "frameInterval": 0,
• "charInterval": 0,
• "remoteDevs": [

  • {

    • "remoteDevId": 0,
    • "masterSerIfaceId": 0,
    • "name": "device",
    • "enable": 0,
    • "slaveId": 1,
    • "slaveIpaddr": "0.0.0.0",
    • "slaveTcpPort": 502,
    • "mcmds": [

      • {

        • "mcmdId": 1,
        • "remoteDevId": 2,
        • "name": "read_command_1",
        • "mode": 1,
        • "func": 3,
        • "readAddress": 0,
        • "readQuantity": 10,
        • "writeAddress": 0,
        • "writeQuantity": 1,
        • "pollInterval": 100,
        • "swap": 0,
        • "fpFunc": 0,
        • "fpTout": 60000,
        • "fpData": "00 00",
        • "scalingFunc": 0,
        • "interceptSlope": 1,
        • "interceptOffset": 0,
        • "pointSourceMin": 0,
        • "pointSourceMax": 1,
        • "pointTargetMin": 0,
        • "pointTargetMax": 1,
        • "tags": {

          • "tagId": 1,
          • "szoneId": 1,
          • "mcmdId": 1,
          • "name": "read_command_tag1",
          • "dataType": "raw",
          • "dataUnit": "%",
          • "access": "r",
          • "dataSize": 20,
          • "offset": 0

          }

        }

      ]

    }

  ]

}

Modify all of master port configuration

The configuration which does not belong to the request would be the default value.

Authorizations:

bearerAuth

path Parameters

masterSerIfaceId required

string ID of port.

Request Body schema: application/json

Array

masterSerIfaceId	integer Master serial interface ID.
serMasterId required	integer Used as foreign key for master serial interface table.
portValue required	integer Serial port index which should be unique.
format	integer Default: 0 Enum: 0 1 Modbus serial mode (RTU, ASCII).
initialDelay	integer [ 0 .. 30000 ] Default: 0 When Modbus module start, activate the serial master after initial delay time (ms).
retryCount	integer [ 0 .. 5 ] Default: 3 Modbus retry count. When Modbus command does not get response, resend the command by define times.
responseTout	integer [ 10 .. 120000 ] Default: 1000 Modbus response timeout. Modbus master wait the request command time for response (ms).
	integer or integer Default: 0 Modbus frame interval (t3.5), 0 is used by auto baud rate setting (ms).
	integer or integer Default: 0 Modbus char interval (t1.5), 0 is used by auto baud rate setting (ms).
	Array of objects (remoteDevsForSer) [ items ]

Responses

https://127.0.0.1/api/v1/modbusmaster/config/master-ser-ifaces/{masterSerIfaceId}

Request samples

• Payload

Content type

application/json

Example

modbus_serial_master_put_master_port0modbus_serial_master_put_master_port1_ASCIImodbus_serial_master_put_master_port0

{

• "serMasterId": 1,
• "portValue": 0,
• "format": 0,
• "initialDelay": 0,
• "retryCount": 3,
• "responseTout": 1000,
• "frameInterval": 0,
• "charInterval": 0

}

Response samples

• 200
• 400

Content type

application/json

{

• "masterSerIfaceId": 0,
• "serMasterId": 0,
• "portValue": 0,
• "format": 0,
• "initialDelay": 0,
• "retryCount": 3,
• "responseTout": 1000,
• "frameInterval": 0,
• "charInterval": 0,
• "remoteDevs": [

  • {

    • "remoteDevId": 0,
    • "masterSerIfaceId": 0,
    • "name": "device",
    • "enable": 0,
    • "slaveId": 1,
    • "slaveIpaddr": "0.0.0.0",
    • "slaveTcpPort": 502,
    • "mcmds": [

      • {

        • "mcmdId": 1,
        • "remoteDevId": 2,
        • "name": "read_command_1",
        • "mode": 1,
        • "func": 3,
        • "readAddress": 0,
        • "readQuantity": 10,
        • "writeAddress": 0,
        • "writeQuantity": 1,
        • "pollInterval": 100,
        • "swap": 0,
        • "fpFunc": 0,
        • "fpTout": 60000,
        • "fpData": "00 00",
        • "scalingFunc": 0,
        • "interceptSlope": 1,
        • "interceptOffset": 0,
        • "pointSourceMin": 0,
        • "pointSourceMax": 1,
        • "pointTargetMin": 0,
        • "pointTargetMax": 1,
        • "tags": {

          • "tagId": 1,
          • "szoneId": 1,
          • "mcmdId": 1,
          • "name": "read_command_tag1",
          • "dataType": "raw",
          • "dataUnit": "%",
          • "access": "r",
          • "dataSize": 20,
          • "offset": 0

          }

        }

      ]

    }

  ]

}

Modify some of specific master port configuration

The configuration which does not belong to the request would not be changed.

Authorizations:

bearerAuth

path Parameters

masterSerIfaceId required

string ID of port.

Request Body schema: application/json

Array

masterSerIfaceId	integer Master serial interface ID.
serMasterId required	integer Used as foreign key for master serial interface table.
portValue required	integer Serial port index which should be unique.
format	integer Default: 0 Enum: 0 1 Modbus serial mode (RTU, ASCII).
initialDelay	integer [ 0 .. 30000 ] Default: 0 When Modbus module start, activate the serial master after initial delay time (ms).
retryCount	integer [ 0 .. 5 ] Default: 3 Modbus retry count. When Modbus command does not get response, resend the command by define times.
responseTout	integer [ 10 .. 120000 ] Default: 1000 Modbus response timeout. Modbus master wait the request command time for response (ms).
	integer or integer Default: 0 Modbus frame interval (t3.5), 0 is used by auto baud rate setting (ms).
	integer or integer Default: 0 Modbus char interval (t1.5), 0 is used by auto baud rate setting (ms).
	Array of objects (remoteDevsForSer) [ items ]

Responses

https://127.0.0.1/api/v1/modbusmaster/config/master-ser-ifaces/{masterSerIfaceId}

Request samples

• Payload

Content type

application/json

Example

modbus_serial_master_patch_master_port0modbus_serial_master_patch_master_port1_ASCIImodbus_serial_master_patch_master_port0

{

• "serMasterId": 1,
• "portValue": 0,
• "format": 0,
• "initialDelay": 0,
• "retryCount": 3,
• "responseTout": 1000,
• "frameInterval": 0,
• "charInterval": 0

}

Response samples

• 200
• 400

Content type

application/json

{

• "masterSerIfaceId": 0,
• "serMasterId": 0,
• "portValue": 0,
• "format": 0,
• "initialDelay": 0,
• "retryCount": 3,
• "responseTout": 1000,
• "frameInterval": 0,
• "charInterval": 0,
• "remoteDevs": [

  • {

    • "remoteDevId": 0,
    • "masterSerIfaceId": 0,
    • "name": "device",
    • "enable": 0,
    • "slaveId": 1,
    • "slaveIpaddr": "0.0.0.0",
    • "slaveTcpPort": 502,
    • "mcmds": [

      • {

        • "mcmdId": 1,
        • "remoteDevId": 2,
        • "name": "read_command_1",
        • "mode": 1,
        • "func": 3,
        • "readAddress": 0,
        • "readQuantity": 10,
        • "writeAddress": 0,
        • "writeQuantity": 1,
        • "pollInterval": 100,
        • "swap": 0,
        • "fpFunc": 0,
        • "fpTout": 60000,
        • "fpData": "00 00",
        • "scalingFunc": 0,
        • "interceptSlope": 1,
        • "interceptOffset": 0,
        • "pointSourceMin": 0,
        • "pointSourceMax": 1,
        • "pointTargetMin": 0,
        • "pointTargetMax": 1,
        • "tags": {

          • "tagId": 1,
          • "szoneId": 1,
          • "mcmdId": 1,
          • "name": "read_command_tag1",
          • "dataType": "raw",
          • "dataUnit": "%",
          • "access": "r",
          • "dataSize": 20,
          • "offset": 0

          }

        }

      ]

    }

  ]

}

Remote Devices

Get all of remote devices' configurations

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/modbusmaster/config/remote-devs

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "remoteDevId": 1,
  • "masterSerIfaceId": 1,
  • "name": "dev1",
  • "enable": 1,
  • "slaveId": 1,
  • "slaveIpaddr": "192.168.127.254",
  • "slaveTcpPort": 502,
  • "mcmds": {

    • "mcmdId": 1,
    • "remoteDevId": 2,
    • "name": "read_command_1",
    • "mode": 1,
    • "func": 3,
    • "readAddress": 0,
    • "readQuantity": 10,
    • "writeAddress": 0,
    • "writeQuantity": 1,
    • "pollInterval": 100,
    • "swap": 0,
    • "fpFunc": 0,
    • "fpTout": 60000,
    • "fpData": "00 00",
    • "scalingFunc": 0,
    • "interceptSlope": 1,
    • "interceptOffset": 0,
    • "pointSourceMin": 0,
    • "pointSourceMax": 1,
    • "pointTargetMin": 0,
    • "pointTargetMax": 1,
    • "dataType": "raw",
    • "tags": {

      • "tagId": 1,
      • "szoneId": 1,
      • "mcmdId": 1,
      • "name": "read_command_tag1",
      • "dataType": "raw",
      • "dataUnit": "%",
      • "access": "r",
      • "dataSize": 20,
      • "offset": 0

      }

    }

  }

]

Add remote device(s) configuration

Authorizations:

bearerAuth

query Parameters

autoCreate

string Value: "tags" /remote-devs?autoCreate=tags would create tags automatically. dataType must be added in payload of mcmds.

Request Body schema:

application/jsonmultipart/form-dataapplication/json

remote device data.

One of

remoteDevId	integer Unique remote device ID.
masterSerIfaceId required	integer Master serial interface ID. Either "masterSerIfaceId" or "masterTcpIfaceId" should be set.
masterTcpIfaceId required	integer Master TCP interface ID. Either "masterSerIfaceId" or "masterTcpIfaceId" should be set.
name	string [ 1 .. 128 ] characters ^[\w\-.~]{1,128}$ Default: "device" Device name. "name" should be unique.
enable	integer Default: 1 Enum: 0 1 Enable all of this device's polling command.
slaveId	integer [ 0 .. 255 ] Default: 1 Slave ID of remote device. "slaveId" should be unique in a masterSerIface. "slaveId + slaveIpaddr + slaveTcpPort" should be unique in a masterTcpIface.
slaveIpaddr	string Default: "0.0.0.0" Slave IP address of remote device.
slaveTcpPort	integer [ 1 .. 65535 ] Default: 502 Slave IP port of remote device.
	Array of objects (mcmds) [ items ]

Responses

https://127.0.0.1/api/v1/modbusmaster/config/remote-devs

Request samples

• Payload

Content type

application/jsonmultipart/form-dataapplication/json

Example

modbus_serial_master_post_remote_devicemodbus_tcp_master_post_remote_devicemodbus_tcp_master_post_remote_devicesmodbus_tcp_master_post_remote_device_with_auto_create_tagsmodbus_serial_master_post_remote_device

{

• "masterSerIfaceId": 1,
• "name": "dev1",
• "enable": 1,
• "slaveId": 1

}

Response samples

• 201
• 400

Content type

application/json

Example

remoteDevremoteDevsremoteDev

{

• "remoteDevId": 1,
• "masterSerIfaceId": 1,
• "name": "dev1",
• "enable": 1,
• "slaveId": 1,
• "slaveIpaddr": "192.168.127.254",
• "slaveTcpPort": 502,
• "mcmds": {

  • "mcmdId": 1,
  • "remoteDevId": 2,
  • "name": "read_command_1",
  • "mode": 1,
  • "func": 3,
  • "readAddress": 0,
  • "readQuantity": 10,
  • "writeAddress": 0,
  • "writeQuantity": 1,
  • "pollInterval": 100,
  • "swap": 0,
  • "fpFunc": 0,
  • "fpTout": 60000,
  • "fpData": "00 00",
  • "scalingFunc": 0,
  • "interceptSlope": 1,
  • "interceptOffset": 0,
  • "pointSourceMin": 0,
  • "pointSourceMax": 1,
  • "pointTargetMin": 0,
  • "pointTargetMax": 1,
  • "dataType": "raw",
  • "tags": {

    • "tagId": 1,
    • "szoneId": 1,
    • "mcmdId": 1,
    • "name": "read_command_tag1",
    • "dataType": "raw",
    • "dataUnit": "%",
    • "access": "r",
    • "dataSize": 20,
    • "offset": 0

    }

  }

}

Delete all remote devices configuration

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/modbusmaster/config/remote-devs

Response samples

• 400

Content type

application/json

{

• "error": {

  • "message": "string"

  }

}

Get specific remote device's configuration

Authorizations:

bearerAuth

path Parameters

remoteDevId required

string ID of remoteDev.

Responses

https://127.0.0.1/api/v1/modbusmaster/config/remote-devs/{remoteDevId}

Response samples

• 200
• 400

Content type

application/json

{

• "remoteDevId": 1,
• "masterSerIfaceId": 1,
• "name": "dev1",
• "enable": 1,
• "slaveId": 1,
• "slaveIpaddr": "192.168.127.254",
• "slaveTcpPort": 502,
• "mcmds": {

  • "mcmdId": 1,
  • "remoteDevId": 2,
  • "name": "read_command_1",
  • "mode": 1,
  • "func": 3,
  • "readAddress": 0,
  • "readQuantity": 10,
  • "writeAddress": 0,
  • "writeQuantity": 1,
  • "pollInterval": 100,
  • "swap": 0,
  • "fpFunc": 0,
  • "fpTout": 60000,
  • "fpData": "00 00",
  • "scalingFunc": 0,
  • "interceptSlope": 1,
  • "interceptOffset": 0,
  • "pointSourceMin": 0,
  • "pointSourceMax": 1,
  • "pointTargetMin": 0,
  • "pointTargetMax": 1,
  • "dataType": "raw",
  • "tags": {

    • "tagId": 1,
    • "szoneId": 1,
    • "mcmdId": 1,
    • "name": "read_command_tag1",
    • "dataType": "raw",
    • "dataUnit": "%",
    • "access": "r",
    • "dataSize": 20,
    • "offset": 0

    }

  }

}

Delete specific remote device's configuration

Authorizations:

bearerAuth

path Parameters

remoteDevId required

string ID of remoteDev.

Responses

https://127.0.0.1/api/v1/modbusmaster/config/remote-devs/{remoteDevId}

Response samples

• 400

Content type

application/json

{

• "error": {

  • "message": "string"

  }

}

Modify all of remote device configuration

The configuration which does not belong to the request would be the default value.

Authorizations:

bearerAuth

path Parameters

remoteDevId required

string ID of remoteDev.

Request Body schema: application/json

remoteDevId	integer Unique remote device ID.
masterSerIfaceId required	integer Master serial interface ID. Either "masterSerIfaceId" or "masterTcpIfaceId" should be set.
masterTcpIfaceId required	integer Master TCP interface ID. Either "masterSerIfaceId" or "masterTcpIfaceId" should be set.
name	string [ 1 .. 128 ] characters ^[\w\-.~]{1,128}$ Default: "device" Device name. "name" should be unique.
enable	integer Default: 1 Enum: 0 1 Enable all of this device's polling command.
slaveId	integer [ 0 .. 255 ] Default: 1 Slave ID of remote device. "slaveId" should be unique in a masterSerIface. "slaveId + slaveIpaddr + slaveTcpPort" should be unique in a masterTcpIface.
slaveIpaddr	string Default: "0.0.0.0" Slave IP address of remote device.
slaveTcpPort	integer [ 1 .. 65535 ] Default: 502 Slave IP port of remote device.
	Array of objects (mcmds) [ items ]

Responses

https://127.0.0.1/api/v1/modbusmaster/config/remote-devs/{remoteDevId}

Request samples

• Payload

Content type

application/json

Example

modbus_serial_master_put_remote_devicemodbus_tcp_master_put_remote_devicemodbus_serial_master_put_remote_device

{

• "masterSerIfaceId": 1,
• "name": "dev1",
• "enable": 1,
• "slaveId": 1

}

Response samples

• 200
• 400

Content type

application/json

{

• "remoteDevId": 1,
• "masterSerIfaceId": 1,
• "name": "dev1",
• "enable": 1,
• "slaveId": 1,
• "slaveIpaddr": "192.168.127.254",
• "slaveTcpPort": 502,
• "mcmds": {

  • "mcmdId": 1,
  • "remoteDevId": 2,
  • "name": "read_command_1",
  • "mode": 1,
  • "func": 3,
  • "readAddress": 0,
  • "readQuantity": 10,
  • "writeAddress": 0,
  • "writeQuantity": 1,
  • "pollInterval": 100,
  • "swap": 0,
  • "fpFunc": 0,
  • "fpTout": 60000,
  • "fpData": "00 00",
  • "scalingFunc": 0,
  • "interceptSlope": 1,
  • "interceptOffset": 0,
  • "pointSourceMin": 0,
  • "pointSourceMax": 1,
  • "pointTargetMin": 0,
  • "pointTargetMax": 1,
  • "dataType": "raw",
  • "tags": {

    • "tagId": 1,
    • "szoneId": 1,
    • "mcmdId": 1,
    • "name": "read_command_tag1",
    • "dataType": "raw",
    • "dataUnit": "%",
    • "access": "r",
    • "dataSize": 20,
    • "offset": 0

    }

  }

}

Modify some of specific remote device configuration

The configuration which does not belong to the request would not be changed.

Authorizations:

bearerAuth

path Parameters

remoteDevId required

string ID of remoteDev.

Request Body schema: application/json

remoteDevId	integer Unique remote device ID.
masterSerIfaceId required	integer Master serial interface ID. Either "masterSerIfaceId" or "masterTcpIfaceId" should be set.
masterTcpIfaceId required	integer Master TCP interface ID. Either "masterSerIfaceId" or "masterTcpIfaceId" should be set.
name	string [ 1 .. 128 ] characters ^[\w\-.~]{1,128}$ Default: "device" Device name. "name" should be unique.
enable	integer Default: 1 Enum: 0 1 Enable all of this device's polling command.
slaveId	integer [ 0 .. 255 ] Default: 1 Slave ID of remote device. "slaveId" should be unique in a masterSerIface. "slaveId + slaveIpaddr + slaveTcpPort" should be unique in a masterTcpIface.
slaveIpaddr	string Default: "0.0.0.0" Slave IP address of remote device.
slaveTcpPort	integer [ 1 .. 65535 ] Default: 502 Slave IP port of remote device.
	Array of objects (mcmds) [ items ]

Responses

https://127.0.0.1/api/v1/modbusmaster/config/remote-devs/{remoteDevId}

Request samples

• Payload

Content type

application/json

Example

modbus_serial_master_patch_remote_devicemodbus_tcp_master_patch_remote_devicemodbus_serial_master_patch_remote_device

{

• "masterSerIfaceId": 1,
• "name": "dev1",
• "enable": 1,
• "slaveId": 1

}

Response samples

• 200
• 400

Content type

application/json

{

• "remoteDevId": 1,
• "masterSerIfaceId": 1,
• "name": "dev1",
• "enable": 1,
• "slaveId": 1,
• "slaveIpaddr": "192.168.127.254",
• "slaveTcpPort": 502,
• "mcmds": {

  • "mcmdId": 1,
  • "remoteDevId": 2,
  • "name": "read_command_1",
  • "mode": 1,
  • "func": 3,
  • "readAddress": 0,
  • "readQuantity": 10,
  • "writeAddress": 0,
  • "writeQuantity": 1,
  • "pollInterval": 100,
  • "swap": 0,
  • "fpFunc": 0,
  • "fpTout": 60000,
  • "fpData": "00 00",
  • "scalingFunc": 0,
  • "interceptSlope": 1,
  • "interceptOffset": 0,
  • "pointSourceMin": 0,
  • "pointSourceMax": 1,
  • "pointTargetMin": 0,
  • "pointTargetMax": 1,
  • "dataType": "raw",
  • "tags": {

    • "tagId": 1,
    • "szoneId": 1,
    • "mcmdId": 1,
    • "name": "read_command_tag1",
    • "dataType": "raw",
    • "dataUnit": "%",
    • "access": "r",
    • "dataSize": 20,
    • "offset": 0

    }

  }

}

Master Commands

Get all of master commands' configurations

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/modbusmaster/config/mcmds

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "mcmdId": 1,
  • "remoteDevId": 2,
  • "name": "read_command_1",
  • "mode": 1,
  • "func": 3,
  • "readAddress": 0,
  • "readQuantity": 10,
  • "writeAddress": 0,
  • "writeQuantity": 1,
  • "pollInterval": 100,
  • "swap": 0,
  • "fpFunc": 0,
  • "fpTout": 60000,
  • "fpData": "00 00",
  • "scalingFunc": 0,
  • "interceptSlope": 1,
  • "interceptOffset": 0,
  • "pointSourceMin": 0,
  • "pointSourceMax": 1,
  • "pointTargetMin": 0,
  • "pointTargetMax": 1,
  • "tags": {

    • "tagId": 1,
    • "szoneId": 1,
    • "mcmdId": 1,
    • "name": "read_command_tag1",
    • "dataType": "raw",
    • "dataUnit": "%",
    • "access": "r",
    • "dataSize": 20,
    • "offset": 0

    }

  }

]

Add master command(s) configuration

Authorizations:

bearerAuth

query Parameters

autoCreate

string Value: "tags" /mcmds?autoCreate=tags would create tags automatically. dataType must be added in payload.

Request Body schema: application/json

Master command data.

One of

mcmdId	integer Unique Modbus command name.
remoteDevId required	integer Used as foreign key for mcmd table.
name	string [ 1 .. 120 ] characters ^[\w\-.~]{1,120}$ Default: "command" Modbus command name. "name" should be unique in a remoteDev.
enable	integer Default: 1 Enum: 0 1 Enable this polling command (disable, enable).
mode	integer Default: 0 Enum: 0 1 Modbus command mode (cyclic, data change).
func	integer Default: 3 Enum: 1 2 3 4 5 6 15 16 23 Function code
readAddress	integer [ 0 .. 65535 ] Default: 0 Reading address.
readQuantity	integer [ 1 .. 2000 ] Default: 10 Reading length (different maximum value depends on func. func 01, 02 - max 2000; func 03, 04, 23 - max 125).
writeAddress	integer [ 0 .. 65535 ] Default: 0 Writing address.
writeQuantity	integer [ 1 .. 1968 ] Default: 1 Writing length (different maximum value depends on func. func 05, 06 - max 1; func 15 - max 1968; func 16 - max 123; func 23 - max 121).
pollInterval	integer [ 100 .. 86400000 ] Default: 1000 The polling interval for this Modbus command (ms).
swap	integer Default: 0 Enum: 0 1 2 3 The swap mode for this Modbus command(none, byte, word, byte word).
fpFunc	integer Default: 0 Enum: 0 1 2 Fault protection func (keep original data, all clear to zero, user define).
fpTout	integer [ 1 .. 86400 ] Default: 3600 Fault protection timeout. After fault protection timeout, Modbus command data not update from other data will trigger fault protection function (s).
fpData	string Default: "00 00" User defined data for fault protection when fpFunc = 2. Data should be described as raw HEX, e.g. "1A 2B"
scalingFunc	integer Default: 0 Enum: 0 1 2 Modbus scaling function, (disable, intercept, point).
interceptSlope	number Default: 1 Slope for intercept of Modbus scaling function.
interceptOffset	number Default: 0 Offset for intercept of Modbus scaling function.
pointSourceMin	number Default: 0 Source minimum value for point of Modbus scaling function.
pointSourceMax	number Default: 1 Source maximum value for point of Modbus scaling function.
pointTargetMin	number Default: 0 Target minimum value for point of Modbus scaling function.
pointTargetMax	number Default: 1 Target maximum value for point of Modbus scaling function.
	Array of objects (tagsForMcmds) [ items ]

Responses

https://127.0.0.1/api/v1/modbusmaster/config/mcmds

Request samples

• Payload

Content type

application/json

Example

modbus_master_post_read_coils_commandmodbus_master_post_read_coils_commandsmodbus_master_post_read_coils_command_with_auto_create_tagsmodbus_master_post_read_coils_commands_with_auto_create_tagsmodbus_master_post_read_discrete_inputs_commandmodbus_master_post_read_holding_registers_commandmodbus_master_post_read_input_registers_commandmodbus_master_post_write_single_coil_commandmodbus_master_post_write_single_register_commandmodbus_master_post_write_multiple_coils_commandmodbus_master_post_write_multiple_registers_commandmodbus_master_post_read_write_multiple_registers_commandmodbus_master_post_write_command_with_fault_protectionmodbus_master_post_write_command_with_fault_protection_user_definedmodbus_master_post_read_command_with_scalingmodbus_master_post_read_command_with_single_tagmodbus_master_post_read_command_with_multiple_tagmodbus_master_post_read_coils_command

{

• "remoteDevId": 1,
• "name": "cmd1",
• "mode": 1,
• "func": 1,
• "readAddress": 0,
• "readQuantity": 10,
• "pollInterval": 1000,
• "swap": 0

}

Response samples

• 201
• 400

Content type

application/json

Example

mcmdmcmdsmcmd

{

• "mcmdId": 1,
• "remoteDevId": 2,
• "name": "read_command_1",
• "mode": 1,
• "func": 3,
• "readAddress": 0,
• "readQuantity": 10,
• "writeAddress": 0,
• "writeQuantity": 1,
• "pollInterval": 100,
• "swap": 0,
• "fpFunc": 0,
• "fpTout": 60000,
• "fpData": "00 00",
• "scalingFunc": 0,
• "interceptSlope": 1,
• "interceptOffset": 0,
• "pointSourceMin": 0,
• "pointSourceMax": 1,
• "pointTargetMin": 0,
• "pointTargetMax": 1,
• "tags": {

  • "tagId": 1,
  • "szoneId": 1,
  • "mcmdId": 1,
  • "name": "read_command_tag1",
  • "dataType": "raw",
  • "dataUnit": "%",
  • "access": "r",
  • "dataSize": 20,
  • "offset": 0

  }

}

Delete all master command configuration

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/modbusmaster/config/mcmds

Response samples

• 400

Content type

application/json

{

• "error": {

  • "message": "string"

  }

}

Get specific master command's configuration

Authorizations:

bearerAuth

path Parameters

mcmdId required

string ID of mcmd.

Responses

https://127.0.0.1/api/v1/modbusmaster/config/mcmds/{mcmdId}

Response samples

• 200
• 400

Content type

application/json

{

• "mcmdId": 1,
• "remoteDevId": 2,
• "name": "read_command_1",
• "mode": 1,
• "func": 3,
• "readAddress": 0,
• "readQuantity": 10,
• "writeAddress": 0,
• "writeQuantity": 1,
• "pollInterval": 100,
• "swap": 0,
• "fpFunc": 0,
• "fpTout": 60000,
• "fpData": "00 00",
• "scalingFunc": 0,
• "interceptSlope": 1,
• "interceptOffset": 0,
• "pointSourceMin": 0,
• "pointSourceMax": 1,
• "pointTargetMin": 0,
• "pointTargetMax": 1,
• "tags": {

  • "tagId": 1,
  • "szoneId": 1,
  • "mcmdId": 1,
  • "name": "read_command_tag1",
  • "dataType": "raw",
  • "dataUnit": "%",
  • "access": "r",
  • "dataSize": 20,
  • "offset": 0

  }

}

Delete specific master command's configuration

Authorizations:

bearerAuth

path Parameters

mcmdId required

string ID of mcmd.

Responses

https://127.0.0.1/api/v1/modbusmaster/config/mcmds/{mcmdId}

Response samples

• 400

Content type

application/json

{

• "error": {

  • "message": "string"

  }

}

Modify all of master command configuration

The configuration which does not belong to the request would be the default value.

Authorizations:

bearerAuth

path Parameters

mcmdId required

string ID of mcmd.

query Parameters

autoCreate

string Value: "tags" /mcmds?autoCreate=tags would create tags automatically. dataType must be added in payload.

Request Body schema: application/json

One of

mcmdId	integer Unique Modbus command name.
remoteDevId required	integer Used as foreign key for mcmd table.
name	string [ 1 .. 120 ] characters ^[\w\-.~]{1,120}$ Default: "command" Modbus command name. "name" should be unique in a remoteDev.
enable	integer Default: 1 Enum: 0 1 Enable this polling command (disable, enable).
mode	integer Default: 0 Enum: 0 1 Modbus command mode (cyclic, data change).
func	integer Default: 3 Enum: 1 2 3 4 5 6 15 16 23 Function code
readAddress	integer [ 0 .. 65535 ] Default: 0 Reading address.
readQuantity	integer [ 1 .. 2000 ] Default: 10 Reading length (different maximum value depends on func. func 01, 02 - max 2000; func 03, 04, 23 - max 125).
writeAddress	integer [ 0 .. 65535 ] Default: 0 Writing address.
writeQuantity	integer [ 1 .. 1968 ] Default: 1 Writing length (different maximum value depends on func. func 05, 06 - max 1; func 15 - max 1968; func 16 - max 123; func 23 - max 121).
pollInterval	integer [ 100 .. 86400000 ] Default: 1000 The polling interval for this Modbus command (ms).
swap	integer Default: 0 Enum: 0 1 2 3 The swap mode for this Modbus command(none, byte, word, byte word).
fpFunc	integer Default: 0 Enum: 0 1 2 Fault protection func (keep original data, all clear to zero, user define).
fpTout	integer [ 1 .. 86400 ] Default: 3600 Fault protection timeout. After fault protection timeout, Modbus command data not update from other data will trigger fault protection function (s).
fpData	string Default: "00 00" User defined data for fault protection when fpFunc = 2. Data should be described as raw HEX, e.g. "1A 2B"
scalingFunc	integer Default: 0 Enum: 0 1 2 Modbus scaling function, (disable, intercept, point).
interceptSlope	number Default: 1 Slope for intercept of Modbus scaling function.
interceptOffset	number Default: 0 Offset for intercept of Modbus scaling function.
pointSourceMin	number Default: 0 Source minimum value for point of Modbus scaling function.
pointSourceMax	number Default: 1 Source maximum value for point of Modbus scaling function.
pointTargetMin	number Default: 0 Target minimum value for point of Modbus scaling function.
pointTargetMax	number Default: 1 Target maximum value for point of Modbus scaling function.
	Array of objects (tagsForMcmds) [ items ]

Responses

https://127.0.0.1/api/v1/modbusmaster/config/mcmds/{mcmdId}

Request samples

• Payload

Content type

application/json

Example

modbus_master_put_read_coils_commandmodbus_master_put_read_coils_command_with_auto_create_tagsmodbus_master_put_read_discrete_inputs_commandmodbus_master_put_read_holding_registers_commandmodbus_master_put_read_input_registers_commandmodbus_master_put_write_single_coil_commandmodbus_master_put_write_single_register_commandmodbus_master_put_write_multiple_coils_commandmodbus_master_put_write_multiple_registers_commandmodbus_master_put_read_write_multiple_registers_commandmodbus_master_put_read_coils_command

{

• "remoteDevId": 1,
• "name": "cmd1",
• "mode": 0,
• "func": 1,
• "readAddress": 0,
• "readQuantity": 10,
• "pollInterval": 1000,
• "swap": 0

}

Response samples

• 200
• 400

Content type

application/json

{

• "mcmdId": 1,
• "remoteDevId": 2,
• "name": "read_command_1",
• "mode": 1,
• "func": 3,
• "readAddress": 0,
• "readQuantity": 10,
• "writeAddress": 0,
• "writeQuantity": 1,
• "pollInterval": 100,
• "swap": 0,
• "fpFunc": 0,
• "fpTout": 60000,
• "fpData": "00 00",
• "scalingFunc": 0,
• "interceptSlope": 1,
• "interceptOffset": 0,
• "pointSourceMin": 0,
• "pointSourceMax": 1,
• "pointTargetMin": 0,
• "pointTargetMax": 1,
• "tags": {

  • "tagId": 1,
  • "szoneId": 1,
  • "mcmdId": 1,
  • "name": "read_command_tag1",
  • "dataType": "raw",
  • "dataUnit": "%",
  • "access": "r",
  • "dataSize": 20,
  • "offset": 0

  }

}

Modify some of specific master command configuration

The configuration which does not belong to the request would not be changed.

Authorizations:

bearerAuth

path Parameters

mcmdId required

string ID of mcmd.

query Parameters

autoCreate

string Value: "tags" /mcmds?autoCreate=tags would create tags automatically. dataType must be added in payload.

Request Body schema: application/json

One of

mcmdId	integer Unique Modbus command name.
remoteDevId required	integer Used as foreign key for mcmd table.
name	string [ 1 .. 120 ] characters ^[\w\-.~]{1,120}$ Default: "command" Modbus command name. "name" should be unique in a remoteDev.
enable	integer Default: 1 Enum: 0 1 Enable this polling command (disable, enable).
mode	integer Default: 0 Enum: 0 1 Modbus command mode (cyclic, data change).
func	integer Default: 3 Enum: 1 2 3 4 5 6 15 16 23 Function code
readAddress	integer [ 0 .. 65535 ] Default: 0 Reading address.
readQuantity	integer [ 1 .. 2000 ] Default: 10 Reading length (different maximum value depends on func. func 01, 02 - max 2000; func 03, 04, 23 - max 125).
writeAddress	integer [ 0 .. 65535 ] Default: 0 Writing address.
writeQuantity	integer [ 1 .. 1968 ] Default: 1 Writing length (different maximum value depends on func. func 05, 06 - max 1; func 15 - max 1968; func 16 - max 123; func 23 - max 121).
pollInterval	integer [ 100 .. 86400000 ] Default: 1000 The polling interval for this Modbus command (ms).
swap	integer Default: 0 Enum: 0 1 2 3 The swap mode for this Modbus command(none, byte, word, byte word).
fpFunc	integer Default: 0 Enum: 0 1 2 Fault protection func (keep original data, all clear to zero, user define).
fpTout	integer [ 1 .. 86400 ] Default: 3600 Fault protection timeout. After fault protection timeout, Modbus command data not update from other data will trigger fault protection function (s).
fpData	string Default: "00 00" User defined data for fault protection when fpFunc = 2. Data should be described as raw HEX, e.g. "1A 2B"
scalingFunc	integer Default: 0 Enum: 0 1 2 Modbus scaling function, (disable, intercept, point).
interceptSlope	number Default: 1 Slope for intercept of Modbus scaling function.
interceptOffset	number Default: 0 Offset for intercept of Modbus scaling function.
pointSourceMin	number Default: 0 Source minimum value for point of Modbus scaling function.
pointSourceMax	number Default: 1 Source maximum value for point of Modbus scaling function.
pointTargetMin	number Default: 0 Target minimum value for point of Modbus scaling function.
pointTargetMax	number Default: 1 Target maximum value for point of Modbus scaling function.
	Array of objects (tagsForMcmds) [ items ]

Responses

https://127.0.0.1/api/v1/modbusmaster/config/mcmds/{mcmdId}

Request samples

• Payload

Content type

application/json

Example

modbus_master_patch_read_coils_commandmodbus_master_patch_read_coils_command_with_auto_create_tagsmodbus_master_patch_read_discrete_inputs_commandmodbus_master_patch_read_holding_registers_commandmodbus_master_patch_read_input_registers_commandmodbus_master_patch_write_single_coil_commandmodbus_master_patch_write_single_register_commandmodbus_master_patch_write_multiple_coils_commandmodbus_master_patch_write_multiple_registers_commandmodbus_master_patch_read_write_multiple_registers_commandmodbus_master_patch_read_coils_command

{

• "remoteDevId": 1,
• "name": "cmd1",
• "mode": 0,
• "func": 1,
• "readAddress": 0,
• "readQuantity": 10,
• "pollInterval": 1000,
• "swap": 0

}

Response samples

• 200
• 400

Content type

application/json

{

• "mcmdId": 1,
• "remoteDevId": 2,
• "name": "read_command_1",
• "mode": 1,
• "func": 3,
• "readAddress": 0,
• "readQuantity": 10,
• "writeAddress": 0,
• "writeQuantity": 1,
• "pollInterval": 100,
• "swap": 0,
• "fpFunc": 0,
• "fpTout": 60000,
• "fpData": "00 00",
• "scalingFunc": 0,
• "interceptSlope": 1,
• "interceptOffset": 0,
• "pointSourceMin": 0,
• "pointSourceMax": 1,
• "pointTargetMin": 0,
• "pointTargetMax": 1,
• "tags": {

  • "tagId": 1,
  • "szoneId": 1,
  • "mcmdId": 1,
  • "name": "read_command_tag1",
  • "dataType": "raw",
  • "dataUnit": "%",
  • "access": "r",
  • "dataSize": 20,
  • "offset": 0

  }

}

Tags

Get all of tags' configurations

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/modbusmaster/config/tags

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "tagId": 1,
  • "szoneId": 1,
  • "mcmdId": 1,
  • "name": "read_command_tag1",
  • "dataType": "raw",
  • "dataUnit": "%",
  • "access": "rw",
  • "dataSize": 20,
  • "offset": 0

  }

]

Add tag(s) configuration

Authorizations:

bearerAuth

Request Body schema: application/json

Tag data.

One of

tagId	integer Unique tag ID.
mcmdId required	integer Used as foreign key for tags table. Set either mcmdId or szoneId.
szoneId required	integer Used as foreign key for tags table. Set either mcmdId or szoneId.
name	string [ 1 .. 128 ] characters ^[\w\-.~]{1,128}$ Default: "tag" Tag name for tag mapping used. "name" should be unique in a remoteDev. Tag name should not be 'status'.
dataType	string Default: "raw" Enum: "boolean" "int8" "int16" "int32" "int64" "uint8" "uint16" "uint32" "uint64" "float" "double" "string" "bytearray" "raw" Data type of tag.
dataUnit	string Real unit description of tag (e.g. ms, s, A, mA, ...).
access	string Default: "rw" Enum: "r" "w" "rw" Tag access for publish or subscribe.
dataSize	integer >= 1 Data size for data type (string, bytearray, raw). dataSize must exist in payload if data type is string/bytearray/raw. dataSize must not exist in payload if data type is not string/bytearray/raw.
offset	integer Default: 0 Tag's start byte offset in Modbus command.

Responses

https://127.0.0.1/api/v1/modbusmaster/config/tags

Request samples

• Payload

Content type

application/json

Example

modbus_master_read_command_int16_tagmodbus_master_read_command_int16_tagsmodbus_master_read_command_int32_tagmodbus_master_read_command_int64_tagmodbus_master_read_command_uint16_tagmodbus_master_read_command_uint32_tagmodbus_master_read_command_uint64_tagmodbus_master_read_command_float_tagmodbus_master_read_command_double_tagmodbus_master_read_command_boolean_tagmodbus_master_read_command_string_tag_with_20bytesmodbus_master_read_command_rawdata_tag_with_20bytesmodbus_master_write_command_rawdata_tag_with_20bytesmodbus_master_readwrite_command_rawdata_tag_with_20bytesmodbus_master_read_command_int16_tag_without_offsetmodbus_master_read_command_int16_tag_with_offsetmodbus_master_read_command_int16_tag

{

• "mcmdId": 1,
• "name": "read_command_int16_tag",
• "dataType": "int16",
• "access": "r",
• "offset": 0

}

Response samples

• 201
• 400

Content type

application/json

{

• "data": {

  • "tagId": 1,
  • "szoneId": 1,
  • "mcmdId": 1,
  • "name": "read_command_tag1",
  • "dataType": "raw",
  • "dataUnit": "%",
  • "access": "rw",
  • "dataSize": 20,
  • "offset": 0

  }

}

Delete all tags configuration

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/modbusmaster/config/tags

Response samples

• 400

Content type

application/json

{

• "error": {

  • "message": "string"

  }

}

Get specific tag's configuration

Authorizations:

bearerAuth

path Parameters

tagId required

string ID of tag.

Responses

https://127.0.0.1/api/v1/modbusmaster/config/tags/{tagId}

Response samples

• 200
• 400

Content type

application/json

{

• "data": {

  • "tagId": 1,
  • "szoneId": 1,
  • "mcmdId": 1,
  • "name": "read_command_tag1",
  • "dataType": "raw",
  • "dataUnit": "%",
  • "access": "rw",
  • "dataSize": 20,
  • "offset": 0

  }

}

Delete specific tag's configuration

Authorizations:

bearerAuth

path Parameters

tagId required

string ID of tag.

Responses

https://127.0.0.1/api/v1/modbusmaster/config/tags/{tagId}

Response samples

• 400

Content type

application/json

{

• "error": {

  • "message": "string"

  }

}

Modify all of tag configuration

The configuration which does not belong to the request would be the default value.

Authorizations:

bearerAuth

path Parameters

tagId required

string ID of tag.

Request Body schema: application/json

tagId	integer Unique tag ID.
mcmdId required	integer Used as foreign key for tags table. Set either mcmdId or szoneId.
szoneId required	integer Used as foreign key for tags table. Set either mcmdId or szoneId.
name	string [ 1 .. 128 ] characters ^[\w\-.~]{1,128}$ Default: "tag" Tag name for tag mapping used. "name" should be unique in a remoteDev. Tag name should not be 'status'.
dataType	string Default: "raw" Enum: "boolean" "int8" "int16" "int32" "int64" "uint8" "uint16" "uint32" "uint64" "float" "double" "string" "bytearray" "raw" Data type of tag.
dataUnit	string Real unit description of tag (e.g. ms, s, A, mA, ...).
access	string Default: "rw" Enum: "r" "w" "rw" Tag access for publish or subscribe.
dataSize	integer >= 1 Data size for data type (string, bytearray, raw). dataSize must exist in payload if data type is string/bytearray/raw. dataSize must not exist in payload if data type is not string/bytearray/raw.
offset	integer Default: 0 Tag's start byte offset in Modbus command.

Responses

https://127.0.0.1/api/v1/modbusmaster/config/tags/{tagId}

Request samples

• Payload

Content type

application/json

Example

modbus_master_read_command_int16_tagmodbus_master_read_command_int32_tagmodbus_master_read_command_int64_tagmodbus_master_read_command_uint16_tagmodbus_master_read_command_uint32_tagmodbus_master_read_command_uint64_tagmodbus_master_read_command_float_tagmodbus_master_read_command_double_tagmodbus_master_read_command_boolean_tagmodbus_master_read_command_string_tag_with_20bytesmodbus_master_read_command_rawdata_tag_with_20bytesmodbus_master_write_command_rawdata_tag_with_20bytesmodbus_master_readwrite_command_rawdata_tag_with_20bytesmodbus_master_read_command_int16_tag_without_offsetmodbus_master_read_command_int16_tag_with_offsetmodbus_master_read_command_int16_tag

{

• "mcmdId": 1,
• "name": "read_command_int16_tag",
• "dataType": "int16",
• "access": "r"

}

Response samples

• 200
• 400

Content type

application/json

{

• "tagId": 1,
• "szoneId": 1,
• "mcmdId": 1,
• "name": "read_command_tag1",
• "dataType": "raw",
• "dataUnit": "%",
• "access": "rw",
• "dataSize": 20,
• "offset": 0

}

Control

Start the Modbus module, configuration will reload

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/modbusmaster/control/daemon/start

Response samples

• 400

Content type

application/json

{

• "error": {

  • "message": "string"

  }

}

Stop the Modbus module

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/modbusmaster/control/daemon/stop

Response samples

• 400

Content type

application/json

{

• "error": {

  • "message": "string"

  }

}

Restart the Modbus module, configuration will reload

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/modbusmaster/control/daemon/restart

Response samples

• 400

Content type

application/json

{

• "error": {

  • "message": "string"

  }

}

Reset the configuration of Modbus module

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/modbusmaster/control/config/factory-default

Response samples

• 400

Content type

application/json

{

• "error": {

  • "message": "string"

  }

}

Apply the Modbus configuration(it will restart the modbus daemon)

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/modbusmaster/control/config/apply

Response samples

• 400

Content type

application/json

{

• "error": {

  • "message": "string"

  }

}

Undo the Modbus configuration for un-applied status.

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/modbusmaster/control/config/undo

Response samples

• 400

Content type

application/json

{

• "error": {

  • "message": "string"

  }

}

export the configuration of Modbus masters

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/modbusmaster/control/config/masters/export

Response samples

• 400

Content type

application/json

{

• "error": {

  • "message": "string"

  }

}

import a configuration file into Modbus masters

Authorizations:

bearerAuth

Request Body schema: multipart/form-data

mastersFile

string Modbus masters csv file.

Responses

https://127.0.0.1/api/v1/modbusmaster/control/config/masters/import

Response samples

• 201
• 400

Content type

application/json

{

• "data": [

  • {

    • "configId": 0,
    • "masterParams": [

      • {

        • "masterParamId": 0,
        • "configId": 0,
        • "enableTcpMasters": 0,
        • "enableSerMasters": 0,
        • "enableDevFailEvent": 0,
        • "enableCmdFailEvent": 0

        }

      ],
    • "tcpMasters": [

      • {

        • "tcpMasterId": 0,
        • "configId": 0,
        • "name": "modbus_tcp_master",
        • "masterTcpIfaces": [

          • {

            • "masterTcpIfaceId": 0,
            • "tcpMasterId": 0,
            • "initialDelay": 0,
            • "retryCount": 3,
            • "responseTout": 1000,
            • "remoteDevs": [

              • {

                • "remoteDevId": 0,
                • "masterTcpIfaceId": 0,
                • "name": "device",
                • "enable": 0,
                • "slaveId": 1,
                • "slaveIpaddr": "0.0.0.0",
                • "slaveTcpPort": 502,
                • "mcmds": [

                  • null

                  ]

                }

              ]

            }

          ]

        }

      ],
    • "serMasters": [

      • {

        • "serMasterId": 0,
        • "configId": 0,
        • "name": "modbus_serial_master",
        • "masterSerIfaces": [

          • {

            • "masterSerIfaceId": 0,
            • "serMasterId": 0,
            • "portValue": 0,
            • "format": 0,
            • "initialDelay": 0,
            • "retryCount": 3,
            • "responseTout": 1000,
            • "frameInterval": 0,
            • "charInterval": 0,
            • "remoteDevs": [

              • {

                • "remoteDevId": 0,
                • "masterSerIfaceId": 0,
                • "name": "device",
                • "enable": 0,
                • "slaveId": 1,
                • "slaveIpaddr": "0.0.0.0",
                • "slaveTcpPort": 502,
                • "mcmds": [

                  • null

                  ]

                }

              ]

            }

          ]

        }

      ]

    }

  ],
• "count": 0

}

export the configuration of master commands

Authorizations:

bearerAuth

query Parameters

remoteDevId

integer /export?remoteDevId=1.

Responses

https://127.0.0.1/api/v1/modbusmaster/control/config/mcmds/export

Response samples

• 400

Content type

application/json

{

• "error": {

  • "message": "string"

  }

}

import a configuration file into master commands for a remote device

Authorizations:

bearerAuth

Request Body schema: multipart/form-data

mcmdsFile	string Master command csv file.
remoteDevId	any Remote device ID.

Responses

https://127.0.0.1/api/v1/modbusmaster/control/config/mcmds/import

Response samples

• 201
• 400

Content type

application/json

{

• "data": [

  • [

    • {

      • "mcmdId": 1,
      • "remoteDevId": 2,
      • "name": "read_command_1",
      • "mode": 1,
      • "func": 3,
      • "readAddress": 0,
      • "readQuantity": 10,
      • "writeAddress": 0,
      • "writeQuantity": 1,
      • "pollInterval": 100,
      • "swap": 0,
      • "fpFunc": 0,
      • "fpTout": 60000,
      • "fpData": "00 00",
      • "scalingFunc": 0,
      • "interceptSlope": 1,
      • "interceptOffset": 0,
      • "pointSourceMin": 0,
      • "pointSourceMax": 1,
      • "pointTargetMin": 0,
      • "pointTargetMax": 1,
      • "tags": {

        • "tagId": 1,
        • "szoneId": 1,
        • "mcmdId": 1,
        • "name": "read_command_tag1",
        • "dataType": "raw",
        • "dataUnit": "%",
        • "access": "r",
        • "dataSize": 20,
        • "offset": 0

        }

      }

    ]

  ],
• "count": 0

}

Get current modbus daemon system log level

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/modbusmaster/control/log-level

Response samples

• 200
• 400

Content type

application/json

"ALL"

Diagnose

set modbus dameon system log level

Authorizations:

bearerAuth

Request Body schema: application/json

system log level.

logLevel

string (log_level_str) Enum: "ALL" "TRACE" "DEBUG" "INFO" "WARN" "ERROR" "FATAL" "OFF" system log level.

Responses

https://127.0.0.1/api/v1/modbusmaster/control/log-level

Request samples

• Payload

Content type

application/json

{

• "logLevel": "DEBUG"

}

Get all of TCP connection diagnose information (include masters and slaves)

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/modbusmaster/diagnose/tcp-status

Response samples

• 200
• 400

Content type

application/json

{

• "modbus_tcp": [

  • {

    • "mode": "Slave",
    • "numConns": 0,
    • "sentReqs": 0,
    • "recvValidResps": 0,
    • "recvInvalidResps": 0,
    • "recvExceptions": 0,
    • "timeout": 0,
    • "conns": [

      • {

        • "status": "OK",
        • "remoteIpPort": "string",
        • "sentReqs": 0,
        • "recvValidResps": 0,
        • "recvInvalidResps": 0,
        • "recvExceptions": 0,
        • "timeout": 0

        }

      ]

    }

  ]

}

Get all of serial connection diagnose information (include masters and slaves)

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/modbusmaster/diagnose/serial-status

Response samples

• 200
• 400

Content type

application/json

{

• "modbus_serial": [

  • {

    • "mode": "RTU Master",
    • "sentReqs": 0,
    • "recvValidResps": 0,
    • "recvInvalidResps": 0,
    • "recvCrcLrcErrors": 0,
    • "recvExceptions": 0,
    • "timeout": 0,
    • "Ports": [

      • {

        • "portNumber": 0,
        • "break": 0,
        • "frameError": 0,
        • "parityError": 0,
        • "overrunError": 0,
        • "sentReqs": 0,
        • "recvValidResps": 0,
        • "recvInvalidResps": 0,
        • "recvCrcLrcErrors": 0,
        • "recvExceptions": 0,
        • "timeout": 0

        }

      ]

    }

  ]

}

Start traffic modbus log.

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/modbusmaster/diagnose/traffic/start

Response samples

• 400

Content type

application/json

{

• "error": {

  • "message": "string"

  }

}

Stop traffic modbus log.

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/modbusmaster/diagnose/traffic/stop

Response samples

• 400

Content type

application/json

{

• "error": {

  • "message": "string"

  }

}

Operate

trigger the tag's related command to polling and get the tag data result

Authorizations:

bearerAuth

Request Body schema: application/json

Tag information.

prvdName	string Provider name.
srcName	string Source name.
tagName	string Tag name.

Responses

https://127.0.0.1/api/v1/modbusmaster/operate/direct-read-tag

Request samples

• Payload

Content type

application/json

{

• "prvdName": "modbus_tcp_master",
• "srcName": "ieg_device",
• "tagName": "command_1"

}

Response samples

• 200

Content type

application/json

Example

read_float_tagread_int32_tagread_raw_tagread_float_tag

{

• "prvdName": "modbus_tcp_master",
• "srcName": "moxa_device",
• "tagName": "command_float",
• "timestamp": 939700,
• "dataType": "float",
• "dataValue": 3.14

}

trigger the tag's related command to polling and post the tag data

Authorizations:

bearerAuth

Request Body schema: application/json

Tag information.

prvdName	string Provider name.
srcName	string Device name.
tagName	string Tag name.
dataType	string Enum: "boolean" "int8" "int16" "int32" "int64" "uint8" "uint16" "uint32" "uint64" "float" "double" "string" "bytearray" "raw" Tag type.
	string or number Tag value.

Responses

https://127.0.0.1/api/v1/modbusmaster/operate/direct-write-tag

Request samples

• Payload

Content type

application/json

Example

write_float_tagwrite_int32_tagwrite_raw_tagwrite_float_tag

{

• "prvdName": "modbus_tcp_master",
• "srcName": "moxa_device",
• "tagName": "command_float",
• "dataType": "float",
• "dataValue": 3.14

}

Status

Get status of Modbus database was modified or not

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/modbusmaster/status/config/change

Response samples

• 200

Content type

application/json

{

• "data": {

  • "result": 1

  }

}

Get overview of Modbus master

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/modbusmaster/status/config/master-overview

Response samples

• 200
• 400

Content type

application/json

{

• "version": "0.2.1",
• "enableDevFailEvent": 1,
• "enableCmdFailEvent": 1,
• "tcp": {

  • "enable": 1,
  • "masterTcpIfaces": [

    • {

      • "masterTcpIfaceId": 1,
      • "devCount": 4,
      • "cmdCount": 20

      }

    ]

  },
• "serial": {

  • "enable": 1,
  • "masterSerIfaces": [

    • {

      • "masterSerIfaceId": 1,
      • "portName": "COM1",
      • "format": 0,
      • "devCount": 3,
      • "cmdCount": 30

      },
    • {

      • "masterSerIfaceId": 2,
      • "portName": "COM2",
      • "format": 1,
      • "devCount": 2,
      • "cmdCount": 15

      },
    • {

      • "masterSerIfaceId": 3,
      • "portName": "COM3",
      • "format": 1,
      • "devCount": 6,
      • "cmdCount": 35

      },
    • {

      • "masterSerIfaceId": 4,
      • "portName": "COM4",
      • "format": 0,
      • "devCount": 2,
      • "cmdCount": 15

      }

    ]

  }

}

Platform

Get tag list of Modbus master

Authorizations:

bearerAuth

Responses

https://127.0.0.1/api/v1/modbusmaster/platform/master-tags

Response samples

• 200
• 400

Content type

application/json

[

• {

  • "prvdName": "modbus_tcp_master",
  • "srcName": "moxa-device",
  • "tagName": "voltage",
  • "dataType": "int32",
  • "access": "w",
  • "dataUnit": "%"

  },
• {

  • "prvdName": "modbus_tcp_master",
  • "srcName": "moxa-device2",
  • "tagName": "voltage",
  • "dataType": "raw",
  • "access": "r",
  • "dataSize": 5,
  • "dataUnit": "%"

  }

]