bec-widgets 0.53.3__py3-none-any.whl → 0.55.0__py3-none-any.whl

bec_widgets/widgets/motor_control/movement_relative/movement_relative.py

@@ -0,0 +1,227 @@
+import os
+
+from qtpy import uic
+from qtpy.QtCore import Qt
+from qtpy.QtCore import Signal as pyqtSignal
+from qtpy.QtCore import Slot as pyqtSlot
+from qtpy.QtGui import QKeySequence
+from qtpy.QtWidgets import QDoubleSpinBox, QShortcut, QWidget
+
+from bec_widgets.widgets.motor_control.motor_control import MotorControlWidget
+
+
+class MotorControlRelative(MotorControlWidget):
+    """
+    Widget for controlling the motors to relative coordinates.
+
+    Signals:
+        precision_signal (pyqtSignal): Signal to emit the precision of the coordinates.
+    Slots:
+        change_motors (pyqtSlot(str,str)): Slot to change the active motors.
+        enable_motor_controls (pyqtSlot): Slot to enable/disable the motor controls.
+    """
+
+    precision_signal = pyqtSignal(int)
+
+    def _load_ui(self):
+        """Load the UI from the .ui file."""
+        # Loading UI
+        current_path = os.path.dirname(__file__)
+        uic.loadUi(os.path.join(current_path, "movement_relative.ui"), self)
+
+    def _init_ui(self):
+        """Initialize the UI."""
+        self._init_ui_motor_control()
+        self._init_keyboard_shortcuts()
+
+    @pyqtSlot(dict)
+    def on_config_update(self, config: dict) -> None:
+        """
+        Update config dict
+        Args:
+            config(dict): New config dict
+        """
+        self.config = config
+
+        # Get motor names
+        self.motor_x, self.motor_y = (
+            self.config["motor_control"]["motor_x"],
+            self.config["motor_control"]["motor_y"],
+        )
+
+        # Update step precision
+        self.precision = self.config["motor_control"]["precision"]
+        self.spinBox_precision.setValue(self.precision)
+
+        # Update step sizes
+        self.spinBox_step_x.setValue(self.config["motor_control"]["step_size_x"])
+        self.spinBox_step_y.setValue(self.config["motor_control"]["step_size_y"])
+
+        # Checkboxes for keyboard shortcuts and x/y step size link
+        self.checkBox_same_xy.setChecked(self.config["motor_control"]["step_x_y_same"])
+        self.checkBox_enableArrows.setChecked(self.config["motor_control"]["move_with_arrows"])
+
+        self._init_ui()
+
+    def _init_ui_motor_control(self) -> None:
+        """Initialize the motor control elements"""
+
+        # Connect checkbox and spinBoxes
+        self.checkBox_same_xy.stateChanged.connect(self._sync_step_sizes)
+        self.spinBox_step_x.valueChanged.connect(self._update_step_size_x)
+        self.spinBox_step_y.valueChanged.connect(self._update_step_size_y)
+
+        self.toolButton_right.clicked.connect(
+            lambda: self.move_motor_relative(self.motor_x, "x", 1)
+        )
+        self.toolButton_left.clicked.connect(
+            lambda: self.move_motor_relative(self.motor_x, "x", -1)
+        )
+        self.toolButton_up.clicked.connect(lambda: self.move_motor_relative(self.motor_y, "y", 1))
+        self.toolButton_down.clicked.connect(
+            lambda: self.move_motor_relative(self.motor_y, "y", -1)
+        )
+
+        # Switch between key shortcuts active
+        self.checkBox_enableArrows.stateChanged.connect(self._update_arrow_key_shortcuts)
+        self._update_arrow_key_shortcuts()
+
+        # Enable/Disable GUI
+        self.motor_thread.lock_gui.connect(self.enable_motor_controls)
+
+        # Precision update
+        self.spinBox_precision.valueChanged.connect(lambda x: self._update_precision(x))
+
+        # Error messages
+        self.motor_thread.motor_error.connect(
+            lambda error: MotorControlErrors.display_error_message(error)
+        )
+
+        # Stop Button
+        self.pushButton_stop.clicked.connect(self.motor_thread.stop_movement)
+
+    def _init_keyboard_shortcuts(self) -> None:
+        """Initialize the keyboard shortcuts"""
+
+        # Increase/decrease step size for X motor
+        increase_x_shortcut = QShortcut(QKeySequence("Ctrl+A"), self)
+        decrease_x_shortcut = QShortcut(QKeySequence("Ctrl+Z"), self)
+        increase_x_shortcut.activated.connect(
+            lambda: self._change_step_size(self.spinBox_step_x, 2)
+        )
+        decrease_x_shortcut.activated.connect(
+            lambda: self._change_step_size(self.spinBox_step_x, 0.5)
+        )
+        self.spinBox_step_x.setToolTip("Increase step size: Ctrl+A\nDecrease step size: Ctrl+Z")
+
+        # Increase/decrease step size for Y motor
+        increase_y_shortcut = QShortcut(QKeySequence("Alt+A"), self)
+        decrease_y_shortcut = QShortcut(QKeySequence("Alt+Z"), self)
+        increase_y_shortcut.activated.connect(
+            lambda: self._change_step_size(self.spinBox_step_y, 2)
+        )
+        decrease_y_shortcut.activated.connect(
+            lambda: self._change_step_size(self.spinBox_step_y, 0.5)
+        )
+        self.spinBox_step_y.setToolTip("Increase step size: Alt+A\nDecrease step size: Alt+Z")
+
+        # Stop Button
+        self.pushButton_stop.setShortcut("Ctrl+X")
+        self.pushButton_stop.setToolTip("Ctrl+X")
+
+    def _update_arrow_key_shortcuts(self) -> None:
+        """Update the arrow key shortcuts based on the checkbox state."""
+        if self.checkBox_enableArrows.isChecked():
+            # Set the arrow key shortcuts for motor movement
+            self.toolButton_right.setShortcut(Qt.Key_Right)
+            self.toolButton_left.setShortcut(Qt.Key_Left)
+            self.toolButton_up.setShortcut(Qt.Key_Up)
+            self.toolButton_down.setShortcut(Qt.Key_Down)
+        else:
+            # Clear the shortcuts
+            self.toolButton_right.setShortcut("")
+            self.toolButton_left.setShortcut("")
+            self.toolButton_up.setShortcut("")
+            self.toolButton_down.setShortcut("")
+
+    def _update_precision(self, precision: int) -> None:
+        """
+        Update the precision of the coordinates.
+        Args:
+            precision(int): Precision of the coordinates.
+        """
+        self.spinBox_step_x.setDecimals(precision)
+        self.spinBox_step_y.setDecimals(precision)
+        self.precision_signal.emit(precision)
+
+    def _change_step_size(self, spinBox: QDoubleSpinBox, factor: float) -> None:
+        """
+        Change the step size of the spinbox.
+        Args:
+            spinBox(QDoubleSpinBox): Spinbox to change the step size.
+            factor(float): Factor to change the step size.
+        """
+        old_step = spinBox.value()
+        new_step = old_step * factor
+        spinBox.setValue(new_step)
+
+    def _sync_step_sizes(self):
+        """Sync step sizes based on checkbox state."""
+        if self.checkBox_same_xy.isChecked():
+            value = self.spinBox_step_x.value()
+            self.spinBox_step_y.setValue(value)
+
+    def _update_step_size_x(self):
+        """Update step size for x if checkbox is checked."""
+        if self.checkBox_same_xy.isChecked():
+            value = self.spinBox_step_x.value()
+            self.spinBox_step_y.setValue(value)
+
+    def _update_step_size_y(self):
+        """Update step size for y if checkbox is checked."""
+        if self.checkBox_same_xy.isChecked():
+            value = self.spinBox_step_y.value()
+            self.spinBox_step_x.setValue(value)
+
+    @pyqtSlot(str, str)
+    def change_motors(self, motor_x: str, motor_y: str):
+        """
+        Change the active motors and update config.
+        Can be connected to the selected_motors_signal from MotorControlSelection.
+        Args:
+            motor_x(str): New motor X to be controlled.
+            motor_y(str): New motor Y to be controlled.
+        """
+        self.motor_x = motor_x
+        self.motor_y = motor_y
+        self.config["motor_control"]["motor_x"] = motor_x
+        self.config["motor_control"]["motor_y"] = motor_y
+
+    @pyqtSlot(bool)
+    def enable_motor_controls(self, disable: bool) -> None:
+        """
+        Enable or disable the motor controls.
+        Args:
+            disable(bool): True to disable, False to enable.
+        """
+
+        # Disable or enable all controls within the motorControl_absolute group box
+        for widget in self.motorControl.findChildren(QWidget):
+            widget.setEnabled(disable)
+
+        # Enable the pushButton_stop if the motor is moving
+        self.pushButton_stop.setEnabled(True)
+
+    def move_motor_relative(self, motor, axis: str, direction: int) -> None:
+        """
+        Move the motor relative to the current position.
+        Args:
+            motor: Motor to move.
+            axis(str): Axis to move.
+            direction(int): Direction to move. 1 for positive, -1 for negative.
+        """
+        if axis == "x":
+            step = direction * self.spinBox_step_x.value()
+        elif axis == "y":
+            step = direction * self.spinBox_step_y.value()
+        self.motor_thread.move_relative(motor, step)

bec_widgets/widgets/motor_control/selection/selection.py

@@ -0,0 +1,110 @@
+# pylint: disable = no-name-in-module,missing-module-docstring
+import os
+
+from qtpy import uic
+from qtpy.QtCore import Signal as pyqtSignal
+from qtpy.QtCore import Slot as pyqtSlot
+from qtpy.QtWidgets import QComboBox
+
+from bec_widgets.widgets.motor_control.motor_control import MotorControlWidget
+
+
+class MotorControlSelection(MotorControlWidget):
+    """
+    Widget for selecting the motors to control.
+
+    Signals:
+        selected_motors_signal (pyqtSignal(str,str)): Signal to emit the selected motors.
+    Slots:
+        get_available_motors (pyqtSlot): Slot to populate the available motors in the combo boxes and set the index based on the configuration.
+        enable_motor_controls (pyqtSlot(bool)): Slot to enable/disable the motor controls GUI.
+        on_config_update (pyqtSlot(dict)): Slot to update the config dict.
+    """
+
+    selected_motors_signal = pyqtSignal(str, str)
+
+    def _load_ui(self):
+        """Load the UI from the .ui file."""
+        current_path = os.path.dirname(__file__)
+        uic.loadUi(os.path.join(current_path, "selection.ui"), self)
+
+    def _init_ui(self):
+        """Initialize the UI."""
+        # Lock GUI while motors are moving
+        self.motor_thread.lock_gui.connect(self.enable_motor_controls)
+
+        self.pushButton_connecMotors.clicked.connect(self.select_motor)
+        self.get_available_motors()
+
+        # Connect change signals to change color
+        self.comboBox_motor_x.currentIndexChanged.connect(
+            lambda: self.set_combobox_style(self.comboBox_motor_x, "#ffa700")
+        )
+        self.comboBox_motor_y.currentIndexChanged.connect(
+            lambda: self.set_combobox_style(self.comboBox_motor_y, "#ffa700")
+        )
+
+    @pyqtSlot(dict)
+    def on_config_update(self, config: dict) -> None:
+        """
+        Update config dict
+        Args:
+            config(dict): New config dict
+        """
+        self.config = config
+
+        # Get motor names
+        self.motor_x, self.motor_y = (
+            self.config["motor_control"]["motor_x"],
+            self.config["motor_control"]["motor_y"],
+        )
+
+        self._init_ui()
+
+    @pyqtSlot(bool)
+    def enable_motor_controls(self, enable: bool) -> None:
+        """
+        Enable or disable the motor controls.
+        Args:
+            enable(bool): True to enable, False to disable.
+        """
+        self.motorSelection.setEnabled(enable)
+
+    @pyqtSlot()
+    def get_available_motors(self) -> None:
+        """
+        Slot to populate the available motors in the combo boxes and set the index based on the configuration.
+        """
+        # Get all available motors
+        self.motor_list = self.motor_thread.get_all_motors_names()
+
+        # Populate the combo boxes
+        self.comboBox_motor_x.addItems(self.motor_list)
+        self.comboBox_motor_y.addItems(self.motor_list)
+
+        # Set the index based on the config if provided
+        if self.config:
+            index_x = self.comboBox_motor_x.findText(self.motor_x)
+            index_y = self.comboBox_motor_y.findText(self.motor_y)
+            self.comboBox_motor_x.setCurrentIndex(index_x if index_x != -1 else 0)
+            self.comboBox_motor_y.setCurrentIndex(index_y if index_y != -1 else 0)
+
+    def set_combobox_style(self, combobox, color: str) -> None:
+        """
+        Set the combobox style to a specific color.
+        Args:
+            combobox(QComboBox): Combobox to change the color.
+            color(str): Color to set the combobox to.
+        """
+        combobox.setStyleSheet(f"QComboBox {{ background-color: {color}; }}")
+
+    def select_motor(self):
+        """Emit the selected motors"""
+        motor_x = self.comboBox_motor_x.currentText()
+        motor_y = self.comboBox_motor_y.currentText()
+
+        # Reset the combobox color to normal after selection
+        self.set_combobox_style(self.comboBox_motor_x, "")
+        self.set_combobox_style(self.comboBox_motor_y, "")
+
+        self.selected_motors_signal.emit(motor_x, motor_y)

bec_widgets/widgets/spiral_progress_bar/__init__.py

@@ -0,0 +1 @@
+from .spiral_progress_bar import SpiralProgressBar

bec_widgets/widgets/spiral_progress_bar/ring.py

@@ -0,0 +1,184 @@
+from __future__ import annotations
+
+from typing import Literal, Optional
+
+from bec_lib.endpoints import EndpointInfo
+from pydantic import BaseModel, Field, field_validator
+from pydantic_core import PydanticCustomError
+from qtpy import QtGui
+
+from bec_widgets.utils import BECConnector, ConnectionConfig
+
+
+class RingConnections(BaseModel):
+    slot: Literal["on_scan_progress", "on_device_readback"] = None
+    endpoint: EndpointInfo | str = None
+
+    @field_validator("endpoint")
+    def validate_endpoint(cls, v, values):
+        slot = values.data["slot"]
+        endpoint = v.endpoint if isinstance(v, EndpointInfo) else v
+        if slot == "on_scan_progress":
+            if endpoint != "scans/scan_progress":
+                raise PydanticCustomError(
+                    "unsupported endpoint",
+                    "For slot 'on_scan_progress', endpoint must be MessageEndpoint.scan_progress or 'scans/scan_progress'.",
+                    {"wrong_value": v},
+                )
+        elif slot == "on_device_readback":
+            if not endpoint.startswith("internal/devices/readback/"):
+                raise PydanticCustomError(
+                    "unsupported endpoint",
+                    "For slot 'on_device_readback', endpoint must be MessageEndpoint.device_readback(device) or 'internal/devices/readback/{device}'.",
+                    {"wrong_value": v},
+                )
+        return v
+
+
+class RingConfig(ConnectionConfig):
+    direction: int | None = Field(
+        -1, description="Direction of the progress bars. -1 for clockwise, 1 for counter-clockwise."
+    )
+    color: str | tuple | None = Field(
+        (0, 159, 227, 255),
+        description="Color for the progress bars. Can be tuple (R, G, B, A) or string HEX Code.",
+    )
+    background_color: str | tuple | None = Field(
+        (200, 200, 200, 50),
+        description="Background color for the progress bars. Can be tuple (R, G, B, A) or string HEX Code.",
+    )
+    index: int | None = Field(0, description="Index of the progress bar. 0 is outer ring.")
+    line_width: int | None = Field(5, description="Line widths for the progress bars.")
+    start_position: int | None = Field(
+        90,
+        description="Start position for the progress bars in degrees. Default is 90 degrees - corespons to "
+        "the top of the ring.",
+    )
+    min_value: int | None = Field(0, description="Minimum value for the progress bars.")
+    max_value: int | None = Field(100, description="Maximum value for the progress bars.")
+    precision: int | None = Field(3, description="Precision for the progress bars.")
+    update_behaviour: Literal["manual", "auto"] | None = Field(
+        "auto", description="Update behaviour for the progress bars."
+    )
+    connections: RingConnections | None = Field(
+        default_factory=RingConnections, description="Connections for the progress bars."
+    )
+
+
+class Ring(BECConnector):
+    USER_ACCESS = [
+        "get_all_rpc",
+        "rpc_id",
+        "config_dict",
+        "set_value",
+        "set_color",
+        "set_background",
+        "set_line_width",
+        "set_min_max_values",
+        "set_start_angle",
+        "set_connections",
+        "reset_connection",
+    ]
+
+    def __init__(
+        self,
+        parent=None,
+        parent_progress_widget=None,
+        config: RingConfig | dict | None = None,
+        client=None,
+        gui_id: Optional[str] = None,
+    ):
+        if config is None:
+            config = RingConfig(widget_class=self.__class__.__name__)
+            self.config = config
+        else:
+            if isinstance(config, dict):
+                config = RingConfig(**config)
+            self.config = config
+        super().__init__(client=client, config=config, gui_id=gui_id)
+
+        self.parent_progress_widget = parent_progress_widget
+        self.color = None
+        self.background_color = None
+        self.start_position = None
+        self.config = config
+        self.value = 0
+        self.RID = None
+        self._init_config_params()
+
+    def _init_config_params(self):
+        self.color = self.convert_color(self.config.color)
+        self.background_color = self.convert_color(self.config.background_color)
+        self.set_start_angle(self.config.start_position)
+        if self.config.connections:
+            self.set_connections(self.config.connections.slot, self.config.connections.endpoint)
+
+    def set_value(self, value: int | float):
+        self.value = round(
+            max(self.config.min_value, min(self.config.max_value, value)), self.config.precision
+        )
+
+    def set_color(self, color: str | tuple):
+        self.config.color = color
+        self.color = self.convert_color(color)
+
+    def set_background(self, color: str | tuple):
+        self.config.background_color = color
+        self.color = self.convert_color(color)
+
+    def set_line_width(self, width: int):
+        self.config.line_width = width
+
+    def set_min_max_values(self, min_value: int, max_value: int):
+        self.config.min_value = min_value
+        self.config.max_value = max_value
+
+    def set_start_angle(self, start_angle: int):
+        self.config.start_position = start_angle
+        self.start_position = start_angle * 16
+
+    @staticmethod
+    def convert_color(color):
+        converted_color = None
+        if isinstance(color, str):
+            converted_color = QtGui.QColor(color)
+        elif isinstance(color, tuple):
+            converted_color = QtGui.QColor(*color)
+        return converted_color
+
+    def set_connections(self, slot: str, endpoint: str | EndpointInfo):
+        if self.config.connections.endpoint == endpoint and self.config.connections.slot == slot:
+            return
+        else:
+            self.bec_dispatcher.disconnect_slot(
+                self.config.connections.slot, self.config.connections.endpoint
+            )
+            self.config.connections = RingConnections(slot=slot, endpoint=endpoint)
+            self.bec_dispatcher.connect_slot(getattr(self, slot), endpoint)
+
+    def reset_connection(self):
+        self.bec_dispatcher.disconnect_slot(
+            self.config.connections.slot, self.config.connections.endpoint
+        )
+        self.config.connections = RingConnections()
+
+    def on_scan_progress(self, msg, meta):
+        current_RID = meta.get("RID", None)
+        if current_RID != self.RID:
+            self.set_min_max_values(0, msg.get("max_value", 100))
+        self.set_value(msg.get("value", 0))
+        self.parent_progress_widget.update()
+
+    def on_device_readback(self, msg, meta):
+        if isinstance(self.config.connections.endpoint, EndpointInfo):
+            endpoint = self.config.connections.endpoint.endpoint
+        else:
+            endpoint = self.config.connections.endpoint
+        device = endpoint.split("/")[-1]
+        value = msg.get("signals").get(device).get("value")
+        self.set_value(value)
+        self.parent_progress_widget.update()
+
+    def cleanup(self):
+        self.reset_connection()
+        super().cleanup()