/config/modbus/client/map

User-defined Modbus address maps. The builtin, read-only system maps are available at /sys/modbus/client/map. If a user-defined map with the same name as a system map exists, it will shadow (mask) the system map with them same name.

Get /config/modbus/client/map

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/client/map
Request samples
Response samples
application/json
{
  • "result": {
    },
  • "error": "Error message (present if an error occurred)."
}

Replace /config/modbus/client/map

SecurityApiKey
Request
Request Body schema: application/json
additional property
object (configModbusClientMapName)

Modbus map consisting of a list of register definitions and a set of options.

Responses
200

Normal response.

401

Unauthorized response.

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

Update /config/modbus/client/map

SecurityApiKey
Request
Request Body schema: application/json
additional property
object (configModbusClientMapName)

Modbus map consisting of a list of register definitions and a set of options.

Responses
200

Normal response.

401

Unauthorized response.

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

Delete /config/modbus/client/map

Delete all user maps.

SecurityApiKey
Responses
200

Normal response.

401

Unauthorized response.

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