bec-widgets 0.57.1__tar.gz → 0.57.3__tar.gz

{bec_widgets-0.57.1 → bec_widgets-0.57.3}/CHANGELOG.md

@@ -2,6 +2,48 @@
 
 
 
+## v0.57.3 (2024-06-06)
+
+### Documentation
+
+* docs(bar): docs updated ([`4be0d14`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4be0d14b7445c2322c2aef86257db168a841265c))
+
+* docs: fixed syntax of add_widget ([`a951ebf`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a951ebf1be6c086d094aa8abef5e0dfd1b3b8558))
+
+* docs: added auto update; closes #206 ([`32da803`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/32da803df9f7259842c43e85ba9a0ce29a266d06))
+
+* docs: cleanup ([`07d60cf`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/07d60cf7355d2edadb3c5ef8b86607d74b360455))
+
+### Fix
+
+* fix(ring): automatic updates are disabled uf user specify updates manually with .set_update; 'scan_progres' do not reset number of rings ([`e883dba`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e883dbad814dbcc0a19c341041c6d836e58a5918))
+
+* fix(ring): enable_auto_updates(True) do not reset properties of already setup bars ([`a2abad3`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a2abad344f4c0039516eb60a825afb6822c5b19a))
+
+* fix(ring): set_min_max accepts floats ([`d44b1cf`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/d44b1cf8b107cf02deedd9154b77d01c7f9ed05d))
+
+* fix(ring): set_update changed to Literals, no need to specify endpoint manually ([`c5b6499`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c5b6499e41eb1495bf260436ca3e1b036182c360))
+
+
+## v0.57.2 (2024-06-06)
+
+### Fix
+
+* fix(test/e2e): autoupdate e2e rewritten ([`e1af5ca`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e1af5ca60f0616835f9f41d84412f29dc298c644))
+
+* fix(test/e2e): spiral_progress_bar e2e tests rewritten to use config_dict ([`7fb31fc`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7fb31fc4d762ff4ca839971b3092a084186f81b8))
+
+* fix(test/e2e): dockarea and dock e2e tests changed to check asserts against config_dict ([`5c6ba65`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/5c6ba65469863ea1e6fc5abdc742650e20eba9b9))
+
+* fix: rpc_server_dock fixture now spawns the server process ([`cd9fc46`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/cd9fc46ff8a947242c8c28adcd73d7de60b11c44))
+
+* fix: accept scalars or numpy arrays of 1 element ([`2a88e17`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2a88e17b23436c55d25b7d3449e4af3a7689661c))
+
+### Refactor
+
+* refactor: move _get_output and _start_plot_process at the module level ([`69f4371`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/69f4371007c66aee6b7521a6803054025adf8c92))
+
+
 ## v0.57.1 (2024-06-06)
 
 ### Documentation
@@ -117,59 +159,3 @@
 ### Fix
 
 * fix: removed apparently unnecessary sleep while waiting for an rpc response ([`7d64cac`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7d64cac6610b39d3553ff650354f78ead8ee6b55))
-
-
-## v0.53.2 (2024-05-15)
-
-### Ci
-
-* ci: added echo to highlight the current branch ([`0490e80`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/0490e80c48563e4fb486bce903b3ce1f08863e83))
-
-### Fix
-
-* fix: check device class without importing to speed up initial import time ([`9f8fbdd`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9f8fbdd5fc13cf2be10eacb41e10cf742864cd92))
-
-* fix: speed up initial import times using lazy import (from bec_lib) ([`d1e6cd3`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/d1e6cd388c6c9f345f52d6096d8a75a1fa7e6934))
-
-* fix: adapt to bec_lib changes (no more submodules in `__init__.py`) ([`5d09a13`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/5d09a13d8820a8bdb900733c97593b723a2fce1d))
-
-
-## v0.53.1 (2024-05-09)
-
-### Ci
-
-* ci: fixed rtd pages url ([`8ff3610`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/8ff36105d1e637c429915b4bfc2852d54a3c6f19))
-
-### Fix
-
-* fix: docs config ([`0f6a5e5`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/0f6a5e5fa9530969c98a9266c9ca7b89a378ff70))
-
-
-## v0.53.0 (2024-05-09)
-
-### Ci
-
-* ci: use formatter config of toml file ([`5cc816d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/5cc816d0af73e20c648e044a027c589704ab1625))
-
-### Documentation
-
-* docs: update install instructions ([`57ee735`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/57ee735e5c2436d45a285507cdc939daa20e8e8f))
-
-### Feature
-
-* feat: moved to pyproject.toml; closes #162 ([`c86ce30`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c86ce302a964d71ee631f0817609ab5aa0e3ab0f))
-
-### Fix
-
-* fix: fixed semver job and upgraded to v9 ([`32e1a9d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/32e1a9d8472eb1c25d30697d407a8ffecd04e75d))
-
-### Refactor
-
-* refactor: applied formatter ([`4117fd7`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4117fd7b5b2090ff4fb7ad9e0d92cc87cd13ed5f))
-
-
-## v0.52.1 (2024-05-08)
-
-### Fix
-
-* fix(docstrings): docstrings formating fixed for sphinx to properly format readdocs ([`7f2f7cd`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7f2f7cd07a14876617cd83cedde8c281fdc52c3a))

{bec_widgets-0.57.1 → bec_widgets-0.57.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.57.1
+Version: 0.57.3
 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
@@ -27,6 +27,7 @@ Requires-Dist: pytest; extra == 'dev'
 Requires-Dist: pytest-qt; extra == 'dev'
 Requires-Dist: pytest-random-order; extra == 'dev'
 Requires-Dist: pytest-timeout; extra == 'dev'
+Requires-Dist: pytest-xvfb; extra == 'dev'
 Provides-Extra: pyqt5
 Requires-Dist: pyqt5>=5.9; extra == 'pyqt5'
 Provides-Extra: pyqt6

{bec_widgets-0.57.1 → bec_widgets-0.57.3}/bec_widgets/cli/client.py

@@ -1651,6 +1651,16 @@ class BECDockArea(RPCBase, BECGuiClientMixin):
         Get all registered RPC objects.
         """
 
+    @property
+    @rpc_call
+    def temp_areas(self) -> "list":
+        """
+        Get the temporary areas in the dock area.
+
+        Returns:
+            list: The temporary areas in the dock area.
+        """
+
 
 class SpiralProgressBar(RPCBase):
     @rpc_call
@@ -1880,7 +1890,7 @@ class Ring(RPCBase):
         """
 
     @rpc_call
-    def set_min_max_values(self, min_value: "int", max_value: "int"):
+    def set_min_max_values(self, min_value: "int | float", max_value: "int | float"):
         """
         None
         """
@@ -1892,9 +1902,13 @@ class Ring(RPCBase):
         """
 
     @rpc_call
-    def set_connections(self, slot: "str", endpoint: "str | EndpointInfo"):
+    def set_update(self, mode: "Literal['manual', 'scan', 'device']", device: "str" = None):
         """
-        None
+        Set the update mode for the ring widget
+
+        Args:
+            mode(str): Update mode for the ring widget. Can be "manual", "scan" or "device"
+            device(str): Device name for the device readback mode, only used when mode is "device"
         """
 
     @rpc_call

{bec_widgets-0.57.1 → bec_widgets-0.57.3}/bec_widgets/cli/client_utils.py

@@ -61,10 +61,54 @@ def rpc_call(func):
     return wrapper
 
 
+def _get_output(process) -> None:
+    try:
+        os.set_blocking(process.stdout.fileno(), False)
+        os.set_blocking(process.stderr.fileno(), False)
+        while process.poll() is None:
+            readylist, _, _ = select.select([process.stdout, process.stderr], [], [], 1)
+            if process.stdout in readylist:
+                output = process.stdout.read(1024)
+                if output:
+                    print(output, end="")
+            if process.stderr in readylist:
+                error_output = process.stderr.read(1024)
+                if error_output:
+                    print(error_output, end="", file=sys.stderr)
+    except Exception as e:
+        print(f"Error reading process output: {str(e)}")
+
+
+def _start_plot_process(gui_id, gui_class, config) -> None:
+    """
+    Start the plot in a new process.
+    """
+    # pylint: disable=subprocess-run-check
+    monitor_module = importlib.import_module("bec_widgets.cli.server")
+    monitor_path = monitor_module.__file__
+
+    command = [
+        sys.executable,
+        "-u",
+        monitor_path,
+        "--id",
+        gui_id,
+        "--config",
+        config,
+        "--gui_class",
+        gui_class.__name__,
+    ]
+    process = subprocess.Popen(command, text=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+    process_output_processing_thread = threading.Thread(target=_get_output, args=(process,))
+    process_output_processing_thread.start()
+    return process, process_output_processing_thread
+
+
 class BECGuiClientMixin:
     def __init__(self, **kwargs) -> None:
         super().__init__(**kwargs)
         self._process = None
+        self._process_output_processing_thread = None
         self.auto_updates = self._get_update_script()
         self._target_endpoint = MessageEndpoints.scan_status()
         self._selected_device = None
@@ -118,7 +162,10 @@ class BECGuiClientMixin:
         Show the figure.
         """
         if self._process is None or self._process.poll() is not None:
-            self._start_plot_process()
+            self._start_update_script()
+            self._process, self._process_output_processing_thread = _start_plot_process(
+                self._gui_id, self.__class__, self._client._service_config.redis
+            )
         while not self.gui_is_alive():
             print("Waiting for GUI to start...")
             time.sleep(1)
@@ -138,34 +185,6 @@ class BECGuiClientMixin:
         self._process = None
         self._client.shutdown()
 
-    def _start_plot_process(self) -> None:
-        """
-        Start the plot in a new process.
-        """
-        self._start_update_script()
-        # pylint: disable=subprocess-run-check
-        config = self._client._service_config.redis
-        monitor_module = importlib.import_module("bec_widgets.cli.server")
-        monitor_path = monitor_module.__file__
-        gui_class = self.__class__.__name__
-
-        command = [
-            sys.executable,
-            "-u",
-            monitor_path,
-            "--id",
-            self._gui_id,
-            "--config",
-            config,
-            "--gui_class",
-            gui_class,
-        ]
-        self._process = subprocess.Popen(
-            command, text=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE
-        )
-        self._process_output_processing_thread = threading.Thread(target=self._get_output)
-        self._process_output_processing_thread.start()
-
     def print_log(self) -> None:
         """
         Print the log of the plot process.
@@ -176,26 +195,6 @@ class BECGuiClientMixin:
         # Flush list
         self.stderr_output.clear()
 
-    def _get_output(self) -> str:
-        try:
-            os.set_blocking(self._process.stdout.fileno(), False)
-            os.set_blocking(self._process.stderr.fileno(), False)
-            while self._process.poll() is None:
-                readylist, _, _ = select.select(
-                    [self._process.stdout, self._process.stderr], [], [], 1
-                )
-                if self._process.stdout in readylist:
-                    output = self._process.stdout.read(1024)
-                    if output:
-                        print(output, end="")
-                if self._process.stderr in readylist:
-                    error_output = self._process.stderr.read(1024)
-                    if error_output:
-                        print(error_output, end="", file=sys.stderr)
-                        self.stderr_output.append(error_output)
-        except Exception as e:
-            print(f"Error reading process output: {str(e)}")
-
 
 class RPCResponseTimeoutError(Exception):
     """Exception raised when an RPC response is not received within the expected time."""

{bec_widgets-0.57.1 → bec_widgets-0.57.3}/bec_widgets/widgets/dock/dock_area.py

@@ -33,6 +33,7 @@ class BECDockArea(BECConnector, DockArea):
         "detach_dock",
         "attach_all",
         "get_all_rpc",
+        "temp_areas",
     ]
 
     def __init__(
@@ -70,9 +71,22 @@ class BECDockArea(BECConnector, DockArea):
 
     @panels.setter
     def panels(self, value: dict):
-
         self.docks = WeakValueDictionary(value)
 
+    @property
+    def temp_areas(self) -> list:
+        """
+        Get the temporary areas in the dock area.
+
+        Returns:
+            list: The temporary areas in the dock area.
+        """
+        return list(map(str, self.tempAreas))
+
+    @temp_areas.setter
+    def temp_areas(self, value: list):
+        self.tempAreas = list(map(str, value))
+
     def restore_state(
         self, state: dict = None, missing: Literal["ignore", "error"] = "ignore", extra="bottom"
     ):
@@ -107,6 +121,7 @@ class BECDockArea(BECConnector, DockArea):
             name(str): The name of the dock to remove.
         """
         dock = self.docks.pop(name, None)
+        self.config.docks.pop(name, None)
         if dock:
             dock.close()
             if len(self.docks) <= 1:
@@ -190,7 +205,7 @@ class BECDockArea(BECConnector, DockArea):
             BECDock: The undocked dock.
         """
         dock = self.docks[dock_name]
-        self.floatDock(dock)
+        dock.detach()
         return dock
 
     def attach_all(self):

{bec_widgets-0.57.1 → bec_widgets-0.57.3}/bec_widgets/widgets/figure/plots/motor_map/motor_map.py

@@ -317,7 +317,7 @@ class BECMotorMap(BECPlotBase):
         Returns:
             float: Motor initial position.
         """
-        init_position = round(self.dev[name].read()[entry]["value"], precision)
+        init_position = round(float(self.dev[name].read()[entry]["value"]), precision)
         return init_position
 
     def _validate_signal_entries(
@@ -403,7 +403,7 @@ class BECMotorMap(BECPlotBase):
         # Update plot title
         precision = self.config.precision
         self.set_title(
-            f"Motor position: ({round(current_x,precision)}, {round(current_y,precision)})"
+            f"Motor position: ({round(float(current_x),precision)}, {round(float(current_y),precision)})"
         )
 
     @pyqtSlot(dict)

{bec_widgets-0.57.1 → bec_widgets-0.57.3}/bec_widgets/widgets/figure/plots/waveform/waveform.py

@@ -577,7 +577,6 @@ class BECWaveform(BECPlotBase):
         Returns:
             dict | pd.DataFrame: Data of all curves in the specified format.
         """
-
         data = {}
         try:
             import pandas as pd

{bec_widgets-0.57.1 → bec_widgets-0.57.3}/bec_widgets/widgets/spiral_progress_bar/ring.py

@@ -49,7 +49,7 @@ class RingConfig(ConnectionConfig):
         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.")
+    line_width: int | None = Field(10, 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 "
@@ -77,7 +77,7 @@ class Ring(BECConnector):
         "set_line_width",
         "set_min_max_values",
         "set_start_angle",
-        "set_connections",
+        "set_update",
         "reset_connection",
     ]
 
@@ -115,7 +115,8 @@ class Ring(BECConnector):
 
     def set_value(self, value: int | float):
         self.config.value = round(
-            max(self.config.min_value, min(self.config.max_value, value)), self.config.precision
+            float(max(self.config.min_value, min(self.config.max_value, value))),
+            self.config.precision,
         )
 
     def set_color(self, color: str | tuple):
@@ -129,7 +130,7 @@ class Ring(BECConnector):
     def set_line_width(self, width: int):
         self.config.line_width = width
 
-    def set_min_max_values(self, min_value: int, max_value: int):
+    def set_min_max_values(self, min_value: int | float, max_value: int | float):
         self.config.min_value = min_value
         self.config.max_value = max_value
 
@@ -146,6 +147,27 @@ class Ring(BECConnector):
             converted_color = QtGui.QColor(*color)
         return converted_color
 
+    def set_update(self, mode: Literal["manual", "scan", "device"], device: str = None):
+        """
+        Set the update mode for the ring widget
+
+        Args:
+            mode(str): Update mode for the ring widget. Can be "manual", "scan" or "device"
+            device(str): Device name for the device readback mode, only used when mode is "device"
+        """
+        if mode == "manual":
+            self.bec_dispatcher.disconnect_slot(
+                getattr(self, self.config.connections.slot), self.config.connections.endpoint
+            )
+            self.config.connections.slot = None
+            self.config.connections.endpoint = None
+        elif mode == "scan":
+            self.set_connections("on_scan_progress", "scans/scan_progress")
+        elif mode == "device":
+            self.set_connections("on_device_readback", f"internal/devices/readback/{device}")
+
+        self.parent_progress_widget.enable_auto_updates(False)
+
     def set_connections(self, slot: str, endpoint: str | EndpointInfo):
         if self.config.connections.endpoint == endpoint and self.config.connections.slot == slot:
             return

{bec_widgets-0.57.1 → bec_widgets-0.57.3}/bec_widgets/widgets/spiral_progress_bar/spiral_progress_bar.py

@@ -23,7 +23,7 @@ class SpiralProgressBarConfig(ConnectionConfig):
         10, description="Maximum number of progress bars to display."
     )
     num_bars: int | None = Field(1, description="Number of progress bars to display.")
-    gap: int | None = Field(10, description="Gap between progress bars.")
+    gap: int | None = Field(20, description="Gap between progress bars.")
     auto_updates: bool | None = Field(
         True, description="Enable or disable updates based on scan queue status."
     )
@@ -118,7 +118,7 @@ class SpiralProgressBar(BECConnector, QWidget):
 
         # For updating bar behaviour
         self._auto_updates = True
-        self._rings = []
+        self._rings = None
 
         if num_bars is not None:
             self.config.num_bars = max(
@@ -186,13 +186,22 @@ class SpiralProgressBar(BECConnector, QWidget):
             Ring: Ring object.
         """
         if self.config.num_bars < self.config.max_number_of_bars:
-            ring = Ring(parent_progress_widget=self, **kwargs)
-            ring.config.index = self.config.num_bars
+            ring_index = self.config.num_bars
+            ring_config = RingConfig(
+                widget_class="Ring",
+                index=ring_index,
+                start_positions=90 * 16,
+                directions=-1,
+                **kwargs,
+            )
+            ring = Ring(parent_progress_widget=self, config=ring_config)
             self.config.num_bars += 1
             self._rings.append(ring)
             self.config.rings.append(ring.config)
             if self.config.color_map:
                 self.set_colors_from_map(self.config.color_map)
+            base_line_width = self._rings[ring.config.index].config.line_width
+            self.set_line_widths(base_line_width, ring.config.index)
             self.update()
             return ring
 
@@ -211,6 +220,7 @@ class SpiralProgressBar(BECConnector, QWidget):
         self._reindex_rings()
         if self.config.color_map:
             self.set_colors_from_map(self.config.color_map)
+        del ring
         self.update()
 
     def _reindex_rings(self):
@@ -269,9 +279,30 @@ class SpiralProgressBar(BECConnector, QWidget):
         num_bars = max(
             self.config.min_number_of_bars, min(num_bars, self.config.max_number_of_bars)
         )
-        if num_bars != self.config.num_bars:
-            self.config.num_bars = num_bars
-            self.initialize_bars()
+        current_num_bars = self.config.num_bars
+
+        if num_bars > current_num_bars:
+            for i in range(current_num_bars, num_bars):
+                new_ring_config = RingConfig(
+                    widget_class="Ring", index=i, start_positions=90 * 16, directions=-1
+                )
+                self.config.rings.append(new_ring_config)
+                new_ring = Ring(parent_progress_widget=self, config=new_ring_config)
+                self._rings.append(new_ring)
+
+        elif num_bars < current_num_bars:
+            for i in range(current_num_bars - 1, num_bars - 1, -1):
+                self.remove_ring(i)
+
+        self.config.num_bars = num_bars
+
+        if self.config.color_map:
+            self.set_colors_from_map(self.config.color_map)
+
+        base_line_width = self._rings[0].config.line_width
+        self.set_line_widths(base_line_width)
+
+        self.update()
 
     def set_value(self, values: int | list, ring_index: int = None):
         """
@@ -443,8 +474,6 @@ class SpiralProgressBar(BECConnector, QWidget):
                 if report_instructions:
                     instruction_type = list(report_instructions[0].keys())[0]
                     if instruction_type == "scan_progress":
-                        if self.config.num_bars != 1:
-                            self.set_number_of_bars(1)
                         self._hook_scan_progress(ring_index=0)
                     elif instruction_type == "readback":
                         devices = report_instructions[0].get("readback").get("devices")

bec_widgets-0.57.3/docs/user/getting_started/auto_updates.md

@@ -0,0 +1,82 @@
+(user.auto_updates)=
+# Auto updates
+BEC Widgets provides a simple way to update the entire GUI configuration based on events. These events can be of different types, such as a new scan being started or completed, a button being pressed, a device reporting an error or the existence of a specific metadata key. This allows the users to streamline the experience of the GUI and to focus on the data and the analysis, rather than on the GUI itself.
+
+The default auto update only takes control over a single `BECFigure` widget, which is automatically added to the GUI instance. The update instance is accessible via the `bec.gui.auto_updates` object. The user can disable / enable the auto updates by setting the `enabled` attribute of the `bec.gui.auto_updates` object, e.g. 
+
+```python
+bec.gui.auto_updates.enabled = False
+```
+
+Without further customization, the auto update will automatically update the `BECFigure` widget based on the currently performed scan. The behaviour is determined by the `handler` method of the `AutoUpdate` class: 
+
+````{dropdown} Auto Updates Handler
+:icon: code-square
+:animate: fade-in-slide-down
+:open: 
+```{literalinclude} ../../../bec_widgets/cli/auto_updates.py
+:pyobject: AutoUpdates.handler
+```
+````
+
+As shown, the default handler switches between different scan names and updates the `BECFigure` widget accordingly. If the scan is a line scan, the `simple_line_scan` update method is executed. 
+
+````{dropdown} Auto Updates Simple Line Scan
+:icon: code-square
+:animate: fade-in-slide-down
+:open: 
+```{literalinclude} ../../../bec_widgets/cli/auto_updates.py
+:pyobject: AutoUpdates.simple_line_scan
+```
+````
+
+As it can be seen from the above snippet, the update method gets the default figure by calling the `get_default_figure` method. If the figure is not found, maybe because the user has deleted or closed it, no update is performed. If the figure is found, the scan info is used to extract the first reported device for the x axis and the first device of the monitored devices for the y axis. The y axis can also be set by the user using the `selected_device` attribute:
+
+```python
+bec.gui.auto_updates.selected_device = 'bpm4i'
+```
+
+
+````{dropdown} Auto Updates Code
+:icon: code-square
+:animate: fade-in-slide-down
+```{literalinclude} ../../../bec_widgets/cli/auto_updates.py
+```
+````
+
+## Custom Auto Updates
+The beamline can customize their default behaviour through customized auto update classes. This can be achieved by modifying the class located in the beamline plugin repository: `<beamline_plugin>/bec_widgets/auto_updates.py`. The class should inherit from the `AutoUpdates` class and overwrite the `handler` method. 
+
+```python
+from bec_widgets.cli.auto_updates import AutoUpdates, ScanInfo
+
+
+class PlotUpdate(AutoUpdates):
+    create_default_dock = True
+    enabled = True
+
+    # def simple_line_scan(self, info: ScanInfo) -> None:
+    #     """
+    #     Simple line scan.
+    #     """
+    #     fig = self.get_default_figure()
+    #     if not fig:
+    #         return
+    #     dev_x = info.scan_report_devices[0]
+    #     dev_y = self.get_selected_device(info.monitored_devices, self.gui.selected_device)
+    #     if not dev_y:
+    #         return
+    #     fig.clear_all()
+    #     plt = fig.plot(x_name=dev_x, y_name=dev_y)
+    #     plt.set(title=f"Custom Plot {info.scan_number}", x_label=dev_x, y_label=dev_y)
+
+    def handler(self, info: ScanInfo) -> None:
+        # EXAMPLES:
+        # if info.scan_name == "line_scan" and info.scan_report_devices:
+        #     self.simple_line_scan(info)
+        #     return
+        # if info.scan_name == "grid_scan" and info.scan_report_devices:
+        #     self.run_grid_scan_update(info)
+        #     return
+        super().handler(info)
+```

{bec_widgets-0.57.1 → bec_widgets-0.57.3}/docs/user/getting_started/getting_started.md

@@ -9,5 +9,6 @@ hidden: true
 ---
 
 installation/
-command_line_introduction/
+quick_start/
+auto_updates/
 ```