feat(widgets): added status indicator widget

Automatically generated by python-semantic-release

.gitlab-ci.yml

@@ -22,6 +22,13 @@ workflow:
 
 include:
   - template: Security/Secret-Detection.gitlab-ci.yml
+  - project: "bec/awi_utils"
+    file: "/templates/check-packages-job.yml"
+    inputs:
+      stage: test
+      path: "."
+      pytest_args: "-v --random-order tests/"
+      exclude_packages: ""
 
 # different stages in the pipeline
 stages:
@@ -32,21 +39,21 @@ stages:
   - Deploy
 
 .install-qt-webengine-deps: &install-qt-webengine-deps
-    - apt-get -y install libnss3 libxdamage1 libasound2 libatomic1 libxcursor1
-    - export QTWEBENGINE_DISABLE_SANDBOX=1
+  - apt-get -y install libnss3 libxdamage1 libasound2 libatomic1 libxcursor1
+  - export QTWEBENGINE_DISABLE_SANDBOX=1
 
 .clone-repos: &clone-repos
-    - git clone --branch $BEC_CORE_BRANCH https://gitlab.psi.ch/bec/bec.git
-    - git clone --branch $OPHYD_DEVICES_BRANCH https://gitlab.psi.ch/bec/ophyd_devices.git
-    - export OHPYD_DEVICES_PATH=$PWD/ophyd_devices
-  
+  - git clone --branch $BEC_CORE_BRANCH https://gitlab.psi.ch/bec/bec.git
+  - git clone --branch $OPHYD_DEVICES_BRANCH https://gitlab.psi.ch/bec/ophyd_devices.git
+  - export OHPYD_DEVICES_PATH=$PWD/ophyd_devices
+
 .install-os-packages: &install-os-packages
-    - apt-get update
-    - apt-get install -y libgl1-mesa-glx libegl1-mesa x11-utils libxkbcommon-x11-0 libdbus-1-3
-    - *install-qt-webengine-deps
+  - apt-get update
+  - apt-get install -y libgl1-mesa-glx libegl1-mesa x11-utils libxkbcommon-x11-0 libdbus-1-3
+  - *install-qt-webengine-deps
 
 before_script:
-  - if [[ "$CI_PROJECT_PATH" != "bec/bec_widgets" ]]; then 
+  - if [[ "$CI_PROJECT_PATH" != "bec/bec_widgets" ]]; then
     echo -e "\033[35;1m Using branch $CHILD_PIPELINE_BRANCH of BEC Widgets \033[0;m";
     test -d bec_widgets || git clone --branch $CHILD_PIPELINE_BRANCH https://gitlab.psi.ch/bec/bec_widgets.git; cd bec_widgets;
     fi
@@ -92,10 +99,10 @@ pylint-check:
     - git fetch origin $CI_MERGE_REQUEST_TARGET_BRANCH_NAME
     # Identify changed Python files
     - if [ "$CI_PIPELINE_SOURCE" == "merge_request_event" ]; then
-        TARGET_BRANCH_COMMIT_SHA=$(git rev-parse origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME);
-        CHANGED_FILES=$(git diff --name-only $TARGET_BRANCH_COMMIT_SHA HEAD | grep '\.py$' || true);
+      TARGET_BRANCH_COMMIT_SHA=$(git rev-parse origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME);
+      CHANGED_FILES=$(git diff --name-only $TARGET_BRANCH_COMMIT_SHA HEAD | grep '\.py$' || true);
       else
-        CHANGED_FILES=$(git diff --name-only $CI_COMMIT_BEFORE_SHA $CI_COMMIT_SHA | grep '\.py$' || true);
+      CHANGED_FILES=$(git diff --name-only $CI_COMMIT_BEFORE_SHA $CI_COMMIT_SHA | grep '\.py$' || true);
       fi
     - if [ -z "$CHANGED_FILES" ]; then echo "No Python files changed."; exit 0; fi
 
@@ -120,7 +127,7 @@ tests:
   stage: test
   needs: []
   variables:
-      QT_QPA_PLATFORM: "offscreen"
+    QT_QPA_PLATFORM: "offscreen"
   script:
     - *clone-repos
     - *install-os-packages
@@ -141,21 +148,21 @@ tests:
 test-matrix:
   parallel:
     matrix:
-      - PYTHON_VERSION: 
-        - "3.10"
-        - "3.11"
-        - "3.12"
-        QT_PCKG: 
-        - "pyside6"
-        - "pyqt5"
-        - "pyqt6"
+      - PYTHON_VERSION:
+          - "3.10"
+          - "3.11"
+          - "3.12"
+        QT_PCKG:
+          - "pyside6"
+          - "pyqt5"
+          - "pyqt6"
 
   stage: AdditionalTests
   needs: []
   variables:
-      QT_QPA_PLATFORM: "offscreen"
-      PYTHON_VERSION: ""
-      QT_PCKG: ""
+    QT_QPA_PLATFORM: "offscreen"
+    PYTHON_VERSION: ""
+    QT_PCKG: ""
   image: $CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX/python:$PYTHON_VERSION
   script:
     - *clone-repos
@@ -226,7 +233,7 @@ semver:
     - pip install python-semantic-release==9.* wheel build twine
     - export GL_TOKEN=$CI_UPDATES
     - semantic-release -vv version
-    
+
     # check if any artifacts were created
     - if [ ! -d dist ]; then echo No release will be made; exit 0; fi
     - twine upload dist/* -u __token__ -p $CI_PYPI_TOKEN --skip-existing
@@ -242,7 +249,7 @@ pages:
   variables:
     TARGET_BRANCH: $CI_COMMIT_REF_NAME
   rules:
-    - if: '$CI_COMMIT_TAG != null'
+    - if: "$CI_COMMIT_TAG != null"
       variables:
         TARGET_BRANCH: $CI_COMMIT_TAG
     - if: '$CI_COMMIT_REF_NAME == "main" && $CI_PROJECT_PATH == "bec/bec_widgets"'

CHANGELOG.md

@@ -2,6 +2,56 @@
 
 
 
+## v0.63.2 (2024-06-14)
+
+### Fix
+
+* fix: do not import "server" in client, prevents from having trouble with QApplication creation order
+
+Like with QtWebEngine ([`6f96498`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6f96498de66358b89f3a2035627eed2e02dde5a1))
+
+### Unknown
+
+* Reapply "feat: implement non-polling, interruptible waiting of gui instruction response with timeout"
+
+This reverts commit fe04dd80e59a0e74f7fdea603e0642707ecc7c2a. ([`836b6e6`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/836b6e64f694916d6b6f909dedf11a4a6d2c86a4))
+
+
+## v0.63.1 (2024-06-13)
+
+### Fix
+
+* fix: just terminate the remote process in close() instead of communicating
+
+The proper finalization sequence will be executed by the remote process
+on SIGTERM ([`9263f8e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9263f8ef5c17ae7a007a1a564baf787b39061756))
+
+
+## v0.63.0 (2024-06-13)
+
+### Documentation
+
+* docs: add documentation ([`bc709c4`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/bc709c4184c985d4e721f9ea7d1b3dad5e9153a7))
+
+### Feature
+
+* feat: add textbox widget ([`d9d4e3c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/d9d4e3c9bf73ab2a5629c2867b50fc91e69489ec))
+
+### Refactor
+
+* refactor: add pydantic config, add change_theme ([`6b8432f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6b8432f5b20a71175a3537b5f6832b76e3b67d73))
+
+### Test
+
+* test: add test for text box ([`b49462a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b49462abeb186e56bac79d2ef0b0add1ef28a1a5))
+
+### Unknown
+
+* Revert "feat: implement non-polling, interruptible waiting of gui instruction response with timeout"
+
+This reverts commit abc6caa2d0b6141dfbe1f3d025f78ae14deddcb3 ([`fe04dd8`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/fe04dd80e59a0e74f7fdea603e0642707ecc7c2a))
+
+
 ## v0.62.0 (2024-06-12)
 
 ### Feature
@@ -124,42 +174,3 @@
 
 
 ## v0.57.7 (2024-06-07)
-
-### Documentation
-
-* docs: added schema of BECDockArea and BECFigure ([`828067f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/828067f486a905eb4678538df58e2bdd6c770de1))
-
-### Fix
-
-* fix: add model_config to pydantic models to allow runtime checks after creation ([`ca5e8d2`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ca5e8d2fbbffbf221cc5472710fef81a33ee29d6))
-
-
-## v0.57.6 (2024-06-06)
-
-### Fix
-
-* fix(bar): docstrings extended ([`edb1775`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/edb1775967c3ff0723d0edad2b764f1ffc832b7c))
-
-
-## v0.57.5 (2024-06-06)
-
-### Documentation
-
-* docs(figure): docs adjusted to be compatible with new signature ([`c037b87`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c037b87675af91b26e8c7c60e76622d4ed4cf5d5))
-
-### Fix
-
-* fix(waveform): added .plot method with the same signature as BECFigure.plot ([`8479caf`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/8479caf53a7325788ca264e5bd9aee01f1d4c5a0))
-
-* fix(plot_base): .plot removed from plot_base.py, because there is no use case for it ([`82e2c89`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/82e2c898d2e26f786b2d481f85c647472675e75b))
-
-### Refactor
-
-* refactor(figure): logic for .add_image and .image consolidated; logic for .add_plot and .plot consolidated ([`52bc322`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/52bc322b2b8d3ef92ff3480e61bddaf32464f976))
-
-
-## v0.57.4 (2024-06-06)
-
-### Fix
-
-* fix(docks): set_title do update dock internal _name now ([`15cbc21`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/15cbc21e5bb3cf85f5822d44a2b3665b5aa2f346))

bec_widgets/cli/client.py

@@ -16,7 +16,9 @@ class Widgets(str, enum.Enum):
     BECDock = "BECDock"
     BECDockArea = "BECDockArea"
     BECFigure = "BECFigure"
+    RoundStatusIndicator = "RoundStatusIndicator"
     SpiralProgressBar = "SpiralProgressBar"
+    TextBox = "TextBox"
     WebsiteWidget = "WebsiteWidget"
 
 
@@ -1718,6 +1720,17 @@ class Ring(RPCBase):
         """
 
 
+class RoundStatusIndicator(RPCBase):
+    @rpc_call
+    def set_state(self, state: Literal["success", "failure", "warning"]) -> None:
+        """
+        Set the state of the indicator.
+
+        Args:
+            state (str): The state of the indicator. Can be "success", "failure", or "warning"
+        """
+
+
 class SpiralProgressBar(RPCBase):
     @rpc_call
     def get_all_rpc(self) -> "dict":
@@ -1897,6 +1910,54 @@ class SpiralProgressBar(RPCBase):
         """
 
 
+class StopButton(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 TextBox(RPCBase):
+    @rpc_call
+    def set_color(self, background_color: str, font_color: str) -> None:
+        """
+        Set the background color of the widget.
+
+        Args:
+            background_color (str): The color to set the background in HEX.
+            font_color (str): The color to set the font in HEX.
+        """
+
+    @rpc_call
+    def set_text(self, text: str) -> None:
+        """
+        Set the text of the widget.
+
+        Args:
+            text (str): The text to set.
+        """
+
+    @rpc_call
+    def set_font_size(self, size: int) -> None:
+        """
+        Set the font size of the text in the widget.
+
+        Args:
+            size (int): The font size to set.
+        """
+
+
 class WebsiteWidget(RPCBase):
     @rpc_call
     def set_url(self, url: str) -> None:

bec_widgets/cli/client_utils.py

@@ -86,13 +86,8 @@ 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,
+        "bec-gui-server",
         "--id",
         gui_id,
         "--config",
@@ -100,7 +95,11 @@ def _start_plot_process(gui_id, gui_class, config) -> None:
         "--gui_class",
         gui_class.__name__,
     ]
-    process = subprocess.Popen(command, text=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+    env_dict = os.environ.copy()
+    env_dict["PYTHONUNBUFFERED"] = "1"
+    process = subprocess.Popen(
+        command, text=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=env_dict
+    )
     process_output_processing_thread = threading.Thread(target=_get_output, args=(process,))
     process_output_processing_thread.start()
     return process, process_output_processing_thread
@@ -176,16 +175,11 @@ class BECGuiClientMixin:
         """
         Close the figure.
         """
-        if self._process is None:
-            return
-        if self.gui_is_alive():
-            self._run_rpc("close", (), wait_for_rpc_response=True)
-        else:
-            self._run_rpc("close", (), wait_for_rpc_response=False)
-        self._process.terminate()
-        self._process_output_processing_thread.join()
-        self._process = None
         self._client.shutdown()
+        if self._process:
+            self._process.terminate()
+            self._process_output_processing_thread.join()
+            self._process = None
 
     def print_log(self) -> None:
         """

bec_widgets/cli/rpc_wigdet_handler.py

@@ -1,6 +1,8 @@
 from bec_widgets.utils import BECConnector
 from bec_widgets.widgets.figure import BECFigure
+from bec_widgets.widgets.round_status_indicator.round_status_indicator import RoundStatusIndicator
 from bec_widgets.widgets.spiral_progress_bar.spiral_progress_bar import SpiralProgressBar
+from bec_widgets.widgets.text_box.text_box import TextBox
 from bec_widgets.widgets.website.website import WebsiteWidget
 
 
@@ -11,6 +13,8 @@ class RPCWidgetHandler:
         "BECFigure": BECFigure,
         "SpiralProgressBar": SpiralProgressBar,
         "Website": WebsiteWidget,
+        "TextBox": TextBox,
+        "RoundStatusIndicator": RoundStatusIndicator,
     }
 
     @staticmethod

bec_widgets/cli/server.py

@@ -114,7 +114,7 @@ class BECWidgetsCLIServer:
         self.client.shutdown()
 
 
-if __name__ == "__main__":  # pragma: no cover
+def main():
     import argparse
     import os
     import sys
@@ -166,3 +166,7 @@ if __name__ == "__main__":  # pragma: no cover
 
     app.aboutToQuit.connect(server.shutdown)
     sys.exit(app.exec())
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

bec_widgets/widgets/console/console.py

@@ -1,159 +0,0 @@
-import logging
-import os
-import platform
-import sys
-
-import termqt
-from qtpy.QtCore import QSocketNotifier, Qt
-from qtpy.QtGui import QFont
-from qtpy.QtWidgets import QApplication, QHBoxLayout, QScrollBar, QWidget
-from termqt import Terminal
-
-try:
-    from qtpy.QtCore import pyqtRemoveInputHook
-
-    pyqtRemoveInputHook()
-except ImportError:
-    pass
-
-if platform.system() in ["Linux", "Darwin"]:
-    terminal_cmd = os.environ["SHELL"]
-
-    from termqt import TerminalPOSIXExecIO
-
-    class TerminalExecIO(TerminalPOSIXExecIO):
-        def _read_loop(self):
-            pass
-
-        def find_utf8_split(self, data):
-            """UTF-8 characters can be 1-4 bytes long, this finds first index which is not mid character
-
-            Character lengths include:
-              1 Bytes: 0xxxxxxx
-              2 Bytes: 110xxxxx 10xxxxxx
-              3 Bytes: 1110xxxx 10xxxxxx 10xxxxxx
-              4 bytes: 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
-              Source: https://en.wikipedia.org/wiki/UTF-8#Encoding
-
-            Start at end of chunk moving backwards, find first UTF-8 start byte:
-              1 Bytes: 0xxxxxxx - 0x80 == 0x00
-              2 Bytes: 110xxxxx - 0xE0 == 0xC0
-              3 Bytes: 1110xxxx - 0xF0 == 0xE0
-              4 bytes: 11110xxx - 0xF8 == 0xF0
-
-            Parameters:
-              data (bytes) - buffer to be evaluated
-
-            Returns:
-              (int) - last position of complete UTF-8 character
-            """
-            pos = 0
-            for i, c in enumerate(reversed(data)):
-                if c & 0x80 == 0x00 or c & 0xE0 == 0xC0 or c & 0xF0 == 0xE0 or c & 0xF8 == 0xF0:
-                    pos = i
-                    break
-            return len(data) - pos
-
-        def _read(self, fd):
-            try:
-                data = os.read(fd, 2**16)  # read as much as possible
-            except OSError:
-                data = b""
-
-            if data:
-                self._read_buf += data
-                i = self.find_utf8_split(self._read_buf)
-                output = self._read_buf[:i]
-                self._read_buf = self._read_buf[i:]
-                self.stdout_callback(output)
-            else:
-                self.logger.info("Spawned process has been killed")
-                if self.running:
-                    self.running = False
-                    self.terminated_callback()
-                    os.close(fd)
-
-        def spawn(self):
-            super().spawn()
-            self._read_notifier = QSocketNotifier(self.fd, QSocketNotifier.Read)
-            self._read_notifier.activated.connect(self._read)
-
-        def write(self, buffer):
-            # same as original method, but without logging and without assert (unneeded)
-            if not self.running:
-                return
-            try:
-                os.write(self.fd, buffer)
-            except OSError:
-                self.running = False
-                self.terminated_callback()
-
-else:
-    terminal_cmd = "cmd.exe"
-    from termqt import TerminalWinptyIO as TerminalExecIO
-
-
-class TerminalWidget(QWidget):
-    def __init__(self, logger):
-        super().__init__()
-        self.logger = logger
-        self.terminal = Terminal(800, 600, logger=self.logger)
-        self.terminal.set_font()
-        self.terminal.maximum_line_history = 2000
-        self.scroll = QScrollBar(Qt.Vertical, self.terminal)
-        self.terminal.connect_scroll_bar(self.scroll)
-
-        layout = QHBoxLayout()
-        layout.addWidget(self.terminal)
-        layout.addWidget(self.scroll)
-        layout.setSpacing(0)
-        self.setLayout(layout)
-
-
-class BECConsole(QWidget):
-    def __init__(self):
-        super().__init__()
-        self.setWindowTitle(f"termqt on {platform.system()}")
-        self.logger = self.setup_logger()
-
-        self.terminal_widget = TerminalWidget(self.logger)
-
-        layout = QHBoxLayout()
-        layout.addWidget(self.terminal_widget)
-        self.setLayout(layout)
-
-        self.auto_wrap_enabled = True
-        self.platform = platform.system()
-
-        self.setup_terminal_io()
-
-    def setup_logger(self):
-        logger = logging.getLogger()
-        logger.setLevel(logging.DEBUG)
-        handler = logging.StreamHandler()
-        formatter = logging.Formatter("[%(asctime)s] > [%(filename)s:%(lineno)d] %(message)s")
-        handler.setFormatter(formatter)
-        logger.addHandler(handler)
-        return logger
-
-    def setup_terminal_io(self):
-        self.terminal_io = TerminalExecIO(
-            self.terminal_widget.terminal.row_len,
-            self.terminal_widget.terminal.col_len,
-            terminal_cmd,
-            logger=self.logger,
-        )
-        self.auto_wrap_enabled = False
-
-        self.terminal_widget.terminal.enable_auto_wrap(self.auto_wrap_enabled)
-        self.terminal_io.stdout_callback = self.terminal_widget.terminal.stdout
-        self.terminal_widget.terminal.stdin_callback = self.terminal_io.write
-        self.terminal_widget.terminal.resize_callback = self.terminal_io.resize
-        self.terminal_io.spawn()
-
-
-if __name__ == "__main__":
-    app = QApplication([])
-    main_window = BECConsole()
-    main_window.show()
-    sys.exit(app.exec())

bec_widgets/widgets/round_status_indicator/round_status_indicator.py

@@ -0,0 +1,108 @@
+from enum import Enum
+from typing import Literal
+
+from PyQt6.QtGui import QPaintEvent
+from qtpy import QtGui
+from qtpy.QtCore import QRect, Qt
+from qtpy.QtWidgets import QApplication, QMainWindow, QWidget
+
+from bec_widgets.utils.bec_connector import BECConnector, ConnectionConfig
+
+
+class RoundStatusIndicatorConfig(ConnectionConfig):
+    """
+    Configuration for the RoundStatusIndicator
+    """
+
+    state: Literal["success", "failure", "warning"] = "success"
+
+
+class RoundStatusIndicator(BECConnector, QWidget):
+
+    indicator_config = {
+        "success": {"color": "#24a148", "text": "✔", "offset": 0.25},
+        "failure": {"color": "#da1e28", "text": "✘", "offset": 0.28},
+        "warning": {"color": "#ffcc00", "text": "!", "offset": 0.28},
+    }
+
+    USER_ACCESS = ["set_state"]
+
+    def __init__(
+        self,
+        client=None,
+        config: RoundStatusIndicatorConfig | dict | None = None,
+        gui_id=None,
+        parent=None,
+    ):
+        super().__init__(client=client, config=config, gui_id=gui_id)
+        QWidget.__init__(self, parent=parent)
+        self.config = config or RoundStatusIndicatorConfig(widget_class=self.__class__.__name__)
+        self.active_state_config = self.indicator_config[self.config.state]
+
+    def paintEvent(self, _event: QPaintEvent) -> None:
+        """
+        Paint the widget.
+
+        Args:
+            _event (QPaintEvent): The paint event
+        """
+
+        color = QtGui.QColor(self.active_state_config["color"])  # Red color as default
+        text_color = QtGui.QColor("#ffffff")  # White color for text
+        text = self.active_state_config["text"]
+        offset = self.active_state_config["offset"]
+
+        painter = QtGui.QPainter(self)
+        painter.setRenderHint(QtGui.QPainter.RenderHint.Antialiasing)
+
+        # Determine the size of the widget
+        size = min(self.width(), self.height())
+        rect = QRect(0, 0, size, size)
+
+        # Set the color and draw the disk
+        painter.setBrush(color)
+        painter.setPen(Qt.PenStyle.NoPen)
+        painter.drawEllipse(rect)
+
+        # Draw the exclamation mark "!"
+        painter.setPen(text_color)
+        font = painter.font()
+        font.setPixelSize(int(size * 0.9))  # Adjust font size based on widget size
+        painter.setFont(font)
+
+        # text_rect = painter.boundingRect(rect, Qt.AlignmentFlag.AlignCenter, text)
+
+        font_metrics = QtGui.QFontMetrics(font)
+        text_width = font_metrics.horizontalAdvance(text)
+        text_height = font_metrics.height()
+
+        text_x = int(rect.center().x() - text_width / 2)
+        text_y = int(rect.center().y() + text_height * offset)
+        painter.drawText(text_x, text_y, text)
+
+    def set_state(self, state: Literal["success", "failure", "warning"]) -> None:
+        """
+        Set the state of the indicator.
+
+        Args:
+            state (str): The state of the indicator. Can be "success", "failure", or "warning"
+
+        """
+        self.config.state = state
+        self.active_state_config = self.indicator_config[state]
+        self.update()
+
+
+if __name__ == "__main__":
+    app = QApplication([])
+
+    window = QMainWindow()
+    status_indicator = RoundStatusIndicator()
+    window.setCentralWidget(status_indicator)
+    window.resize(200, 200)
+    window.show()
+
+    # Example of changing the color
+    status_indicator.set_state("warning")  # Change to a different color
+
+    app.exec()

bec_widgets/widgets/text_box/text_box.py

@@ -0,0 +1,127 @@
+import re
+
+from pydantic import Field, field_validator
+from qtpy.QtWidgets import QTextEdit
+
+from bec_widgets.utils.bec_connector import BECConnector, ConnectionConfig
+from bec_widgets.utils.colors import Colors
+
+
+class TextBoxConfig(ConnectionConfig):
+
+    theme: str = Field("dark", description="The theme of the figure widget.")
+    font_color: str = Field("#FFF", description="The font color of the text")
+    background_color: str = Field("#000", description="The background color of the widget.")
+    font_size: int = Field(16, description="The font size of the text in the widget.")
+    text: str = Field("", description="The text to display in the widget.")
+
+    @classmethod
+    @field_validator("theme")
+    def validate_theme(cls, v):
+        """Validate the theme of the figure widget."""
+        if v not in ["dark", "light"]:
+            raise ValueError("Theme must be either 'dark' or 'light'")
+        return v
+
+    _validate_font_color = field_validator("font_color")(Colors.validate_color)
+    _validate_background_color = field_validator("background_color")(Colors.validate_color)
+
+
+class TextBox(BECConnector, QTextEdit):
+
+    USER_ACCESS = ["set_color", "set_text", "set_font_size"]
+
+    def __init__(self, text: str = "", parent=None, client=None, config=None, gui_id=None):
+        if config is None:
+            config = TextBoxConfig(widget_class=self.__class__.__name__)
+        else:
+            if isinstance(config, dict):
+                config = TextBoxConfig(**config)
+            self.config = config
+        super().__init__(client=client, config=config, gui_id=gui_id)
+        QTextEdit.__init__(self, parent=parent)
+
+        self.config = config
+        self.setReadOnly(True)
+        self.setGeometry(self.rect())
+        self.set_color(self.config.background_color, self.config.font_color)
+        if not text:
+            text = "<h1>Welcome to the BEC Widget TextBox</h1><p>A widget that allows user to display text in plain and HTML format.</p><p>This is an example of displaying HTML text.</p>"
+        self.set_text(text)
+
+    def change_theme(self) -> None:
+        """
+        Change the theme of the figure widget.
+        """
+        if self.config.theme == "dark":
+            theme = "light"
+            font_color = "#000"
+            background_color = "#FFF"
+        else:
+            theme = "dark"
+            font_color = "#FFF"
+            background_color = "#000"
+        self.config.theme = theme
+        self.set_color(background_color, font_color)
+
+    def set_color(self, background_color: str, font_color: str) -> None:
+        """Set the background color of the widget.
+
+        Args:
+            background_color (str): The color to set the background in HEX.
+            font_color (str): The color to set the font in HEX.
+
+        """
+        self.config.background_color = background_color
+        self.config.font_color = font_color
+        self._update_stylesheet()
+
+    def set_font_size(self, size: int) -> None:
+        """Set the font size of the text in the widget.
+
+        Args:
+            size (int): The font size to set.
+        """
+        self.config.font_size = size
+        self._update_stylesheet()
+
+    def _update_stylesheet(self):
+        """Update the stylesheet of the widget."""
+        self.setStyleSheet(
+            f"background-color: {self.config.background_color}; color: {self.config.font_color}; font-size: {self.config.font_size}px"
+        )
+
+    def set_text(self, text: str) -> None:
+        """Set the text of the widget.
+
+        Args:
+            text (str): The text to set.
+        """
+        if self.is_html(text):
+            self.setHtml(text)
+        else:
+            self.setPlainText(text)
+        self.config.text = text
+
+    def is_html(self, text: str) -> bool:
+        """Check if the text contains HTML tags.
+
+        Args:
+            text (str): The text to check.
+
+        Returns:
+            bool: True if the text contains HTML tags, False otherwise.
+        """
+        return bool(re.search(r"<[a-zA-Z/][^>]*>", text))
+
+
+if __name__ == "__main__":
+    import sys
+
+    from qtpy.QtWidgets import QApplication
+
+    app = QApplication(sys.argv)
+
+    widget = TextBox()
+    widget.show()
+    sys.exit(app.exec())

docs/developer/developer.md

@@ -1,18 +1,46 @@
 (developer)=
-# Development
+# Developer 
 
-To contribute to the development of BEC Widgets, start by setting up the development environment:
+Welcome to the BEC Widgets developer guide! This section is intended for developers who want to contribute to the development of BEC Widgets.
 
-1. **Clone the Repository**: 
-```bash
-git clone https://gitlab.psi.ch/bec/bec_widgets
-cd bec_widgets
-```
-2. **Install in Editable Mode**:
+```{toctree}
+---
+maxdepth: 2
+hidden: true
+---
 
-Installing the package in editable mode allows you to make changes to the code and test them in real-time.
-```bash
-pip install -e .[dev,pyqt6]
+getting_started/getting_started.md
+widgets/widgets.md
+api_reference/api_reference.md
 ```
 
 
+***
+
+````{grid} 2
+:gutter: 5
+
+```{grid-item-card}
+:link: developer.getting_started
+:link-type: ref
+:img-top: /assets/rocket_launch_48dp.svg
+:text-align: center
+
+## Getting Started
+
+Learn how to install BEC Widgets and get started with the framework.
+```
+
+```{grid-item-card}
+:link: developer.widgets
+:link-type: ref
+:img-top: /assets/apps_48dp.svg
+:text-align: center
+
+## Widgets
+
+Learn about the building blocks of larger applications: widgets.
+```
+````
+
+

docs/developer/getting_started/development.md

@@ -0,0 +1,27 @@
+(developer.development)=
+# Development
+
+If you like to contribute to the development of BEC Widgets, you can follow the steps below to set up your development environment.
+BEC Widgets works in conjunction with [BEC](https://bec.readthedocs.io/en/latest/). 
+Therefore, we recommend that you install BEC first following the [developer instructions](https://bec.readthedocs.io/en/latest/developer/getting_started/install_developer_env.html) and include BEC Widgets. 
+
+If you already have a BEC environment set up, you can install BEC Widgets in editable mode into your BEC Python environment.
+
+**Prerequisites**
+1. **Python Version:** BEC Widgets requires Python version 3.10 or higher. Verify your Python version to ensure compatibility.
+2. **BEC Installation:** BEC Widgets works in conjunction with BEC. While BEC is a dependency and will be installed automatically, you can find more information about BEC and its installation process in the [BEC documentation](https://beamline-experiment-control.readthedocs.io/en/latest/).
+
+**Clone the Repository**: 
+```bash
+git clone https://gitlab.psi.ch/bec/bec_widgets
+cd bec_widgets
+```
+**Install in Editable Mode**:
+
+Please install the package in editable mode into your BEC Python environemnt. 
+```bash
+pip install -e '.[dev,pyqt6]'
+```
+This installs the package together with [PyQT6](https://www.riverbankcomputing.com/static/Docs/PyQt6/introduction.html). 
+
+

docs/developer/getting_started/getting_started.md

@@ -0,0 +1,12 @@
+(developer.getting_started)=
+# Getting Started
+This section provides valuable information for developers who want to contribute to the development of BEC Widgets. The guide will help you set up the development environment, understand the modular development concept of BEC Widgets, and contribute to the project.
+
+```{toctree}
+---
+maxdepth: 2
+hidden: false
+---
+
+development/
+```

docs/developer/widgets/widgets.md

@@ -0,0 +1,12 @@
+(developer.widgets)=
+# Widgets
+This section provides an introduction to the building blocks of BEC Widgets: widgets. Widgets are the basic components of the graphical user interface (GUI) and are used to create larger applications. We will cover key topics such as how to develop new widgets or how to customise existing widgets. For details on the already available widgets and their usage, please refer to user section about [widgets](#user.widgets)
+
+```{toctree}
+---
+maxdepth: 2
+hidden: false
+---
+
+how_to_develop_a_widget/
+```

docs/user/getting_started/installation.md

@@ -9,7 +9,7 @@ Before installing BEC Widgets, please ensure the following requirements are met:
 
 **Standard Installation**
 
-To install BEC Widgets using the pip package manager, execute the following command in your terminal for getting the default PyQT6 version in your python environment:
+To install BEC Widgets using the pip package manager, execute the following command in your terminal for getting the default PyQT6 version into your python environment for BEC:
 
 
 ```bash

docs/user/widgets/text_box.md

@@ -0,0 +1,33 @@
+(user.widgets.text_box)=
+# [Text Box Widget](/api_reference/_autosummary/bec_widgets.cli.client.TextBox)
+**Purpose:**
+
+The Text Box Widget is a widget that allows you to display text within the BEC GUI. The widget can be used to display plain text or HTML text.
+
+**Key Features:**
+
+- set the text to display.
+- automatically detects if the text is plain text or HTML text.
+- set background color and font color.
+
+**Code example:**
+
+The following code snipped demonstrates how to create a `TextBox` widget using BEC Widgets within BEC.
+```python
+text_box = gui.add_dock().add_widget("TextBox")
+# set the text to display
+text_box.set_text("Hello, World!")
+# set the background color and font color
+text_box.set_color(backgroud_color="#FFF", font_color="#000")
+# set the text to display as HTML
+text_box.set_text("<h1>Welcome to BEC Widgets</h1><p>This is an example of displaying <strong>HTML</strong> text.</p>")
+```
+
+
+
+
+
+
+
+
+

docs/user/widgets/widgets.md

@@ -12,6 +12,7 @@ bec_figure/
 spiral_progress_bar/
 website/
 buttons/
+text_box/
 ```
 
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_widgets"
-version = "0.62.0"
+version = "0.63.2"
 description = "BEC Widgets"
 requires-python = ">=3.10"
 classifiers = [
@@ -25,7 +25,6 @@ dependencies = [
     "pyqtdarktheme",
     "black",              # needed for bw-generate-cli
     "isort",              # needed for bw-generate-cli
-    "termqt @ git+ssh://git@github.com:TerryGeng/termqt.git"
 ]
 
 
@@ -37,7 +36,6 @@ dev = [
     "pytest-xvfb",
     "coverage",
     "pytest-qt",
-    "isort",
     "fakeredis",
 ]
 pyqt5 = ["PyQt5>=5.9", "PyQtWebEngine>=5.9"]
@@ -50,6 +48,7 @@ Homepage = "https://gitlab.psi.ch/bec/bec_widgets"
 
 [project.scripts]
 bw-generate-cli = "bec_widgets.cli.generate_cli:main"
+bec-gui-server = "bec_widgets.cli.server:main"
 
 [tool.hatch.build.targets.wheel]
 include = ["*"]

tests/unit_tests/test_text_box_widget.py

@@ -0,0 +1,55 @@
+import re
+from unittest import mock
+
+import pytest
+
+from bec_widgets.widgets.text_box.text_box import TextBox
+
+from .client_mocks import mocked_client
+
+
+@pytest.fixture
+def text_box_widget(qtbot, mocked_client):
+    widget = TextBox(client=mocked_client)
+    qtbot.addWidget(widget)
+    qtbot.waitExposed(widget)
+    yield widget
+    widget.close()
+
+
+def test_textbox_widget(text_box_widget):
+    """Test the TextBox widget."""
+    text = "Hello World!"
+    text_box_widget.set_text(text)
+    assert text_box_widget.toPlainText() == text
+
+    text_box_widget.set_color("#FFDDC1", "#123456")
+    text_box_widget.set_font_size(20)
+    assert (
+        text_box_widget.styleSheet() == "background-color: #FFDDC1; color: #123456; font-size: 20px"
+    )
+    text_box_widget.set_color("white", "blue")
+    text_box_widget.set_font_size(14)
+    assert text_box_widget.styleSheet() == "background-color: white; color: blue; font-size: 14px"
+    text = "<h1>Welcome to PyQt6</h1><p>This is an example of displaying <strong>HTML</strong> text.</p>"
+    with mock.patch.object(text_box_widget, "setHtml") as mocked_set_html:
+        text_box_widget.set_text(text)
+        assert mocked_set_html.call_count == 1
+        assert mocked_set_html.call_args == mock.call(text)
+
+
+def test_textbox_change_theme(text_box_widget):
+    """Test change theme functionaility"""
+    # Default is dark theme
+    text_box_widget.change_theme()
+    assert text_box_widget.config.theme == "light"
+    assert (
+        text_box_widget.styleSheet()
+        == f"background-color: #FFF; color: #000; font-size: {text_box_widget.config.font_size}px"
+    )
+    text_box_widget.change_theme()
+    assert text_box_widget.config.theme == "dark"
+    assert (
+        text_box_widget.styleSheet()
+        == f"background-color: #000; color: #FFF; font-size: {text_box_widget.config.font_size}px"
+    )