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

egse/tempcontrol/digalox/digalox.py

@@ -1,115 +0,0 @@
-import logging
-import random
-
-from egse.command import ClientServerCommand
-from egse.proxy import Proxy
-from egse.decorators import dynamic_interface
-from egse.device import DeviceInterface
-from egse.serialdevice import SerialDevice
-from egse.settings import Settings
-from egse.zmq_ser import connect_address
-
-logger = logging.getLogger(__name__)
-
-DEVICE_SETTINGS = Settings.load(filename='digalox.yaml')
-CTRL_SETTINGS = Settings.load("Digalox LN2 level monitor Control Server")
-
-
-class DigaloxError(Exception):
-    pass
-
-
-class DigaloxCommand(ClientServerCommand):
-    def get_cmd_string(self, *args, **kwargs):
-        out = super().get_cmd_string(*args, **kwargs)
-        return out + '\n'
-
-
-class DigaloxInterface(DeviceInterface):
-    """ Digalox LN2 level monitor Interface base class."""
-
-    @dynamic_interface
-    def get_value(self):
-        """ Get Digalox value """
-        return NotImplemented
-
-
-class DigaloxSimulator(DigaloxInterface):
-    def __init__(self):
-        self._is_connected = True
-
-    def is_connected(self):
-       return self._is_connected
-
-    def is_simulator(self):
-       return True
-
-    def connect(self):
-       self._is_connected = True
-
-    def disconnect(self):
-       self._is_connected = False
-
-    def reconnect(self):
-       if self.is_connected():
-           self.disconnect()
-       self.connect()
-
-    def get_value(self):
-        return random.random()
-        
-        
-class DigaloxController(DigaloxInterface):
-
-    def __init__(self):
-        super().__init__()
-
-        logger.debug('Initializing Digalox controller')
-        
-        settings = Settings.load(f'Digalox LN2 level monitor Controller')
-        self._port = settings.PORT
-        self._baudrate = settings.BAUDRATE
-        
-        try:
-            self.digalox = SerialDevice(self._port ,
-                                        baudrate=self._baudrate,
-                                        terminator='\r',
-                                        timeout=2)
-        except ConnectionError as ex:
-            raise DigaloxError("Could not connect to the Digalox LN2 level monitor") from ex
-        self.digalox.connect()
-        
-    def is_simulator(self):
-        return False
-
-    def is_connected(self):
-        if self.digalox._serial is None:
-            return False
-
-        if not self.digalox._serial.is_open:
-            return False
-
-        return True
-
-    def connect(self):
-        if not self.digalox.is_connected():
-            self.digalox.connect()
-
-    def disconnect(self):
-        self.digalox.disconnect()
-
-    def reconnect(self):
-        self.digalox.reconnect()
-
-    def get_value(self):
-        response = self.digalox.query('value?\r')
-        value = response.split(';')[-1]
-        return float(value)
-        
-
-class DigaloxProxy(Proxy, DigaloxInterface):
-    def __init__(self):
-        super().__init__(connect_address(CTRL_SETTINGS.PROTOCOL, 
-                                         CTRL_SETTINGS.HOSTNAME, 
-                                         CTRL_SETTINGS.COMMANDING_PORT), 
-                         timeout=20000)

egse/tempcontrol/digalox/digalox.yaml

@@ -1,36 +0,0 @@
-BaseClass:
-    egse.tempcontrol.digalox.DigaloxInterface
-
-ProxyClass:
-    egse.tempcontrol.digalox.DigaloxProxy
-
-ControlServerClass:
-    egse.tempcontrol.digalox.DigaloxControlServer
-
-ControlServer:
-    egse.tempcontrol.digalox.digalox_cs
-
-Commands:
-    # The command strings in this file are not used.
-    # They need to include the arguments of the commands though or else the control server will
-    # remove them from the interface.
-
-    disconnect:
-        description: Disconnect from the Digalox LN2 level monitor Controller.
-
-    connect:
-        description: Connect to the Digalox LN2 level monitor Controller.
-
-    reconnect:
-        description: Reconnect to the Digalox LN2 level monitor Controller.
-    is_simulator:
-        description: Ask if the control server is a simulator.
-        returns:     bool | True if far end is a simulator.
-
-    is_connected:
-        description: Check if Digalox LN2 level monitor Controller is connected.
-
-    # Definition of the device commands.
-    get_value:
-        description: Querys the current LN2 level
-        returns:    float | Current LN2 level

egse/tempcontrol/digalox/digalox_cs.py

@@ -1,108 +0,0 @@
-#!/usr/bin/env python3
-import logging
-import multiprocessing
-
-import click
-import sys
-import zmq
-from prometheus_client import start_http_server
-
-from egse.control import ControlServer
-from egse.settings import Settings
-from egse.tempcontrol.digalox.digalox import DigaloxProxy
-from egse.tempcontrol.digalox.digalox_protocol import DigaloxProtocol
-
-logging.basicConfig(level=logging.DEBUG, format=Settings.LOG_FORMAT_FULL)
-
-logger = logging.getLogger('__name__')
-
-CTRL_SETTINGS = Settings.load("Digalox LN2 level monitor Control Server")
-
-
-class DigaloxControlServer(ControlServer):
-
-    def __init__(self):
-        super().__init__()
-
-        self.device_protocol = DigaloxProtocol(self)
-
-        logger.debug(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)
-
-        self.set_hk_delay(CTRL_SETTINGS.DELAY)
-
-    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:
-            return f'Digalox'
-
-    def before_serve(self):
-        start_http_server(CTRL_SETTINGS['METRICS_PORT'])
-
-
-@click.group()
-def cli():
-    pass
-
-
-@cli.command()
-@click.option("--simulator", "--sim", is_flag=True, help="Start the Digalox Simulator as the backend.")
-def start(simulator):
-    """Start the BeagleBone Control Server."""
-
-    if simulator:
-        Settings.set_simulation_mode(True)
-    try:
-        logger.debug(f'Starting Digalox LN2 level monitor Control Server')
-        
-        multiprocessing.current_process().name = "digalox"
-
-        control_server = DigaloxControlServer()
-        control_server.serve()
-
-    except KeyboardInterrupt:
-        logger.info("Shutdown requested...exiting")
-
-    except SystemExit as exit_code:
-        logger.info("System Exit with code {}.".format(exit_code))
-        sys.exit(exit_code)
-
-    except Exception:
-
-        logger.exception("Cannot start the Digalox LN2 level monitor Control Server")
-        # The above line does exactly the same as the traceback, but on the logger
-        # import traceback
-        # traceback.print_exc(file=sys.stdout)
-
-    return 0
-
-
-@cli.command()
-def stop(index):
-    """Send a 'quit_server' command to the Control Server."""
-
-    with DigaloxProxy(index) as proxy:
-
-        sp = proxy.get_service_proxy()
-        sp.quit_server()
-
-
-if __name__ == "__main__":
-
-    sys.exit(cli())

egse/tempcontrol/digalox/digalox_protocol.py

@@ -1,56 +0,0 @@
-import logging
-
-import numpy as np
-from prometheus_client import Gauge
-
-from egse.protocol import CommandProtocol
-from egse.settings import Settings
-from egse.system import format_datetime
-from egse.tempcontrol.digalox.digalox import DigaloxController, DigaloxInterface, DigaloxSimulator, DigaloxCommand
-from egse.zmq_ser import bind_address
-
-logger = logging.getLogger(__name__)
-
-COMMAND_SETTINGS = Settings.load(filename='digalox.yaml')
-
-
-class DigaloxProtocol(CommandProtocol):
-    def __init__(self, control_server):
-
-        super().__init__()
-
-        self.control_server = control_server
-        self.cs_storage_mnemonic = self.control_server.get_storage_mnemonic()
-
-        if Settings.simulation_mode():
-            self.digalox = DigaloxSimulator()
-        else:
-            self.digalox = DigaloxController()
-
-        self.load_commands(COMMAND_SETTINGS.Commands, DigaloxCommand, DigaloxInterface)
-
-        self.build_device_method_lookup_table(self.digalox)
-        
-        self.ln2_gauge = Gauge('GSRON_DIGALOX_LN2_LEVEL', '')
-
-
-    def get_bind_address(self):
-        return bind_address(self.control_server.get_communication_protocol(),
-                            self.control_server.get_commanding_port())
-
-    def get_status(self):
-        return super().get_status()
-
-
-    def get_housekeeping(self) -> dict:
-
-        hk_dict = {'timestamp': format_datetime()}
-        try:
-            hk_dict['GSRON_DIGALOX_LN2_LEVEL'] = self.digalox.get_value()
-        except Exception as ex:
-            logger.warning(f"Could not retrieve LN2 level housekeeping: {ex}")
-            hk_dict['GSRON_DIGALOX_LN2_LEVEL'] = np.nan
-        
-        self.ln2_gauge.set(hk_dict['GSRON_DIGALOX_LN2_LEVEL'])
-        
-        return hk_dict

egse/tempcontrol/keithley/__init__.py

@@ -1,33 +0,0 @@
-"""
-This package provides support for the Keithley instrumentation for temperature control.
-
-We support in this package the following device:
-
-* Keithley DAQ6510 Data Acquisition and Multimeter System
-
-## Keithley DAQ6510
-
-The main entry point for the user of this package is through the `DAQ6510Proxy` class:
-
-    >>> from egse.tempcontrol.keithley.daq6510 import DAQ6510Proxy
-
-This class will connect to the control server of the DAQ6510 Controller and
-provides all commands to control and monitor the temperature and other sensors that are
-connected in the slots. The control server is a small server application that is started as shown
-below. The control server directly connects to the DAQ6510 Controller through an
-Ethernet interface. When you have no hardware available, the control server can
-be started in simulation mode by appending the `--sim` string to the command below.
-
-    $ python -m egse.tempcontrol.keithley.daq6501_cs
-
-We have also provided a graphical user interface (GUI) to monitor and manipulate the
-temperature sensors. The GUI is currently a very preliminary and simple stripchart that
-plots the temperature of just one channel. Below is a screenshot of this GUI connected to the
-DAQ6510 Control Server in simulation mode. The simulation does a random walk.
-
-![DAQ6510 GUI screenshot](../../../../img/screenshot-daq6510_ui.png)
-
-Make sure that when executing above applications from the Terminal, you have
-properly set your Python environment and the `PYTHONPATH` environment variable.
-
-"""