conson-xp 1.3.0__tar.gz → 1.5.0__tar.gz

{conson_xp-1.3.0 → conson_xp-1.5.0}/PKG-INFO

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

{conson_xp-1.3.0 → conson_xp-1.5.0}/pyproject.toml

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

{conson_xp-1.3.0 → conson_xp-1.5.0}/src/xp/__init__.py

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

{conson_xp-1.3.0 → conson_xp-1.5.0}/src/xp/models/conbus/conbus_discover.py

@@ -2,7 +2,23 @@
 
 from dataclasses import dataclass
 from datetime import datetime
-from typing import Any, Dict, Optional
+from typing import Any, Dict, Optional, TypedDict
+
+
+class DiscoveredDevice(TypedDict):
+    """Discovered device information.
+
+    Attributes:
+        serial_number: Serial number of the device.
+        module_type: Module type name (e.g., "XP24", "XP230"), None if not yet retrieved.
+        module_type_code: Module type code (e.g., "13", "10"), None if not yet retrieved.
+        module_type_name: Module type name converted from module_type_code, None if not yet retrieved.
+    """
+
+    serial_number: str
+    module_type: Optional[str]
+    module_type_code: Optional[int]
+    module_type_name: Optional[str]
 
 
 @dataclass
@@ -13,7 +29,7 @@ class ConbusDiscoverResponse:
         success: Whether the operation was successful.
         sent_telegram: Telegram sent to discover devices.
         received_telegrams: List of telegrams received.
-        discovered_devices: List of discovered device serial numbers.
+        discovered_devices: List of discovered devices with their module types.
         error: Error message if operation failed.
         timestamp: Timestamp of the response.
     """
@@ -21,7 +37,7 @@ class ConbusDiscoverResponse:
     success: bool
     sent_telegram: Optional[str] = None
     received_telegrams: Optional[list[str]] = None
-    discovered_devices: Optional[list[str]] = None
+    discovered_devices: Optional[list[DiscoveredDevice]] = None
     error: Optional[str] = None
     timestamp: Optional[datetime] = None
 

{conson_xp-1.3.0 → conson_xp-1.5.0}/src/xp/models/telegram/system_telegram.py

@@ -22,10 +22,10 @@ class SystemTelegram(Telegram):
     Examples: <S0020012521F02D18FN>
 
     Attributes:
-        serial_number: Serial number of the device.
-        system_function: System function code.
-        data: Data payload.
-        datapoint_type: Type of datapoint.
+        serial_number: Serial number of the device (0020012521)
+        system_function: System function code (02).
+        data: Data payload (18)
+        datapoint_type: Type of datapoint (18).
     """
 
     serial_number: str = ""

{conson_xp-1.3.0 → conson_xp-1.5.0}/src/xp/services/conbus/conbus_discover_service.py

@@ -10,7 +10,10 @@ from typing import Callable, Optional
 from twisted.internet.posixbase import PosixReactorBase
 
 from xp.models import ConbusClientConfig, ConbusDiscoverResponse
+from xp.models.conbus.conbus_discover import DiscoveredDevice
 from xp.models.protocol.conbus_protocol import TelegramReceivedEvent
+from xp.models.telegram.datapoint_type import DataPointType
+from xp.models.telegram.module_type_code import MODULE_TYPE_REGISTRY
 from xp.models.telegram.system_function import SystemFunction
 from xp.models.telegram.telegram_type import TelegramType
 from xp.services.protocol.conbus_protocol import ConbusProtocol
@@ -73,6 +76,7 @@ class ConbusDiscoverService(ConbusProtocol):
             self.discovered_device_result.received_telegrams = []
         self.discovered_device_result.received_telegrams.append(telegram_received.frame)
 
+        # Check for discovery response
         if (
             telegram_received.checksum_valid
             and telegram_received.telegram_type == TelegramType.REPLY.value
@@ -80,8 +84,30 @@ class ConbusDiscoverService(ConbusProtocol):
             and len(telegram_received.payload) == 15
         ):
             self.discovered_device(telegram_received.serial_number)
+
+        # Check for module type response (F02D07)
+        elif (
+            telegram_received.checksum_valid
+            and telegram_received.telegram_type == TelegramType.REPLY.value
+            and telegram_received.payload[11:17] == "F02D07"
+            and len(telegram_received.payload) >= 19
+        ):
+            self.handle_module_type_code_response(
+                telegram_received.serial_number, telegram_received.payload[17:19]
+            )
+        # Check for module type response (F02D00)
+        elif (
+            telegram_received.checksum_valid
+            and telegram_received.telegram_type == TelegramType.REPLY.value
+            and telegram_received.payload[11:17] == "F02D00"
+            and len(telegram_received.payload) >= 19
+        ):
+            self.handle_module_type_response(
+                telegram_received.serial_number, telegram_received.payload[17:19]
+            )
+
         else:
-            self.logger.debug("Not a discover response")
+            self.logger.debug("Not a discover or module type response")
 
     def discovered_device(self, serial_number: str) -> None:
         """Handle discovered device event.
@@ -92,10 +118,102 @@ class ConbusDiscoverService(ConbusProtocol):
         self.logger.info("discovered_device: %s", serial_number)
         if not self.discovered_device_result.discovered_devices:
             self.discovered_device_result.discovered_devices = []
-        self.discovered_device_result.discovered_devices.append(serial_number)
+
+        # Add device with module_type as None initially
+        device: DiscoveredDevice = {
+            "serial_number": serial_number,
+            "module_type": None,
+            "module_type_code": None,
+            "module_type_name": None,
+        }
+        self.discovered_device_result.discovered_devices.append(device)
+
+        # Send READ_DATAPOINT telegram to query module type
+        self.logger.debug(f"Sending module type query for {serial_number}")
+        self.send_telegram(
+            telegram_type=TelegramType.SYSTEM,
+            serial_number=serial_number,
+            system_function=SystemFunction.READ_DATAPOINT,
+            data_value=DataPointType.MODULE_TYPE.value,
+        )
+
+        self.send_telegram(
+            telegram_type=TelegramType.SYSTEM,
+            serial_number=serial_number,
+            system_function=SystemFunction.READ_DATAPOINT,
+            data_value=DataPointType.MODULE_TYPE_CODE.value,
+        )
+
         if self.progress_callback:
             self.progress_callback(serial_number)
 
+    def handle_module_type_code_response(
+        self, serial_number: str, module_type_code: str
+    ) -> None:
+        """Handle module type code response and update discovered device.
+
+        Args:
+            serial_number: Serial number of the device.
+            module_type_code: Module type code from telegram (e.g., "07", "24").
+        """
+        self.logger.info(
+            f"Received module type code {module_type_code} for {serial_number}"
+        )
+
+        # Convert module type code to name
+        code = 0
+        try:
+            # The telegram format uses decimal values represented as strings
+            code = int(module_type_code)
+            module_info = MODULE_TYPE_REGISTRY.get(code)
+
+            if module_info:
+                module_type_name = module_info["name"]
+                self.logger.debug(
+                    f"Module type code {module_type_code} ({code}) = {module_type_name}"
+                )
+            else:
+                module_type_name = f"UNKNOWN_{module_type_code}"
+                self.logger.warning(
+                    f"Unknown module type code {module_type_code} ({code})"
+                )
+
+        except ValueError:
+            self.logger.error(
+                f"Invalid module type code format: {module_type_code} for {serial_number}"
+            )
+            module_type_name = f"INVALID_{module_type_code}"
+
+        # Find and update the device in discovered_devices
+        if self.discovered_device_result.discovered_devices:
+            for device in self.discovered_device_result.discovered_devices:
+                if device["serial_number"] == serial_number:
+                    device["module_type_code"] = code
+                    device["module_type_name"] = module_type_name
+                    self.logger.debug(
+                        f"Updated device {serial_number} with module_type {module_type_name}"
+                    )
+                    break
+
+    def handle_module_type_response(self, serial_number: str, module_type: str) -> None:
+        """Handle module type response and update discovered device.
+
+        Args:
+            serial_number: Serial number of the device.
+            module_type: Module type code from telegram (e.g., "XP33", "XP24").
+        """
+        self.logger.info(f"Received module type {module_type} for {serial_number}")
+
+        # Find and update the device in discovered_devices
+        if self.discovered_device_result.discovered_devices:
+            for device in self.discovered_device_result.discovered_devices:
+                if device["serial_number"] == serial_number:
+                    device["module_type"] = module_type
+                    self.logger.debug(
+                        f"Updated device {serial_number} with module_type {module_type}"
+                    )
+                    break
+
     def timeout(self) -> bool:
         """Handle timeout event to stop discovery.
 

{conson_xp-1.3.0 → conson_xp-1.5.0}/src/xp/services/conbus/conbus_scan_service.py

@@ -128,7 +128,7 @@ class ConbusScanService(ConbusProtocol):
         function_code: str,
         progress_callback: Callable[[str], None],
         finish_callback: Callable[[ConbusResponse], None],
-        timeout_seconds: Optional[float] = None,
+        timeout_seconds: float = 0.25,
     ) -> None:
         """Scan a module for all datapoints by function code.
 

{conson_xp-1.3.0 → conson_xp-1.5.0}/src/xp/services/protocol/telegram_protocol.py

@@ -124,7 +124,7 @@ class TelegramProtocol(protocol.Protocol):
             payload = telegram[:-2]  # S0123450001F02D12
             checksum = telegram[-2:].decode()  # FK
             serial_number = (
-                telegram[1:11] if telegram_type in "S" else b""
+                telegram[1:11] if telegram_type in ("S", "R") else b""
             )  # 0123450001
             calculated_checksum = calculate_checksum(payload.decode(encoding="latin-1"))
 
@@ -151,9 +151,9 @@ class TelegramProtocol(protocol.Protocol):
             await self.event_bus.dispatch(
                 TelegramReceivedEvent(
                     protocol=self,
-                    frame=frame.decode(),
-                    telegram=telegram.decode(),
-                    payload=payload.decode(),
+                    frame=frame.decode("latin-1"),
+                    telegram=telegram.decode("latin-1"),
+                    payload=payload.decode("latin-1"),
                     telegram_type=telegram_type,
                     serial_number=serial_number,
                     checksum=checksum,

{conson_xp-1.3.0 → conson_xp-1.5.0}/src/xp/services/server/base_server_service.py

@@ -5,9 +5,11 @@ containing common functionality like module type response generation.
 """
 
 import logging
+import threading
 from abc import ABC
 from typing import Optional
 
+from xp.models import ModuleTypeCode
 from xp.models.telegram.datapoint_type import DataPointType
 from xp.models.telegram.system_function import SystemFunction
 from xp.models.telegram.system_telegram import SystemTelegram
@@ -33,7 +35,7 @@ class BaseServerService(ABC):
 
         # Must be set by subclasses
         self.device_type: str = ""
-        self.module_type_code: int = 0
+        self.module_type_code: ModuleTypeCode = ModuleTypeCode.NOMOD
         self.hardware_version: str = ""
         self.software_version: str = ""
         self.device_status: str = "OK"
@@ -41,6 +43,9 @@ 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
+
     def generate_datapoint_type_response(
         self, datapoint_type: DataPointType
     ) -> Optional[str]:
@@ -54,11 +59,11 @@ class BaseServerService(ABC):
         """
         datapoint_values = {
             DataPointType.TEMPERATURE: self.temperature,
-            DataPointType.MODULE_TYPE_CODE: f"{self.module_type_code:02X}",
+            DataPointType.MODULE_TYPE_CODE: f"{self.module_type_code.value:02}",
             DataPointType.SW_VERSION: self.software_version,
             DataPointType.MODULE_STATE: self.device_status,
             DataPointType.MODULE_TYPE: self.device_type,
-            DataPointType.LINK_NUMBER: f"{self.link_number:02X}",
+            DataPointType.LINK_NUMBER: f"{self.link_number:02}",
             DataPointType.VOLTAGE: self.voltage,
             DataPointType.HW_VERSION: self.hardware_version,
             DataPointType.MODULE_ERROR_CODE: "00",
@@ -187,11 +192,15 @@ class BaseServerService(ABC):
         self.logger.debug(
             f"_handle_return_data_request {self.device_type} request: {request}"
         )
+        module_specific = self._handle_device_specific_data_request(request)
+        if module_specific:
+            return module_specific
+
         if request.datapoint_type:
             return self.generate_datapoint_type_response(request.datapoint_type)
 
         # Allow device-specific handlers
-        return self._handle_device_specific_data_request(request)
+        return None
 
     def _handle_device_specific_data_request(
         self, request: SystemTelegram
@@ -252,3 +261,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.3.0 → conson_xp-1.5.0}/src/xp/services/server/cp20_server_service.py

@@ -6,6 +6,7 @@ including response generation and device configuration handling.
 
 from typing import Dict, Optional
 
+from xp.models import ModuleTypeCode
 from xp.models.telegram.system_telegram import SystemTelegram
 from xp.services.server.base_server_service import BaseServerService
 
@@ -32,7 +33,7 @@ class CP20ServerService(BaseServerService):
         """
         super().__init__(serial_number)
         self.device_type = "CP20"
-        self.module_type_code = 2  # CP20 module type from registry
+        self.module_type_code = ModuleTypeCode.CP20  # CP20 module type from registry
         self.firmware_version = "CP20_V0.01.05"
 
     def _handle_device_specific_data_request(

{conson_xp-1.3.0 → conson_xp-1.5.0}/src/xp/services/server/server_service.py

@@ -71,6 +71,13 @@ class ServerService:
             ],
         ] = {}  # 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__)
 
@@ -167,6 +174,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 +230,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 +275,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:
@@ -253,15 +289,86 @@ class ServerService:
                 self.logger.error(f"Error closing client socket: {e}")
 
     def _process_request(self, message: str) -> List[str]:
-        """Process incoming request and generate responses."""
+        """Process incoming request and generate responses.
+
+        Args:
+            message: Message potentially containing multiple telegrams in format <TELEGRAM><TELEGRAM2>...
+
+        Returns:
+            List of responses for all processed telegrams.
+        """
+        responses: list[str] = []
+
+        try:
+            # Split message into individual telegrams (enclosed in angle brackets)
+            telegrams = self._split_telegrams(message)
+
+            if not telegrams:
+                self.logger.warning(f"No valid telegrams found in message: {message}")
+                return responses
+
+            # Process each telegram
+            for telegram in telegrams:
+                telegram_responses = self._process_single_telegram(telegram)
+                responses.extend(telegram_responses)
+
+        except Exception as e:
+            self.logger.error(f"Error processing request: {e}")
+
+        return responses
+
+    def _split_telegrams(self, message: str) -> List[str]:
+        """Split message into individual telegrams.
+
+        Args:
+            message: Raw message containing one or more telegrams in format <TELEGRAM><TELEGRAM2>...
+
+        Returns:
+            List of individual telegram strings including angle brackets.
+        """
+        telegrams = []
+        start = 0
+
+        while True:
+            # Find the start of a telegram
+            start_idx = message.find("<", start)
+            if start_idx == -1:
+                break
+
+            # Find the end of the telegram
+            end_idx = message.find(">", start_idx)
+            if end_idx == -1:
+                self.logger.warning(
+                    f"Incomplete telegram found starting at position {start_idx}"
+                )
+                break
+
+            # Extract telegram including angle brackets
+            telegram = message[start_idx : end_idx + 1]
+            telegrams.append(telegram)
+
+            # Move to the next position
+            start = end_idx + 1
+
+        return telegrams
+
+    def _process_single_telegram(self, telegram: str) -> List[str]:
+        """Process a single telegram and generate responses.
+
+        Args:
+            telegram: A single telegram string.
+
+        Returns:
+            List of response strings for this telegram.
+        """
         responses: list[str] = []
 
         try:
             # Parse the telegram
-            parsed_telegram = self.telegram_service.parse_system_telegram(message)
+            parsed_telegram = self.telegram_service.parse_system_telegram(telegram)
 
             if not parsed_telegram:
-                self.logger.warning(f"Failed to parse telegram: {message}")
+                self.logger.warning(f"Failed to parse telegram: {telegram}")
                 return responses
 
             # Handle discover requests
@@ -296,7 +403,7 @@ class ServerService:
                         )
 
         except Exception as e:
-            self.logger.error(f"Error processing request: {e}")
+            self.logger.error(f"Error processing telegram: {e}")
 
         return responses
 
@@ -319,3 +426,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.3.0 → conson_xp-1.5.0}/src/xp/services/server/xp130_server_service.py

@@ -7,6 +7,7 @@ XP130 is an Ethernet/TCPIP interface module.
 
 from typing import Dict
 
+from xp.models import ModuleTypeCode
 from xp.services.server.base_server_service import BaseServerService
 
 
@@ -32,7 +33,7 @@ class XP130ServerService(BaseServerService):
         """
         super().__init__(serial_number)
         self.device_type = "XP130"
-        self.module_type_code = 13  # XP130 module type from registry
+        self.module_type_code = ModuleTypeCode.XP130  # XP130 module type from registry
         self.firmware_version = "XP130_V1.02.15"
 
         # XP130-specific network configuration

{conson_xp-1.3.0 → conson_xp-1.5.0}/src/xp/services/server/xp20_server_service.py

@@ -6,6 +6,7 @@ including response generation and device configuration handling.
 
 from typing import Dict
 
+from xp.models import ModuleTypeCode
 from xp.services.server.base_server_service import BaseServerService
 
 
@@ -31,7 +32,7 @@ class XP20ServerService(BaseServerService):
         """
         super().__init__(serial_number)
         self.device_type = "XP20"
-        self.module_type_code = 33  # XP20 module type from registry
+        self.module_type_code = ModuleTypeCode.XP20  # XP20 module type from registry
         self.firmware_version = "XP20_V0.01.05"
 
     def get_device_info(self) -> Dict:

{conson_xp-1.3.0 → conson_xp-1.5.0}/src/xp/services/server/xp230_server_service.py

@@ -6,6 +6,7 @@ including response generation and device configuration handling.
 
 from typing import Dict
 
+from xp.models import ModuleTypeCode
 from xp.services.server.base_server_service import BaseServerService
 
 
@@ -31,7 +32,7 @@ class XP230ServerService(BaseServerService):
         """
         super().__init__(serial_number)
         self.device_type = "XP230"
-        self.module_type_code = 34  # XP230 module type from registry
+        self.module_type_code = ModuleTypeCode.XP230  # XP230 module type from registry
         self.firmware_version = "XP230_V1.00.04"
 
     def get_device_info(self) -> Dict: