cgse-common 0.17.3__tar.gz → 0.17.4__tar.gz

{cgse_common-0.17.3 → cgse_common-0.17.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cgse-common
-Version: 0.17.3
+Version: 0.17.4
 Summary: Software framework to support hardware testing
 Author: IvS KU Leuven
 Maintainer-email: Rik Huygen <rik.huygen@kuleuven.be>, Sara Regibo <sara.regibo@kuleuven.be>

{cgse_common-0.17.3 → cgse_common-0.17.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cgse-common"
-version = "0.17.3"
+version = "0.17.4"
 description = "Software framework to support hardware testing"
 authors = [
     {name = "IvS KU Leuven"}

{cgse_common-0.17.3 → cgse_common-0.17.4}/src/egse/device.py

@@ -339,6 +339,76 @@ class AsyncDeviceTransport:
         return await self.trans(command)
 
 
+class AsyncDeviceConnectionInterface(DeviceConnectionObservable):
+    """Generic connection interface for all Device classes and Controllers.
+
+    This interface shall be implemented in the Controllers that directly connect to the
+    hardware, but also in the simulators to guarantee an identical interface as the controllers.
+
+    This interface will be implemented in the Proxy classes through the
+    YAML definitions. Therefore, the YAML files shall define at least
+    the following commands: `connect`, `disconnect`, `reconnect`, `is_connected`.
+    """
+
+    def __init__(self):
+        super().__init__()
+
+    def __enter__(self):
+        self.connect()
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        self.disconnect()
+
+    async def connect(self) -> None:
+        """Connect to the device controller.
+
+        Raises:
+            ConnectionError: when the connection can not be opened.
+        """
+
+        raise NotImplementedError
+
+    async def disconnect(self) -> None:
+        """Disconnect from the device controller.
+
+        Raises:
+            ConnectionError: when the connection can not be closed.
+        """
+        raise NotImplementedError
+
+    async def reconnect(self):
+        """Reconnect the device controller.
+
+        Raises:
+            ConnectionError: when the device can not  be reconnected for some reason.
+        """
+        raise NotImplementedError
+
+    async def is_connected(self) -> bool:
+        """Check if the device is connected.
+
+        Returns:
+            True if the device is connected and responds to a command, False otherwise.
+        """
+        raise NotImplementedError
+
+
+class AsyncDeviceInterface(AsyncDeviceConnectionInterface):
+    """A generic interface for all device classes."""
+
+    def is_simulator(self) -> bool:
+        """Checks whether the device is a simulator rather than a real hardware controller.
+
+        This can be useful for testing purposes or when doing actual movement simulations.
+
+        Returns:
+            True if the Device is a Simulator; False if the Device is connected to real hardware.
+        """
+
+        raise NotImplementedError
+
+
 class DeviceFactoryInterface:
     """
     Base class for creating a device factory class to access devices.

{cgse_common-0.17.3 → cgse_common-0.17.4}/src/egse/hk.py

@@ -51,8 +51,8 @@ class TmDictionaryColumns(str, Enum):
     """  # noqa
 
     STORAGE_MNEMONIC = "Storage mnemonic"
-    CORRECT_HK_NAMES = "CAM EGSE mnemonic"
-    ORIGINAL_EGSE_HK_NAMES = "Original name in EGSE"
+    CORRECT_HK_NAMES = "CGSE mnemonic"
+    ORIGINAL_EGSE_HK_NAMES = "Original name in CGSE"
     SYNOPTICS_ORIGIN = f"Origin of synoptics at {get_site_id()}"
     TIMESTAMP_NAMES = "Name of corresponding timestamp"
     DESCRIPTION = "Description"

{cgse_common-0.17.3 → cgse_common-0.17.4}/src/egse/log.py

@@ -131,6 +131,14 @@ for handler in root_logger.handlers:
         handler.addFilter(NonEGSEFilter())
         handler.addFilter(PackageFilter())
 
+try:
+    from textual.logging import TextualHandler
+
+    root_logger.addHandler(TextualHandler())
+except ImportError:
+    pass
+
+
 logger = egse_logger
 
 if __name__ == "__main__":

{cgse_common-0.17.3 → cgse_common-0.17.4}/src/egse/scpi.py

@@ -4,17 +4,23 @@ from typing import Any
 from typing import Dict
 from typing import Optional
 
+from egse.device import AsyncDeviceInterface
 from egse.device import AsyncDeviceTransport
 from egse.device import DeviceConnectionError
 from egse.device import DeviceError
 from egse.device import DeviceTimeoutError
+from egse.env import bool_env
 from egse.log import logger
 
-# Constants that can be overridden by specific device implementations
 DEFAULT_READ_TIMEOUT = 1.0  # seconds
 DEFAULT_CONNECT_TIMEOUT = 3.0  # seconds
 IDENTIFICATION_QUERY = "*IDN?"
 
+VERBOSE_DEBUG = bool_env("VERBOSE_DEBUG")
+
+SEPARATOR = b"\n"
+SEPARATOR_STR = SEPARATOR.decode()
+
 
 class SCPICommand:
     """Base class for SCPI commands."""
@@ -32,7 +38,7 @@ class SCPICommand:
         raise NotImplementedError("Subclasses must implement get_cmd_string().")
 
 
-class AsyncSCPIInterface(AsyncDeviceTransport):
+class AsyncSCPIInterface(AsyncDeviceInterface, AsyncDeviceTransport):
     """Generic asynchronous interface for devices that use SCPI commands over Ethernet."""
 
     def __init__(
@@ -56,7 +62,9 @@ class AsyncSCPIInterface(AsyncDeviceTransport):
             read_timeout: Timeout for read operations in seconds
             id_validation: String that should appear in the device's identification response
         """
-        self.device_name = device_name
+        super().__init__()
+
+        self._device_name = device_name
         self.hostname = hostname
         self.port = port
         self.settings = settings or {}
@@ -70,8 +78,66 @@ class AsyncSCPIInterface(AsyncDeviceTransport):
         self._connect_lock = asyncio.Lock()
         """Prevents multiple, simultaneous connect or disconnect attempts."""
         self._io_lock = asyncio.Lock()
-        """Prevents multiple coroutines from attempting to read, write or query from the same stream
-        at the same time."""
+        """Prevents multiple coroutines from attempting to read, write or query from the same stream at the same time."""
+
+    def is_simulator(self) -> bool:
+        return False
+
+    @property
+    def device_name(self) -> str:
+        return self._device_name
+
+    async def initialize(self, commands: list[tuple[str, bool]] = None, reset_device: bool = False) -> list[str | None]:
+        """Initialize the device with optional reset and command sequence.
+
+        Performs device initialization by optionally resetting the device and then
+        executing a sequence of commands. Each command can optionally expect a
+        response that will be logged for debugging purposes.
+
+        Args:
+            commands: List of tuples containing (command_string, expects_response).
+                Each tuple specifies a command to send and whether to wait for and
+                log the response. Defaults to None (no commands executed).
+            reset_device: Whether to send a reset command (*RST) before executing
+                the command sequence. Defaults to False.
+
+        Returns:
+           Response for each of the commands, or None when no response was expected.
+
+        Raises:
+            Any exceptions raised by the underlying write() or trans() methods,
+            typically communication errors or device timeouts.
+
+        Example:
+            await device.initialize(
+                [
+                    ("*IDN?", True),           # Query device ID, expect response
+                    ("SYST:ERR?", True),       # Check for errors, expect response
+                    ("OUTP ON", False),        # Enable output, no response expected
+                ],
+                reset_device=True
+            )
+        """
+
+        commands = commands or []
+        responses = []
+
+        if reset_device:
+            logger.info(f"Resetting the {self._device_name}...")
+            await self.write("*RST")  # this also resets the user-defined buffer
+
+        for cmd, expects_response in commands:
+            if expects_response:
+                logger.debug(f"Sending {cmd}...")
+                response = (await self.trans(cmd)).decode().strip()
+                responses.append(response)
+                logger.debug(f"{response = }")
+            else:
+                logger.debug(f"Sending {cmd}...")
+                await self.write(cmd)
+                responses.append(None)
+
+        return responses
 
     async def connect(self) -> None:
         """Connect to the device asynchronously.
@@ -84,47 +150,51 @@ class AsyncSCPIInterface(AsyncDeviceTransport):
         async with self._connect_lock:
             # Sanity checks
             if self._is_connection_open:
-                logger.warning(f"{self.device_name}: Trying to connect to an already connected device.")
+                logger.warning(f"{self._device_name}: Trying to connect to an already connected device.")
                 return
 
             if not self.hostname:
-                raise ValueError(f"{self.device_name}: Hostname is not initialized.")
+                raise ValueError(f"{self._device_name}: Hostname is not initialized.")
 
             if not self.port:
-                raise ValueError(f"{self.device_name}: Port number is not initialized.")
+                raise ValueError(f"{self._device_name}: Port number is not initialized.")
 
             # Attempt to establish a connection
             try:
-                logger.debug(f'Connecting to {self.device_name} at "{self.hostname}" using port {self.port}')
+                logger.debug(f'Connecting to {self._device_name} at "{self.hostname}" using port {self.port}')
 
                 connect_task = asyncio.open_connection(self.hostname, self.port)
                 self._reader, self._writer = await asyncio.wait_for(connect_task, timeout=self.connect_timeout)
 
                 self._is_connection_open = True
 
-                logger.debug(f"Successfully connected to {self.device_name}.")
+                response = await self.read_string()
+                if VERBOSE_DEBUG:
+                    logger.debug(f"Response after connection: {response}")
+
+                logger.debug(f"Successfully connected to {self._device_name}.")
 
             except asyncio.TimeoutError as exc:
                 raise DeviceTimeoutError(
-                    self.device_name, f"Connection to {self.hostname}:{self.port} timed out"
+                    self._device_name, f"Connection to {self.hostname}:{self.port} timed out"
                 ) from exc
             except ConnectionRefusedError as exc:
                 raise DeviceConnectionError(
-                    self.device_name, f"Connection refused to {self.hostname}:{self.port}"
+                    self._device_name, f"Connection refused to {self.hostname}:{self.port}"
                 ) from exc
             except socket.gaierror as exc:
-                raise DeviceConnectionError(self.device_name, f"Address resolution error for {self.hostname}") from exc
+                raise DeviceConnectionError(self._device_name, f"Address resolution error for {self.hostname}") from exc
             except socket.herror as exc:
-                raise DeviceConnectionError(self.device_name, f"Host address error for {self.hostname}") from exc
+                raise DeviceConnectionError(self._device_name, f"Host address error for {self.hostname}") from exc
             except OSError as exc:
-                raise DeviceConnectionError(self.device_name, f"OS error: {exc}") from exc
+                raise DeviceConnectionError(self._device_name, f"OS error: {exc}") from exc
 
             # Validate device identity if requested
             if self.id_validation:
                 logger.debug("Validating connection..")
                 if not await self.is_connected():
                     await self.disconnect()
-                    raise DeviceConnectionError(self.device_name, "Device connected but failed identity verification")
+                    raise DeviceConnectionError(self._device_name, "Device connected but failed identity verification")
 
     async def disconnect(self) -> None:
         """Disconnect from the device asynchronously.
@@ -135,22 +205,20 @@ class AsyncSCPIInterface(AsyncDeviceTransport):
         async with self._connect_lock:
             try:
                 if self._is_connection_open and self._writer is not None:
-                    logger.debug(f"Disconnecting from {self.device_name} at {self.hostname}")
+                    logger.debug(f"Disconnecting from {self._device_name} at {self.hostname}")
                     self._writer.close()
                     await self._writer.wait_closed()
                     self._writer = None
                     self._reader = None
                     self._is_connection_open = False
             except Exception as exc:
-                raise DeviceConnectionError(self.device_name, f"Could not close connection: {exc}") from exc
+                raise DeviceConnectionError(self._device_name, f"Could not close connection: {exc}") from exc
 
     async def reconnect(self) -> None:
         """Reconnect to the device asynchronously."""
-        async with self._connect_lock:
-            if self._is_connection_open:
-                await self.disconnect()
-                await asyncio.sleep(0.1)
-            await self.connect()
+        await self.disconnect()
+        await asyncio.sleep(0.1)
+        await self.connect()
 
     async def is_connected(self) -> bool:
         """Check if the device is connected and responds correctly to identification.
@@ -168,7 +236,7 @@ class AsyncSCPIInterface(AsyncDeviceTransport):
             # Validate the response if validation string is provided
             if self.id_validation and self.id_validation not in id_response:
                 logger.error(
-                    f"{self.device_name}: Device did not respond correctly to identification query. "
+                    f"{self._device_name}: Device did not respond correctly to identification query. "
                     f'Expected "{self.id_validation}" in response, got: {id_response}'
                 )
                 await self.disconnect()
@@ -177,8 +245,7 @@ class AsyncSCPIInterface(AsyncDeviceTransport):
             return True
 
         except DeviceError as exc:
-            logger.exception(exc)
-            logger.error(f"{self.device_name}: Connection test failed")
+            logger.error(f"{self._device_name}: Connection test failed: {exc}", exc_info=True)
             await self.disconnect()
             return False
 
@@ -195,19 +262,20 @@ class AsyncSCPIInterface(AsyncDeviceTransport):
         async with self._io_lock:
             try:
                 if not self._is_connection_open or self._writer is None:
-                    raise DeviceConnectionError(self.device_name, "Device not connected, use connect() first")
+                    raise DeviceConnectionError(self._device_name, "Device not connected, use connect() first")
 
-                # Ensure command ends with newline
-                if not command.endswith("\n"):
-                    command += "\n"
+                # Ensure command ends with the proper separator or terminator
+                if not command.endswith(SEPARATOR_STR):
+                    command += SEPARATOR_STR
 
+                logger.info(f"-----> {command}")
                 self._writer.write(command.encode())
                 await self._writer.drain()
 
             except asyncio.TimeoutError as exc:
-                raise DeviceTimeoutError(self.device_name, "Write operation timed out") from exc
+                raise DeviceTimeoutError(self._device_name, "Write operation timed out") from exc
             except (ConnectionError, OSError) as exc:
-                raise DeviceConnectionError(self.device_name, f"Communication error: {exc}") from exc
+                raise DeviceConnectionError(self._device_name, f"Communication error: {exc}") from exc
 
     async def read(self) -> bytes:
         """
@@ -222,7 +290,7 @@ class AsyncSCPIInterface(AsyncDeviceTransport):
         """
         async with self._io_lock:
             if not self._is_connection_open or self._reader is None:
-                raise DeviceConnectionError(self.device_name, "Device not connected, use connect() first")
+                raise DeviceConnectionError(self._device_name, "Device not connected, use connect() first")
 
             try:
                 # First, small delay to allow device to prepare response
@@ -231,18 +299,19 @@ class AsyncSCPIInterface(AsyncDeviceTransport):
                 # Try to read until newline (common SCPI terminator)
                 try:
                     response = await asyncio.wait_for(
-                        self._reader.readuntil(separator=b"\n"), timeout=self.read_timeout
+                        self._reader.readuntil(separator=SEPARATOR), timeout=self.read_timeout
                     )
+                    logger.info(f"<----- {response}")
                     return response
 
                 except asyncio.IncompleteReadError as exc:
                     # Connection closed before receiving full response
-                    logger.warning(f"{self.device_name}: Incomplete read, got {len(exc.partial)} bytes")
-                    return exc.partial if exc.partial else b"\r\n"
+                    logger.warning(f"{self._device_name}: Incomplete read, got {len(exc.partial)} bytes")
+                    return exc.partial if exc.partial else SEPARATOR
 
                 except asyncio.LimitOverrunError:
                     # Response too large for buffer
-                    logger.warning(f"{self.device_name}: Response exceeded buffer limits")
+                    logger.warning(f"{self._device_name}: Response exceeded buffer limits")
                     # Fall back to reading a large chunk
                     return await asyncio.wait_for(
                         self._reader.read(8192),  # Larger buffer for exceptional cases
@@ -250,9 +319,9 @@ class AsyncSCPIInterface(AsyncDeviceTransport):
                     )
 
             except asyncio.TimeoutError as exc:
-                raise DeviceTimeoutError(self.device_name, "Read operation timed out") from exc
+                raise DeviceTimeoutError(self._device_name, "Read operation timed out") from exc
             except Exception as exc:
-                raise DeviceConnectionError(self.device_name, f"Read error: {exc}") from exc
+                raise DeviceConnectionError(self._device_name, f"Read error: {exc}") from exc
 
     async def trans(self, command: str) -> bytes:
         """
@@ -273,33 +342,35 @@ class AsyncSCPIInterface(AsyncDeviceTransport):
         async with self._io_lock:
             try:
                 if not self._is_connection_open or self._writer is None:
-                    raise DeviceConnectionError(self.device_name, "Device not connected, use connect() first")
+                    raise DeviceConnectionError(self._device_name, "Device not connected, use connect() first")
 
-                # Ensure command ends with newline
-                if not command.endswith("\n"):
-                    command += "\n"
+                # Ensure command ends with the required terminator
+                if not command.endswith(SEPARATOR_STR):
+                    command += SEPARATOR_STR
 
+                logger.info(f"-----> {command=}")
                 self._writer.write(command.encode())
                 await self._writer.drain()
 
-                # First, small delay to allow device to prepare response
+                # First, small delay to allow the device to prepare a response
                 await asyncio.sleep(0.01)
 
-                # Try to read until newline (common SCPI terminator)
+                # Try to read until the required separator (common SCPI terminator)
                 try:
                     response = await asyncio.wait_for(
-                        self._reader.readuntil(separator=b"\n"), timeout=self.read_timeout
+                        self._reader.readuntil(separator=SEPARATOR), timeout=self.read_timeout
                     )
+                    logger.info(f"<----- {response=}")
                     return response
 
                 except asyncio.IncompleteReadError as exc:
                     # Connection closed before receiving full response
-                    logger.warning(f"{self.device_name}: Incomplete read, got {len(exc.partial)} bytes")
-                    return exc.partial if exc.partial else b"\r\n"
+                    logger.warning(f"{self._device_name}: Incomplete read, got {len(exc.partial)} bytes")
+                    return exc.partial if exc.partial else SEPARATOR
 
                 except asyncio.LimitOverrunError:
                     # Response too large for buffer
-                    logger.warning(f"{self.device_name}: Response exceeded buffer limits")
+                    logger.warning(f"{self._device_name}: Response exceeded buffer limits")
                     # Fall back to reading a large chunk
                     return await asyncio.wait_for(
                         self._reader.read(8192),  # Larger buffer for exceptional cases
@@ -307,11 +378,11 @@ class AsyncSCPIInterface(AsyncDeviceTransport):
                     )
 
             except asyncio.TimeoutError as exc:
-                raise DeviceTimeoutError(self.device_name, "Communication timed out") from exc
+                raise DeviceTimeoutError(self._device_name, "Communication timed out") from exc
             except (ConnectionError, OSError) as exc:
-                raise DeviceConnectionError(self.device_name, f"Communication error: {exc}") from exc
+                raise DeviceConnectionError(self._device_name, f"Communication error: {exc}") from exc
             except Exception as exc:
-                raise DeviceConnectionError(self.device_name, f"Transaction error: {exc}") from exc
+                raise DeviceConnectionError(self._device_name, f"Transaction error: {exc}") from exc
 
     async def __aenter__(self):
         """Async context manager entry."""

cgse_common-0.17.4/src/egse/socketdevice.py

@@ -0,0 +1,380 @@
+"""
+This module defines base classes and generic functions to work with sockets.
+"""
+
+import asyncio
+import select
+import socket
+import time
+from typing import Optional
+
+from egse.device import AsyncDeviceInterface
+from egse.device import AsyncDeviceTransport
+from egse.device import DeviceConnectionError
+from egse.device import DeviceConnectionInterface
+from egse.device import DeviceTimeoutError
+from egse.device import DeviceTransport
+from egse.log import logger
+from egse.system import type_name
+
+SEPARATOR = b"\x03"
+SEPARATOR_STR = SEPARATOR.decode()
+
+
+class SocketDevice(DeviceConnectionInterface, DeviceTransport):
+    """Base class that implements the socket interface."""
+
+    # We set a default connect timeout of 3.0 sec before connecting and reset
+    # to None (=blocking) after connecting. The reason for this is that when no
+    # device is available, e.g. during testing, the timeout will take about
+    # two minutes which is way too long. It needs to be evaluated if this
+    # approach is acceptable and not causing problems during production.
+
+    def __init__(
+        self,
+        hostname: str,
+        port: int,
+        connect_timeout: float = 3.0,
+        read_timeout: float | None = 1.0,
+        separator: bytes = SEPARATOR,
+    ):
+        super().__init__()
+        self.is_connection_open = False
+        self.hostname = hostname
+        self.port = port
+        self.connect_timeout = connect_timeout
+        self.read_timeout = read_timeout
+        self.separator = separator
+        self.socket = None
+
+    @property
+    def device_name(self):
+        """The name of the device that this interface connects to."""
+        return f"SocketDevice({self.hostname}:{self.port})"
+
+    def connect(self):
+        """
+        Connect the device.
+
+        Raises:
+            ConnectionError: When the connection could not be established. Check the logging
+                messages for more detail.
+            TimeoutError: When the connection timed out.
+            ValueError: When hostname or port number are not provided.
+        """
+
+        # Sanity checks
+
+        if self.is_connection_open:
+            logger.warning(f"{self.device_name}: trying to connect to an already connected socket.")
+            return
+
+        if self.hostname in (None, ""):
+            raise ValueError(f"{self.device_name}: hostname is not initialized.")
+
+        if self.port in (None, 0):
+            raise ValueError(f"{self.device_name}: port number is not initialized.")
+
+        # Create a new socket instance
+
+        try:
+            self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+        except socket.error as exc:
+            raise ConnectionError(f"{self.device_name}: Failed to create socket.") from exc
+
+        try:
+            logger.debug(f'Connecting a socket to host "{self.hostname}" using port {self.port}')
+            self.socket.settimeout(self.connect_timeout)
+            self.socket.connect((self.hostname, self.port))
+            self.socket.settimeout(None)
+        except ConnectionRefusedError as exc:
+            raise ConnectionError(f"{self.device_name}: Connection refused to {self.hostname}:{self.port}.") from exc
+        except TimeoutError as exc:
+            raise TimeoutError(f"{self.device_name}: Connection to {self.hostname}:{self.port} timed out.") from exc
+        except socket.gaierror as exc:
+            raise ConnectionError(f"{self.device_name}: socket address info error for {self.hostname}") from exc
+        except socket.herror as exc:
+            raise ConnectionError(f"{self.device_name}: socket host address error for {self.hostname}") from exc
+        except OSError as exc:
+            raise ConnectionError(f"{self.device_name}: OSError caught ({exc}).") from exc
+
+        self.is_connection_open = True
+
+    def disconnect(self):
+        """
+        Disconnect from the Ethernet connection.
+
+        Raises:
+            ConnectionError when the socket could not be closed.
+        """
+
+        try:
+            if self.is_connection_open:
+                logger.debug(f"Disconnecting from {self.hostname}")
+                self.socket.close()
+                self.is_connection_open = False
+        except Exception as e_exc:
+            raise ConnectionError(f"{self.device_name}: Could not close socket to {self.hostname}") from e_exc
+
+    def is_connected(self) -> bool:
+        """
+        Check if the device is connected.
+
+        Returns:
+             True is the device is connected, False otherwise.
+        """
+
+        return bool(self.is_connection_open)
+
+    def reconnect(self):
+        """
+        Reconnect to the device. If the connection is open, this function will first disconnect
+        and then connect again.
+        """
+
+        if self.is_connection_open:
+            self.disconnect()
+        self.connect()
+
+    def read(self) -> bytes:
+        """
+        Read until ETX (b'\x03') or until `self.read_timeout` elapses.
+        Uses `select` to avoid blocking indefinitely when no data is available.
+        If `self.read_timeout` was set to None in the constructor, this will block anyway.
+        """
+        if not self.socket:
+            raise DeviceConnectionError(self.device_name, "Not connected")
+
+        buf_size = 1024 * 4
+        response = bytearray()
+
+        # If read_timeout is None we preserve blocking behaviour; otherwise enforce overall timeout.
+        if self.read_timeout is None:
+            end_time = None
+        else:
+            end_time = time.monotonic() + self.read_timeout
+
+        try:
+            while True:
+                # compute the remaining timeout for select, this is needed because we read in different parts
+                # until ETX is received, and we want to receive the complete messages including ETX within
+                # the read timeout.
+                if end_time is None:
+                    timeout = None
+                else:
+                    remaining = end_time - time.monotonic()
+                    if remaining <= 0.0:
+                        raise DeviceTimeoutError(self.device_name, "Socket read timed out")
+                    timeout = remaining
+
+                ready, _, _ = select.select([self.socket], [], [], timeout)
+
+                if not ready:
+                    # no socket ready within timeout
+                    raise DeviceTimeoutError(self.device_name, "Socket read timed out")
+
+                try:
+                    data = self.socket.recv(buf_size)
+                except OSError as exc:
+                    raise DeviceConnectionError(self.device_name, f"Caught {type_name(exc)}: {exc}") from exc
+
+                if not data:
+                    # remote closed connection (EOF)
+                    raise DeviceConnectionError(self.device_name, "Connection closed by peer")
+
+                response.extend(data)
+
+                if self.separator in response:
+                    break
+
+        except DeviceTimeoutError:
+            raise
+        except DeviceConnectionError:
+            raise
+        except Exception as exc:
+            # unexpected errors - translate to DeviceConnectionError
+            raise DeviceConnectionError(self.device_name, "Socket read error") from exc
+
+        return bytes(response)
+
+    def write(self, command: str):
+        """
+        Send a command to the device.
+
+        No processing is done on the command string, except for the encoding into a bytes object.
+
+        Args:
+            command: the command string including terminators.
+
+        Raises:
+            A DeviceTimeoutError when the send timed out, and a DeviceConnectionError if
+            there was a socket related error.
+        """
+
+        try:
+            self.socket.sendall(command.encode())
+        except socket.timeout as exc:
+            raise DeviceTimeoutError(self.device_name, "Socket timeout error") from exc
+        except socket.error as exc:
+            # Interpret any socket-related error as an I/O error
+            raise DeviceConnectionError(self.device_name, "Socket communication error.") from exc
+
+    def trans(self, command: str) -> bytes:
+        """
+        Send a command to the device and wait for the response.
+
+        No processing is done on the command string, except for the encoding into a bytes object.
+
+        Args:
+            command: the command string including terminators.
+
+        Returns:
+            A bytes object containing the response from the device. No processing is done
+            on the response.
+
+        Raises:
+            A DeviceTimeoutError when the send timed out, and a DeviceConnectionError if
+            there was a socket related error.
+        """
+
+        try:
+            # Attempt to send the complete command
+
+            self.socket.sendall(command.encode())
+
+            # wait for, read and return the response (will be at most TBD chars)
+
+            return_string = self.read()
+
+            return return_string
+
+        except socket.timeout as exc:
+            raise DeviceTimeoutError(self.device_name, "Socket timeout error") from exc
+        except socket.error as exc:
+            # Interpret any socket-related error as an I/O error
+            raise DeviceConnectionError(self.device_name, "Socket communication error.") from exc
+
+
+class AsyncSocketDevice(AsyncDeviceInterface, AsyncDeviceTransport):
+    """
+    Async socket-backed device using asyncio streams.
+
+    - async connect() / disconnect()
+    - async read() reads until ETX (b'\\x03') or timeout
+    - async write() and async trans()
+    """
+
+    def __init__(
+        self,
+        hostname: str,
+        port: int,
+        connect_timeout: float = 3.0,
+        read_timeout: float | None = 1.0,
+        separator: bytes = SEPARATOR,
+    ):
+        super().__init__()
+        self.hostname = hostname
+        self.port = port
+        self.connect_timeout = connect_timeout
+        self.read_timeout = read_timeout
+        self.separator = separator
+        self.reader: Optional[asyncio.StreamReader] = None
+        self.writer: Optional[asyncio.StreamWriter] = None
+        self.is_connection_open = False
+
+    @property
+    def device_name(self) -> str:
+        # Override this property for a decent name
+        return f"AsyncSocketDevice({self.hostname}:{self.port})"
+
+    async def connect(self) -> None:
+        if self.is_connection_open:
+            logger.debug(f"{self.device_name}: already connected")
+            return
+
+        if not self.hostname:
+            raise ValueError(f"{self.device_name}: hostname is not initialized.")
+        if not self.port:
+            raise ValueError(f"{self.device_name}: port is not initialized.")
+
+        try:
+            logger.debug(f"{self.device_name}: connect() called; is_connection_open={self.is_connection_open}")
+            coro = asyncio.open_connection(self.hostname, self.port)
+            self.reader, self.writer = await asyncio.wait_for(coro, timeout=self.connect_timeout)
+            self.is_connection_open = True
+            logger.debug(f"{self.device_name}: connected -> peer={self.writer.get_extra_info('peername')}")
+
+        except asyncio.TimeoutError as exc:
+            await self._cleanup()
+            logger.warning(f"{self.device_name}: connect timed out")
+            raise DeviceTimeoutError(self.device_name, f"Connection to {self.hostname}:{self.port} timed out.") from exc
+        except Exception as exc:
+            await self._cleanup()
+            logger.warning(f"{self.device_name}: connect failed: {type_name(exc)} – {exc}")
+            raise DeviceConnectionError(self.device_name, f"Failed to connect to {self.hostname}:{self.port}") from exc
+
+    async def disconnect(self) -> None:
+        logger.debug(f"{self.device_name}: disconnect() called; writer_exists={bool(self.writer)}")
+        peer = None
+        try:
+            if self.writer and not self.writer.is_closing():
+                peer = self.writer.get_extra_info("peername")
+                self.writer.close()
+                # wait for close, but don't hang forever
+                try:
+                    await asyncio.wait_for(self.writer.wait_closed(), timeout=1.0)
+                except asyncio.TimeoutError:
+                    logger.debug(f"{self.device_name}: wait_closed() timed out for peer={peer}")
+
+        finally:
+            await self._cleanup()
+            logger.debug(f"{self.device_name}: disconnected ({peer=})")
+
+    def is_connected(self) -> bool:
+        return bool(self.is_connection_open and self.writer and not self.writer.is_closing())
+
+    async def _cleanup(self) -> None:
+        self.reader = None
+        self.writer = None
+        self.is_connection_open = False
+
+    async def read(self) -> bytes:
+        if not self.reader:
+            raise DeviceConnectionError(self.device_name, "Not connected")
+        try:
+            # readuntil includes the separator; we keep it for parity with existing code
+            data = await asyncio.wait_for(self.reader.readuntil(separator=self.separator), timeout=self.read_timeout)
+            return data
+        except asyncio.IncompleteReadError as exc:
+            # EOF before separator
+            await self._cleanup()
+            raise DeviceConnectionError(self.device_name, "Connection closed while reading") from exc
+        except asyncio.TimeoutError as exc:
+            raise DeviceTimeoutError(self.device_name, "Socket read timed out") from exc
+        except Exception as exc:
+            await self._cleanup()
+            raise DeviceConnectionError(self.device_name, "Socket read error") from exc
+
+    async def write(self, command: str) -> None:
+        if not self.writer:
+            raise DeviceConnectionError(self.device_name, "Not connected")
+        try:
+            self.writer.write(command.encode())
+            await asyncio.wait_for(self.writer.drain(), timeout=self.read_timeout)
+        except asyncio.TimeoutError as exc:
+            raise DeviceTimeoutError(self.device_name, "Socket write timed out") from exc
+        except Exception as exc:
+            await self._cleanup()
+            raise DeviceConnectionError(self.device_name, "Socket write error") from exc
+
+    async def trans(self, command: str) -> bytes:
+        if not self.writer or not self.reader:
+            raise DeviceConnectionError(self.device_name, "Not connected")
+        try:
+            await self.write(command)
+            return await self.read()
+        except (DeviceTimeoutError, DeviceConnectionError):
+            raise
+        except Exception as exc:
+            await self._cleanup()
+            raise DeviceConnectionError(self.device_name, "Socket trans error") from exc

{cgse_common-0.17.3 → cgse_common-0.17.4}/src/egse/system.py

@@ -2283,6 +2283,11 @@ def kebab_to_title(kebab_str: str) -> str:
     return kebab_str.replace("-", " ").title()
 
 
+def title_to_kebab(title_str: str) -> str:
+    """Convert Title Case (each word capitalized) to kebab-case"""
+    return title_str.replace(" ", "-").lower()
+
+
 def snake_to_title(snake_str: str) -> str:
     """Convert snake_case to Title Case (each word capitalized)"""
     return snake_str.replace("_", " ").title()

cgse_common-0.17.3/justfile

@@ -1,20 +0,0 @@
-# If you don't have 'just' installed, install it with the following command:
-#
-# $  uv tool install rust-just
-#
-# The 'just' website: https://just.systems/man/en/
-
-default:
-    @just --list
-
-typecheck:
-    uv run --with mypy mypy -p egse --strict
-
-test:
-    uv run pytest -v
-
-format:
-    uvx ruff format
-
-check:
-    uvx ruff check --no-fix