Powered by Redocly

/config/register/virtual

The virtual register configuration of the meter.

Virtual registers are calculated from physical register values and do not take up space in the database. As such there is no a priori limit on the number of virtual registers that can be configured on a meter.

Get /config/register/virtual

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


Several virtual register names are well-known and provide special
semantics:


    

  • use: Intended to represent total power consumption at a
site.  It is generally presented with the name Usage in
English and the equivalent translation in other languages
(subject to availablility).
    

    • 

  • gen: Intended to represent total power generation at a site,
e.g., from local solar or wind power generation facilities.
It is generally presented with the name Generation in
English and the equivalent translation in other languages
(subject to availability).
    

    • 

  • bat: Intended to represent total power coming from on-site
batteries (if positive) or power going to on-site batteries
for charging (if negative).  It is generally presented with
the name Battery in English and the equivalent translation
in other languages (subject to availability).
    

    • 

  • bat_el: Intended to represent the amount of energy left in
on-site batteries.  The value of this register should be equal
to the sum of each battery's state of charge times the
battery's capacity (in joules).  It is generally presented
with the name Battery left in English and the equivalent
translation in other languages (subject to availability).
    

    • 



 
Responses 
200
Normal response.


401
Unauthorized response.


put/config/register/virtual
Request samples 
application/json
{
  • "use": {
    },
  • "gen": {
    }
}
Response samples 
application/json
{
  • "status": "OK",
  • "error": "Error message (present if an error occurred)."
}
Update /config/register/virtual
SecurityApiKey 
Request 
Request Body schema: application/json
additional property
object (configRegisterVirtualReg) 
The virtual register configuration.


Several virtual register names are well-known and provide special
semantics:


    

  • use: Intended to represent total power consumption at a
site.  It is generally presented with the name Usage in
English and the equivalent translation in other languages
(subject to availablility).
    

    • 

  • gen: Intended to represent total power generation at a site,
e.g., from local solar or wind power generation facilities.
It is generally presented with the name Generation in
English and the equivalent translation in other languages
(subject to availability).
    

    • 

  • bat: Intended to represent total power coming from on-site
batteries (if positive) or power going to on-site batteries
for charging (if negative).  It is generally presented with
the name Battery in English and the equivalent translation
in other languages (subject to availability).
    

    • 

  • bat_el: Intended to represent the amount of energy left in
on-site batteries.  The value of this register should be equal
to the sum of each battery's state of charge times the
battery's capacity (in joules).  It is generally presented
with the name Battery left in English and the equivalent
translation in other languages (subject to availability).
    

    • 



 
Responses 
200
Normal response.


401
Unauthorized response.


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