cgse 0.16.9__tar.gz → 0.16.11__tar.gz

{cgse-0.16.9 → cgse-0.16.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cgse
-Version: 0.16.9
+Version: 0.16.11
 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>
@@ -9,6 +9,7 @@ Requires-Python: >=3.10
 Requires-Dist: cgse-common
 Requires-Dist: cgse-core
 Requires-Dist: cgse-tools
+Requires-Dist: marimo>=0.17.0
 Requires-Dist: rich>=13.9.4
 Requires-Dist: tomlkit>=0.13.2
 Description-Content-Type: text/markdown

{cgse-0.16.9 → cgse-0.16.11}/docs/libs/cgse-common/settings.md

@@ -39,8 +39,8 @@ Settings
 │   ├── METRICS_PORT: 7003
 │   ├── MAX_NR_LOG_FILES: 20
 │   ├── MAX_SIZE_LOG_FILES: 20
-│   ├── TEXTUALOG_IP_ADDRESS: 127.0.0.1
-│   └── TEXTUALOG_LISTENING_PORT: 19996
+│   ├── EXTERN_LOG_HOST: 127.0.0.1
+│   └── EXTERN_LOG_PORT: 19996
 ├── Configuration Manager Control Server
 │   ├── PROTOCOL: tcp
 │   ├── HOSTNAME: localhost
@@ -146,8 +146,8 @@ Logging Control Server:                          # LOG_CS
     METRICS_PORT:                  7003          # The HTTP port where Prometheus will connect to for retrieving metrics
     MAX_NR_LOG_FILES:                20          # The maximum number of log files that will be maintained in a roll-over
     MAX_SIZE_LOG_FILES:              20          # The maximum size one log file can become
-    TEXTUALOG_IP_ADDRESS:     127.0.0.1          # The IP address of the textualog listening server
-    TEXTUALOG_LISTENING_PORT:     19996          # The port number on which the textualog server is listening
+    EXTERN_LOG_HOST:          127.0.0.1          # The IP address of the external logger 
+    EXTERN_LOG_PORT:              19996          # The port number on which the external logger is listening
 
 Configuration Manager Control Server:            # CM_CS
 

cgse-0.16.11/docs/user_guide/cli.md

@@ -0,0 +1,35 @@
+
+# CLI Commands CGSE
+
+The CGSE comes with a suite of CLI commands to start and stop services, get 
+status reports and check the installation. It's actually a suite of `cgse` 
+sub-commands that is extendable by external packages. This section will 
+describe the commands that are available from the `cgse` packages.
+
+## The `cgse` command
+
+When you run the `cgse` command without arguments, you will see something 
+like this.
+![cli-cgse.png](../images/cli-cgse.png)
+The _Options_ sections shows the global options to the CGSE command and allows you to activate auto-completion for all 
+sub-commands.
+
+The _Commands_ section lists the `cgse` commands that are not linked to a core service or a control server. 
+
+The _Core Command_ section lists the sub-command for each of the core services, use `core` when you want to 
+start/stop all core services in one go. The core services are:
+- **reg** the service registry for all core services and control servers
+- **not** the notification server that collects and published all events
+- **log** the log server that collects and stores all log messages
+- **cm** the configuration manager
+- **sm** the storage manager
+- **pm** the process manager
+
+The _Device Command_ section lists the sub-commands for all device packages that have been installed and have a 
+plugin for the `cgse` command. In the `cgse` package, the following devices are available:
+- **DAQ6510** the Keithley Data Acquisition and Logging Multimeter
+- **LakeShore336** the LakeShore Temperature Controller
+- **puna**, **joran**, **zonda** the Symétrie positioning Hexapods
+
+The _Example_ section lists devices that are purely there as examples on how to develop device drives and their 
+plugins and how to use them in the framework.

{cgse-0.16.9 → cgse-0.16.11}/libs/cgse-common/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cgse-common"
-version = "0.16.9"
+version = "0.16.11"
 description = "Software framework to support hardware testing"
 authors = [
     {name = "IvS KU Leuven"}
@@ -43,6 +43,7 @@ dependencies = [
     "duckdb>=1.3.1",
     "requests>=2.32.4",
     "psycopg>=3.2.9",
+    "python-dotenv>=1.1.1",
 ]
 
 [project.scripts]

{cgse-0.16.9 → cgse-0.16.11}/libs/cgse-common/src/egse/env.py

@@ -42,6 +42,7 @@ locations and settings.
 from __future__ import annotations
 
 __all__ = [
+    "bool_env",
     "env_var",
     "get_conf_data_location",
     "get_conf_data_location_env_name",

{cgse-0.16.9 → cgse-0.16.11}/libs/cgse-common/src/egse/setup.py

@@ -117,6 +117,7 @@ from __future__ import annotations
 __all__ = [
     "Setup",
     "setup_ctx",
+    "disentangle_filename",
     "navdict",  # noqa: ignore typo
     "list_setups",
     "load_setup_from_disk",

{cgse-0.16.9 → cgse-0.16.11}/libs/cgse-common/src/egse/system.py

@@ -71,19 +71,32 @@ TIME_FORMAT = "%Y-%m-%dT%H:%M:%S.%f%z"
 class Periodic:
     """A timer that periodically invokes a function in the background.
 
-    If no callback is provided, a warning message will be logged. In a future, we might send out an event to the
-    application (will need an event handler).
+    This class schedules a callback to be executed at regular intervals using asyncio.
+    If no callback is provided, a warning message will be logged. If the callback execution
+    takes longer than the interval, and `skip` is True (default), the timer will skip missed
+    intervals to maintain the schedule.
 
-    When the function execution takes longer then the interval there re several options:
-
-    - if skip is True (default) the interval will take precedence and the
     Args:
-        interval: The time between timer events, in seconds.
-        name: A name to assign the event (for debugging), defaults to `Periodic#`.
-        callback: A optional callback to invoke when the event is handled.
-        repeat: The number of times to repeat the timer, or None to repeat forever.
-        skip: Enable skipping of scheduled function calls that couldn't be sent in time.
-        pause: Start the timer paused. Use `resume()` to activate the timer.
+        interval (float): The time between timer events, in seconds.
+        name (str, optional): A name to assign the event (for debugging), defaults to `Periodic#`.
+        callback (Callable, optional): A callback to invoke when the event is handled.
+        repeat (int, optional): The number of times to repeat the timer, or None to repeat forever.
+        skip (bool, optional): Enable skipping of scheduled function calls that couldn't be sent in time.
+        pause (bool, optional): Start the timer paused. Use `resume()` to activate the timer.
+
+    Methods:
+        start(): Start the timer.
+        stop(): Stop the timer.
+        is_running(): Return True if the timer is running.
+        is_paused(): Return True if the timer is paused.
+        pause(): Pause the timer.
+        reset(): Reset the timer to start from the beginning.
+        resume(): Resume a paused timer.
+
+    Note:
+        The timer runs asynchronously and is suitable for use in asyncio-based applications.
+        If the callback is a coroutine, it will be awaited.
+
     """
 
     _periodic_count: int = 0

{cgse-0.16.9 → cgse-0.16.11}/libs/cgse-common/src/egse/zmq_ser.py

@@ -44,17 +44,26 @@ def recv_zipped_pickle(socket, flags=0, protocol=-1):
     return pickle.loads(p)
 
 
-def get_port_number(socket: zmq.Socket) -> int | None:
+def get_port_number(socket: zmq.Socket | None) -> int:
     """
-    Returns the port number associated with this socket. Returns None for sockets
-    that do not bind to a TCP or IPC transport.
+    Returns the port number associated with this socket.
+
+    If the socket is bound to a TCP or IPC transport, the port number is extracted from the
+    LAST_ENDPOINT socket option.
+
+    Returns:
+        - 0 for sockets that do not bound to a TCP or IPC transport.
+        - 0 if the socket is None.
     """
+    if socket is None:
+        return 0
+
     endpoint = socket.getsockopt(zmq.LAST_ENDPOINT)
-    if endpoint:
+    if endpoint and isinstance(endpoint, bytes):
         port = endpoint.decode("utf-8").split(":")[-1]
         return int(port)
     else:
-        return None
+        return 0
 
 
 def zmq_string_request(request: str) -> list:

{cgse-0.16.9 → cgse-0.16.11}/libs/cgse-coordinates/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cgse-coordinates"
-version = "0.16.9"
+version = "0.16.11"
 description = "Reference Frames and Coordinate Transofrmations for CGSE"
 authors = [
     {name = "IvS KU Leuven"}

{cgse-0.16.9 → cgse-0.16.11}/libs/cgse-core/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "cgse-core"
-version = "0.16.9"
+version = "0.16.11"
 description = "Core services for the CGSE framework"
 authors = [
     {name = "IvS KU Leuven"}

{cgse-0.16.9 → cgse-0.16.11}/libs/cgse-core/src/cgse_core/settings.yaml

@@ -18,8 +18,8 @@ Logging Control Server:                          # LOG_CS
     MAX_SIZE_LOG_FILES:              20          # The maximum size one log file can become
     RECEIVER_PORT:                 6105
     COMMANDER_PORT:                6106
-    TEXTUALOG_IP_ADDRESS:     127.0.0.1          # The IP address of the textualog listening server
-    TEXTUALOG_LISTENING_PORT:     19996          # The port number on which the textualog server is listening
+    EXTERN_LOG_HOST:          127.0.0.1          # The IP address of the external logger
+    EXTERN_LOG_PORT:             19996          # The port number on which the external logger is listening
 
 Configuration Manager Control Server:            # CM_CS