Metadata bat all

packages/control/bat_all.py

@@ -24,7 +24,6 @@
 from control import data
 from control.bat import Bat
 from helpermodules.constants import NO_ERROR
-from helpermodules.pub import Pub
 from modules.common.fault_state import FaultStateLevel
 
 log = logging.getLogger(__name__)
@@ -38,7 +37,7 @@ class BatConsiderationMode(Enum):
 
 @dataclass
 class Config:
-    configured: bool = False
+    configured: bool = field(default=False, metadata={"topic": "config/configured"})
 
 
 def config_factory() -> Config:
@@ -47,14 +46,14 @@ def config_factory() -> Config:
 
 @dataclass
 class Get:
-    soc: float = field(default=0, metadata={"topic": "get/soc", "mutable_by_algorithm": True})
-    daily_exported: float = field(default=0, metadata={"topic": "get/daily_exported", "mutable_by_algorithm": True})
-    daily_imported: float = field(default=0, metadata={"topic": "get/daily_imported", "mutable_by_algorithm": True})
-    fault_str: str = field(default=NO_ERROR, metadata={"topic": "get/fault_str", "mutable_by_algorithm": True})
-    fault_state: int = field(default=0, metadata={"topic": "get/fault_state", "mutable_by_algorithm": True})
-    imported: float = field(default=0, metadata={"topic": "get/imported", "mutable_by_algorithm": True})
-    exported: float = field(default=0, metadata={"topic": "get/exported", "mutable_by_algorithm": True})
-    power: float = field(default=0, metadata={"topic": "get/power", "mutable_by_algorithm": True})
+    soc: float = field(default=0, metadata={"topic": "get/soc"})
+    daily_exported: float = field(default=0, metadata={"topic": "get/daily_exported"})
+    daily_imported: float = field(default=0, metadata={"topic": "get/daily_imported"})
+    fault_str: str = field(default=NO_ERROR, metadata={"topic": "get/fault_str"})
+    fault_state: int = field(default=0, metadata={"topic": "get/fault_state"})
+    imported: float = field(default=0, metadata={"topic": "get/imported"})
+    exported: float = field(default=0, metadata={"topic": "get/exported"})
+    power: float = field(default=0, metadata={"topic": "get/power"})
 
 
 def get_factory() -> Get:
@@ -63,8 +62,9 @@ def get_factory() -> Get:
 
 @dataclass
 class Set:
-    charging_power_left: float = 0
-    regulate_up: bool = False
+    charging_power_left: float = field(
+        default=0, metadata={"topic": "set/charging_power_left"})
+    regulate_up: bool = field(default=False, metadata={"topic": "set/regulate_up"})
 
 
 def set_factory() -> Set:
@@ -90,7 +90,6 @@ def calc_power_for_all_components(self):
         try:
             if len(data.data.bat_data) >= 1:
                 self.data.config.configured = True
-                Pub().pub("openWB/set/bat/config/configured", self.data.config.configured)
                 # Summe für alle konfigurierten Speicher bilden
                 exported = 0
                 imported = 0
@@ -128,7 +127,6 @@ def calc_power_for_all_components(self):
                     self.data.get.soc = 0
             else:
                 self.data.config.configured = False
-                Pub().pub("openWB/set/bat/config/configured", self.data.config.configured)
         except Exception:
             log.exception("Fehler im Bat-Modul")
 
@@ -148,10 +146,6 @@ def _max_bat_power_hybrid_system(self, battery: Bat) -> float:
             else:
                 battery.data.get.fault_state = FaultStateLevel.ERROR.value
                 battery.data.get.fault_str = self.ERROR_CONFIG_MAX_AC_OUT
-                Pub().pub(f"openWB/set/bat/{battery.num}/get/fault_state",
-                          battery.data.get.fault_state)
-                Pub().pub(f"openWB/set/bat/{battery.num}/get/fault_str",
-                          battery.data.get.fault_str)
                 raise ValueError(self.ERROR_CONFIG_MAX_AC_OUT)
         else:
             # Kein Hybrid-WR
@@ -193,8 +187,6 @@ def setup_bat(self):
             else:
                 self.data.set.charging_power_left = 0
                 self.data.get.power = 0
-            Pub().pub("openWB/set/bat/set/charging_power_left", self.data.set.charging_power_left)
-            Pub().pub("openWB/set/bat/set/regulate_up", self.data.set.regulate_up)
         except Exception:
             log.exception("Fehler im Bat-Modul")
 

packages/control/prepare.py

@@ -18,6 +18,8 @@ def setup_algorithm(self) -> None:
         """ bereitet die Daten für den Algorithmus vor und startet diesen.
         """
         try:
+            data.data.pv_all_data.calc_power_for_all_components()
+            data.data.bat_all_data.calc_power_for_all_components()
             for cp in data.data.cp_data.values():
                 cp.setup_values_at_start()
             data.data.bat_all_data.setup_bat()

packages/helpermodules/changed_values_handler.py

@@ -14,9 +14,8 @@
 
 # In den Metadaten wird unter dem Key der Topic-Suffix ab "openWB/ev/2/" angegeben. Der Topic-Prefix ("openWB/ev/2/")
 # wird automatisch ermittelt.
-# Der Key mutable_by_algorithm ist True, wenn die Werte im Algorithmus geändert werden können. Nur diese Werte werden
-# automatisiert gepublished. Werte, die an anderer Stelle gepublished werden, wie zB Zählerstände, werden mit False
-# gekennzeichnet. Um eine Dokumentation der Topics zu erhalten, sollten die Metadaten dennoch ausgefüllt werden.
+# Der Kontextmanager muss immer verwendet werden, wenn in den Funktionen Werte geändert werden, die nicht gepublished
+# werden.
 # Metadaten werden nur für Felder erzeugt, die gepublished werden sollen, dh bei ganzen Klassen für das Feld der
 # jeweiligen Klasse. Wenn Werte aus einer instanziierten Klasse gepublished werden sollen, erhält die übergeordnete
 # Klasse keine Metadaten (siehe Beispiel unten).
@@ -34,8 +33,8 @@
 
 # @dataclass
 # class SampleNested:
-#     parameter1: bool = field(default=False, metadata={"topic": "get/nested1", "mutable_by_algorithm": True})
-#     parameter2: int = field(default=0, metadata={"topic": "get/nested2", "mutable_by_algorithm": True})
+#     parameter1: bool = field(default=False, metadata={"topic": "get/nested1"})
+#     parameter2: int = field(default=0, metadata={"topic": "get/nested2"})
 
 
 # def sample_nested() -> SampleNested:
@@ -48,12 +47,12 @@
 # diese Klasse eingetragen. Die Felder der Konfigurationsklasse bekommen keine Metadaten, da diese nicht einzeln
 # gepublished werden.
 #     sample_field_class: SampleClass = field(
-#         default_factory=sample_class, metadata={"topic": "get/field_class", "mutable_by_algorithm": True})
-#     sample_field_int: int = field(default=0, metadata={"topic": "get/field_int", "mutable_by_algorithm": True})
+#         default_factory=sample_class, metadata={"topic": "get/field_class"})
+#     sample_field_int: int = field(default=0, metadata={"topic": "get/field_int"})
 #     sample_field_immutable: float = field(
-#         default=0, metadata={"topic": "get/field_immutable", "mutable_by_algorithm": False})
+#         default=0, metadata={"topic": "get/field_immutable"})
 #     sample_field_list: List = field(default_factory=currents_list_factory, metadata={
-#                                     "topic": "get/field_list", "mutable_by_algorithm": True})
+#                                     "topic": "get/field_list"})
 #     # Bei verschachtelten Klassen, wo der zu publishende Wert auf einer tieferen Ebene liegt, werden nur für den zu
 # publishenden Wert Metadaten erzeugt.
 #     sample_field_nested: SampleNested = field(default_factory=sample_nested)
@@ -99,7 +98,7 @@ def _update_value(self, topic_prefix, data_inst_previous, data_inst):
                 if isinstance(previous_value, Enum):
                     previous_value = previous_value.value
                 if hasattr(f, "metadata"):
-                    if f.metadata.get("mutable_by_algorithm"):
+                    if f.metadata.get("topic"):
                         if isinstance(value, (str, int, float, Dict, List, Tuple)):
                             if previous_value != value:
                                 changed = True
@@ -123,3 +122,15 @@ def _update_value(self, topic_prefix, data_inst_previous, data_inst):
                     self._update_value(topic_prefix, previous_value, value)
             except Exception as e:
                 log.exception(e)
+
+
+class ChangedValuesContext:
+    def __init__(self, event_module_update_completed: threading.Event):
+        self.changed_values_handler = ChangedValuesHandler(event_module_update_completed)
+
+    def __enter__(self):
+        self.changed_values_handler.store_initial_values()
+
+    def __exit__(self, exception_type, exception, exception_traceback) -> bool:
+        self.changed_values_handler.pub_changed_values()
+        return False

packages/helpermodules/changed_values_handler_test.py

@@ -23,8 +23,8 @@ def sample_class() -> SampleClass:
 
 @dataclass
 class SampleNested:
-    parameter1: bool = field(default=False, metadata={"topic": "get/nested1", "mutable_by_algorithm": True})
-    parameter2: int = field(default=0, metadata={"topic": "get/nested2", "mutable_by_algorithm": True})
+    parameter1: bool = field(default=False, metadata={"topic": "get/nested1"})
+    parameter2: int = field(default=0, metadata={"topic": "get/nested2"})
 
 
 def sample_nested() -> SampleNested:
@@ -41,25 +41,25 @@ def sample_tuple_factory() -> Tuple:
 
 @dataclass
 class SampleData:
-    sample_field_bool: bool = field(default=False, metadata={"topic": "get/field_bool", "mutable_by_algorithm": True})
+    sample_field_bool: bool = field(default=False, metadata={"topic": "get/field_bool"})
     sample_field_class: SampleClass = field(
-        default_factory=sample_class, metadata={"topic": "get/field_class", "mutable_by_algorithm": True})
+        default_factory=sample_class, metadata={"topic": "get/field_class"})
     sample_field_dict: Dict = field(default_factory=sample_dict_factory, metadata={
-        "topic": "get/field_dict", "mutable_by_algorithm": True})
+        "topic": "get/field_dict"})
     sample_field_enum: ChargepointState = field(default=ChargepointState.CHARGING_ALLOWED, metadata={
-        "topic": "get/field_enum", "mutable_by_algorithm": True})
-    sample_field_float: float = field(default=0, metadata={"topic": "get/field_float", "mutable_by_algorithm": True})
-    sample_field_int: int = field(default=0, metadata={"topic": "get/field_int", "mutable_by_algorithm": True})
+        "topic": "get/field_enum"})
+    sample_field_float: float = field(default=0, metadata={"topic": "get/field_float"})
+    sample_field_int: int = field(default=0, metadata={"topic": "get/field_int"})
     sample_field_immutable: float = field(
-        default=0, metadata={"topic": "get/field_immutable", "mutable_by_algorithm": False})
+        default=0, metadata={"topic": "get/field_immutable"})
     sample_field_list: List = field(default_factory=currents_list_factory, metadata={
-                                    "topic": "get/field_list", "mutable_by_algorithm": True})
+                                    "topic": "get/field_list"})
     sample_field_nested: SampleNested = field(default_factory=sample_nested)
     sample_field_none: Optional[str] = field(
-        default="Hi", metadata={"topic": "get/field_none", "mutable_by_algorithm": True})
-    sample_field_str: str = field(default="Hi", metadata={"topic": "get/field_str", "mutable_by_algorithm": True})
+        default="Hi", metadata={"topic": "get/field_none"})
+    sample_field_str: str = field(default="Hi", metadata={"topic": "get/field_str"})
     sample_field_tuple: Tuple = field(default_factory=sample_tuple_factory, metadata={
-                                      "topic": "get/field_tuple", "mutable_by_algorithm": True})
+                                      "topic": "get/field_tuple"})
 
 
 @dataclass
@@ -83,7 +83,6 @@ class Params:
            expected_pub_call=("openWB/get/field_float", 2.5)),
     Params(name="change int", sample_data=SampleData(sample_field_int=2),
            expected_pub_call=("openWB/get/field_int", 2)),
-    Params(name="immutable", sample_data=SampleData(sample_field_immutable=2), expected_calls=0),
     Params(name="change list", sample_data=SampleData(sample_field_list=[
            10, 0, 0]), expected_pub_call=("openWB/get/field_list", [10, 0, 0])),
     Params(name="change nested", sample_data=SampleData(sample_field_nested=SampleNested(

packages/helpermodules/measurement_logging/update_yields_test.py

@@ -1,5 +1,4 @@
-import pytest
-
+from control import data
 from helpermodules.measurement_logging.update_yields import update_module_yields
 
 
@@ -8,28 +7,17 @@ def test_update_module_yields(daily_log_totals, mock_pub):
     [update_module_yields(type, daily_log_totals) for type in ("bat", "counter", "cp", "pv")]
 
     # evaluation
-    expected = {
-        "openWB/set/bat/2/get/daily_imported": 0.0,
-        "openWB/set/bat/2/get/daily_exported": 550.0,
-        "openWB/set/counter/0/get/daily_imported": 1492.0,
-        "openWB/set/counter/0/get/daily_exported": 0.0,
-        "openWB/set/chargepoint/get/daily_imported": 1920.0,
-        "openWB/set/chargepoint/get/daily_exported": 0.0,
-        "openWB/set/chargepoint/4/get/daily_imported": 384.0,
-        "openWB/set/chargepoint/4/get/daily_exported": 0.0,
-        "openWB/set/chargepoint/5/get/daily_imported": 192.0,
-        "openWB/set/chargepoint/5/get/daily_exported": 0.0,
-        "openWB/set/chargepoint/6/get/daily_imported": 0.0,
-        "openWB/set/chargepoint/6/get/daily_exported": 0.0,
-        "openWB/set/pv/get/daily_exported": 251.0,
-        "openWB/set/pv/1/get/daily_exported": 251.0}
-    for topic, value in expected.items():
-        for call in mock_pub.mock_calls:
-            try:
-                if call.args[0] == topic:
-                    assert value == call.args[1]
-                    break
-            except IndexError:
-                pass
-        else:
-            pytest.fail(f"Topic {topic} is missing")
+    data.data.bat_data["bat2"].data.get.daily_imported = 0.0
+    data.data.bat_data["bat2"].data.get.daily_exported = 550.0
+    data.data.counter_data["counter0"].data.get.daily_imported = 1492.0
+    data.data.counter_data["counter0"].data.get.daily_exported = 0.0
+    data.data.cp_all_data.data.get.daily_imported = 1920.0
+    data.data.cp_all_data.data.get.daily_exported = 0.0
+    data.data.cp_data["cp4"].data.get.daily_imported = 384.0
+    data.data.cp_data["cp4"].data.get.daily_exported = 0.0
+    data.data.cp_data["cp5"].data.get.daily_imported = 192.0
+    data.data.cp_data["cp5"].data.get.daily_exported = 0.0
+    data.data.cp_data["cp6"].data.get.daily_imported = 0.0
+    data.data.cp_data["cp6"].data.get.daily_exported = 0.0
+    data.data.pv_all_data.data.get.daily_exported = 251.0
+    data.data.pv_data["pv1"].data.get.daily_exported = 251.0

packages/helpermodules/update_config.py

@@ -403,6 +403,7 @@ class UpdateConfig:
         "^openWB/system/version$",
     ]
     default_topic = (
+        ("openWB/bat/config/configured", False),
         ("openWB/bat/get/fault_state", 0),
         ("openWB/bat/get/fault_str", NO_ERROR),
         ("openWB/chargepoint/get/power", 0),