ariel-tcu 0.17.0__py3-none-any.whl

ariel_tcu/cgse_explore.py

@@ -0,0 +1,16 @@
+__all__ = [
+    "show_processes",
+]
+
+import re
+
+from egse.process import ProcessInfo, get_processes
+
+
+def show_processes():
+    def filter_procs(pi: ProcessInfo):
+        pattern = r"tcu_(ui|cs)"
+
+        return re.search(pattern, pi.command)
+
+    return get_processes(filter_procs)

ariel_tcu/cgse_services.py

@@ -0,0 +1,57 @@
+import subprocess
+from pathlib import Path
+from typing import TextIO, Annotated
+
+import sys
+import rich
+import typer
+
+from egse.system import all_logging_disabled, redirect_output_to_log
+
+tcu = typer.Typer(name="tcu", help="Ariel Telescope Control Unit (TCU)", no_args_is_help=True)
+
+
+@tcu.command(name="start")
+def start_tcu(
+    simulator: Annotated[
+        bool, typer.Option("--simulator", "--sim", help="use a device simulator as the backend")
+    ] = False,
+):
+    """Start the Ariel TCU Control Server.
+
+    The Control Server is always started in the background.
+    """
+
+    rich.print(f"Starting the Ariel TCU Control Server - {simulator = }")
+    out = redirect_output_to_log("tcu_cs.start.log")
+
+    cmd = [sys.executable, "-m", "egse.ariel.tcu.tcu_cs", "start"]
+    if simulator:
+        cmd.append("--simulator")
+
+    subprocess.Popen(cmd, stdout=out, stderr=out, stdin=subprocess.DEVNULL, close_fds=True)
+
+
+@tcu.command(name="stop")
+def stop_tcu():
+    """Stops the Ariel TCU Control Server."""
+
+    rich.print("Stopping the Ariel TCU Control Server")
+    out = redirect_output_to_log("tcu_cs.stop.log")
+
+    cmd = [sys.executable, "-m", "egse.ariel.tcu.tcu_cs", "stop"]
+    subprocess.Popen(cmd, stdout=out, stderr=out, stdin=subprocess.DEVNULL, close_fds=True)
+
+
+@tcu.command(name="status")
+def status_tcu():
+    """Prints the status information about the Ariel TCU Control Server."""
+
+    with all_logging_disabled():
+        from egse.ariel.tcu import tcu_cs
+
+        tcu_cs.status()
+
+
+if __name__ == "__main__":
+    tcu()

ariel_tcu/settings.yaml

@@ -0,0 +1,20 @@
+PACKAGES:
+    ARIEL_TCU: Telescope Control Unit for Ariel
+
+Ariel TCU Controller:
+#    HOSTNAME:                  localhost
+    COM_PORT:                       COM1
+    BAUD_RATE:                      9600
+    NUM_DATA_BITS:                     8
+    NUM_STOP_BITS:                     1
+    PARITY:                            N
+
+Ariel TCU Control Server:
+    PROTOCOL:                       tcp
+    HOSTNAME:                 localhost     # Hostname that the client shall connect to, e.g. on the same machine
+    COMMANDING_PORT:                  0     # Port on which the controller listens to commands (REQ-REP)
+    MONITORING_PORT:                  0     # Port on which the controller sends periodic status information about the device (PUB-SUB)
+    SERVICE_PORT:                     0     # Port on which the controller listens for configuration and administration (REQ-REP)
+    METRICS_PORT:                     0
+    STORAGE_MNEMONIC:               TCU
+    SERVICE_TYPE:                TCU_CS

ariel_tcu-0.17.0.dist-info/METADATA

@@ -0,0 +1,14 @@
+Metadata-Version: 2.4
+Name: ariel-tcu
+Version: 0.17.0
+Summary: Telescope Control Unit (TCU) for Ariel
+Author: IVS KU Leuven
+Maintainer-email: Rik Huygen <rik.huygen@kuleuven.be>, Sara Regibo <sara.regibo@kuleuven.be>
+License-Expression: MIT
+Keywords: Ariel,hardware testing,software framework,telescope control
+Requires-Python: >=3.10
+Requires-Dist: cgse-common
+Requires-Dist: cgse-core
+Requires-Dist: cgse-gui
+Requires-Dist: crcmod>=1.7
+Requires-Dist: pyserial>=3.5

ariel_tcu-0.17.0.dist-info/RECORD

@@ -0,0 +1,15 @@
+ariel_tcu/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+ariel_tcu/cgse_explore.py,sha256=vyplUdKvizZeuaChU-Y-sje1Pwz72gFH_fUptp_-8Iw,283
+ariel_tcu/cgse_services.py,sha256=c04Xd75QyZ_rfRnAZgPq-HChjAg7HJJISEcHOWCeycI,1543
+ariel_tcu/settings.yaml,sha256=Czc58_bK3sEozVkTnAPSXGiE6v-9meS2ay9tBCMkAMI,1000
+egse/ariel/tcu/__init__.py,sha256=S8TZxQ39g0-PEQsUAyQ3fovHEGlsJpbf9Kd1N2Hr2FA,3127
+egse/ariel/tcu/tcu.py,sha256=etu-iTW4DBYpdzuDv75x_o4vp-ODvLGKKT1U5awMENE,35147
+egse/ariel/tcu/tcu.yaml,sha256=hzhsa6XkWB0fX8R-2eryxcfBtP3r2spLFv6cu_tY-V4,1287
+egse/ariel/tcu/tcu_cmd_utils.py,sha256=xp2znLbC20sYA4T1dP0mG2MNI9QC7r37U8Wo5HxnXZk,46061
+egse/ariel/tcu/tcu_cs.py,sha256=KwjeADMQavLF3zDr4TnGEcgfQjBPqaKmLkxiUvQurBo,7901
+egse/ariel/tcu/tcu_devif.py,sha256=5A60IKyh9ej6IwosjPFxWAE2lCDZjp5tqfIIutN9F6c,3088
+egse/ariel/tcu/tcu_protocol.py,sha256=ie_ivSkG5Tx0lP2AKvqlN1JyemOA5g-_tVpk7m-45Ho,5394
+ariel_tcu-0.17.0.dist-info/METADATA,sha256=jgtT_mJWykSBpN10gQZemcnKJoe3l5KMXcXbofrCLhw,467
+ariel_tcu-0.17.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ariel_tcu-0.17.0.dist-info/entry_points.txt,sha256=eijgIMSb0EWjBjIRxhPJd2ltwoOo3qTbyDySEccIjQ4,283
+ariel_tcu-0.17.0.dist-info/RECORD,,

ariel_tcu-0.17.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

ariel_tcu-0.17.0.dist-info/entry_points.txt

@@ -0,0 +1,14 @@
+[console_scripts]
+tcu_cs = egse.ariel.tcu.tcu_cs:app
+
+[cgse.explore]
+explore = ariel_tcu.cgse_explore
+
+[cgse.service.device_command]
+tcu = ariel_tcu.cgse_services:tcu
+
+[cgse.settings]
+ariel-tcu = ariel_tcu:settings.yaml
+
+[cgse.version]
+ariel-tcu = egse.version:get_version_installed

egse/ariel/tcu/__init__.py

@@ -0,0 +1,105 @@
+"""General information for the Ariel Telescope Control Unit (TCU).
+
+Reference documents:
+    - RD01: TCU User Manual (ARIEL-IEEC-PL-TN-002), v1.2
+    - RD02: ARIEL TCU Data Handling (ARIEL-IEEC-PL-TN-007), v1.0
+    - RD02: TCU code provided by Vladimiro Noce (priv. comm.)
+"""
+
+from enum import IntEnum
+from pathlib import Path
+
+from egse.settings import Settings
+
+HERE = Path(__file__).parent
+settings = Settings.load("Ariel TCU Control Server")
+
+# General information about the TCU Control Server
+
+PROCESS_NAME = settings.get("PROCESS_NAME", "tcu_cs")  # Name under which it is registered in the service registry
+SERVICE_TYPE = settings.get(
+    "SERVICE_TYPE", "tcu_cs"
+)  # Service type under which it is registered in the service registry
+PROTOCOL = settings.get("PROTOCOL", "tcp")  # Communication protocol
+HOSTNAME = settings.get("HOSTNAME", "localhost")  # Hostname
+COMMANDING_PORT = settings.get("COMMANDING_PORT", 0)  # Commanding port (as per settings or dynamically assigned)
+SERVICE_PORT = settings.get("SERVICE_PORT", 0)  # Service port (as per settings or dynamically assigned)
+MONITORING_PORT = settings.get("MONITORING_PORT", 0)  # Monitoring port (as per settings or dynamically assigned)
+STORAGE_MNEMONIC = settings.get("STORAGE_MNEMONIC", "TCU")  # Storage mnemonic (used in the HK filenames)
+
+PROXY_TIMEOUT = 10
+
+NUM_TSM_FRAMES = 2
+NUM_TSM_PROBES_PER_FRAME = 22
+NUM_M2MD_POSITIONS = 18
+
+NUM_M2MD_AXES = 3
+
+
+class TcuMode(IntEnum):
+    """Ariel TCU operating modes.
+
+    The different TCU modes are:
+    - IDLE: Waiting for commands, minimum power consumption,
+    - BASE: HK + TSM circuitry on,
+    - CALIBRATION: HK + TSM + M2MD circuitry on.
+    """
+
+    # Adopted from Vladimiro's code
+
+    IDLE = 0x0000  # Waiting for commands, minimum power consumption
+    BASE = 0x0001  # HK + TSM circuitry on
+    CALIBRATION = 0x0003  # HK + TSM + M2MD circuitry on
+
+
+class MotorState(IntEnum):
+    """State of the M2MD motors.
+
+    The different motor states are:
+    - STANDBY: No motion,
+    - OPERATION: Motor moving.
+    """
+
+    # Adopted from Vladimiro's code
+    # RD01 -> Sect. 5.1
+
+    STANDBY = 0x0001  # No motion
+    OPERATION = 0x0010  # Motor moving
+
+
+AXIS_VELOCITY = {
+    1: 0x5DC0,  # Writing @ 1Hz
+    2: 0x2EE0,  # Writing @ 2Hz
+    4: 0x1770,  # Writing @ 4Hz
+    8: 0x0BB8,  # Writing @ 8Hz
+    16: 0x05DC,  # Writing @ 16Hz
+    32: 0x02EE,  # Writing @ 32Hz
+    64: 0x0177,  # Writing @ 64Hz
+    # For testing purposes
+    75: 0x0140,  # Writing @ 75Hz
+    80: 0x012C,  # Writing @ 80Hz
+    96: 0x00FA,  # Writing @ 96Hz
+}
+
+
+# To interpret the error code values
+# Taken from RD02 -> Table 3
+
+ERROR_CODES = {
+    0x00: "No errors",
+    0x01: "Command not executed",
+    0x02: "Command error",
+    0x03: "Command not allowed",
+    0x04: "Destination address error",
+    0x05: "Protocol ID error",
+    0x06: "Source address error",
+    0x07: "Unexpected sequence error",
+    0x08: "Address error",
+    0x09: "Data length error",
+    0x0A: "CRC error",
+    0x0B: "Parameter values error",
+    0x0C: "Bad mode",
+    0x0D: "Timeout",
+    0x0E: "Unknown",
+    0x0F: "Extended error, see cargo",
+}