/config/modbus/server

Modbus server configuration. This configures the server-side of the meter. That is, it defines how the meter provides its own data to other Modbus devices.

Get /config/modbus/server

SecurityApiKey
Request
query Parameters
max-depth
integer >= 1

Limit output depth of the response. See Max-Depth.

Example: max-depth=2
filter
string

Response filter string. See Filter-Spec.

Example: filter={foo,bar}
Responses
200

Normal response.

401

Unauthorized response.

get/config/modbus/server
Request samples
Response samples
application/json
{
  • "result": {
    },
  • "error": "Error message (present if an error occurred)."
}

Replace /config/modbus/server

SecurityApiKey
Request
Request Body schema: application/json
enable
Array of strings (configModbusServerEnable)

The list of protocols (if any) that are enabled in the Modbus server. An empty list indicates that the Modbus server is disabled.

Valid protocol names are:

Items Enum: "rtu" "tcp"
id
integer (configModbusServerId) [ 1 .. 247 ]

The address of the meter on the Modbus/RTU network. Every Modbus device must have a unique address. The default unit id is 1.

Note Address 0 is the broadcast address and addresses 248..255 are reserved for future use.

object (configModbusServerRtu)

The RTU protocol configuration.

object (configModbusServerTcp)

The TCP protocol configuration.

Responses
200

Normal response.

401

Unauthorized response.

put/config/modbus/server
Request samples
application/json
{ }
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Update /config/modbus/server

SecurityApiKey
Request
Request Body schema: application/json
enable
Array of strings (configModbusServerEnable)

The list of protocols (if any) that are enabled in the Modbus server. An empty list indicates that the Modbus server is disabled.

Valid protocol names are:

Items Enum: "rtu" "tcp"
id
integer (configModbusServerId) [ 1 .. 247 ]

The address of the meter on the Modbus/RTU network. Every Modbus device must have a unique address. The default unit id is 1.

Note Address 0 is the broadcast address and addresses 248..255 are reserved for future use.

object (configModbusServerRtu)

The RTU protocol configuration.

object (configModbusServerTcp)

The TCP protocol configuration.

Responses
200

Normal response.

401

Unauthorized response.

post/config/modbus/server
Request samples
application/json
{ }
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}

Delete /config/modbus/server

Reset to default. See the descriptions of the individual endpoints for their default values. Commonly, arrays and strings are cleared to empty, numbers are cleared to 0, and booleans are cleared to false.

SecurityApiKey
Responses
200

Normal response.

401

Unauthorized response.

delete/config/modbus/server
Request samples
Response samples
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}