Files
EOS/tests/test_measurement_energy.py
T
1a18935667 feat(measurement): add typed energy, quality and capacity APIs (#1326)
* feat: adapt configuration for multi optimization algorithms

Decouple configuration from optimization algorithm parameters. Add to_[algorithm]_param() methods
to the configuration that derive optimization algorithm specific parameters from the configuration.
Add x-scope tags to the configuration options that describe for which specific algorithms the
configuration option is for.

The whole device settings are restructured. There are now general settings for the device classes
with the afore mentioned to_[algorithm]_param() methods. The general device settings got their own
directory `devices/settings`. By this the parameter class also does not have to be a pydantic model
which can be used for future optimization/ simulations speed up.

Also the parameter class for a device is now part of the device module. This better decouples and
also is the natural place for parameters of a device.

Besides this feature there are also fixes and improvements:

* feat: extend home appliance time window settings and simulation

  Home appliance can now be configured for multiple runs with per-cycle allowed time windows. The
  number of remaining cycles to plan is determined at runtime by reading the
  ``cycles_completed_measurement_key`` from the measurement store.

* feat: specialiced CycleTimeWindowSequence for time window sequences

  Sequence of time windows associated to cycles.

  This model specializes ``ValueTimeWindowSequence`` so that the ``value``
  field of each ``ValueTimeWindow`` encodes the **cycle index** (0-based
  integer) the window belongs to.

  Typical use: an appliance that must run ``n`` times per day, each run
  constrained to a distinct time window.  Assign ``value=0`` to windows
  for the first cycle, ``value=1`` for the second, and so on.  Multiple
  windows may share the same cycle index (their allowed regions are unioned).
  Windows with ``value=None`` are silently ignored by all cycle-aware methods.

* fix: Make test_configmigrate also regard the _ANY_SENTENIEL in key values

* chore: Make devices configurations a map instead of a list

  This makes config paths stable regardless of declaration order and lets each device settings
  class build its own config path from ``self.device_id`` without needing an external index.
  Tests are adapted likewise.

  Devices configurations are automatically migrated from lists to maps.

* chore: rename levelized_cost_of_storage_kwh to levelized_cost_of_storage_amt kwh

  This better fits in the naming scheme and also makes clear the costs are money.

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>

* fix: runtime config update ignored by config file

Runtime settings were handed back to pydantic-settings as init settings,
which rank below the config file and the environment. Any key already
present in EOS.config.json or in the environment silently discarded the
update, so a bulk PUT /v1/config returned 200 without applying anything,
while the granular PUT /v1/config/{path} endpoint kept working.

Add a dedicated runtime settings source ranked directly below the command
line arguments and record granular updates there as well, so both
endpoints share one store that survives re-evaluation of the settings
sources. Environment variables keep precedence over the config file for
all keys that were not set at runtime.

Also repairs revert_settings() and update(), which passed their data
through the same init settings.

Closes #1303

* fix: env vars ignored on first config build

ConfigEOS.__init__ passed self as first positional argument to _setup,
which forwards it to pydantic_settings.BaseSettings.__init__. Its first
positional parameter is _case_sensitive, so the environment source
matched the upper case variable names against the lower case field names
and returned nothing. Environment settings only took effect after the
next configuration setup.

* docs: changelog for config priority fixes

* fix(config): preserve device identities and storage costs during migration

* fix(measurement): restore JSON records into the existing singleton

* fix(devices): preserve charge-rate typing and public import compatibility

* feat(measurement): integrate typed energy quality and capacity APIs

Port the locally backed-up measurement extensions to main async storage and PR #1256 device maps. Preserve runtime capacity estimates across #1305 bulk updates. Confirm JSON singleton restore defect on unchanged main and add regression. No production configuration or measurements included.

Co-authored-by: Andreas <drbacke@gmx.de>

* docs(measurement): describe household settings and consolidate regression coverage

* docs(measurement): regenerate configuration and API contracts

* test(measurement): isolate capacity database state between tests

* ruff format fix

* test(measurement): assert restored timestamps before timezone conversion

* docs(measurement): align API version with refreshed prerequisites

* fix(config): satisfy typed device conversion and migration contracts

* docs(config): refresh validated configuration prerequisite schemas

* fix(measurement): enforce typed capacity and sample validation

* style(measurement): normalize imports for CI

* docs(measurement): refresh typed measurement API schemas

---------

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
Co-authored-by: Bobby Noelte <b0661n0e17e@gmail.com>
Co-authored-by: r0b2g1t <r0b2g1t@users.noreply.github.com>
2026-09-17 18:28:43 +02:00

136 lines
5.1 KiB
Python

"""Physical and temporal contracts for interval energy."""
# ruff: noqa: S101
from datetime import datetime, timedelta, timezone
from typing import Any
from zoneinfo import ZoneInfo
import pytest
from akkudoktoreos.measurement.energy import energy_intervals
from akkudoktoreos.measurement.measurement import MeasurementChannelSettings
from akkudoktoreos.utils.datetimeutil import to_datetime
START = datetime(2026, 9, 10, tzinfo=timezone.utc)
def channel(quantity="power", **kwargs):
defaults: dict[str, dict[str, Any]] = {
"power": dict(unit="W", integration_method="hold", max_gap_seconds=900),
"cumulative_energy": dict(unit="kWh"),
"interval_energy": dict(unit="Wh", interval_seconds=900, timestamp_reference="start"),
}
return MeasurementChannelSettings(quantity=quantity, **(defaults[quantity] | kwargs))
def convert(points, config=None, seconds=900):
return energy_intervals(
[(START + timedelta(seconds=t), v) for t, v in points],
config or channel(),
START,
START + timedelta(seconds=seconds),
)
@pytest.mark.parametrize(
"config,points",
[
(channel(), [(0, 800), (900, 800)]),
(channel(unit="kW"), [(0, 0.8), (900, 0.8)]),
(channel("cumulative_energy"), [(0, 10), (900, 10.2)]),
(channel("interval_energy"), [(0, 200)]),
(channel("interval_energy", timestamp_reference="end"), [(900, 200)]),
],
)
def test_equivalent_measurements(config, points):
result = convert(points, config)[0]
assert result.energy_wh == pytest.approx(200)
assert result.coverage_seconds == 900
assert result.coverage_status == "complete"
def test_time_weighting_and_linear_interpolation():
assert convert([(0, 0), (600, 1200), (900, 1200)])[0].energy_wh == 100
assert convert([(0, 0), (900, 1600)], channel(integration_method="linear"))[0].energy_wh == 200
def test_gap_and_no_extrapolation():
result = convert([(0, 800), (300, 800)])[0]
assert result.energy_wh is None
assert result.observed_energy_wh == pytest.approx(800 / 12)
assert result.coverage_status == "partial"
assert convert([(0, 800), (900, 800)], channel(max_gap_seconds=60))[0].energy_wh is None
assert convert([])[0].coverage_status == "missing"
def test_null_breaks_hold_at_outage():
result = convert([(0, 800), (300, None), (600, 800), (900, 800)])[0]
assert result.coverage_seconds == 600
assert result.coverage_status == "partial"
assert len(result.coverage_ranges) == 2
def test_reset_does_not_create_negative_consumption():
result = convert([(0, 10), (450, 0), (900, 0.1)], channel("cumulative_energy"))[0]
assert result.energy_wh is None
assert result.observed_energy_wh == pytest.approx(100)
assert "meter_reset" in result.flags
def test_hour_allocation_conserves_energy_and_is_labelled():
result = convert([(0, 1000)], channel("interval_energy", interval_seconds=3600), 3600)
assert all(r.energy_wh is not None for r in result)
assert sum(r.energy_wh for r in result if r.energy_wh is not None) == 1000
assert all("allocated_energy" in r.methods for r in result)
@pytest.mark.parametrize(
"quantity,points",
[
("power", [(0, 1), (0, 2)]),
("interval_energy", [(0, 100), (450, 100)]),
],
)
def test_ambiguous_time_support_rejected(quantity, points):
with pytest.raises(ValueError):
convert(points, channel(quantity))
def test_nan_and_signed_power():
assert convert([(0, float("nan")), (900, 800)])[0].energy_wh is None
assert convert([(0, -800), (900, -800)])[0].energy_wh == -200
@pytest.mark.parametrize("month,day,hours", [(3, 29, 23), (10, 25, 25)])
def test_dst_calendar_day(month, day, hours):
start = datetime(2026, month, day, tzinfo=ZoneInfo("Europe/Berlin"))
end = start + timedelta(days=1)
result = energy_intervals([(start, 0), (end, hours)], channel("cumulative_energy"), start, end)
assert len(result) == hours * 4
assert all(r.energy_wh is not None for r in result)
assert sum(r.energy_wh for r in result if r.energy_wh is not None) == pytest.approx(hours * 1000)
@pytest.mark.asyncio
async def test_measurement_wrapper_preserves_asynchronous_channels(config_eos):
from akkudoktoreos.core.coreabc import get_measurement
from akkudoktoreos.measurement.measurement import MeasurementCommonSettings
measurement = get_measurement()
previous, records = config_eos.measurement, measurement.records
try:
config_eos.measurement = MeasurementCommonSettings(
channels={"p": channel(), "other": channel()}
)
measurement._db_reset_state()
(await measurement.update_value(to_datetime(START), "p", 800))
(await measurement.update_value(to_datetime(START + timedelta(seconds=450)), "other", 1))
(await measurement.update_value(to_datetime(START + timedelta(seconds=900)), "p", 800))
result = (await measurement.energy_intervals("p", START, START + timedelta(seconds=900)))
assert result[0].energy_wh == 200
finally:
measurement._db_reset_state()
measurement.records = records
config_eos.measurement = previous