conson-xp 1.45.0__py3-none-any.whl → 1.47.0__py3-none-any.whl

xp/services/conbus/conbus_event_raw_service.py

@@ -1,7 +1,8 @@
-"""Conbus Event Raw Service for sending raw event telegrams.
+"""
+Conbus Event Raw Service for sending raw event telegrams.
 
-This service implements a TCP client that connects to Conbus servers and sends
-raw event telegrams to simulate button presses on Conbus modules.
+This service implements a TCP client that connects to Conbus servers and sends raw event
+telegrams to simulate button presses on Conbus modules.
 """
 
 import logging
@@ -15,7 +16,8 @@ from xp.services.protocol.conbus_event_protocol import ConbusEventProtocol
 
 
 class ConbusEventRawService:
-    """Service for sending raw event telegrams to Conbus servers.
+    """
+    Service for sending raw event telegrams to Conbus servers.
 
     Uses ConbusEventProtocol to send MAKE/BREAK event sequences to
     simulate button presses on Conbus modules.
@@ -27,7 +29,8 @@ class ConbusEventRawService:
     conbus_protocol: ConbusEventProtocol
 
     def __init__(self, conbus_protocol: ConbusEventProtocol) -> None:
-        """Initialize the Conbus event raw service.
+        """
+        Initialize the Conbus event raw service.
 
         Args:
             conbus_protocol: ConbusEventProtocol instance.
@@ -79,7 +82,8 @@ class ConbusEventRawService:
         self.conbus_protocol.call_later(0.0, self.conbus_protocol.start_queue_manager)
 
     def telegram_sent(self, telegram_sent: str) -> None:
-        """Handle telegram sent event.
+        """
+        Handle telegram sent event.
 
         Args:
             telegram_sent: The telegram that was sent.
@@ -90,7 +94,8 @@ class ConbusEventRawService:
         self.event_result.sent_telegrams.append(telegram_sent)
 
     def telegram_received(self, telegram_received: TelegramReceivedEvent) -> None:
-        """Handle telegram received event.
+        """
+        Handle telegram received event.
 
         Args:
             telegram_received: The telegram received event.
@@ -105,7 +110,8 @@ class ConbusEventRawService:
             self.progress_callback(telegram_received.frame)
 
     def timeout(self) -> None:
-        """Handle timeout event.
+        """
+        Handle timeout event.
 
         Timeout is the normal/expected way to finish this service.
         """
@@ -119,7 +125,8 @@ class ConbusEventRawService:
         self.stop_reactor()
 
     def failed(self, message: str) -> None:
-        """Handle failed connection event.
+        """
+        Handle failed connection event.
 
         Args:
             message: Failure message.
@@ -155,7 +162,8 @@ class ConbusEventRawService:
         finish_callback: Callable[[ConbusEventRawResponse], None],
         timeout_seconds: int = 5,
     ) -> None:
-        """Run reactor in dedicated thread with its own event loop.
+        """
+        Run reactor in dedicated thread with its own event loop.
 
         Args:
             module_type_code: Module type code (numeric, e.g., 2 for CP20, 33 for XP33).

xp/services/conbus/conbus_export_service.py

@@ -23,7 +23,8 @@ from xp.services.telegram.telegram_service import TelegramService
 
 
 class ConbusExportService:
-    """Service for exporting Conbus device configurations.
+    """
+    Service for exporting Conbus device configurations.
 
     Discovers all devices on the Conbus network and queries their configuration
     datapoints to generate a structured export file compatible with conson.yml format.
@@ -57,7 +58,8 @@ class ConbusExportService:
     ]
 
     def __init__(self, conbus_protocol: ConbusEventProtocol) -> None:
-        """Initialize the Conbus export service.
+        """
+        Initialize the Conbus export service.
 
         Args:
             conbus_protocol: Protocol for Conbus communication.
@@ -93,7 +95,8 @@ class ConbusExportService:
         )
 
     def telegram_sent(self, telegram: str) -> None:
-        """Handle telegram sent event.
+        """
+        Handle telegram sent event.
 
         Args:
             telegram: Telegram that was sent.
@@ -101,7 +104,8 @@ class ConbusExportService:
         self.export_result.sent_telegrams.append(telegram)
 
     def telegram_received(self, event: TelegramReceivedEvent) -> None:
-        """Handle telegram received event.
+        """
+        Handle telegram received event.
 
         Args:
             event: Telegram received event.
@@ -133,7 +137,8 @@ class ConbusExportService:
                 )
 
     def _handle_discovery_response(self, serial_number: str) -> None:
-        """Handle discovery response and query all datapoints.
+        """
+        Handle discovery response and query all datapoints.
 
         Args:
             serial_number: Serial number of discovered device.
@@ -175,7 +180,8 @@ class ConbusExportService:
     def _handle_datapoint_response(
         self, serial_number: str, datapoint_code: str, value: str
     ) -> None:
-        """Handle datapoint response and store value.
+        """
+        Handle datapoint response and store value.
 
         Args:
             serial_number: Serial number of device.
@@ -201,7 +207,8 @@ class ConbusExportService:
     def _store_datapoint_value(
         self, serial_number: str, datapoint: DataPointType, value: str
     ) -> None:
-        """Store datapoint value in device config.
+        """
+        Store datapoint value in device config.
 
         Args:
             serial_number: Serial number of device.
@@ -231,7 +238,8 @@ class ConbusExportService:
             self.logger.warning(f"Invalid value '{value}' for {datapoint.name}: {e}")
 
     def _is_device_complete(self, serial_number: str) -> bool:
-        """Check if a device has all required datapoints.
+        """
+        Check if a device has all required datapoints.
 
         Args:
             serial_number: Serial number of device.
@@ -253,7 +261,8 @@ class ConbusExportService:
         )
 
     def _check_device_complete(self, serial_number: str) -> None:
-        """Check if device has all datapoints and emit completion signal.
+        """
+        Check if device has all datapoints and emit completion signal.
 
         Args:
             serial_number: Serial number of device.
@@ -313,7 +322,8 @@ class ConbusExportService:
             self.on_finish.emit(self.export_result)
 
     def _write_export_file(self, path: str) -> None:
-        """Write export to YAML file.
+        """
+        Write export to YAML file.
 
         Args:
             path: Output file path.
@@ -385,7 +395,8 @@ class ConbusExportService:
         self._finalize_export()
 
     def failed(self, message: str) -> None:
-        """Handle connection failure event.
+        """
+        Handle connection failure event.
 
         Args:
             message: Failure message.
@@ -398,7 +409,8 @@ class ConbusExportService:
         self.on_finish.emit(self.export_result)
 
     def set_timeout(self, timeout_seconds: float) -> None:
-        """Set timeout for export operation.
+        """
+        Set timeout for export operation.
 
         Args:
             timeout_seconds: Timeout in seconds.
@@ -407,7 +419,8 @@ class ConbusExportService:
         self.conbus_protocol.timeout_seconds = timeout_seconds
 
     def set_event_loop(self, event_loop: asyncio.AbstractEventLoop) -> None:
-        """Set event loop for async operations.
+        """
+        Set event loop for async operations.
 
         Args:
             event_loop: Event loop to use.
@@ -424,7 +437,8 @@ class ConbusExportService:
         self.conbus_protocol.stop_reactor()
 
     def __enter__(self) -> "ConbusExportService":
-        """Enter context manager.
+        """
+        Enter context manager.
 
         Returns:
             Self for context manager protocol.

xp/services/conbus/conbus_output_service.py

@@ -1,7 +1,8 @@
-"""Conbus Output Service for sending action telegrams to Conbus modules.
+"""
+Conbus Output Service for sending action telegrams to Conbus modules.
 
-This service handles sending action telegrams (ON/OFF) to module outputs
-and processing ACK/NAK responses.
+This service handles sending action telegrams (ON/OFF) to module outputs and processing
+ACK/NAK responses.
 """
 
 import logging
@@ -49,7 +50,8 @@ class ConbusOutputService:
         conbus_protocol: ConbusEventProtocol,
         telegram_output_service: TelegramOutputService,
     ):
-        """Initialize the Conbus output service.
+        """
+        Initialize the Conbus output service.
 
         Args:
             conbus_protocol: ConbusEventProtocol for communication.
@@ -105,7 +107,8 @@ class ConbusOutputService:
         )
 
     def telegram_sent(self, telegram_sent: str) -> None:
-        """Handle telegram sent event.
+        """
+        Handle telegram sent event.
 
         Args:
             telegram_sent: The telegram that was sent.
@@ -113,7 +116,8 @@ class ConbusOutputService:
         self.service_response.sent_telegram = telegram_sent
 
     def telegram_received(self, telegram_received: TelegramReceivedEvent) -> None:
-        """Handle telegram received event.
+        """
+        Handle telegram received event.
 
         Args:
             telegram_received: The telegram received event.
@@ -149,7 +153,8 @@ class ConbusOutputService:
             )
 
     def succeed(self, output_telegram: OutputTelegram) -> None:
-        """Handle successful output action.
+        """
+        Handle successful output action.
 
         Args:
             output_telegram: The output telegram received as response.
@@ -169,7 +174,8 @@ class ConbusOutputService:
         self.failed("Timeout")
 
     def failed(self, message: str) -> None:
-        """Handle failed connection event.
+        """
+        Handle failed connection event.
 
         Args:
             message: Failure message.
@@ -190,7 +196,8 @@ class ConbusOutputService:
         action_type: ActionType,
         timeout_seconds: Optional[float] = None,
     ) -> None:
-        """Send an action telegram to a module output.
+        """
+        Send an action telegram to a module output.
 
         Args:
             serial_number: 10-digit module serial number.
@@ -206,7 +213,8 @@ class ConbusOutputService:
         self.action_type = action_type
 
     def set_timeout(self, timeout_seconds: float) -> None:
-        """Set operation timeout.
+        """
+        Set operation timeout.
 
         Args:
             timeout_seconds: Timeout in seconds.

xp/services/conbus/conbus_raw_service.py

@@ -1,4 +1,5 @@
-"""Conbus Raw Service for sending raw telegram sequences.
+"""
+Conbus Raw Service for sending raw telegram sequences.
 
 This service handles sending raw telegram strings without prior validation.
 """
@@ -35,7 +36,8 @@ class ConbusRawService:
         self,
         conbus_protocol: ConbusEventProtocol,
     ) -> None:
-        """Initialize the Conbus raw service.
+        """
+        Initialize the Conbus raw service.
 
         Args:
             conbus_protocol: ConbusEventProtocol instance.
@@ -62,7 +64,8 @@ class ConbusRawService:
         self.conbus_protocol.send_raw_telegram(self.raw_input)
 
     def telegram_sent(self, telegram_sent: str) -> None:
-        """Handle telegram sent event.
+        """
+        Handle telegram sent event.
 
         Args:
             telegram_sent: The telegram that was sent.
@@ -73,7 +76,8 @@ class ConbusRawService:
         self.service_response.received_telegrams = []
 
     def telegram_received(self, telegram_received: TelegramReceivedEvent) -> None:
-        """Handle telegram received event.
+        """
+        Handle telegram received event.
 
         Args:
             telegram_received: The telegram received event.
@@ -92,7 +96,8 @@ class ConbusRawService:
         self.on_finish.emit(self.service_response)
 
     def failed(self, message: str) -> None:
-        """Handle failed connection event.
+        """
+        Handle failed connection event.
 
         Args:
             message: Failure message.
@@ -108,7 +113,8 @@ class ConbusRawService:
         raw_input: str,
         timeout_seconds: Optional[float] = None,
     ) -> None:
-        """Send a raw telegram string to the Conbus server.
+        """
+        Send a raw telegram string to the Conbus server.
 
         Args:
             raw_input: Raw telegram string to send.
@@ -120,7 +126,8 @@ class ConbusRawService:
         self.raw_input = raw_input
 
     def set_timeout(self, timeout_seconds: float) -> None:
-        """Set operation timeout.
+        """
+        Set operation timeout.
 
         Args:
             timeout_seconds: Timeout in seconds.
@@ -136,7 +143,8 @@ class ConbusRawService:
         self.conbus_protocol.stop_reactor()
 
     def __enter__(self) -> "ConbusRawService":
-        """Enter context manager.
+        """
+        Enter context manager.
 
         Returns:
             Self for context manager protocol.

xp/services/conbus/conbus_receive_service.py

@@ -1,7 +1,8 @@
-"""Conbus Receive Service for receiving telegrams from Conbus servers.
+"""
+Conbus Receive Service for receiving telegrams from Conbus servers.
 
-This service uses ConbusEventProtocol to provide receive-only functionality,
-allowing clients to receive waiting event telegrams using empty telegram sends.
+This service uses ConbusEventProtocol to provide receive-only functionality, allowing
+clients to receive waiting event telegrams using empty telegram sends.
 """
 
 import asyncio
@@ -33,7 +34,8 @@ class ConbusReceiveService:
     on_finish: Signal = Signal(ConbusReceiveResponse)
 
     def __init__(self, conbus_protocol: ConbusEventProtocol) -> None:
-        """Initialize the Conbus receive service.
+        """
+        Initialize the Conbus receive service.
 
         Args:
             conbus_protocol: ConbusEventProtocol instance.
@@ -57,7 +59,8 @@ class ConbusReceiveService:
         self.logger.debug("Connection established, waiting for telegrams.")
 
     def telegram_sent(self, telegram_sent: str) -> None:
-        """Handle telegram sent event.
+        """
+        Handle telegram sent event.
 
         Args:
             telegram_sent: The telegram that was sent.
@@ -65,7 +68,8 @@ class ConbusReceiveService:
         pass
 
     def telegram_received(self, telegram_received: TelegramReceivedEvent) -> None:
-        """Handle telegram received event.
+        """
+        Handle telegram received event.
 
         Args:
             telegram_received: The telegram received event.
@@ -85,7 +89,8 @@ class ConbusReceiveService:
         self.on_finish.emit(self.receive_response)
 
     def failed(self, message: str) -> None:
-        """Handle failed connection event.
+        """
+        Handle failed connection event.
 
         Args:
             message: Failure message.
@@ -96,7 +101,8 @@ class ConbusReceiveService:
         self.on_finish.emit(self.receive_response)
 
     def set_timeout(self, timeout_seconds: float) -> None:
-        """Setup callbacks and timeout for receiving telegrams.
+        """
+        Setup callbacks and timeout for receiving telegrams.
 
         Args:
             timeout_seconds: Optional timeout in seconds.
@@ -108,7 +114,8 @@ class ConbusReceiveService:
         self,
         event_loop: asyncio.AbstractEventLoop,
     ) -> None:
-        """Setup callbacks and timeout for receiving telegrams.
+        """
+        Setup callbacks and timeout for receiving telegrams.
 
         Args:
             event_loop: Optional event loop to use for async operations.
@@ -125,7 +132,8 @@ class ConbusReceiveService:
         self.conbus_protocol.stop_reactor()
 
     def __enter__(self) -> "ConbusReceiveService":
-        """Enter context manager.
+        """
+        Enter context manager.
 
         Returns:
             Self for context manager protocol.

xp/services/conbus/conbus_scan_service.py

@@ -1,7 +1,8 @@
-"""Conbus Scan Service for TCP communication with Conbus servers.
+"""
+Conbus Scan Service for TCP communication with Conbus servers.
 
-This service implements a TCP client that scans Conbus servers and sends
-telegrams to scan modules for all datapoints by function code.
+This service implements a TCP client that scans Conbus servers and sends telegrams to
+scan modules for all datapoints by function code.
 """
 
 import logging
@@ -35,7 +36,8 @@ class ConbusScanService:
         self,
         conbus_protocol: ConbusEventProtocol,
     ) -> None:
-        """Initialize the Conbus scan service.
+        """
+        Initialize the Conbus scan service.
 
         Args:
             conbus_protocol: ConbusEventProtocol instance.
@@ -66,7 +68,8 @@ class ConbusScanService:
         self.scan_next_datacode()
 
     def scan_next_datacode(self) -> bool:
-        """Scan the next data code.
+        """
+        Scan the next data code.
 
         Returns:
             True if scanning should continue, False if complete.
@@ -83,7 +86,8 @@ class ConbusScanService:
         return True
 
     def telegram_sent(self, telegram_sent: str) -> None:
-        """Handle telegram sent event.
+        """
+        Handle telegram sent event.
 
         Args:
             telegram_sent: The telegram that was sent.
@@ -92,7 +96,8 @@ class ConbusScanService:
         self.service_response.sent_telegrams.append(telegram_sent)
 
     def telegram_received(self, telegram_received: TelegramReceivedEvent) -> None:
-        """Handle telegram received event.
+        """
+        Handle telegram received event.
 
         Args:
             telegram_received: The telegram received event.
@@ -111,7 +116,8 @@ class ConbusScanService:
         self.scan_next_datacode()
 
     def failed(self, message: str) -> None:
-        """Handle failed connection event.
+        """
+        Handle failed connection event.
 
         Args:
             message: Failure message.
@@ -128,7 +134,8 @@ class ConbusScanService:
         function_code: str,
         timeout_seconds: float = 0.25,
     ) -> None:
-        """Scan a module for all datapoints by function code.
+        """
+        Scan a module for all datapoints by function code.
 
         Args:
             serial_number: 10-digit module serial number.
@@ -143,7 +150,8 @@ class ConbusScanService:
         self.function_code = function_code
 
     def set_timeout(self, timeout_seconds: float) -> None:
-        """Set operation timeout.
+        """
+        Set operation timeout.
 
         Args:
             timeout_seconds: Timeout in seconds.

xp/services/conbus/msactiontable/msactiontable_upload_service.py

@@ -29,7 +29,8 @@ class MsActionTableUploadError(Exception):
 
 
 class MsActionTableUploadService:
-    """TCP client service for uploading MS action tables to Conbus modules.
+    """
+    TCP client service for uploading MS action tables to Conbus modules.
 
     Manages TCP socket connections, handles telegram generation and transmission,
     and processes server responses for MS action table uploads.
@@ -53,7 +54,8 @@ class MsActionTableUploadService:
         telegram_service: TelegramService,
         conson_config: ConsonModuleListConfig,
     ) -> None:
-        """Initialize the MS action table upload service.
+        """
+        Initialize the MS action table upload service.
 
         Args:
             conbus_protocol: ConbusEventProtocol for communication.
@@ -104,7 +106,8 @@ class MsActionTableUploadService:
         )
 
     def telegram_sent(self, telegram_sent: str) -> None:
-        """Handle telegram sent event.
+        """
+        Handle telegram sent event.
 
         Args:
             telegram_sent: The telegram that was sent.
@@ -112,7 +115,8 @@ class MsActionTableUploadService:
         self.logger.debug(f"Telegram sent: {telegram_sent}")
 
     def telegram_received(self, telegram_received: TelegramReceivedEvent) -> None:
-        """Handle telegram received event.
+        """
+        Handle telegram received event.
 
         Args:
             telegram_received: The telegram received event.
@@ -133,7 +137,8 @@ class MsActionTableUploadService:
         self._handle_upload_response(reply_telegram)
 
     def _handle_upload_response(self, reply_telegram: Any) -> None:
-        """Handle telegram responses during upload.
+        """
+        Handle telegram responses during upload.
 
         Args:
             reply_telegram: Parsed reply telegram.
@@ -174,7 +179,8 @@ class MsActionTableUploadService:
         self.failed("Upload timeout")
 
     def failed(self, message: str) -> None:
-        """Handle failed connection event.
+        """
+        Handle failed connection event.
 
         Args:
             message: Failure message.
@@ -188,7 +194,8 @@ class MsActionTableUploadService:
         xpmoduletype: str,
         timeout_seconds: Optional[float] = None,
     ) -> None:
-        """Upload MS action table to module.
+        """
+        Upload MS action table to module.
 
         Uploads the MS action table configuration to the specified module.
 
@@ -273,14 +280,15 @@ class MsActionTableUploadService:
             return
 
         # Serialize to telegram data (68 characters: AAAA + 64 data chars)
-        self.upload_data = self.serializer.to_data(msactiontable)  # type: ignore[arg-type]
+        self.upload_data = self.serializer.to_encoded_string(msactiontable)  # type: ignore[arg-type]
 
         self.logger.debug(
             f"Upload data encoded: {len(self.upload_data)} chars (single chunk)"
         )
 
     def set_timeout(self, timeout_seconds: float) -> None:
-        """Set operation timeout.
+        """
+        Set operation timeout.
 
         Args:
             timeout_seconds: Timeout in seconds.