improves

Author: WolfgangFahl

ngwidgets/mbus_viewer.py

@@ -3,77 +3,136 @@
 
 @author: wf
 """
+
+import json
 import os
 import re
-import json
-import meterbus
 from dataclasses import field
+from typing import Dict
+
+import meterbus
 from nicegui import ui
+
 from ngwidgets.widgets import Link
 from ngwidgets.yamlable import lod_storable
-from typing import Dict
+from reportlab.lib.textsplit import dumbSplit
+
 
 @lod_storable
 class Manufacturer:
     """
     A manufacturer of M-Bus devices
     """
+
     name: str
     url: str
     country: str = "Germany"  # Most M-Bus manufacturers are German
 
     def as_html(self) -> str:
-        return Link.create(url=self.url, text=self.name, target="_blank") if self.url else self.name
+        return (
+            Link.create(url=self.url, text=self.name, target="_blank")
+            if self.url
+            else self.name
+        )
+
 
 @lod_storable
 class Device:
     """
-    A device class for M-Bus devices
+    A device class for M-Bus devices storing manufacturer reference
     """
-    manufacturer: Manufacturer
+    mid: str  # manufacturer id reference
     model: str
     title: str = ""  # Optional full product title
     doc_url: str = ""  # Documentation URL
+    # manufacturer: Manufacturer - set on relink
 
     def as_html(self) -> str:
         title = self.title if self.title else self.model
-        return Link.create(url=self.doc_url, text=title, target="_blank") if self.doc_url else title
-
+        device_link = Link.create(url=self.doc_url, text=title, target="_blank") if self.doc_url else title
+        mfr_html = self.manufacturer.as_html() if hasattr(self, 'manufacturer') else self.mid
+        return f"{mfr_html} → {device_link}"
+    
 @lod_storable
 class MBusExample:
-    device: Device
+    """
+    An M-Bus example storing device reference
+    """
+    did: str  # device id reference
     name: str
     title: str
     hex: str
+    # device: Device - set on relink
 
     def as_html(self) -> str:
-        return self.device.as_html()
+        device_html = self.device.as_html() if hasattr(self, 'device') else self.did
+        example_text = f"{self.name}: {self.title}" if self.title else self.name
+        return f"{device_html} → {example_text}"
+    
+
 
 @lod_storable
 class MBusExamples:
     """
-    Manages M-Bus devices and their examples
+    Manages M-Bus devices and their examples with separate dictionaries for
+    manufacturers, devices and examples
     """
+    manufacturers: Dict[str, Manufacturer] = field(default_factory=dict)
+    devices: Dict[str, Device] = field(default_factory=dict)
     examples: Dict[str, MBusExample] = field(default_factory=dict)
 
     @classmethod
-    def get(cls, yaml_path:str=None) -> Dict[str, MBusExample]:
+    def get(cls, yaml_path: str = None) -> 'MBusExamples':
+        """
+        Load and dereference M-Bus examples from YAML
+        
+        Args:
+            yaml_path: Path to YAML file (defaults to examples_path/mbus_examples.yaml)
+            
+        Returns:
+            MBusExamples instance with dereferenced objects
+        """
         if yaml_path is None:
-            yaml_path=cls.examples_path()+"/mbus_examples.yaml"
-        mbus_examples=cls.load_from_yaml_file(yaml_path)
+            yaml_path = cls.examples_path() + "/mbus_examples.yaml"
+            
+        # Load raw YAML data
+        mbus_examples = cls.load_from_yaml_file(yaml_path)
+        mbus_examples.relink()
         return mbus_examples
+        
+    def relink(self):
+        """
+        Reestablish object references between manufacturers, devices and examples
+        """
+        # Dereference manufacturers in devices
+        for device_id, device in self.devices.items():
+            if device.mid in self.manufacturers:
+                device.manufacturer = self.manufacturers[device.mid]
+            else:
+                raise KeyError(f"Manufacturer '{device.mid}' not found for device '{device_id}'")
+                
+        # Dereference devices in examples
+        for example_id, example in self.examples.items():
+            if example.did in self.devices:
+                example.device = self.devices[example.did]
+            else:
+                raise KeyError(f"Device '{example.did}' not found for example '{example_id}'")
+
 
     @classmethod
     def examples_path(cls) -> str:
         # the root directory (default: examples)
         path = os.path.join(os.path.dirname(__file__), "../ngwidgets_examples")
         path = os.path.abspath(path)
         return path
+    
+
 
 class MBusParser:
     """
     parse MBus data
     """
+
     def __init__(self):
         # Define example messages
         self.examples = MBusExamples.get().examples
@@ -84,19 +143,17 @@ def fromhex(self, x, base=16):
 
     def get_frame_json(self, frame):
         """Fallback JSON generation if to_JSON not available"""
-        if hasattr(frame, 'to_JSON'):
+        if hasattr(frame, "to_JSON"):
             return frame.to_JSON()
         # Fallback to basic frame info
         data = {
             "header": {
                 "start": frame.header.startField.parts[0],
                 "length": len(frame.body.bodyHeader.ci_field.parts) + 2,
                 "control": frame.header.cField.parts[0],
-                "address": frame.header.aField.parts[0]
+                "address": frame.header.aField.parts[0],
             },
-            "body": {
-                "ci_field": frame.body.bodyHeader.ci_field.parts[0]
-            }
+            "body": {"ci_field": frame.body.bodyHeader.ci_field.parts[0]},
         }
         return json.dumps(data)
 
@@ -118,10 +175,12 @@ def parse_mbus_frame(self, hex_data):
             error_msg = f"Error parsing M-Bus data: {str(e)}"
         return error_msg, frame
 
+
 class MBusViewer(MBusParser):
     """
     Meterbus message viewer with JSON editor support
     """
+
     def __init__(self, solution=None):
         super().__init__()
         self.solution = solution
@@ -144,15 +203,15 @@ def on_parse(self):
         """Handle parse button click"""
         try:
             with self.result_row:
-                self.json_code.content=""
-                self.error_view.content=""
-                mbus_hex_str=self.hex_input.value
+                self.json_code.content = ""
+                self.error_view.content = ""
+                mbus_hex_str = self.hex_input.value
                 error_msg, frame = self.parse_mbus_frame(mbus_hex_str)
                 if error_msg:
                     self.error_view.content = f"{error_msg}"
                 else:
-                    json_str=self.get_frame_json(frame)
-                    self.json_code.content=json_str
+                    json_str = self.get_frame_json(frame)
+                    self.json_code.content = json_str
         except Exception as ex:
             self.solution.handle_exception(ex)
 
@@ -163,13 +222,7 @@ def on_example_change(self):
         if selected in self.examples:
             example = self.examples[selected]
             self.hex_input.value = example.hex
-            markup = Link.create(
-                url=example.url,
-                text=example.device,
-                tooltip=example.title,
-                target="_blank") if example.url else example.device
-            self.example_details.content = markup
-            self.example_details.content=markup
+            self.example_details.content = example.as_html()
             self.on_parse()
 
     def setup_ui(self):
@@ -194,4 +247,4 @@ def setup_ui(self):
             ui.button("Parse Message", on_click=self.on_parse).classes("q-mt-md")
         with ui.row() as self.result_row:
             self.error_view = ui.html()
-            self.json_code = ui.code(language='json').classes("w-full h-96 q-mt-md")
+            self.json_code = ui.code(language="json").classes("w-full h-96 q-mt-md")

ngwidgets/mbus_viewer_cmd.py

@@ -3,28 +3,32 @@
 
 @author: wf
 """
+
 import sys
 from argparse import ArgumentParser
+
 from ngwidgets.cmd import WebserverCmd
-from ngwidgets.mbus_viewer_server import NiceMBusWebserver
 from ngwidgets.mbus_viewer import MBusExamples
+from ngwidgets.mbus_viewer_server import NiceMBusWebserver
+
 
 class NiceMBusCmd(WebserverCmd):
     """
     command line handling for ngwidgets
     """
+
     def getArgParser(self, description: str, version_msg) -> ArgumentParser:
-            """
-            override the default argparser call
-            """
-            parser = super().getArgParser(description, version_msg)
-            parser.add_argument(
-                "-rp",
-                "--root_path",
-                default=MBusExamples.examples_path(),
-                help="path to mbux hex files [default: %(default)s]",
-            )
-            return parser
+        """
+        override the default argparser call
+        """
+        parser = super().getArgParser(description, version_msg)
+        parser.add_argument(
+            "-rp",
+            "--root_path",
+            default=MBusExamples.examples_path(),
+            help="path to mbux hex files [default: %(default)s]",
+        )
+        return parser
 
 
 def main(argv: list = None):
@@ -43,4 +47,4 @@ def main(argv: list = None):
 if __name__ == "__main__":
     if DEBUG:
         sys.argv.append("-d")
-    sys.exit(main())
+    sys.exit(main())

ngwidgets/mbus_viewer_server.py

@@ -3,19 +3,23 @@
 
 @author: wf
 """
+
 import os
+
 from nicegui import Client
+
 import ngwidgets
-from ngwidgets.input_webserver import InputWebserver, WebserverConfig, InputWebSolution
+from ngwidgets.input_webserver import InputWebserver, InputWebSolution, WebserverConfig
+from ngwidgets.mbus_viewer import MBusExamples, MBusViewer
 from ngwidgets.yamlable import lod_storable
-from ngwidgets.mbus_viewer import MBusViewer, MBusExamples
 
 
 @lod_storable
 class Version:
     """
     Version handling for nicegui widgets
     """
+
     name = "mbus-viewer"
     version = ngwidgets.__version__
     date = "2025-01-22"
@@ -41,6 +45,7 @@ class Version:
 
   Created by {authors} on {date} last updated {updated}"""
 
+
 class NiceMBusWebserver(InputWebserver):
     """
     webserver to demonstrate ngwidgets capabilities
@@ -69,9 +74,7 @@ def __init__(self):
 
     def configure_run(self):
         root_path = (
-            self.args.root_path
-            if self.args.root_path
-            else MBusExamples.examples_path()
+            self.args.root_path if self.args.root_path else MBusExamples.examples_path()
         )
         self.root_path = os.path.abspath(root_path)
         self.allowed_urls = [
@@ -82,9 +85,7 @@ def configure_run(self):
 
 
 class NiceMBus(InputWebSolution):
-    """
-
-    """
+    """ """
 
     def __init__(self, webserver: "NiceMBusWebserver", client: Client):
         super().__init__(webserver, client)
@@ -95,9 +96,7 @@ async def home(self):
         """
 
         def setup_home():
-            viewer=MBusViewer(solution=self)
+            viewer = MBusViewer(solution=self)
             viewer.setup_ui()
 
-
         await self.setup_content_div(setup_home)
-

ngwidgets_examples/mbus_examples.yaml

@@ -6,34 +6,30 @@ manufacturers:
     name: Allmess
     url: https://www.allmess.de
     country: Germany
-
 devices:
   cf_echo_ii:
-    manufacturer: allmess
+    mid: allmess
     model: CF Echo II
+    title: ''
     doc_url: https://www.allmess.de/fileadmin/multimedia/alle_Dateien/MA/MA_BA_12088-AC%20CF%20Echo%20II%20D%20TS1021_KL.pdf
-
   ultramaxx:
-    manufacturer: allmess
+    mid: allmess
     model: UltraMaXX
     title: Integral-MK UltraMaXX
     doc_url: https://www.allmess.de/fileadmin/multimedia/alle_Dateien/DB/DB_P0012%20UltraMaXX_TS0219.pdf
-
 examples:
-  cf_echo_ii_basic:
-    device: cf_echo_ii
+  cf_echo_basic:
+    did: cf_echo_ii
     name: Basic Reading
     title: Standard M-Bus reading
     hex: 684d4d680800722654832277040904360000000c78265483220406493500000c14490508000b2d0000000b3b0000000a5a18060a5e89020b61883200046d0d0c2c310227c80309fd0e2209fd0f470f00008d16
-
-  cf_echo_ii_init:
-    device: cf_echo_ii
+  cf_echo_init:
+    did: cf_echo_ii
     name: CF Echo II init write
     title: CF Echo II init
     hex: 6803036873fea61716
-
   ultramaxx_init:
-    device: ultramaxx
+    did: ultramaxx
     name: CFUM init
     title: CFUM init
-    hex: 6803036853fea6f716
+    hex: 6803036853fea6f716