feat(waveform_widget): designer plugin added

bec_widgets/cli/client.py

@@ -1842,15 +1842,71 @@ class BECWaveformWidget(RPCBase):
         """
 
     @rpc_call
-    def plot(*args, **kwargs):
+    def plot(
+        self,
+        x: "list | np.ndarray | None" = None,
+        y: "list | np.ndarray | None" = None,
+        x_name: "str | None" = None,
+        y_name: "str | None" = None,
+        z_name: "str | None" = None,
+        x_entry: "str | None" = None,
+        y_entry: "str | None" = None,
+        z_entry: "str | None" = None,
+        color: "str | None" = None,
+        color_map_z: "str | None" = "plasma",
+        label: "str | None" = None,
+        validate: "bool" = True,
+        dap: "str | None" = None,
+        **kwargs,
+    ) -> "BECCurve":
         """
-        None
+        Plot a curve to the plot widget.
+        Args:
+            x(list | np.ndarray): Custom x data to plot.
+            y(list | np.ndarray): Custom y data to plot.
+            x_name(str): The name of the device for the x-axis.
+            y_name(str): The name of the device for the y-axis.
+            z_name(str): The name of the device for the z-axis.
+            x_entry(str): The name of the entry for the x-axis.
+            y_entry(str): The name of the entry for the y-axis.
+            z_entry(str): The name of the entry for the z-axis.
+            color(str): The color of the curve.
+            color_map_z(str): The color map to use for the z-axis.
+            label(str): The label of the curve.
+            validate(bool): If True, validate the device names and entries.
+            dap(str): The dap model to use for the curve. If not specified, none will be added.
+
+        Returns:
+            BECCurve: The curve object.
         """
 
     @rpc_call
-    def add_dap(*args, **kwargs):
+    def add_dap(
+        self,
+        x_name: "str",
+        y_name: "str",
+        x_entry: "str | None" = None,
+        y_entry: "str | None" = None,
+        color: "str | None" = None,
+        dap: "str" = "GaussianModel",
+        validate_bec: "bool" = True,
+        **kwargs,
+    ) -> "BECCurve":
         """
-        None
+        Add LMFIT dap model curve to the plot widget.
+
+        Args:
+            x_name(str): Name of the x signal.
+            x_entry(str): Entry of the x signal.
+            y_name(str): Name of the y signal.
+            y_entry(str): Entry of the y signal.
+            color(str, optional): Color of the curve. Defaults to None.
+            dap(str): The dap model to use for the curve.
+            validate_bec(bool, optional): If True, validate the signal with BEC. Defaults to True.
+            **kwargs: Additional keyword arguments for the curve configuration.
+
+        Returns:
+            BECCurve: The curve object.
         """
 
     @rpc_call
@@ -1913,6 +1969,20 @@ class BECWaveformWidget(RPCBase):
             - legend_label_size: int
         """
 
+    @rpc_call
+    def set_x(self, x_name: "str", x_entry: "str | None" = None):
+        """
+        Change the x axis of the plot widget.
+
+        Args:
+            x_name(str): Name of the x signal.
+                - "best_effort": Use the best effort signal.
+                - "timestamp": Use the timestamp signal.
+                - "index": Use the index signal.
+                - Custom signal name of device from BEC.
+            x_entry(str): Entry of the x signal.
+        """
+
     @rpc_call
     def set_title(self, title: "str"):
         """

bec_widgets/widgets/motor_map/bec_motor_map_widget_plugin.py

@@ -26,7 +26,7 @@ class BECMotorMapWidgetPlugin(QDesignerCustomWidgetInterface):  # pragma: no cov
         return DOM_XML
 
     def group(self):
-        return "BEC Visualization Widgets"
+        return "BEC Plots"
 
     def icon(self):
         current_path = os.path.dirname(__file__)

bec_widgets/widgets/waveform/bec_waveform_widget.pyproject

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

bec_widgets/widgets/waveform/bec_waveform_widget_plugin.py

@@ -0,0 +1,59 @@
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+import os
+
+from qtpy.QtDesigner import QDesignerCustomWidgetInterface
+from qtpy.QtGui import QIcon
+
+import bec_widgets
+from bec_widgets.widgets.waveform.waveform_widget import BECWaveformWidget
+
+DOM_XML = """
+<ui language='c++'>
+    <widget class='BECWaveformWidget' name='bec_waveform_widget'>
+    </widget>
+</ui>
+"""
+
+MODULE_PATH = os.path.dirname(bec_widgets.__file__)
+
+
+class BECWaveformWidgetPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self._form_editor = None
+
+    def createWidget(self, parent):
+        t = BECWaveformWidget(parent)
+        return t
+
+    def domXml(self):
+        return DOM_XML
+
+    def group(self):
+        return "BEC Plots"
+
+    def icon(self):
+        icon_path = os.path.join(MODULE_PATH, "assets", "designer_icons", "BECWaveformWidget.png")
+        return QIcon(icon_path)
+
+    def includeFile(self):
+        return "bec_waveform_widget"
+
+    def initialize(self, form_editor):
+        self._form_editor = form_editor
+
+    def isContainer(self):
+        return False
+
+    def isInitialized(self):
+        return self._form_editor is not None
+
+    def name(self):
+        return "BECWaveformWidget"
+
+    def toolTip(self):
+        return "BECWaveformWidget"
+
+    def whatsThis(self):
+        return self.toolTip()

bec_widgets/widgets/waveform/register_bec_waveform_widget.py

@@ -0,0 +1,15 @@
+def main():  # pragma: no cover
+    from qtpy import PYSIDE6
+
+    if not PYSIDE6:
+        print("PYSIDE6 is not available in the environment. Cannot patch designer.")
+        return
+    from PySide6.QtDesigner import QPyDesignerCustomWidgetCollection
+
+    from bec_widgets.widgets.waveform.bec_waveform_widget_plugin import BECWaveformWidgetPlugin
+
+    QPyDesignerCustomWidgetCollection.addCustomWidget(BECWaveformWidgetPlugin())
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

bec_widgets/widgets/waveform/waveform_widget.py

@@ -38,6 +38,7 @@ class BECWaveformWidget(BECConnector, QWidget):
         "scan_history",
         "get_all_data",
         "set",
+        "set_x",
         "set_title",
         "set_x_label",
         "set_y_label",
@@ -99,15 +100,10 @@ class BECWaveformWidget(BECConnector, QWidget):
         self.waveform = self.fig.plot()
         self.waveform.apply_config(config)
 
-        self.config = config  # TODO not sure if this should be here
+        self.config = config
 
         self._hook_actions()
 
-        # TEst actions
-        self.plot(x_name="samx", y_name="bpm4i", dap="GaussianModel")
-        self.plot(x_name="samx", y_name="bpm3a", dap="GaussianModel")
-        self.plot(x_name="samx", y_name="bpm6i")
-
     def _hook_actions(self):
         self.toolbar.widgets["save"].action.triggered.connect(self.export)
         self.toolbar.widgets["matplotlib"].action.triggered.connect(self.export_to_matplotlib)