cgse 2024.7.0__py3-none-any.whl → 2025.0.1__py3-none-any.whl

egse/dpu/dpu.yaml

@@ -1,153 +0,0 @@
-BaseClass:
-    egse.dpu.DPUInterface
-
-ProxyClass:
-    egse.dpu.DPUProxy
-
-ControlServerClass:
-    egse.dpu.dpu_cs.DPUControlServer
-
-ControlServer:
-    egse.dpu.dpu_cs
-
-UserInterface:
-    egse.dpu.dpu_ui
-
-Commands:
-
-    # Each of these groups is parsed and used on both the server and the client side.
-    # The group name (e.g. is_simulator) will be monkey patched in the Proxy class for the device or service.
-    # The other field are:
-    #   description:   Used by the doc_string method to generate a help string
-    #   cmd:           Command string that will eventually be send to the hardware controller for the
-    #                  device.
-    #   device_method: The name of the method to be called on the device class.
-    #                  These should all be defined by the base class for the device, i.e. HexapodBase.
-    #   response:      The name of the method to be called from the devive protocol.
-    #                  This method should exist in the subclass of the CommandProtocol base class, i.e.
-    #                  in this case it will be the HexapodProtocol class.
-
-    is_simulator:
-        description:    Returns True
-
-    # DPU commands
-
-    marker:
-        description:    Send a marker to the DPU
-        cmd:            "{marker}"
-
-    get_slicing:
-        description:    Request the number of cycles to use for slicing as a hint for the FITS generation.
-
-    set_slicing:
-        description:    Set a slicing hint for the FITS generation.
-        cmd:            "{n_cycles}"
-
-    get_register_map:
-        description:    Return the current RegisterMap from the DPU Processor
-
-
-    # N-FEE commands
-
-    n_fee_sync_register_map:
-        description:    Read and sync the register map from the N-FEE on the DPU Processor.
-
-    n_fee_get_mode:
-        description:    Request the mode of the N-FEE.
-
-    n_fee_get_sync_mode:
-        description:    Request the sync mode of the N-FEE.
-
-    n_fee_is_dump_mode:
-        description:    Returns True if the N-FEE is configured for DUMP mode.
-
-    n_fee_set_immediate_on_mode:
-        description:    Command the N-FEE to go into IMMEDIATE ON mode.
-
-    n_fee_set_on_mode:
-        description:    Command the N-FEE to go into ON mode.
-
-                        This will change the `ccd_mode_config` in register `reg_21_config` to `n_fee_mode.ON_MODE`.
-                        No other registers will be changed by this command.
-
-    n_fee_set_standby_mode:
-        description:    Command the N-FEE to go into STANDBY mode.
-
-                        This will change the `ccd_mode_config` in register `reg_21_config` to `n_fee_mode.STAND_BY_MODE`.
-                        No other registers will be changed by this command.
-
-    n_fee_set_dump_mode:
-        description:    Command the N-FEE to go into DUMP mode.
-        cmd:            "{n_fee_parameters}"
-
-    n_fee_set_dump_mode_int_sync:
-        description:    Command the N-FEE to go into DUMP mode internal sync.
-        cmd:            "{n_fee_parameters}"
-
-    n_fee_set_full_image_mode:
-        description:    Command the N-FEE to go into FULL_IMAGE mode.
-
-                        This will set the `ccd_mode_config` in the `reg_21_config` to the value for FULL_IMAGE_MODE (0x05).
-        cmd:            "{n_fee_parameters}"
-
-    n_fee_set_full_image_mode_int_sync:
-        description:    Command the N-FEE to go into FULL_IMAGE mode and internal sync.
-
-                        This will set the `ccd_mode_config` in the `reg_21_config` to the value for FULL_IMAGE_MODE (0x05).
-        cmd:            "{n_fee_parameters}"
-
-    n_fee_set_full_image_pattern_mode:
-        description:    Command the N-FEE to go into FULL_IMAGE_PATTERN mode.
-
-                        This will set the `ccd_mode_config` in the `reg_21_config` to the value for FULL_IMAGE_PATTERN_MODE (0x01).
-        cmd:            "{n_fee_parameters}"
-
-    n_fee_set_internal_sync:
-        description:    Command the N-FEE to go into internal sync mode. The internal sync Timer will generate 400ms
-                        sync pulses indefenitly.
-
-                        This will change the `sync_sel` value in the register `reg_5_config` to 1.
-
-                        There is an additional related register setting `int_sync_period` in register `reg_4_config`
-                        which defines the sync period in milliseconds.
-        cmd:            "{n_fee_parameters}"
-
-    n_fee_set_external_sync:
-        description:    Command the N-FEE to go into external sync mode. The external sync pulses are generated by the
-                        AEU, which generates one 400ms pulse followed by three 200ms pulses.
-
-                        This will change the `sync_sel` value in the register `reg_5_config` to 0.
-        cmd:            "{n_fee_parameters}"
-
-    n_fee_high_precision_hk_mode:
-        description:    Set the N-FEE in high precision HK mode
-        cmd:            "{n_fee_parameters}"
-
-    n_fee_set_register_value:
-        description:    Set the given register poarameter to the given value
-        cmd:            "{reg_name} {field_name} {field_value}"
-
-    n_fee_reset:
-        description:    Reset the N-FEE to its default settings
-
-    n_fee_set_clear_error_flags:
-        description:  Command the N-FEE to clear all error flags for non RMAP/SpW related functions immediately.  The
-                      `clear_error_flag` bit in the register map is set to 1, meaning that all error flags that are
-                      generated by  the N-FEE FPGA for non RMAP-SpW related functions are cleared immediately.  This
-                      bit is cleared automatically, so that any future error flags can be latched again.  If the error
-                      conditions persist and no corrective measures are taken, then error flags would be set again.
-
-    n_fee_set_reverse_clocking:
-        description:    Set the N-FEE in reverse clocking mode
-        cmd:            "{n_fee_parameters}"
-
-    n_fee_set_charge_injection:
-        description:    Enable charge injection in the N-FEE
-        cmd:            "{n_fee_parameters}"
-
-    n_fee_set_vgd:
-        description:    Set the VGD config parameter in the N-FEE
-        cmd:            "{n_fee_parameters}"
-
-    n_fee_set_fpga_defaults:
-        description:    Set the default FPGA values in the N-FEE

egse/dpu/dpu_cs.py

@@ -1,272 +0,0 @@
-"""
-The DPU Control Server will receive commands from the DPU Proxy and executes those commands via
-the DPU Controller.
-
-Start the DPU Control Server from the terminal as follows when you have the real hardware
-connected via a Diagnostic SpaceWire Interface (DSI):
-```bash
-$ dpu_cs start [-a <IP address of DSI>] [-p <dsi port>]
-```
-Alternatively, when you want to run the FEE Simulator, start the DPU Control Server as follows:
-```bash
-$ dpu_cs start --zeromq
-```
-This last command will try to connect to an N-FEE simulator that is also started with the `--zeromq` option.
-See the `feesim` module in `egse.fee` for more information.
-
-Please note that software simulators are intended for simple test purposes and will not simulate
-all device behavior correctly, e.g. timing, error conditions, etc.
-
-"""
-import getpass
-import logging
-import multiprocessing
-import sys
-import time
-
-import click
-import invoke
-import rich
-import sshtunnel
-import zmq
-from prometheus_client import start_http_server
-
-from egse.control import ControlServer
-from egse.control import is_control_server_active
-from egse.dpu import DPUProtocol
-from egse.dpu import DPUProxy
-from egse.dsi.spw import SpaceWireOverDSI
-from egse.settings import Settings
-from egse.spw import SpaceWireInterface
-from egse.zmq.spw import SpaceWireOverZeroMQ
-from egse.zmq_ser import connect_address
-
-logging.basicConfig(level=logging.DEBUG, format=Settings.LOG_FORMAT_PROCESS)
-
-LOGGER = logging.getLogger(__name__)
-
-DPU_SETTINGS = Settings.load("DPU")
-DSI_SETTINGS = Settings.load("DSI")
-SITE_SETTINGS = Settings.load("SITE")
-CTRL_SETTINGS = Settings.load("DPU Control Server")
-
-
-def is_dpu_cs_active(timeout: float = 0.5):
-    """
-    Checks whether the DPU Control Server is running.
-
-    Args:
-        timeout (float): Timeout when waiting for a reply [seconds, default=0.5]
-
-    Returns:
-        True if the DPU CS is running and replied with the expected answer.
-    """
-
-    endpoint = connect_address(
-        CTRL_SETTINGS.PROTOCOL, CTRL_SETTINGS.HOSTNAME, CTRL_SETTINGS.COMMANDING_PORT
-    )
-
-    return is_control_server_active(endpoint, timeout)
-
-
-class DPUControlServer(ControlServer):
-    """
-    The Control Server is the commanding center for the DPU. The CS receives commands from any
-    DPU Proxy and puts them on a Queue for processing by the DPU Processor.
-    """
-
-    def __init__(self, transport: SpaceWireInterface):
-        super().__init__()
-
-        self.device_protocol = DPUProtocol(self, transport)
-
-        self.logger.info(f"Binding ZeroMQ socket to {self.device_protocol.get_bind_address()}")
-
-        self.device_protocol.bind(self.dev_ctrl_cmd_sock)
-
-        self.poller.register(self.dev_ctrl_cmd_sock, zmq.POLLIN)
-
-    def get_communication_protocol(self):
-        return CTRL_SETTINGS.PROTOCOL
-
-    def get_commanding_port(self):
-        return CTRL_SETTINGS.COMMANDING_PORT
-
-    def get_service_port(self):
-        return CTRL_SETTINGS.SERVICE_PORT
-
-    def get_monitoring_port(self):
-        return CTRL_SETTINGS.MONITORING_PORT
-
-    def get_storage_mnemonic(self):
-        try:
-            return CTRL_SETTINGS.STORAGE_MNEMONIC
-        except AttributeError:
-            return "DPU"
-
-    def before_serve(self):
-        start_http_server(CTRL_SETTINGS.METRICS_PORT)
-
-
-def start_dpu_simulator(transport: SpaceWireInterface):
-
-    multiprocessing.current_process().name = "dpu_cs"
-
-    try:
-        dpu_sim = DPUControlServer(transport)
-        dpu_sim.serve()
-    except KeyboardInterrupt:
-        print("Shutdown requested...exiting")
-    except SystemExit as exit_code:
-        print("System Exit with code {}.".format(exit_code))
-        return exit_code
-    except Exception:
-        import traceback
-
-        traceback.print_exc(file=sys.stdout)
-
-
-@click.group()
-def cli():
-    pass
-
-
-@cli.command()
-@click.option("--zeromq", is_flag=True,
-              help="use ZeroMQ to connect to the DPU Processor")
-@click.option("--dsi-address", "-a",
-              help="the hostname or IP address of the DSI to which this client "
-                   "will connect (+ tcp socket port)")
-@click.option("--dsi-port", "-p", type=int, default=1,
-              help="the DSI port number to which this client needs to connect "
-                   "(not the port on the socket) [type=int]")
-def start_bg(zeromq, dsi_address, dsi_port):
-    """Start the DPU Control Server in the background."""
-
-    if zeromq:
-        options = "--zeromq"
-    else:
-        options = f"-a {dsi_address} " if dsi_address else ""
-        options += f"-p {dsi_port}"
-
-    LOGGER.info(f"Starting: dpu_cs start {options}")
-
-    invoke.run(f"dpu_cs start {options}", disown=True)
-
-    time.sleep(3.0)  # give the DPU CS and the DPU Processor the time to startup
-
-
-@cli.command()
-@click.option("--tunnel", is_flag=True,
-              help="use an SSH tunnel to connect to the DSI")
-@click.option("--zeromq", is_flag=True,
-              help="use ZeroMQ to connect to the DPU Processor")
-@click.option("--ssh-user", "-u",
-              help="the username at the SSH server")
-@click.option("--dsi-address", "-a",
-              help="the hostname or IP address of the DSI to which this client "
-                   "will connect (+ tcp socket port)")
-@click.option("--dsi-port", "-p", type=int, default=1,
-              help="the DSI port number to which this client needs to connect "
-                   "(not the port on the socket) [type=int]")
-def start(tunnel, zeromq, ssh_user, dsi_address, dsi_port):
-    """
-    Start the DPU Control Server and the DPU Processor.
-
-    When --tunnel is specified, DSI_ADDRESS will default to 127.0.0.1
-    unless explicitly provided.
-    """
-
-    if tunnel:
-        user = getpass.getuser()
-        password = getpass.getpass("Enter SSH passphrase: ")
-
-        # This is the IP address of the SSH server.
-
-        server_host = SITE_SETTINGS.SSH_SERVER
-        server_port = SITE_SETTINGS.SSH_PORT
-
-        # The IP address of the DSI, i.e. the EtherSpaceLink device from 4Links and
-        # the default port as defined in the Settings configuration file.
-
-        remote_host = DSI_SETTINGS.DSI_DPU_IP_ADDRESS
-        remote_port = DSI_SETTINGS.DSI_DPU_PORT
-
-        # The host from which the connection will be established. Usually, this
-        # is the 'localhost', but can be specified on the commandline if needed.
-
-        if not dsi_address:
-            local_host = "127.0.0.1"
-            local_port = 4949  # this number is just an arbitrary choice
-            dsi_address = f"{local_host}:{local_port}"
-        else:
-            local_host, local_port = dsi_address.split(":")
-            local_port = int(local_port)
-
-        LOGGER.debug(
-            f"SSH server: {server_host}:{server_port}, "
-            f"DSI: {remote_host}:{remote_port}, "
-            f"{local_host=}:{local_port=}, "
-            f"{dsi_address=}, {dsi_port=}"
-        )
-
-        with sshtunnel.open_tunnel(
-            (server_host, server_port),
-            ssh_username=user,
-            # FIXME: hardcoded info should go into specific user settings or the file should
-            #   be searched for in the user's home directory.
-            ssh_private_key="/Users/rik/.ssh/id_rsa",
-            ssh_private_key_password=password,
-            remote_bind_address=(remote_host, remote_port),
-            local_bind_address=(local_host, local_port),
-        ) as tunnel:
-            transport = SpaceWireOverDSI(dsi_address, dsi_port)
-            return start_dpu_simulator(transport)
-    else:
-        if zeromq:
-            transport = SpaceWireOverZeroMQ("tcp://*:5555", "DPU--FEE")
-        else:
-            if not dsi_address:
-                dsi_address = f"{DSI_SETTINGS.DSI_DPU_IP_ADDRESS}:{DSI_SETTINGS.DSI_DPU_PORT}"
-
-            transport = SpaceWireOverDSI(dsi_address, dsi_port)
-
-        return start_dpu_simulator(transport)
-
-
-@cli.command()
-def status():
-    """Print the status of the control server."""
-
-    import rich
-
-    rich.print('DPU Control Server:')
-    if is_dpu_cs_active():
-        rich.print('  Status: [green]active')
-        with DPUProxy() as proxy:
-            rich.print(f"  Hostname: {proxy.get_ip_address()}")
-            rich.print(f"  Monitoring port: {proxy.get_monitoring_port()}")
-            rich.print(f"  Commanding port: {proxy.get_commanding_port()}")
-            rich.print(f"  Service port: {proxy.get_service_port()}")
-    else:
-        rich.print('  Status: [red]not active')
-
-
-@cli.command()
-def stop():
-    """Send a 'quit_server' command to the DPU Control Server."""
-
-    if not is_dpu_cs_active():
-        rich.print('DPU CS: [red]not active')
-        return
-
-    try:
-        with DPUProxy() as proxy:
-            sp = proxy.get_service_proxy()
-            sp.quit_server()
-    except ConnectionError:
-        rich.print("[red]Couldn't connect to 'dpu_cs', process probably not running. ")
-
-
-if __name__ == "__main__":
-    sys.exit(cli())