Inverter v2 (#245)

* inverter class rewritten second try
* cleanup
* inverter section of decives.py translation
* open api fix
* fix openapi v2
* renamed the class itself
* ruff fix
* Update genetic.py
* cleanup
* reverted indent

tests/test_class_ems.py

@@ -10,7 +10,7 @@ from akkudoktoreos.core.ems import (
 )
 from akkudoktoreos.devices.battery import EAutoParameters, PVAkku, PVAkkuParameters
 from akkudoktoreos.devices.generic import HomeAppliance, HomeApplianceParameters
-from akkudoktoreos.devices.inverter import Wechselrichter, WechselrichterParameters
+from akkudoktoreos.devices.inverter import Inverter, InverterParameters
 
 start_hour = 1
 
@@ -30,7 +30,7 @@ def create_ems_instance() -> EnergieManagementSystem:
         hours=config_eos.prediction_hours,
     )
     akku.reset()
-    wechselrichter = Wechselrichter(WechselrichterParameters(max_leistung_wh=10000), akku)
+    inverter = Inverter(InverterParameters(max_power_wh=10000), akku)
 
     # Household device (currently not used, set to None)
     home_appliance = HomeAppliance(
@@ -216,7 +216,7 @@ def create_ems_instance() -> EnergieManagementSystem:
             preis_euro_pro_wh_akku=preis_euro_pro_wh_akku,
             gesamtlast=gesamtlast,
         ),
-        wechselrichter=wechselrichter,
+        inverter=inverter,
         eauto=eauto,
         home_appliance=home_appliance,
     )

tests/test_class_ems_2.py

@@ -9,7 +9,7 @@ from akkudoktoreos.core.ems import (
 )
 from akkudoktoreos.devices.battery import EAutoParameters, PVAkku, PVAkkuParameters
 from akkudoktoreos.devices.generic import HomeAppliance, HomeApplianceParameters
-from akkudoktoreos.devices.inverter import Wechselrichter, WechselrichterParameters
+from akkudoktoreos.devices.inverter import Inverter, InverterParameters
 
 start_hour = 0
 
@@ -29,7 +29,7 @@ def create_ems_instance() -> EnergieManagementSystem:
         hours=config_eos.prediction_hours,
     )
     akku.reset()
-    wechselrichter = Wechselrichter(WechselrichterParameters(max_leistung_wh=10000), akku)
+    inverter = Inverter(InverterParameters(max_power_wh=10000), akku)
 
     # Household device (currently not used, set to None)
     home_appliance = HomeAppliance(
@@ -121,7 +121,7 @@ def create_ems_instance() -> EnergieManagementSystem:
             preis_euro_pro_wh_akku=preis_euro_pro_wh_akku,
             gesamtlast=gesamtlast,
         ),
-        wechselrichter=wechselrichter,
+        inverter=inverter,
         eauto=eauto,
         home_appliance=home_appliance,
     )

tests/test_inverter.py

@@ -0,0 +1,262 @@
+from unittest.mock import Mock
+
+import pytest
+
+from akkudoktoreos.devices.inverter import Inverter, InverterParameters
+
+
+@pytest.fixture
+def mock_battery():
+    mock_battery = Mock()
+    mock_battery.energie_laden = Mock(return_value=(0.0, 0.0))
+    mock_battery.energie_abgeben = Mock(return_value=(0.0, 0.0))
+    return mock_battery
+
+
+@pytest.fixture
+def inverter(mock_battery):
+    return Inverter(InverterParameters(max_power_wh=500.0), akku=mock_battery)
+
+
+def test_process_energy_excess_generation(inverter, mock_battery):
+    # Battery charges 100 Wh with 10 Wh loss
+    mock_battery.energie_laden.return_value = (100.0, 10.0)
+    generation = 600.0
+    consumption = 200.0
+    hour = 12
+
+    grid_export, grid_import, losses, self_consumption = inverter.process_energy(
+        generation, consumption, hour
+    )
+
+    assert grid_export == pytest.approx(290.0, rel=1e-2)  # 290 Wh feed-in after battery charges
+    assert grid_import == 0.0  # No grid draw
+    assert losses == 10.0  # Battery charging losses
+    assert self_consumption == 200.0  # All consumption is met
+    mock_battery.energie_laden.assert_called_once_with(400.0, hour)
+
+
+def test_process_energy_generation_equals_consumption(inverter, mock_battery):
+    generation = 300.0
+    consumption = 300.0
+    hour = 12
+
+    grid_export, grid_import, losses, self_consumption = inverter.process_energy(
+        generation, consumption, hour
+    )
+
+    assert grid_export == 0.0  # No feed-in as generation equals consumption
+    assert grid_import == 0.0  # No grid draw
+    assert losses == 0.0  # No losses
+    assert self_consumption == 300.0  # All consumption is met with generation
+
+    mock_battery.energie_laden.assert_called_once_with(0.0, hour)
+
+
+def test_process_energy_battery_discharges(inverter, mock_battery):
+    # Battery discharges 100 Wh with 10 Wh loss already accounted for in the discharge
+    mock_battery.energie_abgeben.return_value = (100.0, 10.0)
+    generation = 100.0
+    consumption = 250.0
+    hour = 12
+
+    grid_export, grid_import, losses, self_consumption = inverter.process_energy(
+        generation, consumption, hour
+    )
+
+    assert grid_export == 0.0  # No feed-in as generation is insufficient
+    assert grid_import == pytest.approx(
+        50.0, rel=1e-2
+    )  # Grid supplies remaining shortfall after battery discharge
+    assert losses == 10.0  # Discharge losses
+    assert self_consumption == 200.0  # Generation + battery discharge
+    mock_battery.energie_abgeben.assert_called_once_with(150.0, hour)
+
+
+def test_process_energy_battery_empty(inverter, mock_battery):
+    # Battery is empty, so no energy can be discharged
+    mock_battery.energie_abgeben.return_value = (0.0, 0.0)
+    generation = 100.0
+    consumption = 300.0
+    hour = 12
+
+    grid_export, grid_import, losses, self_consumption = inverter.process_energy(
+        generation, consumption, hour
+    )
+
+    assert grid_export == 0.0  # No feed-in as generation is insufficient
+    assert grid_import == pytest.approx(200.0, rel=1e-2)  # Grid has to cover the full shortfall
+    assert losses == 0.0  # No losses as the battery didn't discharge
+    assert self_consumption == 100.0  # Only generation is consumed
+    mock_battery.energie_abgeben.assert_called_once_with(200.0, hour)
+
+
+def test_process_energy_battery_full_at_start(inverter, mock_battery):
+    # Battery is full, so no charging happens
+    mock_battery.energie_laden.return_value = (0.0, 0.0)
+    generation = 500.0
+    consumption = 200.0
+    hour = 12
+
+    grid_export, grid_import, losses, self_consumption = inverter.process_energy(
+        generation, consumption, hour
+    )
+
+    assert grid_export == pytest.approx(
+        300.0, rel=1e-2
+    )  # All excess energy should be fed into the grid
+    assert grid_import == 0.0  # No grid draw
+    assert losses == 0.0  # No losses
+    assert self_consumption == 200.0  # Only consumption is met
+    mock_battery.energie_laden.assert_called_once_with(300.0, hour)
+
+
+def test_process_energy_insufficient_generation_no_battery(inverter, mock_battery):
+    # Insufficient generation and no battery discharge
+    mock_battery.energie_abgeben.return_value = (0.0, 0.0)
+    generation = 100.0
+    consumption = 500.0
+    hour = 12
+
+    grid_export, grid_import, losses, self_consumption = inverter.process_energy(
+        generation, consumption, hour
+    )
+
+    assert grid_export == 0.0  # No feed-in as generation is insufficient
+    assert grid_import == pytest.approx(400.0, rel=1e-2)  # Grid supplies the shortfall
+    assert losses == 0.0  # No losses
+    assert self_consumption == 100.0  # Only generation is consumed
+    mock_battery.energie_abgeben.assert_called_once_with(400.0, hour)
+
+
+def test_process_energy_insufficient_generation_battery_assists(inverter, mock_battery):
+    # Battery assists with some discharge to cover the shortfall
+    mock_battery.energie_abgeben.return_value = (
+        50.0,
+        5.0,
+    )  # Battery discharges 50 Wh with 5 Wh loss
+    generation = 200.0
+    consumption = 400.0
+    hour = 12
+
+    grid_export, grid_import, losses, self_consumption = inverter.process_energy(
+        generation, consumption, hour
+    )
+
+    assert grid_export == 0.0  # No feed-in as generation is insufficient
+    assert grid_import == pytest.approx(
+        150.0, rel=1e-2
+    )  # Grid supplies the remaining shortfall after battery discharge
+    assert losses == 5.0  # Discharge losses
+    assert self_consumption == 250.0  # Generation + battery discharge
+    mock_battery.energie_abgeben.assert_called_once_with(200.0, hour)
+
+
+def test_process_energy_zero_generation(inverter, mock_battery):
+    # Zero generation, full reliance on battery and grid
+    mock_battery.energie_abgeben.return_value = (
+        100.0,
+        5.0,
+    )  # Battery discharges 100 Wh with 5 Wh loss
+    generation = 0.0
+    consumption = 300.0
+    hour = 12
+
+    grid_export, grid_import, losses, self_consumption = inverter.process_energy(
+        generation, consumption, hour
+    )
+
+    assert grid_export == 0.0  # No feed-in as there is zero generation
+    assert grid_import == pytest.approx(200.0, rel=1e-2)  # Grid supplies the remaining shortfall
+    assert losses == 5.0  # Discharge losses
+    assert self_consumption == 100.0  # Only battery discharge is consumed
+    mock_battery.energie_abgeben.assert_called_once_with(300.0, hour)
+
+
+def test_process_energy_zero_consumption(inverter, mock_battery):
+    # Generation exceeds consumption, but consumption is zero
+    mock_battery.energie_laden.return_value = (100.0, 10.0)
+    generation = 500.0
+    consumption = 0.0
+    hour = 12
+
+    grid_export, grid_import, losses, self_consumption = inverter.process_energy(
+        generation, consumption, hour
+    )
+
+    assert grid_export == pytest.approx(390.0, rel=1e-2)  # Excess energy after battery charges
+    assert grid_import == 0.0  # No grid draw as no consumption
+    assert losses == 10.0  # Charging losses
+    assert self_consumption == 0.0  # Zero consumption
+    mock_battery.energie_laden.assert_called_once_with(500.0, hour)
+
+
+def test_process_energy_zero_generation_zero_consumption(inverter, mock_battery):
+    generation = 0.0
+    consumption = 0.0
+    hour = 12
+
+    grid_export, grid_import, losses, self_consumption = inverter.process_energy(
+        generation, consumption, hour
+    )
+
+    assert grid_export == 0.0  # No feed-in
+    assert grid_import == 0.0  # No grid draw
+    assert losses == 0.0  # No losses
+    assert self_consumption == 0.0  # No consumption
+
+
+def test_process_energy_partial_battery_discharge(inverter, mock_battery):
+    mock_battery.energie_abgeben.return_value = (50.0, 5.0)
+    generation = 200.0
+    consumption = 400.0
+    hour = 12
+
+    grid_export, grid_import, losses, self_consumption = inverter.process_energy(
+        generation, consumption, hour
+    )
+
+    assert grid_export == 0.0  # No feed-in due to insufficient generation
+    assert grid_import == pytest.approx(
+        150.0, rel=1e-2
+    )  # Grid supplies the shortfall after battery assist
+    assert losses == 5.0  # Discharge losses
+    assert self_consumption == 250.0  # Generation + battery discharge
+
+
+def test_process_energy_consumption_exceeds_max_no_battery(inverter, mock_battery):
+    # Battery is empty, and consumption is much higher than the inverter's max power
+    mock_battery.energie_abgeben.return_value = (0.0, 0.0)
+    generation = 100.0
+    consumption = 1000.0  # Exceeds the inverter's max power
+    hour = 12
+
+    grid_export, grid_import, losses, self_consumption = inverter.process_energy(
+        generation, consumption, hour
+    )
+
+    assert grid_export == 0.0  # No feed-in
+    assert grid_import == pytest.approx(900.0, rel=1e-2)  # Grid covers the remaining shortfall
+    assert losses == 0.0  # No losses as the battery didn’t assist
+    assert self_consumption == 100.0  # Only the generation is consumed, maxing out the inverter
+    mock_battery.energie_abgeben.assert_called_once_with(400.0, hour)
+
+
+def test_process_energy_zero_generation_full_battery_high_consumption(inverter, mock_battery):
+    # Full battery, no generation, and high consumption
+    mock_battery.energie_abgeben.return_value = (500.0, 10.0)
+    generation = 0.0
+    consumption = 600.0
+    hour = 12
+
+    grid_export, grid_import, losses, self_consumption = inverter.process_energy(
+        generation, consumption, hour
+    )
+
+    assert grid_export == 0.0  # No feed-in due to zero generation
+    assert grid_import == pytest.approx(
+        100.0, rel=1e-2
+    )  # Grid covers remaining shortfall after battery discharge
+    assert losses == 10.0  # Battery discharge losses
+    assert self_consumption == 500.0  # Battery fully discharges to meet consumption
+    mock_battery.energie_abgeben.assert_called_once_with(500.0, hour)

tests/testdata/optimize_input_1.json

@@ -31,8 +31,8 @@
         "start_soc_prozent": 80,
         "min_soc_prozent": 15
     },
-    "wechselrichter": {
-        "max_leistung_wh": 10000
+    "inverter": {
+        "max_power_wh": 10000
     },
     "eauto": {
         "kapazitaet_wh": 60000,
@@ -55,4 +55,4 @@
       1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1
     ]
   }
-  
+