conson-xp 1.32.0__tar.gz → 1.34.0__tar.gz

{conson_xp-1.32.0 → conson_xp-1.34.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: conson-xp
-Version: 1.32.0
+Version: 1.34.0
 Summary: XP Protocol Communication Tools
 Author-Email: ldvchosal <ldvchosal@github.com>
 License: MIT License
@@ -91,6 +91,9 @@ Comprehensive type safety and robust error handling
 # Install with PIP (recommended)
 pip install conson-xp
 
+# Export your Conbus device configuration (recommended first step)
+xp conbus export
+
 # Parse a telegram
 xp telegram parse "<E14L00I02MAK>"
 
@@ -133,7 +136,29 @@ xp telegram validate "<E14L00I02MAK>"
 ```
 
 **Device Communication**
+
+> **⚠️ Important**: Bridge modules (XP130, XP230) accept **only one TCP connection at a time**.
+> Close any existing connections (including the official app) before using xp commands.
+
 ```bash
+# Export device configuration (RECOMMENDED - run this first!)
+# Discovers all devices and exports complete configuration to export.yml
+xp conbus export
+
+# What it does:
+# - Automatically discovers all devices on the Conbus network
+# - Queries 7 datapoints per device (type, version, link number, etc.)
+# - Generates export.yml in conson.yml format
+# - Shows real-time progress for each device
+# - Handles timeouts gracefully with partial exports
+#
+# Example output:
+#   Querying device 1/12: 0020041013...
+#     ✓ Module type: X130 (1)
+#     ✓ Link number: 1
+#     ✓ Software version: V2.3
+#   Export complete: export.yml (12 devices)
+
 # Discover XP servers on your network
 xp conbus discover
 

{conson_xp-1.32.0 → conson_xp-1.34.0}/README.md

@@ -38,6 +38,9 @@ Comprehensive type safety and robust error handling
 # Install with PIP (recommended)
 pip install conson-xp
 
+# Export your Conbus device configuration (recommended first step)
+xp conbus export
+
 # Parse a telegram
 xp telegram parse "<E14L00I02MAK>"
 
@@ -80,7 +83,29 @@ xp telegram validate "<E14L00I02MAK>"
 ```
 
 **Device Communication**
+
+> **⚠️ Important**: Bridge modules (XP130, XP230) accept **only one TCP connection at a time**.
+> Close any existing connections (including the official app) before using xp commands.
+
 ```bash
+# Export device configuration (RECOMMENDED - run this first!)
+# Discovers all devices and exports complete configuration to export.yml
+xp conbus export
+
+# What it does:
+# - Automatically discovers all devices on the Conbus network
+# - Queries 7 datapoints per device (type, version, link number, etc.)
+# - Generates export.yml in conson.yml format
+# - Shows real-time progress for each device
+# - Handles timeouts gracefully with partial exports
+#
+# Example output:
+#   Querying device 1/12: 0020041013...
+#     ✓ Module type: X130 (1)
+#     ✓ Link number: 1
+#     ✓ Software version: V2.3
+#   Export complete: export.yml (12 devices)
+
 # Discover XP servers on your network
 xp conbus discover
 

{conson_xp-1.32.0 → conson_xp-1.34.0}/pyproject.toml

@@ -22,7 +22,7 @@ dependencies = [
 ]
 requires-python = ">=3.11"
 readme = "README.md"
-version = "1.32.0"
+version = "1.34.0"
 
 [project.license]
 file = "LICENSE"

{conson_xp-1.32.0 → conson_xp-1.34.0}/src/xp/__init__.py

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

{conson_xp-1.32.0 → conson_xp-1.34.0}/src/xp/cli/commands/conbus/conbus_blink_commands.py

@@ -41,12 +41,15 @@ def send_blink_on_telegram(ctx: Context, serial_number: str) -> None:
             service_response: Blink response object.
         """
         click.echo(json.dumps(service_response.to_dict(), indent=2))
+        service.stop_reactor()
 
     service: ConbusBlinkService = (
         ctx.obj.get("container").get_container().resolve(ConbusBlinkService)
     )
     with service:
-        service.send_blink_telegram(serial_number, "on", on_finish, 0.5)
+        service.on_finish.connect(on_finish)
+        service.send_blink_telegram(serial_number, "on", 0.5)
+        service.start_reactor()
 
 
 @conbus_blink.command("off")
@@ -73,12 +76,15 @@ def send_blink_off_telegram(ctx: Context, serial_number: str) -> None:
             service_response: Blink response object.
         """
         click.echo(json.dumps(service_response.to_dict(), indent=2))
+        service.stop_reactor()
 
     service: ConbusBlinkService = (
         ctx.obj.get("container").get_container().resolve(ConbusBlinkService)
     )
     with service:
-        service.send_blink_telegram(serial_number, "off", on_finish, 0.5)
+        service.on_finish.connect(on_finish)
+        service.send_blink_telegram(serial_number, "off", 0.5)
+        service.start_reactor()
 
 
 @conbus_blink.group("all", short_help="Control blink state for all devices")
@@ -109,6 +115,7 @@ def blink_all_off(ctx: Context) -> None:
             discovered_devices: Blink response with all devices.
         """
         click.echo(json.dumps(discovered_devices.to_dict(), indent=2))
+        service.stop_reactor()
 
     def progress(message: str) -> None:
         """Handle progress updates during blink all off operation.
@@ -116,13 +123,16 @@ def blink_all_off(ctx: Context) -> None:
         Args:
             message: Progress message string.
         """
-        click.echo(message)
+        click.echo(message, nl=False)
 
     service: ConbusBlinkAllService = (
         ctx.obj.get("container").get_container().resolve(ConbusBlinkAllService)
     )
     with service:
-        service.send_blink_all_telegram("off", progress, on_finish, 0.5)
+        service.on_progress.connect(progress)
+        service.on_finish.connect(on_finish)
+        service.send_blink_all_telegram("off", 5)
+        service.start_reactor()
 
 
 @conbus_blink_all.command("on", short_help="Turn on blinking for all devices")
@@ -147,6 +157,7 @@ def blink_all_on(ctx: Context) -> None:
             discovered_devices: Blink response with all devices.
         """
         click.echo(json.dumps(discovered_devices.to_dict(), indent=2))
+        service.stop_reactor()
 
     def progress(message: str) -> None:
         """Handle progress updates during blink all on operation.
@@ -154,10 +165,13 @@ def blink_all_on(ctx: Context) -> None:
         Args:
             message: Progress message string.
         """
-        click.echo(message)
+        click.echo(message, nl=False)
 
     service: ConbusBlinkAllService = (
         ctx.obj.get("container").get_container().resolve(ConbusBlinkAllService)
     )
     with service:
-        service.send_blink_all_telegram("on", progress, on_finish, 0.5)
+        service.on_progress.connect(progress)
+        service.on_finish.connect(on_finish)
+        service.send_blink_all_telegram("on", 5)
+        service.start_reactor()

{conson_xp-1.32.0 → conson_xp-1.34.0}/src/xp/services/conbus/conbus_blink_all_service.py

@@ -6,46 +6,48 @@ blink/unblink telegrams to all discovered modules on the network.
 
 import logging
 from datetime import datetime
-from typing import Callable, Optional
+from typing import Any, Optional
 
-from twisted.internet.posixbase import PosixReactorBase
+from psygnal import Signal
 
-from xp.models import ConbusClientConfig
 from xp.models.conbus.conbus_blink import ConbusBlinkResponse
 from xp.models.protocol.conbus_protocol import TelegramReceivedEvent
 from xp.models.telegram.system_function import SystemFunction
 from xp.models.telegram.telegram_type import TelegramType
-from xp.services.protocol import ConbusProtocol
+from xp.services.protocol.conbus_event_protocol import ConbusEventProtocol
 from xp.services.telegram.telegram_service import TelegramService
 
 
-class ConbusBlinkAllService(ConbusProtocol):
+class ConbusBlinkAllService:
     """
     Service for blinking all modules on Conbus servers.
 
-    Uses ConbusProtocol to provide blink/unblink functionality
+    Uses ConbusEventProtocol to provide blink/unblink functionality
     for all discovered modules on the network.
+
+    Attributes:
+        on_progress: Signal emitted during blink operation progress (with message).
+        on_finish: Signal emitted when blink operation completes (with response).
     """
 
+    on_progress: Signal = Signal(str)
+    on_finish: Signal = Signal(ConbusBlinkResponse)
+
     def __init__(
         self,
+        conbus_protocol: ConbusEventProtocol,
         telegram_service: TelegramService,
-        cli_config: ConbusClientConfig,
-        reactor: PosixReactorBase,
     ) -> None:
         """Initialize the Conbus blink all service.
 
         Args:
+            conbus_protocol: ConbusEventProtocol instance for communication.
             telegram_service: Service for parsing telegrams.
-            cli_config: Configuration for Conbus client connection.
-            reactor: Twisted reactor for event loop.
         """
-        super().__init__(cli_config, reactor)
+        self.conbus_protocol = conbus_protocol
         self.telegram_service = telegram_service
         self.serial_number: str = ""
         self.on_or_off = "none"
-        self.progress_callback: Optional[Callable[[str], None]] = None
-        self.finish_callback: Optional[Callable[[ConbusBlinkResponse], None]] = None
         self.service_response: ConbusBlinkResponse = ConbusBlinkResponse(
             success=False,
             serial_number=self.serial_number,
@@ -56,17 +58,23 @@ class ConbusBlinkAllService(ConbusProtocol):
         # Set up logging
         self.logger = logging.getLogger(__name__)
 
-    def connection_established(self) -> None:
-        """Handle connection established event."""
+        # Connect protocol signals
+        self.conbus_protocol.on_connection_made.connect(self.connection_made)
+        self.conbus_protocol.on_telegram_sent.connect(self.telegram_sent)
+        self.conbus_protocol.on_telegram_received.connect(self.telegram_received)
+        self.conbus_protocol.on_timeout.connect(self.timeout)
+        self.conbus_protocol.on_failed.connect(self.failed)
+
+    def connection_made(self) -> None:
+        """Handle connection made event."""
         self.logger.debug("Connection established, send discover telegram.")
-        self.send_telegram(
+        self.conbus_protocol.send_telegram(
             telegram_type=TelegramType.SYSTEM,
             serial_number="0000000000",
             system_function=SystemFunction.DISCOVERY,
             data_value="00",
         )
-        if self.progress_callback:
-            self.progress_callback(".")
+        self.on_progress.emit(".")
 
     def send_blink(self, serial_number: str) -> None:
         """Send blink or unblink telegram to a discovered module.
@@ -81,7 +89,7 @@ class ConbusBlinkAllService(ConbusProtocol):
         if self.on_or_off.lower() == "on":
             system_function = SystemFunction.BLINK
 
-        self.send_telegram(
+        self.conbus_protocol.send_telegram(
             telegram_type=TelegramType.SYSTEM,
             serial_number=serial_number,
             system_function=system_function,
@@ -90,8 +98,7 @@ class ConbusBlinkAllService(ConbusProtocol):
         self.service_response.system_function = system_function
         self.service_response.operation = self.on_or_off
 
-        if self.progress_callback:
-            self.progress_callback(".")
+        self.on_progress.emit(".")
 
     def telegram_sent(self, telegram_sent: str) -> None:
         """Handle telegram sent event.
@@ -129,8 +136,7 @@ class ConbusBlinkAllService(ConbusProtocol):
         ):
             self.logger.debug("Received discovery response")
             self.send_blink(reply_telegram.serial_number)
-            if self.progress_callback:
-                self.progress_callback(".")
+            self.on_progress.emit(".")
             return
 
         if reply_telegram and reply_telegram.system_function in (
@@ -138,12 +144,18 @@ class ConbusBlinkAllService(ConbusProtocol):
             SystemFunction.UNBLINK,
         ):
             self.logger.debug("Received blink response")
-            if self.progress_callback:
-                self.progress_callback(".")
+            self.on_progress.emit(".")
             return
 
         self.logger.debug("Received unexpected response")
 
+    def timeout(self) -> None:
+        """Handle timeout event to stop operation."""
+        self.logger.info("Blink all operation timeout")
+        self.service_response.success = False
+        self.service_response.error = "Blink all operation timeout"
+        self.on_finish.emit(self.service_response)
+
     def failed(self, message: str) -> None:
         """Handle failed connection event.
 
@@ -154,28 +166,70 @@ class ConbusBlinkAllService(ConbusProtocol):
         self.service_response.success = False
         self.service_response.timestamp = datetime.now()
         self.service_response.error = message
-        if self.finish_callback:
-            self.finish_callback(self.service_response)
+        self.on_finish.emit(self.service_response)
 
     def send_blink_all_telegram(
         self,
         on_or_off: str,
-        progress_callback: Callable[[str], None],
-        finish_callback: Callable[[ConbusBlinkResponse], None],
         timeout_seconds: Optional[float] = None,
     ) -> None:
         """Send blink command to all discovered modules.
 
         Args:
             on_or_off: "on" to blink or "off" to unblink all devices.
-            progress_callback: Callback function to call with progress updates.
-            finish_callback: Callback function to call when the operation completes.
             timeout_seconds: Timeout in seconds.
         """
         self.logger.info("Starting send_blink_all_telegram")
         if timeout_seconds:
-            self.timeout_seconds = timeout_seconds
-        self.progress_callback = progress_callback
-        self.finish_callback = finish_callback
+            self.conbus_protocol.timeout_seconds = timeout_seconds
         self.on_or_off = on_or_off
-        self.start_reactor()
+        # Caller invokes start_reactor()
+
+    def set_timeout(self, timeout_seconds: float) -> None:
+        """Set operation timeout.
+
+        Args:
+            timeout_seconds: Timeout in seconds.
+        """
+        self.conbus_protocol.timeout_seconds = timeout_seconds
+
+    def start_reactor(self) -> None:
+        """Start the reactor."""
+        self.conbus_protocol.start_reactor()
+
+    def stop_reactor(self) -> None:
+        """Stop the reactor."""
+        self.conbus_protocol.stop_reactor()
+
+    def __enter__(self) -> "ConbusBlinkAllService":
+        """Enter context manager - reset state for singleton reuse.
+
+        Returns:
+            Self for context manager protocol.
+        """
+        # Reset state for singleton reuse
+        self.service_response = ConbusBlinkResponse(
+            success=False,
+            serial_number="",
+            system_function=SystemFunction.NONE,
+            operation="none",
+        )
+        self.serial_number = ""
+        self.on_or_off = "none"
+        return self
+
+    def __exit__(
+        self, _exc_type: Optional[type], _exc_val: Optional[Exception], _exc_tb: Any
+    ) -> None:
+        """Exit context manager - cleanup signals and reactor."""
+        # Disconnect protocol signals
+        self.conbus_protocol.on_connection_made.disconnect(self.connection_made)
+        self.conbus_protocol.on_telegram_sent.disconnect(self.telegram_sent)
+        self.conbus_protocol.on_telegram_received.disconnect(self.telegram_received)
+        self.conbus_protocol.on_timeout.disconnect(self.timeout)
+        self.conbus_protocol.on_failed.disconnect(self.failed)
+        # Disconnect service signals
+        self.on_progress.disconnect()
+        self.on_finish.disconnect()
+        # Stop reactor
+        self.stop_reactor()

{conson_xp-1.32.0 → conson_xp-1.34.0}/src/xp/services/conbus/conbus_blink_service.py

@@ -6,45 +6,46 @@ blink/unblink telegrams to control module LED indicators.
 
 import logging
 from datetime import datetime
-from typing import Callable, Optional
+from typing import Any, Optional
 
-from twisted.internet.posixbase import PosixReactorBase
+from psygnal import Signal
 
-from xp.models import ConbusClientConfig
 from xp.models.conbus.conbus_blink import ConbusBlinkResponse
 from xp.models.protocol.conbus_protocol import TelegramReceivedEvent
 from xp.models.telegram.system_function import SystemFunction
 from xp.models.telegram.telegram_type import TelegramType
-from xp.services.protocol import ConbusProtocol
+from xp.services.protocol.conbus_event_protocol import ConbusEventProtocol
 from xp.services.telegram.telegram_service import TelegramService
 
 
-class ConbusBlinkService(ConbusProtocol):
+class ConbusBlinkService:
     """
     Service for blinking module LEDs on Conbus servers.
 
-    Uses ConbusProtocol to provide blink/unblink functionality
+    Uses ConbusEventProtocol to provide blink/unblink functionality
     for controlling module LED indicators.
+
+    Attributes:
+        on_finish: Signal emitted when blink operation completes (with response).
     """
 
+    on_finish: Signal = Signal(ConbusBlinkResponse)
+
     def __init__(
         self,
+        conbus_protocol: ConbusEventProtocol,
         telegram_service: TelegramService,
-        cli_config: ConbusClientConfig,
-        reactor: PosixReactorBase,
     ) -> None:
         """Initialize the Conbus blink service.
 
         Args:
+            conbus_protocol: ConbusEventProtocol instance for communication.
             telegram_service: Service for parsing telegrams.
-            cli_config: Configuration for Conbus client connection.
-            reactor: Twisted reactor for event loop.
         """
-        super().__init__(cli_config, reactor)
+        self.conbus_protocol = conbus_protocol
         self.telegram_service = telegram_service
         self.serial_number: str = ""
         self.on_or_off = "none"
-        self.finish_callback: Optional[Callable[[ConbusBlinkResponse], None]] = None
         self.service_response: ConbusBlinkResponse = ConbusBlinkResponse(
             success=False,
             serial_number=self.serial_number,
@@ -55,15 +56,22 @@ class ConbusBlinkService(ConbusProtocol):
         # Set up logging
         self.logger = logging.getLogger(__name__)
 
-    def connection_established(self) -> None:
-        """Handle connection established event."""
+        # Connect signals
+        self.conbus_protocol.on_connection_made.connect(self.connection_made)
+        self.conbus_protocol.on_telegram_sent.connect(self.telegram_sent)
+        self.conbus_protocol.on_telegram_received.connect(self.telegram_received)
+        self.conbus_protocol.on_timeout.connect(self.timeout)
+        self.conbus_protocol.on_failed.connect(self.failed)
+
+    def connection_made(self) -> None:
+        """Handle connection made event."""
         self.logger.debug("Connection established, sending blink command.")
         # Blink is 05, Unblink is 06
         system_function = SystemFunction.UNBLINK
         if self.on_or_off.lower() == "on":
             system_function = SystemFunction.BLINK
 
-        self.send_telegram(
+        self.conbus_protocol.send_telegram(
             telegram_type=TelegramType.SYSTEM,
             serial_number=self.serial_number,
             system_function=system_function,
@@ -113,8 +121,14 @@ class ConbusBlinkService(ConbusProtocol):
             self.service_response.serial_number = self.serial_number
             self.service_response.reply_telegram = reply_telegram
 
-            if self.finish_callback:
-                self.finish_callback(self.service_response)
+            self.on_finish.emit(self.service_response)
+
+    def timeout(self) -> None:
+        """Handle timeout event to stop operation."""
+        self.logger.info("Blink operation timeout")
+        self.service_response.success = False
+        self.service_response.error = "Blink operation timeout"
+        self.on_finish.emit(self.service_response)
 
     def failed(self, message: str) -> None:
         """Handle failed connection event.
@@ -126,14 +140,12 @@ class ConbusBlinkService(ConbusProtocol):
         self.service_response.success = False
         self.service_response.timestamp = datetime.now()
         self.service_response.error = message
-        if self.finish_callback:
-            self.finish_callback(self.service_response)
+        self.on_finish.emit(self.service_response)
 
     def send_blink_telegram(
         self,
         serial_number: str,
         on_or_off: str,
-        finish_callback: Callable[[ConbusBlinkResponse], None],
         timeout_seconds: Optional[float] = None,
     ) -> None:
         r"""Send blink command to start blinking module LED.
@@ -141,7 +153,6 @@ class ConbusBlinkService(ConbusProtocol):
         Args:
             serial_number: 10-digit module serial number.
             on_or_off: "on" to blink or "off" to unblink.
-            finish_callback: Callback function to call when the reply is received.
             timeout_seconds: Timeout in seconds.
 
         Examples:
@@ -151,8 +162,55 @@ class ConbusBlinkService(ConbusProtocol):
         """
         self.logger.info("Starting send_blink_telegram")
         if timeout_seconds:
-            self.timeout_seconds = timeout_seconds
-        self.finish_callback = finish_callback
+            self.conbus_protocol.timeout_seconds = timeout_seconds
         self.serial_number = serial_number
         self.on_or_off = on_or_off
-        self.start_reactor()
+        # Caller invokes start_reactor()
+
+    def set_timeout(self, timeout_seconds: float) -> None:
+        """Set operation timeout.
+
+        Args:
+            timeout_seconds: Timeout in seconds.
+        """
+        self.conbus_protocol.timeout_seconds = timeout_seconds
+
+    def start_reactor(self) -> None:
+        """Start the reactor."""
+        self.conbus_protocol.start_reactor()
+
+    def stop_reactor(self) -> None:
+        """Stop the reactor."""
+        self.conbus_protocol.stop_reactor()
+
+    def __enter__(self) -> "ConbusBlinkService":
+        """Enter context manager - reset state for singleton reuse.
+
+        Returns:
+            Self for context manager protocol.
+        """
+        # Reset state for singleton reuse
+        self.service_response = ConbusBlinkResponse(
+            success=False,
+            serial_number="",
+            system_function=SystemFunction.NONE,
+            operation="none",
+        )
+        self.serial_number = ""
+        self.on_or_off = "none"
+        return self
+
+    def __exit__(
+        self, _exc_type: Optional[type], _exc_val: Optional[Exception], _exc_tb: Any
+    ) -> None:
+        """Exit context manager - cleanup signals and reactor."""
+        # Disconnect protocol signals
+        self.conbus_protocol.on_connection_made.disconnect(self.connection_made)
+        self.conbus_protocol.on_telegram_sent.disconnect(self.telegram_sent)
+        self.conbus_protocol.on_telegram_received.disconnect(self.telegram_received)
+        self.conbus_protocol.on_timeout.disconnect(self.timeout)
+        self.conbus_protocol.on_failed.disconnect(self.failed)
+        # Disconnect service signals
+        self.on_finish.disconnect()
+        # Stop reactor
+        self.stop_reactor()