bec-widgets 1.0.1__py3-none-any.whl → 1.1.0__py3-none-any.whl

CHANGELOG.md

@@ -1,6 +1,32 @@
 # CHANGELOG
 
 
+## v1.1.0 (2024-10-25)
+
+### Features
+
+* feat: add filter i/o utility class ([`0350833`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/0350833f36e0a7cadce4173f9b1d1fbfdf985375))
+
+### Refactoring
+
+* refactor: do not flush selection upon receiving config update; allow widgetIO to receive kwargs to be able to use get_value to receive string instead of int for QComboBox ([`91959e8`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/91959e82de8586934af3ebb5aaa0923930effc51))
+
+* refactor: allow to set selection in DeviceInput; automatic update of selection on device config update; cleanup ([`5eb15b7`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/5eb15b785f12e30eb8ccbc56d4ad9e759a4cf5eb))
+
+* refactor: cleanup, added device_signal for signal inputs ([`6fb2055`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6fb20552ff57978f4aeb79fd7f062f8d6b5581e7))
+
+### Testing
+
+* test(scan_control): tests added for grid_scan to ensure scan_args signal validity ([`acb7902`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/acb79020d4be546efc001ff47b6f5cdba2ee9375))
+
+
+## v1.0.2 (2024-10-22)
+
+### Bug Fixes
+
+* fix(scan_control): scan args signal fixed to emit list instead of hardcoded structure ([`4f5448c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4f5448cf51a204e077af162c7f0aed1f1a60e57a))
+
+
 ## v1.0.1 (2024-10-22)
 
 ### Bug Fixes
@@ -144,30 +170,6 @@ is emitted multiple times. ([`f084e25`](https://gitlab.psi.ch/bec/bec_widgets/-/
 
 ## v0.113.0 (2024-10-02)
 
-### Bug Fixes
-
-* fix: add is_log checks and functionality to plot_indicator_items ([`0f9953e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/0f9953e8fdcf3f9b5a09f994c69edb6b34756df9))
-
-### Features
-
-* feat: add first draft for alignment_1d GUI ([`63c24f9`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/63c24f97a355edaa928b6e222909252b276bcada))
-
-* feat: add move to position button to lmfit dialog ([`281cb27`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/281cb27d8b5433e27a7ba0ca0a19e4b45b9c544f))
-
-### Refactoring
-
-* refactor: various minor improvements for the alignment gui ([`f554f3c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f554f3c1672c4fe32968a5991dc98802556a6f3b))
-
-* refactor: allow hiding of arg/kwarg boxes ([`efe90eb`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/efe90eb163e2123a5b4d0bb59f66025a569336ad))
-
-* refactor: add proxy to waveform to limit the dap_request frequency ([`5c74037`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/5c740371d86d9b1b341bc3c4d8bdf62027aa089b))
-
-* refactor: update dap_model also if x and y axis are selected ([`28ee385`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/28ee3856be2c47a63182b16454ece37a0ec04811))
-
 ### Testing
 
 * test: add tests for scan_status_callback ([`dc0c825`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/dc0c825fd594c093a24543ff803d6c6564010e92))
-
-### Unknown
-
-* feat : Add bec_signal_proxy to handle signals with option to unblock them manually. ([`1dcfeb6`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1dcfeb6cfce3c69f0c5401731d4d3f9a1981b22e))

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 1.0.1
+Version: 1.1.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/applications/alignment/alignment_1d/alignment_1d.ui

@@ -215,42 +215,18 @@
           <layout class="QVBoxLayout" name="verticalLayout_3">
            <item>
             <widget class="ScanControl" name="scan_control">
-             <property name="sizePolicy">
-              <sizepolicy hsizetype="Preferred" vsizetype="Fixed">
-               <horstretch>1</horstretch>
-               <verstretch>0</verstretch>
-              </sizepolicy>
-             </property>
-             <property name="minimumSize">
-              <size>
-               <width>0</width>
-               <height>0</height>
-              </size>
-             </property>
              <property name="current_scan" stdset="0">
               <string>line_scan</string>
              </property>
              <property name="hide_arg_box" stdset="0">
               <bool>false</bool>
              </property>
-             <property name="hide_kwarg_boxes" stdset="0">
-              <bool>false</bool>
-             </property>
-             <property name="hide_scan_control_buttons" stdset="0">
-              <bool>false</bool>
-             </property>
              <property name="hide_scan_selection_combobox" stdset="0">
               <bool>true</bool>
              </property>
              <property name="hide_add_remove_buttons" stdset="0">
               <bool>true</bool>
              </property>
-             <property name="hide_args_group" stdset="0">
-              <bool>false</bool>
-             </property>
-             <property name="hide_kwargs_group" stdset="0">
-              <bool>false</bool>
-             </property>
             </widget>
            </item>
            <item>
@@ -440,54 +416,54 @@
  </widget>
  <customwidgets>
   <customwidget>
-   <class>ToggleSwitch</class>
+   <class>DapComboBox</class>
    <extends>QWidget</extends>
-   <header>toggle_switch</header>
+   <header>dap_combo_box</header>
   </customwidget>
   <customwidget>
-   <class>BECWaveformWidget</class>
+   <class>StopButton</class>
    <extends>QWidget</extends>
-   <header>bec_waveform_widget</header>
+   <header>stop_button</header>
   </customwidget>
   <customwidget>
-   <class>BECStatusBox</class>
+   <class>WebsiteWidget</class>
    <extends>QWidget</extends>
-   <header>bec_status_box</header>
+   <header>website_widget</header>
   </customwidget>
   <customwidget>
-   <class>WebsiteWidget</class>
+   <class>BECQueue</class>
    <extends>QWidget</extends>
-   <header>website_widget</header>
+   <header>bec_queue</header>
   </customwidget>
   <customwidget>
-   <class>StopButton</class>
+   <class>ScanControl</class>
    <extends>QWidget</extends>
-   <header>stop_button</header>
+   <header>scan_control</header>
   </customwidget>
   <customwidget>
-   <class>LMFitDialog</class>
+   <class>ToggleSwitch</class>
    <extends>QWidget</extends>
-   <header>lm_fit_dialog</header>
+   <header>toggle_switch</header>
   </customwidget>
   <customwidget>
-   <class>PositionerGroup</class>
+   <class>BECProgressBar</class>
    <extends>QWidget</extends>
-   <header>positioner_group</header>
+   <header>bec_progress_bar</header>
   </customwidget>
   <customwidget>
-   <class>ScanControl</class>
+   <class>DarkModeButton</class>
    <extends>QWidget</extends>
-   <header>scan_control</header>
+   <header>dark_mode_button</header>
   </customwidget>
   <customwidget>
-   <class>BECQueue</class>
+   <class>PositionerGroup</class>
    <extends>QWidget</extends>
-   <header>bec_queue</header>
+   <header>positioner_group</header>
   </customwidget>
   <customwidget>
-   <class>BECProgressBar</class>
+   <class>BECWaveformWidget</class>
    <extends>QWidget</extends>
-   <header>bec_progress_bar</header>
+   <header>bec_waveform_widget</header>
   </customwidget>
   <customwidget>
    <class>DeviceComboBox</class>
@@ -495,14 +471,14 @@
    <header>device_combobox</header>
   </customwidget>
   <customwidget>
-   <class>DarkModeButton</class>
+   <class>LMFitDialog</class>
    <extends>QWidget</extends>
-   <header>dark_mode_button</header>
+   <header>lm_fit_dialog</header>
   </customwidget>
   <customwidget>
-   <class>DapComboBox</class>
+   <class>BECStatusBox</class>
    <extends>QWidget</extends>
-   <header>dap_combo_box</header>
+   <header>bec_status_box</header>
   </customwidget>
  </customwidgets>
  <resources/>
@@ -514,12 +490,12 @@
    <slot>toogle_roi_select(bool)</slot>
    <hints>
     <hint type="sourcelabel">
-     <x>529</x>
-     <y>728</y>
+     <x>1042</x>
+     <y>212</y>
     </hint>
     <hint type="destinationlabel">
-     <x>1099</x>
-     <y>96</y>
+     <x>1416</x>
+     <y>322</y>
     </hint>
    </hints>
   </connection>
@@ -546,12 +522,12 @@
    <slot>plot(QString)</slot>
    <hints>
     <hint type="sourcelabel">
-     <x>297</x>
-     <y>170</y>
+     <x>577</x>
+     <y>215</y>
     </hint>
     <hint type="destinationlabel">
-     <x>1099</x>
-     <y>201</y>
+     <x>1416</x>
+     <y>427</y>
     </hint>
    </hints>
   </connection>
@@ -562,12 +538,12 @@
    <slot>select_y_axis(QString)</slot>
    <hints>
     <hint type="sourcelabel">
-     <x>297</x>
-     <y>170</y>
+     <x>577</x>
+     <y>215</y>
     </hint>
     <hint type="destinationlabel">
-     <x>467</x>
-     <y>170</y>
+     <x>909</x>
+     <y>215</y>
     </hint>
    </hints>
   </connection>
@@ -578,60 +554,60 @@
    <slot>add_dap(QString,QString,QString)</slot>
    <hints>
     <hint type="sourcelabel">
-     <x>467</x>
-     <y>170</y>
+     <x>909</x>
+     <y>215</y>
     </hint>
     <hint type="destinationlabel">
-     <x>1099</x>
-     <y>221</y>
+     <x>1416</x>
+     <y>447</y>
     </hint>
    </hints>
   </connection>
   <connection>
    <sender>scan_control</sender>
-   <signal>scan_axis(QString,double,double)</signal>
-   <receiver>bec_waveform_widget</receiver>
-   <slot>set_x(QString)</slot>
+   <signal>device_selected(QString)</signal>
+   <receiver>positioner_group</receiver>
+   <slot>set_positioners(QString)</slot>
    <hints>
     <hint type="sourcelabel">
-     <x>244</x>
-     <y>348</y>
+     <x>230</x>
+     <y>306</y>
     </hint>
     <hint type="destinationlabel">
-     <x>1140</x>
-     <y>491</y>
+     <x>187</x>
+     <y>926</y>
     </hint>
    </hints>
   </connection>
   <connection>
    <sender>scan_control</sender>
-   <signal>scan_axis(QString,double,double)</signal>
-   <receiver>dap_combo_box</receiver>
-   <slot>select_x_axis(QString)</slot>
+   <signal>device_selected(QString)</signal>
+   <receiver>bec_waveform_widget</receiver>
+   <slot>set_x(QString)</slot>
    <hints>
     <hint type="sourcelabel">
-     <x>244</x>
-     <y>322</y>
+     <x>187</x>
+     <y>356</y>
     </hint>
     <hint type="destinationlabel">
-     <x>909</x>
-     <y>189</y>
+     <x>972</x>
+     <y>509</y>
     </hint>
    </hints>
   </connection>
   <connection>
    <sender>scan_control</sender>
    <signal>device_selected(QString)</signal>
-   <receiver>positioner_group</receiver>
-   <slot>set_positioners(QString)</slot>
+   <receiver>dap_combo_box</receiver>
+   <slot>select_x_axis(QString)</slot>
    <hints>
     <hint type="sourcelabel">
-     <x>227</x>
-     <y>337</y>
+     <x>187</x>
+     <y>356</y>
     </hint>
     <hint type="destinationlabel">
-     <x>227</x>
-     <y>676</y>
+     <x>794</x>
+     <y>202</y>
     </hint>
    </hints>
   </connection>

bec_widgets/cli/client.py

@@ -38,6 +38,8 @@ class Widgets(str, enum.Enum):
     ResumeButton = "ResumeButton"
     RingProgressBar = "RingProgressBar"
     ScanControl = "ScanControl"
+    SignalComboBox = "SignalComboBox"
+    SignalLineEdit = "SignalLineEdit"
     StopButton = "StopButton"
     TextBox = "TextBox"
     VSCodeEditor = "VSCodeEditor"
@@ -2591,6 +2593,24 @@ class DeviceLineEdit(RPCBase):
         """
 
 
+class DeviceSignalInputBase(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.
+        """
+
+
 class LMFitDialog(RPCBase):
     @property
     @rpc_call
@@ -3003,6 +3023,42 @@ class ScanControl(RPCBase):
         """
 
 
+class SignalComboBox(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.
+        """
+
+
+class SignalLineEdit(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.
+        """
+
+
 class StopButton(RPCBase):
     @property
     @rpc_call

bec_widgets/tests/utils.py

@@ -0,0 +1,226 @@
+from unittest.mock import MagicMock
+
+from bec_lib.device import Device as BECDevice
+from bec_lib.device import Positioner as BECPositioner
+from bec_lib.device import ReadoutPriority
+from bec_lib.devicemanager import DeviceContainer
+
+
+class FakeDevice(BECDevice):
+    """Fake minimal positioner class for testing."""
+
+    def __init__(self, name, enabled=True, readout_priority=ReadoutPriority.MONITORED):
+        super().__init__(name=name)
+        self._enabled = enabled
+        self.signals = {self.name: {"value": 1.0}}
+        self.description = {self.name: {"source": self.name, "dtype": "number", "shape": []}}
+        self._readout_priority = readout_priority
+        self._config = {
+            "readoutPriority": "baseline",
+            "deviceClass": "ophyd.Device",
+            "deviceConfig": {},
+            "deviceTags": ["user device"],
+            "enabled": enabled,
+            "readOnly": False,
+            "name": self.name,
+        }
+
+    @property
+    def readout_priority(self):
+        return self._readout_priority
+
+    @readout_priority.setter
+    def readout_priority(self, value):
+        self._readout_priority = value
+
+    @property
+    def limits(self) -> tuple[float, float]:
+        return self._limits
+
+    @limits.setter
+    def limits(self, value: tuple[float, float]):
+        self._limits = value
+
+    def __contains__(self, item):
+        return item == self.name
+
+    @property
+    def _hints(self):
+        return [self.name]
+
+    def set_value(self, fake_value: float = 1.0) -> None:
+        """
+        Setup fake value for device readout
+        Args:
+            fake_value(float): Desired fake value
+        """
+        self.signals[self.name]["value"] = fake_value
+
+    def describe(self) -> dict:
+        """
+        Get the description of the device
+        Returns:
+            dict: Description of the device
+        """
+        return self.description
+
+
+class FakePositioner(BECPositioner):
+
+    def __init__(
+        self,
+        name,
+        enabled=True,
+        limits=None,
+        read_value=1.0,
+        readout_priority=ReadoutPriority.MONITORED,
+    ):
+        super().__init__(name=name)
+        # self.limits = limits if limits is not None else [0.0, 0.0]
+        self.read_value = read_value
+        self.setpoint_value = read_value
+        self.motor_is_moving_value = 0
+        self._enabled = enabled
+        self._limits = limits
+        self._readout_priority = readout_priority
+        self.signals = {self.name: {"value": 1.0}}
+        self.description = {self.name: {"source": self.name, "dtype": "number", "shape": []}}
+        self._config = {
+            "readoutPriority": "baseline",
+            "deviceClass": "ophyd_devices.SimPositioner",
+            "deviceConfig": {"delay": 1, "tolerance": 0.01, "update_frequency": 400},
+            "deviceTags": ["user motors"],
+            "enabled": enabled,
+            "readOnly": False,
+            "name": self.name,
+        }
+        self._info = {
+            "signals": {
+                "readback": {"kind_str": "5"},  # hinted
+                "setpoint": {"kind_str": "1"},  # normal
+                "velocity": {"kind_str": "2"},  # config
+            }
+        }
+        self.signals = {
+            self.name: {"value": self.read_value},
+            f"{self.name}_setpoint": {"value": self.setpoint_value},
+            f"{self.name}_motor_is_moving": {"value": self.motor_is_moving_value},
+        }
+
+    @property
+    def readout_priority(self):
+        return self._readout_priority
+
+    @readout_priority.setter
+    def readout_priority(self, value):
+        self._readout_priority = value
+
+    @property
+    def enabled(self) -> bool:
+        return self._enabled
+
+    @enabled.setter
+    def enabled(self, value: bool):
+        self._enabled = value
+
+    @property
+    def limits(self) -> tuple[float, float]:
+        return self._limits
+
+    @limits.setter
+    def limits(self, value: tuple[float, float]):
+        self._limits = value
+
+    def __contains__(self, item):
+        return item == self.name
+
+    @property
+    def _hints(self):
+        return [self.name]
+
+    def set_value(self, fake_value: float = 1.0) -> None:
+        """
+        Setup fake value for device readout
+        Args:
+            fake_value(float): Desired fake value
+        """
+        self.read_value = fake_value
+
+    def describe(self) -> dict:
+        """
+        Get the description of the device
+        Returns:
+            dict: Description of the device
+        """
+        return self.description
+
+    @property
+    def precision(self):
+        return 3
+
+    def set_read_value(self, value):
+        self.read_value = value
+
+    def read(self):
+        return self.signals
+
+    def set_limits(self, limits):
+        self.limits = limits
+
+    def move(self, value, relative=False):
+        """Simulates moving the device to a new position."""
+        if relative:
+            self.read_value += value
+        else:
+            self.read_value = value
+        # Respect the limits
+        self.read_value = max(min(self.read_value, self.limits[1]), self.limits[0])
+
+    @property
+    def readback(self):
+        return MagicMock(get=MagicMock(return_value=self.read_value))
+
+
+class Positioner(FakePositioner):
+    """just placeholder for testing embedded isinstance check in DeviceCombobox"""
+
+    def __init__(self, name="test", limits=None, read_value=1.0):
+        super().__init__(name, limits, read_value)
+
+
+class Device(FakeDevice):
+    """just placeholder for testing embedded isinstance check in DeviceCombobox"""
+
+    def __init__(self, name, enabled=True):
+        super().__init__(name, enabled)
+
+
+class DMMock:
+    def __init__(self):
+        self.devices = DeviceContainer()
+        self.enabled_devices = [device for device in self.devices if device.enabled]
+
+    def add_devives(self, devices: list):
+        for device in devices:
+            self.devices[device.name] = device
+
+
+DEVICES = [
+    FakePositioner("samx", limits=[-10, 10], read_value=2.0),
+    FakePositioner("samy", limits=[-5, 5], read_value=3.0),
+    FakePositioner("samz", limits=[-8, 8], read_value=4.0),
+    FakePositioner("aptrx", limits=None, read_value=4.0),
+    FakePositioner("aptry", limits=None, read_value=5.0),
+    FakeDevice("gauss_bpm"),
+    FakeDevice("gauss_adc1"),
+    FakeDevice("gauss_adc2"),
+    FakeDevice("gauss_adc3"),
+    FakeDevice("bpm4i"),
+    FakeDevice("bpm3a"),
+    FakeDevice("bpm3i"),
+    FakeDevice("eiger", readout_priority=ReadoutPriority.ASYNC),
+    FakeDevice("waveform1d"),
+    FakeDevice("async_device", readout_priority=ReadoutPriority.ASYNC),
+    Positioner("test", limits=[-10, 10], read_value=2.0),
+    Device("test_device"),
+]