bec-widgets 0.66.1__py3-none-any.whl → 0.68.0__py3-none-any.whl

bec_widgets/widgets/bec_status_box/bec_status_box.py

@@ -0,0 +1,352 @@
+"""This module contains the BECStatusBox widget, which displays the status of different BEC services in a collapsible tree widget.
+The widget automatically updates the status of all running BEC services, and displays their status.
+"""
+
+from __future__ import annotations
+
+import sys
+from typing import TYPE_CHECKING
+
+import qdarktheme
+from bec_lib.utils.import_utils import lazy_import_from
+from pydantic import BaseModel, Field, field_validator
+from qtpy.QtCore import QObject, QTimer, Signal, Slot
+from qtpy.QtWidgets import QTreeWidget, QTreeWidgetItem, QVBoxLayout, QWidget
+
+from bec_widgets.utils.bec_connector import BECConnector, ConnectionConfig
+from bec_widgets.widgets.bec_status_box.status_item import StatusItem
+
+if TYPE_CHECKING:
+    from bec_lib.client import BECClient
+
+# TODO : Put normal imports back when Pydantic gets faster
+BECStatus = lazy_import_from("bec_lib.messages", ("BECStatus",))
+
+
+class BECStatusBoxConfig(ConnectionConfig):
+    pass
+
+
+class BECServiceInfoContainer(BaseModel):
+    """Container to store information about the BEC services."""
+
+    service_name: str
+    status: BECStatus | str = Field(
+        default="NOTCONNECTED",
+        description="The status of the service. Can be any of the BECStatus names, or NOTCONNECTED.",
+    )
+    info: dict
+    metrics: dict | None
+    model_config: dict = {"validate_assignment": True}
+
+    @field_validator("status")
+    @classmethod
+    def validate_status(cls, v):
+        """Validate input for status. Accept BECStatus and NOTCONNECTED.
+
+        Args:
+            v (BECStatus | str): The input value.
+
+        Returns:
+            str: The validated status.
+        """
+        if v in list(BECStatus.__members__.values()):
+            return v.name
+        if v in list(BECStatus.__members__.keys()) or v == "NOTCONNECTED":
+            return v
+        raise ValueError(
+            f"Status must be one of {BECStatus.__members__.values()} or 'NOTCONNECTED'. Input {v}"
+        )
+
+
+class BECServiceStatusMixin(QObject):
+    """A mixin class to update the service status, and metrics.
+    It emits a signal 'services_update' when the service status is updated.
+
+    Args:
+        client (BECClient): The client object to connect to the BEC server.
+    """
+
+    services_update = Signal(dict, dict)
+
+    def __init__(self, client: BECClient):
+        super().__init__()
+        self.client = client
+        self._service_update_timer = QTimer()
+        self._service_update_timer.timeout.connect(self._get_service_status)
+        self._service_update_timer.start(1000)
+
+    def _get_service_status(self):
+        """Pull latest service and metrics updates from REDIS for all services, and emit both via 'services_update' signal."""
+        # pylint: disable=protected-access
+        self.client._update_existing_services()
+        self.services_update.emit(self.client._services_info, self.client._services_metric)
+
+
+class BECStatusBox(BECConnector, QTreeWidget):
+    """A widget to display the status of different BEC services.
+    This widget automatically updates the status of all running BEC services, and displays their status.
+    Information about the individual services is collapsible, and double clicking on
+    the individual service will display the metrics about the service.
+
+    Args:
+        parent Optional : The parent widget for the BECStatusBox. Defaults to None.
+        service_name Optional(str): The name of the top service label. Defaults to "BEC Server".
+        client Optional(BECClient): The client object to connect to the BEC server. Defaults to None
+        config Optional(BECStatusBoxConfig | dict): The configuration for the status box. Defaults to None.
+        gui_id Optional(str): The unique id for the widget. Defaults to None.
+    """
+
+    CORE_SERVICES = ["DeviceServer", "ScanServer", "SciHub", "ScanBundler", "FileWriterManager"]
+
+    service_update = Signal(dict)
+    bec_core_state = Signal(str)
+
+    def __init__(
+        self,
+        parent=None,
+        service_name: str = "BEC Server",
+        client: BECClient = None,
+        config: BECStatusBoxConfig | dict = None,
+        gui_id: str = None,
+    ):
+        if config is None:
+            config = BECStatusBoxConfig(widget_class=self.__class__.__name__)
+        else:
+            if isinstance(config, dict):
+                config = BECStatusBoxConfig(**config)
+        super().__init__(client=client, config=config, gui_id=gui_id)
+        QTreeWidget.__init__(self, parent=parent)
+
+        self.service_name = service_name
+        self.config = config
+
+        self.bec_service_info_container = {}
+        self.tree_items = {}
+        self.tree_top_item = None
+        self.bec_service_status = BECServiceStatusMixin(client=self.client)
+
+        self.init_ui()
+        self.bec_service_status.services_update.connect(self.update_service_status)
+        self.bec_core_state.connect(self.update_top_item_status)
+        self.itemDoubleClicked.connect(self.on_tree_item_double_clicked)
+
+    def init_ui(self) -> None:
+        """Initialize the UI for the status box, and add QTreeWidget as the basis for the status box."""
+        self.init_ui_tree_widget()
+        top_label = self._create_status_widget(self.service_name, status=BECStatus.IDLE)
+        self.tree_top_item = QTreeWidgetItem()
+        self.tree_top_item.setExpanded(True)
+        self.tree_top_item.setDisabled(True)
+        self.addTopLevelItem(self.tree_top_item)
+        self.setItemWidget(self.tree_top_item, 0, top_label)
+        self.service_update.connect(top_label.update_config)
+
+    def _create_status_widget(
+        self, service_name: str, status=BECStatus, info: dict = None, metrics: dict = None
+    ) -> StatusItem:
+        """Creates a StatusItem (QWidget) for the given service, and stores all relevant
+        information about the service in the bec_service_info_container.
+
+        Args:
+            service_name (str): The name of the service.
+            status (BECStatus): The status of the service.
+            info Optional(dict): The information about the service. Default is {}
+            metric Optional(dict): Metrics for the respective service. Default is None
+
+        Returns:
+            StatusItem: The status item widget.
+        """
+        if info is None:
+            info = {}
+        self._update_bec_service_container(service_name, status, info, metrics)
+        item = StatusItem(
+            parent=self,
+            config={
+                "service_name": service_name,
+                "status": status.name,
+                "info": info,
+                "metrics": metrics,
+            },
+        )
+        return item
+
+    @Slot(str)
+    def update_top_item_status(self, status: BECStatus) -> None:
+        """Method to update the status of the top item in the tree widget.
+        Gets the status from the Signal 'bec_core_state' and updates the StatusItem via the signal 'service_update'.
+
+        Args:
+            status (BECStatus): The state of the core services.
+        """
+        self.bec_service_info_container[self.service_name].status = status
+        self.service_update.emit(self.bec_service_info_container[self.service_name].model_dump())
+
+    def _update_bec_service_container(
+        self, service_name: str, status: BECStatus, info: dict, metrics: dict = None
+    ) -> None:
+        """Update the bec_service_info_container with the newest status and metrics for the BEC service.
+        If information about the service already exists, it will create a new entry.
+
+        Args:
+            service_name (str): The name of the service.
+            service_info (StatusMessage): A class containing the service status.
+            service_metric (ServiceMetricMessage): A class containing the service metrics.
+        """
+        container = self.bec_service_info_container.get(service_name, None)
+        if container:
+            container.status = status
+            container.info = info
+            container.metrics = metrics
+            return
+        service_info_item = BECServiceInfoContainer(
+            service_name=service_name, status=status, info=info, metrics=metrics
+        )
+        self.bec_service_info_container.update({service_name: service_info_item})
+
+    @Slot(dict, dict)
+    def update_service_status(self, services_info: dict, services_metric: dict) -> None:
+        """Callback function services_metric from BECServiceStatusMixin.
+        It updates the status of all services.
+
+        Args:
+            services_info (dict): A dictionary containing the service status for all running BEC services.
+            services_metric (dict): A dictionary containing the service metrics for all running BEC services.
+        """
+        checked = []
+        services_info = self.update_core_services(services_info, services_metric)
+        checked.extend(self.CORE_SERVICES)
+
+        for service_name, msg in sorted(services_info.items()):
+            checked.append(service_name)
+            metric_msg = services_metric.get(service_name, None)
+            metrics = metric_msg.metrics if metric_msg else None
+            if service_name in self.tree_items:
+                self._update_bec_service_container(
+                    service_name=service_name, status=msg.status, info=msg.info, metrics=metrics
+                )
+                self.service_update.emit(self.bec_service_info_container[service_name].model_dump())
+                continue
+
+            item_widget = self._create_status_widget(
+                service_name=service_name, status=msg.status, info=msg.info, metrics=metrics
+            )
+            item = QTreeWidgetItem()
+            item.setDisabled(True)
+            self.service_update.connect(item_widget.update_config)
+            self.tree_top_item.addChild(item)
+            self.setItemWidget(item, 0, item_widget)
+            self.tree_items.update({service_name: (item, item_widget)})
+
+        self.check_redundant_tree_items(checked)
+
+    def update_core_services(self, services_info: dict, services_metric: dict) -> dict:
+        """Method to process status and metrics updates of core services (stored in CORE_SERVICES).
+        If a core services is not connected, it should not be removed from the status widget
+
+        Args:
+            services_info (dict): A dictionary containing the service status of different services.
+            services_metric (dict): A dictionary containing the service metrics of different services.
+
+        Returns:
+            dict: The services_info dictionary after removing the info updates related to the CORE_SERVICES
+        """
+        bec_core_state = "RUNNING"
+        for service_name in sorted(self.CORE_SERVICES):
+            metric_msg = services_metric.get(service_name, None)
+            metrics = metric_msg.metrics if metric_msg else None
+            if service_name not in services_info:
+                self.bec_service_info_container[service_name].status = "NOTCONNECTED"
+                bec_core_state = "ERROR"
+            else:
+                msg = services_info.pop(service_name)
+                self._update_bec_service_container(
+                    service_name=service_name, status=msg.status, info=msg.info, metrics=metrics
+                )
+                bec_core_state = (
+                    "RUNNING" if (msg.status.value > 1 and bec_core_state == "RUNNING") else "ERROR"
+                )
+
+            if service_name in self.tree_items:
+                self.service_update.emit(self.bec_service_info_container[service_name].model_dump())
+                continue
+            self.add_tree_item(service_name, msg.status, msg.info, metrics)
+
+        self.bec_core_state.emit(bec_core_state)
+        return services_info
+
+    def check_redundant_tree_items(self, checked: list) -> None:
+        """Utility method to check and remove redundant objects from the BECStatusBox.
+
+        Args:
+            checked (list): A list of services that are currently running.
+        """
+        to_be_deleted = [key for key in self.tree_items if key not in checked]
+
+        for key in to_be_deleted:
+            item, _ = self.tree_items.pop(key)
+            self.tree_top_item.removeChild(item)
+
+    def add_tree_item(
+        self, service_name: str, status: BECStatus, info: dict = None, metrics: dict = None
+    ) -> None:
+        """Method to add a new QTreeWidgetItem together with a StatusItem to the tree widget.
+
+        Args:
+            service_name (str): The name of the service.
+            service_status_msg (StatusMessage): The status of the service.
+            metrics (dict): The metrics of the service.
+        """
+        item_widget = self._create_status_widget(
+            service_name=service_name, status=status, info=info, metrics=metrics
+        )
+        item = QTreeWidgetItem()
+        self.service_update.connect(item_widget.update_config)
+        self.tree_top_item.addChild(item)
+        self.setItemWidget(item, 0, item_widget)
+        self.tree_items.update({service_name: (item, item_widget)})
+
+    def init_ui_tree_widget(self) -> None:
+        """Initialise the tree widget for the status box."""
+        self.setHeaderHidden(True)
+        self.setStyleSheet(
+            "QTreeWidget::item:!selected "
+            "{ "
+            "border: 1px solid gainsboro; "
+            "border-left: none; "
+            "border-top: none; "
+            "}"
+            "QTreeWidget::item:selected {}"
+        )
+
+    @Slot(QTreeWidgetItem, int)
+    def on_tree_item_double_clicked(self, item: QTreeWidgetItem, column: int) -> None:
+        """Callback function for double clicks on individual QTreeWidgetItems in the collapsed section.
+
+        Args:
+            item (QTreeWidgetItem): The item that was double clicked.
+            column (int): The column that was double clicked.
+        """
+        for _, (tree_item, status_widget) in self.tree_items.items():
+            if tree_item == item:
+                status_widget.show_popup()
+
+    def closeEvent(self, event):
+        super().cleanup()
+        QTreeWidget().closeEvent(event)
+
+
+def main():
+    """Main method to run the BECStatusBox widget."""
+    # pylint: disable=import-outside-toplevel
+    from qtpy.QtWidgets import QApplication
+
+    app = QApplication(sys.argv)
+    qdarktheme.setup_theme("auto")
+    main_window = BECStatusBox()
+    main_window.show()
+    sys.exit(app.exec())
+
+
+if __name__ == "__main__":
+    main()

bec_widgets/widgets/bec_status_box/status_item.py

@@ -0,0 +1,171 @@
+""" Module for a StatusItem widget to display status and metrics for a BEC service.
+The widget is bound to be used with the BECStatusBox widget."""
+
+import enum
+import sys
+from datetime import datetime
+
+import qdarktheme
+from bec_lib.utils.import_utils import lazy_import_from
+from pydantic import Field
+from qtpy.QtCore import Qt, Slot
+from qtpy.QtWidgets import QDialog, QHBoxLayout, QLabel, QStyle, QVBoxLayout, QWidget
+
+from bec_widgets.utils.bec_connector import ConnectionConfig
+
+# TODO : Put normal imports back when Pydantic gets faster
+BECStatus = lazy_import_from("bec_lib.messages", ("BECStatus",))
+
+
+class IconsEnum(enum.Enum):
+    """Enum class for icons in the status item widget."""
+
+    RUNNING = "SP_DialogApplyButton"
+    BUSY = "SP_BrowserReload"
+    IDLE = "SP_MessageBoxWarning"
+    ERROR = "SP_DialogCancelButton"
+    NOTCONNECTED = "SP_TitleBarContextHelpButton"
+
+
+class StatusWidgetConfig(ConnectionConfig):
+    """Configuration class for the status item widget."""
+
+    service_name: str
+    status: str
+    info: dict
+    metrics: dict | None
+    icon_size: tuple = Field(default=(24, 24), description="The size of the icon in the widget.")
+    font_size: int = Field(16, description="The font size of the text in the widget.")
+
+
+class StatusItem(QWidget):
+    """A widget to display the status of a service.
+
+    Args:
+        parent: The parent widget.
+        config (dict): The configuration for the service.
+    """
+
+    def __init__(self, parent=None, config: dict = None):
+        if config is None:
+            config = StatusWidgetConfig(widget_class=self.__class__.__name__)
+        else:
+            if isinstance(config, dict):
+                config = StatusWidgetConfig(**config)
+            self.config = config
+        QWidget.__init__(self, parent=parent)
+        self.parent = parent
+        self.layout = None
+        self.config = config
+        self._popup_label_ref = {}
+        self._label = None
+        self._icon = None
+        self.init_ui()
+
+    def init_ui(self) -> None:
+        """Init the UI for the status item widget."""
+        self.layout = QHBoxLayout()
+        self.layout.setContentsMargins(5, 5, 5, 5)
+        self.setLayout(self.layout)
+        self._label = QLabel()
+        self._icon = QLabel()
+        self.layout.addWidget(self._label)
+        self.layout.addWidget(self._icon)
+        self.update_ui()
+
+    @Slot(dict)
+    def update_config(self, config: dict) -> None:
+        """Update the configuration of the status item widget.
+        This method is invoked from the parent widget.
+        The UI values are later updated based on the new configuration.
+
+        Args:
+            config (dict): Config updates from parent widget.
+        """
+        if config["service_name"] != self.config.service_name:
+            return
+        self.config.status = config["status"]
+        self.config.info = config["info"]
+        self.config.metrics = config["metrics"]
+        self.update_ui()
+
+    def update_ui(self) -> None:
+        """Update the UI of the labels, and popup dialog."""
+        self.set_text()
+        self.set_status()
+        self._set_popup_text()
+
+    def set_text(self) -> None:
+        """Set the text of the QLabel basae on the config."""
+        service = self.config.service_name
+        status = self.config.status
+        if "BECClient" in service.split("/"):
+            service = service.split("/")[0] + "/..." + service.split("/")[1][-4:]
+        if status == "NOTCONNECTED":
+            status = "NOT CONNECTED"
+        text = f"{service} is {status}"
+        self._label.setText(text)
+
+    def set_status(self) -> None:
+        """Set the status icon for the status item widget."""
+        icon_name = IconsEnum[self.config.status].value
+        icon = self.style().standardIcon(getattr(QStyle.StandardPixmap, icon_name))
+        self._icon.setPixmap(icon.pixmap(*self.config.icon_size))
+        self._icon.setAlignment(Qt.AlignmentFlag.AlignRight)
+
+    def show_popup(self) -> None:
+        """Method that is invoked when the user double clicks on the StatusItem widget."""
+        dialog = QDialog(self)
+        dialog.setWindowTitle(f"{self.config.service_name} Details")
+        layout = QVBoxLayout()
+        popup_label = self._make_popup_label()
+        self._set_popup_text()
+        layout.addWidget(popup_label)
+        dialog.setLayout(layout)
+        dialog.finished.connect(self._cleanup_popup_label)
+        dialog.exec()
+
+    def _make_popup_label(self) -> QLabel:
+        """Create a QLabel for the popup dialog.
+
+        Returns:
+            QLabel: The label for the popup dialog.
+        """
+        label = QLabel()
+        label.setWordWrap(True)
+        self._popup_label_ref.update({"label": label})
+        return label
+
+    def _set_popup_text(self) -> None:
+        """Compile the metrics text for the status item widget."""
+        if self._popup_label_ref.get("label") is None:
+            return
+        metrics_text = (
+            f"<b>SERVICE:</b> {self.config.service_name}<br><b>STATUS:</b> {self.config.status}<br>"
+        )
+        if self.config.metrics:
+            for key, value in self.config.metrics.items():
+                if key == "create_time":
+                    value = datetime.fromtimestamp(value).strftime("%Y-%m-%d %H:%M:%S")
+                metrics_text += f"<b>{key.upper()}:</b> {value}<br>"
+        self._popup_label_ref["label"].setText(metrics_text)
+
+    def _cleanup_popup_label(self) -> None:
+        """Cleanup the popup label."""
+        self._popup_label_ref.clear()
+
+
+def main():
+    """Run the status item widget."""
+    # pylint: disable=import-outside-toplevel
+    from qtpy.QtWidgets import QApplication
+
+    app = QApplication(sys.argv)
+    qdarktheme.setup_theme("auto")
+    main_window = StatusItem()
+    main_window.show()
+    sys.exit(app.exec())
+
+
+if __name__ == "__main__":
+    main()

{bec_widgets-0.66.1.dist-info → bec_widgets-0.68.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.66.1
+Version: 0.68.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-0.66.1.dist-info → bec_widgets-0.68.0.dist-info}/RECORD

@@ -2,11 +2,11 @@
 .gitlab-ci.yml,sha256=RnYDz4zKXjlqltTryprlB1s5vLXxI2-seW-Vb70NNF0,8162
 .pylintrc,sha256=OstrgmEyP0smNFBKoIN5_26-UmNZgMHnbjvAWX0UrLs,18535
 .readthedocs.yaml,sha256=aSOc277LqXcsTI6lgvm_JY80lMlr69GbPKgivua2cS0,603
-CHANGELOG.md,sha256=Vh2_soSc85dy9lRU01vmqFhnlnY81lRRHA67ib_xlto,6911
+CHANGELOG.md,sha256=EhWy5RDQRny8SHputsNnGM7Hy1HOZoSmZ6cJB2Gw8Cw,7198
 LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-PKG-INFO,sha256=u-mGylcSYfdLA6I276ETlul9ZXRitI9ECVKvIBxHY8w,1302
+PKG-INFO,sha256=I5LEt7gWZyuBZpnkwiIXlKyxz5sQOmtI-RAIDZjzD9s,1302
 README.md,sha256=y4jB6wvArS7N8_iTbKWnSM_oRAqLA2GqgzUR-FMh5sU,2645
-pyproject.toml,sha256=6z3-hs4UXP5ysKDuF4Te-9abra68AXuIvGB3ReAukC4,2162
+pyproject.toml,sha256=wCSTnyvyFrQnQiDgC5Pn18_zeLOguN86bLfJVSIboz8,2162
 .git_hooks/pre-commit,sha256=n3RofIZHJl8zfJJIUomcMyYGFi_rwq4CC19z0snz3FI,286
 .gitlab/issue_templates/bug_report_template.md,sha256=gAuyEwl7XlnebBrkiJ9AqffSNOywmr8vygUFWKTuQeI,386
 .gitlab/issue_templates/documentation_update_template.md,sha256=FHLdb3TS_D9aL4CYZCjyXSulbaW5mrN2CmwTaeLPbNw,860
@@ -17,12 +17,12 @@ bec_widgets/assets/bec_widgets_icon.png,sha256=K8dgGwIjalDh9PRHUsSQBqgdX7a00nM3i
 bec_widgets/assets/terminal_icon.png,sha256=bJl7Tft4Fi2uxvuXI8o14uMHnI9eAWKSU2uftXCH9ws,3889
 bec_widgets/cli/__init__.py,sha256=d0Q6Fn44e7wFfLabDOBxpcJ1DPKWlFunGYDUBmO-4hA,22
 bec_widgets/cli/auto_updates.py,sha256=DyBV3HnjMSH-cvVkYNcDiYKVf0Xut4Qy2qGQqkW47Bw,4833
-bec_widgets/cli/client.py,sha256=GJRzys0DVHQp8X9QxociTrshPm4CvaPtEprxWEpEKCs,56446
-bec_widgets/cli/client_utils.py,sha256=D076XKwcukKBKknd11B1UyOcQN_9sN7ZKMVttyCxS9Q,11586
+bec_widgets/cli/client.py,sha256=Zd4oMSE5-HY3IBUIVcparGGV2Ew86gaWAFTd4OjFVmg,58005
+bec_widgets/cli/client_utils.py,sha256=_Hb2nl1rKEf7k4By9VZDYl5YyGFczxMuYIFMVrOAZD0,12182
 bec_widgets/cli/generate_cli.py,sha256=Bi8HxHhge1I87vbdYHZUZiZwvbB-OSkLYS5Xfmwiz9M,4922
 bec_widgets/cli/rpc_register.py,sha256=QxXUZu5XNg00Yf5O3UHWOXg3-f_pzKjjoZYMOa-MOJc,2216
 bec_widgets/cli/rpc_wigdet_handler.py,sha256=1qQOGrM8rozaWLkoxAW8DTVLv_L_DZdZgUMDPy5MOek,1486
-bec_widgets/cli/server.py,sha256=4sigviIyJgZOgikWHc1X998vWAWayKF6S61oAY_mVDQ,5727
+bec_widgets/cli/server.py,sha256=3bFBPmtXKXFMjeja18d0hF3CO66Jo0-LEDtcF7lYb7k,7166
 bec_widgets/examples/__init__.py,sha256=WWQ0cu7m8sA4Ehy-DWdTIqSISjaHsbxhsNmNrMnhDZU,202
 bec_widgets/examples/jupyter_console/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/examples/jupyter_console/jupyter_console_window.py,sha256=FXf0q7oz9GyJSct8PAgeOalzNnIJjApiaRvNfXsZPs0,5345
@@ -32,7 +32,7 @@ bec_widgets/examples/motor_movement/motor_control_compilations.py,sha256=8rpA7a2
 bec_widgets/examples/motor_movement/motor_controller.ui,sha256=83XX6NGILwntoUIghvzWnMuGf80O8khK3SduVKTAEFM,29105
 bec_widgets/utils/__init__.py,sha256=1930ji1Jj6dVuY81Wd2kYBhHYNV-2R0bN_L4o9zBj1U,533
 bec_widgets/utils/bec_connector.py,sha256=RxHJNF7JjtY5pRbTMu2eQTiRXvoyJ53QuTYxHjZba38,5357
-bec_widgets/utils/bec_dispatcher.py,sha256=vvHpD_7ZddRmD6mHR5JWU_XEJYxognpmG7CnEWMjaZk,5989
+bec_widgets/utils/bec_dispatcher.py,sha256=yM9PG04O7ABhiA9Nzk38Rv9Qbjc5O93wi2xfSbOlOxc,6202
 bec_widgets/utils/bec_table.py,sha256=nA2b8ukSeUfquFMAxGrUVOqdrzMoDYD6O_4EYbOG2zk,717
 bec_widgets/utils/colors.py,sha256=GYSDe0ZxsJSwxvuy-yG2BH17qlf_Sjq8dhDcyp9IhBI,8532
 bec_widgets/utils/container_utils.py,sha256=m3VUyAYmSWkEwApP9tBvKxPYVtc2kHw4toxIpMryJy4,1495
@@ -47,6 +47,9 @@ bec_widgets/utils/validator_delegate.py,sha256=Emj1WF6W8Ke1ruBWUfmHdVJpmOSPezuOt
 bec_widgets/utils/widget_io.py,sha256=f36198CvT_EzWQ_cg2G-4tRRsaMdJ3yVqsZWKJCQEfA,10880
 bec_widgets/utils/yaml_dialog.py,sha256=cMVif-39SB9WjwGH5FWBJcFs4tnfFJFs5cacydRyhy0,1853
 bec_widgets/widgets/__init__.py,sha256=6RE9Pot2ud6BNJc_ZKiE--U-lgVRUff2IVR91lPcCbo,214
+bec_widgets/widgets/bec_status_box/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bec_widgets/widgets/bec_status_box/bec_status_box.py,sha256=ARdVzwabmbT_Jti6Wp-5KrxDQIingYVC-pZQHd6uz7o,14375
+bec_widgets/widgets/bec_status_box/status_item.py,sha256=wPkDm0GCGNXXpy3rR_Ljaxy0ZHeiiYcrWFqEntZnz4E,5869
 bec_widgets/widgets/buttons/__init__.py,sha256=74ucIRU6-anoqQ-zT7wbrysmxhg_3_04xGhN_kllNUI,48
 bec_widgets/widgets/buttons/stop_button/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 bec_widgets/widgets/buttons/stop_button/stop_button.py,sha256=x4a7RvlMkHzOd05zKOGYkyTmBza7Me7jgOL9WIgA_c4,906
@@ -103,7 +106,7 @@ docs/Makefile,sha256=i2WHuFlgfyAPEW4ssEP8NY4cOibDJrVjvzSEU8_Ggwc,634
 docs/conf.py,sha256=HxLxupNGu0Smhwn57g1kFdjZzFuaWVREgRJKhT1zi2k,2464
 docs/index.md,sha256=8ZCgaLIbJsYvt-jwi--QxsNwnK4-k3rejIeOOLclG40,1101
 docs/make.bat,sha256=vKazJE8RW49Cy8K7hm8QYbletvAd8YkeKsaPA_dWnXs,800
-docs/requirements.txt,sha256=SbcWrLYX6tEZNMCUETgsE50Y7VioR1VX6YCeifuJWEc,140
+docs/requirements.txt,sha256=TcjRnzVYFOg64N-lJc2sn-G6YQdhPjzp0lrLuPsPMXY,156
 docs/_static/custom.css,sha256=v4Nk7r8LZslhOV8RaSUb15bG4miwiZ4-kZyXBLnSyms,13487
 docs/_templates/custom-class-template.rst,sha256=HPuPaGJob2zXlWOl5FmA-hAZRbUTGQmdqo3HS1iIFog,711
 docs/_templates/custom-module-template.rst,sha256=MXYXAz06HP_mbblO--iFwL08xROmSBo7U4O-hPbMcZU,1228
@@ -118,7 +121,7 @@ docs/assets/rocket_launch_48dp.svg,sha256=pdrPrBcKWUa5OlgWKM0B6TA6qAW7E57d7C7YW2
 docs/developer/developer.md,sha256=VUdMnQBsSRCawYMFCe0vya5oj1MimLML7Pd58kY6fYY,765
 docs/developer/getting_started/development.md,sha256=aYLmuLMYpp5FcIXeDUqCfcStIV8veuiMBjOt5bTW_30,1406
 docs/developer/getting_started/getting_started.md,sha256=My_K_6O7LLaXVB_eINrRku5o-jVx95lsmGgHxgZhT7A,378
-docs/developer/widgets/widgets.md,sha256=O7v0DsgCr-IULxl0TJ7NIGN68wd5kouKz1Y5ZuEvaEU,529
+docs/developer/widgets/widgets.md,sha256=aNsJgG7R-3EerumNB6GH84JLIXfZqGN5GjvpKWDi0Hk,504
 docs/introduction/introduction.md,sha256=wp7jmhkUtJnSnEnmIAZGUcau_3-5e5-FohvZb63khw4,1432
 docs/user/customisation.md,sha256=wCW8fAbqtlgGE3mURvXOrK67Xo0_B-lxfg0sYuQWB40,3186
 docs/user/user.md,sha256=uCTcjclIi6rdjYRQebko6bWFEVsjyfshsVU3BDYrC-Y,1403
@@ -128,11 +131,13 @@ docs/user/getting_started/BECDockArea.png,sha256=t3vSm_rVRk371J5LOutbolETuEjStNc
 docs/user/getting_started/auto_updates.md,sha256=Gicx3lplI6JRBlnPj_VL6IhqOIcsWjYF4_EdZSCje2A,3754
 docs/user/getting_started/getting_started.md,sha256=lxZXCr6HAkM61oo5Bu-YjINSKo4wihWhAPJdotEAAVQ,358
 docs/user/getting_started/gui_complex_gui.gif,sha256=ovv9u371BGG5GqhzyBMl4mvqMHLfJS0ylr-dR0Ydwtw,6550393
-docs/user/getting_started/installation.md,sha256=gqMV44lh9-wkKtAtDckvnyX_d8oTBNinQxvriFQ9Sk4,1145
+docs/user/getting_started/installation.md,sha256=5_fPbmUqLGtwOskFHTlytd4PJKrMcHqHShzM9ymM0oI,1149
 docs/user/getting_started/quick_start.md,sha256=VGU880GwamcIZcBE8tjxuqX2syE-71jqZedtskCoBbA,9405
 docs/user/widgets/BECFigure.png,sha256=8dQr4u0uk_y0VV-R1Jh9yTR3Vidd9HDEno_07R0swaE,1605920
 docs/user/widgets/bec_figure.md,sha256=BwcumbhZd6a2zKmoHTvwKr8kG8WxBx9lS_QwxNiBMpQ,5155
-docs/user/widgets/buttons.md,sha256=LG-Csj9RL7hWur8Xgj19r-u2SuIFq912fyBVN6peLGY,1222
+docs/user/widgets/bec_status_box.gif,sha256=kLxf40HbS6fjdUIQ2b9SiduBEXdBd4DDWGEnQDOFMcY,1259044
+docs/user/widgets/bec_status_box.md,sha256=0ILY12UnSjiVCtd5qpC8G2dPBYhug3J_rmQLilDxulY,1164
+docs/user/widgets/buttons.md,sha256=Yci21PmxlRvfKcrvY7mVI7JkECPmE6j9WyWyH3j7Y2o,1221
 docs/user/widgets/image_plot.gif,sha256=_mVFhMTXGqwDOcEtrBHMZj5Thn2sLhDAHEeL2XyHN-s,14098977
 docs/user/widgets/motor.gif,sha256=FtaWdRHx4UZaGJPpq8LNhMMgX4PFcAB6IZ93JCMEh_w,2280719
 docs/user/widgets/progress_bar.gif,sha256=5jh0Zw2BBGPuNxszV1DBLJCb4_6glIRX-U2ABjnsK2k,5263592
@@ -141,10 +146,10 @@ docs/user/widgets/spiral_progress_bar.md,sha256=QTgUDIl6XPuK_HwSfB6sNijZ4bss26bi
 docs/user/widgets/text_box.md,sha256=_ST7RQWXl67MKLm6dTa995GjoughPUyK_hLnF8SPZcM,925
 docs/user/widgets/w1D.gif,sha256=tuHbleJpl6bJFNNC2OdndF5LF7IyfvlkFCMGZajrQPs,622773
 docs/user/widgets/website.md,sha256=wfudAupdtHX-Sfritg0xMWXZLLczJ4XwMLNWvu6ww-w,705
-docs/user/widgets/widgets.md,sha256=NzRfrgd4LWmZHa2Cs_1G59LeY5uAlFdy5aP00AtGAjk,380
+docs/user/widgets/widgets.md,sha256=6H8C8M2fFmTxFFlrAuOE-jBpOUVUrOIIzWP0l_EwMGo,397
 tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/end-2-end/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tests/end-2-end/conftest.py,sha256=j1O1SxXRJ8jcrunn6dcfbZLK2Jc-VUxyh9ZuCSc6Qj4,1816
+tests/end-2-end/conftest.py,sha256=-BLnFE-NeCerf6xahGCkbZ4Ktactowi6RkBnboIzRvg,1767
 tests/end-2-end/test_bec_dock_rpc_e2e.py,sha256=8iJz4lITspY7eHdSgy9YvGUGTu3fsSperoVGBvTGT0U,9067
 tests/end-2-end/test_bec_figure_rpc_e2e.py,sha256=zTbB_F4Fs-QG8KhMK24xfsrCQBgZUAguMk3KFdEdP2o,5095
 tests/end-2-end/test_rpc_register_e2e.py,sha256=3dfCnSvdcRO92pzHt9WlCTK0vzTKAvPtliEoEKrtuzQ,1604
@@ -156,6 +161,7 @@ tests/unit_tests/test_bec_dispatcher.py,sha256=rYPiRizHaswhGZw55IBMneDFxmPiCCLAZ
 tests/unit_tests/test_bec_dock.py,sha256=BXKXpuyIYj-l6KSyhQtM_p3kRFCRECIoXLzvkcJZDlM,3611
 tests/unit_tests/test_bec_figure.py,sha256=aEd2R8K6fU2ON8QvPemGWpql_LaaYLipRlvnjBY2qFA,8009
 tests/unit_tests/test_bec_motor_map.py,sha256=AfD_9-x6VV3TPnkQgNfFYRndPHDsGx-a_YknFeDr6hc,4588
+tests/unit_tests/test_bec_status_box.py,sha256=zZ4pe7DaBzzpRsy62yHFkUGgAGb3zZU3I6zQIPsqUTY,6070
 tests/unit_tests/test_client_utils.py,sha256=eViJ1Tz-HX9TkMvQH6W8cO-c3_1I8bUc4_Yen6LOc0E,830
 tests/unit_tests/test_color_validation.py,sha256=csdvVKAohENZIRY-JQ97Hv-TShb1erj4oKMX7QRwo78,1883
 tests/unit_tests/test_crosshair.py,sha256=3OMAJ2ZaISYXMOtkXf1rPdy94vCr8njeLi6uHblBL9Q,5045
@@ -180,8 +186,8 @@ tests/unit_tests/test_configs/config_device_no_entry.yaml,sha256=hdvue9KLc_kfNzG
 tests/unit_tests/test_configs/config_scan.yaml,sha256=vo484BbWOjA_e-h6bTjSV9k7QaQHrlAvx-z8wtY-P4E,1915
 tests/unit_tests/test_msgs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/unit_tests/test_msgs/available_scans_message.py,sha256=m_z97hIrjHXXMa2Ex-UvsPmTxOYXfjxyJaGkIY6StTY,46532
-bec_widgets-0.66.1.dist-info/METADATA,sha256=u-mGylcSYfdLA6I276ETlul9ZXRitI9ECVKvIBxHY8w,1302
-bec_widgets-0.66.1.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
-bec_widgets-0.66.1.dist-info/entry_points.txt,sha256=OvoqiNzNF9bizFQNhbAmmdc_njHrnVewLE-Kl-u9sh0,115
-bec_widgets-0.66.1.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
-bec_widgets-0.66.1.dist-info/RECORD,,
+bec_widgets-0.68.0.dist-info/METADATA,sha256=I5LEt7gWZyuBZpnkwiIXlKyxz5sQOmtI-RAIDZjzD9s,1302
+bec_widgets-0.68.0.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
+bec_widgets-0.68.0.dist-info/entry_points.txt,sha256=OvoqiNzNF9bizFQNhbAmmdc_njHrnVewLE-Kl-u9sh0,115
+bec_widgets-0.68.0.dist-info/licenses/LICENSE,sha256=YRKe85CBRyP7UpEAWwU8_qSIyuy5-l_9C-HKg5Qm8MQ,1511
+bec_widgets-0.68.0.dist-info/RECORD,,

docs/developer/widgets/widgets.md

@@ -8,5 +8,4 @@ maxdepth: 2
 hidden: false
 ---
 
-how_to_develop_a_widget/
 ```

docs/requirements.txt

@@ -7,5 +7,6 @@ sphinx-copybutton
 myst-parser
 sphinx-design
 PyQt6
+PyQt6-WebEngine
 bec-widgets
 tomli