conson-xp 1.21.0__py3-none-any.whl → 1.22.0__py3-none-any.whl

{conson_xp-1.21.0.dist-info → conson_xp-1.22.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: conson-xp
-Version: 1.21.0
+Version: 1.22.0
 Summary: XP Protocol Communication Tools
 Author-Email: ldvchosal <ldvchosal@github.com>
 License: MIT License
@@ -60,7 +60,7 @@ Description-Content-Type: text/markdown
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
 
-> **A powerful Python CLI and API toolkit for CONSON XP Protocol operations**
+> **A powerful Python CLI toolkit for CONSON XP Protocol operations**
 
 Control and communicate with XP devices through console bus (Conbus), parse telegrams in real-time, and integrate with smart home systems like Apple HomeKit.
 
@@ -81,7 +81,7 @@ Bridge XP devices to Apple HomeKit for seamless smart home control
 Automatically discover XP servers and scan connected modules on your network
 
 ⚡ **Modern Architecture**
-FastAPI REST endpoints and comprehensive type safety
+Comprehensive type safety and robust error handling
 
 ---
 
@@ -96,9 +96,6 @@ xp telegram parse "<E14L00I02MAK>"
 
 # Discover XP servers on your network
 xp conbus discover
-
-# Start the REST API server
-xp api start
 ```
 
 ## 📦 Installation
@@ -167,7 +164,32 @@ xp module search "push button"
 xp module list --group-by-category
 ```
 
+### 🖥️ Terminal UI (TUI)
+
+**Real-time Protocol Monitor**
+
+Launch an interactive terminal interface for live protocol monitoring and control:
 
+```bash
+# Start the protocol monitor TUI
+xp term protocol
+```
+
+**Features:**
+- 📊 **Live Telegram Stream**: Real-time RX/TX telegram monitoring from Conbus server
+- ⌨️ **Keyboard Shortcuts**: Quick access controls for common operations
+  - `Q` - Quit application
+  - `C` - Toggle connection (connect/disconnect)
+  - `R` - Reset and clear log
+  - `0-9, a-q` - Send predefined protocol telegrams
+- 🎨 **Visual Status Indicators**: Color-coded connection states
+  - 🟢 Green - Connected
+  - 🟡 Yellow - Connecting/Disconnecting
+  - 🔴 Red - Failed
+  - ⚪ White - Disconnected
+- 📝 **Interactive Display**: Scrollable telegram log with detailed parsing information
+
+The TUI provides a convenient way to monitor and interact with XP devices without juggling multiple terminal commands.
 
 ### 🔧 Advanced Features
 
@@ -201,13 +223,7 @@ xp checksum calculate "E14L00I02M" --algorithm crc32
 ```
 </details>
 
-### 🌐 API & Integration
-
-**REST API Server**
-```bash
-# Start API server with interactive docs at /docs
-xp api start
-```
+### 🌐 Integration
 
 **HomeKit Smart Home Bridge**
 ```bash
@@ -232,7 +248,7 @@ xp reverse-proxy start
 
 **Layered Design**
 ```
-CLI Layer → API Layer → Services → Models → Connection Layer
+CLI Layer → Services → Models → Connection Layer
 ```
 
 **Key Components**: Telegram processing • Real-time Conbus communication • HomeKit bridge • Multiple XP server support • Configuration management
@@ -256,9 +272,8 @@ pdm run check
 <details>
 <summary><b>Project Structure</b></summary>
 
-``` 
+```
 src/xp/
-├── api/           # FastAPI REST endpoints
 ├── cli/           # Command-line interface
 ├── models/        # Core data models
 ├── services/      # Business logic
@@ -407,7 +422,7 @@ xp term protocol
 ```
 </details>
 
-**Requirements**: Python 3.10+ • FastAPI • Pydantic • Click • HAP-python
+**Requirements**: Python 3.10+ • Pydantic • Click • HAP-python
 
 ## License
 

{conson_xp-1.21.0.dist-info → conson_xp-1.22.0.dist-info}/RECORD

@@ -1,8 +1,8 @@
-conson_xp-1.21.0.dist-info/METADATA,sha256=HK1EyLvZ5dYaq4J30bnPy8dCvOHt7Zg7eZEI_6yjAbk,9584
-conson_xp-1.21.0.dist-info/WHEEL,sha256=tsUv_t7BDeJeRHaSrczbGeuK-TtDpGsWi_JfpzD255I,90
-conson_xp-1.21.0.dist-info/entry_points.txt,sha256=1OcdIcDM1hz3ljCXgybaPUh1IOFEwkaTgLIW9u9zGeg,50
-conson_xp-1.21.0.dist-info/licenses/LICENSE,sha256=rxj6woMM-r3YCyGq_UHFtbh7kHTAJgrccH6O-33IDE4,1419
-xp/__init__.py,sha256=XRUlxeaLq3T5GvQqiQm4B3VDGuqGInrFa511pFvemqI,181
+conson_xp-1.22.0.dist-info/METADATA,sha256=SHz732F4Z0CbbWIukCpttstkgiNLFBgqYAZQg94OkEk,10298
+conson_xp-1.22.0.dist-info/WHEEL,sha256=tsUv_t7BDeJeRHaSrczbGeuK-TtDpGsWi_JfpzD255I,90
+conson_xp-1.22.0.dist-info/entry_points.txt,sha256=1OcdIcDM1hz3ljCXgybaPUh1IOFEwkaTgLIW9u9zGeg,50
+conson_xp-1.22.0.dist-info/licenses/LICENSE,sha256=rxj6woMM-r3YCyGq_UHFtbh7kHTAJgrccH6O-33IDE4,1419
+xp/__init__.py,sha256=cGDFz-p2G9nzESEviCX7b8voSRj-fYSsRjnhBPsDwSE,181
 xp/cli/__init__.py,sha256=QjnKB1KaI2aIyKlzrnvCwfbBuUj8HNgwNMvNJVQofbI,81
 xp/cli/__main__.py,sha256=l2iKwMdat5rTGd3JWs-uGksnYYDDffp_Npz05QdKEeU,117
 xp/cli/commands/__init__.py,sha256=noh8fdZAWq-ihJEboP8WugbIgq4LJ3jUWMRA7720xWE,4909
@@ -42,7 +42,7 @@ xp/cli/commands/telegram/telegram_parse_commands.py,sha256=_OYOso1hS4f_ox96qlkYL
 xp/cli/commands/telegram/telegram_version_commands.py,sha256=WQyx1-B9yJ8V9WrFyBpOvULJ-jq12GoZZDDoRbM7eyw,1553
 xp/cli/commands/term/__init__.py,sha256=1NNST_8YJfj5LCujQISwQflK6LyEn7mDmZpMpvI9d-o,116
 xp/cli/commands/term/term.py,sha256=gjvsv2OE-F_KNWQrWi04fXQ5cGo0l8P-Ortbb5KTA-A,309
-xp/cli/commands/term/term_commands.py,sha256=5LwxOp1oHqki3iWPHXm6enPCF4De6uDg5N1QDVxjROs,739
+xp/cli/commands/term/term_commands.py,sha256=ccBdvvyxjh2-cptmI9ohVIa02OOfG0dzO1JFb4KTowQ,744
 xp/cli/main.py,sha256=ap5jU0DrSnrCKDKqGXcz9N-sngZodyyN-5ReWE8Fh1s,1817
 xp/cli/utils/__init__.py,sha256=gTGIj60Uai0iE7sr9_TtEpl04fD7krtTzbbigXUsUVU,46
 xp/cli/utils/click_tree.py,sha256=ilmM2IMa_c-TqUMsv2alrZXuS0BNhvVlrBlSfyN8lzM,1670
@@ -176,11 +176,13 @@ xp/services/telegram/telegram_output_service.py,sha256=UaUv_14fR8o5K2PxQBXrCzx-H
 xp/services/telegram/telegram_service.py,sha256=XrP1CPi0ckxoKBaNwLA6lo-TogWxXgmXDOsU4Xl8BlY,13237
 xp/services/telegram/telegram_version_service.py,sha256=M5HdOTsLdcwo122FP-jW6R740ktLrtKf2TiMDVz23h8,10528
 xp/term/__init__.py,sha256=Xg2DhBeI3xQJLfc7_BPWI1por-rUXemyer5OtOt9Cus,51
-xp/term/app.py,sha256=vrC5VJbw1tlCvKnLR0n9NvGWaJx44yz0gG6k3--BaNk,5652
+xp/term/protocol.py,sha256=ERntzYvNMyI-VDCYW7EnhpPu-V6WPmyEk0xcQfm7LFM,4399
 xp/term/protocol.tcss,sha256=biaIv6X-bmD1tbXENFUNsXOF8ABkuoRAUgeSDqwudtQ,2126
-xp/term/protocol.yml,sha256=vPtTsMdasWiruj8iqqQX4f4ZtQdJ5wA39IJ-et3qiZc,2110
-xp/term/widgets/__init__.py,sha256=Ewiza9u6k5K50zZRIMD7jjOHY1IvGhoX1ViwlqhdGms,27
+xp/term/protocol.yml,sha256=kiTe_QSMPmLvLA0ZyIhNaDPwBdi6khh5C1NSR7I9TN0,2124
+xp/term/widgets/__init__.py,sha256=ftWmN_fmjxy2E8Qfm-YSRmzKfgL0KTBCTpgvYWCPbUY,274
+xp/term/widgets/help_menu.py,sha256=bdT5AYRdtKt_tvZTVbG7-DPMb1mj78kggtjjsa-95BA,1780
 xp/term/widgets/protocol_log.py,sha256=yuSfc61azgQmWQxLvBcmVik3cJAW1Hocj2Sk8qr3hSg,14343
+xp/term/widgets/status_footer.py,sha256=VTN5owCprMbYmNiEbNWS_4CE8yxysDi8IBCECuU9EQY,1663
 xp/utils/__init__.py,sha256=_avMF_UOkfR3tNeDIPqQ5odmbq5raKkaq1rZ9Cn1CJs,332
 xp/utils/checksum.py,sha256=HDpiQxmdIedbCbZ4o_Box0i_Zig417BtCV_46ZyhiTk,1711
 xp/utils/dependencies.py,sha256=ECS6p0eXzocM5INLwJeckHXn_Dim18uOjXTJ29qQvkQ,22001
@@ -189,4 +191,4 @@ xp/utils/logging.py,sha256=rZDXwlBrYK8A6MPq5StsMNpgsRowzJXM6fvROPwJdGM,3750
 xp/utils/serialization.py,sha256=RWHHk86feaB4ZP7rjE4qOWK0900yg2joUBDkP76gfOY,4618
 xp/utils/state_machine.py,sha256=Oe2sLwCh9z_vr1tF6X0ZRGTeuckRQAGzmef7xc9CNdc,2413
 xp/utils/time_utils.py,sha256=dEyViDlAG9GWU-J3D_YVa-sGma6yiyyMTgN4h2x3PY4,3781
-conson_xp-1.21.0.dist-info/RECORD,,
+conson_xp-1.22.0.dist-info/RECORD,,

xp/__init__.py

@@ -3,7 +3,7 @@
 conson-xp package.
 """
 
-__version__ = "1.21.0"
+__version__ = "1.22.0"
 __manufacturer__ = "salchichon"
 __model__ = "xp.cli"
 __serial__ = "2025.09.23.000"

xp/cli/commands/term/term_commands.py

@@ -21,7 +21,7 @@ def protocol_monitor(ctx: Context) -> None:
         \b
         xp term protocol
     """
-    from xp.term.app import ProtocolMonitorApp
+    from xp.term.protocol import ProtocolMonitorApp
 
     # Resolve ServiceContainer from context
     container = ctx.obj.get("container").get_container()

xp/term/{app.py → protocol.py}

@@ -4,11 +4,12 @@ from pathlib import Path
 from typing import Any, Optional
 
 from textual.app import App, ComposeResult
-from textual.containers import Horizontal, Vertical
-from textual.widgets import DataTable, Footer, Static
+from textual.containers import Horizontal
 
 from xp.models.term import ProtocolKeysConfig
+from xp.term.widgets.help_menu import HelpMenuWidget
 from xp.term.widgets.protocol_log import ProtocolLogWidget
+from xp.term.widgets.status_footer import StatusFooterWidget
 
 
 class ProtocolMonitorApp(App[None]):
@@ -45,9 +46,8 @@ class ProtocolMonitorApp(App[None]):
         super().__init__()
         self.container = container
         self.protocol_widget: Optional[ProtocolLogWidget] = None
-        self.status_widget: Optional[Static] = None
-        self.status_text_widget: Optional[Static] = None
-        self.help_table: Optional[DataTable] = None
+        self.help_menu: Optional[HelpMenuWidget] = None
+        self.footer_widget: Optional[StatusFooterWidget] = None
         self.protocol_keys = self._load_protocol_keys()
 
     def _load_protocol_keys(self) -> ProtocolKeysConfig:
@@ -70,18 +70,13 @@ class ProtocolMonitorApp(App[None]):
             yield self.protocol_widget
 
             # Help menu (hidden by default)
-            help_container = Vertical(id="help-menu")
-            help_container.border_title = "Help menu"
-            help_container.can_focus = False
-            with help_container:
-                self.help_table = DataTable(id="help-table", show_header=False)
-                self.help_table.can_focus = False
-                yield self.help_table
-
-        with Horizontal(id="footer-container"):
-            yield Footer()
-            self.status_widget = Static("○", id="status-line")
-            yield self.status_widget
+            self.help_menu = HelpMenuWidget(
+                protocol_keys=self.protocol_keys, id="help-menu"
+            )
+            yield self.help_menu
+
+        self.footer_widget = StatusFooterWidget(id="footer-container")
+        yield self.footer_widget
 
     def action_toggle_connection(self) -> None:
         """Toggle connection on 'c' key press.
@@ -122,37 +117,11 @@ class ProtocolMonitorApp(App[None]):
                 self._update_status,
             )
 
-        # Initialize help table
-        if self.help_table:
-            self.help_table.add_columns("Key", "Command")
-            for key, config in self.protocol_keys.protocol.items():
-                self.help_table.add_row(key, config.name)
-
     def _update_status(self, state: Any) -> None:
         """Update status line with connection state.
 
         Args:
             state: Current connection state.
         """
-        if self.status_widget:
-            # Map states to colored dots
-            status_map = {
-                "CONNECTED": "[green]●[/green]",
-                "CONNECTING": "[yellow]●[/yellow]",
-                "DISCONNECTING": "[yellow]●[/yellow]",
-                "FAILED": "[red]●[/red]",
-                "DISCONNECTED": "○",
-            }
-            dot = status_map.get(state.value, "○")
-            self.status_widget.update(dot)
-
-    def on_protocol_log_widget_status_message_changed(
-        self, message: ProtocolLogWidget.StatusMessageChanged
-    ) -> None:
-        """Handle status message changes from protocol widget.
-
-        Args:
-            message: Message containing the status text.
-        """
-        if self.status_text_widget:
-            self.status_text_widget.update(message.message)
+        if self.footer_widget:
+            self.footer_widget.update_status(state)

xp/term/protocol.yml

@@ -55,85 +55,85 @@ protocol:
       - E02L00I08B
 
   "d":
-    name: "All 1 On"
+    name: "Link 1 On"
     telegrams:
       - E02L01I08M
       - E02L01I08B
 
   "e":
-    name: "All 1 Off"
+    name: "Link 1 Off"
     telegrams:
       - E02L01I00M
       - E02L01I00B
 
   "f":
-    name: "All 2 On"
+    name: "Link 2 On"
     telegrams:
       - E02L02I08M
       - E02L02I08B
 
   "g":
-    name: "All 2 Off"
+    name: "Link 2 Off"
     telegrams:
       - E02L02I00M
       - E02L02I00B
 
   "h":
-    name: "All 3 On"
+    name: "Link 3 On"
     telegrams:
       - E02L03I08M
       - E02L03I08B
 
   "i":
-    name: "All 3 Off"
+    name: "Link 3 Off"
     telegrams:
       - E02L03I00M
       - E02L03I00B
 
   "j":
-    name: "All 4 On"
+    name: "Link 4 On"
     telegrams:
       - E02L04I08M
       - E02L04I08B
 
   "k":
-    name: "All 4 Off"
+    name: "Link 4 Off"
     telegrams:
       - E02L04I00M
       - E02L04I00B
 
   "l":
-    name: "All 5 On"
+    name: "Link 5 On"
     telegrams:
       - E02L05I08M
       - E02L05I08B
 
   "m":
-    name: "All 5 Off"
+    name: "Link 5 Off"
     telegrams:
       - E02L05I00M
       - E02L05I00B
 
   "n":
-    name: "All 6 On"
+    name: "Link 6 On"
     telegrams:
       - E02L06I08M
       - E02L06I08B
 
   "o":
-    name: "All 6 Off"
+    name: "Link 6 Off"
     telegrams:
       - E02L06I00M
       - E02L06I00B
 
   "p":
-    name: "All 7 On"
+    name: "Link 7 On"
     telegrams:
       - E02L07I08M
       - E02L07I08B
 
   "q":
-    name: "All 7 Off"
+    name: "Link 7 Off"
     telegrams:
       - E02L07I00M
       - E02L07I00B

xp/term/widgets/__init__.py

@@ -1 +1,7 @@
 """TUI widgets package."""
+
+from xp.term.widgets.help_menu import HelpMenuWidget
+from xp.term.widgets.protocol_log import ProtocolLogWidget
+from xp.term.widgets.status_footer import StatusFooterWidget
+
+__all__ = ["HelpMenuWidget", "ProtocolLogWidget", "StatusFooterWidget"]

xp/term/widgets/help_menu.py

@@ -0,0 +1,55 @@
+"""Help Menu Widget for displaying keyboard shortcuts and protocol keys."""
+
+from typing import Any
+
+from textual.app import ComposeResult
+from textual.containers import Vertical
+from textual.widgets import DataTable
+
+from xp.models.term import ProtocolKeysConfig
+
+
+class HelpMenuWidget(Vertical):
+    """Help menu widget displaying keyboard shortcuts and protocol keys.
+
+    Displays a table of available keyboard shortcuts mapped to their
+    corresponding protocol commands.
+
+    Attributes:
+        protocol_keys: Configuration of protocol keys and their telegrams.
+        help_table: DataTable widget for displaying key mappings.
+    """
+
+    def __init__(
+        self,
+        protocol_keys: ProtocolKeysConfig,
+        *args: Any,
+        **kwargs: Any,
+    ) -> None:
+        """Initialize the Help Menu widget.
+
+        Args:
+            protocol_keys: Configuration containing protocol key mappings.
+            args: Additional positional arguments for Vertical.
+            kwargs: Additional keyword arguments for Vertical.
+        """
+        super().__init__(*args, **kwargs)
+        self.protocol_keys = protocol_keys
+        self.help_table: DataTable = DataTable(id="help-table", show_header=False)
+        self.help_table.can_focus = False
+        self.border_title = "Help menu"
+        self.can_focus = False
+
+    def compose(self) -> ComposeResult:
+        """Compose the help menu layout.
+
+        Yields:
+            DataTable widget with key mappings.
+        """
+        yield self.help_table
+
+    def on_mount(self) -> None:
+        """Populate help table when widget mounts."""
+        self.help_table.add_columns("Key", "Command")
+        for key, config in self.protocol_keys.protocol.items():
+            self.help_table.add_row(key, config.name)

xp/term/widgets/status_footer.py

@@ -0,0 +1,53 @@
+"""Status Footer Widget for displaying app footer with connection status."""
+
+from typing import Any
+
+from textual.app import ComposeResult
+from textual.containers import Horizontal
+from textual.widgets import Footer, Static
+
+
+class StatusFooterWidget(Horizontal):
+    """Footer widget with connection status indicator.
+
+    Combines the Textual Footer with a status indicator dot that shows
+    the current connection state.
+
+    Attributes:
+        status_widget: Static widget displaying colored status dot.
+    """
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        """Initialize the Status Footer widget.
+
+        Args:
+            args: Additional positional arguments for Horizontal.
+            kwargs: Additional keyword arguments for Horizontal.
+        """
+        super().__init__(*args, **kwargs)
+        self.status_widget: Static = Static("○", id="status-line")
+
+    def compose(self) -> ComposeResult:
+        """Compose the footer layout.
+
+        Yields:
+            Footer and status indicator widgets.
+        """
+        yield Footer()
+        yield self.status_widget
+
+    def update_status(self, state: Any) -> None:
+        """Update status indicator with connection state.
+
+        Args:
+            state: Current connection state (ConnectionState enum).
+        """
+        # Map states to colored dots
+        dot = {
+            "CONNECTED": "[green]●[/green]",
+            "CONNECTING": "[yellow]●[/yellow]",
+            "DISCONNECTING": "[yellow]●[/yellow]",
+            "FAILED": "[red]●[/red]",
+            "DISCONNECTED": "○",
+        }.get(state.value, "○")
+        self.status_widget.update(dot)