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).
| reg required | string The name of a virtual register. May not be empty, contain
commas ( |
Normal response.
Unauthorized response.
{- "result": {
- "value": [
- {
- "op": "+",
- "register": "grid"
}, - {
- "op": "+",
- "register": "solar"
}
]
}, - "error": "Error message (present if an error occurred)."
}| reg required | string The name of a virtual register. May not be empty, contain
commas ( |
Array of objects (configRegisterVirtualRegValue) The formula to calculate the value of this virtual register. It consists of a list of physical register names whose values are to be added or subtracted. |
Normal response.
Unauthorized response.
{ }{- "status": "OK",
- "error": "Error message (present if an error occurred)."
}| reg required | string The name of a virtual register. May not be empty, contain
commas ( |
Array of objects (configRegisterVirtualRegValue) The formula to calculate the value of this virtual register. It consists of a list of physical register names whose values are to be added or subtracted. |
Normal response.
Unauthorized response.
{ }{- "status": "OK",
- "error": "Error message (present if an error occurred)."
}Remove this virtual register.
| reg required | string The name of a virtual register. May not be empty, contain
commas ( |
Normal response.
Unauthorized response.
{- "status": "OK",
- "error": "Error message (present if an error occurred)."
}