bec-widgets 1.16.5__tar.gz → 1.17.0__tar.gz

{bec_widgets-1.16.5 → bec_widgets-1.17.0}/CHANGELOG.md

@@ -1,6 +1,35 @@
 # CHANGELOG
 
 
+## v1.17.0 (2025-01-23)
+
+### Bug Fixes
+
+- Focus policy and tab order for positioner_box_2d
+  ([`6df5710`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6df57103bb57c97bedda570b07a31a3cc6e57d5d))
+
+### Documentation
+
+- Add documentation for 2D positioner box
+  ([`9a8cc31`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9a8cc31f6c1fa5595f73c2a60372ef10d4c8eabb))
+
+### Features
+
+- **widget**: Add 2d positioner box widget
+  ([`d2ffddb`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/d2ffddb6d8d2473d8718f5aa650559902067ff12))
+
+### Refactoring
+
+- Move positioner_box and line into submodule
+  ([`2419521`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2419521f5f05d8ff8ce975219629f77efb7fe6be))
+
+PositionerBox and PositionerControlLine are now exported from from
+  bec_widgets.widgets.control.device_control.positioner_box, removing one level of hierarchy
+
+- Move positioner_box logic to base class
+  ([`3770db5`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3770db51be68a5f3fa65e0a67a4ed3efd1c7d6fe))
+
+
 ## v1.16.5 (2025-01-22)
 
 ### Bug Fixes

{bec_widgets-1.16.5 → bec_widgets-1.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bec_widgets
-Version: 1.16.5
+Version: 1.17.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-1.16.5 → bec_widgets-1.17.0}/bec_widgets/cli/client.py

@@ -34,6 +34,7 @@ class Widgets(str, enum.Enum):
     Minesweeper = "Minesweeper"
     PositionIndicator = "PositionIndicator"
     PositionerBox = "PositionerBox"
+    PositionerBox2D = "PositionerBox2D"
     PositionerControlLine = "PositionerControlLine"
     ResetButton = "ResetButton"
     ResumeButton = "ResumeButton"
@@ -3235,6 +3236,51 @@ class PositionerBox(RPCBase):
         """
 
 
+class PositionerBox2D(RPCBase):
+    @rpc_call
+    def set_positioner_hor(self, positioner: "str | Positioner"):
+        """
+        Set the device
+
+        Args:
+            positioner (Positioner | str) : Positioner to set, accepts str or the device
+        """
+
+    @rpc_call
+    def set_positioner_ver(self, positioner: "str | Positioner"):
+        """
+        Set the device
+
+        Args:
+            positioner (Positioner | str) : Positioner to set, accepts str or the device
+        """
+
+
+class PositionerBoxBase(RPCBase):
+    @property
+    @rpc_call
+    def _config_dict(self) -> "dict":
+        """
+        Get the configuration of the widget.
+
+        Returns:
+            dict: The configuration of the widget.
+        """
+
+    @rpc_call
+    def _get_all_rpc(self) -> "dict":
+        """
+        Get all registered RPC objects.
+        """
+
+    @property
+    @rpc_call
+    def _rpc_id(self) -> "str":
+        """
+        Get the RPC ID of the widget.
+        """
+
+
 class PositionerControlLine(RPCBase):
     @rpc_call
     def set_positioner(self, positioner: "str | Positioner"):

{bec_widgets-1.16.5 → bec_widgets-1.17.0}/bec_widgets/widgets/containers/dock/dock_area.py

@@ -20,7 +20,7 @@ from bec_widgets.qt_utils.toolbar import (
 from bec_widgets.utils import ConnectionConfig, WidgetContainerUtils
 from bec_widgets.utils.bec_widget import BECWidget
 from bec_widgets.widgets.containers.dock.dock import BECDock, DockConfig
-from bec_widgets.widgets.control.device_control.positioner_box.positioner_box import PositionerBox
+from bec_widgets.widgets.control.device_control.positioner_box import PositionerBox
 from bec_widgets.widgets.control.scan_control.scan_control import ScanControl
 from bec_widgets.widgets.editors.vscode.vscode import VSCodeEditor
 from bec_widgets.widgets.plots.image.image_widget import BECImageWidget

bec_widgets-1.17.0/bec_widgets/widgets/control/device_control/positioner_box/__init__.py

@@ -0,0 +1,11 @@
+from bec_widgets.widgets.control.device_control.positioner_box.positioner_box.positioner_box import (
+    PositionerBox,
+)
+from bec_widgets.widgets.control.device_control.positioner_box.positioner_box_2d.positioner_box_2d import (
+    PositionerBox2D,
+)
+from bec_widgets.widgets.control.device_control.positioner_box.positioner_control_line.positioner_control_line import (
+    PositionerControlLine,
+)
+
+__ALL__ = ["PositionerBox", "PositionerControlLine", "PositionerBox2D"]

bec_widgets-1.17.0/bec_widgets/widgets/control/device_control/positioner_box/_base/__init__.py

@@ -0,0 +1,3 @@
+from .positioner_box_base import PositionerBoxBase
+
+__ALL__ = ["PositionerBoxBase"]

bec_widgets-1.17.0/bec_widgets/widgets/control/device_control/positioner_box/_base/positioner_box_base.py

@@ -0,0 +1,243 @@
+import uuid
+from abc import abstractmethod
+from ast import Tuple
+from typing import Callable, TypedDict
+
+from bec_lib.device import Positioner
+from bec_lib.endpoints import MessageEndpoints
+from bec_lib.logger import bec_logger
+from bec_lib.messages import ScanQueueMessage
+from qtpy.QtWidgets import (
+    QDialog,
+    QDoubleSpinBox,
+    QGroupBox,
+    QLabel,
+    QLineEdit,
+    QPushButton,
+    QVBoxLayout,
+)
+
+from bec_widgets.qt_utils.compact_popup import CompactPopupWidget
+from bec_widgets.utils.bec_widget import BECWidget
+from bec_widgets.widgets.control.device_control.position_indicator.position_indicator import (
+    PositionIndicator,
+)
+from bec_widgets.widgets.control.device_input.base_classes.device_input_base import BECDeviceFilter
+from bec_widgets.widgets.control.device_input.device_line_edit.device_line_edit import (
+    DeviceLineEdit,
+)
+from bec_widgets.widgets.utility.spinner.spinner import SpinnerWidget
+
+logger = bec_logger.logger
+
+
+class DeviceUpdateUIComponents(TypedDict):
+    spinner: SpinnerWidget
+    setpoint: QLineEdit
+    readback: QLabel
+    position_indicator: PositionIndicator
+    step_size: QDoubleSpinBox
+    device_box: QGroupBox
+    stop: QPushButton
+    tweak_increase: QPushButton
+    tweak_decrease: QPushButton
+
+
+class PositionerBoxBase(BECWidget, CompactPopupWidget):
+    """Contains some core logic for positioner box widgets"""
+
+    current_path = ""
+    ICON_NAME = "switch_right"
+
+    def __init__(self, parent=None, **kwargs):
+        """Initialize the PositionerBox widget.
+
+        Args:
+            parent: The parent widget.
+            device (Positioner): The device to control.
+        """
+        super().__init__(**kwargs)
+        CompactPopupWidget.__init__(self, parent=parent, layout=QVBoxLayout)
+        self._dialog = None
+        self.get_bec_shortcuts()
+
+    def _check_device_is_valid(self, device: str):
+        """Check if the device is a positioner
+
+        Args:
+            device (str): The device name
+        """
+        if device not in self.dev:
+            logger.info(f"Device {device} not found in the device list")
+            return False
+        if not isinstance(self.dev[device], Positioner):
+            logger.info(f"Device {device} is not a positioner")
+            return False
+        return True
+
+    @abstractmethod
+    def _device_ui_components(self, device: str) -> DeviceUpdateUIComponents: ...
+
+    def _init_device(
+        self,
+        device: str,
+        position_emit: Callable[[float], None],
+        limit_update: Callable[[tuple[float, float]], None],
+    ):
+        """Init the device view and readback"""
+        if self._check_device_is_valid(device):
+            data = self.dev[device].read()
+            self._on_device_readback(
+                device,
+                self._device_ui_components(device),
+                {"signals": data},
+                {},
+                position_emit,
+                limit_update,
+            )
+
+    def _stop_device(self, device: str):
+        """Stop call"""
+        request_id = str(uuid.uuid4())
+        params = {"device": device, "rpc_id": request_id, "func": "stop", "args": [], "kwargs": {}}
+        msg = ScanQueueMessage(
+            scan_type="device_rpc",
+            parameter=params,
+            queue="emergency",
+            metadata={"RID": request_id, "response": False},
+        )
+        self.client.connector.send(MessageEndpoints.scan_queue_request(), msg)
+
+    # pylint: disable=unused-argument
+    def _on_device_readback(
+        self,
+        device: str,
+        ui_components: DeviceUpdateUIComponents,
+        msg_content: dict,
+        metadata: dict,
+        position_emit: Callable[[float], None],
+        limit_update: Callable[[tuple[float, float]], None],
+    ):
+        signals = msg_content.get("signals", {})
+        # pylint: disable=protected-access
+        hinted_signals = self.dev[device]._hints
+        precision = self.dev[device].precision
+
+        spinner = ui_components["spinner"]
+        position_indicator = ui_components["position_indicator"]
+        readback = ui_components["readback"]
+        setpoint = ui_components["setpoint"]
+
+        readback_val = None
+        setpoint_val = None
+
+        if len(hinted_signals) == 1:
+            signal = hinted_signals[0]
+            readback_val = signals.get(signal, {}).get("value")
+
+        for setpoint_signal in ["setpoint", "user_setpoint"]:
+            setpoint_val = signals.get(f"{device}_{setpoint_signal}", {}).get("value")
+            if setpoint_val is not None:
+                break
+
+        for moving_signal in ["motor_done_move", "motor_is_moving"]:
+            is_moving = signals.get(f"{device}_{moving_signal}", {}).get("value")
+            if is_moving is not None:
+                break
+
+        if is_moving is not None:
+            spinner.setVisible(True)
+            if is_moving:
+                spinner.start()
+                spinner.setToolTip("Device is moving")
+                self.set_global_state("warning")
+            else:
+                spinner.stop()
+                spinner.setToolTip("Device is idle")
+                self.set_global_state("success")
+        else:
+            spinner.setVisible(False)
+
+        if readback_val is not None:
+            readback.setText(f"{readback_val:.{precision}f}")
+            position_emit(readback_val)
+
+        if setpoint_val is not None:
+            setpoint.setText(f"{setpoint_val:.{precision}f}")
+
+        limits = self.dev[device].limits
+        limit_update(limits)
+        if limits is not None and readback_val is not None and limits[0] != limits[1]:
+            pos = (readback_val - limits[0]) / (limits[1] - limits[0])
+            position_indicator.set_value(pos)
+
+    def _update_limits_ui(
+        self, limits: tuple[float, float], position_indicator, setpoint_validator
+    ):
+        if limits is not None and limits[0] != limits[1]:
+            position_indicator.setToolTip(f"Min: {limits[0]}, Max: {limits[1]}")
+            setpoint_validator.setRange(limits[0], limits[1])
+        else:
+            position_indicator.setToolTip("No limits set")
+            setpoint_validator.setRange(float("-inf"), float("inf"))
+
+    def _update_device_ui(self, device: str, ui: DeviceUpdateUIComponents):
+        ui["device_box"].setTitle(device)
+        ui["readback"].setToolTip(f"{device} readback")
+        ui["setpoint"].setToolTip(f"{device} setpoint")
+        ui["step_size"].setToolTip(f"Step size for {device}")
+        precision = self.dev[device].precision
+        if precision is not None:
+            ui["step_size"].setDecimals(precision)
+            ui["step_size"].setValue(10**-precision * 10)
+
+    def _swap_readback_signal_connection(self, slot, old_device, new_device):
+        self.bec_dispatcher.disconnect_slot(slot, MessageEndpoints.device_readback(old_device))
+        self.bec_dispatcher.connect_slot(slot, MessageEndpoints.device_readback(new_device))
+
+    def _toggle_enable_buttons(self, ui: DeviceUpdateUIComponents, enable: bool) -> None:
+        """Toogle enable/disable on available buttons
+
+        Args:
+            enable (bool): Enable buttons
+        """
+        ui["tweak_increase"].setEnabled(enable)
+        ui["tweak_decrease"].setEnabled(enable)
+        ui["stop"].setEnabled(enable)
+        ui["setpoint"].setEnabled(enable)
+        ui["step_size"].setEnabled(enable)
+
+    def _on_device_change(
+        self,
+        old_device: str,
+        new_device: str,
+        position_emit: Callable[[float], None],
+        limit_update: Callable[[tuple[float, float]], None],
+        on_device_readback: Callable,
+        ui: DeviceUpdateUIComponents,
+    ):
+        logger.info(f"Device changed from {old_device} to {new_device}")
+        self._toggle_enable_buttons(ui, True)
+        self._init_device(new_device, position_emit, limit_update)
+        self._swap_readback_signal_connection(on_device_readback, old_device, new_device)
+        self._update_device_ui(new_device, ui)
+
+    def _open_dialog_selection(self, set_positioner: Callable):
+        def _ods():
+            """Open dialog window for positioner selection"""
+            self._dialog = QDialog(self)
+            self._dialog.setWindowTitle("Positioner Selection")
+            layout = QVBoxLayout()
+            line_edit = DeviceLineEdit(
+                self, client=self.client, device_filter=[BECDeviceFilter.POSITIONER]
+            )
+            line_edit.textChanged.connect(set_positioner)
+            layout.addWidget(line_edit)
+            close_button = QPushButton("Close")
+            close_button.clicked.connect(self._dialog.accept)
+            layout.addWidget(close_button)
+            self._dialog.setLayout(layout)
+            self._dialog.exec()
+            self._dialog = None
+
+        return _ods

bec_widgets-1.17.0/bec_widgets/widgets/control/device_control/positioner_box/positioner_box/positioner_box.py

@@ -0,0 +1,242 @@
+""" Module for a PositionerBox widget to control a positioner device."""
+
+from __future__ import annotations
+
+import os
+
+from bec_lib.device import Positioner
+from bec_lib.logger import bec_logger
+from bec_qthemes import material_icon
+from qtpy.QtCore import Signal
+from qtpy.QtGui import QDoubleValidator
+from qtpy.QtWidgets import QDoubleSpinBox
+
+from bec_widgets.qt_utils.error_popups import SafeProperty, SafeSlot
+from bec_widgets.utils import UILoader
+from bec_widgets.utils.colors import get_accent_colors, set_theme
+from bec_widgets.widgets.control.device_control.positioner_box._base import PositionerBoxBase
+from bec_widgets.widgets.control.device_control.positioner_box._base.positioner_box_base import (
+    DeviceUpdateUIComponents,
+)
+
+logger = bec_logger.logger
+
+MODULE_PATH = os.path.dirname(os.path.dirname(os.path.dirname(__file__)))
+
+
+class PositionerBox(PositionerBoxBase):
+    """Simple Widget to control a positioner in box form"""
+
+    ui_file = "positioner_box.ui"
+    dimensions = (234, 224)
+
+    PLUGIN = True
+
+    USER_ACCESS = ["set_positioner"]
+    device_changed = Signal(str, str)
+    # Signal emitted to inform listeners about a position update
+    position_update = Signal(float)
+
+    def __init__(self, parent=None, device: Positioner | str | None = None, **kwargs):
+        """Initialize the PositionerBox widget.
+
+        Args:
+            parent: The parent widget.
+            device (Positioner): The device to control.
+        """
+        super().__init__(parent=parent, **kwargs)
+
+        self._device = ""
+        self._limits = None
+        if self.current_path == "":
+            self.current_path = os.path.dirname(__file__)
+
+        self.init_ui()
+        self.device = device
+        self._init_device(self.device, self.position_update.emit, self.update_limits)
+
+    def init_ui(self):
+        """Init the ui"""
+        self.device_changed.connect(self.on_device_change)
+
+        self.ui = UILoader(self).loader(os.path.join(self.current_path, self.ui_file))
+
+        self.addWidget(self.ui)
+        self.layout.setSpacing(0)
+        self.layout.setContentsMargins(0, 0, 0, 0)
+
+        # fix the size of the device box
+        db = self.ui.device_box
+        db.setFixedHeight(self.dimensions[0])
+        db.setFixedWidth(self.dimensions[1])
+
+        self.ui.step_size.setStepType(QDoubleSpinBox.AdaptiveDecimalStepType)
+        self.ui.stop.clicked.connect(self.on_stop)
+        self.ui.stop.setToolTip("Stop")
+        self.ui.stop.setStyleSheet(
+            f"QPushButton {{background-color: {get_accent_colors().emergency.name()}; color: white;}}"
+        )
+        self.ui.tweak_right.clicked.connect(self.on_tweak_right)
+        self.ui.tweak_right.setToolTip("Tweak right")
+        self.ui.tweak_left.clicked.connect(self.on_tweak_left)
+        self.ui.tweak_left.setToolTip("Tweak left")
+        self.ui.setpoint.returnPressed.connect(self.on_setpoint_change)
+
+        self.setpoint_validator = QDoubleValidator()
+        self.ui.setpoint.setValidator(self.setpoint_validator)
+        self.ui.spinner_widget.start()
+        self.ui.tool_button.clicked.connect(self._open_dialog_selection(self.set_positioner))
+        icon = material_icon(icon_name="edit_note", size=(16, 16), convert_to_pixmap=False)
+        self.ui.tool_button.setIcon(icon)
+
+    def force_update_readback(self):
+        self._init_device(self.device, self.position_update.emit, self.update_limits)
+
+    @SafeProperty(str)
+    def device(self):
+        """Property to set the device"""
+        return self._device
+
+    @device.setter
+    def device(self, value: str):
+        """Setter, checks if device is a string"""
+        if not value or not isinstance(value, str):
+            return
+        if not self._check_device_is_valid(value):
+            return
+        old_device = self._device
+        self._device = value
+        if not self.label:
+            self.label = value
+        self.device_changed.emit(old_device, value)
+
+    @SafeProperty(bool)
+    def hide_device_selection(self):
+        """Hide the device selection"""
+        return not self.ui.tool_button.isVisible()
+
+    @hide_device_selection.setter
+    def hide_device_selection(self, value: bool):
+        """Set the device selection visibility"""
+        self.ui.tool_button.setVisible(not value)
+
+    @SafeSlot(bool)
+    def show_device_selection(self, value: bool):
+        """Show the device selection
+
+        Args:
+            value (bool): Show the device selection
+        """
+        self.hide_device_selection = not value
+
+    @SafeSlot(str)
+    def set_positioner(self, positioner: str | Positioner):
+        """Set the device
+
+        Args:
+            positioner (Positioner | str) : Positioner to set, accepts str or the device
+        """
+        if isinstance(positioner, Positioner):
+            positioner = positioner.name
+        self.device = positioner
+
+    @SafeSlot(str, str)
+    def on_device_change(self, old_device: str, new_device: str):
+        """Upon changing the device, a check will be performed if the device is a Positioner.
+
+        Args:
+            old_device (str): The old device name.
+            new_device (str): The new device name.
+        """
+        if not self._check_device_is_valid(new_device):
+            return
+        self._on_device_change(
+            old_device,
+            new_device,
+            self.position_update.emit,
+            self.update_limits,
+            self.on_device_readback,
+            self._device_ui_components(new_device),
+        )
+
+    def _device_ui_components(self, device: str) -> DeviceUpdateUIComponents:
+        return {
+            "spinner": self.ui.spinner_widget,
+            "position_indicator": self.ui.position_indicator,
+            "readback": self.ui.readback,
+            "setpoint": self.ui.setpoint,
+            "step_size": self.ui.step_size,
+            "device_box": self.ui.device_box,
+            "stop": self.ui.stop,
+            "tweak_increase": self.ui.tweak_right,
+            "tweak_decrease": self.ui.tweak_left,
+        }
+
+    @SafeSlot(dict, dict)
+    def on_device_readback(self, msg_content: dict, metadata: dict):
+        """Callback for device readback.
+
+        Args:
+            msg_content (dict): The message content.
+            metadata (dict): The message metadata.
+        """
+        self._on_device_readback(
+            self.device,
+            self._device_ui_components(self.device),
+            msg_content,
+            metadata,
+            self.position_update.emit,
+            self.update_limits,
+        )
+
+    def update_limits(self, limits: tuple):
+        """Update limits
+
+        Args:
+            limits (tuple): Limits of the positioner
+        """
+        if limits == self._limits:
+            return
+        self._limits = limits
+        self._update_limits_ui(limits, self.ui.position_indicator, self.setpoint_validator)
+
+    @SafeSlot()
+    def on_stop(self):
+        self._stop_device(self.device)
+
+    @property
+    def step_size(self):
+        """Step size for tweak"""
+        return self.ui.step_size.value()
+
+    @SafeSlot()
+    def on_tweak_right(self):
+        """Tweak motor right"""
+        self.dev[self.device].move(self.step_size, relative=True)
+
+    @SafeSlot()
+    def on_tweak_left(self):
+        """Tweak motor left"""
+        self.dev[self.device].move(-self.step_size, relative=True)
+
+    @SafeSlot()
+    def on_setpoint_change(self):
+        """Change the setpoint for the motor"""
+        self.ui.setpoint.clearFocus()
+        setpoint = self.ui.setpoint.text()
+        self.dev[self.device].move(float(setpoint), relative=False)
+        self.ui.tweak_left.setToolTip(f"Tweak left by {self.step_size}")
+        self.ui.tweak_right.setToolTip(f"Tweak right by {self.step_size}")
+
+
+if __name__ == "__main__":  # pragma: no cover
+    import sys
+
+    from qtpy.QtWidgets import QApplication  # pylint: disable=ungrouped-imports
+
+    app = QApplication(sys.argv)
+    set_theme("dark")
+    widget = PositionerBox(device="bpm4i")
+
+    widget.show()
+    sys.exit(app.exec_())

{bec_widgets-1.16.5/bec_widgets/widgets/control/device_control → bec_widgets-1.17.0/bec_widgets/widgets/control/device_control/positioner_box}/positioner_box/positioner_box_plugin.py

@@ -6,7 +6,7 @@ import os
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
 
 from bec_widgets.utils.bec_designer import designer_material_icon
-from bec_widgets.widgets.control.device_control.positioner_box.positioner_box import PositionerBox
+from bec_widgets.widgets.control.device_control.positioner_box import PositionerBox
 
 DOM_XML = """
 <ui language='c++'>

{bec_widgets-1.16.5/bec_widgets/widgets/control/device_control → bec_widgets-1.17.0/bec_widgets/widgets/control/device_control/positioner_box}/positioner_box/register_positioner_box.py

@@ -6,7 +6,7 @@ def main():  # pragma: no cover
         return
     from PySide6.QtDesigner import QPyDesignerCustomWidgetCollection
 
-    from bec_widgets.widgets.control.device_control.positioner_box.positioner_box_plugin import (
+    from bec_widgets.widgets.control.device_control.positioner_box.positioner_box.positioner_box_plugin import (
         PositionerBoxPlugin,
     )
 

bec_widgets-1.17.0/bec_widgets/widgets/control/device_control/positioner_box/positioner_box_2d/positioner_box2_d.pyproject

@@ -0,0 +1 @@
+{'files': ['positioner_box_2d.py']}