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

xp/services/actiontable/serializer_protocol.py

@@ -0,0 +1,76 @@
+"""Protocol for action table serializers."""
+
+from typing import Any, Protocol
+
+from xp.models.telegram.system_function import SystemFunction
+
+
+class ActionTableSerializerProtocol(Protocol):
+    """
+    Protocol defining the interface for action table serializers.
+
+    All action table serializers (ActionTableSerializer, Xp20MsActionTableSerializer,
+    Xp24MsActionTableSerializer, Xp33MsActionTableSerializer) implement this protocol.
+    """
+
+    @staticmethod
+    def download_type() -> SystemFunction:
+        """
+        Get the download system function type.
+
+        Returns:
+            The download system function: DOWNLOAD_MSACTIONTABLE or DOWNLOAD_ACTIONTABLE
+        """
+        ...
+
+    @staticmethod
+    def from_encoded_string(encoded_data: str) -> Any:
+        """
+        Deserialize encoded telegram data to action table model.
+
+        Args:
+            encoded_data: Encoded string from telegram (A-P nibble encoding).
+
+        Returns:
+            Deserialized action table model.
+        """
+        ...
+
+    @staticmethod
+    def to_encoded_string(action_table: Any) -> str:
+        """
+        Serialize action table model to encoded telegram format.
+
+        Args:
+            action_table: Action table model to serialize.
+
+        Returns:
+            Encoded string for telegram transmission.
+        """
+        ...
+
+    @staticmethod
+    def from_short_string(action_strings: list[str]) -> Any:
+        """
+        Deserialize human-readable short format to action table model.
+
+        Args:
+            action_strings: List of short format strings.
+
+        Returns:
+            Deserialized action table model.
+        """
+        ...
+
+    @staticmethod
+    def to_short_string(action_table: Any) -> list[str]:
+        """
+        Serialize action table model to human-readable short format.
+
+        Args:
+            action_table: Action table model to serialize.
+
+        Returns:
+            List of human-readable short format strings.
+        """
+        ...

xp/services/conbus/actiontable/actiontable_download_service.py

@@ -1,28 +1,38 @@
 """Service for downloading ActionTable via Conbus protocol."""
 
 import logging
-from dataclasses import asdict
 from typing import Any, Optional
 
-from psygnal import SignalInstance
+from psygnal import Signal
 
-from xp.models.actiontable.actiontable import ActionTable
+from xp.models.actiontable.actiontable_type import ActionTableType
 from xp.models.protocol.conbus_protocol import TelegramReceivedEvent
 from xp.models.telegram.datapoint_type import DataPointType
 from xp.models.telegram.reply_telegram import ReplyTelegram
 from xp.services.actiontable.actiontable_serializer import ActionTableSerializer
-from xp.services.conbus.actiontable.actiontable_download_state_machine import (
+from xp.services.actiontable.download_state_machine import (
     MAX_ERROR_RETRIES,
-    ActionTableDownloadStateMachine,
+    DownloadStateMachine,
 )
+from xp.services.actiontable.msactiontable_xp20_serializer import (
+    Xp20MsActionTableSerializer,
+)
+from xp.services.actiontable.msactiontable_xp24_serializer import (
+    Xp24MsActionTableSerializer,
+)
+from xp.services.actiontable.msactiontable_xp33_serializer import (
+    Xp33MsActionTableSerializer,
+)
+from xp.services.actiontable.serializer_protocol import ActionTableSerializerProtocol
 from xp.services.protocol.conbus_event_protocol import (
     NO_ERROR_CODE,
     ConbusEventProtocol,
 )
 
 
-class ActionTableDownloadService(ActionTableDownloadStateMachine):
-    """Service for downloading action tables from Conbus modules via TCP.
+class ActionTableDownloadService(DownloadStateMachine):
+    """
+    Service for downloading action tables from Conbus modules via TCP.
 
     Inherits from ActionTableDownloadStateMachine and overrides on_enter_*
     methods to add protocol-specific behavior.
@@ -51,31 +61,41 @@ class ActionTableDownloadService(ActionTableDownloadStateMachine):
         ...     service.start_reactor()
     """
 
+    # Service signals
+    on_progress: Signal = Signal(str)
+    on_error: Signal = Signal(str)
+    on_finish: Signal = Signal()
+    on_actiontable_received: Signal = Signal(Any, dict[str, Any], list[str])
+
     def __init__(
         self,
         conbus_protocol: ConbusEventProtocol,
         actiontable_serializer: ActionTableSerializer,
+        msactiontable_serializer_xp20: Xp20MsActionTableSerializer,
+        msactiontable_serializer_xp24: Xp24MsActionTableSerializer,
+        msactiontable_serializer_xp33: Xp33MsActionTableSerializer,
     ) -> None:
-        """Initialize the action table download service.
+        """
+        Initialize the action table download service.
 
         Args:
             conbus_protocol: ConbusEventProtocol instance.
             actiontable_serializer: Action table serializer.
+            msactiontable_serializer_xp20: XP20 master station action table serializer.
+            msactiontable_serializer_xp24: XP24 master station action table serializer.
+            msactiontable_serializer_xp33: XP33 master station action table serializer.
         """
         self.conbus_protocol = conbus_protocol
-        self.serializer = actiontable_serializer
+        self.actiontable_serializer = actiontable_serializer
+        self.msactiontable_serializer_xp20 = msactiontable_serializer_xp20
+        self.msactiontable_serializer_xp24 = msactiontable_serializer_xp24
+        self.msactiontable_serializer_xp33 = msactiontable_serializer_xp33
+        self.serializer: ActionTableSerializerProtocol = actiontable_serializer
+
         self.serial_number: str = ""
         self.actiontable_data: list[str] = []
         self._signals_connected: bool = False
 
-        # Service signals
-        self.on_progress: SignalInstance = SignalInstance((str,))
-        self.on_error: SignalInstance = SignalInstance((str,))
-        self.on_finish: SignalInstance = SignalInstance()
-        self.on_actiontable_received: SignalInstance = SignalInstance(
-            (ActionTable, dict[str, Any], list[str])
-        )
-
         # Initialize state machine (must be last - triggers introspection)
         super().__init__()
 
@@ -125,11 +145,8 @@ class ActionTableDownloadService(ActionTableDownloadStateMachine):
         self.logger.debug("Entering PROCESSING_EOF state - deserializing")
         all_data = "".join(self.actiontable_data)
         actiontable = self.serializer.from_encoded_string(all_data)
-        actiontable_dict = asdict(actiontable)
-        actiontable_short = self.serializer.format_decoded_output(actiontable)
-        self.on_actiontable_received.emit(
-            actiontable, actiontable_dict, actiontable_short
-        )
+        actiontable_short = self.serializer.to_short_string(actiontable)
+        self.on_actiontable_received.emit(actiontable, actiontable_short)
         # Switch to CLEANUP phase
         self.start_cleanup_phase()
 
@@ -152,7 +169,8 @@ class ActionTableDownloadService(ActionTableDownloadStateMachine):
             self.do_connect()
 
     def _on_read_datapoint_received(self, reply_telegram: ReplyTelegram) -> None:
-        """Handle READ_DATAPOINT response for error status check.
+        """
+        Handle READ_DATAPOINT response for error status check.
 
         Args:
             reply_telegram: The parsed reply telegram.
@@ -176,7 +194,8 @@ class ActionTableDownloadService(ActionTableDownloadStateMachine):
     def _on_actiontable_chunk_received(
         self, reply_telegram: ReplyTelegram, actiontable_chunk: str
     ) -> None:
-        """Handle actiontable chunk telegram received.
+        """
+        Handle actiontable chunk telegram received.
 
         Args:
             reply_telegram: The parsed reply telegram containing chunk data.
@@ -192,7 +211,8 @@ class ActionTableDownloadService(ActionTableDownloadStateMachine):
             self.receive_chunk()
 
     def _on_eof_received(self, reply_telegram: ReplyTelegram) -> None:
-        """Handle EOF telegram received.
+        """
+        Handle EOF telegram received.
 
         Args:
             reply_telegram: The parsed reply telegram (unused).
@@ -205,7 +225,8 @@ class ActionTableDownloadService(ActionTableDownloadStateMachine):
             self.receive_eof()
 
     def _on_telegram_received(self, telegram_received: TelegramReceivedEvent) -> None:
-        """Handle telegram received event.
+        """
+        Handle telegram received event.
 
         Args:
             telegram_received: The telegram received event.
@@ -233,7 +254,8 @@ class ActionTableDownloadService(ActionTableDownloadStateMachine):
             self.on_error.emit("Timeout")
 
     def _on_failed(self, message: str) -> None:
-        """Handle failed connection event.
+        """
+        Handle failed connection event.
 
         Args:
             message: Failure message.
@@ -246,15 +268,18 @@ class ActionTableDownloadService(ActionTableDownloadStateMachine):
     def configure(
         self,
         serial_number: str,
+        actiontable_type: ActionTableType,
         timeout_seconds: Optional[float] = 2.0,
     ) -> None:
-        """Configure download parameters before starting.
+        """
+        Configure download parameters before starting.
 
         Sets the target module serial number and timeout. Call this before
         start_reactor() to configure the download target.
 
         Args:
             serial_number: Module serial number to download from.
+            actiontable_type: Type of action table to download.
             timeout_seconds: Timeout in seconds for each operation (default 2.0).
 
         Raises:
@@ -264,11 +289,20 @@ class ActionTableDownloadService(ActionTableDownloadStateMachine):
             raise RuntimeError("Cannot configure while download in progress")
         self.logger.info("Configuring actiontable download")
         self.serial_number = serial_number
+        if actiontable_type == ActionTableType.ACTIONTABLE:
+            self.serializer = self.actiontable_serializer
+        elif actiontable_type == ActionTableType.MSACTIONTABLE_XP20:
+            self.serializer = self.msactiontable_serializer_xp20
+        elif actiontable_type == ActionTableType.MSACTIONTABLE_XP24:
+            self.serializer = self.msactiontable_serializer_xp24
+        elif actiontable_type == ActionTableType.MSACTIONTABLE_XP33:
+            self.serializer = self.msactiontable_serializer_xp33
         if timeout_seconds:
             self.conbus_protocol.timeout_seconds = timeout_seconds
 
     def set_timeout(self, timeout_seconds: float) -> None:
-        """Set operation timeout.
+        """
+        Set operation timeout.
 
         Args:
             timeout_seconds: Timeout in seconds.

xp/services/conbus/actiontable/actiontable_list_service.py

@@ -8,7 +8,8 @@ from psygnal import Signal
 
 
 class ActionTableListService:
-    """Service for listing modules with action table configurations.
+    """
+    Service for listing modules with action table configurations.
 
     Reads conson.yml and returns a list of all modules that have action table
     configurations defined.
@@ -26,7 +27,8 @@ class ActionTableListService:
         self.logger = logging.getLogger(__name__)
 
     def __enter__(self) -> "ActionTableListService":
-        """Context manager entry.
+        """
+        Context manager entry.
 
         Returns:
             Self for context manager use.
@@ -43,7 +45,8 @@ class ActionTableListService:
         self,
         config_path: Optional[Path] = None,
     ) -> None:
-        """List all modules with action table configurations.
+        """
+        List all modules with action table configurations.
 
         Args:
             config_path: Optional path to conson.yml. Defaults to current directory.
@@ -73,6 +76,15 @@ class ActionTableListService:
                 "serial_number": module.serial_number,
                 "module_type": module.module_type,
                 "action_table": len(module.action_table) if module.action_table else 0,
+                "msaction_table": (
+                    1
+                    if (
+                        module.xp20_msaction_table
+                        or module.xp24_msaction_table
+                        or module.xp33_msaction_table
+                    )
+                    else 0
+                ),
             }
             for module in config.root
         ]
@@ -84,7 +96,8 @@ class ActionTableListService:
         self.on_finish.emit(result)
 
     def _handle_error(self, message: str) -> None:
-        """Handle error and emit error signal.
+        """
+        Handle error and emit error signal.
 
         Args:
             message: Error message.

xp/services/conbus/actiontable/actiontable_show_service.py

@@ -8,10 +8,11 @@ from xp.models.config.conson_module_config import ConsonModuleConfig
 
 
 class ActionTableShowService:
-    """Service for showing action table configuration for a specific module.
+    """
+    Service for showing action table configuration for a specific module.
 
-    Reads conson.yml and returns the action table configuration for the specified
-    module serial number.
+    Reads conson.yml and returns the action table configuration for the specified module
+    serial number.
     """
 
     def __init__(self) -> None:
@@ -21,7 +22,8 @@ class ActionTableShowService:
         self.error_callback: Optional[Callable[[str], None]] = None
 
     def __enter__(self) -> "ActionTableShowService":
-        """Context manager entry.
+        """
+        Context manager entry.
 
         Returns:
             Self for context manager use.
@@ -39,7 +41,8 @@ class ActionTableShowService:
         error_callback: Callable[[str], None],
         config_path: Optional[Path] = None,
     ) -> None:
-        """Show action table configuration for a specific module.
+        """
+        Show action and msaction table configuration for a specific module.
 
         Args:
             serial_number: Module serial number.
@@ -80,7 +83,8 @@ class ActionTableShowService:
             self.finish_callback(module)
 
     def _handle_error(self, message: str) -> None:
-        """Handle error and invoke error callback.
+        """
+        Handle error and invoke error callback.
 
         Args:
             message: Error message.

xp/services/conbus/actiontable/actiontable_upload_service.py

@@ -15,7 +15,8 @@ from xp.services.telegram.telegram_service import TelegramService
 
 
 class ActionTableUploadService:
-    """TCP client service for uploading action tables to Conbus modules.
+    """
+    TCP client service for uploading action tables to Conbus modules.
 
     Manages TCP socket connections, handles telegram generation and transmission,
     and processes server responses for action table uploads.
@@ -37,7 +38,8 @@ class ActionTableUploadService:
         telegram_service: TelegramService,
         conson_config: ConsonModuleListConfig,
     ) -> None:
-        """Initialize the action table upload service.
+        """
+        Initialize the action table upload service.
 
         Args:
             conbus_protocol: ConbusEventProtocol for communication.
@@ -76,7 +78,8 @@ class ActionTableUploadService:
         )
 
     def telegram_sent(self, telegram_sent: str) -> None:
-        """Handle telegram sent event.
+        """
+        Handle telegram sent event.
 
         Args:
             telegram_sent: The telegram that was sent.
@@ -84,7 +87,8 @@ class ActionTableUploadService:
         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.
@@ -105,7 +109,8 @@ class ActionTableUploadService:
         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.
@@ -152,7 +157,8 @@ class ActionTableUploadService:
         self.failed("Upload timeout")
 
     def failed(self, message: str) -> None:
-        """Handle failed connection event.
+        """
+        Handle failed connection event.
 
         Args:
             message: Failure message.
@@ -165,7 +171,8 @@ class ActionTableUploadService:
         serial_number: str,
         timeout_seconds: Optional[float] = None,
     ) -> None:
-        """Upload action table to module.
+        """
+        Upload action table to module.
 
         Uploads the action table configuration to the specified module.
 
@@ -187,7 +194,7 @@ class ActionTableUploadService:
         # Parse action table strings to ActionTable object
         try:
             module_action_table = module.action_table or []
-            action_table = self.serializer.parse_action_table(module_action_table)
+            action_table = self.serializer.from_short_string(module_action_table)
         except ValueError as e:
             self.logger.error(f"Invalid action table format: {e}")
             self.failed(f"Invalid action table format: {e}")
@@ -210,7 +217,8 @@ class ActionTableUploadService:
         )
 
     def set_timeout(self, timeout_seconds: float) -> None:
-        """Set operation timeout.
+        """
+        Set operation timeout.
 
         Args:
             timeout_seconds: Timeout in seconds.

xp/services/conbus/conbus_blink_all_service.py

@@ -1,4 +1,5 @@
-"""Conbus Blink All Service for TCP communication with Conbus servers.
+"""
+Conbus Blink All Service for TCP communication with Conbus servers.
 
 This service implements a TCP client that connects to Conbus servers and sends
 blink/unblink telegrams to all discovered modules on the network.
@@ -38,7 +39,8 @@ class ConbusBlinkAllService:
         conbus_protocol: ConbusEventProtocol,
         telegram_service: TelegramService,
     ) -> None:
-        """Initialize the Conbus blink all service.
+        """
+        Initialize the Conbus blink all service.
 
         Args:
             conbus_protocol: ConbusEventProtocol instance for communication.
@@ -77,7 +79,8 @@ class ConbusBlinkAllService:
         self.on_progress.emit(".")
 
     def send_blink(self, serial_number: str) -> None:
-        """Send blink or unblink telegram to a discovered module.
+        """
+        Send blink or unblink telegram to a discovered module.
 
         Args:
             serial_number: 10-digit module serial number.
@@ -101,7 +104,8 @@ class ConbusBlinkAllService:
         self.on_progress.emit(".")
 
     def telegram_sent(self, telegram_sent: str) -> None:
-        """Handle telegram sent event.
+        """
+        Handle telegram sent event.
 
         Args:
             telegram_sent: The telegram that was sent.
@@ -110,7 +114,8 @@ class ConbusBlinkAllService:
         self.service_response.sent_telegram = system_telegram
 
     def telegram_received(self, telegram_received: TelegramReceivedEvent) -> None:
-        """Handle telegram received event.
+        """
+        Handle telegram received event.
 
         Args:
             telegram_received: The telegram received event.
@@ -157,7 +162,8 @@ class ConbusBlinkAllService:
         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.
@@ -173,7 +179,8 @@ class ConbusBlinkAllService:
         on_or_off: str,
         timeout_seconds: Optional[float] = None,
     ) -> None:
-        """Send blink command to all discovered modules.
+        """
+        Send blink command to all discovered modules.
 
         Args:
             on_or_off: "on" to blink or "off" to unblink all devices.
@@ -186,7 +193,8 @@ class ConbusBlinkAllService:
         # Caller invokes start_reactor()
 
     def set_timeout(self, timeout_seconds: float) -> None:
-        """Set operation timeout.
+        """
+        Set operation timeout.
 
         Args:
             timeout_seconds: Timeout in seconds.

xp/services/conbus/conbus_blink_service.py

@@ -1,4 +1,5 @@
-"""Conbus Blink Service for TCP communication with Conbus servers.
+"""
+Conbus Blink Service for TCP communication with Conbus servers.
 
 This service implements a TCP client that connects to Conbus servers and sends
 blink/unblink telegrams to control module LED indicators.
@@ -36,7 +37,8 @@ class ConbusBlinkService:
         conbus_protocol: ConbusEventProtocol,
         telegram_service: TelegramService,
     ) -> None:
-        """Initialize the Conbus blink service.
+        """
+        Initialize the Conbus blink service.
 
         Args:
             conbus_protocol: ConbusEventProtocol instance for communication.
@@ -81,7 +83,8 @@ class ConbusBlinkService:
         self.service_response.operation = self.on_or_off
 
     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 +93,8 @@ class ConbusBlinkService:
         self.service_response.sent_telegram = system_telegram
 
     def telegram_received(self, telegram_received: TelegramReceivedEvent) -> None:
-        """Handle telegram received event.
+        """
+        Handle telegram received event.
 
         Args:
             telegram_received: The telegram received event.
@@ -131,7 +135,8 @@ class ConbusBlinkService:
         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.
@@ -148,7 +153,8 @@ class ConbusBlinkService:
         on_or_off: str,
         timeout_seconds: Optional[float] = None,
     ) -> None:
-        r"""Send blink command to start blinking module LED.
+        r"""
+        Send blink command to start blinking module LED.
 
         Args:
             serial_number: 10-digit module serial number.
@@ -168,7 +174,8 @@ class ConbusBlinkService:
         # Caller invokes start_reactor()
 
     def set_timeout(self, timeout_seconds: float) -> None:
-        """Set operation timeout.
+        """
+        Set operation timeout.
 
         Args:
             timeout_seconds: Timeout in seconds.

xp/services/conbus/conbus_custom_service.py

@@ -1,4 +1,5 @@
-"""Conbus Custom Service for sending custom telegrams to modules.
+"""
+Conbus Custom Service for sending custom telegrams to modules.
 
 This service handles custom telegram operations for modules through Conbus telegrams.
 """
@@ -19,7 +20,8 @@ from xp.services.telegram.telegram_service import TelegramService
 
 
 class ConbusCustomService:
-    """Service for sending custom telegrams to Conbus modules.
+    """
+    Service for sending custom telegrams to Conbus modules.
 
     Uses ConbusEventProtocol to provide custom telegram functionality
     for sending arbitrary function codes and data to modules.
@@ -37,7 +39,8 @@ class ConbusCustomService:
         conbus_protocol: ConbusEventProtocol,
         telegram_service: TelegramService,
     ) -> None:
-        """Initialize the Conbus custom service.
+        """
+        Initialize the Conbus custom service.
 
         Args:
             conbus_protocol: Protocol instance for Conbus communication.
@@ -82,7 +85,8 @@ class ConbusCustomService:
         )
 
     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 ConbusCustomService:
         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.
@@ -131,7 +136,8 @@ class ConbusCustomService:
         self.failed("Timeout")
 
     def failed(self, message: str) -> None:
-        """Handle failed connection event.
+        """
+        Handle failed connection event.
 
         Args:
             message: Failure message.
@@ -151,7 +157,8 @@ class ConbusCustomService:
         data: str,
         timeout_seconds: Optional[float] = None,
     ) -> None:
-        """Send a custom telegram to a module.
+        """
+        Send a custom telegram to a module.
 
         Args:
             serial_number: 10-digit module serial number.
@@ -167,7 +174,8 @@ class ConbusCustomService:
             self.set_timeout(timeout_seconds)
 
     def set_timeout(self, timeout_seconds: float) -> None:
-        """Set operation timeout.
+        """
+        Set operation timeout.
 
         Args:
             timeout_seconds: Timeout in seconds.