conson-xp 1.21.0__tar.gz → 1.23.0__tar.gz

{conson_xp-1.21.0 → conson_xp-1.23.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: conson-xp
-Version: 1.21.0
+Version: 1.23.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 → conson_xp-1.23.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.21.0 → conson_xp-1.23.0}/pyproject.toml

@@ -22,7 +22,7 @@ dependencies = [
 ]
 requires-python = ">=3.11"
 readme = "README.md"
-version = "1.21.0"
+version = "1.23.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.21.0 → conson_xp-1.23.0}/src/xp/__init__.py

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

{conson_xp-1.21.0 → conson_xp-1.23.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.term.app import ProtocolMonitorApp
+    from xp.term.protocol import ProtocolMonitorApp
 
     # Resolve ServiceContainer from context
     container = ctx.obj.get("container").get_container()

conson_xp-1.23.0/src/xp/models/term/connection_state.py

@@ -0,0 +1,58 @@
+"""Connection state management module."""
+
+from enum import Enum
+
+from xp.utils.state_machine import StateMachine
+
+
+class ConnectionState(str, Enum):
+    """Connection state enumeration.
+
+    Attributes:
+        DISCONNECTING: Disconnecting to server.
+        DISCONNECTED: Not connected to server.
+        CONNECTING: Connection in progress.
+        CONNECTED: Successfully connected.
+        FAILED: Connection failed.
+    """
+
+    DISCONNECTING = "DISCONNECTING"
+    DISCONNECTED = "DISCONNECTED"
+    CONNECTING = "CONNECTING"
+    CONNECTED = "CONNECTED"
+    FAILED = "FAILED"
+
+    @staticmethod
+    def create_state_machine() -> StateMachine:
+        """Create and configure state machine for connection management.
+
+        Returns:
+            Configured StateMachine with connection state transitions.
+        """
+        sm = StateMachine(ConnectionState.DISCONNECTED)
+
+        # Define valid transitions
+        sm.define_transition(
+            "connect", {ConnectionState.DISCONNECTED, ConnectionState.FAILED}
+        )
+        sm.define_transition(
+            "disconnect", {ConnectionState.CONNECTED, ConnectionState.CONNECTING}
+        )
+        sm.define_transition(
+            "connecting", {ConnectionState.DISCONNECTED, ConnectionState.FAILED}
+        )
+        sm.define_transition("connected", {ConnectionState.CONNECTING})
+        sm.define_transition(
+            "disconnecting", {ConnectionState.CONNECTED, ConnectionState.CONNECTING}
+        )
+        sm.define_transition("disconnected", {ConnectionState.DISCONNECTING})
+        sm.define_transition(
+            "failed",
+            {
+                ConnectionState.CONNECTING,
+                ConnectionState.CONNECTED,
+                ConnectionState.DISCONNECTING,
+            },
+        )
+
+        return sm

conson_xp-1.23.0/src/xp/models/term/status_message.py

@@ -0,0 +1,16 @@
+"""Status message models for terminal UI."""
+
+from textual.message import Message
+
+
+class StatusMessageChanged(Message):
+    """Message posted when status message changes."""
+
+    def __init__(self, message: str) -> None:
+        """Initialize the message.
+
+        Args:
+            message: The status message to display.
+        """
+        super().__init__()
+        self.message = message

{conson_xp-1.21.0 → conson_xp-1.23.0}/src/xp/services/protocol/conbus_event_protocol.py

@@ -17,7 +17,7 @@ from twisted.internet.interfaces import IAddress, IConnector
 from twisted.internet.posixbase import PosixReactorBase
 from twisted.python.failure import Failure
 
-from xp.models import ConbusClientConfig
+from xp.models import ConbusClientConfig, ModuleTypeCode
 from xp.models.protocol.conbus_protocol import (
     TelegramReceivedEvent,
 )
@@ -168,9 +168,6 @@ class ConbusEventProtocol(protocol.Protocol, protocol.ClientFactory):
 
         Args:
             data: Raw telegram payload (without checksum/framing).
-
-        Raises:
-            IOError: If transport is not open.
         """
         self.on_send_frame.emit(data)
 
@@ -180,8 +177,9 @@ class ConbusEventProtocol(protocol.Protocol, protocol.ClientFactory):
         frame = b"<" + frame_data.encode() + b">"
 
         if not self.transport:
-            self.logger.info("Invalid transport")
-            raise IOError("Transport is not open")
+            self.logger.info("Invalid transport, connection closed.")
+            self.on_connection_failed.emit(Failure("Invalid transport."))
+            return
 
         self.logger.debug(f"Sending frame: {frame.decode()}")
         self.transport.write(frame)  # type: ignore
@@ -211,6 +209,21 @@ class ConbusEventProtocol(protocol.Protocol, protocol.ClientFactory):
         )
         self.send_raw_telegram(payload)
 
+    def send_event_telegram(
+        self, module_type_code: ModuleTypeCode, link_number: int, input_number: int
+    ) -> None:
+        """Send telegram with specified parameters.
+
+        Args:
+            module_type_code: Type code of module.
+            link_number: Link number.
+            input_number: Input number.
+        """
+        payload = (
+            f"E" f"{module_type_code}" f"L{link_number:02d}" f"I{input_number:02d}"
+        )
+        self.send_raw_telegram(payload)
+
     def send_raw_telegram(self, payload: str) -> None:
         """Send telegram with specified parameters.
 

conson_xp-1.21.0/src/xp/term/app.py → conson_xp-1.23.0/src/xp/term/protocol.py

@@ -4,11 +4,13 @@ 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.models.term.status_message import StatusMessageChanged
+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 +47,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 +71,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 +118,20 @@ 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:
+        if self.footer_widget:
+            self.footer_widget.update_status(state)
+
+    def on_status_message_changed(self, message: 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_message(message.message)

{conson_xp-1.21.0 → conson_xp-1.23.0}/src/xp/term/protocol.tcss

@@ -119,7 +119,7 @@ Footer {
 #status-text {
     dock: right;
     width: auto;
-    padding: 0 1;
+    padding: 0 3;
     background: $background;
     color: $text;
     text-align: right;

{conson_xp-1.21.0 → conson_xp-1.23.0}/src/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

conson_xp-1.23.0/src/xp/term/widgets/__init__.py

@@ -0,0 +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"]

conson_xp-1.23.0/src/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)