/sys/modbus/client/map/{name}

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

Get /sys/modbus/client/map/{name}

SecurityApiKey

Request

path Parameters

name

required

string

The name of a system Modbus map (read-only).

Example: egauge_prm3

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/sys/modbus/client/map/{name}

Request samples

curl
Python
JavaScript
Go

Response samples

application/json

{"result": {"option": {"default-modbus-addr": "2",
"default-serial-params": "9600/8n1"
},
"reg": [{"name": "irradiance",
"addr": 0,
"type": "u32",
"kind": "analog",
"unit": "W",
"offset": 0,
"scale": 0.1,
"access": "ro"
},
{"name": "temp",
"addr": 1,
"type": "s32",
"kind": "analog",
"unit": "degC",
"offset": 0,
"scale": 0.01,
"access": "ro"
}
]
},
"error": "Error message (present if an error occurred)."
}

➔ Next to /sys/modbus/client/map/{name}/option