bec-widgets 0.69.0__py3-none-any.whl → 0.71.0__py3-none-any.whl

bec_widgets/widgets/scan_control/scan_group_box.py

@@ -0,0 +1,223 @@
+from typing import Literal
+
+from qtpy.QtWidgets import (
+    QCheckBox,
+    QComboBox,
+    QDoubleSpinBox,
+    QGridLayout,
+    QGroupBox,
+    QLabel,
+    QLineEdit,
+    QSpinBox,
+)
+
+from bec_widgets.utils.widget_io import WidgetIO
+from bec_widgets.widgets.device_inputs import DeviceLineEdit
+
+
+class ScanArgType:
+    DEVICE = "device"
+    FLOAT = "float"
+    INT = "int"
+    BOOL = "bool"
+    STR = "str"
+    DEVICEBASE = "DeviceBase"
+    LITERALS = "dict"
+
+
+class ScanSpinBox(QSpinBox):
+    def __init__(
+        self, parent=None, arg_name: str = None, default: int | None = None, *args, **kwargs
+    ):
+        super().__init__(parent=parent, *args, **kwargs)
+        self.arg_name = arg_name
+        self.setRange(-9999, 9999)
+        if default is not None:
+            self.setValue(default)
+
+
+class ScanDoubleSpinBox(QDoubleSpinBox):
+    def __init__(
+        self, parent=None, arg_name: str = None, default: float | None = None, *args, **kwargs
+    ):
+        super().__init__(parent=parent, *args, **kwargs)
+        self.arg_name = arg_name
+        self.setRange(-9999, 9999)
+        if default is not None:
+            self.setValue(default)
+
+
+class ScanLineEdit(QLineEdit):
+    def __init__(
+        self, parent=None, arg_name: str = None, default: str | None = None, *args, **kwargs
+    ):
+        super().__init__(parent=parent, *args, **kwargs)
+        self.arg_name = arg_name
+        if default is not None:
+            self.setText(default)
+
+
+class ScanCheckBox(QCheckBox):
+    def __init__(
+        self, parent=None, arg_name: str = None, default: bool | None = None, *args, **kwargs
+    ):
+        super().__init__(parent=parent, *args, **kwargs)
+        self.arg_name = arg_name
+        if default is not None:
+            self.setChecked(default)
+
+
+class ScanGroupBox(QGroupBox):
+    WIDGET_HANDLER = {
+        ScanArgType.DEVICE: DeviceLineEdit,
+        ScanArgType.DEVICEBASE: DeviceLineEdit,
+        ScanArgType.FLOAT: ScanDoubleSpinBox,
+        ScanArgType.INT: ScanSpinBox,
+        ScanArgType.BOOL: ScanCheckBox,
+        ScanArgType.STR: ScanLineEdit,
+        ScanArgType.LITERALS: QComboBox,  # TODO figure out combobox logic
+    }
+
+    def __init__(
+        self,
+        parent=None,
+        box_type=Literal["args", "kwargs"],
+        config: dict | None = None,
+        *args,
+        **kwargs,
+    ):
+        super().__init__(parent=parent, *args, **kwargs)
+        self.config = config
+        self.box_type = box_type
+
+        self.layout = QGridLayout(self)
+        self.labels = []
+        self.widgets = []
+
+        self.init_box(self.config)
+
+    def init_box(self, config: dict):
+        box_name = config.get("name", "ScanGroupBox")
+        self.inputs = config.get("inputs", {})
+        self.setTitle(box_name)
+
+        # Labels
+        self.add_input_labels(self.inputs, 0)
+
+        # Widgets
+        if self.box_type == "args":
+            min_bundle = self.config.get("min", 1)
+            for i in range(1, min_bundle + 1):
+                self.add_input_widgets(self.inputs, i)
+        else:
+            self.add_input_widgets(self.inputs, 1)
+
+    def add_input_labels(self, group_inputs: dict, row: int) -> None:
+        """
+        Adds the given arg_group from arg_bundle to the scan control layout. The input labels are always added to the first row.
+
+        Args:
+            group(dict): Dictionary containing the arg_group information.
+        """
+        for column_index, item in enumerate(group_inputs):
+            arg_name = item.get("name", None)
+            display_name = item.get("display_name", arg_name)
+            label = QLabel(text=display_name)
+            self.layout.addWidget(label, row, column_index)
+            self.labels.append(label)
+
+    def add_input_widgets(self, group_inputs: dict, row) -> None:
+        """
+        Adds the given arg_group from arg_bundle to the scan control layout.
+
+        Args:
+            group_inputs(dict): Dictionary containing the arg_group information.
+            row(int): The row to add the widgets to.
+        """
+        for column_index, item in enumerate(group_inputs):
+            arg_name = item.get("name", None)
+            default = item.get("default", None)
+            widget = self.WIDGET_HANDLER.get(item["type"], None)
+            if widget is None:
+                print(f"Unsupported annotation '{item['type']}' for parameter '{item['name']}'")
+                continue
+            if default == "_empty":
+                default = None
+            widget_to_add = widget(arg_name=arg_name, default=default)
+            tooltip = item.get("tooltip", None)
+            if tooltip is not None:
+                widget_to_add.setToolTip(item["tooltip"])
+            self.layout.addWidget(widget_to_add, row, column_index)
+            self.widgets.append(widget_to_add)
+
+    def add_widget_bundle(self):
+        """
+        Adds a new row of widgets to the scan control layout. Only usable for arg_groups.
+        """
+        if self.box_type != "args":
+            return
+        arg_max = self.config.get("max", None)
+        row = self.layout.rowCount()
+        if arg_max is not None and row >= arg_max:
+            return
+
+        self.add_input_widgets(self.inputs, row)
+
+    def remove_widget_bundle(self):
+        """
+        Removes the last row of widgets from the scan control layout. Only usable for arg_groups.
+        """
+        if self.box_type != "args":
+            return
+        arg_min = self.config.get("min", None)
+        row = self.count_arg_rows()
+        if arg_min is not None and row <= arg_min:
+            return
+
+        for widget in self.widgets[-len(self.inputs) :]:
+            widget.deleteLater()
+        self.widgets = self.widgets[: -len(self.inputs)]
+
+    def get_parameters(self):
+        """
+        Returns the parameters from the widgets in the scan control layout formated to run scan from BEC.
+        """
+        if self.box_type == "args":
+            return self._get_arg_parameterts()
+        elif self.box_type == "kwargs":
+            return self._get_kwarg_parameters()
+
+    def _get_arg_parameterts(self):
+        args = []
+        for i in range(1, self.layout.rowCount()):
+            for j in range(self.layout.columnCount()):
+                widget = self.layout.itemAtPosition(i, j).widget()
+                if isinstance(widget, DeviceLineEdit):
+                    value = widget.get_device()
+                else:
+                    value = WidgetIO.get_value(widget)
+                args.append(value)
+        return args
+
+    def _get_kwarg_parameters(self):
+        kwargs = {}
+        for i in range(self.layout.columnCount()):
+            widget = self.layout.itemAtPosition(1, i).widget()
+            if isinstance(widget, DeviceLineEdit):
+                value = widget.get_device()
+            else:
+                value = WidgetIO.get_value(widget)
+            kwargs[widget.arg_name] = value
+        return kwargs
+
+    def count_arg_rows(self):
+        widget_rows = 0
+        for row in range(self.layout.rowCount()):
+            for col in range(self.layout.columnCount()):
+                item = self.layout.itemAtPosition(row, col)
+                if item is not None:
+                    widget = item.widget()
+                    if widget is not None:
+                        if isinstance(widget, DeviceLineEdit):
+                            widget_rows += 1
+        return widget_rows

{bec_widgets-0.69.0.dist-info → bec_widgets-0.71.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.69.0
+Version: 0.71.0
 Summary: BEC Widgets
 Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec_widgets/issues
 Project-URL: Homepage, https://gitlab.psi.ch/bec/bec_widgets

{bec_widgets-0.69.0.dist-info → bec_widgets-0.71.0.dist-info}/RECORD

@@ -2,11 +2,11 @@
 .gitlab-ci.yml,sha256=RnYDz4zKXjlqltTryprlB1s5vLXxI2-seW-Vb70NNF0,8162
 .pylintrc,sha256=OstrgmEyP0smNFBKoIN5_26-UmNZgMHnbjvAWX0UrLs,18535
 .readthedocs.yaml,sha256=aSOc277LqXcsTI6lgvm_JY80lMlr69GbPKgivua2cS0,603
-CHANGELOG.md,sha256=48HpbXwe-Y_t9YJAntu3fJ8MU4DN6bSWSJWj-1bJAEY,7057
+CHANGELOG.md,sha256=G8kiuKBLYo8mE65R9TMUCjp2wL0-b_Qmf1jfmVq6xfw,7407
 LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-PKG-INFO,sha256=GEZve_LqjICZHq1bEuZ7S1woFWxfQSVUsGmIVgudNYE,1302
+PKG-INFO,sha256=yJmWivH4mEeBkmuE4Qt0Tba4AEFW8OJIXt3QQxnUP8A,1302
 README.md,sha256=y4jB6wvArS7N8_iTbKWnSM_oRAqLA2GqgzUR-FMh5sU,2645
-pyproject.toml,sha256=Td8223p7vyZ4AVOTaqH50fwtAgfFtSIRq-QYp625MOA,2162
+pyproject.toml,sha256=srKN62y_l-c28R8DtIAj_uspBsCVVDcoWYMi2hdnbgo,2215
 .git_hooks/pre-commit,sha256=n3RofIZHJl8zfJJIUomcMyYGFi_rwq4CC19z0snz3FI,286
 .gitlab/issue_templates/bug_report_template.md,sha256=gAuyEwl7XlnebBrkiJ9AqffSNOywmr8vygUFWKTuQeI,386
 .gitlab/issue_templates/documentation_update_template.md,sha256=FHLdb3TS_D9aL4CYZCjyXSulbaW5mrN2CmwTaeLPbNw,860
@@ -17,7 +17,7 @@ bec_widgets/assets/bec_widgets_icon.png,sha256=K8dgGwIjalDh9PRHUsSQBqgdX7a00nM3i
 bec_widgets/assets/terminal_icon.png,sha256=bJl7Tft4Fi2uxvuXI8o14uMHnI9eAWKSU2uftXCH9ws,3889
 bec_widgets/cli/__init__.py,sha256=d0Q6Fn44e7wFfLabDOBxpcJ1DPKWlFunGYDUBmO-4hA,22
 bec_widgets/cli/auto_updates.py,sha256=DyBV3HnjMSH-cvVkYNcDiYKVf0Xut4Qy2qGQqkW47Bw,4833
-bec_widgets/cli/client.py,sha256=DNsCueEdVwW0MWjBIIg-vhTu_p64qr0QurT7mHM79is,58074
+bec_widgets/cli/client.py,sha256=6W85QrsOAmNipucjWBf65AOUd-ODvuzlCAjtE9YMskM,58455
 bec_widgets/cli/client_utils.py,sha256=_Hb2nl1rKEf7k4By9VZDYl5YyGFczxMuYIFMVrOAZD0,12182
 bec_widgets/cli/generate_cli.py,sha256=InKBVYM7DRfAVLNJhRJbWWSSPBQBHI8Ek6v7NCsK0ME,4997
 bec_widgets/cli/rpc_register.py,sha256=QxXUZu5XNg00Yf5O3UHWOXg3-f_pzKjjoZYMOa-MOJc,2216
@@ -30,8 +30,16 @@ bec_widgets/examples/jupyter_console/jupyter_console_window.ui,sha256=2A2mNTUMZB
 bec_widgets/examples/motor_movement/__init__.py,sha256=LzPJkxLAxOsZCbXR-fRCPmeYobp7Yqds6tDxW4W1gSw,214
 bec_widgets/examples/motor_movement/motor_control_compilations.py,sha256=8rpA7a2xVZTDMrx7YQIj3IJew78J1gcVMkHvloS0U_Q,9055
 bec_widgets/examples/motor_movement/motor_controller.ui,sha256=83XX6NGILwntoUIghvzWnMuGf80O8khK3SduVKTAEFM,29105
+bec_widgets/examples/plugin_example_pyside/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bec_widgets/examples/plugin_example_pyside/main.py,sha256=xdC6RWSRt1rW8Prj0CsDeCPct6-_j3__oJmdgogB5PI,505
+bec_widgets/examples/plugin_example_pyside/registertictactoe.py,sha256=VNFkHc5Sc30lRKzOFJbhArCHGkp_wRxOeJjZbmaAHRU,448
+bec_widgets/examples/plugin_example_pyside/taskmenuextension.pyproject,sha256=O_PSMFJlXxQuf55gIOfkpfZIZGpX8W1SfUVZ-mvtI_E,119
+bec_widgets/examples/plugin_example_pyside/tictactoe.py,sha256=s3rCurXloVcmMdzZiSzDS7Lgj0Qe6x8-wkxCeiXYX80,4904
+bec_widgets/examples/plugin_example_pyside/tictactoeplugin.py,sha256=BBt3MD8oDLUMCCY3mioJa1QRR0WQdW6DuvVmK1Taovk,1734
+bec_widgets/examples/plugin_example_pyside/tictactoetaskmenu.py,sha256=LNwplI6deUdKY6FOhUuWBanotxk9asF2G-6k7lFfA8Y,2301
 bec_widgets/utils/__init__.py,sha256=1930ji1Jj6dVuY81Wd2kYBhHYNV-2R0bN_L4o9zBj1U,533
 bec_widgets/utils/bec_connector.py,sha256=RxHJNF7JjtY5pRbTMu2eQTiRXvoyJ53QuTYxHjZba38,5357
+bec_widgets/utils/bec_designer.py,sha256=gaxNuxRu-3rQylUd5lGSysK1lqoRg8gtmfad0CnsUPU,2613
 bec_widgets/utils/bec_dispatcher.py,sha256=yM9PG04O7ABhiA9Nzk38Rv9Qbjc5O93wi2xfSbOlOxc,6202
 bec_widgets/utils/bec_table.py,sha256=nA2b8ukSeUfquFMAxGrUVOqdrzMoDYD6O_4EYbOG2zk,717
 bec_widgets/utils/colors.py,sha256=GYSDe0ZxsJSwxvuy-yG2BH17qlf_Sjq8dhDcyp9IhBI,8532
@@ -44,7 +52,7 @@ bec_widgets/utils/rpc_decorator.py,sha256=pIvtqySQLnuS7l2Ti_UAe4WX7CRivZnsE5ZdKA
 bec_widgets/utils/thread_checker.py,sha256=rDNuA3X6KQyA7JPb67mccTg0z8YkInynLAENQDQpbuE,1607
 bec_widgets/utils/ui_loader.py,sha256=5NktcP1r1HQub7K82fW_jkj8rT2cqJQdMvDxwToLY4E,1650
 bec_widgets/utils/validator_delegate.py,sha256=Emj1WF6W8Ke1ruBWUfmHdVJpmOSPezuOt4zvQTay_44,442
-bec_widgets/utils/widget_io.py,sha256=f36198CvT_EzWQ_cg2G-4tRRsaMdJ3yVqsZWKJCQEfA,10880
+bec_widgets/utils/widget_io.py,sha256=U_02ESf9Ukz63B01AzYioNepSc6SX11nJhPPSDmL4IA,11318
 bec_widgets/utils/yaml_dialog.py,sha256=cMVif-39SB9WjwGH5FWBJcFs4tnfFJFs5cacydRyhy0,1853
 bec_widgets/widgets/__init__.py,sha256=6RE9Pot2ud6BNJc_ZKiE--U-lgVRUff2IVR91lPcCbo,214
 bec_widgets/widgets/bec_status_box/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -54,11 +62,19 @@ bec_widgets/widgets/buttons/__init__.py,sha256=74ucIRU6-anoqQ-zT7wbrysmxhg_3_04x
 bec_widgets/widgets/buttons/stop_button/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/buttons/stop_button/stop_button.py,sha256=x4a7RvlMkHzOd05zKOGYkyTmBza7Me7jgOL9WIgA_c4,906
 bec_widgets/widgets/device_inputs/__init__.py,sha256=BcWvcSASPh6YdDu5jfC48xqI2_iBj1epUt4doYJQHEs,122
-bec_widgets/widgets/device_inputs/device_input_base.py,sha256=ew3G1WXX0srCOQ2uRSjYoK5zB-NBZ9EwwhO-rmR3K4M,3803
+bec_widgets/widgets/device_inputs/device_input_base.py,sha256=AP0Pgto87CKqgTuzrmFL3a7MOW9_qm1rmyiI2ZrvCOM,3839
 bec_widgets/widgets/device_inputs/device_combobox/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bec_widgets/widgets/device_inputs/device_combobox/device_combobox.py,sha256=_XL40tD1AVuSMmjC2movK5tscZzxfRnKg3lyZbvE6ZE,2889
+bec_widgets/widgets/device_inputs/device_combobox/device_combobox.py,sha256=S5QIDis1SKVVUH2bYgROE40xdMBCuoZAGuh5yW0OvU0,2815
+bec_widgets/widgets/device_inputs/device_combobox/device_combobox.pyproject,sha256=AH6Oz_4aDCzsBbHWnCNK_ALvQ0Qwj-z24sUG1oNSK3I,75
+bec_widgets/widgets/device_inputs/device_combobox/device_combobox_plugin.py,sha256=VfbP0PrLwME8OB1bz1kVmy8vJCZDRONvas5j5cPyd08,1218
+bec_widgets/widgets/device_inputs/device_combobox/launch_device_combobox.py,sha256=jr9JJHtIPmbUNLpGLUESS_bYcITnbv-W3EdrZCHq2Rg,267
+bec_widgets/widgets/device_inputs/device_combobox/register_device_combobox.py,sha256=V6QcxBU9Lli4qy2Vhf9bFfpTsofsc-bT-_vEp0heBsM,518
 bec_widgets/widgets/device_inputs/device_line_edit/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-bec_widgets/widgets/device_inputs/device_line_edit/device_line_edit.py,sha256=cvvFg9HS7yN9kn-lWI_Uvj_dq2xlqNhuDi21e73k2xo,3249
+bec_widgets/widgets/device_inputs/device_line_edit/device_line_edit.py,sha256=147grp_zFMlYq4MiSffw9QULTD5hQWby7v7xf93-Oxk,3368
+bec_widgets/widgets/device_inputs/device_line_edit/device_line_edit.pyproject,sha256=0GTk3WfNUHl-6tFEAY0pel5XBpVR0oyRX2BU-LNzVps,77
+bec_widgets/widgets/device_inputs/device_line_edit/device_line_edit_plugin.py,sha256=J1MNrtXkgBrwEsUXnf0pGRoNJ1g_OWqk-xafSpV4ot8,1239
+bec_widgets/widgets/device_inputs/device_line_edit/launch_device_line_edit.py,sha256=3sVZ-5Hoy1smhgBcnzO9SXHk5_oUEaWFnRfslXAW3_4,267
+bec_widgets/widgets/device_inputs/device_line_edit/register_device_line_edit.py,sha256=GXHPRe1kSkJ2NKDWQJWabI4a6Maw__niA2g5wLiheX8,520
 bec_widgets/widgets/dock/__init__.py,sha256=B7foHt02gnhM7mFksa7GJVwT7n0j_JvYDCt6wc6XR5g,61
 bec_widgets/widgets/dock/dock.py,sha256=lEl6ppy0v-8X5bVX7EQIYka8rAakjkZyh6ufgr7YxKs,7595
 bec_widgets/widgets/dock/dock_area.py,sha256=9c_tLzyBRllLfc4H5o9-4bvasWp5hWe1NWg4mupXVtU,7911
@@ -92,7 +108,8 @@ bec_widgets/widgets/motor_control/selection/__init__.py,sha256=47DEQpj8HBSa-_TIm
 bec_widgets/widgets/motor_control/selection/selection.py,sha256=WNHndvv4JvxeAMnDFBMTvUILcn9u_0mWGRsgNiBZEsM,3988
 bec_widgets/widgets/motor_control/selection/selection.ui,sha256=vXXpvNWuL6xyHhW7Lx1zmVFX-95Z5AXGlhKQD2HmM1A,1779
 bec_widgets/widgets/scan_control/__init__.py,sha256=IOfHl15vxb_uC6KN62-PeUzbBha_vQyqkkXbJ2HU674,38
-bec_widgets/widgets/scan_control/scan_control.py,sha256=B5n2U2iVtTCY3Tx93JyBqzGCDCmWhWwAOhbPelLI-bs,17168
+bec_widgets/widgets/scan_control/scan_control.py,sha256=u2fjSUiSRYTkIq9WhdfQuQV6Sv3iWWcSfCraVGro1RQ,7686
+bec_widgets/widgets/scan_control/scan_group_box.py,sha256=8XGpYcdKTEtiqOFbBxZ6xV07ZJ_tg9R-JDfsdTdqXSI,7400
 bec_widgets/widgets/spiral_progress_bar/__init__.py,sha256=4efbtcqCToMIw5bkQrTzy2TzuBCXvlhuUPh1bYC_Yzg,51
 bec_widgets/widgets/spiral_progress_bar/ring.py,sha256=7i5oKpW8eUQGvLyKce2-2rlaGDVLec__DoWp6hfJlRw,10524
 bec_widgets/widgets/spiral_progress_bar/spiral_progress_bar.py,sha256=cMi4g7zNTLrkkzZ9ChiIBTaqigDCYwzrgA2iRmq9dUI,24050
@@ -138,11 +155,13 @@ docs/user/getting_started/quick_start.md,sha256=VGU880GwamcIZcBE8tjxuqX2syE-71jq
 docs/user/widgets/BECFigure.png,sha256=8dQr4u0uk_y0VV-R1Jh9yTR3Vidd9HDEno_07R0swaE,1605920
 docs/user/widgets/bec_figure.md,sha256=BwcumbhZd6a2zKmoHTvwKr8kG8WxBx9lS_QwxNiBMpQ,5155
 docs/user/widgets/bec_status_box.gif,sha256=kLxf40HbS6fjdUIQ2b9SiduBEXdBd4DDWGEnQDOFMcY,1259044
-docs/user/widgets/bec_status_box.md,sha256=0ILY12UnSjiVCtd5qpC8G2dPBYhug3J_rmQLilDxulY,1164
+docs/user/widgets/bec_status_box.md,sha256=YJ7uHuaHRsvP7tkC65O7siJOzm1LRtsrvH1ikeOH9xo,1156
 docs/user/widgets/buttons.md,sha256=Yci21PmxlRvfKcrvY7mVI7JkECPmE6j9WyWyH3j7Y2o,1221
 docs/user/widgets/image_plot.gif,sha256=_mVFhMTXGqwDOcEtrBHMZj5Thn2sLhDAHEeL2XyHN-s,14098977
 docs/user/widgets/motor.gif,sha256=FtaWdRHx4UZaGJPpq8LNhMMgX4PFcAB6IZ93JCMEh_w,2280719
 docs/user/widgets/progress_bar.gif,sha256=5jh0Zw2BBGPuNxszV1DBLJCb4_6glIRX-U2ABjnsK2k,5263592
+docs/user/widgets/scan_control.gif,sha256=zrVOZgleMbu7Jd8AAIn2fQ08tNAEMSud3g0ZLyNUcjQ,1506739
+docs/user/widgets/scan_control.md,sha256=lsn08uw90uRajxfBqRxIYiq52xWKqRPVO6mfI6qzolI,1721
 docs/user/widgets/scatter_2D.gif,sha256=yHpsuAUseMafJjI_J5BcOhmE3nu9VFn_Xm9XHzJaH5I,13188862
 docs/user/widgets/spiral_progress_bar.md,sha256=QTgUDIl6XPuK_HwSfB6sNijZ4bss26biDg6B_mJ8Pxk,2208
 docs/user/widgets/text_box.md,sha256=_ST7RQWXl67MKLm6dTa995GjoughPUyK_hLnF8SPZcM,925
@@ -155,6 +174,7 @@ tests/end-2-end/conftest.py,sha256=-BLnFE-NeCerf6xahGCkbZ4Ktactowi6RkBnboIzRvg,1
 tests/end-2-end/test_bec_dock_rpc_e2e.py,sha256=8iJz4lITspY7eHdSgy9YvGUGTu3fsSperoVGBvTGT0U,9067
 tests/end-2-end/test_bec_figure_rpc_e2e.py,sha256=zTbB_F4Fs-QG8KhMK24xfsrCQBgZUAguMk3KFdEdP2o,5095
 tests/end-2-end/test_rpc_register_e2e.py,sha256=3dfCnSvdcRO92pzHt9WlCTK0vzTKAvPtliEoEKrtuzQ,1604
+tests/end-2-end/test_scan_control_e2e.py,sha256=u7oLgFyltkMW2apSZKDukMIXvYrbhHrU32p4mBdn8VE,2276
 tests/unit_tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/unit_tests/client_mocks.py,sha256=R71MJSu8IEyxcJjaIWCPACO_wOfx2Uv_qkmFVVmv7EQ,4195
 tests/unit_tests/conftest.py,sha256=KrnktXPWmZhnKNue-xGWOLD1XGEvdz9Vf7V2eO3XQ3A,596
@@ -167,15 +187,16 @@ tests/unit_tests/test_bec_status_box.py,sha256=zZ4pe7DaBzzpRsy62yHFkUGgAGb3zZU3I
 tests/unit_tests/test_client_utils.py,sha256=eViJ1Tz-HX9TkMvQH6W8cO-c3_1I8bUc4_Yen6LOc0E,830
 tests/unit_tests/test_color_validation.py,sha256=csdvVKAohENZIRY-JQ97Hv-TShb1erj4oKMX7QRwo78,1883
 tests/unit_tests/test_crosshair.py,sha256=3OMAJ2ZaISYXMOtkXf1rPdy94vCr8njeLi6uHblBL9Q,5045
-tests/unit_tests/test_device_input_base.py,sha256=HesN6jDY1msbPPFsu3-wTcAmA27y92zxIgzt7tDo7MY,2451
-tests/unit_tests/test_device_input_widgets.py,sha256=TOtO4z2c_rBmVlB5KD9JvEkyK-GXn1usbM0f2Scjpgc,5875
+tests/unit_tests/test_device_input_base.py,sha256=DiwbNzFQ8o90ELhlT103roqLNEzJ09bvlpNrOmT4lfM,2423
+tests/unit_tests/test_device_input_widgets.py,sha256=yQ67Xwn-T7NHAIT1XLA4DvcxQEIJYMUr9PfPnT6CAPI,5805
 tests/unit_tests/test_generate_cli_client.py,sha256=adcMoXjWpFLVjpauCu0r31CMMibUY1LF1MMf8rO-6rw,2815
 tests/unit_tests/test_motor_control.py,sha256=NBekcGALo5mYkuyBJvBhvJkWiQDV82hI4GmsobRzjTI,20770
 tests/unit_tests/test_plot_base.py,sha256=Akr_JgglUCrtERtdtsMqWko_MLUYoAYRGzV2sum-YHo,3836
 tests/unit_tests/test_plugin_utils.py,sha256=PonKNpu4fZaFmKbI2v0tZJjZrsTvBGSF96bPHvKJvrE,608
 tests/unit_tests/test_rpc_register.py,sha256=hECjZEimd440mwRrO0rg7L3PKN7__3DgjmESN6wx3bo,1179
 tests/unit_tests/test_rpc_widget_handler.py,sha256=QC85N48UAFsROKRNkoDIfInzy1mLhp2buLVSJifkhiU,236
-tests/unit_tests/test_scan_control.py,sha256=Xf8bGt8lRJobRwBoqUdVXxsHno8ejvC77FqprhF7Z6I,7564
+tests/unit_tests/test_scan_control.py,sha256=Wr6KcE8av4sEIOx5VgYbzVCem3Jgb4Kzx_oOuvwlmkE,13459
+tests/unit_tests/test_scan_control_group_box.py,sha256=HNqjP10B_NonikspNwKz9upJU-t7xf6hwBerNhbC-uo,5563
 tests/unit_tests/test_spiral_progress_bar.py,sha256=n5aLSZ2B6K5a1vQuKTERnCSmIz9hYGFyk7jP3TU0AwQ,12438
 tests/unit_tests/test_stop_button.py,sha256=2OH9dhs_-S5QovPPgU-5hJoViE1YKZa0gxisb4vOY28,712
 tests/unit_tests/test_text_box_widget.py,sha256=cT0uEHt_6d-FwST0A_wE9sFW9E3F_nJbKhuBAeU4yHg,1862
@@ -189,8 +210,8 @@ tests/unit_tests/test_configs/config_device_no_entry.yaml,sha256=hdvue9KLc_kfNzG
 tests/unit_tests/test_configs/config_scan.yaml,sha256=vo484BbWOjA_e-h6bTjSV9k7QaQHrlAvx-z8wtY-P4E,1915
 tests/unit_tests/test_msgs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/unit_tests/test_msgs/available_scans_message.py,sha256=m_z97hIrjHXXMa2Ex-UvsPmTxOYXfjxyJaGkIY6StTY,46532
-bec_widgets-0.69.0.dist-info/METADATA,sha256=GEZve_LqjICZHq1bEuZ7S1woFWxfQSVUsGmIVgudNYE,1302
-bec_widgets-0.69.0.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
-bec_widgets-0.69.0.dist-info/entry_points.txt,sha256=OvoqiNzNF9bizFQNhbAmmdc_njHrnVewLE-Kl-u9sh0,115
-bec_widgets-0.69.0.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-bec_widgets-0.69.0.dist-info/RECORD,,
+bec_widgets-0.71.0.dist-info/METADATA,sha256=yJmWivH4mEeBkmuE4Qt0Tba4AEFW8OJIXt3QQxnUP8A,1302
+bec_widgets-0.71.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+bec_widgets-0.71.0.dist-info/entry_points.txt,sha256=3otEkCdDB9LZJuBLzG4pFLK5Di0CVybN_12IsZrQ-58,166
+bec_widgets-0.71.0.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
+bec_widgets-0.71.0.dist-info/RECORD,,

{bec_widgets-0.69.0.dist-info → bec_widgets-0.71.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.24.2
+Generator: hatchling 1.25.0
 Root-Is-Purelib: true
 Tag: py3-none-any

{bec_widgets-0.69.0.dist-info → bec_widgets-0.71.0.dist-info}/entry_points.txt

@@ -1,3 +1,4 @@
 [console_scripts]
+bec-designer = bec_widgets.utils.bec_designer:main
 bec-gui-server = bec_widgets.cli.server:main
 bw-generate-cli = bec_widgets.cli.generate_cli:main

docs/user/widgets/bec_status_box.md

@@ -2,7 +2,7 @@
 # BEC Status Box
 **Purpose:**
 
-The [BECStatusBox]](/api_reference/_autosummary/bec_widgets.cli.client.BECStatusBox) Widget is a widget that allows you to monitor the status/health of the all running BEC processes. The widget generates the view automatically and updates the status of the processes in real-time. The top level indicates the overall state of the BEC core services (DeviceServer, ScanServer, SciHub, ScanBundler and FileWriter), but you can also see the status of each individual process by opening the collapsed view. In the collapsed view, you can double click on each process to get a popup window with live updates of the metrics for each process in real-time.
+The [BECStatusBox](/api_reference/_autosummary/bec_widgets.cli.client.BECStatusBox) is a widget that allows you to monitor the status/health of the all running BEC processes. The widget generates the view automatically and updates the status of the processes in real-time. The top level indicates the overall state of the BEC core services (DeviceServer, ScanServer, SciHub, ScanBundler and FileWriter), but you can also see the status of each individual process by opening the collapsed view. In the collapsed view, you can double click on each process to get a popup window with live updates of the metrics for each process in real-time.
 
 **Key Features:**
 

docs/user/widgets/scan_control.md

@@ -0,0 +1,35 @@
+(user.widgets.scan_control)=
+
+# Scan Control
+
+**Purpose:**
+
+The `ScanControl` widget is designed to generate a graphical user interface (GUI) to control various scan operations
+based on the scan's signature and `gui_config`. The widget is used to control the scan operations, such as starting,
+stopping, and pausing the scan. The widget also provides a graphical representation of the scan progress and the scan
+status. The widget is designed to be used in conjunction with the `ScanServer` and `ScanBundler` services from the BEC
+core services.
+
+By default the widget supports only the scans which have defined `gui_config` and are inhereted from these scan classes:
+
+- [ScanBase](https://beamline-experiment-control.readthedocs.io/en/latest/api_reference/_autosummary/bec_server.scan_server.scans.ScanBase.html)
+- [SyncFlyScanBase](https://beamline-experiment-control.readthedocs.io/en/latest/api_reference/_autosummary/bec_server.scan_server.scans.SyncFlyScanBase.html)
+- [AsyncFlyScanBase](https://beamline-experiment-control.readthedocs.io/en/latest/api_reference/_autosummary/bec_server.scan_server.scans.AsyncFlyScanBase.html)
+
+**Key Features:**
+
+- Automatically generates a control interface based on scan signatures and `gui_config`.
+- Supports adding and removing argument bundles dynamically.
+- Provides a visual representation of scan parameters grouped by functionality.
+- Integrates start and stop controls for executing and halting scans.
+
+**Example of Use:**
+
+**Code example:**
+The following code snipped demonstrates how to create a `ScanControl` widget using BEC Widgets within `BECIPythonClient`
+
+![ScanControl](./scan_control.gif)
+
+```python
+scan_control = gui.add_dock().add_widget("ScanControl")
+```

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_widgets"
-version = "0.69.0"
+version = "0.71.0"
 description = "BEC Widgets"
 requires-python = ">=3.10"
 classifiers = [
@@ -49,6 +49,7 @@ Homepage = "https://gitlab.psi.ch/bec/bec_widgets"
 [project.scripts]
 bw-generate-cli = "bec_widgets.cli.generate_cli:main"
 bec-gui-server = "bec_widgets.cli.server:main"
+bec-designer = "bec_widgets.utils.bec_designer:main"
 
 [tool.hatch.build.targets.wheel]
 include = ["*"]

tests/end-2-end/test_scan_control_e2e.py

@@ -0,0 +1,71 @@
+import time
+
+import pytest
+
+from bec_widgets.utils.widget_io import WidgetIO
+from bec_widgets.widgets.scan_control import ScanControl
+
+
+@pytest.fixture(scope="function")
+def scan_control(qtbot, bec_client_lib):  # , mock_dev):
+    widget = ScanControl(client=bec_client_lib)
+    qtbot.addWidget(widget)
+    qtbot.waitExposed(widget)
+    yield widget
+
+
+def test_scan_control_populate_scans_e2e(scan_control):
+    expected_scans = [
+        "grid_scan",
+        "fermat_scan",
+        "round_scan",
+        "cont_line_scan",
+        "cont_line_fly_scan",
+        "round_scan_fly",
+        "round_roi_scan",
+        "time_scan",
+        "monitor_scan",
+        "acquire",
+        "line_scan",
+    ]
+    items = [
+        scan_control.comboBox_scan_selection.itemText(i)
+        for i in range(scan_control.comboBox_scan_selection.count())
+    ]
+    assert scan_control.comboBox_scan_selection.count() == len(expected_scans)
+    assert sorted(items) == sorted(expected_scans)
+
+
+def test_run_line_scan_with_parameters_e2e(scan_control, bec_client_lib, qtbot):
+    client = bec_client_lib
+    queue = client.queue
+
+    scan_name = "line_scan"
+    kwargs = {"exp_time": 0.01, "steps": 10, "relative": True, "burst_at_each_point": 1}
+    args = {"device": "samx", "start": -5, "stop": 5}
+
+    scan_control.comboBox_scan_selection.setCurrentText(scan_name)
+
+    # Set kwargs in the UI
+    for kwarg_box in scan_control.kwarg_boxes:
+        for widget in kwarg_box.widgets:
+            for key, value in kwargs.items():
+                if widget.arg_name == key:
+                    WidgetIO.set_value(widget, value)
+                    break
+    # Set args in the UI
+    for widget in scan_control.arg_box.widgets:
+        for key, value in args.items():
+            if widget.arg_name == key:
+                WidgetIO.set_value(widget, value)
+                break
+
+    # Run the scan
+    scan_control.button_run_scan.click()
+    time.sleep(2)
+
+    last_scan = queue.scan_storage.storage[-1]
+    assert last_scan.status_message.info["scan_name"] == scan_name
+    assert last_scan.status_message.info["exp_time"] == kwargs["exp_time"]
+    assert last_scan.status_message.info["scan_motors"] == [args["device"]]
+    assert last_scan.status_message.info["num_points"] == kwargs["steps"]

tests/unit_tests/test_device_input_base.py

@@ -17,7 +17,7 @@ def test_device_input_base_init(device_input_base):
     assert isinstance(device_input_base, DeviceInputBase)
     assert device_input_base.config.widget_class == "DeviceInputBase"
     assert device_input_base.config.device_filter is None
-    assert device_input_base.config.default_device is None
+    assert device_input_base.config.default is None
     assert device_input_base.devices == []
 
 
@@ -26,12 +26,12 @@ def test_device_input_base_init_with_config(mocked_client):
         "widget_class": "DeviceInputBase",
         "gui_id": "test_gui_id",
         "device_filter": "FakePositioner",
-        "default_device": "samx",
+        "default": "samx",
     }
     widget = DeviceInputBase(client=mocked_client, config=config)
     assert widget.config.gui_id == "test_gui_id"
     assert widget.config.device_filter == "FakePositioner"
-    assert widget.config.default_device == "samx"
+    assert widget.config.default == "samx"
 
 
 def test_device_input_base_set_device_filter(device_input_base):
@@ -47,7 +47,7 @@ def test_device_input_base_set_device_filter_error(device_input_base):
 
 def test_device_input_base_set_default_device(device_input_base):
     device_input_base.set_default_device("samx")
-    assert device_input_base.config.default_device == "samx"
+    assert device_input_base.config.default == "samx"
 
 
 def test_device_input_base_set_default_device_error(device_input_base):

tests/unit_tests/test_device_input_widgets.py

@@ -21,7 +21,7 @@ def device_input_combobox_with_config(qtbot, mocked_client):
         "widget_class": "DeviceComboBox",
         "gui_id": "test_gui_id",
         "device_filter": "FakePositioner",
-        "default_device": "samx",
+        "default": "samx",
         "arg_name": "test_arg_name",
     }
     widget = DeviceComboBox(client=mocked_client, config=config)
@@ -37,7 +37,7 @@ def device_input_combobox_with_kwargs(qtbot, mocked_client):
         client=mocked_client,
         gui_id="test_gui_id",
         device_filter="FakePositioner",
-        default_device="samx",
+        default="samx",
         arg_name="test_arg_name",
     )
     qtbot.addWidget(widget)
@@ -52,7 +52,7 @@ def test_device_input_combobox_init(device_input_combobox):
     assert isinstance(device_input_combobox, DeviceComboBox)
     assert device_input_combobox.config.widget_class == "DeviceComboBox"
     assert device_input_combobox.config.device_filter is None
-    assert device_input_combobox.config.default_device is None
+    assert device_input_combobox.config.default is None
     assert device_input_combobox.devices == [
         "samx",
         "samy",
@@ -72,14 +72,14 @@ def test_device_input_combobox_init(device_input_combobox):
 def test_device_input_combobox_init_with_config(device_input_combobox_with_config):
     assert device_input_combobox_with_config.config.gui_id == "test_gui_id"
     assert device_input_combobox_with_config.config.device_filter == "FakePositioner"
-    assert device_input_combobox_with_config.config.default_device == "samx"
+    assert device_input_combobox_with_config.config.default == "samx"
     assert device_input_combobox_with_config.config.arg_name == "test_arg_name"
 
 
 def test_device_input_combobox_init_with_kwargs(device_input_combobox_with_kwargs):
     assert device_input_combobox_with_kwargs.config.gui_id == "test_gui_id"
     assert device_input_combobox_with_kwargs.config.device_filter == "FakePositioner"
-    assert device_input_combobox_with_kwargs.config.default_device == "samx"
+    assert device_input_combobox_with_kwargs.config.default == "samx"
     assert device_input_combobox_with_kwargs.config.arg_name == "test_arg_name"
 
 
@@ -106,7 +106,7 @@ def device_input_line_edit_with_config(qtbot, mocked_client):
         "widget_class": "DeviceLineEdit",
         "gui_id": "test_gui_id",
         "device_filter": "FakePositioner",
-        "default_device": "samx",
+        "default": "samx",
         "arg_name": "test_arg_name",
     }
     widget = DeviceLineEdit(client=mocked_client, config=config)
@@ -122,7 +122,7 @@ def device_input_line_edit_with_kwargs(qtbot, mocked_client):
         client=mocked_client,
         gui_id="test_gui_id",
         device_filter="FakePositioner",
-        default_device="samx",
+        default="samx",
         arg_name="test_arg_name",
     )
     qtbot.addWidget(widget)
@@ -137,7 +137,7 @@ def test_device_input_line_edit_init(device_input_line_edit):
     assert isinstance(device_input_line_edit, DeviceLineEdit)
     assert device_input_line_edit.config.widget_class == "DeviceLineEdit"
     assert device_input_line_edit.config.device_filter is None
-    assert device_input_line_edit.config.default_device is None
+    assert device_input_line_edit.config.default is None
     assert device_input_line_edit.devices == [
         "samx",
         "samy",
@@ -157,14 +157,14 @@ def test_device_input_line_edit_init(device_input_line_edit):
 def test_device_input_line_edit_init_with_config(device_input_line_edit_with_config):
     assert device_input_line_edit_with_config.config.gui_id == "test_gui_id"
     assert device_input_line_edit_with_config.config.device_filter == "FakePositioner"
-    assert device_input_line_edit_with_config.config.default_device == "samx"
+    assert device_input_line_edit_with_config.config.default == "samx"
     assert device_input_line_edit_with_config.config.arg_name == "test_arg_name"
 
 
 def test_device_input_line_edit_init_with_kwargs(device_input_line_edit_with_kwargs):
     assert device_input_line_edit_with_kwargs.config.gui_id == "test_gui_id"
     assert device_input_line_edit_with_kwargs.config.device_filter == "FakePositioner"
-    assert device_input_line_edit_with_kwargs.config.default_device == "samx"
+    assert device_input_line_edit_with_kwargs.config.default == "samx"
     assert device_input_line_edit_with_kwargs.config.arg_name == "test_arg_name"