cgse 2023.38.0__py3-none-any.whl → 2024.1.4__py3-none-any.whl

egse/vacuum/instrutech/igm402.py

@@ -1,92 +0,0 @@
-import logging
-
-from prometheus_client import Gauge
-
-from egse.control import ControlServer
-from egse.command import ClientServerCommand
-from egse.protocol import CommandProtocol
-from egse.proxy import Proxy
-from egse.settings import Settings
-from egse.setup import get_setup
-from egse.zmq_ser import bind_address
-from egse.system import format_datetime
-from egse.vacuum.instrutech.igm402_interface import Igm402Interface
-from egse.vacuum.instrutech.igm402_controller import Igm402Controller
-from egse.vacuum.instrutech.igm402_simulator import Igm402Simulator
-from egse.zmq_ser import connect_address
-
-
-LOGGER = logging.getLogger(__name__)
-
-CTRL_SETTINGS = Settings.load("InstruTech IGM402 Control Server")
-DEVICE_SETTINGS = Settings.load(filename="igm402.yaml")
-
-
-gauge_ion_gauge_pressure = Gauge('GSRON_IGM402_IG_P', '')
-gauge_cg_pressure_1 = Gauge('GSRON_IGM402_CG_P_1', '')
-gauge_cg_pressure_2 = Gauge('GSRON_IGM402_CG_P_2', '')
-
-
-class Igm402Command(ClientServerCommand):
-    pass
-
-
-class Igm402Protocol(CommandProtocol):
-
-    def __init__(self, control_server: ControlServer):
-
-        super().__init__()
-        self.control_server = control_server
-
-        if Settings.simulation_mode():
-            self.dev = Igm402Simulator()
-        else:
-            self.dev = Igm402Controller()
-
-        self.load_commands(DEVICE_SETTINGS.Commands, Igm402Command, Igm402Interface)
-        self.build_device_method_lookup_table(self.dev)
-
-        # Get calibration from setup
-        self.setup = get_setup()
-
-
-    # move to parent class?
-    def get_bind_address(self):
-        return bind_address(
-            self.control_server.get_communication_protocol(),
-            self.control_server.get_commanding_port(),
-        )
-
-
-    def get_status(self):
-        status_dict = super().get_status()
-
-        return status_dict
-
-
-    def get_housekeeping(self) -> dict:
-        result = dict()
-        result["timestamp"] = format_datetime()
-        result["GSRON_IGM402_IG_P"] = self.dev.get_ion_gauge_pressure()
-        result["GSRON_IGM402_CG_P_1"] = self.dev.get_cgn_pressure(1)
-        result["GSRON_IGM402_CG_P_2"] = self.dev.get_cgn_pressure(2)
-
-        gauge_ion_gauge_pressure.set(result["GSRON_IGM402_IG_P"])
-        gauge_cg_pressure_1.set(result["GSRON_IGM402_CG_P_1"])
-        gauge_cg_pressure_2.set(result["GSRON_IGM402_CG_P_2"])
-
-        # Select the IG current based on the pressure
-        if result["GSRON_IGM402_IG_P"] < self.setup.gse.igm402.calibration.enable_4ma_pressure:
-            self.dev.set_emission_current(1) # Set to 4ma.
-        else:
-            self.dev.set_emission_current(0) # Set to 100uA.
-
-        return result
-
-
-class Igm402Proxy(Proxy, Igm402Interface):
-
-    def __init__(self):
-        super().__init__(
-            connect_address(
-                CTRL_SETTINGS.PROTOCOL, CTRL_SETTINGS.HOSTNAME, CTRL_SETTINGS.COMMANDING_PORT))

egse/vacuum/instrutech/igm402.yaml

@@ -1,90 +0,0 @@
-# The commands in this file are fake.
-# One of the parameters of the command is the device index. If this is included here, the client
-# will have to pass this argument for every function call. I prefer to add this on the
-# controller side. Note that arguments must be included in the cmd string for the proxy interface.
-
-BaseClass:
-    egse.vacuum.instrutech.igm402_interface.Igm402Interface
-
-ProxyClass:
-    egse.vacuum.instrutech.igm402.Igm402Proxy
-
-ControlServer:
-    egse.vacuum.instrutech.igm402_cs
-
-Commands:
-
-    disconnect:
-        description:        Disconnect from the device.
-
-    connect:
-        description:        Connect to the device.
-
-    reconnect:
-        description:        Reconnect to the device.
-                            This command will force a disconnect and then try to re-connect to the controller.
-    is_connected:
-        description:        Check if the Thorlabs Hardware Controller is connected.
-
-    is_simulator:
-        description:        Ask if the control server is a simulator instead of the real controller class.
-        returns:            bool | True if the far end is a simulator instead of the real hardware
-
-    get_idn:
-        description:        Get device firmware version.
-        returns:            str | version number
-
-    get_status:
-        description:        Get the device status string.
-        returns:            str | status string
-
-    get_system_pressure:
-        description:        Read IG and CG pressures combined (single value?).
-        returns:            str | String reply containing the pressure in Torr
-
-    get_ion_gauge_pressure:
-        description:        Read IG pressure.
-        returns:            str | String reply containing the pressure in Torr
-
-    get_cgn_pressure:
-        description:        Read CG pressures.
-        args:
-            index:          int | device index [1, 2]
-        cmd:                "{index}"
-        returns:            str | String reply containing the pressure in Torr
-
-    set_filament_enable:
-        description:        Power up/down the filament and start/stop reading pressure.
-        args:
-            enable:         bool | True = enable
-        cmd:                "{enable}"
-
-    set_enable_degas:
-        description:        Start/stop a degas cycle.
-        args:
-            enable:         bool | True = enable
-        cmd:                "{enable}"
-
-    set_emission_current:
-        description:        Set the emission current to 4mA or 100uA.
-        args:
-            current:        int | 4mA = 1, 100uA = 0
-        cmd:                "{current}"
-
-    set_filament:
-        description:        Select filament 1 or 2.
-        args:
-            type:           int | 1 = F1, 2 = F2
-        cmd:                "{type}"
-
-    set_trip_point_i_low:
-        description:        Turn on the IG filament below this pressure.
-        args:
-            pressure:       int | threshold pressure
-        cmd:                "{pressure}"
-
-    set_trip_point_i_high:
-        description:        Turn off the IG filament above this pressure.
-        args:
-            pressure:       int | threshold pressure
-        cmd:                "{pressure}"

egse/vacuum/instrutech/igm402_controller.py

@@ -1,128 +0,0 @@
-import logging
-import time
-from functools import partial
-import random
-
-import yaml
-
-from egse.serialdevice import SerialDevice
-from egse.command import Command
-from egse.settings import Settings
-from egse.setup import get_setup
-from egse.vacuum.instrutech.igm402_interface import Igm402Interface
-
-logger = logging.getLogger(__name__)
-
-# Load the device settings from the global common-egse config file
-DEVICE_SETTINGS = Settings.load("InstruTech IGM402 Controller")
-
-# Load the device protocol
-DEVICE_PROTOCOL = Settings.load(filename='igm402.yaml')['Commands']
-
-
-class Igm402Controller(SerialDevice, Igm402Interface):
-
-    def __init__(self, port=None, baudrate=None, address=None):
-
-        # Load device configuration from the common-egse global config file
-        self._port     = DEVICE_SETTINGS.PORT if port is None else port
-        self._baudrate = DEVICE_SETTINGS.BAUDRATE if baudrate is None else baudrate
-        self._address  = DEVICE_SETTINGS.ADDRESS if address is None else address
-
-        # Get calibration from setup
-        setup = get_setup()
-
-        # Initialize the parent class with the port and baudrate
-        super().__init__(port=self._port, baudrate=self._baudrate)
-        self.connect()
-        
-        # Set the temperature points at which the IG filament is dis-/enabled.
-        self.set_trip_point_i_low(0.9 * setup.gse.igm402.calibration.enable_filament_pressure)
-        time.sleep(0.1)
-        self.set_trip_point_i_high(setup.gse.igm402.calibration.enable_filament_pressure)
-        time.sleep(0.1)
-
-    def get_idn(self):
-        cmd = f"#{self._address:02d}VER\r"
-        return self.query(cmd)
-
-    def reset(self):
-        cmd = f"#{self._address:02d}RST\r"
-        self.send_command(cmd)
-
-    def get_status(self):
-        cmd = f"#{self._address:02d}RS\r"
-        return self.query(cmd)
-
-    def get_system_pressure(self):
-        cmd = f"#{self._address:02d}RDS\r"
-        return self.query(cmd)
-
-    def get_ion_gauge_pressure(self):
-        cmd = f"#{self._address:02d}RD\r"
-        raw_value = self.query(cmd)
-        return float(raw_value.rstrip('\x00')) # only when the pressure is zero, the device appends a null character
-
-    def get_cgn_pressure(self, index):
-        assert index in [1, 2], 'index must be either 1 or 2'
-        cmd = f"#{self._address:02d}RDCG{index:d}\r"
-        raw_value = self.query(cmd)
-        return float(raw_value.rstrip('\x00')) # only when the pressure is zero, the device appends a null character
-
-    def set_filament_enable(self, enable):
-        cmd = f"#{self._address:02d}IG{int(enable):1d}\r"
-        return self.query(cmd)
-
-    def set_enable_degas(self, enable):
-        cmd = f"#{self._address:02d}DG{int(enable):1d}\r"
-        return self.query(cmd)
-
-    def set_emission_current(self, current):
-        assert current in [0, 1], 'current selector must be either 0 or 1'
-        cmd = f"#{self._address:02d}SE{current:1d}\r"
-        return self.query(cmd)
-
-    def set_filament(self, type):
-        assert type in [1, 2], 'type must be either 1 or 2'
-        cmd = f"#{self._address:02d}SF{type:1d}\r"
-        return self.query(cmd)
-
-    def set_trip_point_i_low(self, pressure):
-        cmd = f"#{self._address:02d}SL+{pressure:.2E}\r"
-        return self.query(cmd)
-
-    def set_trip_point_i_high(self, pressure):
-        cmd = f"#{self._address:02d}SL-{pressure:.2E}\r"
-        return self.query(cmd)
-
-    def query(self, command: str):
-        """ Override the parent class to do some error checking on the response. """
-
-        response = super().query(command)
-
-        if len(response) == 0:
-            return "0"
-            raise ConnectionError(f"No reply from device")
-        elif response[-1] != '\r':
-            return "0"
-            raise ConnectionError(f"Invalid termination character in response: {response}")
-        elif response[0] != '*':
-            return "0"
-            raise ConnectionError(f"Invalid header character in response: {response}")
-        elif response[0] == '?':
-            return "0"
-            raise ConnectionError(f"Got an error response from device: {response[4:-1]}")
-
-        return response[4:-1]
-
-
-def main():
-    dev = Igm402Controller()
-    print(dev.get_idn())
-    print(dev.get_ion_gauge_pressure())
-    print(dev.get_cgn_pressure(1))
-    print(dev.get_cgn_pressure(2))
-    
-    
-if __name__ == '__main__':
-    main()

egse/vacuum/instrutech/igm402_cs.py

@@ -1,108 +0,0 @@
-import click
-import logging
-import sys
-
-import zmq
-from prometheus_client import start_http_server
-
-from egse.control import ControlServer
-from egse.settings import Settings
-from egse.vacuum.instrutech.igm402 import Igm402Protocol, Igm402Proxy
-
-logging.basicConfig(level=logging.DEBUG, format=Settings.LOG_FORMAT_FULL)
-
-logger = logging.getLogger(__name__)
-
-CTRL_SETTINGS = Settings.load("InstruTech IGM402 Control Server")
-
-
-class Igm402ControlServer(ControlServer):
-    """
-    Igm402ControlServer - Command and monitor the Igm402 pressure sensor.
-    This class works as a command and monitoring server to control the device remotely.
-    The sever binds to the following ZeroMQ sockets:
-    * a REP socket that can be used as a command server. Any client can connect and
-      send a command to the Lamp controller.
-    * a PUB socket that serves as a monitoring server. It will send out Lamp status
-      information to all the connected clients every DELAY seconds.
-    """
-
-    def __init__(self):
-        super().__init__()
-
-        self.device_protocol = Igm402Protocol(self)
-
-        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)
-
-    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 "IGM402"
-
-    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 IGM402 Simulator as the backend.")
-def start(simulator):
-    """Start the IGM402 Control Server."""
-
-    if simulator:
-        Settings.set_simulation_mode(True)
-    try:
-        controller = Igm402ControlServer()
-        controller.serve()
-
-    except KeyboardInterrupt:
-        print("Shutdown requested...exiting")
-
-    except SystemExit as exit_code:
-        print("System Exit with code {}.".format(exit_code))
-        sys.exit(exit_code)
-
-    except Exception:
-
-        logger.exception("Cannot start the IGM402 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():
-    """Send a 'quit_server' command to the Control Server."""
-
-    with Igm402Proxy() as proxy:
-
-        sp = proxy.get_service_proxy()
-        sp.quit_server()
-
-
-if __name__ == "__main__":
-
-    sys.exit(cli())

egse/vacuum/instrutech/igm402_interface.py

@@ -1,49 +0,0 @@
-from egse.device import DeviceInterface
-from egse.decorators import dynamic_interface
-
-
-class Igm402Interface(DeviceInterface):
-
-    @dynamic_interface
-    def get_idn(self):
-        return NotImplemented
-
-    @dynamic_interface
-    def get_status(self):
-        return NotImplemented
-
-    @dynamic_interface
-    def get_system_pressure(self):
-        return NotImplemented
-
-    @dynamic_interface
-    def get_ion_gauge_pressure(self):
-        return NotImplemented
-
-    @dynamic_interface
-    def get_cgn_pressure(self, index):
-        return NotImplemented
-
-    @dynamic_interface
-    def set_filament_enable(self, enable):
-        return NotImplemented
-
-    @dynamic_interface
-    def set_enable_degas(self, enable):
-        return NotImplemented
-
-    @dynamic_interface
-    def set_emission_current(self, current):
-        return NotImplemented
-
-    @dynamic_interface
-    def set_filament(self, type):
-        return NotImplemented
-
-    @dynamic_interface
-    def set_trip_point_i_low(self, pressure):
-        return NotImplemented
-
-    @dynamic_interface
-    def set_trip_point_i_high(self, pressure):
-        return NotImplemented

egse/vacuum/instrutech/igm402_simulator.py

@@ -1,36 +0,0 @@
-from egse.simulator import Simulator
-from egse.vacuum.instrutech.igm402_interface import Igm402Interface
-
-
-class Igm402Simulator(Igm402Interface, Simulator):
-
-    def __init__(self):
-        super().__init__()
-
-    def is_simulator(self):
-        return True
-
-    def get_idn(self):
-        return NotImplemented
-
-    def get_status(self):
-        return NotImplemented
-
-    def get_ion_gauge_pressure(self):
-        return 0.0
-
-    def get_cgn_pressure(self, index):
-        assert index in [1, 2], 'index must be either 1 or 2'
-        return 0.0
-
-    def set_filament_enable(self, enable):
-        return NotImplemented
-
-    def set_enable_degas(self, enable):
-        return NotImplemented
-
-    def set_emission_current(self, current):
-        return NotImplemented
-
-    def set_filament(self, type):
-        return NotImplemented