/ctrl/interface

The names and descriptions of control interfaces detected by the meter.

Get /ctrl/interface

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/ctrl/interface

Request samples

curl
Python
JavaScript
Go

Response samples

application/json

{"result": {"modbus": {"method": [{"name": "read_coils",
"in": "qq",
"in_names": ["addr",
"count"
],
"out": "ay",
"doc": "Read <arg>count</arg> number of coils starting with the coil at address <arg>addr</arg>. The return value is a Modbus reply packet which may contain an exception status or the requested coil values."
}
]
},
"relay": {"method": [{"name": "close",
"in": "u",
"in_names": ["n"
],
"out": "",
"doc": "Close the relay with index <arg>n</arg>."
},
{"name": "open",
"in": "u",
"in_names": ["n"
],
"out": "",
"doc": "Open the relay with index <arg>n</arg>."
}
]
}
},
"error": "Error message (present if an error occurred)."
}

➔ Next to /ctrl/interface/{if}