tries improving

Author: WolfgangFahl

ngwidgets/mbus_viewer.py

@@ -3,21 +3,80 @@
 
 @author: wf
 """
+import os
 import re
 import json
 import meterbus
+from dataclasses import field
 from nicegui import ui
+from ngwidgets.widgets import Link
+from ngwidgets.yamlable import lod_storable
+from typing import Dict
+
+@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
+
+@lod_storable
+class Device:
+    """
+    A device class for M-Bus devices
+    """
+    manufacturer: Manufacturer
+    model: str
+    title: str = ""  # Optional full product title
+    doc_url: str = ""  # Documentation URL
+
+    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
+
+@lod_storable
+class MBusExample:
+    device: Device
+    name: str
+    title: str
+    hex: str
+
+    def as_html(self) -> str:
+        return self.device.as_html()
+
+@lod_storable
+class MBusExamples:
+    """
+    Manages M-Bus devices and their examples
+    """
+    examples: Dict[str, MBusExample] = field(default_factory=dict)
+
+    @classmethod
+    def get(cls, yaml_path:str=None) -> Dict[str, MBusExample]:
+        if yaml_path is None:
+            yaml_path=cls.examples_path()+"/mbus_examples.yaml"
+        mbus_examples=cls.load_from_yaml_file(yaml_path)
+        return mbus_examples
+
+    @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 = {
-            "Basic Reading": "684d4d680800722654832277040904360000000c78265483220406493500000c14490508000b2d0000000b3b0000000a5a18060a5e89020b61883200046d0d0c2c310227c80309fd0e2209fd0f470f00008d16",
-            "CF Echo II": "68 03 03 68  73 fe a6 17  16"
-        }
+        self.examples = MBusExamples.get().examples
 
     def fromhex(self, x, base=16):
         """Convert hex string to integer"""
@@ -41,12 +100,12 @@ def get_frame_json(self, frame):
         }
         return json.dumps(data)
 
-    def parse_mbus_data(self, hex_data):
+    def parse_mbus_frame(self, hex_data):
         """
-        Parse M-Bus hex data and return JSON result
-        Returns tuple of (error_msg, json_str)
+        Parse M-Bus hex data and return mbus frame
+        Returns tuple of (error_msg, mbus_frame)
         """
-        json_str = None
+        frame = None
         error_msg = None
         try:
             # Allow flexible whitespace in input
@@ -55,10 +114,9 @@ def parse_mbus_data(self, hex_data):
             data = list(map(self.fromhex, re.findall("..", filtered_data)))
             # Parse using meterbus
             frame = meterbus.load(data)
-            json_str = self.get_frame_json(frame)
         except Exception as e:
             error_msg = f"Error parsing M-Bus data: {str(e)}"
-        return error_msg, json_str
+        return error_msg, frame
 
 class MBusViewer(MBusParser):
     """
@@ -70,7 +128,7 @@ def __init__(self, solution=None):
         self.hex_input = None
         self.json_code = None
         self.example_select = None
-        self.error_label = None
+        self.error_html = None
 
     def createTextArea(self, label, placeholder=None, classes: str = "h-64"):
         """Create a standardized textarea with common styling"""
@@ -85,34 +143,47 @@ def createTextArea(self, label, placeholder=None, classes: str = "h-64"):
     def on_parse(self):
         """Handle parse button click"""
         try:
-            error_msg, json_str = self.parse_mbus_data(self.hex_input.value)
-            if error_msg:
-                self.error_label.text = error_msg
-                self.error_label.classes("text-red-500")
-            else:
-                self.json_code.content=json_str
+            with self.result_row:
+                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
         except Exception as ex:
             self.solution.handle_exception(ex)
 
     def on_example_change(self):
         """Handle example selection change"""
+
         selected = self.example_select.value
         if selected in self.examples:
-            self.hex_input.value = self.examples[selected]
+            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.on_parse()
 
     def setup_ui(self):
         """Create the NiceGUI user interface"""
         ui.label("M-Bus Message Parser").classes("text-h4 q-mb-md")
 
-        self.error_label = ui.label().classes("text-red-500 hidden")
-
         self.example_select = ui.select(
             label="Select Example",
             options=list(self.examples.keys()),
             on_change=self.on_example_change,
         ).classes("w-full q-mb-md")
 
+        self.example_details = ui.html().classes("w-full mb-4")
+
         self.hex_input = self.createTextArea(
             label="Enter M-Bus hex message",
             placeholder="e.g. 68 4d 4d 68 08 00 72 26 54 83 22 77...",
@@ -121,5 +192,6 @@ def setup_ui(self):
 
         with ui.row() as self.button_row:
             ui.button("Parse Message", on_click=self.on_parse).classes("q-mt-md")
-
-        self.json_code = ui.code(language='json').classes("w-full h-96 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")

ngwidgets/mbus_viewer_cmd.py

@@ -3,17 +3,28 @@
 
 @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
 
 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
 
 
 def main(argv: list = None):

ngwidgets/mbus_viewer_server.py

@@ -3,11 +3,13 @@
 
 @author: wf
 """
+import os
 from nicegui import Client
 import ngwidgets
 from ngwidgets.input_webserver import InputWebserver, WebserverConfig, InputWebSolution
 from ngwidgets.yamlable import lod_storable
-from ngwidgets.mbus_viewer import MBusViewer
+from ngwidgets.mbus_viewer import MBusViewer, MBusExamples
+
 
 @lod_storable
 class Version:
@@ -65,6 +67,20 @@ def __init__(self):
         InputWebserver.__init__(self, config=NiceMBusWebserver.get_config())
         pass
 
+    def configure_run(self):
+        root_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 = [
+            "https://raw.githubusercontent.com/WolfgangFahl/nicescad/main/examples/",
+            "https://raw.githubusercontent.com/openscad/openscad/master/examples/",
+            self.root_path,
+        ]
+
+
 class NiceMBus(InputWebSolution):
     """
 

ngwidgets_examples/mbus_examples.yaml

@@ -0,0 +1,39 @@
+# Example definitions for mbus viewer tool
+# WF 2025-01-22
+
+manufacturers:
+  allmess:
+    name: Allmess
+    url: https://www.allmess.de
+    country: Germany
+
+devices:
+  cf_echo_ii:
+    manufacturer: allmess
+    model: CF Echo II
+    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
+    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
+    name: Basic Reading
+    title: Standard M-Bus reading
+    hex: 684d4d680800722654832277040904360000000c78265483220406493500000c14490508000b2d0000000b3b0000000a5a18060a5e89020b61883200046d0d0c2c310227c80309fd0e2209fd0f470f00008d16
+
+  cf_echo_ii_init:
+    device: cf_echo_ii
+    name: CF Echo II init write
+    title: CF Echo II init
+    hex: 6803036873fea61716
+
+  ultramaxx_init:
+    device: ultramaxx
+    name: CFUM init
+    title: CFUM init
+    hex: 6803036853fea6f716

tests/test_mbusparser.py

@@ -5,7 +5,7 @@
 """
 import json
 from ngwidgets.basetest import Basetest
-from ngwidgets.mbus_viewer import MBusParser
+from ngwidgets.mbus_viewer import MBusParser,MBusExample
 
 class TestMBusParser(Basetest):
     """
@@ -20,16 +20,23 @@ def test_mbus_parser(self):
         Test examples from MBusParser class
         """
         mbus_parser = MBusParser()
-        for name, hex_data in mbus_parser.examples.items():
-            error_msg,json_str = mbus_parser.parse_mbus_data(hex_data)
+        for name, example in MBusExample.get().items():
+            if not example.hex:
+                if self.debug:
+                    print(f"{example.name}: ⚪ no hex data")
+                continue
+
+            error_msg, frame = mbus_parser.parse_mbus_frame(example.hex)
             if self.debug:
-                marker="✗" if error_msg else "✓"
-                print(f"{name}{marker}")
+                marker = "✗" if error_msg else "✓"
+                print(f"{example.name} {marker}")
                 if error_msg:
-                    print(error_msg)
+                    print(f"  {error_msg}")
                 else:
-                    json_data=json.loads(json_str)
-                    print(json.dumps(json_data,indent=2))
+                    json_str = mbus_parser.get_frame_json(frame)
+                    json_data = json.loads(json_str)
+                    print(json.dumps(json_data, indent=2))
 
-            self.assertIsNone(error_msg, f"Failed to parse {name}")
-            self.assertIsInstance(json_data, dict)
+            if example.hex:  # only assert for examples with hex data
+                self.assertIsNone(error_msg, f"Failed to parse {example.name}")
+                self.assertIsInstance(json_data, dict)