The service provides the ability to execute various operations for their side effects, such as rebooting the meter. Unless stated otherwise, the resources in this service are available only to users with the save right (see /auth/rights).
Clear data. The string in the request body identifies what data to clear:
excess: For register values that are read from a remote
device, it is possible that the meter may not be able to
reach the remote device at times (e.g., due to a networking
problem). If the remote device provides cumulative values,
this means that when the remote device becomes accessible
again, the cumulative value may have increased
significantly, which could then cause a spike in the graphed
values for that register. To prevent such spikes, the meter
will instead record the jump as an excess and then replay
that excess gradually over time so that the meter can catch
up to the true value without causing a spike. Executing
this command clears to zero the excess of all registers.
This will typically cause a spike in the graphed values for
any remote registers which had a non-zero excess but, on the
positive side, will then ensure that the cumulative
values afterwards match those of the remote
device(s).
Note If excess keeps accumulating, it may be better to
use the spiky option for remote
registers.
web_cache: Clears the web server cache of compressed
files. Under normal circumstances, it is not necessary to
clear this cache explicitly. However, this command can be
used in case the cache gets corrupted, e.g., due to a power
cycle while the meter is in the middle of writing a cache
file.
Clear response.
Unauthorized response.
"excess"{- "status": "OK",
- "error": "Error message (present if an error occurred)."
}This command supports restoring the database from a backup file, zeroing of all or parts of the database, as well as splitting the positive values of certain registers into separate positive-only registers.
| action required | string The action to perform. The possible values are:
|
| from | string (ForeverStamp) If specified, this limits the operation to data that is not older than the timestamp specified here. |
| to | string (ForeverStamp) If specified, this limits the operation to data that is not younger than the timestamp specified here. |
| regs | Array of integers If specified, the operation is limited to the registers whose database ids appear in this list. |
| data | string This member is required for action |
| more_chunks | boolean This is used only for |
DB response.
Unauthorized response.
{- "action": "restore"
}{- "status": "OK",
- "error": "Error message (present if an error occurred)."
}Restore the factory settings and reboot the meter.
Warning All existing data and settings will be lost.
Restore factory settings response.
Unauthorized response.
{- "status": "OK",
- "error": "Error message (present if an error occurred)."
}Initiate a reboot of the meter. The actual reboot command is delayed by one second to increase the likelihood that the reply to this request can be received by the client before the meter shuts down.
Once initiated, the meter will be unavailable for a while (typically, 20 to 60 seconds). If the network configuration of the meter was changed, the reboot may cause the meter to not become available again at the old network address. Thus, the client should check for such changes before initiating the reboot and take appropriate action if the network configuration did change.
Set time response.
Unauthorized response.
{- "status": "OK",
- "error": "Error message (present if an error occurred)."
}Optionally set the date/time of the meter and restart the NTP and/or the PTP services, if configured.
A Unix timestamp expressed as a decimal string that may contain a fractional value for sub-second resolution. A string is used here since most JSON libraries store numbers as IEEE-754 double-precision numbers and the 54-bit mantissa of that format may not be sufficient to accurately represent the timestamp.
Set time response.
Unauthorized response.
"1677523091.000900435"{- "status": "OK",
- "error": "Error message (present if an error occurred)."
}Update the meter firmware or kernel.
Update response.
Unauthorized response.
{- "action": "list",
- "target": "fw"
}{- "version": 4.4,
- "minimum": "4.1.2",
- "error": "Error message (present if an error occurred)."
}Manage WLAN (Wi-Fi) connection. See /sys/net/wlan to get the currently detected and configured WLAN networks.
WLAN response.
Unauthorized response.
{- "action": "add"
}{- "status": "OK",
- "error": "Error message (present if an error occurred)."
}