conson-xp 1.34.0__py3-none-any.whl → 1.35.0__py3-none-any.whl

xp/services/conbus/conbus_scan_service.py

@@ -6,43 +6,50 @@ telegrams to scan modules for all datapoints by function code.
 
 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,
-    ConbusResponse,
-)
+from xp.models import ConbusResponse
 from xp.models.protocol.conbus_protocol import TelegramReceivedEvent
-from xp.services.protocol import ConbusProtocol
+from xp.services.protocol.conbus_event_protocol import ConbusEventProtocol
 
 
-class ConbusScanService(ConbusProtocol):
+class ConbusScanService:
     """
     Service for scanning modules for all datapoints by function code.
 
-    Uses ConbusProtocol to provide scan functionality for discovering
+    Uses ConbusEventProtocol to provide scan functionality for discovering
     all available datapoints on a module.
+
+    Attributes:
+        conbus_protocol: Protocol instance for Conbus communication.
+        on_progress: Signal emitted when scan progress is made (with telegram frame).
+        on_finish: Signal emitted when scan finishes (with result).
     """
 
+    on_progress: Signal = Signal(str)
+    on_finish: Signal = Signal(ConbusResponse)
+
     def __init__(
         self,
-        cli_config: ConbusClientConfig,
-        reactor: PosixReactorBase,
+        conbus_protocol: ConbusEventProtocol,
     ) -> None:
         """Initialize the Conbus scan service.
 
         Args:
-            cli_config: Conbus client configuration.
-            reactor: Twisted reactor instance.
+            conbus_protocol: ConbusEventProtocol instance.
         """
-        super().__init__(cli_config, reactor)
+        self.conbus_protocol = conbus_protocol
+        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)
+
         self.serial_number: str = ""
         self.function_code: str = ""
         self.datapoint_value: int = -1
-        self.progress_callback: Optional[Callable[[str], None]] = None
-        self.finish_callback: Optional[Callable[[ConbusResponse], None]] = None
         self.service_response: ConbusResponse = ConbusResponse(
             success=False,
             serial_number=self.serial_number,
@@ -53,8 +60,8 @@ class ConbusScanService(ConbusProtocol):
         # Set up logging
         self.logger = logging.getLogger(__name__)
 
-    def connection_established(self) -> None:
-        """Handle connection established event."""
+    def connection_made(self) -> None:
+        """Handle connection made event."""
         self.logger.debug("Connection established, starting scan")
         self.scan_next_datacode()
 
@@ -66,14 +73,13 @@ class ConbusScanService(ConbusProtocol):
         """
         self.datapoint_value += 1
         if self.datapoint_value >= 100:
-            if self.finish_callback:
-                self.finish_callback(self.service_response)
+            self.on_finish.emit(self.service_response)
             return False
 
         self.logger.debug(f"Scanning next datacode: {self.datapoint_value:02d}")
         data = f"{self.datapoint_value:02d}"
         telegram_body = f"S{self.serial_number}F{self.function_code}D{data}"
-        self.sendFrame(telegram_body.encode())
+        self.conbus_protocol.sendFrame(telegram_body.encode())
         return True
 
     def telegram_sent(self, telegram_sent: str) -> None:
@@ -96,18 +102,13 @@ class ConbusScanService(ConbusProtocol):
             self.service_response.received_telegrams = []
         self.service_response.received_telegrams.append(telegram_received.frame)
 
-        if self.progress_callback:
-            self.progress_callback(telegram_received.frame)
-
-    def timeout(self) -> bool:
-        """Handle timeout event by scanning next data code.
+        self.on_progress.emit(telegram_received.frame)
 
-        Returns:
-            True to continue scanning, False to stop.
-        """
-        self.logger.debug(f"Timeout: {self.timeout_seconds}s")
-        continue_scan = self.scan_next_datacode()
-        return continue_scan
+    def timeout(self) -> None:
+        """Handle timeout event by scanning next data code."""
+        timeout_seconds = self.conbus_protocol.timeout_seconds
+        self.logger.debug(f"Timeout: {timeout_seconds}s")
+        self.scan_next_datacode()
 
     def failed(self, message: str) -> None:
         """Handle failed connection event.
@@ -119,15 +120,12 @@ class ConbusScanService(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 scan_module(
         self,
         serial_number: str,
         function_code: str,
-        progress_callback: Callable[[str], None],
-        finish_callback: Callable[[ConbusResponse], None],
         timeout_seconds: float = 0.25,
     ) -> None:
         """Scan a module for all datapoints by function code.
@@ -135,16 +133,62 @@ class ConbusScanService(ConbusProtocol):
         Args:
             serial_number: 10-digit module serial number.
             function_code: The function code to scan.
-            progress_callback: Callback to handle progress.
-            finish_callback: Callback function to call when the scan is complete.
             timeout_seconds: Timeout in seconds.
         """
         self.logger.info("Starting scan_module")
         if timeout_seconds:
-            self.timeout_seconds = timeout_seconds
+            self.conbus_protocol.timeout_seconds = timeout_seconds
 
         self.serial_number = serial_number
         self.function_code = function_code
-        self.progress_callback = progress_callback
-        self.finish_callback = finish_callback
-        self.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) -> "ConbusScanService":
+        """Enter context manager - reset state for singleton reuse.
+
+        Returns:
+            Self for context manager protocol.
+        """
+        # Reset state for singleton reuse
+        self.serial_number = ""
+        self.function_code = ""
+        self.datapoint_value = -1
+        self.service_response = ConbusResponse(
+            success=False,
+            serial_number="",
+            sent_telegrams=[],
+            received_telegrams=[],
+            timestamp=datetime.now(),
+        )
+        return self
+
+    def __exit__(
+        self, _exc_type: Optional[type], _exc_val: Optional[Exception], _exc_tb: Any
+    ) -> None:
+        """Exit context manager and disconnect signals."""
+        # 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()

xp/services/conbus/write_config_service.py

@@ -5,49 +5,49 @@ This service handles setting link numbers for modules through Conbus telegrams.
 
 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_writeconfig import ConbusWriteConfigResponse
 from xp.models.protocol.conbus_protocol import TelegramReceivedEvent
 from xp.models.telegram.datapoint_type import DataPointType
 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 WriteConfigService(ConbusProtocol):
-    """
-    Service for writing module settings via Conbus telegrams.
+class WriteConfigService:
+    """Service for writing module settings via Conbus telegrams.
 
     Handles setting assignment by sending F04DXX telegrams and processing
     ACK/NAK responses from modules.
+
+    Attributes:
+        conbus_protocol: Protocol for Conbus communication.
+        telegram_service: Service for parsing telegrams.
+        on_finish: Signal emitted when write operation completes (with response).
     """
 
+    on_finish: Signal = Signal(ConbusWriteConfigResponse)
+
     def __init__(
         self,
+        conbus_protocol: ConbusEventProtocol,
         telegram_service: TelegramService,
-        cli_config: ConbusClientConfig,
-        reactor: PosixReactorBase,
     ) -> None:
         """Initialize the Conbus link number set service.
 
         Args:
+            conbus_protocol: Protocol for Conbus 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.datapoint_type: Optional[DataPointType] = None
         self.serial_number: str = ""
         self.data_value: str = ""
-        self.write_config_finished_callback: Optional[
-            Callable[[ConbusWriteConfigResponse], None]
-        ] = None
         self.write_config_response: ConbusWriteConfigResponse = (
             ConbusWriteConfigResponse(
                 success=False,
@@ -58,8 +58,15 @@ class WriteConfigService(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(f"Connection established, writing config {self.data_value}.")
 
         # Validate parameters before sending
@@ -79,7 +86,7 @@ class WriteConfigService(ConbusProtocol):
         # Function F04 = WRITE_CONFIG,
         # Datapoint = D datapoint_type
         # Data = XX
-        self.send_telegram(
+        self.conbus_protocol.send_telegram(
             telegram_type=TelegramType.SYSTEM,
             serial_number=self.serial_number,
             system_function=SystemFunction.WRITE_CONFIG,
@@ -133,6 +140,11 @@ class WriteConfigService(ConbusProtocol):
             succeed_or_failed=succeed, system_function=reply_telegram.system_function
         )
 
+    def timeout(self) -> None:
+        """Handle timeout event."""
+        self.logger.debug("Timeout occurred")
+        self.finished(succeed_or_failed=False, message="Timeout")
+
     def failed(self, message: str) -> None:
         """Handle telegram failed event.
 
@@ -163,16 +175,15 @@ class WriteConfigService(ConbusProtocol):
         self.write_config_response.system_function = system_function
         self.write_config_response.datapoint_type = self.datapoint_type
         self.write_config_response.data_value = self.data_value
-        if self.write_config_finished_callback:
-            self.write_config_finished_callback(self.write_config_response)
-        self._stop_reactor()
+
+        # Emit finish signal
+        self.on_finish.emit(self.write_config_response)
 
     def write_config(
         self,
         serial_number: str,
         datapoint_type: DataPointType,
         data_value: str,
-        finish_callback: Callable[[ConbusWriteConfigResponse], None],
         timeout_seconds: Optional[float] = None,
     ) -> None:
         """Write config to a specific module.
@@ -181,14 +192,53 @@ class WriteConfigService(ConbusProtocol):
             serial_number: 10-digit module serial number.
             datapoint_type: the datapoint type to write to.
             data_value: the data to write.
-            finish_callback: Callback function to call when operation completes.
             timeout_seconds: Optional timeout in seconds.
         """
         self.logger.info("Starting write_config")
         if timeout_seconds:
-            self.timeout_seconds = timeout_seconds
+            self.conbus_protocol.timeout_seconds = timeout_seconds
         self.serial_number = serial_number
         self.datapoint_type = datapoint_type
         self.data_value = data_value
-        self.write_config_finished_callback = finish_callback
-        self.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) -> "WriteConfigService":
+        """Enter context manager - reset state for singleton reuse.
+
+        Returns:
+            Self for context manager protocol.
+        """
+        self.write_config_response = ConbusWriteConfigResponse(
+            success=False, serial_number=""
+        )
+        self.datapoint_type = None
+        self.serial_number = ""
+        self.data_value = ""
+        return self
+
+    def __exit__(
+        self, _exc_type: Optional[type], _exc_val: Optional[Exception], _exc_tb: Any
+    ) -> None:
+        """Exit context manager and disconnect 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)
+        self.on_finish.disconnect()
+        self.stop_reactor()

xp/utils/dependencies.py

@@ -159,9 +159,8 @@ class ServiceContainer:
         self.container.register(
             ConbusDatapointService,
             factory=lambda: ConbusDatapointService(
+                conbus_protocol=self.container.resolve(ConbusEventProtocol),
                 telegram_service=self.container.resolve(TelegramService),
-                cli_config=self.container.resolve(ConbusClientConfig),
-                reactor=self.container.resolve(PosixReactorBase),
             ),
             scope=punq.Scope.singleton,
         )
@@ -169,9 +168,8 @@ class ServiceContainer:
         self.container.register(
             ConbusDatapointQueryAllService,
             factory=lambda: ConbusDatapointQueryAllService(
+                conbus_protocol=self.container.resolve(ConbusEventProtocol),
                 telegram_service=self.container.resolve(TelegramService),
-                cli_config=self.container.resolve(ConbusClientConfig),
-                reactor=self.container.resolve(PosixReactorBase),
             ),
             scope=punq.Scope.singleton,
         )
@@ -179,8 +177,7 @@ class ServiceContainer:
         self.container.register(
             ConbusScanService,
             factory=lambda: ConbusScanService(
-                cli_config=self.container.resolve(ConbusClientConfig),
-                reactor=self.container.resolve(PosixReactorBase),
+                conbus_protocol=self.container.resolve(ConbusEventProtocol),
             ),
             scope=punq.Scope.singleton,
         )
@@ -283,9 +280,8 @@ class ServiceContainer:
         self.container.register(
             ConbusOutputService,
             factory=lambda: ConbusOutputService(
+                conbus_protocol=self.container.resolve(ConbusEventProtocol),
                 telegram_output_service=self.container.resolve(TelegramOutputService),
-                cli_config=self.container.resolve(ConbusClientConfig),
-                reactor=self.container.resolve(PosixReactorBase),
             ),
             scope=punq.Scope.singleton,
         )
@@ -293,9 +289,8 @@ class ServiceContainer:
         self.container.register(
             WriteConfigService,
             factory=lambda: WriteConfigService(
+                conbus_protocol=self.container.resolve(ConbusEventProtocol),
                 telegram_service=self.container.resolve(TelegramService),
-                cli_config=self.container.resolve(ConbusClientConfig),
-                reactor=self.container.resolve(PosixReactorBase),
             ),
             scope=punq.Scope.singleton,
         )
@@ -309,8 +304,7 @@ class ServiceContainer:
         self.container.register(
             ActionTableService,
             factory=lambda: ActionTableService(
-                cli_config=self.container.resolve(ConbusClientConfig),
-                reactor=self.container.resolve(PosixReactorBase),
+                conbus_protocol=self.container.resolve(ConbusEventProtocol),
                 actiontable_serializer=self.container.resolve(ActionTableSerializer),
                 telegram_service=self.container.resolve(TelegramService),
             ),
@@ -320,8 +314,7 @@ class ServiceContainer:
         self.container.register(
             ActionTableUploadService,
             factory=lambda: ActionTableUploadService(
-                cli_config=self.container.resolve(ConbusClientConfig),
-                reactor=self.container.resolve(PosixReactorBase),
+                conbus_protocol=self.container.resolve(ConbusEventProtocol),
                 actiontable_serializer=self.container.resolve(ActionTableSerializer),
                 telegram_service=self.container.resolve(TelegramService),
                 conson_config=self.container.resolve(ConsonModuleListConfig),
@@ -362,8 +355,7 @@ class ServiceContainer:
         self.container.register(
             MsActionTableService,
             factory=lambda: MsActionTableService(
-                cli_config=self.container.resolve(ConbusClientConfig),
-                reactor=self.container.resolve(PosixReactorBase),
+                conbus_protocol=self.container.resolve(ConbusEventProtocol),
                 xp20ms_serializer=self.container.resolve(Xp20MsActionTableSerializer),
                 xp24ms_serializer=self.container.resolve(Xp24MsActionTableSerializer),
                 xp33ms_serializer=self.container.resolve(Xp33MsActionTableSerializer),
@@ -375,9 +367,8 @@ class ServiceContainer:
         self.container.register(
             ConbusCustomService,
             factory=lambda: ConbusCustomService(
+                conbus_protocol=self.container.resolve(ConbusEventProtocol),
                 telegram_service=self.container.resolve(TelegramService),
-                cli_config=self.container.resolve(ConbusClientConfig),
-                reactor=self.container.resolve(PosixReactorBase),
             ),
             scope=punq.Scope.singleton,
         )
@@ -385,8 +376,7 @@ class ServiceContainer:
         self.container.register(
             ConbusRawService,
             factory=lambda: ConbusRawService(
-                cli_config=self.container.resolve(ConbusClientConfig),
-                reactor=self.container.resolve(PosixReactorBase),
+                conbus_protocol=self.container.resolve(ConbusEventProtocol),
             ),
             scope=punq.Scope.singleton,
         )