Powered by Redocly

/config/register/physical

The physical register configuration of the meter.

A register is a named measurement whose values are recorded in a database at discrete points in time (the database rows). There is an upper limit on the number of physical registers that can be supported by the meter. Depending on meter model and database configuration, typically, 16 to 64 phycial registers are available. The actual limit is available at /sys/db/max-registers.

Get /config/register/physical

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/register/physical
Request samples 
Response samples 
application/json
{
  • "result": {
    },
  • "error": "Error message (present if an error occurred)."
}
Replace /config/register/physical
SecurityApiKey 
Request 
Request Body schema: application/json
additional property
object (configRegisterPhysicalReg) 
The configuration of the named physical register.


 
Responses 
200
Normal response.


401
Unauthorized response.


put/config/register/physical
Request samples 
application/json
{
  • "grid": {
    },
  • "grid*": {
    },
  • "solar": {
    },
  • "temp": {
    }
}
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Update /config/register/physical
SecurityApiKey 
Request 
Request Body schema: application/json
additional property
object (configRegisterPhysicalReg) 
The configuration of the named physical register.


 
Responses 
200
Normal response.


401
Unauthorized response.


post/config/register/physical
Request samples 
application/json
{
  • "grid": {
    },
  • "grid*": {
    },
  • "solar": {
    },
  • "temp": {
    }
}
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Delete /config/register/physical
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/register/physical
Request samples 
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
➔ Next to /config/register/physical/{reg}