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

egse/vacuum/keller/kellerBus.py

@@ -1,256 +0,0 @@
-from struct import unpack, pack
-from serial import Serial
-
-class kellerBusBadAddress(Exception):
-    def __init__(self):
-        super().__init__("Invalid KellerBus address")
-
-class kellerBusException1(Exception):
-    def __init__(self):
-        super().__init__("Illegal, non-implemented function")
-
-class kellerBusBadCrcException(Exception):
-    def __init__(self):
-        super().__init__("CRC is incorrect")
-
-class kellerBusException2(Exception):
-    def __init__(self):
-        super().__init__("Illegal data address")
- 
-class kellerBusException3(Exception):
-    def __init__(self):
-        super().__init__("Illegal data value")        
-
-class kellerBusException32(Exception):
-    def __init__(self):
-        super().__init__("Initialization required")
-        
-class kellerBusBadException(Exception):
-    def __init__(self):
-        super().__init__("Incorrect data received")
-
-class kellerBusNotReadable(Exception):
-    def __init__(self):
-        super().__init__("No data received as response")
-    
-class kellerBusRxException(Exception):
-    def __init__(self):
-        super().__init__("Received bad data")
-
-class kellerBus(Serial):
-    def __init__(self, port, baudrate, timeout=0.2):
-        super().__init__(port=port, baudrate=baudrate, timeout=timeout)
-
-    def calculateCrc16(self, data: bytes):
-        crc = 0xFFFF
-        
-        for byte in data:
-            crc = int(crc ^ byte)
-            for bit in range(8):
-                b = True if crc % 2 ==1 else False
-                crc = int(crc / 2)
-                crc = int(crc ^ 0xA001) if b else crc
-                
-        high, low = crc >> 8, crc & 0x00FF
-        return high, low
-
-
-    def transferData(self, txBuf, nRead):
-        self.reset_input_buffer()
-        self.reset_output_buffer()
-
-        txHigh, txLow = self.calculateCrc16(bytes(txBuf))
-        
-        txBuf.append(txHigh)
-        txBuf.append(txLow)
-#        print(txBuf)
-        self.write(txBuf)
-        
-        rxBuf = self.read(nRead)
-        
-#        print(rxBuf)
-
-        if len(rxBuf) == 0:
-            raise kellerBusNotReadable()
-        
-        rxHigh, rxLow = self.calculateCrc16(bytes(rxBuf[:-2]))
-        
-        if (rxBuf[-2] != rxHigh) or (rxBuf[-1] != rxLow):
-            raise kellerBusBadCrcException()
-        
-        if txBuf[0] != rxBuf[0]:
-             raise kellerBusBadAddress()
-        
-        if txBuf[1] == rxBuf[1]: 
-            return rxBuf
-        
-        if rxBuf[2] == 1:
-            raise kellerBusException1()
-        elif rxBuf[2] == 2:
-            raise kellerBusException2()
-        elif rxBuf[2] == 3:
-            raise kellerBusException3()
-        elif rxBuf[2] == 32:
-            raise kellerBusException32()
-        else:
-            raise kellerBusBadException()
-            
-        raise kellerBusRxException()
-
-
-    def F48(self, address):
-        ''' Initialize Keller Bus device
-        
-        : param address = int Device address
-        '''
-        code = 48
-        nRead = 10
-        txBuf = [address, code]
-        try:
-            rxBuf = self.transferData(txBuf, nRead)
-
-            data = {
-            "deviceClass"  :rxBuf[2],
-            "deviceGroup"  :rxBuf[3],
-            "deviceYear"   : rxBuf[4],
-            "deviceWeek"   :rxBuf[5],
-            "deviceBuffer" :rxBuf[6],
-            "deviceState"  : rxBuf[7]
-            }
-            
-            return data
-            
-        except Exception as exc:
-            raise exc
-
-
-    def F30(self, address, coef):
-        code = 30
-        nRead = 8
-        txBuf = [address, code, coef]
-        
-        try:
-            rxBuf = self.transferData(txBuf, nRead)
-            
-            return unpack('f', rxBuf[2:6])[0]
-
-        except Exception as exc:
-            raise exc
-
-   
-    def F31(self, address, coef, value):
-        code = 31
-        nRead = 5
-        value = pack('f', value)
-        txBuf = [address, code, coef]
-        txBuf += value
-        try:
-            rxBuf = self.transferData(txBuf, nRead)
-            return True
-        except Exception as exc:
-            raise exc
-
-    def F32(self, address, num):
-        code =  32
-        nRead = 5
-        txBuf = [address, code, num]
-        try:
-            rxBuf = self.transferData(txBuf, nRead)
-            return rxBuf[3]
-        except Exception as exc:
-            raise exc
-        
-        
-    def F66(self, address, new_address):
-        code = 66
-        nRead = 5
-        txBuf = [address, code, new_address]
-        try:
-            rxBuf = self.transferData(txBuf, nRead)
-            return rxBuf[3]
-        except Exception as exc:
-            raise exc
-
-
-    def F69(self, address):
-        code = 69
-        nRead = 8
-        txBuf = [address, code]
-        try:
-            rxBuf = self.transferData(txBuf, nRead)
-            return 256*65536*rxBuf[3]*65536*rxBuf[4]*256*rxBuf[5]*rxBuf[6]
-        except Exception as exc:
-            raise exc
-
-
-    def F73(self, address, channel):
-        code = 73
-        nRead = 9
-        txBuf = [address, code, channel]
-        try:
-            rxBuf = self.transferData(txBuf, nRead)
-            
-            value = unpack('!f', rxBuf[2:6])
-
-            return value[0], rxBuf[6]
-        except Exception as exc:
-            raise exc
-
-
-    def F95(self, address, command):
-        code = 95
-        nRead = 9
-        txBuf = [address, code, command]
-        try:
-            self.transferData(txBuf, nRead)
-            return True
-        except Exception as exc:
-            raise exc
-
-   
-    def F95_val(self, address, command, value):
-        code = 95
-        nRead = 9
-        txBuf = [address, code, command, value]
-        try:
-            self.transferData(txBuf, nRead)
-            return True
-        except Exception as exc:
-            raise exc
-
-
-    def F100(self, address, index):
-        code = 100
-        nRead = 9
-        txBuf = [address, code, index]
-        try:
-            rxBuf = self.transferData(txBuf, nRead)         
-            
-            data = {
-                'PARA0': f"{rxBuf[2]:08b}",
-                'PARA1': f"{rxBuf[3]:08b}",
-                'PARA2': f"{rxBuf[4]:08b}",
-                'PARA3': f"{rxBuf[5]:08b}",
-                'PARA4': f"{rxBuf[6]:08b}"
-                }
-            
-            return data
-        except Exception as exc:
-            raise exc
-
-def main():
-    leo3 = []
-
-    leo3 = kellerBus('/dev/ttyUSB0', 9600, 2)
-
-    for idx in [1, 2, 3, 4, 5, 6]:
-        print(f"Keller LEO3 address: {idx}")
-        print(leo3.F48(idx))
-        print(leo3.F100(idx, 2))
-    while 1:
-        for idx in [1, 2, 3, 4, 5, 6]:
-            print(f"Address : {idx}, Pressure: {leo3.F73(idx, 1)}, Temperature: {leo3.F73(idx, 4)}")
-
-    
-if __name__ == "__main__":
-    main()

egse/vacuum/keller/leo3.py

@@ -1,100 +0,0 @@
-import logging
-
-from prometheus_client import Gauge
-
-from egse.command import ClientServerCommand
-from egse.control import ControlServer
-from egse.protocol import CommandProtocol
-from egse.proxy import Proxy
-from egse.settings import Settings
-from egse.system import format_datetime
-from egse.vacuum.keller.leo3_controller import Leo3Controller
-from egse.vacuum.keller.leo3_controller import Leo3Simulator
-from egse.vacuum.keller.leo3_interface import Leo3Interface
-from egse.zmq_ser import bind_address
-from egse.zmq_ser import connect_address
-
-LOGGER = logging.getLogger(__name__)
-
-CTRL_SETTINGS = Settings.load("KELLER Leo3 Control Server")
-DEVICE_SETTINGS = Settings.load(filename="leo3.yaml")
-
-class Leo3Command(ClientServerCommand):
-    pass
-
-
-class Leo3Protocol(CommandProtocol):
-
-    def __init__(self, control_server: ControlServer):
-
-        super().__init__()
-        self.control_server = control_server
-
-        if Settings.simulation_mode():
-            self.dev = Leo3Simulator()
-        else:
-            self.dev = Leo3Controller()
-
-        self.load_commands(DEVICE_SETTINGS.Commands, Leo3Command, Leo3Interface)
-        self.build_device_method_lookup_table(self.dev)
-
-        self.addresses = [1, 2, 3, 4, 5, 6]
-
-        self.gauge_pressures         = []
-        self.gauge_temperatures      = []
-        self.gauge_status             = []
-        
-        self.invalid_result = [False] * 6
-        
-        for address in self.addresses:
-            self.gauge_pressures      += [Gauge(f'GSRON_LEO3_{address}_P', '')]
-            self.gauge_temperatures   += [Gauge(f'GSRON_LEO3_{address}_T', '')]
-            self.gauge_status          += [Gauge(f'GSRON_LEO3_{address}_STAT', '')]
-            try:
-                self.dev.initialize(address)
-            except Exception as exc:
-                LOGGER.info(f"Could not initialize kellerBus {address}: {exc}")
-    # 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()
-        
-        for idx, address in enumerate(self.addresses):
-            try:
-                result[f"GSRON_LEO3_{address}_P"], _ = self.dev.get_pressure(address)
-                result[f"GSRON_LEO3_{address}_T"], result[f'GSRON_LEO3_{address}_STAT'] = self.dev.get_temperature(address)            
-            except Exception as exc:
-                result[f"GSRON_LEO3_{address}_P"]    = 0
-                result[f"GSRON_LEO3_{address}_T"], result[f"GSRON_LEO3_{address}_STAT"] = 0, 0
-
-                if not self.invalid_result[idx]:
-                    self.invalid_result[idx] = True
-                    LOGGER.warning(f"Unable to get HK for KellerBus {address}: {exc}")
-            else:
-                self.invalid_result[idx] = False
-            finally:
-                self.gauge_pressures[idx].set(result[f"GSRON_LEO3_{address}_P"])
-                self.gauge_temperatures[idx].set(result[f"GSRON_LEO3_{address}_T"])
-                self.gauge_status[idx].set(result[f'GSRON_LEO3_{address}_STAT'])
-            
-        return result
-
-
-class Leo3Proxy(Proxy, Leo3Interface):
-    def __init__(self):
-        super().__init__(
-            connect_address(
-                CTRL_SETTINGS.PROTOCOL, CTRL_SETTINGS.HOSTNAME, CTRL_SETTINGS.COMMANDING_PORT))

egse/vacuum/keller/leo3.yaml

@@ -1,38 +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.keller.leo3_interace.Leo3Interface
-
-ProxyClass:
-    egse.vacuum.keller.leo3.Leo3proxy
-
-ControlServer:
-    egse.vacuum.keller.leo3_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_pressure:
-        description:        Get the device status string.
-        returns:            str | status string
-
-    get_temperature:
-        description:        Read IG and CG pressures combined (single value?).
-        returns:            str | String reply containing the pressure in Torr

egse/vacuum/keller/leo3_controller.py

@@ -1,81 +0,0 @@
-import logging
-
-from egse.settings import Settings
-from egse.vacuum.keller.kellerBus import kellerBus
-from egse.vacuum.keller.leo3_interface import Leo3Interface
-
-logger = logging.getLogger(__name__)
-
-# Load the device settings from the global common-egse config file
-DEVICE_SETTINGS = Settings.load("KELLER Leo3 Controller")
-
-# Load the device protocol
-DEVICE_PROTOCOL = Settings.load(filename='leo3.yaml')['Commands']
-
-class Leo3Controller(kellerBus, Leo3Interface):
-    def __init__(self, port=None, baudrate=None, timeout=1):
-
-        port = DEVICE_SETTINGS.PORT if not port else port
-        baudrate = DEVICE_SETTINGS.BAUDRATE if not baudrate else baudrate
-        
-        super().__init__(port, baudrate, timeout)
-    
-    def connect(self):
-        self.open()
-    
-    def disconnect(self):
-        self.close()
-    
-    def reconnect(self):
-        self.close()
-        self.open()
-    
-    def is_connected(self):
-        return self.is_open
-    
-    def is_simulator(self):
-        return False
-    
-    def get_idn(self, address):
-        return self.F69(address)
-
-    def initialize(self, address):
-        return self.F48(address)
-    
-    def get_pressure(self, address):
-        p, stat = self.F73(address, 1)
-        return p, stat
-    
-    def get_temperature(self, address):
-        t, stat = self.F73(address, 4)
-        return t, stat
-    
-class Leo3Simulator():
-    def __init__(self):
-        pass
-    
-    def connect(self):
-        return True
-    
-    def disconnect(self):
-        return True
-    
-    def reconnect(self):
-        return True
-    
-    def is_connected(self):
-        return True
-    
-    def is_simulator(self):
-        return False
-    
-    
-    def get_pressure(self, address, index):
-        return 10, 1
-    
-    def get_temperature(self, address, index):
-        return 20, 1
-    
-if __name__ == "__main__":
-    leo = Leo3Controller()
-    print(leo.get_pressure(1, 1))

egse/vacuum/keller/leo3_cs.py

@@ -1,101 +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.keller.leo3 import Leo3Protocol, Leo3Proxy
-
-logging.basicConfig(level=logging.DEBUG, format=Settings.LOG_FORMAT_FULL)
-
-logger = logging.getLogger(__name__)
-
-CTRL_SETTINGS = Settings.load("KELLER Leo3 Control Server")
-
-
-class Leo3ControlServer(ControlServer):
-
-    def __init__(self):
-        super().__init__()
-
-        self.device_protocol = Leo3Protocol(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)
-
-        self.set_hk_delay(5)
-
-    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 "LEO3"
-
-    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 LEO3 Simulator as the backend.")
-def start(simulator):
-    """Start the IGM402 Control Server."""
-
-    if simulator:
-        Settings.set_simulation_mode(True)
-    try:
-        controller = Leo3ControlServer()
-        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 LEO3 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 Leo3Proxy() as proxy:
-
-        sp = proxy.get_service_proxy()
-        sp.quit_server()
-
-
-if __name__ == "__main__":
-
-    sys.exit(cli())

egse/vacuum/keller/leo3_interface.py

@@ -1,33 +0,0 @@
-from egse.device import DeviceInterface
-from egse.decorators import dynamic_interface
-
-
-class Leo3Interface(DeviceInterface):
-
-    @dynamic_interface
-    def connect(self):
-        return NotImplemented
-    
-    @dynamic_interface
-    def disconnect(self):
-        return NotImplemented
-    
-    @dynamic_interface
-    def reconnect(self):
-        return NotImplemented
-    
-    @dynamic_interface
-    def is_connected(self):
-        return NotImplemented
-    
-    @dynamic_interface
-    def is_simulator(self):
-        return NotImplemented
-
-    @dynamic_interface
-    def get_pressure(self, address, index):
-        return NotImplemented
-    
-    @dynamic_interface
-    def get_temperature(self, address, index):
-        return NotImplemented

egse/vacuum/mks/evision.py

@@ -1,86 +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.zmq_ser import bind_address
-from egse.system import format_datetime
-from egse.zmq_ser import connect_address
-
-from egse.vacuum.mks.evision_interface import EvisionInterface
-from egse.vacuum.mks.evision_devif     import EvisionDriver
-from egse.vacuum.mks.evision_simulator import EvisionSimulator
-
-logger = logging.getLogger(__name__)
-
-DEVICE_SETTINGS = Settings.load(filename="evision.yaml")
-CTRL_SETTINGS = Settings.load("MKS E-Vision RGA Control Server")
-
-
-class EvisionCommand(ClientServerCommand):
-    pass
-
-
-class EvisionProtocol(CommandProtocol):
-
-    def __init__(self, control_server: ControlServer):
-
-        super().__init__()
-        self.control_server = control_server
-
-        if Settings.simulation_mode():
-            self.dev = EvisionSimulator()
-        else:
-            self.dev = EvisionDriver()
-
-        self.load_commands(DEVICE_SETTINGS.Commands, EvisionCommand, EvisionInterface)
-        self.build_device_method_lookup_table(self.dev)
-        
-        self.dev.control_sensor()
-        self.dev.filament_status()
-        self.dev.rga_status()
-        
-        self.massreading_gauges = [Gauge(f'GSRON_EVISION_MASSREADING_{i}', '') for i in range(0, 200)]
-
-    # 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()
-        
-        status_dict['ScanStatus']         = self.dev.get_scan_status()
-        status_dict['RGAStatus']          = self.dev.get_rga_status()
-        status_dict['FilamentStatus']     = self.dev.get_filament_status()
-        status_dict['MassReading']      = self.dev.get_mass_reading()
-        return status_dict
-
-
-    def get_housekeeping(self) -> dict:
-        result = dict()
-        result["timestamp"] = format_datetime()
-        
-        for i in range(0, 200):
-            column_name = f'GSRON_EVISION_MASSREADING_{i}'
-            
-            result[column_name] = self.dev.get_mass_reading()[i]
-            
-            self.massreading_gauges[i].set(self.dev.get_mass_reading()[i])
-        
-        return result
-
-
-class EvisionProxy(Proxy, EvisionInterface):
-
-    def __init__(self):
-        super().__init__(
-            connect_address(
-                CTRL_SETTINGS.PROTOCOL, CTRL_SETTINGS.HOSTNAME, CTRL_SETTINGS.COMMANDING_PORT))