cgse 0.17.3__tar.gz → 0.18.0__tar.gz

{cgse-0.17.3 → cgse-0.18.0}/.gitignore

@@ -22,9 +22,14 @@ dist
 .nox
 htmlcov
 
-# Virtual environments
+# dotenv, ignore all but the example file
 
 .env
+.env.*
+!.env.example
+
+# Virtual environments
+
 .venv
 venv
 

cgse-0.18.0/.op/plugins/gh.json

@@ -0,0 +1,15 @@
+{
+	"account_id": "TH3OTWXUQRFT7O7QV447RPGKII",
+	"entrypoint": [
+		"gh"
+	],
+	"credentials": [
+		{
+			"plugin": "github",
+			"credential_type": "personal_access_token",
+			"usage_id": "personal_access_token",
+			"vault_id": "hftanxm6nbsh6dd4je5xzpmqwa",
+			"item_id": "iq66j22e5sstusksk6dwxsh7eq"
+		}
+	]
+}

{cgse-0.17.3 → cgse-0.18.0}/CHANGELOG.md

@@ -8,6 +8,19 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 
 ## [Unreleased]
 
+## [0.18.0] - 2026-02-04
+
+- Implementation of KIKUSUI PMX-A power supply
+- Refactoring Keithley DAQ6510
+
+## [0.17.4] - 2026-01-27
+
+- Extracting HK from Ariel facility database
+- Re-shuffled hexapod settings
+- Cleaned up cgse-coordinates
+- Maintenance on cgse-core
+- Implementation of Digilent MEASURpoint DT8874
+
 
 ## [0.17.3] - 2025-11-29
 
@@ -33,9 +46,9 @@ This release is mainly on maintenance and improvements to the `cgse-common` pack
 - 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 
+- A warning message is now logged when you try to read the last few lines from a non-existing file [#218]
 - InitializationError = InitialisationError, to be conform to the styling guide promoting the use of standard 
-  American English for code, comments  and docs 
+  American English for code, comments  and docs [#218]
 
 ### Added
 - Added a `from_string()` class method to Settings. This is mainly for testing and when you need to load 
@@ -202,7 +215,11 @@ This release is mainly on maintenance and improvements to the `cgse-common` pack
 - Renamed `cgse` subcommands `registry` →  `reg`, `notify` →  `not`.
 
 
-[Unreleased]: https://github.com/IvS-KULeuven/cgse/compare/v0.17.1...HEAD
+[Unreleased]: https://github.com/IvS-KULeuven/cgse/compare/v0.18.0...HEAD
+[0.18.0]: https://github.com/IvS-KULeuven/cgse/compare/v0.17.4...v0.18.0
+[0.17.4]: https://github.com/IvS-KULeuven/cgse/compare/v0.17.3...v0.17.4
+[0.17.3]: https://github.com/IvS-KULeuven/cgse/compare/v0.17.2...v0.17.3
+[0.17.2]: https://github.com/IvS-KULeuven/cgse/compare/v0.17.1...v0.17.2
 [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
@@ -221,6 +238,8 @@ This release is mainly on maintenance and improvements to the `cgse-common` pack
 [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
 
+[#219]: https://github.com/IvS-KULeuven/cgse/pull/219
+[#218]: https://github.com/IvS-KULeuven/cgse/pull/218
 [#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

cgse-0.18.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Instituut voor sterrenkunde - KU Leuven
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

{cgse-0.17.3 → cgse-0.18.0}/PKG-INFO

@@ -1,10 +1,11 @@
 Metadata-Version: 2.4
 Name: cgse
-Version: 0.17.3
+Version: 0.18.0
 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>
 License: MIT
+License-File: LICENSE
 Requires-Python: >=3.10
 Requires-Dist: cgse-common
 Requires-Dist: cgse-core

{cgse-0.17.3 → cgse-0.18.0/docs/admin_guide}/make-a-release.md

@@ -1,32 +1,65 @@
+## Making a release
 
-(also check the docs: [Building and publishing packages](https://ivs-kuleuven.github.io/cgse/dev_guide/uv/#building-and-publishing-all-packages))
+The first thing to do is to properly format your code changes, run:
 
-## Making a release
+```bash
+uvx ruff format
+```
+
+You should be on the branch with the developments that you want to push and merge the pull request on GitHub before making the release.
 
-- run `uvx ruff format`
 - commit all changes with a proper message
+- push changes to `origin`
+- create a pull request (possibly needs a review)
+- merge the pull request
+
+When all pull requests that should go into the release are merged, checkout main again and pull all the latest changes:
+
+```bash
+git checkout main
+git pull upstream main
+```
+
+Now, create the release branch: e.g. `release/v0.17.3`
+
+- `git checkout -b release/v0.17.3`
 - add all notable changes to the CHANGELOG file
   - fix the links in the headers if needed
   - add links to the different pull requests
   - commit the CHANGELOG file
 - bump the version number: `uv run bump.py [patch|minor|major]`
 - commit all `pyproject.toml` files after the version bump
-- push the changes to upstream
+- push the changes to `origin`
 - create (and merge) a pull request, use the CHANGELOG as description
-- remove the old distributions: `rm -r dist`
 
-In order to prevent publishing all changes and untracked files to, stash the changes:
-- `git stash push -u -m "All development work"` all changes and untracked files
+In order to prevent publishing all remaining uncommitted changes and untracked files too, stash all changes and untracked files:
+
+```bash
+git stash push -u -m "All development work"
+```
+
+## Publish the new release
+
+(also check the docs: [Building and publishing packages](https://ivs-kuleuven.github.io/cgse/dev_guide/uv/#building-and-publishing-all-packages))
+
+Now, build and publish the packages:
 
+- remove the old distributions: `rm -r dist`
 - build the packages: `uv build --all-packages`
 - publish the packages to PyPI: `uv publish --token $UV_PUBLISH_TOKEN`
 
-Now, put back the changes and untracked files:
-- `git stash pop`
+Put back the changes and untracked files:
+
+```bash
+git checkout main
+git pull upstream main
+git stash pop
+```
 
 ## Tag the new release
 
 - create a tag for the commit of the bump: `git tag <version number> <commit hash>`, e.g. `git tag v0.16.0 559bbfc`
+    - you can find the commit hash with: `git log --oneline`
 - push the tag to upstream: `git push upstream <tag name>`, e.g. `git push upstream v0.16.0`
 
 

{cgse-0.17.3 → cgse-0.18.0}/libs/cgse-common/pyproject.toml

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

{cgse-0.17.3 → cgse-0.18.0}/libs/cgse-common/src/egse/device.py

@@ -54,7 +54,7 @@ class DeviceControllerError(DeviceError):
         super().__init__(device_name, message)
 
 
-class DeviceConnectionError(DeviceError):
+class DeviceConnectionError(DeviceError, ConnectionError):
     """A generic error for all connection type of problems.
 
     Args:
@@ -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-0.17.3 → cgse-0.18.0}/libs/cgse-common/src/egse/env.py

@@ -170,7 +170,7 @@ def setup_env():
         return
 
     if VERBOSE_DEBUG:
-        logger.debug(f"Initialising the environment...")
+        logger.debug("Initializing the environment...")
 
     load_dotenv()
 

{cgse-0.17.3 → cgse-0.18.0}/libs/cgse-common/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-0.17.3 → cgse-0.18.0}/libs/cgse-common/src/egse/log.py

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