cgse 0.17.1__tar.gz → 0.17.2__tar.gz

{cgse-0.17.1 → cgse-0.17.2}/.env.example

@@ -3,7 +3,12 @@ SITE_ID='VACUUM_LAB'
 
 # The variable below all start with the project name.
 
+# These variables point to folders.
+
 ARIEL_DATA_STORAGE_LOCATION=~/data/ARIEL/VACUUM_LAB
 ARIEL_CONF_DATA_LOCATION=~/data/ARIEL/VACUUM_LAB/conf
-ARIEL_LOCAL_SETTINGS=~/data/ARIEL/VACUUM_LAB/local_settings.yaml
 ARIEL_LOG_FILE_LOCATION=~/data/ARIEL/VACUUM_LAB/log
+
+# This variable points to a file, not to a folder.
+
+ARIEL_LOCAL_SETTINGS=~/data/ARIEL/VACUUM_LAB/local_settings.yaml

{cgse-0.17.1 → cgse-0.17.2}/.gitignore

@@ -32,6 +32,11 @@ venv
 
 .idea
 
+# VSCode IDE
+
+.vscode
+*.code-workspace
+
 # MKDOCS documentation site
 
 /site

cgse-0.17.2/.pylintrc

@@ -0,0 +1,5 @@
+; [MESSAGES CONTROL]
+; enable=
+;     logging-format-interpolation,
+;     logging-fstring-interpolation,
+;     logging-not-lazy

cgse-0.17.2/CHANGELOG.md

@@ -0,0 +1,230 @@
+
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+
+## [Unreleased]
+
+
+## [0.17.2] - 2025-11-28
+
+This release is mainly on maintenance and improvements to the `cgse-common` package. 
+
+### Fixed
+- Nothing needed to be really fixed.
+
+### Changed
+- To improve readability, the CHANGELOG file now contains all [link titles](https://github.github.com/gfm/#links) at 
+  the bottom, both for version comparison and for issue/pull request linking. [#215]
+- The args in the function `bits_set(value, *args)` should always be unpacked. Previously, the `args` could also be a 
+  list, but that made the function call needlessly confusing. This should not be a problem (not a breaking change) 
+  since this function is apparently only used in the unit tests currently. [#215]
+- The `egse.log` module exports the logging module, so, when users import logging from egse.log, the specific CGSE 
+  loggers will be configured. [#215]
+- Changed the type of the default argument in `get_log_level_from_env()` function (not a breaking change) [#215]
+- Changed the return value of the different `get_version_*()` functions to return "0.0.0" when the version cannot 
+  be determined. Previously, these functions returned None. [#215]
+- Improvements to `redirect_output_to_log()`: the file can be an absolute path, added a guard to overwrite [#217]
+- A warning message is now logged when you try to read the last few lines from a non-existing file 
+- InitializationError = InitialisationError, to be conform to the styling guide promoting the use of standard 
+  American English for code, comments  and docs 
+
+### Added
+- Added a `from_string()` class method to Settings. This is mainly for testing and when you need to load 
+  Settings from a specific file. [#215]
+- Added an example `.env` file [#215]
+
+### Testing
+- Added a test for the `round_up()` function in `egse.system` [#215]
+- Added unit tests for `egse.version` and `egse.settings` [#215], [#216]
+- Fixed the test `test_quit_process()` temporarily as it is not clear on macOS what is the actual return value 
+  from a process when it is terminated or killed. [#215]
+- Added unit test for `redirect_output_to_log()` [#217]
+
+
+## [0.17.1] - 2025-11-20
+
+### Fixed
+- Fixed a missing expanduser(). Apparently a `path.resolve()` doesn't handle the '`~`' character. [#210]
+- Fixed `env_var()` which is a context manager for temporarily setting an environment variable. It uses `setup_env()` 
+  to update the environment before and after the `yield`, but `setup_env()` only initializes once. [#210]
+- Fixed unit tests for settings, setup, and env. [#210]
+
+### Changed
+- Some of the debug messages in settings are now filtered behind the VERBOSE_DEBUG flag. [#210]
+
+
+## [0.17.0] - 2025-11-20
+
+### Added
+- Added this CHANGELOG file. [#209]
+- Added an initial implementation of the ARIEL Telescope Control Unit (TCU). This is a separate package in this 
+  monorepo that is located at `projects/ariel/ariel-tcu`. The package will be added to PyPI as `ariel-tcu`. [#178]
+- Added a `read_string()` method to the `DeviceTransport` and `AsyncDeviceTransport` classes. [#209]
+### Fixed
+- Fixed the `sm_cs` for the missing `--full` cli argument. [#204]
+- Fixed the configuration of the InfluxDB client. The client can now be fully configured with environment variables 
+  if needed. [#206]
+### Changed
+- Improved initialization of the process environment with `setup_env()`. [#208]
+- The configuration manager now also re-registers the obsid table to the storage. [#207]
+- The `cgse` subcommand to start the notification hub is changed from `not` to `nh`. Use `cgse nh [start|stop|status]`.  [#209]
+- The environment variables that contain a path can start with a tilde '`~`' which will be expanded to the user's 
+  home directory when used. [#204]
+### Docs
+- Documentation updates for the Python version, the CLI `cgse` subcommands,  environment and the introduction of `dotenv`, ...
+- Updated information on the use of `dotenv` in the developer guid.
+- Added information on the environment variables to the user guide.
+
+
+## [0.16.14] - 2025-10-24
+
+### Added
+- Added `cmd_string_func` parameter to the `@dynamic_command` interface. Use this parameter if you need to create a fancy command string from the arguments passed into the command function.
+
+## [0.16.13] - 2025-10-23
+
+### Changed
+- Improved unit tests for the `mixin.py` module.
+
+## [0.16.12] - 2025-10-21
+
+### Fixed
+- Fixed a bug in starting the puna proxy.
+
+
+## [0.16.11] - 2025-10-21
+
+### Fixed
+- Fixed starting the hexapod GUI by specifying a device identifier.
+- Fixed registration and connection of the notification hub.
+### Added
+- Added a dependency for the `dotenv` module.
+### Changed
+- The PUNA GUI script now starts as a Typer app.
+- The `get_port_number()` in `zmq_ser.py` now returns 0 (zero) on error.
+- Improved logging for the Symétrie hexapods.
+- Introduced the `VERBOSE_DEBUG` environment variable that can be used to restrict debug logging messages only when 
+  this environment variable is set. Use this for very verbose debug logging.
+
+
+## [0.16.10] - 2025-10-03
+
+### Changed
+- Renamed Settings for external logger from `TEXTUALOG_*` to `EXTERN_LOG_*`.
+- The heartbeat ZeroMQ protocol now uses ROUTER-DEALER instead of REQ-REP. This was needed because too often we got an invalid state for the REQ sockets after one of the services went down.
+
+
+## [0.16.9] - 2025-10-02
+
+### Removed
+- Removed caching from the async registry client.
+
+
+## [0.16.8] - 2025-10-02
+
+### Fixed
+- Fixed re-registration for the async registry client.
+
+
+## [0.16.7] - 2025-10-01
+
+### Fixed
+- Fixed re-registration problem in the service registry.
+### Changed
+- Read the Settings in the `__init__.py` files where possible. Do not spread Settings in all modules of a package.
+
+
+## [0.16.6] - 2025-09-30
+
+### Fixed
+- Fixed timeouts for Proxy (sub)classes to seconds instead of milliseconds. We strive to have all timeout in seconds and only convert to milliseconds when needed for a library call.
+
+
+## [0.16.5] - 2025-09-29
+
+### Changed
+- The service type for the notification hub is now `NH_CS` instead of `NOTIFY_HUB`.
+- Remove the leading dot '`.`' from all startup log filenames. Startup log files are log files per `cgse` subcommand that are located in the `LOG_FILE_LOCATION`. You will find a log file there for the `start` and the `stop` for each core service or device control server.
+
+
+## [0.16.4] - 2025-09-29
+
+### Added
+- Added the `bool_env()` function in `env.py`.
+### Changed
+- The listeners functionality has been transferred to the notification hub and services subscribe to this notification service.
+- Log messages to the `general.log` file now contain the logger name.
+### Removed
+- Remove the listener notification from the configuration manager. 
+- Remove listener registration from the storage manager and the process manager.
+
+
+## [0.16.3] - 2025-09-19
+
+### Fixed
+- Fixed a circular import problem in `system.py`.
+
+
+## [0.16.2] - 2025-09-19
+
+### Changed
+- The output of startup scripts is now redirected to the log location.
+
+
+## [0.16.1] - 2025-09-19
+
+### Changed
+- Use the `get_endpoint()` function in Proxy subclasses.
+- Define constants from settings with proper defaults.
+- Cleanup port numbers for core services in Settings. All core services now have a fixed port number, which can be 
+  overwritten in the local settings file.
+- When `port == 0` use the service registry to get the endpoint.
+
+
+## [0.16.0] - 2025-09-17
+
+### Added
+- Added a `deregister` subcommand to the service registry. Usage: `cgse reg deregister <SERVICE_TYPE>`.
+### Fixed
+- Fixed proper sorting of cgse subcommands.
+- Fixed port numbers for core services.
+### Changed
+- Proxies now handle fixed port numbers properly.
+- Renamed `cgse` subcommands `registry` →  `reg`, `notify` →  `not`.
+
+
+[Unreleased]: https://github.com/IvS-KULeuven/cgse/compare/v0.17.1...HEAD
+[0.17.1]: https://github.com/IvS-KULeuven/cgse/compare/v0.17.0...v0.17.1
+[0.17.0]: https://github.com/IvS-KULeuven/cgse/compare/v0.16.14...v0.17.0
+[0.16.14]: https://github.com/IvS-KULeuven/cgse/compare/v0.16.13...v0.16.14
+[0.16.13]: https://github.com/IvS-KULeuven/cgse/compare/v0.16.12...v0.16.13
+[0.16.12]: https://github.com/IvS-KULeuven/cgse/compare/v0.16.11...v0.16.12
+[0.16.11]: https://github.com/IvS-KULeuven/cgse/compare/v0.16.10...v0.16.11
+[0.16.10]: https://github.com/IvS-KULeuven/cgse/compare/v0.16.9...v0.16.10
+[0.16.9]: https://github.com/IvS-KULeuven/cgse/compare/v0.16.8...v0.16.9
+[0.16.8]: https://github.com/IvS-KULeuven/cgse/compare/v0.16.7...v0.16.8
+[0.16.7]: https://github.com/IvS-KULeuven/cgse/compare/v0.16.6...v0.16.7
+[0.16.6]: https://github.com/IvS-KULeuven/cgse/compare/v0.16.5...v0.16.6
+[0.16.5]: https://github.com/IvS-KULeuven/cgse/compare/v0.16.4...v0.16.5
+[0.16.4]: https://github.com/IvS-KULeuven/cgse/compare/v0.16.3...v0.16.4
+[0.16.3]: https://github.com/IvS-KULeuven/cgse/compare/v0.16.2...v0.16.3
+[0.16.2]: https://github.com/IvS-KULeuven/cgse/compare/v0.16.1...v0.16.2
+[0.16.1]: https://github.com/IvS-KULeuven/cgse/compare/v0.16.0...v0.16.1
+[0.16.0]: https://github.com/IvS-KULeuven/cgse/compare/v0.15.1...v0.16.0
+
+[#217]: https://github.com/IvS-KULeuven/cgse/pull/217
+[#216]: https://github.com/IvS-KULeuven/cgse/pull/216
+[#215]: https://github.com/IvS-KULeuven/cgse/pull/215
+[#210]: https://github.com/IvS-KULeuven/cgse/pull/210
+[#209]: https://github.com/IvS-KULeuven/cgse/pull/209
+[#208]: https://github.com/IvS-KULeuven/cgse/pull/208
+[#207]: https://github.com/IvS-KULeuven/cgse/pull/207
+[#206]: https://github.com/IvS-KULeuven/cgse/pull/206
+[#205]: https://github.com/IvS-KULeuven/cgse/pull/205
+[#204]: https://github.com/IvS-KULeuven/cgse/pull/204
+
+[#178]: https://github.com/IvS-KULeuven/cgse/pull/178

{cgse-0.17.1 → cgse-0.17.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cgse
-Version: 0.17.1
+Version: 0.17.2
 Summary: Generic Common-EGSE: Commanding and monitoring lab equipment
 Author: IvS KU Leuven
 Maintainer-email: Rik Huygen <rik.huygen@kuleuven.be>, Sara Regibo <sara.regibo@kuleuven.be>

{cgse-0.17.1 → cgse-0.17.2}/libs/cgse-common/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cgse-common"
-version = "0.17.1"
+version = "0.17.2"
 description = "Software framework to support hardware testing"
 authors = [
     {name = "IvS KU Leuven"}
@@ -68,19 +68,23 @@ markers = [
     "slow: marks tests as slow (deselect with '-m \"not slow\"')"
 ]
 
+# Some of these omitted files are only temporary omitted until refactored
 [tool.coverage.run]
 omit = [
     "tests/*",
     "conftest.py",
+    "src/egse/ratelimit.py",
+    "src/egse/plugins/metrics/duckdb.py",
+    "src/egse/plugins/metrics/timescaledb.py",
 ]
 
 [tool.hatch.build.targets.sdist]
 exclude = [
-    "/tests",
-    "/pytest.ini",
-    "/.gitignore",
-    "/*poetry*",
-    "/*setuptools*",
+    "tests",
+    "pytest.ini",
+    ".gitignore",
+    "*poetry*",
+    "*setuptools*",
 ]
 
 [tool.hatch.build.targets.wheel]
@@ -90,8 +94,12 @@ packages = ["src/egse", "src/scripts", "src/cgse_common"]
 line-length = 120
 
 [tool.ruff.lint]
+select = ["F", "I"]
 extend-select = ["E", "W"]
 
+[tool.ruff.lint.isort]
+force-single-line = true
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"

{cgse-0.17.1 → cgse-0.17.2}/libs/cgse-common/src/egse/bits.py

@@ -5,7 +5,6 @@ This module contains a number of convenience functions to work with bits, bytes
 from __future__ import annotations
 
 import ctypes
-from collections.abc import Iterable
 from typing import Union
 
 
@@ -33,7 +32,7 @@ def extract_bits(value: int, start_position: int, num_bits: int) -> int:
     return extracted_bits
 
 
-def set_bit(value: int, bit) -> int:
+def set_bit(value: int, bit: int) -> int:
     """
     Set bit to 1 for the given value.
 
@@ -47,7 +46,7 @@ def set_bit(value: int, bit) -> int:
     return value | (1 << bit)
 
 
-def set_bits(value: int, bits: tuple) -> int:
+def set_bits(value: int, bits: tuple[int, int]) -> int:
     """
     Set the given bits in value to 1.
 
@@ -63,7 +62,7 @@ def set_bits(value: int, bits: tuple) -> int:
     return value
 
 
-def clear_bit(value: int, bit) -> int:
+def clear_bit(value: int, bit: int) -> int:
     """
     Set bit to 0 for the given value.
 
@@ -77,7 +76,7 @@ def clear_bit(value: int, bit) -> int:
     return value & ~(1 << bit)
 
 
-def clear_bits(value: int, bits: tuple) -> int:
+def clear_bits(value: int, bits: tuple[int, int]) -> int:
     """
     Set the given bits in value to 0.
 
@@ -93,7 +92,7 @@ def clear_bits(value: int, bits: tuple) -> int:
     return value
 
 
-def toggle_bit(value: int, bit) -> int:
+def toggle_bit(value: int, bit: int) -> int:
     """
     Toggle the bit in the given value.
 
@@ -107,7 +106,7 @@ def toggle_bit(value: int, bit) -> int:
     return value ^ (1 << bit)
 
 
-def bit_set(value: int, bit) -> bool:
+def bit_set(value: int, bit: int) -> bool:
     """
     Return True if the bit is set.
 
@@ -122,27 +121,25 @@ def bit_set(value: int, bit) -> bool:
     return value & bit_value == bit_value
 
 
-def bits_set(value: int, *args: Union[int, Iterable[int]]) -> bool:
+def bits_set(value: int, *args: int) -> bool:
     """
     Return True if all the bits are set.
 
     Args:
         value (int): the value to check
         args: a set of indices of the bits to check, starting from 0 at the LSB.
-            All the indices can be given as separate arguments, or they can be passed
-            in as a list.
+            All the indices shall be given as separate arguments, i.e. unpack a list
+            if needed.
 
     Returns:
         True if all the bits are set (1).
 
     Examples:
-        >>> assert bits_set(0b0101_0000_1011, [0, 1, 3, 8, 10])
-        >>> assert bits_set(0b0101_0000_1011, [3, 8])
-        >>> assert not bits_set(0b0101_0000_1011, [1, 2, 3])
+        >>> assert bits_set(0b0101_0000_1011, 0, 1, 3, 8, 10)
+        >>> assert bits_set(0b0101_0000_1011, 3, 8)
+        >>> assert not bits_set(0b0101_0000_1011, *[1, 2, 3])
     """
 
-    if len(args) == 1 and isinstance(args[0], list):
-        args = args[0]
     return all([bit_set(value, bit) for bit in args])
 
 
@@ -506,7 +503,7 @@ def crc_calc(data: list[bytes | int], start: int, len_: int) -> int:
     Reference:
         The description of the CRC calculation for RMAP is given in the ECSS document
         _Space Engineering: SpaceWire - Remote Memory Access Protocol_, section A.3
-        on page 80 [ECSS‐E‐ST‐50‐52C].
+        on page 80 [ECSS-E-ST-50-52C].
 
     """
     crc: int = 0
@@ -548,7 +545,7 @@ def s16(value: int) -> int:
         >>> s16(0b1000_0000_0001_0001)
         -32751
 
-        The 'bin()' fuction will return a strange representation of this number:
+        The 'bin()' function will return a strange representation of this number:
 
         >>> bin(-32751)
         '-0b111111111101111'

{cgse-0.17.1 → cgse-0.17.2}/libs/cgse-common/src/egse/decorators.py

@@ -15,8 +15,8 @@ from typing import Optional
 
 import rich
 
-from egse.system import get_caller_info
 from egse.log import logger
+from egse.system import get_caller_info
 
 
 def static_vars(**kwargs):
@@ -316,7 +316,10 @@ def debug(func):
 
 
 def profile_func(
-    output_file: str = None, sort_by: str = "cumulative", lines_to_print: int = None, strip_dirs: bool = False
+    output_file: str | None = None,
+    sort_by: str = "cumulative",
+    lines_to_print: int | None = None,
+    strip_dirs: bool = False,
 ) -> Callable:
     """A time profiler decorator.
 
@@ -346,7 +349,7 @@ def profile_func(
         decorator](https://gist.github.com/ekhoda/2de44cf60d29ce24ad29758ce8635b78).
 
         Inspired by and modified the profile decorator of Giampaolo Rodola:
-        [profile decorato](http://code.activestate.com/recipes/577817-profile-decorator/).
+        [profile decorator](http://code.activestate.com/recipes/577817-profile-decorator/).
 
 
     """

{cgse-0.17.1 → cgse-0.17.2}/libs/cgse-common/src/egse/env.py

@@ -72,8 +72,8 @@ import os
 import warnings
 from pathlib import Path
 
-from dotenv import load_dotenv as _load_dotenv
 from dotenv import find_dotenv
+from dotenv import load_dotenv as _load_dotenv
 from rich.console import Console
 
 from egse.decorators import static_vars
@@ -697,6 +697,7 @@ def env_var(**kwargs: str | int | float | bool | None):
 def main(args: list | None = None):  # pragma: no cover
     import argparse
     import sys
+
     import rich
 
     parser = argparse.ArgumentParser()

{cgse-0.17.1 → cgse-0.17.2}/libs/cgse-common/src/egse/exceptions.py

@@ -61,3 +61,6 @@ class Abort(RuntimeError):
 
 class InitialisationError(Error):
     """Raised when an initialisation failed."""
+
+
+InitializationError = InitialisationError  # Alias with American spelling

{cgse-0.17.1 → cgse-0.17.2}/libs/cgse-common/src/egse/log.py

@@ -18,6 +18,7 @@ __all__ = [
     "LOG_DATE_FORMAT_FULL",
     "LOG_DATE_FORMAT_CLEAN",
     "logger",
+    "logging",  # export to guarantee that this module is imported and initialized before users use logging
     "root_logger",
     "egse_logger",
     "get_log_level_from_env",
@@ -84,7 +85,7 @@ class NonEGSEFilter(logging.Filter):
         return not record.name.startswith("egse")
 
 
-def get_log_level_from_env(env_var: str = "LOG_LEVEL", default: int = logging.INFO):
+def get_log_level_from_env(env_var: str = "LOG_LEVEL", default: str = "INFO") -> int:
     """Read the log level from an environment variable."""
     log_level_str = os.getenv(env_var, default)
 
@@ -95,18 +96,16 @@ def get_log_level_from_env(env_var: str = "LOG_LEVEL", default: int = logging.IN
         if 10 <= log_level <= 50:
             return log_level
         else:
-            logging.warning(
-                f"Log level {log_level} outside standard range (10-50). Using {logging.getLevelName(default)}."
-            )
-            return default
+            logging.warning(f"Log level {log_level} outside standard range (10-50). Using {default.upper()}.")
+            return logging._nameToLevel[default.upper()]
 
     except ValueError:
         log_level_str = log_level_str.upper()
         try:
             return getattr(logging, log_level_str)
         except AttributeError:
-            logging.error(f"Invalid LOG_LEVEL '{log_level_str}'. Using {logging.getLevelName(default)}.")
-            return default
+            logging.error(f"Invalid LOG_LEVEL '{log_level_str}'. Using {default.upper()}.")
+            return logging._nameToLevel[default.upper()]
 
 
 egse_logger = logging.getLogger("egse")
@@ -145,7 +144,7 @@ if __name__ == "__main__":
             Environment variables:
               - LOG_LEVEL=debug|info|warning|critical
               - LOG_FORMAT=full|clean
-            
+
             Example logging statements
               - logging level set to INFO
               - logging format set to full

{cgse-0.17.1 → cgse-0.17.2}/libs/cgse-common/src/egse/scpi.py

@@ -9,12 +9,15 @@ 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
 
 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()
 
@@ -75,8 +78,7 @@ class AsyncSCPIInterface(AsyncDeviceInterface, 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
@@ -166,6 +168,10 @@ class AsyncSCPIInterface(AsyncDeviceInterface, AsyncDeviceTransport):
 
                 self._is_connection_open = True
 
+                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:
@@ -338,23 +344,23 @@ class AsyncSCPIInterface(AsyncDeviceInterface, AsyncDeviceTransport):
                 if not self._is_connection_open or self._writer is None:
                     raise DeviceConnectionError(self._device_name, "Device not connected, use connect() first")
 
-                # Ensure command ends with newline
+                # Ensure command ends with the required terminator
                 if not command.endswith(SEPARATOR_STR):
                     command += SEPARATOR_STR
 
-                logger.info(f"-----> {command}")
+                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=SEPARATOR), timeout=self.read_timeout
                     )
-                    logger.info(f"<----- {response}")
+                    logger.info(f"<----- {response=}")
                     return response
 
                 except asyncio.IncompleteReadError as exc:

{cgse-0.17.1 → cgse-0.17.2}/libs/cgse-common/src/egse/settings.py

@@ -380,6 +380,37 @@ class Settings:
 
         return msg.rstrip()
 
+    @classmethod
+    def from_string(cls, yaml_string: str, group: str | None = None) -> attrdict:
+        """
+        Creates a Settings object from a YAML string.
+
+        Args:
+            yaml_string (str): the YAML configuration as a string
+
+        Returns:
+            An attribute dictionary with all the settings from the given string.
+        """
+        try:
+            yaml_document = yaml.load(yaml_string, Loader=SAFE_LOADER)
+            settings = attrdict({name: value for name, value in yaml_document.items()}, label="Settings")
+        except yaml.YAMLError as exc:
+            logger.error(exc)
+            raise SettingsError("Error loading YAML document from string") from exc
+
+        if not settings:
+            logger.warning(
+                "The Settings YAML string is empty. No local settings were loaded, an empty dictionary is returned."
+            )
+
+        if group:
+            if group in settings:
+                settings = attrdict({name: value for name, value in settings[group].items()}, label=group)
+            else:
+                raise SettingsError(f"Group name '{group}' is not defined in the provided YAML string.")
+
+        return settings
+
 
 def main(args: list | None = None):  # pragma: no cover
     # We provide convenience to inspect the settings by calling this module directly from Python.

{cgse-0.17.1 → cgse-0.17.2}/libs/cgse-common/src/egse/socketdevice.py

@@ -155,7 +155,7 @@ class SocketDevice(DeviceConnectionInterface, DeviceTransport):
 
         try:
             while True:
-                # compute remaining timeout for select, this is needed because we read in different parts
+                # 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: