rs_pro_power_supply 0.26.0__tar.gz

rs_pro_power_supply-0.26.0/.gitignore

@@ -0,0 +1,65 @@
+# Python versions and environment
+
+__pycache__
+.python-version
+.envrc
+
+# Build systems
+
+build
+dist
+**/*.egg-info
+
+# Apple specific
+
+.DS_Store
+
+# Unit testing
+
+.pytest_cache
+.coverage
+.coverage.*
+.nox
+htmlcov
+libs/cgse-core/temperature.csv
+
+# Prototypes
+
+**/prototypes/typed_serialization
+
+# dotenv, ignore all but the example file
+
+.env
+.env.*
+!.env.example
+
+# Virtual environments
+
+.venv
+venv
+
+# PyCharm IDE
+
+.idea
+
+# VSCode IDE
+
+.vscode
+*.code-workspace
+
+# MKDOCS documentation site
+
+/site
+
+# Packaging
+
+uv.lock
+libs/test_service_registry.db
+libs/cgse-core/metrics.duckdb
+install_influxdb3.sh
+.pylintrc
+
+# CGSE Specific
+
+.migrate_influx_to_questdb.state.json
+service_registry.db*

rs_pro_power_supply-0.26.0/PKG-INFO

@@ -0,0 +1,75 @@
+Metadata-Version: 2.5
+Name: rs_pro_power_supply
+Version: 0.26.0
+Summary: RS-PRO RS-D3305P Power Supply
+Author: IvS KU Leuven
+Maintainer-email: Rik Huygen <rik.huygen@kuleuven.be>, Sara Regibo <sara.regibo@kuleuven.be>
+License-Expression: MIT
+Keywords: CGSE,Common-EGSE,hardware testing,software framework
+Requires-Python: >=3.10
+Requires-Dist: cgse-common
+Requires-Dist: cgse-core
+Requires-Dist: pyserial>=3.5
+Provides-Extra: test
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Requires-Dist: pytest-mock; extra == 'test'
+Description-Content-Type: text/markdown
+
+# RS-PRO RS-D3305P Power Supply
+
+This package provides a Python interface to the RS-PRO RS-D3305P power supply.  It allows for commanding and monitoring of the power supply via a serial connection.
+
+## Local Settings
+
+This is what you need to add to your local settings file:
+
+```yaml
+RS-PRO RS-D3305P Controller:
+    <arbitrary name to refer to the device>:
+        SERIAL_NUMBER:      <serial number of the device, between quotes, e.g. "123456789">
+
+RS-PRO RS-D3305P Control Server:
+    PROTOCOL:     tcp
+    <same arbitrary name to refer to the device>:
+        SERVICE_TYPE:   <same arbitrary name to refer to the device>
+        PROCESS_NAME:   <same arbitrary name to refer to the device>
+        HOST:           <hostname on which the CS is running, e.g. "localhost">
+        STORAGE_MNEMONIC: <same arbitrary name to refer to the device>
+```
+
+To get hold of the serial number of the device, you can use the following command:
+
+```python
+from egse.power_supply.rs_pro.rsd3305p_devif import print_serial_ports
+
+print_serial_ports()
+```
+
+For each serial port on the computer, the port name and corresponding serial number of the device (if any) will be 
+printed.  Select the serial number of the device you want to connect to and add it to your local settings file, as indicated above.
+
+In case the RS-D3305P device does not show up in the list of serial ports, while the USB cable is connected, try power-cycling the device and try again.
+
+# Control Server
+
+To start the Control Server for the RS-D3305P device, use the following command:
+
+```bash
+$ cgse rsd3305 start [--sim] <same arbitrary name to refer to the device>
+```
+
+The optional `--sim` flag can be used to start the Control Server in simulation mode, which does not require a physical device to be connected.
+
+## Limitations
+
+Initially, the idea was to connect to the RS-3305P power supply via an Ethernet cable and do the commanding via TCP/IP.  However, this only works for write commands and not for read commands.   Therefore, we use a serial connection instead.
+
+The RS-3305P power supply has a USB port that can be used to connect to a computer via a USB cable.  The USB connection is recognised as a virtual COM port, which allows for serial communication with the power supply.
+
+## Reference Documents
+
+- RS-D3305P IP LAN Communication Protocol
+- RS-D3305P Series Multiple Channel Remote Control Syntax v4.0
+- RS-D3305P DC Power Supply Series User Manual
+- [RS Pro D3305P - Python GUI Remote Controller](https://github.com/LucarVicti/rs-d3305p-gui-controller)

rs_pro_power_supply-0.26.0/README.md

@@ -0,0 +1,57 @@
+# RS-PRO RS-D3305P Power Supply
+
+This package provides a Python interface to the RS-PRO RS-D3305P power supply.  It allows for commanding and monitoring of the power supply via a serial connection.
+
+## Local Settings
+
+This is what you need to add to your local settings file:
+
+```yaml
+RS-PRO RS-D3305P Controller:
+    <arbitrary name to refer to the device>:
+        SERIAL_NUMBER:      <serial number of the device, between quotes, e.g. "123456789">
+
+RS-PRO RS-D3305P Control Server:
+    PROTOCOL:     tcp
+    <same arbitrary name to refer to the device>:
+        SERVICE_TYPE:   <same arbitrary name to refer to the device>
+        PROCESS_NAME:   <same arbitrary name to refer to the device>
+        HOST:           <hostname on which the CS is running, e.g. "localhost">
+        STORAGE_MNEMONIC: <same arbitrary name to refer to the device>
+```
+
+To get hold of the serial number of the device, you can use the following command:
+
+```python
+from egse.power_supply.rs_pro.rsd3305p_devif import print_serial_ports
+
+print_serial_ports()
+```
+
+For each serial port on the computer, the port name and corresponding serial number of the device (if any) will be 
+printed.  Select the serial number of the device you want to connect to and add it to your local settings file, as indicated above.
+
+In case the RS-D3305P device does not show up in the list of serial ports, while the USB cable is connected, try power-cycling the device and try again.
+
+# Control Server
+
+To start the Control Server for the RS-D3305P device, use the following command:
+
+```bash
+$ cgse rsd3305 start [--sim] <same arbitrary name to refer to the device>
+```
+
+The optional `--sim` flag can be used to start the Control Server in simulation mode, which does not require a physical device to be connected.
+
+## Limitations
+
+Initially, the idea was to connect to the RS-3305P power supply via an Ethernet cable and do the commanding via TCP/IP.  However, this only works for write commands and not for read commands.   Therefore, we use a serial connection instead.
+
+The RS-3305P power supply has a USB port that can be used to connect to a computer via a USB cable.  The USB connection is recognised as a virtual COM port, which allows for serial communication with the power supply.
+
+## Reference Documents
+
+- RS-D3305P IP LAN Communication Protocol
+- RS-D3305P Series Multiple Channel Remote Control Syntax v4.0
+- RS-D3305P DC Power Supply Series User Manual
+- [RS Pro D3305P - Python GUI Remote Controller](https://github.com/LucarVicti/rs-d3305p-gui-controller)

rs_pro_power_supply-0.26.0/pyproject.toml

@@ -0,0 +1,83 @@
+[project]
+name = "rs_pro_power_supply"
+version = "0.26.0"
+description = "RS-PRO RS-D3305P Power Supply"
+authors = [
+    {name = "IvS KU Leuven"}
+]
+maintainers = [
+    {name = "Rik Huygen", email = "rik.huygen@kuleuven.be"},
+    {name = "Sara Regibo", email = "sara.regibo@kuleuven.be"}
+]
+readme = {"file" = "README.md", "content-type" = "text/markdown"}
+requires-python = ">=3.10"
+license = "MIT"
+keywords = [
+    "CGSE",
+    "Common-EGSE",
+    "hardware testing",
+    "software framework",
+]
+dependencies = [
+    "cgse-common",
+    "cgse-core",
+    "pyserial>=3.5",
+]
+
+[project.optional-dependencies]
+test = ["pytest", "pytest-mock", "pytest-cov"]
+
+[project.scripts]
+rsd3305p_cs = 'egse.power_supply.rs_pro.rsd3305p_cs:app'
+#rsd3305p_sim = 'egse.power_supply.rs_pro.rsd3305p_sim:app'
+
+#[project.gui-scripts]
+#rsd3305p_ui = "egse.power_supply.rs_pro.rsd3305p_ui:main"
+
+[project.entry-points."cgse.version"]
+rs-pro-power-supply = 'egse.version:get_version_installed'
+
+[project.entry-points."cgse.settings"]
+rs-pro-power-supply = "rs_pro_power_supply:settings.yaml"
+
+[project.entry-points."cgse.service.device_command"]
+rsd3305p = 'rs_pro_power_supply.cgse_services:rsd3305p'
+
+[project.entry-points."cgse.explore"]
+explore = "rs_pro_power_supply.cgse_explore"
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+
+[tool.hatch.build.targets.sdist]
+exclude = [
+    "/tests",
+    "/pytest.ini",
+    "/.gitignore",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/egse", "src/rs_pro_power_supply"]
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+extend-select = ["E501"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = [
+    "setuptools", # needed by PyCharm
+    "pytest>=8.3.4",
+    "pytest-cov>=6.0.0",
+    "pytest-mock>=3.14.0",
+    "ruff>=0.9.0",
+    "nox>=2025.2.9",
+    "setuptools>=75.8.2", # needed by PyCharm
+    "pytest-asyncio>=0.26.0",
+    "ipython",
+]

rs_pro_power_supply-0.26.0/src/egse/power_supply/rs_pro/__init__.py

@@ -0,0 +1,147 @@
+from enum import IntEnum
+from pathlib import Path
+
+from egse.settings import Settings
+
+HERE = Path(__file__).parent
+
+DEVICE_SETTINGS = Settings.load("RS-PRO RS-D3305P Controller")
+CS_SETTINGS = Settings.load("RS-PRO RS-D3305P Control Server")
+PROTOCOL = CS_SETTINGS.get("PROTOCOL", "tcp")  # Communication protocol
+
+
+PROXY_TIMEOUT = 10
+
+ENCODING = "ascii"
+LINE_ENDING = "\n"
+IDENTIFICATION_QUERY = "*IDN?"
+
+
+class OperatingMode(IntEnum):
+    """Enumeration of the operating modes supported by the RS-PRO RS-D3305P power supply."""
+
+    INDEPENDENT = 0
+    TRACKING_SERIES = 1
+    TRACKING_PARALLEL = 2
+
+
+def split_result_on_blanks(response: bytes) -> tuple[str, ...]:
+    """Splits the given response string on blanks.
+
+    Args:
+        response (str): Response to split.
+
+    Returns:
+        Tuple of strings split on commas.
+    """
+
+    return tuple(to_string(response).split(" "))
+
+
+def to_string(response: bytes) -> str:
+    """Converts the given response to a string.
+
+    Args:
+        response (bytes): Response to convert.
+
+    Returns:
+        String value converted from the given response.
+    """
+
+    return response.decode(ENCODING, errors="ignore").strip("\r\n\x00 ")
+
+
+def to_float(response: bytes) -> float:
+    """Converts the given response string to a float.
+
+    Args:
+        response (bytes): Response to convert.
+
+    Returns:
+        Float value converted from the given response.
+    """
+
+    return float(to_string(response))
+
+
+def to_int(response: bytes) -> int:
+    """Converts the given response string to an integer value.
+
+    Args:
+        response (bytes): Response to convert.
+
+    Returns:
+        Integer value converted from the given response.
+    """
+
+    return int(to_string(response))
+
+
+def decode_status(response: bytes) -> dict:
+    """Decodes the status byte from the given response.
+
+    The response an 8-bit number in the following format:
+
+        - bit 0: 0 when channel 1 is operated in CC mode, 1 when channel 1 is operated in CV mode;
+        - bit 1: 0 when channel 2 is operated in CC mode, 1 when channel 2 is operated in CV mode;
+        - bits 2 and 3: operating mode (00: independent, 01: tracking series, 10: tracking parallel);
+        - bits 4 and 5 -> not mentioned in the documentation;
+        - bit 6: 0 if the output of channel 1 is off, 1 if the output of channel 1 is on;
+        - bit 7: 0 if the output of channel 2 is off, 1 if the output of channel 2 is on.
+
+    Args:
+        response (bytes): Response to decode (status byte).
+
+    Returns:
+        Dictionary of decoded status bytes.  The keys in this dictionary are:
+
+            - "ch1_mode": "CC" or "CV" (mode of channel 1);
+            - "ch2_mode": "CC" or "CV" (mode of channel 2);
+            - "tracking": "Independent", "Series", or "Parallel" (operating mode);
+            - "ch1_on": True if the output of channel 1 is on, False otherwise;
+            - "ch2_on": True if the output of channel 2 is on, False otherwise.
+    """
+
+    status_byte = response[0]
+
+    # - bit 0: 0 when channel 1 is operated in CC mode, 1 when channel 1 is operated in CV mode;
+    # - bit 1: 0 when channel 2 is operated in CC mode, 1 when channel 2 is operated in CV mode;
+    # - bits 2 and 3: operating mode (00: independent, 01: tracking series, 10: tracking parallel);
+    # - bits 4 and 5 -> not mentioned in the documentation;
+    # - bit 6: 0 if the output of channel 1 is off, 1 if the output of channel 1 is on;
+    # - bit 7: 0 if the output of channel 2 is off, 1 if the output of channel 2 is on.
+
+    ch1_mode = "CV" if (status_byte & 0b00000001) else "CC"  # Bit 0
+    ch2_mode = "CV" if (status_byte & 0b00000010) else "CC"  # Bit 1
+
+    tracking_code = (status_byte >> 2) & 0b11  # Bits 2 & 3
+    tracking = {0: "Independent", 1: "Series", 2: "Parallel"}.get(tracking_code, f"Unknown({tracking_code})")
+
+    # Bits 4 & 5: Not mentioned in the documentation
+
+    ch1_on = True if (status_byte & 0b01000000) else False  # Bit 6
+    ch2_on = True if (status_byte & 0b0100000) else False  # Bit 7
+
+    return {
+        "ch1_mode": ch1_mode,
+        "ch2_mode": ch2_mode,
+        "tracking": tracking,
+        "ch1_on": ch1_on,
+        "ch2_on": ch2_on,
+    }
+
+
+def check_channel(kwargs: dict):
+    """Checks whether the given channel is 1 or 2.
+
+    Args:
+        kwargs (dict): Dictionary of arguments passed to the function.
+
+    Raises:
+        ValueError if the channel is neither 1 nor 2.
+    """
+
+    channel = kwargs.get("channel")
+
+    if channel not in (1, 2):
+        raise ValueError("Channel must be 1 or 2.")