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

egse/alert/gsm/beaglebone.py

@@ -1,138 +0,0 @@
-import logging
-import time
-
-from egse.decorators import dynamic_interface
-from egse.device import DeviceInterface
-from egse.proxy import Proxy
-from egse.settings import Settings
-from egse.alert.gsm.beaglebone_devif import BeagleboneDeviceInterface
-from egse.zmq_ser import connect_address
-
-logger = logging.getLogger(__name__)
-
-CTRL_SETTINGS = Settings.load("BeagleBone GSM Control Server")
-DEVICE_SETTINGS = Settings.load(filename='beaglebone.yaml')
-
-
-class BeagleboneError(Exception):
-    pass
-
-
-class BeagleboneInterface(DeviceInterface):
-    """ BeagleBone base class."""
-    @dynamic_interface
-    def set_alert(self, pin):
-        NotImplemented
-        
-    @dynamic_interface
-    def unset_alert(self, pin):
-        NotImplemented
-    @dynamic_interface
-    def get_alert(self, pin):
-        NotImplemented
-
-    @dynamic_interface
-    def toggle_watchdog(self):
-        NotImplemented
-
-
-class BeagleboneSimulator(BeagleboneInterface):
-   """ BeagleBone simulator class. """
-
-   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()
-
-
-
-class BeagleboneController(BeagleboneInterface):
-
-    def __init__(self):
-        super().__init__()
-
-        logger.debug('Initalizing BeagleBone Controller')
-
-        try:
-            self.beaglebone = BeagleboneDeviceInterface()
-            self.beaglebone.connect()
-        except BeagleboneError as exc:
-            logger.warning(f"BeagleboneError caught: Couldn't establish connection ({exc})")
-            raise BeagleboneError(
-                "Couldn't establish a connection with BeagleBone controller."
-            ) from exc
-
-    def is_simulator(self):
-        return False
-
-    def is_connected(self):
-        return self.beaglebone.is_connected()
-
-    def connect(self):
-        if not self.beaglebone.is_connected():
-            self.beaglebone.connect()
-
-    def disconnect(self):
-        self.beaglebone.disconnect()
-
-    def reconnect(self):
-        self.beaglebone.reconnect()
-        
-    def set_alert(self, pin):
-        self.beaglebone.set_alert(pin)
-
-    def unset_alert(self, pin):
-        self.beaglebone.unset_alert(pin)
-
-    def get_alert(self, pin):
-        return self.beaglebone.get_alert(pin)
-
-    def toggle_watchdog(self):
-        self.beaglebone.toggle_watchdog()
-
-
-
-class BeagleboneProxy(Proxy, BeagleboneInterface):
-    def __init__(self, protocol=CTRL_SETTINGS.PROTOCOL,
-                 hostname=CTRL_SETTINGS.HOSTNAME,
-                 port=CTRL_SETTINGS.COMMANDING_PORT):
-        super().__init__(connect_address(protocol, hostname, port))
-
-if __name__ == "__main__":
-    bb = BeagleboneProxy()
-    bb.set_alert(0)
-    bb.set_alert(1)
-    bb.set_alert(2)
-    
-    time.sleep(2)
-    
-    bb.get_alert(0)
-    bb.get_alert(1)
-    bb.get_alert(2)
-    
-    time.sleep(2)
-    
-    bb.unset_alert(0)
-    bb.unset_alert(1)
-    bb.unset_alert(2)
-    
-    time.sleep(2)
-    
-    bb.get_alert(0)
-    bb.get_alert(1)
-    bb.get_alert(2)

egse/alert/gsm/beaglebone.yaml

@@ -1,51 +0,0 @@
-BaseClass:
-    egse.alert.gsm.BeagleboneInterface
-
-ProxyClass:
-    egse.alert.gsm.beaglebone.BeagleboneProxy
-
-ControlServerClass:
-    egse.alert.gsm.beaglebone.BeagleboneControlServer
-
-ControlServer:
-    egse.alert.gsm.beaglebone_cs
-
-Commands:
-
-    # Definition of the DeviceInterface.
-
-    disconnect:
-        description: Disconnect from the PWM Controller.
-
-    connect:
-        description: Connect to the PWM Controller.
-
-    reconnect:
-        description: Reconnect to the PWM 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 PWM Controller is connected.
-
-    # Definition of the device commands.
-
-    set_alert:
-        description: Sets one of the available alerts
-        args:        
-            pin:    uint | 0 - 2 
-        cmd:        "{pin}"
-
-    get_alert:
-        description: Gets the current state of the alerts
-        args:
-            pin:     uint | 0 - 2
-        returns:     bool | state of the alert
-
-    unset_alert:
-        description: Unsets one of the available alerts
-        args:
-            pin:    uint | 0 - 2
-        cmd:        "{pin}"

egse/alert/gsm/beaglebone_cs.py

@@ -1,108 +0,0 @@
-# Control server for the BeagleBone Black heater controller
-
-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.alert.gsm.beaglebone_protocol import BeagleboneProtocol
-from egse.alert.gsm.beaglebone import BeagleboneProxy
-
-logging.basicConfig(level=logging.DEBUG, format=Settings.LOG_FORMAT_FULL)
-
-logger = logging.getLogger('BeagleBone GSM')
-
-CTRL_SETTINGS = Settings.load("BeagleBone GSM Control Server")
-
-
-class BeagleBoneControlServer(ControlServer):
-
-    def __init__(self):
-        super().__init__()
-
-        self.device_protocol = BeagleboneProtocol(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(10)
-
-
-    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 'BB_GSM'
-
-    def before_serve(self):
-        start_http_server(CTRL_SETTINGS.METRICS_PORT)
-        
-    def after_serve(self):
-        self.device_protocol.beaglebone.beaglebone._dev_gpio.close()
-
-
-@click.group()
-def cli():
-    pass
-
-
-@cli.command()
-@click.option("--simulator", "--sim", is_flag=True, help="Start the BeagleBone Simulator as the backend.")
-def start(simulator):
-    """Start the BeagleBone Control Server."""
-
-    if simulator:
-        Settings.set_simulation_mode(True)
-    try:
-        control_server = BeagleBoneControlServer()
-        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 BeagleBone 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 BeagleboneProxy() as proxy:
-
-        sp = proxy.get_service_proxy()
-        sp.quit_server()
-
-
-if __name__ == "__main__":
-
-    sys.exit(cli())

egse/alert/gsm/beaglebone_devif.py

@@ -1,122 +0,0 @@
-import logging
-import os
-from threading import Timer
-
-from egse.command import ClientServerCommand
-from egse.settings import Settings
-from egse.setup import load_setup
-
-WATCHDOG = 7
-    
-GSM = [8, 80, 78]
-
-logger = logging.getLogger(__name__)
-ctrl_settings = Settings.load('BeagleBone GSM Control Server')
-
-
-class BeagleboneCommand(ClientServerCommand):
-    def get_cmd_string(self, *args, **kwargs):
-        out = super().get_cmd_string(*args, **kwargs)
-        return out + '\n'
-
-class BeagleboneDeviceInterface:
-    
-    def __init__(self):
-
-        setup = load_setup()
-
-        # Perform SRON gssw imports here to avoid issues at other THs
-        from gssw.config.configclient import ConfigClient
-        from gssw.common import addLoggingLevel
-        from gssw.hal.hal import Hal
-        from gssw.hal.halclient import HalClient
-        from gssw.lib.device import Device
-
-        self._is_connected = False
-
-        # InitGssw does something to zmq that breaks cgse logging.
-        # So instead I copied the essentials here.
-        configClient = ConfigClient(os.getenv('GSSW_CONFIGURATION_FILE'))
-        config = configClient.config
-        addLoggingLevel('data', 15)
-
-        self._availability = setup.gse.beaglebone_heater.availability
-
-        hal = Hal()
-        hal_client = HalClient(hal, config)
-        hal_client.requestHal()
-
-        self.dev_gpio_name = "gpio_gsm"
-        self._dev_gpio = Device(self.dev_gpio_name, config, hal)
-        
-        self.watchdog_state = False
-
-    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 is_connected(self):
-        return self._is_connected
-    
-    def set_alert(self, pin):
-        if pin >= 3:
-            logger.info("Alert out of range (0 - 2)")
-        else:
-            GSM = [8, 80, 78]
-            logger.info(f"Settings Alert {GSM[pin]}")
-            self._dev_gpio.setMultiple([("GPIO_PIN", GSM[pin]), ("GPIO_VALUE", True)])
-            unset = Timer(10.0, self.unset_alert, args=(pin,))
-            unset.start()
-        
-    def unset_alert(self, pin):
-        if pin >= 3:
-            logger.info("Alert out of range (0 - 3)")
-        else:
-            logger.info(f"Unsettings Alert {GSM[pin]}")
-            self._dev_gpio.setMultiple([("GPIO_PIN", GSM[pin]), ("GPIO_VALUE", False)])
-        
-    def get_alert(self, pin):
-        if pin >= 3:
-            logger.info("Alert out of range (0 - 3)")
-        else:
-            logger.info(f"{GSM[pin]} ")
-            alert = self._dev_gpio.getSetMultiple([('GPIO_PIN', GSM[pin]), ('GPIO_VALUE', None)])
-            return alert[0]
-        
-    def toggle_watchdog(self):
-        self._dev_gpio.setMultiple([('GPIO_PIN', WATCHDOG), ('GPIO_VALUE', False if self.watchdog_state else True)])
-        self.watchdog_state = not self.watchdog_state
-
-
-
-def main():
-    bb = BeagleboneDeviceInterface()
-    
-    # bb.set_alert(0)
-    # bb.set_alert(1)
-    # bb.set_alert(2)
-    
-    # time.sleep(1)
-    
-    print(bb.get_alert(0))
-    print(bb.get_alert(1))
-    print(bb.get_alert(2))
-    
-    
-    # time.sleep(10)
-    
-    # print(bb.get_alert(0))
-    # print(bb.get_alert(1))
-    # print(bb.get_alert(2))
-
-
-
-if __name__ == '__main__':
-    main()

egse/alert/gsm/beaglebone_protocol.py

@@ -1,46 +0,0 @@
-import logging
-
-from egse.alert.gsm.beaglebone import BeagleboneController
-from egse.alert.gsm.beaglebone import BeagleboneInterface
-from egse.alert.gsm.beaglebone import BeagleboneSimulator
-from egse.alert.gsm.beaglebone_devif import BeagleboneCommand
-from egse.control import ControlServer
-from egse.protocol import CommandProtocol
-from egse.settings import Settings
-from egse.system import format_datetime
-from egse.zmq_ser import bind_address
-
-COMMAND_SETTINGS = Settings.load(filename='beaglebone.yaml')
-
-logger = logging.getLogger(__name__)
-
-
-class BeagleboneProtocol(CommandProtocol):
-    def __init__(self, control_server:ControlServer):
-        super().__init__()
-        self.control_server = control_server
-
-        if Settings.simulation_mode():
-            self.beaglebone = BeagleboneSimulator()
-        else:
-            self.beaglebone = BeagleboneController()
-
-        self.load_commands(COMMAND_SETTINGS.Commands, BeagleboneCommand, BeagleboneInterface)
-
-        self.build_device_method_lookup_table(self.beaglebone)
-
-    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()}
-        
-        self.beaglebone.toggle_watchdog()
-        # logger.info("Send a pulse to the watchdog")
-
-        return hk_dict