pymodaq 5.1.6__py3-none-any.whl

pymodaq/control_modules/thread_commands.py

@@ -0,0 +1,137 @@
+from pymodaq_utils.enums import StrEnum
+
+
+class ThreadStatus(StrEnum):
+    """ Allowed Generic commands sent from a plugin using the method: emit_status
+
+    Valid both for DAQ_Move and DAQ_Viewer control modules
+
+    See Also
+    --------
+    ControlModule.thread_status
+    """
+    UPDATE_STATUS = 'update_status'
+    CLOSE = 'close'
+    UPDATE_SETTINGS = 'update_settings'
+    UPDATE_MAIN_SETTINGS = 'update_main_settings'
+    UPDATE_UI = 'update_ui'
+    RAISE_TIMEOUT = 'raise_timeout'
+    SHOW_SPLASH = 'show_splash'
+    CLOSE_SPLASH = 'close_splash'
+
+
+class ThreadStatusMove(StrEnum):
+    """ Allowed Generic commands sent from a plugin using the method: emit_status
+
+    Valid only for DAQ_Move control module
+
+    See Also
+    --------
+    DAQ_Move.thread_status
+    """
+    INI_STAGE = 'ini_stage'
+    GET_ACTUATOR_VALUE = 'get_actuator_value'
+    MOVE_DONE = 'move_done'
+    OUT_OF_BOUNDS = 'outofbounds'
+    SET_ALLOWED_VALUES = 'set_allowed_values'
+    STOP = 'stop'
+    UNITS = 'units'
+
+
+class ThreadStatusViewer(StrEnum):
+    """ Allowed Generic commands sent from a plugin using the method: emit_status
+
+    Valid only for DAQ_Viewer control module
+
+    See Also
+    --------
+    DAQ_Viewer.thread_status
+    """
+    INI_DETECTOR = 'ini_detector'
+    GRAB = 'grab'
+    GRAB_STOPPED = 'grab_stopped'
+    INI_LCD = 'init_lcd'
+    LCD = 'lcd'
+    STOP = 'stop'
+    UPDATE_CHANNELS = 'update_channels'
+
+
+
+class ControlToHardwareMove(StrEnum):
+    """ Allowed commands sent from a DAQ_Move to its DAQ_Move_Hardware in another thread
+     using the method: command_hardware
+
+    Valid only for DAQ_Move command_hardware commands
+
+    """
+    INI_STAGE = 'ini_stage'
+    STOP_MOTION = 'stop_motion'
+    RESET_STOP_MOTION = 'reset_stop_motion'
+    MOVE_ABS = 'move_abs'
+    MOVE_REL = 'move_rel'
+    MOVE_HOME = 'move_home'
+    GET_ACTUATOR_VALUE = 'get_actuator_value'
+    CLOSE = 'close'
+
+class ControlToHardwareViewer(StrEnum):
+    """ Allowed commands sent from a DAQ_Viewer to its DAQ_Detector in another thread
+     using the method: command_hardware
+
+    Valid only for DAQ_Viewer command_hardware commands
+
+    """
+    INI_DETECTOR = 'ini_detector'
+
+    SINGLE = 'single'
+    GRAB = 'grab'
+    STOP_GRAB = 'stop_grab'
+    ROI_SELECT = 'roi_select'
+    UPDATE_SCANNER = 'update_scanner'  # may be deprecated
+    CROSSHAIR = 'crosshair'
+    UPDATE_WAIT_TIME = 'update_wait_time'
+    CLOSE = 'close'
+
+
+class UiToMainMove(StrEnum):
+    """ Allowed Commands to be sent from the DAQ_Move_UI to the DAQ_Move
+    """
+    INIT = 'init'
+    QUIT = 'quit'
+    SHOW_LOG = 'show_log'
+    SHOW_CONFIG = 'show_config'
+    STOP = 'stop'
+
+    MOVE_ABS = 'move_abs'
+    MOVE_REL = 'move_rel'
+
+    ACTUATOR_CHANGED = 'actuator_changed'
+
+    GET_VALUE = 'get_value'
+
+    FIND_HOME = 'find_home'
+    REL_VALUE = 'rel_value'
+
+    LOOP_GET_VALUE = 'loop_get_value'
+
+
+class UiToMainViewer(StrEnum):
+    """ Allowed Commands to be sent from the DAQ_Viewer_UI to the DAQ_Viewer
+    """
+    INIT = 'init'
+    QUIT = 'quit'
+    SHOW_LOG = 'show_log'
+    SHOW_CONFIG = 'show_config'
+    STOP = 'stop'
+
+    SNAP = 'snap'
+    GRAB = 'grab'
+    SAVE_CURRENT = 'save_current'
+    SAVE_NEW = 'save_new'
+    OPEN = 'open'
+
+    DETECTOR_CHANGED = 'detector_changed'
+    VIEWERS_CHANGED = 'viewers_changed'
+    DAQ_TYPE_CHANGED = 'daq_type_changed'
+
+    DO_BKG = 'do_bkg'
+    TAKE_BKG = 'take_bkg'

pymodaq/control_modules/ui_utils.py

@@ -0,0 +1,72 @@
+from importlib import import_module
+from pathlib import Path
+
+from qtpy import QtCore
+
+
+from pymodaq_gui.utils import CustomApp
+
+from pymodaq_utils.utils import ThreadCommand
+from pymodaq_utils.config import Config as ConfigUtils
+from pymodaq.utils.config import Config
+
+config_utils = ConfigUtils()
+config = Config()
+
+
+class ControlModuleUI(CustomApp):
+    """ Base Class for ControlModules UIs
+
+    Attributes
+    ----------
+    command_sig: Signal[Threadcommand]
+        This signal is emitted whenever some actions done by the user has to be
+        applied on the main module. Possible commands are:
+        See specific implementation
+
+    See Also
+    --------
+    :class:`daq_move_ui.DAQ_Move_UI`, :class:`daq_viewer_ui.DAQ_Viewer_UI`
+    """
+    command_sig = QtCore.Signal(ThreadCommand)
+
+    def __init__(self, parent):
+        super().__init__(parent)
+        self.config = config
+
+    def display_status(self, txt, wait_time=config_utils('general', 'message_status_persistence')):
+        if self.statusbar is not None:
+            self.statusbar.showMessage(txt, wait_time)
+
+    def do_init(self, do_init=True):
+        """Programmatically press the Init button
+        API entry
+        Parameters
+        ----------
+        do_init: bool
+            will fire the Init button depending on the argument value and the button check state
+        """
+        raise NotImplementedError
+
+    def send_init(self, checked: bool):
+        """Should be implemented to send to the main app the fact that someone (un)checked init."""
+        raise NotImplementedError
+
+
+def register_uis(parent_module_name: str = 'pymodaq.control_modules.daq_move_ui'):
+    uis = []
+    try:
+        scanner_module = import_module(f'{parent_module_name}.uis')
+
+        scanner_path = Path(scanner_module.__path__[0])
+
+        for file in scanner_path.iterdir():
+            if file.is_file() and 'py' in file.suffix and file.stem != '__init__':
+                try:
+                    uis.append(import_module(f'.{file.stem}', scanner_module.__name__))
+                except (ModuleNotFoundError, Exception) as e:
+                    pass
+    except ModuleNotFoundError:
+        pass
+    finally:
+        return uis