mirror of
https://github.com/Akkudoktor-EOS/EOS.git
synced 2026-11-13 01:03:45 +01:00
Bobby NoelteandClaude Opus 5.5
faf37abfe7
An inverter profile describes the technical data of an inverter model: its nominal AC power, the DC→AC and AC→DC efficiency curves over the load fraction (AC power relative to the nominal power), the AC charge power limit of the model, whether that limit also limits PV charging, and an optional power derating over the ambient temperature. Curves are read linearly and clamped at their ends, so every lookup yields a value. The packaged profile generic-hybrid has typical hybrid inverter efficiencies, no nominal power (the inverter device has to provide it) and full power up to 45 degC. Inverter settings name their profile (inverter_profile, default generic-hybrid) and hold the differences of the unit in profile_adjustment: nominal_power_w (replaces the profile value, required for a generic profile), max_power_w and max_ac_charge_power_w (installation limits that can only lower; an AC charge limit of 0 disables AC charging). The effective parameters are resolved at the ambient temperature of the inverter, given by the new measurement key <device_id>-temperature-degc (45 degC without a fresh value); the power derating lowers the maximum power and the AC charge limit. Optimization parameters are always valid: the GENETIC and GENETIC0 parameter preparation resolve the inverter with resolve_current_operating_parameters_or_defaults, which never raises. An unusable profile gives the generic-hybrid profile, a missing nominal power the fallback of 10000 W, an inverter derated to zero power the parameters at 45 degC, and no usable profile at all the profile adjustment with constant efficiency; each is logged as error. The GENETIC inverter takes the AC→DC efficiency curve of the profile, solved exactly on each linear piece of the curve (about 2 % longer runs); GENETIC0 keeps constant efficiencies and no longer replaces the configured inverters with the demo inverter; a battery, electric vehicle or inverter that cannot be prepared is left out of the GENETIC0 run, never replaced by a demo device. Configurations migrate: max_power_w becomes profile_adjustment.nominal_power_w, max_ac_charge_power_w moves into the adjustment, an ac_to_dc_efficiency of 0 keeps AC charging disabled, and the efficiency fields are dropped with an error log, as for batteries, so the profile efficiencies apply. Home Assistant config paths follow. Additional changes - Move the curve algorithms of the battery profile into profilecurve, so battery and inverter profiles share them; the battery profile keeps its document format and classes. - Move ProfileBaseModel, the strict base of profile documents, into profilestore. - Serve inverter profiles through the profile REST API. Refuse to delete a profile that a configured device uses and that has no packaged profile to revert to (409). - Share the measurement access of the device settings in devicemeasurement. - Rename check_battery_profiles to check_device_profiles; the device profile check at configuration setup covers inverters, too. - Document inverter profiles, their configuration, defaults and sharing; regenerate the configuration and OpenAPI documentation. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Assisted-by: Claude Code (claude-opus-5-5)
232 lines
10 KiB
Python
232 lines
10 KiB
Python
"""Tests for the REST API of the device profile store (/v1/profile)."""
|
|
|
|
import json
|
|
from pathlib import Path
|
|
from typing import Iterator
|
|
|
|
import pytest
|
|
from fastapi import FastAPI
|
|
from fastapi.testclient import TestClient
|
|
|
|
from akkudoktoreos.devices.profile.batteryprofile import BatteryProfileSettings
|
|
from akkudoktoreos.devices.profile.inverterprofile import InverterProfileSettings
|
|
from akkudoktoreos.devices.profile.profilestore import ProfileStore, get_profile_store
|
|
from akkudoktoreos.server.rest.error import register_problem_handlers
|
|
from akkudoktoreos.server.rest.profile import router
|
|
|
|
|
|
@pytest.fixture
|
|
def client(config_eos) -> Iterator[TestClient]:
|
|
"""Client of an app with only the profile router, on a fresh store."""
|
|
ProfileStore.reset_instance()
|
|
app = FastAPI()
|
|
register_problem_handlers(app)
|
|
app.include_router(router)
|
|
with TestClient(app) as test_client:
|
|
yield test_client
|
|
ProfileStore.reset_instance()
|
|
|
|
|
|
@pytest.fixture
|
|
def generic_lfp() -> dict:
|
|
"""The document of the packaged generic LFP battery profile."""
|
|
store = get_profile_store()
|
|
path = store.package_dir(BatteryProfileSettings) / "generic-lfp.json"
|
|
return json.loads(path.read_text(encoding="utf-8"))
|
|
|
|
|
|
def user_path(name: str) -> Path:
|
|
return get_profile_store().user_dir(BatteryProfileSettings) / f"{name}.json"
|
|
|
|
|
|
class TestRead:
|
|
def test_kinds(self, client):
|
|
response = client.get("/v1/profile")
|
|
assert response.status_code == 200
|
|
assert "battery" in response.json()
|
|
|
|
def test_list_contains_the_packaged_profile(self, client):
|
|
response = client.get("/v1/profile/battery")
|
|
assert response.status_code == 200
|
|
assert {"name": "generic-lfp", "source": "package", "packaged": True} in response.json()
|
|
|
|
def test_schema(self, client):
|
|
response = client.get("/v1/profile/battery/schema")
|
|
assert response.status_code == 200
|
|
assert "charge_limit_crate" in response.json()["properties"]
|
|
|
|
def test_get_document(self, client):
|
|
response = client.get("/v1/profile/battery/generic-lfp")
|
|
assert response.status_code == 200
|
|
assert response.json()["chemistry"] == "LFP"
|
|
BatteryProfileSettings.model_validate(response.json())
|
|
|
|
def test_inverter_profiles(self, client):
|
|
assert "inverter" in client.get("/v1/profile").json()
|
|
listed = client.get("/v1/profile/inverter").json()
|
|
assert {"name": "generic-hybrid", "source": "package", "packaged": True} in listed
|
|
schema = client.get("/v1/profile/inverter/schema").json()
|
|
assert "power_derating" in schema["properties"]
|
|
response = client.get("/v1/profile/inverter/generic-hybrid")
|
|
assert response.status_code == 200
|
|
InverterProfileSettings.model_validate(response.json())
|
|
|
|
def test_errors_are_problem_details(self, client):
|
|
response = client.get("/v1/profile/nope")
|
|
assert response.headers["content-type"] == "application/problem+json"
|
|
assert response.json() == {
|
|
"type": "about:blank",
|
|
"title": "Unknown profile kind",
|
|
"status": 404,
|
|
"detail": "Unknown profile kind 'nope'.",
|
|
"instance": "/v1/profile/nope",
|
|
}
|
|
|
|
def test_unknown_kind_is_404(self, client):
|
|
assert client.get("/v1/profile/nope").status_code == 404
|
|
assert client.get("/v1/profile/nope/x").status_code == 404
|
|
assert client.put("/v1/profile/nope/x", json={}).status_code == 404
|
|
|
|
def test_missing_profile_is_404(self, client):
|
|
response = client.get("/v1/profile/battery/does-not-exist")
|
|
assert response.status_code == 404
|
|
assert "does-not-exist" in response.json()["detail"]
|
|
|
|
|
|
class TestWrite:
|
|
def test_put_saves_a_user_profile_and_returns_it(self, client, generic_lfp):
|
|
document = {**generic_lfp, "battery_model": "My battery", "nominal_capacity_wh": 10240.0}
|
|
response = client.put("/v1/profile/battery/my-battery", json=document)
|
|
assert response.status_code == 200
|
|
assert response.json()["nominal_capacity_wh"] == 10240.0
|
|
assert user_path("my-battery").is_file()
|
|
assert client.get("/v1/profile/battery/my-battery").json()["battery_model"] == "My battery"
|
|
assert {"name": "my-battery", "source": "user", "packaged": False} in client.get(
|
|
"/v1/profile/battery"
|
|
).json()
|
|
|
|
def test_put_takes_effect_for_compiled_profile_users(self, client, generic_lfp):
|
|
store = get_profile_store()
|
|
before = store.get(BatteryProfileSettings, "generic-lfp")
|
|
assert before.nominal_capacity_wh is None
|
|
response = client.put(
|
|
"/v1/profile/battery/generic-lfp", json={**generic_lfp, "nominal_capacity_wh": 5000.0}
|
|
)
|
|
assert response.status_code == 200
|
|
after = store.get(BatteryProfileSettings, "generic-lfp")
|
|
assert after is not before
|
|
assert after.nominal_capacity_wh == 5000.0
|
|
|
|
def test_put_of_an_invalid_document_is_422_and_saves_nothing(self, client, generic_lfp):
|
|
response = client.put(
|
|
"/v1/profile/battery/broken", json={**generic_lfp, "nominal_capacity_wh": -1}
|
|
)
|
|
assert response.status_code == 422
|
|
assert "nominal_capacity_wh" in response.json()["detail"]
|
|
assert not user_path("broken").exists()
|
|
|
|
def test_put_with_an_unsafe_name_is_422(self, client, generic_lfp):
|
|
response = client.put("/v1/profile/battery/..%2F..%2Fescape", json=generic_lfp)
|
|
assert response.status_code in (404, 422) # rejected by the router or the store
|
|
data_dir = get_profile_store().user_dir(BatteryProfileSettings).parent.parent
|
|
assert not (data_dir / "escape.json").exists()
|
|
|
|
def test_names_with_subdirectories_are_not_routed(self, client, generic_lfp):
|
|
"""Profile names are flat; a path below the name matches no route."""
|
|
assert client.put("/v1/profile/battery/vendor/model-a", json=generic_lfp).status_code == 404
|
|
assert not user_path("vendor/model-a").exists()
|
|
|
|
@pytest.mark.parametrize("name", ["C:evil", ".hidden"])
|
|
def test_invalid_names_are_rejected(self, client, generic_lfp, name):
|
|
response = client.put(f"/v1/profile/battery/{name}", json=generic_lfp)
|
|
assert response.status_code == 422
|
|
assert "Invalid battery profile name" in response.json()["detail"]
|
|
|
|
def test_reserved_name_is_rejected(self, client, generic_lfp):
|
|
"""PUT .../schema would save a profile that GET can never return."""
|
|
response = client.put("/v1/profile/battery/schema", json=generic_lfp)
|
|
assert response.status_code == 422
|
|
assert "reserved" in response.json()["detail"]
|
|
|
|
|
|
class TestDelete:
|
|
def test_delete_of_a_directory_is_an_eos_problem(self, client):
|
|
user_path("model-a").mkdir(parents=True)
|
|
response = client.delete("/v1/profile/battery/model-a")
|
|
assert response.status_code == 422
|
|
assert "is not a file" in response.json()["detail"]
|
|
|
|
def test_delete_user_profile(self, client, generic_lfp):
|
|
client.put("/v1/profile/battery/my-battery", json=generic_lfp)
|
|
response = client.delete("/v1/profile/battery/my-battery")
|
|
assert response.status_code == 200
|
|
assert response.json() is None # no packaged profile of that name
|
|
assert client.get("/v1/profile/battery/my-battery").status_code == 404
|
|
|
|
def test_delete_of_an_override_restores_the_packaged_profile(self, client, generic_lfp):
|
|
client.put(
|
|
"/v1/profile/battery/generic-lfp", json={**generic_lfp, "nominal_capacity_wh": 5000.0}
|
|
)
|
|
response = client.delete("/v1/profile/battery/generic-lfp")
|
|
assert response.status_code == 200
|
|
assert response.json() == {"name": "generic-lfp", "source": "package", "packaged": True}
|
|
assert client.get("/v1/profile/battery/generic-lfp").json()["nominal_capacity_wh"] is None
|
|
|
|
def test_delete_of_a_packaged_profile_is_409(self, client):
|
|
response = client.delete("/v1/profile/battery/generic-lfp")
|
|
assert response.status_code == 409
|
|
assert client.get("/v1/profile/battery/generic-lfp").status_code == 200
|
|
|
|
def test_delete_of_a_missing_profile_is_404(self, client):
|
|
assert client.delete("/v1/profile/battery/does-not-exist").status_code == 404
|
|
|
|
@pytest.mark.parametrize("devices", ["batteries", "electric_vehicles"])
|
|
def test_delete_of_a_battery_profile_in_use_is_409(
|
|
self, client, config_eos, generic_lfp, devices
|
|
):
|
|
client.put("/v1/profile/battery/my-battery", json=generic_lfp)
|
|
config_eos.merge_settings_from_dict(
|
|
{"devices": {devices: {"unit1": {"device_id": "unit1", "battery_profile": "my-battery"}}}}
|
|
)
|
|
response = client.delete("/v1/profile/battery/my-battery")
|
|
assert response.status_code == 409
|
|
assert response.json()["title"] == "Profile in use"
|
|
assert "unit1" in response.json()["detail"]
|
|
assert client.get("/v1/profile/battery/my-battery").status_code == 200
|
|
|
|
def test_delete_of_an_inverter_profile_in_use_is_409(self, client, config_eos):
|
|
generic_hybrid = client.get("/v1/profile/inverter/generic-hybrid").json()
|
|
client.put("/v1/profile/inverter/my-inverter", json=generic_hybrid)
|
|
config_eos.merge_settings_from_dict(
|
|
{
|
|
"devices": {
|
|
"inverters": {
|
|
"inverter1": {"device_id": "inverter1", "inverter_profile": "my-inverter"}
|
|
}
|
|
}
|
|
}
|
|
)
|
|
response = client.delete("/v1/profile/inverter/my-inverter")
|
|
assert response.status_code == 409
|
|
assert "inverter1" in response.json()["detail"]
|
|
# A battery profile of the same name is not in use.
|
|
assert client.delete("/v1/profile/battery/my-inverter").status_code == 404
|
|
|
|
def test_delete_of_an_override_in_use_reverts_to_the_packaged_profile(
|
|
self, client, config_eos, generic_lfp
|
|
):
|
|
client.put("/v1/profile/battery/generic-lfp", json=generic_lfp)
|
|
config_eos.merge_settings_from_dict(
|
|
{"devices": {"batteries": {"battery1": {"device_id": "battery1"}}}}
|
|
)
|
|
assert config_eos.devices.batteries["battery1"].battery_profile == "generic-lfp"
|
|
assert client.delete("/v1/profile/battery/generic-lfp").status_code == 200
|
|
|
|
|
|
def test_eos_app_serves_the_profile_api(config_eos):
|
|
from akkudoktoreos.server.eos import app
|
|
|
|
paths = app.openapi()["paths"]
|
|
assert "/v1/profile/{kind}/{name}" in paths
|
|
assert set(paths["/v1/profile/{kind}/{name}"]) == {"get", "put", "delete"}
|