conson-xp 1.4.0__tar.gz → 1.6.0__tar.gz

{conson_xp-1.4.0 → conson_xp-1.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: conson-xp
-Version: 1.4.0
+Version: 1.6.0
 Summary: XP Protocol Communication Tools
 Author-Email: ldvchosal <ldvchosal@github.com>
 License: MIT License

{conson_xp-1.4.0 → conson_xp-1.6.0}/pyproject.toml

@@ -20,7 +20,7 @@ dependencies = [
 ]
 requires-python = ">=3.11"
 readme = "README.md"
-version = "1.4.0"
+version = "1.6.0"
 
 [project.license]
 file = "LICENSE"

{conson_xp-1.4.0 → conson_xp-1.6.0}/src/xp/__init__.py

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

conson_xp-1.6.0/src/xp/services/actiontable/__init__.py

@@ -0,0 +1 @@
+"""Action table utils."""

conson_xp-1.6.0/src/xp/services/actiontable/msactiontable_serializer.py

@@ -0,0 +1,7 @@
+"""Generic MsActionTable serializer base class for type hints."""
+
+
+class MsActionTableSerializer:
+    """Serializer for ActionTable telegram encoding/decoding."""
+
+    pass

{conson_xp-1.4.0 → conson_xp-1.6.0}/src/xp/services/conbus/actiontable/actiontable_service.py

@@ -10,7 +10,7 @@ from xp.models.actiontable.actiontable import ActionTable
 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.conbus.actiontable.actiontable_serializer import ActionTableSerializer
+from xp.services.actiontable.actiontable_serializer import ActionTableSerializer
 from xp.services.protocol import ConbusProtocol
 from xp.services.telegram.telegram_service import TelegramService
 

{conson_xp-1.4.0 → conson_xp-1.6.0}/src/xp/services/conbus/actiontable/msactiontable_service.py

@@ -12,13 +12,13 @@ from xp.models.actiontable.msactiontable_xp33 import Xp33MsActionTable
 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.conbus.actiontable.msactiontable_xp20_serializer import (
+from xp.services.actiontable.msactiontable_xp20_serializer import (
     Xp20MsActionTableSerializer,
 )
-from xp.services.conbus.actiontable.msactiontable_xp24_serializer import (
+from xp.services.actiontable.msactiontable_xp24_serializer import (
     Xp24MsActionTableSerializer,
 )
-from xp.services.conbus.actiontable.msactiontable_xp33_serializer import (
+from xp.services.actiontable.msactiontable_xp33_serializer import (
     Xp33MsActionTableSerializer,
 )
 from xp.services.protocol import ConbusProtocol

{conson_xp-1.4.0 → conson_xp-1.6.0}/src/xp/services/server/base_server_service.py

@@ -5,8 +5,9 @@ containing common functionality like module type response generation.
 """
 
 import logging
+import threading
 from abc import ABC
-from typing import Optional
+from typing import Any, Optional
 
 from xp.models import ModuleTypeCode
 from xp.models.telegram.datapoint_type import DataPointType
@@ -42,6 +43,12 @@ class BaseServerService(ABC):
         self.temperature: str = "+23,5§C"
         self.voltage: str = "+12,5§V"
 
+        self.telegram_buffer: list[str] = []
+        self.telegram_buffer_lock = threading.Lock()  # Lock for socket set
+
+        # MsActionTable download state (None, "ack_sent", "data_sent")
+        self.msactiontable_download_state: Optional[str] = None
+
     def generate_datapoint_type_response(
         self, datapoint_type: DataPointType
     ) -> Optional[str]:
@@ -147,6 +154,83 @@ class BaseServerService(ABC):
 
         return None
 
+    def _get_msactiontable_serializer(self) -> Optional[Any]:
+        """Get the MsActionTable serializer for this device.
+
+        Subclasses should override this to return their specific serializer.
+
+        Returns:
+            The serializer instance, or None if not supported.
+        """
+        return None
+
+    def _get_msactiontable(self) -> Optional[Any]:
+        """Get the MsActionTable for this device.
+
+        Subclasses should override this to return their msactiontable instance.
+
+        Returns:
+            The msactiontable instance, or None if not supported.
+        """
+        return None
+
+    def _handle_download_msactiontable_request(
+        self, request: SystemTelegram
+    ) -> Optional[str]:
+        """Handle F13D - DOWNLOAD_MSACTIONTABLE request.
+
+        Args:
+            request: The system telegram request to process.
+
+        Returns:
+            ACK telegram if request is valid, NAK otherwise.
+        """
+        if (
+            request.system_function == SystemFunction.DOWNLOAD_MSACTIONTABLE
+            and self.msactiontable_download_state is None
+        ):
+            self.msactiontable_download_state = "ack_sent"
+            # Send ACK and queue data telegram
+            return self._build_response_telegram(f"R{self.serial_number}F18D")  # ACK
+
+        return self._build_response_telegram(f"R{self.serial_number}F19D")  # NAK
+
+    def _handle_download_msactiontable_ack_request(
+        self, _request: SystemTelegram
+    ) -> Optional[str]:
+        """Handle MsActionTable download ACK protocol.
+
+        Args:
+            _request: The system telegram request (unused, kept for signature consistency).
+
+        Returns:
+            Data telegram, EOF telegram, or NAK if state is invalid.
+        """
+        serializer = self._get_msactiontable_serializer()
+        msactiontable = self._get_msactiontable()
+
+        # Only handle if serializer and msactiontable are available
+        if not serializer or msactiontable is None:
+            return None
+
+        # Handle F18D - CONTINUE (after ACK or data)
+        if self.msactiontable_download_state == "ack_sent":
+            # Send MsActionTable data
+            encoded_data = serializer.to_data(msactiontable)
+            data_telegram = self._build_response_telegram(
+                f"R{self.serial_number}F17D{encoded_data}"
+            )
+            self.msactiontable_download_state = "data_sent"
+            return data_telegram
+
+        elif self.msactiontable_download_state == "data_sent":
+            # Send EOF
+            eof_telegram = self._build_response_telegram(f"R{self.serial_number}F16D")
+            self.msactiontable_download_state = None
+            return eof_telegram
+
+        return self._build_response_telegram(f"R{self.serial_number}F19D")  # NAK
+
     def process_system_telegram(self, request: SystemTelegram) -> Optional[str]:
         """Template method for processing system telegrams.
 
@@ -173,6 +257,15 @@ class BaseServerService(ABC):
         elif request.system_function == SystemFunction.ACTION:
             return self._handle_action_request(request)
 
+        elif request.system_function == SystemFunction.DOWNLOAD_MSACTIONTABLE:
+            return self._handle_download_msactiontable_request(request)
+
+        elif (
+            request.system_function == SystemFunction.ACK
+            and self.msactiontable_download_state
+        ):
+            return self._handle_download_msactiontable_ack_request(request)
+
         self.logger.warning(f"Unhandled {self.device_type} request: {request}")
         return None
 
@@ -257,3 +350,28 @@ class BaseServerService(ABC):
             The response telegram string, or None if request cannot be handled.
         """
         return None
+
+    def add_telegram_buffer(self, telegram: str) -> None:
+        """Add telegram to the buffer.
+
+        Args:
+            telegram: The telegram string to add to the buffer.
+        """
+        self.logger.debug(f"Add telegram to the buffer: {telegram}")
+        with self.telegram_buffer_lock:
+            self.telegram_buffer.append(telegram)
+
+    def collect_telegram_buffer(self) -> list[str]:
+        """Collecting telegrams from the buffer.
+
+        Returns:
+            List of telegram strings from the buffer. The buffer is cleared after collection.
+        """
+        self.logger.debug(
+            f"Collecting {self.serial_number} telegrams from buffer: {len(self.telegram_buffer)}"
+        )
+        with self.telegram_buffer_lock:
+            result = self.telegram_buffer.copy()
+            self.logger.debug(f"Resetting {self.serial_number} buffer")
+            self.telegram_buffer.clear()
+            return result

{conson_xp-1.4.0 → conson_xp-1.6.0}/src/xp/services/server/cp20_server_service.py

@@ -8,6 +8,7 @@ from typing import Dict, Optional
 
 from xp.models import ModuleTypeCode
 from xp.models.telegram.system_telegram import SystemTelegram
+from xp.services.actiontable.msactiontable_serializer import MsActionTableSerializer
 from xp.services.server.base_server_service import BaseServerService
 
 
@@ -25,11 +26,18 @@ class CP20ServerService(BaseServerService):
     and implements CP20 telegram format.
     """
 
-    def __init__(self, serial_number: str):
+    def __init__(
+        self,
+        serial_number: str,
+        _variant: str = "",
+        _msactiontable_serializer: Optional[MsActionTableSerializer] = None,
+    ):
         """Initialize CP20 server service.
 
         Args:
             serial_number: The device serial number.
+            _variant: Reserved parameter for consistency (unused).
+            _msactiontable_serializer: Generic MsActionTable serializer (unused).
         """
         super().__init__(serial_number)
         self.device_type = "CP20"

conson_xp-1.6.0/src/xp/services/server/device_service_factory.py

@@ -0,0 +1,94 @@
+"""Device Service Factory for creating device instances.
+
+This module provides a factory for creating device service instances
+with proper dependency injection of serializers.
+"""
+
+from xp.services.actiontable.msactiontable_serializer import MsActionTableSerializer
+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.server.base_server_service import BaseServerService
+from xp.services.server.cp20_server_service import CP20ServerService
+from xp.services.server.xp20_server_service import XP20ServerService
+from xp.services.server.xp24_server_service import XP24ServerService
+from xp.services.server.xp33_server_service import XP33ServerService
+from xp.services.server.xp130_server_service import XP130ServerService
+from xp.services.server.xp230_server_service import XP230ServerService
+
+
+class DeviceServiceFactory:
+    """Factory for creating device service instances.
+
+    Encapsulates device creation logic and handles serializer injection
+    for different device types.
+    """
+
+    def __init__(
+        self,
+        xp20ms_serializer: Xp20MsActionTableSerializer,
+        xp24ms_serializer: Xp24MsActionTableSerializer,
+        xp33ms_serializer: Xp33MsActionTableSerializer,
+        ms_serializer: MsActionTableSerializer,
+    ):
+        """Initialize device service factory.
+
+        Args:
+            xp20ms_serializer: XP20 MsActionTable serializer (injected via DI).
+            xp24ms_serializer: XP24 MsActionTable serializer (injected via DI).
+            xp33ms_serializer: XP33 MsActionTable serializer (injected via DI).
+            ms_serializer: Generic MsActionTable serializer (injected via DI).
+        """
+        self.xp20ms_serializer = xp20ms_serializer
+        self.xp24ms_serializer = xp24ms_serializer
+        self.xp33ms_serializer = xp33ms_serializer
+        self.ms_serializer = ms_serializer
+
+    def create_device(self, module_type: str, serial_number: str) -> BaseServerService:
+        """Create device instance for given module type.
+
+        Args:
+            module_type: Module type code (e.g., "XP20", "XP33LR").
+            serial_number: Device serial number.
+
+        Returns:
+            Device service instance configured with appropriate serializer.
+
+        Raises:
+            ValueError: If module_type is unknown or unsupported.
+        """
+        # Map module types to their constructors and parameters
+        if module_type == "CP20":
+            return CP20ServerService(serial_number, "CP20", self.ms_serializer)
+
+        elif module_type == "XP24":
+            return XP24ServerService(serial_number, "XP24", self.xp24ms_serializer)
+
+        elif module_type == "XP33":
+            return XP33ServerService(serial_number, "XP33", self.xp33ms_serializer)
+
+        elif module_type == "XP33LR":
+            return XP33ServerService(serial_number, "XP33LR", self.xp33ms_serializer)
+
+        elif module_type == "XP33LED":
+            return XP33ServerService(serial_number, "XP33LED", self.xp33ms_serializer)
+
+        elif module_type == "XP20":
+            return XP20ServerService(serial_number, "XP20", self.xp20ms_serializer)
+
+        elif module_type == "XP130":
+            return XP130ServerService(serial_number, "XP130", self.ms_serializer)
+
+        elif module_type == "XP230":
+            return XP230ServerService(serial_number, "XP230", self.ms_serializer)
+
+        else:
+            raise ValueError(
+                f"Unknown device type '{module_type}' for serial {serial_number}"
+            )

{conson_xp-1.4.0 → conson_xp-1.6.0}/src/xp/services/server/server_service.py

@@ -8,19 +8,14 @@ import logging
 import socket
 import threading
 from pathlib import Path
-from typing import Dict, List, Optional, Union
+from typing import Dict, List, Optional
 
 from xp.models.homekit.homekit_conson_config import (
     ConsonModuleConfig,
     ConsonModuleListConfig,
 )
 from xp.services.server.base_server_service import BaseServerService
-from xp.services.server.cp20_server_service import CP20ServerService
-from xp.services.server.xp20_server_service import XP20ServerService
-from xp.services.server.xp24_server_service import XP24ServerService
-from xp.services.server.xp33_server_service import XP33ServerService
-from xp.services.server.xp130_server_service import XP130ServerService
-from xp.services.server.xp230_server_service import XP230ServerService
+from xp.services.server.device_service_factory import DeviceServiceFactory
 from xp.services.telegram.telegram_discover_service import TelegramDiscoverService
 from xp.services.telegram.telegram_service import TelegramService
 
@@ -43,6 +38,7 @@ class ServerService:
         self,
         telegram_service: TelegramService,
         discover_service: TelegramDiscoverService,
+        device_factory: DeviceServiceFactory,
         config_path: str = "server.yml",
         port: int = 10001,
     ):
@@ -51,25 +47,28 @@ class ServerService:
         Args:
             telegram_service: Service for parsing system telegrams.
             discover_service: Service for handling discover requests.
+            device_factory: Factory for creating device service instances (injected via DI).
             config_path: Path to the server configuration file.
             port: TCP port to listen on.
         """
         self.telegram_service = telegram_service
         self.discover_service = discover_service
+        self.device_factory = device_factory
         self.config_path = config_path
         self.port = port
         self.server_socket: Optional[socket.socket] = None
         self.is_running = False
         self.devices: List[ConsonModuleConfig] = []
-        self.device_services: Dict[
-            str,
-            Union[
-                BaseServerService,
-                XP33ServerService,
-                XP20ServerService,
-                XP130ServerService,
-            ],
-        ] = {}  # serial -> device service instance
+        self.device_services: Dict[str, BaseServerService] = (
+            {}
+        )  # serial -> device service instance
+
+        # Collect device buffer to broadcast to client
+        self.collector_thread: Optional[threading.Thread] = (
+            None  # Background thread for storm
+        )
+        self.collector_stop_event = threading.Event()  # Event to stop thread
+        self.collector_buffer: list[str] = []  # All collected buffers
 
         # Set up logging
         self.logger = logging.getLogger(__name__)
@@ -105,44 +104,14 @@ class ServerService:
             serial_number = module.serial_number
 
             try:
+                # Use factory to create device instance
+                self.device_services[serial_number] = self.device_factory.create_device(
+                    module_type, serial_number
+                )
 
-                # Serial number is already a string from config
-                if module_type == "CP20":
-                    self.device_services[serial_number] = CP20ServerService(
-                        serial_number
-                    )
-                if module_type == "XP24":
-                    self.device_services[serial_number] = XP24ServerService(
-                        serial_number
-                    )
-                elif module_type == "XP33":
-                    self.device_services[serial_number] = XP33ServerService(
-                        serial_number, "XP33"
-                    )
-                elif module_type == "XP33LR":
-                    self.device_services[serial_number] = XP33ServerService(
-                        serial_number, "XP33LR"
-                    )
-                elif module_type == "XP33LED":
-                    self.device_services[serial_number] = XP33ServerService(
-                        serial_number, "XP33LED"
-                    )
-                elif module_type == "XP20":
-                    self.device_services[serial_number] = XP20ServerService(
-                        serial_number
-                    )
-                elif module_type == "XP130":
-                    self.device_services[serial_number] = XP130ServerService(
-                        serial_number
-                    )
-                elif module_type == "XP230":
-                    self.device_services[serial_number] = XP230ServerService(
-                        serial_number
-                    )
-                else:
-                    self.logger.warning(
-                        f"Unknown device type '{module_type}' for serial {serial_number}"
-                    )
+            except ValueError as e:
+                # Factory raises ValueError for unknown device types
+                self.logger.warning(str(e))
 
             except Exception as e:
                 self.logger.error(
@@ -167,6 +136,8 @@ class ServerService:
             self.server_socket.bind(("0.0.0.0", self.port))
             self.server_socket.listen(1)  # Accept single connection as per spec
 
+            self._start_device_collector_thread()
+
             self.is_running = True
             self.logger.info(f"Conbus emulator server started on port {self.port}")
             self.logger.info(
@@ -221,17 +192,44 @@ class ServerService:
     ) -> None:
         """Handle individual client connection."""
         try:
+
+            idle_timeout = 300
+            rcv_timeout = 10
+
             # Set timeout for idle connections (30 seconds as per spec)
-            client_socket.settimeout(300.0)
+            client_socket.settimeout(rcv_timeout)
+            timeout = idle_timeout / rcv_timeout
 
             while True:
+
+                # send waiting buffer
+                for i in range(len(self.collector_buffer)):
+                    buffer = self.collector_buffer.pop()
+                    client_socket.send(buffer.encode("latin-1"))
+                    self.logger.debug(f"Sent buffer to {client_address}")
+
                 # Receive data from client
-                data = client_socket.recv(1024)
+                self.logger.debug(f"Receiving data {client_address}")
+                data = None
+                try:
+                    data = client_socket.recv(1024)
+                except socket.timeout:
+                    self.logger.debug(
+                        f"Timeout receiving data {client_address} ({timeout})"
+                    )
+                finally:
+                    timeout -= 1
+
                 if not data:
-                    break
+                    if timeout <= 0:
+                        break
+                    continue
+
+                # reset timeout on receiving data
+                timeout = idle_timeout / rcv_timeout
 
                 message = data.decode("latin-1").strip()
-                self.logger.info(f"Received from {client_address}: {message}")
+                self.logger.debug(f"Received from {client_address}: {message}")
 
                 # Process request (discover or data request)
                 responses = self._process_request(message)
@@ -239,10 +237,10 @@ class ServerService:
                 # Send responses
                 for response in responses:
                     client_socket.send(response.encode("latin-1"))
-                    self.logger.info(f"Sent to {client_address}: {response[:-1]}")
+                    self.logger.debug(f"Sent to {client_address}: {response[:-1]}")
 
         except socket.timeout:
-            self.logger.info(f"Client {client_address} timed out")
+            self.logger.debug(f"Client {client_address} timed out")
         except Exception as e:
             self.logger.error(f"Error handling client {client_address}: {e}")
         finally:
@@ -390,3 +388,48 @@ class ServerService:
         self.logger.info(
             f"Configuration reloaded: {len(self.devices)} devices, {len(self.device_services)} services"
         )
+
+    def _start_device_collector_thread(self) -> None:
+        """Start device buffer collector thread."""
+        if self.collector_thread and self.collector_thread.is_alive():
+            self.logger.debug("Collector thread already running")
+            return
+
+        # Start background thread to send storm telegrams
+        self.collector_thread = threading.Thread(
+            target=self._device_collector_thread, daemon=True, name="DeviceCollector"
+        )
+        self.collector_thread.start()
+        self.logger.info("Collector thread started")
+
+    def _stop_device_collector_thread(self) -> None:
+        """Stop device buffer collector thread."""
+        if not self.collector_thread or not self.collector_thread.is_alive():
+            self.logger.debug("Collector thread not running")
+            return
+
+        self.logger.info(f"Stopping collector thread: {self.collector_thread.name}")
+
+        # Wait for thread to finish (with timeout)
+        if self.collector_thread and self.collector_thread.is_alive():
+            self.collector_thread.join(timeout=1.0)
+
+            self.logger.info("Collector stopped.")
+
+    def _device_collector_thread(self) -> None:
+        """Device buffer collector thread."""
+        self.logger.info("Collector thread starting")
+
+        while True:
+            self.logger.debug(
+                f"Collector thread collecting ({len(self.collector_buffer)})"
+            )
+            collected = 0
+            for device_service in self.device_services.values():
+                telegram_buffer = device_service.collect_telegram_buffer()
+                self.collector_buffer.extend(telegram_buffer)
+                collected += len(telegram_buffer)
+
+            # Wait a bit before checking again
+            self.logger.debug(f"Collector thread collected ({collected})")
+            self.collector_stop_event.wait(timeout=1)

{conson_xp-1.4.0 → conson_xp-1.6.0}/src/xp/services/server/xp130_server_service.py

@@ -5,9 +5,10 @@ including response generation and device configuration handling.
 XP130 is an Ethernet/TCPIP interface module.
 """
 
-from typing import Dict
+from typing import Dict, Optional
 
 from xp.models import ModuleTypeCode
+from xp.services.actiontable.msactiontable_serializer import MsActionTableSerializer
 from xp.services.server.base_server_service import BaseServerService
 
 
@@ -25,11 +26,18 @@ class XP130ServerService(BaseServerService):
     and implements XP130 telegram format for Ethernet/TCPIP interface module.
     """
 
-    def __init__(self, serial_number: str):
+    def __init__(
+        self,
+        serial_number: str,
+        _variant: str = "",
+        _msactiontable_serializer: Optional[MsActionTableSerializer] = None,
+    ):
         """Initialize XP130 server service.
 
         Args:
             serial_number: The device serial number.
+            _variant: Reserved parameter for consistency (unused).
+            _msactiontable_serializer: Generic MsActionTable serializer (unused).
         """
         super().__init__(serial_number)
         self.device_type = "XP130"