metadata for optional (#2976)

Author: LKuemmel

packages/control/ocpp.py

@@ -27,8 +27,9 @@ def _process_call(self: OptionalProtocol,
                           fault_state: FaultState,
                           func: Callable) -> Optional[websockets.WebSocketClientProtocol]:
             async def make_call() -> websockets.WebSocketClientProtocol:
-                async with websockets.connect(self.data.ocpp.url+chargebox_id,
-                                              subprotocols=[self.data.ocpp.version]) as ws:
+                url = self.data.ocpp.config.url
+                async with websockets.connect(f"{url}{'' if url.endswith('/') else '/'}{chargebox_id}",
+                                              subprotocols=[self.data.ocpp.config.version]) as ws:
                     try:
                         cp = OcppChargepoint(chargebox_id, ws, 2)
                         await cp.call(func)
@@ -37,7 +38,7 @@ async def make_call() -> websockets.WebSocketClientProtocol:
                         pass
                     return ws
             try:
-                if self.data.ocpp.active and chargebox_id:
+                if self.data.ocpp.config.active and chargebox_id:
                     return asyncio.run(make_call())
             except websockets.exceptions.InvalidStatusCode:
                 fault_state.warning(f"Chargebox ID {chargebox_id} konnte nicht im OCPP-Backend gefunden werden oder "

packages/control/ocpp_test.py

@@ -13,8 +13,8 @@
 @pytest.fixture()
 def mock_data() -> None:
     data.data_init(Mock())
-    data.data.optional_data.data.ocpp.active = True
-    data.data.optional_data.data.ocpp.url = "ws://localhost:9000/"
+    data.data.optional_data.data.ocpp.config.active = True
+    data.data.optional_data.data.ocpp.config.url = "ws://localhost:9000/"
 
 
 def test_start_transaction(mock_data, monkeypatch):

packages/control/optional.py

@@ -157,13 +157,10 @@ def remove(price_data: Dict) -> Dict:
                 if len(self.data.electricity_pricing.get.prices) >= 0:
                     ep = self.data.electricity_pricing
                     ep.get.prices = remove(ep.get.prices)
-                    Pub().pub("openWB/set/optional/ep/get/prices", ep.get.prices)
                 if self._flexible_tariff_module:
                     ep.flexible_tariff.get.prices = remove(ep.flexible_tariff.get.prices)
-                    Pub().pub("openWB/set/optional/ep/flexible_tariff/get/prices", ep.flexible_tariff.get.prices)
                 if self._grid_fee_module:
                     ep.grid_fee.get.prices = remove(ep.grid_fee.get.prices)
-                    Pub().pub("openWB/set/optional/ep/grid_fee/get/prices", ep.grid_fee.get.prices)
         except Exception:
             log.exception("Fehler beim Entfernen veralteter Preise")
 
@@ -255,7 +252,7 @@ def et_price_update_required(self) -> bool:
 
     def ocpp_transfer_meter_values(self):
         try:
-            if self.data.ocpp.active:
+            if self.data.ocpp.config.active:
                 thread_handler(Thread(target=self._transfer_meter_values, args=(), name="OCPP Client"))
         except Exception as e:
             log.exception("Fehler im OCPP-Optional-Modul: %s", e)
@@ -264,13 +261,12 @@ def _transfer_meter_values(self):
         for cp in data.data.cp_data.values():
             try:
                 if self.data.ocpp.boot_notification_sent is False:
+                    self.data.ocpp.boot_notification_sent = True
                     # Boot-Notification nicht in der init-Funktion aufrufen, da noch nicht alles initialisiert ist
                     self.boot_notification(cp.data.config.ocpp_chargebox_id,
                                            cp.chargepoint_module.fault_state,
                                            cp.chargepoint_module.config.type,
                                            cp.data.get.serial_number)
-                    self.data.ocpp.boot_notification_sent = True
-                    Pub().pub("openWB/set/optional/ocpp/boot_notification_sent", True)
                 if cp.data.set.ocpp_transaction_id is not None:
                     self.send_heart_beat(cp.data.config.ocpp_chargebox_id, cp.chargepoint_module.fault_state)
                     self.transfer_values(cp.data.config.ocpp_chargebox_id,

packages/control/optional_data.py

@@ -14,18 +14,31 @@
 
 @dataclass
 class PricingGet:
-    fault_state: int = 0
-    fault_str: str = NO_ERROR
+    fault_state: int = field(default=0)
+    fault_str: str = field(default=NO_ERROR)
     prices: Dict = field(default_factory=empty_dict_factory)
 
 
-def get_factory() -> PricingGet:
-    return PricingGet()
+def create_pricing_get_with_topics(topic_prefix: str) -> PricingGet:
+    """Factory function to create PricingGet with custom topic prefix"""
+    pricing_get = PricingGet()
+    pricing_get.__dataclass_fields__['fault_state'].metadata = {"topic": f"{topic_prefix}/get/fault_state"}
+    pricing_get.__dataclass_fields__['fault_str'].metadata = {"topic": f"{topic_prefix}/get/fault_str"}
+    pricing_get.__dataclass_fields__['prices'].metadata = {"topic": f"{topic_prefix}/get/prices"}
+    return pricing_get
+
+
+def flexible_tariff_get_factory() -> PricingGet:
+    return create_pricing_get_with_topics("ep/flexible_tariff")
+
+
+def grid_fee_get_factory() -> PricingGet:
+    return create_pricing_get_with_topics("ep/grid_fee")
 
 
 @dataclass
 class FlexibleTariff:
-    get: PricingGet = field(default_factory=get_factory)
+    get: PricingGet = field(default_factory=flexible_tariff_get_factory)
 
 
 def get_flexible_tariff_factory() -> FlexibleTariff:
@@ -34,7 +47,7 @@ def get_flexible_tariff_factory() -> FlexibleTariff:
 
 @dataclass
 class GridFee:
-    get: PricingGet = field(default_factory=get_factory)
+    get: PricingGet = field(default_factory=grid_fee_get_factory)
 
 
 def get_grid_fee_factory() -> GridFee:
@@ -43,8 +56,8 @@ def get_grid_fee_factory() -> GridFee:
 
 @dataclass
 class ElectricityPricingGet:
-    next_query_time: Optional[float] = None
-    _prices: Dict = field(default_factory=empty_dict_factory)
+    next_query_time: Optional[float] = field(default=None, metadata={"topic": "ep/next_query_time"})
+    _prices: Dict = field(default_factory=empty_dict_factory, metadata={"topic": "ep/prices"})
 
     @property
     def prices(self) -> Dict:
@@ -78,7 +91,7 @@ def electricity_pricing_get_factory() -> ElectricityPricingGet:
 
 @dataclass
 class ElectricityPricing:
-    configured: bool = False
+    configured: bool = field(default=False, metadata={"topic": "ep/configured"})
     flexible_tariff: FlexibleTariff = field(default_factory=get_flexible_tariff_factory)
     grid_fee: GridFee = field(default_factory=get_grid_fee_factory)
     get: ElectricityPricingGet = field(default_factory=electricity_pricing_get_factory)
@@ -88,55 +101,52 @@ def ep_factory() -> ElectricityPricing:
     return ElectricityPricing()
 
 
+def cards_display_theme_factory() -> CardsDisplayTheme:
+    return CardsDisplayTheme()
+
+
 @dataclass
 class InternalDisplay:
-    active: bool = False
-    on_if_plugged_in: bool = True
-    pin_active: bool = False
-    pin_code: str = "0000"
-    standby: int = 60
-    theme: CardsDisplayTheme = CardsDisplayTheme()
+    active: bool = field(default=False, metadata={"topic": "int_display/active"})
+    detected: bool = field(default=False, metadata={"topic": "int_display/detected"})
+    on_if_plugged_in: bool = field(default=True, metadata={"topic": "int_display/on_if_plugged_in"})
+    only_local_charge_points: bool = field(default=False, metadata={"topic": "int_display/only_local_charge_points"})
+    pin_active: bool = field(default=False, metadata={"topic": "int_display/pin_active"})
+    pin_code: str = field(default="0000", metadata={"topic": "int_display/pin_code"})
+    rotation: int = field(default=0, metadata={"topic": "int_display/rotation"})
+    standby: int = field(default=60, metadata={"topic": "int_display/standby"})
+    theme: CardsDisplayTheme = field(default_factory=cards_display_theme_factory,
+                                     metadata={"topic": "int_display/theme"})
 
 
 def int_display_factory() -> InternalDisplay:
     return InternalDisplay()
 
 
-@dataclass
-class Led:
-    active: bool = False
-
-
-def led_factory() -> Led:
-    return Led()
-
-
 @dataclass
 class Rfid:
-    active: bool = False
+    active: bool = field(default=False, metadata={"topic": "rfid/active"})
 
 
 def rfid_factory() -> Rfid:
     return Rfid()
 
 
 @dataclass
-class Ocpp:
+class OcppConfig:
     active: bool = False
-    boot_notification_sent: bool = False
-    _url: Optional[str] = None
+    url: Optional[str] = None
     version: str = "ocpp1.6"
 
-    @property
-    def url(self) -> Optional[str]:
-        return self._url
 
-    @url.setter
-    def url(self, value: Optional[str]):
-        if value is not None and not value.endswith("/"):
-            self._url = value + "/"
-        else:
-            self._url = value
+def ocpp_config_factory() -> OcppConfig:
+    return OcppConfig()
+
+
+@dataclass
+class Ocpp:
+    config: OcppConfig = field(default_factory=ocpp_config_factory, metadata={"topic": "ocpp/config"})
+    boot_notification_sent: bool = field(default=False, metadata={"topic": "ocpp/boot_notification_sent"})
 
 
 def ocpp_factory() -> Ocpp:
@@ -147,9 +157,8 @@ def ocpp_factory() -> Ocpp:
 class OptionalData:
     electricity_pricing: ElectricityPricing = field(default_factory=ep_factory)
     int_display: InternalDisplay = field(default_factory=int_display_factory)
-    led: Led = field(default_factory=led_factory)
     rfid: Rfid = field(default_factory=rfid_factory)
-    dc_charging: bool = False
+    dc_charging: bool = field(default=False, metadata={"topic": "dc_charging"})
     ocpp: Ocpp = field(default_factory=ocpp_factory)
 
 

packages/helpermodules/changed_values_handler.py

@@ -83,6 +83,8 @@ def pub_changed_values(self):
                                data.data.cp_all_data.data.get)
             self._update_value("openWB/set/counter/", self.prev_data.counter_all_data.data,
                                data.data.counter_all_data.data)
+            self._update_value("openWB/set/optional/", self.prev_data.optional_data.data,
+                               data.data.optional_data.data)
             for key, value in data.data.cp_data.items():
                 self._update_value(f"openWB/set/chargepoint/{value.num}/", self.prev_data.cp_data[key].data, value.data)
             for key, value in data.data.bat_data.items():

packages/helpermodules/subdata.py

@@ -700,6 +700,8 @@ def process_optional_topic(self, var: optional.Optional, msg: mqtt.MQTTMessage):
                     self.set_json_payload_class(var.data.led, msg)
                 elif re.search("/optional/rfid/", msg.topic) is not None:
                     self.set_json_payload_class(var.data.rfid, msg)
+                elif re.search("/optional/ocpp/config", msg.topic) is not None:
+                    self.set_json_payload_class(var.data.ocpp.config, msg)
                 elif re.search("/optional/ocpp/", msg.topic) is not None:
                     self.set_json_payload_class(var.data.ocpp, msg)
                 elif re.search("/optional/int_display/", msg.topic) is not None:

packages/helpermodules/update_config.py

@@ -41,7 +41,7 @@
 from control.ev import ev
 from control.ev.ev_template import EvTemplateData
 from control.general import Prices, PvCharging
-from control.optional_data import Ocpp
+from control.optional_data import OcppConfig
 from modules.common.abstract_vehicle import GeneralVehicleConfig
 from modules.common.component_type import ComponentType
 from modules.devices.sungrow.sungrow.version import Version
@@ -325,7 +325,6 @@ class UpdateConfig:
         "^openWB/optional/int_display/rotation$",
         "^openWB/optional/int_display/theme$",
         "^openWB/optional/int_display/only_local_charge_points",
-        "^openWB/optional/led/active$",
         "^openWB/optional/monitoring/config$",
         "^openWB/optional/rfid/active$",
         "^openWB/optional/ocpp/config$",
@@ -584,9 +583,8 @@ class UpdateConfig:
         ("openWB/optional/int_display/rotation", 0),
         ("openWB/optional/int_display/theme", dataclass_utils.asdict(CardsDisplayTheme())),
         ("openWB/optional/int_display/only_local_charge_points", False),
-        ("openWB/optional/led/active", False),
         ("openWB/optional/monitoring/config", NO_MODULE),
-        ("openWB/optional/ocpp/config", dataclass_utils.asdict(Ocpp())),
+        ("openWB/optional/ocpp/config", dataclass_utils.asdict(OcppConfig())),
         ("openWB/optional/rfid/active", False),
         ("openWB/system/backup_password", None),
         ("openWB/system/backup_cloud/config", NO_MODULE),