conson-xp 1.20.0__tar.gz → 1.22.0__tar.gz

{conson_xp-1.20.0 → conson_xp-1.22.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: conson-xp
-Version: 1.20.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.20.0 → conson_xp-1.22.0}/README.md

@@ -7,7 +7,7 @@
 [![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.
 
@@ -28,7 +28,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
 
 ---
 
@@ -43,9 +43,6 @@ xp telegram parse "<E14L00I02MAK>"
 
 # Discover XP servers on your network
 xp conbus discover
-
-# Start the REST API server
-xp api start
 ```
 
 ## 📦 Installation
@@ -114,7 +111,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
 
@@ -148,13 +170,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
@@ -179,7 +195,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
@@ -203,9 +219,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
@@ -354,7 +369,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.20.0 → conson_xp-1.22.0}/pyproject.toml

@@ -22,7 +22,7 @@ dependencies = [
 ]
 requires-python = ">=3.11"
 readme = "README.md"
-version = "1.20.0"
+version = "1.22.0"
 
 [project.license]
 file = "LICENSE"
@@ -209,7 +209,7 @@ composite = [
 ]
 
 [tool.pdm.scripts.clean]
-shell = "rm -rf .coverage coverage.xml htmlcov/ .pytest_cache/ && find . -type d -name '__pycache__' -exec rm -rf {} +"
+shell = "rm -rf .coverage coverage.xml htmlcov/ .pytest_cache/ conbus.log.* && find . -type d -name '__pycache__' -exec rm -rf {} +"
 
 [tool.vulture]
 exclude = [

{conson_xp-1.20.0 → conson_xp-1.22.0}/src/xp/__init__.py

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

{conson_xp-1.20.0 → conson_xp-1.22.0}/src/xp/cli/commands/term/term_commands.py

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

conson_xp-1.22.0/src/xp/models/term/__init__.py

@@ -0,0 +1,11 @@
+"""Terminal UI models."""
+
+from xp.models.term.protocol_keys_config import (
+    ProtocolKeyConfig,
+    ProtocolKeysConfig,
+)
+
+__all__ = [
+    "ProtocolKeyConfig",
+    "ProtocolKeysConfig",
+]

conson_xp-1.22.0/src/xp/models/term/protocol_keys_config.py

@@ -0,0 +1,45 @@
+"""Protocol keys configuration model."""
+
+from pathlib import Path
+from typing import Dict
+
+import yaml
+from pydantic import BaseModel, Field
+
+
+class ProtocolKeyConfig(BaseModel):
+    """Configuration for a single protocol key.
+
+    Attributes:
+        name: Human-readable command name.
+        telegrams: List of raw telegram strings to send (without angle brackets).
+    """
+
+    name: str = Field(..., description="Human-readable command name")
+    telegrams: list[str] = Field(..., description="List of raw telegram strings")
+
+
+class ProtocolKeysConfig(BaseModel):
+    """Protocol keys configuration.
+
+    Attributes:
+        protocol: Dictionary mapping key to protocol configuration.
+    """
+
+    protocol: Dict[str, ProtocolKeyConfig] = Field(
+        default_factory=dict, description="Protocol key mappings"
+    )
+
+    @classmethod
+    def from_yaml(cls, config_path: Path) -> "ProtocolKeysConfig":
+        """Load protocol keys from YAML file.
+
+        Args:
+            config_path: Path to YAML configuration file.
+
+        Returns:
+            ProtocolKeysConfig instance.
+        """
+        with config_path.open("r") as f:
+            data = yaml.safe_load(f)
+        return cls(**data)

{conson_xp-1.20.0 → conson_xp-1.22.0}/src/xp/services/protocol/conbus_event_protocol.py

@@ -209,6 +209,14 @@ class ConbusEventProtocol(protocol.Protocol, protocol.ClientFactory):
             f"F{system_function.value}"
             f"D{data_value}"
         )
+        self.send_raw_telegram(payload)
+
+    def send_raw_telegram(self, payload: str) -> None:
+        """Send telegram with specified parameters.
+
+        Args:
+            payload: Telegram to send.
+        """
         self.telegram_queue.put_nowait(payload.encode())
         self.call_later(0.0, self.start_queue_manager)
 

conson_xp-1.22.0/src/xp/term/protocol.py

@@ -0,0 +1,127 @@
+"""Protocol Monitor TUI Application."""
+
+from pathlib import Path
+from typing import Any, Optional
+
+from textual.app import App, ComposeResult
+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]):
+    """Textual app for real-time protocol monitoring.
+
+    Displays live RX/TX telegram stream from Conbus server in an interactive
+    terminal interface with keyboard shortcuts for control.
+
+    Attributes:
+        container: ServiceContainer for dependency injection.
+        CSS_PATH: Path to CSS stylesheet file.
+        BINDINGS: Keyboard bindings for app actions.
+        TITLE: Application title displayed in header.
+        ENABLE_COMMAND_PALETTE: Disable Textual's command palette feature.
+    """
+
+    CSS_PATH = Path(__file__).parent / "protocol.tcss"
+    TITLE = "Protocol Monitor"
+    ENABLE_COMMAND_PALETTE = False
+
+    BINDINGS = [
+        ("Q", "quit", "Quit"),
+        ("C", "toggle_connection", "Connect"),
+        ("R", "reset", "Reset"),
+        ("0-9,a-q", "protocol_keys", "Keys"),
+    ]
+
+    def __init__(self, container: Any) -> None:
+        """Initialize the Protocol Monitor app.
+
+        Args:
+            container: ServiceContainer for resolving services.
+        """
+        super().__init__()
+        self.container = container
+        self.protocol_widget: Optional[ProtocolLogWidget] = 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:
+        """Load protocol keys from YAML config file.
+
+        Returns:
+            ProtocolKeysConfig instance.
+        """
+        config_path = Path(__file__).parent / "protocol.yml"
+        return ProtocolKeysConfig.from_yaml(config_path)
+
+    def compose(self) -> ComposeResult:
+        """Compose the app layout with widgets.
+
+        Yields:
+            ProtocolLogWidget and Footer widgets.
+        """
+        with Horizontal(id="main-container"):
+            self.protocol_widget = ProtocolLogWidget(container=self.container)
+            yield self.protocol_widget
+
+            # Help menu (hidden by default)
+            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.
+
+        Connects if disconnected/failed, disconnects if connected/connecting.
+        """
+        if self.protocol_widget:
+            from xp.term.widgets.protocol_log import ConnectionState
+
+            state = self.protocol_widget.connection_state
+            if state in (ConnectionState.CONNECTED, ConnectionState.CONNECTING):
+                self.protocol_widget.disconnect()
+            else:
+                self.protocol_widget.connect()
+
+    def action_reset(self) -> None:
+        """Reset and clear protocol widget on 'r' key press."""
+        if self.protocol_widget:
+            self.protocol_widget.clear_log()
+
+    def on_key(self, event: Any) -> None:
+        """Handle key press events for protocol keys.
+
+        Args:
+            event: Key press event from Textual.
+        """
+        if event.key in self.protocol_keys.protocol and self.protocol_widget:
+            key_config = self.protocol_keys.protocol[event.key]
+            for telegram in key_config.telegrams:
+                self.protocol_widget.send_telegram(key_config.name, telegram)
+
+    def on_mount(self) -> None:
+        """Set up status line updates when app mounts."""
+        if self.protocol_widget:
+            self.protocol_widget.watch(
+                self.protocol_widget,
+                "connection_state",
+                self._update_status,
+            )
+
+    def _update_status(self, state: Any) -> None:
+        """Update status line with connection state.
+
+        Args:
+            state: Current connection state.
+        """
+        if self.footer_widget:
+            self.footer_widget.update_status(state)

conson_xp-1.22.0/src/xp/term/protocol.tcss

@@ -0,0 +1,135 @@
+/* Protocol Monitor TUI Styling */
+
+/* App-level styling */
+Screen {
+    background: $background;
+}
+
+/* Protocol Log Widget */
+ProtocolLogWidget {
+    border: solid $success;
+    width: 1fr;
+    height: 1fr;
+    background: $background;
+    padding: 1;
+}
+
+ProtocolLogWidget > RichLog {
+    background: $background !important;
+    scrollbar-background: $background;
+}
+
+ProtocolLogWidget > RichLog:focus {
+    background: $background !important;
+    background-tint: transparent;
+}
+
+ProtocolLogWidget > .connection-status {
+    color: $text;
+    text-align: center;
+    padding: 1;
+}
+
+ProtocolLogWidget > .connection-status.connecting {
+    color: $warning;
+}
+
+ProtocolLogWidget > .connection-status.connected {
+    color: $success;
+}
+
+ProtocolLogWidget > .connection-status.failed {
+    color: $error;
+}
+
+/* Message display styling */
+.message-tx {
+    color: $success;
+}
+
+.message-rx {
+    color: $success;
+}
+
+.message-frame {
+    color: $text-muted;
+}
+
+/* Main container */
+#main-container {
+    height: 1fr;
+}
+
+/* Help menu styling */
+#help-menu {
+    width: 35;
+    height: 1fr;
+    background: $background;
+    border: solid $success;
+    padding: 1;
+}
+
+#help-menu:focus {
+    border: solid $success;
+}
+
+#help-title {
+    color: $success;
+    text-align: center;
+    text-style: bold;
+    margin-bottom: 1;
+}
+
+#help-table {
+    background: $background;
+    height: auto;
+    color: $success;
+}
+
+DataTable {
+    background: $background;
+}
+
+DataTable > .datatable--header {
+    background: $background;
+    color: $success;
+}
+
+DataTable > .datatable--cursor {
+    background: $background;
+}
+
+DataTable:focus > .datatable--cursor {
+    background: $background;
+}
+
+/* Footer styling */
+#footer-container {
+    dock: bottom;
+    height: 1;
+    background: $background;
+}
+
+Footer {
+    width: auto;
+    background: $background;
+    color: $text;
+}
+
+#status-text {
+    dock: right;
+    width: auto;
+    padding: 0 1;
+    background: $background;
+    color: $text;
+    text-align: right;
+}
+
+#status-line {
+    dock: right;
+    width: auto;
+    padding: 0 1;
+    background: $background;
+    color: $text;
+    text-align: right;
+}