1.3.2

Automatically generated by python-semantic-release

.gitlab-ci.yml

@@ -5,8 +5,12 @@ image: $CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX/python:3.11
 #commands to run in the Docker container before starting each job.
 variables:
   DOCKER_TLS_CERTDIR: ""
-  BEC_CORE_BRANCH: "main"
-  OPHYD_DEVICES_BRANCH: "main"
+  BEC_CORE_BRANCH:
+    description: bec branch
+    value: main
+  OPHYD_DEVICES_BRANCH:
+    description: ophyd_devices branch
+    value: main
   CHILD_PIPELINE_BRANCH: $CI_DEFAULT_BRANCH
 
 workflow:
@@ -43,13 +47,20 @@ stages:
   - export QTWEBENGINE_DISABLE_SANDBOX=1
 
 .clone-repos: &clone-repos
+  - echo -e "\033[35;1m Using branch $BEC_CORE_BRANCH of BEC CORE \033[0;m";
   - git clone --branch $BEC_CORE_BRANCH https://gitlab.psi.ch/bec/bec.git
+  - echo -e "\033[35;1m Using branch $OPHYD_DEVICES_BRANCH of OPHYD_DEVICES \033[0;m";
   - git clone --branch $OPHYD_DEVICES_BRANCH https://gitlab.psi.ch/bec/ophyd_devices.git
   - export OHPYD_DEVICES_PATH=$PWD/ophyd_devices
 
+.install-repos: &install-repos
+  - pip install -e ./ophyd_devices
+  - pip install -e ./bec/bec_lib[dev]
+  - pip install -e ./bec/bec_ipython_client
+
 .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
+  - apt-get install -y libgl1-mesa-glx libegl1-mesa x11-utils libxkbcommon-x11-0 libdbus-1-3 xvfb
   - *install-qt-webengine-deps
 
 before_script:
@@ -131,10 +142,9 @@ tests:
   script:
     - *clone-repos
     - *install-os-packages
-    - pip install -e ./bec/bec_lib[dev]
-    - pip install -e ./bec/bec_ipython_client
+    - *install-repos
     - pip install -e .[dev,pyqt6]
-    - coverage run --source=./bec_widgets -m pytest -v --junitxml=report.xml --random-order --full-trace ./tests/unit_tests
+    - coverage run --source=./bec_widgets -m pytest -v --junitxml=report.xml --maxfail=2 --random-order --full-trace ./tests/unit_tests
     - coverage report
     - coverage xml
   coverage: '/(?i)total.*? (100(?:\.0+)?\%|[1-9]?\d(?:\.\d+)?\%)$/'
@@ -144,6 +154,9 @@ tests:
       coverage_report:
         coverage_format: cobertura
         path: coverage.xml
+    paths:
+      - tests/reference_failures/
+    when: always
 
 test-matrix:
   parallel:
@@ -154,7 +167,6 @@ test-matrix:
           - "3.12"
         QT_PCKG:
           - "pyside6"
-          - "pyqt5"
           - "pyqt6"
 
   stage: AdditionalTests
@@ -167,11 +179,9 @@ test-matrix:
   script:
     - *clone-repos
     - *install-os-packages
-    - pip install -e ./bec/bec_lib[dev]
-    - pip install -e ./bec/bec_ipython_client
+    - *install-repos
     - pip install -e .[dev,$QT_PCKG]
-    - pytest -v --junitxml=report.xml --random-order ./tests/unit_tests
-  allow_failure: true
+    - pytest -v --maxfail=2 --junitxml=report.xml --random-order ./tests/unit_tests
 
 end-2-end-conda:
   stage: End2End
@@ -193,10 +203,9 @@ end-2-end-conda:
 
     - cd ./bec
     - source ./bin/install_bec_dev.sh -t
-
-    - pip install -e ./bec_lib[dev]
-    - pip install -e ./bec_ipython_client[dev]
     - cd ../
+    - pip install -e ./ophyd_devices
+
     - pip install -e .[dev,pyqt6]
     - cd ./tests/end-2-end
     - pytest -v --start-servers --flush-redis --random-order

.pylintrc

@@ -3,7 +3,7 @@
 # A comma-separated list of package or module names from where C extensions may
 # be loaded. Extensions are loading into the active Python interpreter and may
 # run arbitrary code.
-extension-pkg-allow-list=PyQt5, pyqtgraph
+extension-pkg-allow-list=PyQt6, PySide6, pyqtgraph
 
 # A comma-separated list of package or module names from where C extensions may
 # be loaded. Extensions are loading into the active Python interpreter and may

CHANGELOG.md

@@ -1,153 +1,172 @@
 # CHANGELOG
 
-## v0.74.1 (2024-06-26)
 
-### Build
+## v1.3.2 (2024-11-05)
 
-* build: added missing pytest-bec-e2e dependency; closes #219 ([`56fdae4`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/56fdae42757bdb9fa301c1e425a77e98b6eaf92b))
+### Bug Fixes
 
-* build: fixed dependency ranges; closes #135 ([`e6a06c9`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e6a06c9f43e0ad6bbfcfa550a2f580d2a27aff66))
+* fix(plot_base): legend text color is changed when changing dark-light theme ([`2304c9f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2304c9f8497c1ab1492f3e6690bb79b0464c0df8))
 
-### Chore
+### Build System
 
-* chore: sorted dependencies alphabetically ([`21c807f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/21c807f35831fdd1ef2e488ab90edae4719f0cb7))
+* build: PySide6 version fixed 6.7.2 ([`c6e48ec`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c6e48ec1fe5aaee6a7c7a6f930f1520cd439cdb2))
+
+
+## v1.3.1 (2024-10-31)
+
+### Bug Fixes
+
+* fix(ophyd_kind_util): Kind enums are imported from the bec widget util class ([`940ee65`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/940ee6552c1ee8d9b4e4a74c62351f2e133ab678))
+
+
+## v1.3.0 (2024-10-30)
+
+### Bug Fixes
+
+* fix(colors): extend color map validation for matplotlib and colorcet maps (if available) ([`14dd8c5`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/14dd8c5b2947c92f6643b888d71975e4e8d4ee88))
+
+### Features
+
+* feat(colormap_button): colormap button with menu to select colormap filtered by the colormap type ([`b039933`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b039933405e2fbe92bd81bd0748e79e8d443a741))
+
+
+## v1.2.0 (2024-10-25)
+
+### Features
+
+* feat(colors): evenly spaced color generation + new golden ratio calculation ([`40c9fea`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/40c9fea35f869ef52e05948dd1989bcd99f602e0))
+
+### Refactoring
+
+* refactor: add bec_lib version to statusbox ([`5d4b86e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/5d4b86e1c6e1800051afce4f991153e370767fa6))
+
+
+## v1.1.0 (2024-10-25)
+
+### Features
+
+* feat: add filter i/o utility class ([`0350833`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/0350833f36e0a7cadce4173f9b1d1fbfdf985375))
+
+### Refactoring
+
+* refactor: do not flush selection upon receiving config update; allow widgetIO to receive kwargs to be able to use get_value to receive string instead of int for QComboBox ([`91959e8`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/91959e82de8586934af3ebb5aaa0923930effc51))
+
+* refactor: allow to set selection in DeviceInput; automatic update of selection on device config update; cleanup ([`5eb15b7`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/5eb15b785f12e30eb8ccbc56d4ad9e759a4cf5eb))
+
+* refactor: cleanup, added device_signal for signal inputs ([`6fb2055`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6fb20552ff57978f4aeb79fd7f062f8d6b5581e7))
+
+### Testing
+
+* test(scan_control): tests added for grid_scan to ensure scan_args signal validity ([`acb7902`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/acb79020d4be546efc001ff47b6f5cdba2ee9375))
+
+
+## v1.0.2 (2024-10-22)
+
+### Bug Fixes
+
+* fix(scan_control): scan args signal fixed to emit list instead of hardcoded structure ([`4f5448c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4f5448cf51a204e077af162c7f0aed1f1a60e57a))
+
+
+## v1.0.1 (2024-10-22)
+
+### Bug Fixes
+
+* fix(waveform): added support for live_data and data access ([`7469c89`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7469c892c8076fc09e61f173df6920c551241cec))
+
+
+## v1.0.0 (2024-10-18)
+
+### Breaking
+
+* feat!: ability to disable scatter from waveform & compatible crosshair with down sampling ([`2ab12ed`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2ab12ed60abb995abc381d9330fdcf399796d9e5))
+
+### Bug Fixes
+
+* fix(crosshair): downsample clear markers ([`f9a889f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f9a889fc6d380b9e587edcb465203122ea0bffc1))
+
+
+## v0.119.0 (2024-10-17)
+
+### Bug Fixes
+
+* fix: fix syntax due to change of api for simulated devices ([`19f4e40`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/19f4e407e00ee242973ca4c3f90e4e41a4d3e315))
+
+* fix: remove wrongly scoped test ([`a23841b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a23841b2553dc7162da943715d58275c7dc39ed9))
+
+* fix: rename 'compact' property -> 'compact_view' ([`6982711`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6982711fea5fb8a73845ed7c0692e3ec53ef7871))
+
+* fix: Alignment 1D update, make app window a main window (in .ui file) ([`0015f0e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/0015f0e2d62adc02d3ef334e1f6dbb2d0288fec6))
+
+* fix: set (Minimum, Fixed) size policy on Stop button ([`523cc43`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/523cc435725b10b7d59a4477a1aaa24a1f3e37a2))
+
+### Features
+
+* feat: new PositionerGroup widget ([`af9655d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/af9655de0c541092437accfbaa779628a2f48ccb))
+
+* feat: add 'expand_popup' property to CompactPopupWidget
+
+This property tells if expand should show a popup (by default), or
+if the widget should expand in-place ([`e4121a0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e4121a01cb6b8d496e630cd43bc642b994b8f310))
+
+* feat: PositionerBox with a popup view ([`2615787`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/261578796f1de8ca9cab9b91659bc1484f7aa89d))
+
+* feat: emit 'device_selected' and 'scan_axis' from scan control widget ([`0b9b1a3`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/0b9b1a3c89a98505079f7d4078915b7bbfaa1e23))
+
+* feat: new 'device_selected' signals to ScanControl, ScanGroupBox, DeviceLineEdit ([`9801d27`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9801d2769eb0ee95c94ec0c011e1dac1407142ae))
+
+### Refactoring
+
+* refactor: redesign of scan selection and scan control boxes ([`a69d287`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a69d2870e2b3539739781d741b27b8599c0f4abd))
+
+* refactor: move add/remove bundle to scan group box ([`e3d0a7b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e3d0a7bbf9918dc16eb7227a178c310256ce570d))
+
+
+## v0.118.0 (2024-10-13)
 
 ### Documentation
 
-* docs: fixed doc string ([`f979a63`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f979a63d3d1a008f80e500510909750878ff4303))
+* docs(sphinx-build): adjusted pyside verion ([`b236951`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b23695167ab969f754a058ffdccca2b40f00a008))
 
-### Fix
+### Features
 
-* fix(rings): rings properties updated right after setting ([`c8b7367`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c8b7367815b095f8e4aa8b819481efb701f2e542))
+* feat(image): image widget can take data from monitor_1d endpoint ([`9ef1d1c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9ef1d1c9ac2178d9fa2e655942208f8abbdf5c1b))
 
-* fix(motor_map): motor map can be removed from BECFigure with .remove() ([`6b25abf`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6b25abff70280271e2eeb70450553c05d4b7c99c))
 
-### Test
+## v0.117.1 (2024-10-11)
 
-* test(bec_figure): tests for removing widgets with rpc e2e ([`a268caa`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a268caaa30711fcc7ece542d24578d74cbf65c77))
+### Bug Fixes
 
-## v0.74.0 (2024-06-25)
-
-### Documentation
-
-* docs(becfigure): docs added ([`a51b15d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a51b15da3f5e83e0c897a0342bdb05b9c677a179))
-
-### Feature
-
-* feat(waveform1d): dap LMFit model can be added to plot ([`1866ba6`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1866ba66c8e3526661beb13fff3e13af6a0ae562))
-
-### Test
-
-* test(waveform1d): dap e2e test added ([`7271b42`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7271b422f98ef9264970d708811c414b69a644db))
-
-## v0.73.2 (2024-06-25)
-
-### Fix
-
-* fix(vscode): only run terminate if the process is still alive ([`7120f3e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7120f3e93b054b788f15e2d5bcd688e3c140c1ce))
-
-* fix(rpc): trigger shutdown of server when gui is terminated ([`acc1318`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/acc13183e28030e3ca9af21bb081e1eed081622b))
-
-* fix(rpc): remove of calling "close" and waiting for gui_is_alive ([`f75fc19`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f75fc19c5b10022763252917ca473f404a25165a))
-
-## v0.73.1 (2024-06-25)
-
-### Fix
-
-* fix(ringprogressbar): removed hard-coded endpoint strings ([`1de3cbf`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1de3cbf65a1832150917a7549a1bf3efdee6371a))
-
-## v0.73.0 (2024-06-25)
-
-### Feature
-
-* feat: add new default scaling of image_item ([`df812ea`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/df812eaad5989f2930dde41d87491868505af946))
-
-### Test
-
-* test: add test for imageitem ([`88ecd05`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/88ecd05b95974938ef1efff40e81854baf004cb4))
-
-## v0.72.2 (2024-06-25)
-
-### Fix
-
-* fix(designer): fixed designer for pyenv and venv; closes #237 ([`e631fc1`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e631fc15d8707b73d58cb64316e115a7e43961ea))
-
-## v0.72.1 (2024-06-24)
-
-### Fix
-
-* fix: renamed spiral progress bar to ring progress bar; closes #235 ([`e5c0087`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e5c0087c9aed831edbe1c172746325a772a3bafa))
-
-### Test
-
-* test: bugfix to prohibit leackage of mock ([`4348ed1`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4348ed1bb2182da6bdecaf372d6db85279e60af8))
-
-## v0.72.0 (2024-06-24)
-
-### Feature
-
-* feat(connector): added threadpool wrapper ([`4ca1efe`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4ca1efeeb8955604069f7b98374c7f82e1a8da67))
+* fix(FPS): qtimer cleanup leaking ([`3a22392`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3a2239278075de7489ad10a58c31d7d89715e221))
 
 ### Unknown
 
-* tests(status_box_test): temporary disabled tests for status_box due to high rate of failures ([`aa7ce2e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/aa7ce2ea27bb9564d4f5104bbff30725b8656453))
+* feature(vscode): added support for vscode instructions ([`f5f1f6c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f5f1f6c304b890dc162e8653005233bce4ea82e4))
 
-## v0.71.1 (2024-06-23)
+* feature(vscode): support for controlling vscode from widgets ([`9238679`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/923867947f62db026ac0378c30ef62c883596058))
 
-### Fix
 
-* fix: don't print exception if the auto-update module cannot be found in plugins ([`860517a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/860517a3211075d1f6e2af7fa6a567b9e0cd77f3))
+## v0.117.0 (2024-10-11)
 
-## v0.71.0 (2024-06-23)
+### Features
 
-### Feature
-
-* feat(scan_group_box): scan box for args and kwargs separated from ScanControlGUI code ([`d8cf441`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/d8cf44134c30063e586771f9068947fef7a306d1))
-
-### Fix
-
-* fix(cleanup): cleanup added to device_input widgets and scan_control ([`8badb6a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/8badb6adc1d003dbf0b2b1a800c34821f3fc9aa3))
-
-* fix(scan_group_box): added row counter based on widgets ([`37682e7`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/37682e7b8a6ede38308880d285e41a948d6fe831))
-
-* fix(scan_control): added default min limit for args bundle if specified ([`ec4574e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ec4574ed5c2c85ea6fbbe2b98f162a8e1220653b))
-
-* fix(scan_control): argbox delete later added to prevent overlapping gui if scan changed ([`7ce3a83`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7ce3a83c58cb69c2bf7cb7f4eaba7e6a2ca6c546))
-
-* fix(scan_control): only scans with defined gui_config are allowed ([`6dff187`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6dff1879c4178df0f8ebfd35101acdebb028d572))
-
-* fix(WidgetIO): find handlers within base classes ([`ca85638`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/ca856384f380dabf28d43f1cd48511af784c035b))
-
-* fix(scan_control): adapted widget to scan BEC gui config ([`8b822e0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/8b822e0fa8e28f080b9a4bf81948a7280a4c07bf))
-
-* fix(scan_control): scan_control.py combatible with the newest BEC versions, test disabled ([`67d398c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/67d398caf74e08ab25a70cc5d85a5f0c2de8212d))
-
-### Refactor
-
-* refactor(device_line_edit): renamed default_device to default ([`4e2c9df`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4e2c9df6a4979d935285fd7eba17fd7fd455a35c))
-
-### Test
-
-* test(scan_control): tests added ([`56e74a0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/56e74a0e7da72d18e89bc30d1896dbf9ef97cd6b))
+* feat(utils): FPS counter utility based on the viewBox updates, integrated to waveform and image widget ([`8c5ef26`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/8c5ef268430d5243ac05fcbbdb6b76ad24ac5735))
 
 ### Unknown
 
-* test(scan_control):e2e tests added ([`83001a0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/83001a0d8267e1320549b07032857dcf46ecd293))
+* tests(plot_base): tests extended ([`8dc892d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/8dc892df0a47ccbdd812555b7c5775a455a23ede))
 
-* doc(scan_control): docs added ([`1b7921a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/1b7921a7f2e3bcc846219a2a7aa0de0fd27bb8fe))
 
-* fix(device_line_edit):SizePolicy fixed for 100 horizontal ([`21d20e0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/21d20e0fc78e9a3853abe802733388cce119ce20))
+## v0.116.0 (2024-10-11)
 
-* tests WIP ([`c09644b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c09644b29ddb291c91dc58bcd6ebf02ff45cab36))
+### Features
 
-## v0.70.0 (2024-06-21)
+* feat: UI changes to have top toolbar with compact popup widgets (fix issue #360) ([`499b6b9`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/499b6b9a12efd931b5728b519404c41a7e29e4d6))
 
-### Feature
+* feat: adapt BECQueue and BECStatusBox widgets to use CompactPopupWidget ([`94ce92f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/94ce92f5b054d25ea3bb7976c1f75e14b78b9edc))
 
-* feat(bec-designer): automatic plugin discovery ([`4639eee`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4639eee0b975ebd7a946e0e290449f5b88c372eb))
+* feat: add 'CompactPopupWidget' container widget
 
-* feat(device_line_edit): plugin added to bec-designer ([`b4b27ae`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b4b27aea3d8c08fa3d5d5514c69dbde32721d1dc))
-
-### Fix
-
-* fix(bec-desiger+plugins): imports fixed, PYSIDE6 check to not enable run plugins with pyqt6 ([`50b3422`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/50b3422528d46d74317e8c903b6286e868ab7fe0))
+Makes it easy to write widgets which can have a compact
+representation with LED-like global state indicator,
+with the possibility to display a popup dialog with more
+complete UI ([`49268e3`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/49268e3829406d70b09e4d88989812f5578e46f4))

README.md

@@ -17,7 +17,7 @@ cd bec_widgets
 pip install -e .[dev,pyqt6]
 ```
 
-BEC Widgets currently supports both PyQt5 and PyQt6, however, no default distribution is specified. As a result, users must install one of the supported
+BEC Widgets currently supports both Pyside6 and PyQt6, however, no default distribution is specified. As a result, users must install one of the supported
 Python Qt distributions manually.
 
 To select a specific Python Qt distribution, install the package with an additional tag:
@@ -28,7 +28,7 @@ pip install bec_widgets[pyqt6]
 or 
 
 ```bash
-pip install bec_widgets[pyqt5]
+pip install bec_widgets[pyside6]
 ```
 ## Documentation
 

bec_widgets/applications/alignment/alignment_1d/alignment_1d.py

@@ -0,0 +1,209 @@
+""" This module contains the GUI for the 1D alignment application.
+It is a preliminary version of the GUI, which will be added to the main branch and steadily updated to be improved.
+"""
+
+import os
+from typing import Optional
+
+from bec_lib.device import Positioner as BECPositioner
+from bec_lib.device import Signal as BECSignal
+from bec_lib.endpoints import MessageEndpoints
+from bec_lib.logger import bec_logger
+from qtpy.QtCore import QSize, Signal
+from qtpy.QtGui import QIcon
+from qtpy.QtWidgets import (
+    QApplication,
+    QCheckBox,
+    QDoubleSpinBox,
+    QMainWindow,
+    QPushButton,
+    QSpinBox,
+)
+
+import bec_widgets
+from bec_widgets.qt_utils.error_popups import SafeSlot as Slot
+from bec_widgets.qt_utils.toolbar import WidgetAction
+from bec_widgets.utils import UILoader
+from bec_widgets.utils.bec_dispatcher import BECDispatcher
+from bec_widgets.utils.bec_widget import BECWidget
+from bec_widgets.utils.colors import get_accent_colors
+from bec_widgets.widgets.bec_progressbar.bec_progressbar import BECProgressBar
+from bec_widgets.widgets.device_line_edit.device_line_edit import DeviceLineEdit
+from bec_widgets.widgets.lmfit_dialog.lmfit_dialog import LMFitDialog
+from bec_widgets.widgets.positioner_box.positioner_box import PositionerBox
+from bec_widgets.widgets.positioner_group.positioner_group import PositionerGroup
+from bec_widgets.widgets.stop_button.stop_button import StopButton
+from bec_widgets.widgets.toggle.toggle import ToggleSwitch
+from bec_widgets.widgets.waveform.waveform_widget import BECWaveformWidget
+
+MODULE_PATH = os.path.dirname(bec_widgets.__file__)
+logger = bec_logger.logger
+
+
+class Alignment1D:
+    """Alignment GUI to perform 1D scans"""
+
+    def __init__(self, client=None, gui_id: Optional[str] = None) -> None:
+        """Initialization
+
+        Args:
+            config: Configuration of the application.
+            client: BEC client object.
+            gui_id: GUI ID.
+        """
+        self.bec_dispatcher = BECDispatcher(client=client)
+        self.client = self.bec_dispatcher.client if client is None else client
+        QApplication.instance().aboutToQuit.connect(self.close)
+        self.dev = self.client.device_manager.devices
+
+        self._accent_colors = get_accent_colors()
+        self.ui_file = "alignment_1d.ui"
+        self.ui = None
+        self.progress_bar = None
+        self.waveform = None
+        self.init_ui()
+
+    def init_ui(self):
+        """Initialise the UI from QT Designer file"""
+        current_path = os.path.dirname(__file__)
+        self.ui = UILoader(None).loader(os.path.join(current_path, self.ui_file))
+        # Customize the plotting widget
+        self.waveform = self.ui.findChild(BECWaveformWidget, "bec_waveform_widget")
+        self._customise_bec_waveform_widget()
+        # Setup comboboxes for motor and signal selection
+        # FIXME after changing the filtering in the combobox
+        self._setup_signal_combobox()
+        # Setup motor indicator
+        self._setup_motor_indicator()
+        # Setup progress bar
+        self._setup_progress_bar()
+        # Add actions buttons
+        self._customise_buttons()
+        # Hook scaninfo updates
+        self.bec_dispatcher.connect_slot(self.scan_status_callback, MessageEndpoints.scan_status())
+
+    def show(self):
+        return self.ui.show()
+
+    ##############################
+    ############ SLOTS ###########
+    ##############################
+
+    @Slot(dict, dict)
+    def scan_status_callback(self, content: dict, _) -> None:
+        """This slot allows to enable/disable the UI critical components when a scan is running"""
+        if content["status"] in ["open"]:
+            self.enable_ui(False)
+        elif content["status"] in ["aborted", "halted", "closed"]:
+            self.enable_ui(True)
+
+    @Slot(tuple)
+    def move_to_center(self, move_request: tuple) -> None:
+        """Move the selected motor to the center"""
+        motor = self.ui.device_combobox.currentText()
+        if move_request[0] in ["center", "center1", "center2"]:
+            pos = move_request[1]
+        self.dev.get(motor).move(float(pos), relative=False)
+
+    @Slot()
+    def reset_progress_bar(self) -> None:
+        """Reset the progress bar"""
+        self.progress_bar.set_value(0)
+        self.progress_bar.set_minimum(0)
+
+    @Slot(dict, dict)
+    def update_progress_bar(self, content: dict, _) -> None:
+        """Hook to update the progress bar
+
+        Args:
+            content: Content of the scan progress message.
+            metadata: Metadata of the message.
+        """
+        if content["max_value"] == 0:
+            self.progress_bar.set_value(0)
+            return
+        self.progress_bar.set_maximum(content["max_value"])
+        self.progress_bar.set_value(content["value"])
+
+    @Slot()
+    def clear_queue(self) -> None:
+        """Clear the scan queue"""
+        self.queue.request_queue_reset()
+
+    ##############################
+    ######## END OF SLOTS ########
+    ##############################
+
+    def enable_ui(self, enable: bool) -> None:
+        """Enable or disable the UI components"""
+        # Enable/disable motor and signal selection
+        self.ui.device_combobox_2.setEnabled(enable)
+        # Enable/disable DAP selection
+        self.ui.dap_combo_box.setEnabled(enable)
+        # Enable/disable Scan Button
+        # self.ui.scan_button.setEnabled(enable)
+        # Disable move to buttons in LMFitDialog
+        self.ui.findChild(LMFitDialog).set_actions_enabled(enable)
+
+    def _customise_buttons(self) -> None:
+        """Add action buttons for the Action Control.
+        In addition, we are adding a callback to also clear the queue to the stop button
+        to ensure that upon clicking the button, no scans from another client may be queued
+        which would be confusing without the queue widget.
+        """
+        fit_dialog = self.ui.findChild(LMFitDialog)
+        fit_dialog.active_action_list = ["center", "center1", "center2"]
+        fit_dialog.move_action.connect(self.move_to_center)
+        stop_button = self.ui.findChild(StopButton)
+        stop_button.button.setText("Stop and Clear Queue")
+        stop_button.button.clicked.connect(self.clear_queue)
+
+    def _customise_bec_waveform_widget(self) -> None:
+        """Customise the BEC Waveform Widget, i.e. clear the toolbar"""
+        self.waveform.toolbar.clear()
+
+    def _setup_motor_indicator(self) -> None:
+        """Setup the arrow item"""
+        self.waveform.waveform.tick_item.add_to_plot()
+        positioner_box = self.ui.findChild(PositionerGroup)
+        positioner_box.position_update.connect(self.waveform.waveform.tick_item.set_position)
+        self.waveform.waveform.tick_item.set_position(0)
+
+    def _setup_signal_combobox(self) -> None:
+        """Setup signal selection"""
+        # FIXME after changing the filtering in the combobox
+        signals = [name for name in self.dev if isinstance(self.dev.get(name), BECSignal)]
+        self.ui.device_combobox_2.setCurrentText(signals[0])
+        self.ui.device_combobox_2.set_device_filter("Signal")
+
+    def _setup_progress_bar(self) -> None:
+        """Setup progress bar"""
+        # FIXME once the BECScanProgressBar is implemented
+        self.progress_bar = self.ui.findChild(BECProgressBar, "bec_progress_bar")
+        self.progress_bar.set_value(0)
+        self.ui.bec_waveform_widget.new_scan.connect(self.reset_progress_bar)
+        self.bec_dispatcher.connect_slot(self.update_progress_bar, MessageEndpoints.scan_progress())
+
+    def close(self):
+        logger.info("Disconnecting", repr(self.bec_dispatcher))
+        self.bec_dispatcher.disconnect_all()
+        logger.info("Shutting down BEC Client", repr(self.client))
+        self.client.shutdown()
+
+
+def main():
+    import sys
+
+    app = QApplication(sys.argv)
+    icon = QIcon()
+    icon.addFile(
+        os.path.join(MODULE_PATH, "assets", "app_icons", "alignment_1d.png"), size=QSize(48, 48)
+    )
+    app.setWindowIcon(icon)
+    window = Alignment1D()
+    window.show()
+    sys.exit(app.exec_())
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

bec_widgets/applications/alignment/alignment_1d/alignment_1d.ui

@@ -0,0 +1,615 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>mainWindow</class>
+ <widget class="QMainWindow" name="mainWindow">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>1611</width>
+    <height>1019</height>
+   </rect>
+  </property>
+  <property name="windowTitle">
+   <string>Alignment tool</string>
+  </property>
+  <widget class="QWidget" name="widget">
+   <layout class="QVBoxLayout" name="verticalLayout_2">
+    <item>
+     <widget class="QWidget" name="widget" native="true">
+      <property name="sizePolicy">
+       <sizepolicy hsizetype="Preferred" vsizetype="Fixed">
+        <horstretch>0</horstretch>
+        <verstretch>0</verstretch>
+       </sizepolicy>
+      </property>
+      <layout class="QHBoxLayout" name="horizontalLayout_5">
+       <item>
+        <widget class="DarkModeButton" name="dark_mode_button"/>
+       </item>
+       <item>
+        <spacer name="horizontalSpacer_6">
+         <property name="orientation">
+          <enum>Qt::Orientation::Horizontal</enum>
+         </property>
+         <property name="sizeHint" stdset="0">
+          <size>
+           <width>40</width>
+           <height>20</height>
+          </size>
+         </property>
+        </spacer>
+       </item>
+       <item>
+        <widget class="BECStatusBox" name="bec_status_box">
+         <property name="compact_view" stdset="0">
+          <bool>true</bool>
+         </property>
+         <property name="label" stdset="0">
+          <string>BEC Servers</string>
+         </property>
+        </widget>
+       </item>
+       <item>
+        <spacer name="horizontalSpacer_3">
+         <property name="orientation">
+          <enum>Qt::Orientation::Horizontal</enum>
+         </property>
+         <property name="sizeHint" stdset="0">
+          <size>
+           <width>40</width>
+           <height>20</height>
+          </size>
+         </property>
+        </spacer>
+       </item>
+       <item>
+        <widget class="BECQueue" name="bec_queue">
+         <property name="compact_view" stdset="0">
+          <bool>true</bool>
+         </property>
+        </widget>
+       </item>
+       <item>
+        <spacer name="horizontalSpacer_5">
+         <property name="orientation">
+          <enum>Qt::Orientation::Horizontal</enum>
+         </property>
+         <property name="sizeHint" stdset="0">
+          <size>
+           <width>40</width>
+           <height>20</height>
+          </size>
+         </property>
+        </spacer>
+       </item>
+       <item>
+        <widget class="QRadioButton" name="radioButton">
+         <property name="enabled">
+          <bool>false</bool>
+         </property>
+         <property name="text">
+          <string>SLS Light On</string>
+         </property>
+         <property name="checkable">
+          <bool>true</bool>
+         </property>
+         <property name="checked">
+          <bool>true</bool>
+         </property>
+         <property name="autoExclusive">
+          <bool>false</bool>
+         </property>
+        </widget>
+       </item>
+       <item>
+        <spacer name="horizontalSpacer_7">
+         <property name="orientation">
+          <enum>Qt::Orientation::Horizontal</enum>
+         </property>
+         <property name="sizeHint" stdset="0">
+          <size>
+           <width>40</width>
+           <height>20</height>
+          </size>
+         </property>
+        </spacer>
+       </item>
+       <item>
+        <widget class="QRadioButton" name="radioButton_3">
+         <property name="enabled">
+          <bool>false</bool>
+         </property>
+         <property name="text">
+          <string>BEAMLINE Checks</string>
+         </property>
+         <property name="checkable">
+          <bool>true</bool>
+         </property>
+         <property name="checked">
+          <bool>true</bool>
+         </property>
+         <property name="autoExclusive">
+          <bool>false</bool>
+         </property>
+        </widget>
+       </item>
+       <item>
+        <spacer name="horizontalSpacer_4">
+         <property name="orientation">
+          <enum>Qt::Orientation::Horizontal</enum>
+         </property>
+         <property name="sizeHint" stdset="0">
+          <size>
+           <width>40</width>
+           <height>20</height>
+          </size>
+         </property>
+        </spacer>
+       </item>
+       <item>
+        <widget class="StopButton" name="stop_button">
+         <property name="sizePolicy">
+          <sizepolicy hsizetype="MinimumExpanding" vsizetype="MinimumExpanding">
+           <horstretch>0</horstretch>
+           <verstretch>0</verstretch>
+          </sizepolicy>
+         </property>
+         <property name="minimumSize">
+          <size>
+           <width>200</width>
+           <height>40</height>
+          </size>
+         </property>
+         <property name="maximumSize">
+          <size>
+           <width>200</width>
+           <height>40</height>
+          </size>
+         </property>
+        </widget>
+       </item>
+      </layout>
+     </widget>
+    </item>
+    <item>
+     <widget class="BECProgressBar" name="bec_progress_bar">
+      <property name="minimumSize">
+       <size>
+        <width>0</width>
+        <height>25</height>
+       </size>
+      </property>
+      <property name="maximumSize">
+       <size>
+        <width>16777215</width>
+        <height>25</height>
+       </size>
+      </property>
+     </widget>
+    </item>
+    <item>
+     <widget class="QTabWidget" name="tabWidget">
+      <property name="sizePolicy">
+       <sizepolicy hsizetype="Expanding" vsizetype="Expanding">
+        <horstretch>0</horstretch>
+        <verstretch>0</verstretch>
+       </sizepolicy>
+      </property>
+      <property name="currentIndex">
+       <number>0</number>
+      </property>
+      <widget class="QWidget" name="ControlTab">
+       <attribute name="title">
+        <string>Alignment Control</string>
+       </attribute>
+       <layout class="QHBoxLayout" name="horizontalLayout_6">
+        <item>
+         <widget class="QWidget" name="widget_4" native="true">
+          <property name="sizePolicy">
+           <sizepolicy hsizetype="Preferred" vsizetype="Preferred">
+            <horstretch>1</horstretch>
+            <verstretch>0</verstretch>
+           </sizepolicy>
+          </property>
+          <layout class="QVBoxLayout" name="verticalLayout_3">
+           <item>
+            <widget class="ScanControl" name="scan_control">
+             <property name="current_scan" stdset="0">
+              <string>line_scan</string>
+             </property>
+             <property name="hide_arg_box" stdset="0">
+              <bool>false</bool>
+             </property>
+             <property name="hide_scan_selection_combobox" stdset="0">
+              <bool>true</bool>
+             </property>
+             <property name="hide_add_remove_buttons" stdset="0">
+              <bool>true</bool>
+             </property>
+            </widget>
+           </item>
+           <item>
+            <widget class="PositionerGroup" name="positioner_group"/>
+           </item>
+           <item>
+            <spacer name="verticalSpacer">
+             <property name="orientation">
+              <enum>Qt::Orientation::Vertical</enum>
+             </property>
+             <property name="sizeHint" stdset="0">
+              <size>
+               <width>20</width>
+               <height>40</height>
+              </size>
+             </property>
+            </spacer>
+           </item>
+          </layout>
+         </widget>
+        </item>
+        <item>
+         <widget class="QWidget" name="widget_3" native="true">
+          <property name="sizePolicy">
+           <sizepolicy hsizetype="Preferred" vsizetype="Preferred">
+            <horstretch>4</horstretch>
+            <verstretch>0</verstretch>
+           </sizepolicy>
+          </property>
+          <layout class="QVBoxLayout" name="verticalLayout">
+           <item>
+            <widget class="QWidget" name="widget_2" native="true">
+             <property name="sizePolicy">
+              <sizepolicy hsizetype="Preferred" vsizetype="Fixed">
+               <horstretch>0</horstretch>
+               <verstretch>0</verstretch>
+              </sizepolicy>
+             </property>
+             <layout class="QHBoxLayout" name="horizontalLayout_3">
+              <item>
+               <widget class="QLabel" name="label_2">
+                <property name="font">
+                 <font/>
+                </property>
+                <property name="text">
+                 <string>Monitor</string>
+                </property>
+               </widget>
+              </item>
+              <item>
+               <widget class="DeviceComboBox" name="device_combobox_2"/>
+              </item>
+              <item>
+               <widget class="QLabel" name="label_3">
+                <property name="font">
+                 <font/>
+                </property>
+                <property name="text">
+                 <string>LMFit Model</string>
+                </property>
+               </widget>
+              </item>
+              <item>
+               <widget class="DapComboBox" name="dap_combo_box"/>
+              </item>
+              <item>
+               <widget class="QLabel" name="label">
+                <property name="text">
+                 <string>Enable ROI</string>
+                </property>
+               </widget>
+              </item>
+              <item>
+               <widget class="ToggleSwitch" name="toggle_switch">
+                <property name="sizePolicy">
+                 <sizepolicy hsizetype="Expanding" vsizetype="Expanding">
+                  <horstretch>3</horstretch>
+                  <verstretch>0</verstretch>
+                 </sizepolicy>
+                </property>
+                <property name="toolTip">
+                 <string>Activate linear region select for LMFit</string>
+                </property>
+                <property name="layoutDirection">
+                 <enum>Qt::LayoutDirection::LeftToRight</enum>
+                </property>
+                <property name="checked" stdset="0">
+                 <bool>false</bool>
+                </property>
+               </widget>
+              </item>
+              <item>
+               <spacer name="horizontalSpacer_8">
+                <property name="orientation">
+                 <enum>Qt::Orientation::Horizontal</enum>
+                </property>
+                <property name="sizeHint" stdset="0">
+                 <size>
+                  <width>40</width>
+                  <height>20</height>
+                 </size>
+                </property>
+               </spacer>
+              </item>
+             </layout>
+            </widget>
+           </item>
+           <item>
+            <widget class="BECWaveformWidget" name="bec_waveform_widget">
+             <property name="sizePolicy">
+              <sizepolicy hsizetype="Expanding" vsizetype="Expanding">
+               <horstretch>0</horstretch>
+               <verstretch>1</verstretch>
+              </sizepolicy>
+             </property>
+             <property name="minimumSize">
+              <size>
+               <width>600</width>
+               <height>450</height>
+              </size>
+             </property>
+             <property name="clear_curves_on_plot_update" stdset="0">
+              <bool>true</bool>
+             </property>
+            </widget>
+           </item>
+           <item>
+            <widget class="LMFitDialog" name="lm_fit_dialog">
+             <property name="sizePolicy">
+              <sizepolicy hsizetype="Preferred" vsizetype="Minimum">
+               <horstretch>0</horstretch>
+               <verstretch>0</verstretch>
+              </sizepolicy>
+             </property>
+             <property name="minimumSize">
+              <size>
+               <width>0</width>
+               <height>190</height>
+              </size>
+             </property>
+             <property name="always_show_latest" stdset="0">
+              <bool>true</bool>
+             </property>
+             <property name="hide_curve_selection" stdset="0">
+              <bool>true</bool>
+             </property>
+             <property name="hide_summary" stdset="0">
+              <bool>true</bool>
+             </property>
+            </widget>
+           </item>
+          </layout>
+         </widget>
+        </item>
+       </layout>
+      </widget>
+      <widget class="QWidget" name="tab_2">
+       <attribute name="title">
+        <string>Logbook</string>
+       </attribute>
+       <layout class="QHBoxLayout" name="horizontalLayout_4">
+        <property name="leftMargin">
+         <number>2</number>
+        </property>
+        <property name="topMargin">
+         <number>2</number>
+        </property>
+        <property name="rightMargin">
+         <number>2</number>
+        </property>
+        <property name="bottomMargin">
+         <number>2</number>
+        </property>
+        <item>
+         <widget class="WebsiteWidget" name="website_widget">
+          <property name="url" stdset="0">
+           <string>https://scilog.psi.ch/login</string>
+          </property>
+         </widget>
+        </item>
+       </layout>
+      </widget>
+     </widget>
+    </item>
+   </layout>
+  </widget>
+ </widget>
+ <customwidgets>
+  <customwidget>
+   <class>DapComboBox</class>
+   <extends>QWidget</extends>
+   <header>dap_combo_box</header>
+  </customwidget>
+  <customwidget>
+   <class>StopButton</class>
+   <extends>QWidget</extends>
+   <header>stop_button</header>
+  </customwidget>
+  <customwidget>
+   <class>WebsiteWidget</class>
+   <extends>QWidget</extends>
+   <header>website_widget</header>
+  </customwidget>
+  <customwidget>
+   <class>BECQueue</class>
+   <extends>QWidget</extends>
+   <header>bec_queue</header>
+  </customwidget>
+  <customwidget>
+   <class>ScanControl</class>
+   <extends>QWidget</extends>
+   <header>scan_control</header>
+  </customwidget>
+  <customwidget>
+   <class>ToggleSwitch</class>
+   <extends>QWidget</extends>
+   <header>toggle_switch</header>
+  </customwidget>
+  <customwidget>
+   <class>BECProgressBar</class>
+   <extends>QWidget</extends>
+   <header>bec_progress_bar</header>
+  </customwidget>
+  <customwidget>
+   <class>DarkModeButton</class>
+   <extends>QWidget</extends>
+   <header>dark_mode_button</header>
+  </customwidget>
+  <customwidget>
+   <class>PositionerGroup</class>
+   <extends>QWidget</extends>
+   <header>positioner_group</header>
+  </customwidget>
+  <customwidget>
+   <class>BECWaveformWidget</class>
+   <extends>QWidget</extends>
+   <header>bec_waveform_widget</header>
+  </customwidget>
+  <customwidget>
+   <class>DeviceComboBox</class>
+   <extends>QComboBox</extends>
+   <header>device_combobox</header>
+  </customwidget>
+  <customwidget>
+   <class>LMFitDialog</class>
+   <extends>QWidget</extends>
+   <header>lm_fit_dialog</header>
+  </customwidget>
+  <customwidget>
+   <class>BECStatusBox</class>
+   <extends>QWidget</extends>
+   <header>bec_status_box</header>
+  </customwidget>
+ </customwidgets>
+ <resources/>
+ <connections>
+  <connection>
+   <sender>toggle_switch</sender>
+   <signal>enabled(bool)</signal>
+   <receiver>bec_waveform_widget</receiver>
+   <slot>toogle_roi_select(bool)</slot>
+   <hints>
+    <hint type="sourcelabel">
+     <x>1042</x>
+     <y>212</y>
+    </hint>
+    <hint type="destinationlabel">
+     <x>1416</x>
+     <y>322</y>
+    </hint>
+   </hints>
+  </connection>
+  <connection>
+   <sender>bec_waveform_widget</sender>
+   <signal>dap_summary_update(QVariantMap,QVariantMap)</signal>
+   <receiver>lm_fit_dialog</receiver>
+   <slot>update_summary_tree(QVariantMap,QVariantMap)</slot>
+   <hints>
+    <hint type="sourcelabel">
+     <x>1099</x>
+     <y>258</y>
+    </hint>
+    <hint type="destinationlabel">
+     <x>1157</x>
+     <y>929</y>
+    </hint>
+   </hints>
+  </connection>
+  <connection>
+   <sender>device_combobox_2</sender>
+   <signal>currentTextChanged(QString)</signal>
+   <receiver>bec_waveform_widget</receiver>
+   <slot>plot(QString)</slot>
+   <hints>
+    <hint type="sourcelabel">
+     <x>577</x>
+     <y>215</y>
+    </hint>
+    <hint type="destinationlabel">
+     <x>1416</x>
+     <y>427</y>
+    </hint>
+   </hints>
+  </connection>
+  <connection>
+   <sender>device_combobox_2</sender>
+   <signal>currentTextChanged(QString)</signal>
+   <receiver>dap_combo_box</receiver>
+   <slot>select_y_axis(QString)</slot>
+   <hints>
+    <hint type="sourcelabel">
+     <x>577</x>
+     <y>215</y>
+    </hint>
+    <hint type="destinationlabel">
+     <x>909</x>
+     <y>215</y>
+    </hint>
+   </hints>
+  </connection>
+  <connection>
+   <sender>dap_combo_box</sender>
+   <signal>new_dap_config(QString,QString,QString)</signal>
+   <receiver>bec_waveform_widget</receiver>
+   <slot>add_dap(QString,QString,QString)</slot>
+   <hints>
+    <hint type="sourcelabel">
+     <x>909</x>
+     <y>215</y>
+    </hint>
+    <hint type="destinationlabel">
+     <x>1416</x>
+     <y>447</y>
+    </hint>
+   </hints>
+  </connection>
+  <connection>
+   <sender>scan_control</sender>
+   <signal>device_selected(QString)</signal>
+   <receiver>positioner_group</receiver>
+   <slot>set_positioners(QString)</slot>
+   <hints>
+    <hint type="sourcelabel">
+     <x>230</x>
+     <y>306</y>
+    </hint>
+    <hint type="destinationlabel">
+     <x>187</x>
+     <y>926</y>
+    </hint>
+   </hints>
+  </connection>
+  <connection>
+   <sender>scan_control</sender>
+   <signal>device_selected(QString)</signal>
+   <receiver>bec_waveform_widget</receiver>
+   <slot>set_x(QString)</slot>
+   <hints>
+    <hint type="sourcelabel">
+     <x>187</x>
+     <y>356</y>
+    </hint>
+    <hint type="destinationlabel">
+     <x>972</x>
+     <y>509</y>
+    </hint>
+   </hints>
+  </connection>
+  <connection>
+   <sender>scan_control</sender>
+   <signal>device_selected(QString)</signal>
+   <receiver>dap_combo_box</receiver>
+   <slot>select_x_axis(QString)</slot>
+   <hints>
+    <hint type="sourcelabel">
+     <x>187</x>
+     <y>356</y>
+    </hint>
+    <hint type="destinationlabel">
+     <x>794</x>
+     <y>202</y>
+    </hint>
+   </hints>
+  </connection>
+ </connections>
+</ui>

bec_widgets/applications/bec_app.py

@@ -0,0 +1,84 @@
+"""
+Launcher for BEC GUI Applications
+
+Application must be located in bec_widgets/applications ;
+in order for the launcher to find the application, it has to be put in
+a subdirectory with the same name as the main Python module:
+
+/bec_widgets/applications
+    ├── alignment
+    │   └── alignment_1d
+    │       └── alignment_1d.py
+    ├── other_app
+        └── other_app.py
+
+The tree above would contain 2 applications, alignment_1d and other_app.
+
+The Python module for the application must have `if __name__ == "__main__":`
+in order for the launcher to execute it (it is run with `python -m`).
+"""
+
+import argparse
+import os
+import sys
+
+MODULE_PATH = os.path.dirname(__file__)
+
+
+def find_apps(base_dir: str) -> list[str]:
+    matching_modules = []
+
+    for root, dirs, files in os.walk(base_dir):
+        parent_dir = os.path.basename(root)
+
+        for file in files:
+            if file.endswith(".py") and file != "__init__.py":
+                file_name_without_ext = os.path.splitext(file)[0]
+
+                if file_name_without_ext == parent_dir:
+                    rel_path = os.path.relpath(root, base_dir)
+                    module_path = rel_path.replace(os.sep, ".")
+
+                    module_name = f"{module_path}.{file_name_without_ext}"
+                    matching_modules.append((file_name_without_ext, module_name))
+
+    return matching_modules
+
+
+def main():
+    parser = argparse.ArgumentParser(description="BEC application launcher")
+
+    parser.add_argument("-m", "--module", type=str, help="The module to run (string argument).")
+
+    # Add a positional argument for the module, which acts as a fallback if -m is not provided
+    parser.add_argument(
+        "positional_module",
+        nargs="?",  # This makes the positional argument optional
+        help="Positional argument that is treated as module if -m is not specified.",
+    )
+
+    args = parser.parse_args()
+    # If the -m/--module is not provided, fallback to the positional argument
+    module = args.module if args.module else args.positional_module
+
+    if module:
+        for app_name, app_module in find_apps(MODULE_PATH):
+            if module in (app_name, app_module):
+                print("Starting:", app_name)
+                python_executable = sys.executable
+
+                # Replace the current process with the new Python module
+                os.execvp(
+                    python_executable,
+                    [python_executable, "-m", f"bec_widgets.applications.{app_module}"],
+                )
+        print(f"Error: cannot find application {module}")
+
+    # display list of apps
+    print("Available applications:")
+    for app, _ in find_apps(MODULE_PATH):
+        print(f"  - {app}")
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

bec_widgets/cli/auto_updates.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+import threading
+from queue import Queue
 from typing import TYPE_CHECKING
 
 from pydantic import BaseModel
@@ -25,6 +27,17 @@ class AutoUpdates:
 
     def __init__(self, gui: BECDockArea):
         self.gui = gui
+        self.msg_queue = Queue()
+        self.auto_update_thread = None
+        self._shutdown_sentinel = object()
+        self.start()
+
+    def start(self):
+        """
+        Start the auto update thread.
+        """
+        self.auto_update_thread = threading.Thread(target=self.process_queue)
+        self.auto_update_thread.start()
 
     def start_default_dock(self):
         """
@@ -79,6 +92,16 @@ class AutoUpdates:
         info = self.get_scan_info(msg)
         self.handler(info)
 
+    def process_queue(self):
+        """
+        Process the message queue.
+        """
+        while True:
+            msg = self.msg_queue.get()
+            if msg is self._shutdown_sentinel:
+                break
+            self.run(msg)
+
     @staticmethod
     def get_selected_device(monitored_devices, selected_device):
         """
@@ -151,3 +174,11 @@ class AutoUpdates:
         fig.clear_all()
         plt = fig.plot(x_name=dev_x, y_name=dev_y, label=f"Scan {info.scan_number} - {dev_y}")
         plt.set(title=f"Scan {info.scan_number}", x_label=dev_x, y_label=dev_y)
+
+    def shutdown(self):
+        """
+        Shutdown the auto update thread.
+        """
+        self.msg_queue.put(self._shutdown_sentinel)
+        if self.auto_update_thread:
+            self.auto_update_thread.join()

bec_widgets/cli/client_utils.py

@@ -2,20 +2,20 @@ from __future__ import annotations
 
 import importlib
 import importlib.metadata as imd
+import json
 import os
 import select
 import subprocess
-import sys
 import threading
 import time
 import uuid
 from functools import wraps
 from typing import TYPE_CHECKING
 
+from bec_lib.client import BECClient
 from bec_lib.endpoints import MessageEndpoints
 from bec_lib.logger import bec_logger
 from bec_lib.utils.import_utils import isinstance_based_on_class_name, lazy_import, lazy_import_from
-from qtpy.QtCore import QEventLoop, QSocketNotifier, QTimer
 
 import bec_widgets.cli.client as client
 from bec_widgets.cli.auto_updates import AutoUpdates
@@ -23,10 +23,6 @@ from bec_widgets.cli.auto_updates import AutoUpdates
 if TYPE_CHECKING:
     from bec_lib.device import DeviceBase
 
-    from bec_widgets.cli.client import BECDockArea, BECFigure
-
-from bec_lib.serialization import MsgpackSerialization
-
 messages = lazy_import("bec_lib.messages")
 # from bec_lib.connector import MessageObject
 MessageObject = lazy_import_from("bec_lib.connector", ("MessageObject",))
@@ -84,10 +80,10 @@ def _get_output(process, logger) -> None:
                     buf.clear()
                     buf.append(remaining)
     except Exception as e:
-        print(f"Error reading process output: {str(e)}")
+        logger.error(f"Error reading process output: {str(e)}")
 
 
-def _start_plot_process(gui_id, gui_class, config, logger=None) -> None:
+def _start_plot_process(gui_id: str, gui_class: type, config: dict | str, logger=None) -> None:
     """
     Start the plot in a new process.
 
@@ -98,10 +94,13 @@ def _start_plot_process(gui_id, gui_class, config, logger=None) -> None:
     # pylint: disable=subprocess-run-check
     command = ["bec-gui-server", "--id", gui_id, "--gui_class", gui_class.__name__]
     if config:
+        if isinstance(config, dict):
+            config = json.dumps(config)
         command.extend(["--config", config])
 
     env_dict = os.environ.copy()
     env_dict["PYTHONUNBUFFERED"] = "1"
+
     if logger is None:
         stdout_redirect = subprocess.DEVNULL
         stderr_redirect = subprocess.DEVNULL
@@ -147,7 +146,7 @@ class BECGuiClientMixin:
                         continue
                     return ep.load()(gui=self)
                 except Exception as e:
-                    print(f"Error loading auto update script from plugin: {str(e)}")
+                    logger.error(f"Error loading auto update script from plugin: {str(e)}")
         return None
 
     @property
@@ -181,7 +180,7 @@ class BECGuiClientMixin:
         if isinstance(msg, messages.ScanStatusMessage):
             if not self.gui_is_alive():
                 return
-            self.auto_updates.run(msg)
+            self.auto_updates.msg_queue.put(msg)
 
     def show(self) -> None:
         """
@@ -190,11 +189,12 @@ class BECGuiClientMixin:
         if self._process is None or self._process.poll() is not None:
             self._start_update_script()
             self._process, self._process_output_processing_thread = _start_plot_process(
-                self._gui_id, self.__class__, self._client._service_config.config_path
+                self._gui_id, self.__class__, self._client._service_config.config, logger=logger
             )
         while not self.gui_is_alive():
             print("Waiting for GUI to start...")
             time.sleep(1)
+        logger.success(f"GUI started with id: {self._gui_id}")
 
     def close(self) -> None:
         """
@@ -210,6 +210,8 @@ class BECGuiClientMixin:
                 self._process_output_processing_thread.join()
             self._process.wait()
             self._process = None
+        if self.auto_updates is not None:
+            self.auto_updates.shutdown()
 
 
 class RPCResponseTimeoutError(Exception):
@@ -221,54 +223,14 @@ class RPCResponseTimeoutError(Exception):
         )
 
 
-class QtRedisMessageWaiter:
-    def __init__(self, redis_connector, message_to_wait):
-        self.ev_loop = QEventLoop()
-        self.response = None
-        self.connector = redis_connector
-        self.message_to_wait = message_to_wait
-        self.pubsub = redis_connector._redis_conn.pubsub()
-        self.pubsub.subscribe(self.message_to_wait.endpoint)
-        fd = self.pubsub.connection._sock.fileno()
-        self.notifier = QSocketNotifier(fd, QSocketNotifier.Read)
-        self.notifier.activated.connect(self._pubsub_readable)
-
-    def _msg_received(self, msg_obj):
-        self.response = msg_obj.value
-        self.ev_loop.quit()
-
-    def wait(self, timeout=1):
-        timer = QTimer()
-        timer.singleShot(timeout * 1000, self.ev_loop.quit)
-        self.ev_loop.exec_()
-        timer.stop()
-        self.notifier.setEnabled(False)
-        self.pubsub.close()
-        return self.response
-
-    def _pubsub_readable(self, fd):
-        while True:
-            msg = self.pubsub.get_message()
-            if msg:
-                if msg["type"] == "subscribe":
-                    # get_message buffers, so we may already have the answer
-                    # let's check...
-                    continue
-                else:
-                    break
-            else:
-                return
-        channel = msg["channel"].decode()
-        msg = MessageObject(topic=channel, value=MsgpackSerialization.loads(msg["data"]))
-        self.connector._execute_callback(self._msg_received, msg, {})
-
-
 class RPCBase:
     def __init__(self, gui_id: str = None, config: dict = None, parent=None) -> None:
-        self._client = BECDispatcher().client
+        self._client = BECClient()  # BECClient is a singleton; here, we simply get the instance
         self._config = config if config is not None else {}
-        self._gui_id = gui_id if gui_id is not None else str(uuid.uuid4())
+        self._gui_id = gui_id if gui_id is not None else str(uuid.uuid4())[:5]
         self._parent = parent
+        self._msg_wait_event = threading.Event()
+        self._rpc_response = None
         super().__init__()
         # print(f"RPCBase: {self._gui_id}")
 
@@ -312,24 +274,39 @@ class RPCBase:
         # pylint: disable=protected-access
         receiver = self._root._gui_id
         if wait_for_rpc_response:
-            redis_msg = QtRedisMessageWaiter(
-                self._client.connector, MessageEndpoints.gui_instruction_response(request_id)
+            self._rpc_response = None
+            self._msg_wait_event.clear()
+            self._client.connector.register(
+                MessageEndpoints.gui_instruction_response(request_id),
+                cb=self._on_rpc_response,
+                parent=self,
             )
 
         self._client.connector.set_and_publish(MessageEndpoints.gui_instructions(receiver), rpc_msg)
 
         if wait_for_rpc_response:
-            response = redis_msg.wait(timeout)
-
-            if response is None:
-                raise RPCResponseTimeoutError(request_id, timeout)
-
+            try:
+                finished = self._msg_wait_event.wait(10)
+                if not finished:
+                    raise RPCResponseTimeoutError(request_id, timeout)
+            finally:
+                self._msg_wait_event.clear()
+                self._client.connector.unregister(
+                    MessageEndpoints.gui_instruction_response(request_id), cb=self._on_rpc_response
+                )
             # get class name
-            if not response.accepted:
-                raise ValueError(response.message["error"])
-            msg_result = response.message.get("result")
+            if not self._rpc_response.accepted:
+                raise ValueError(self._rpc_response.message["error"])
+            msg_result = self._rpc_response.message.get("result")
+            self._rpc_response = None
             return self._create_widget_from_msg_result(msg_result)
 
+    @staticmethod
+    def _on_rpc_response(msg: MessageObject, parent: RPCBase) -> None:
+        msg = msg.value
+        parent._msg_wait_event.set()
+        parent._rpc_response = msg
+
     def _create_widget_from_msg_result(self, msg_result):
         if msg_result is None:
             return None
@@ -356,4 +333,8 @@ class RPCBase:
         Check if the GUI is alive.
         """
         heart = self._client.connector.get(MessageEndpoints.gui_heartbeat(self._root._gui_id))
-        return heart is not None
+        if heart is None:
+            return False
+        if heart.status == messages.BECStatus.RUNNING:
+            return True
+        return False

bec_widgets/cli/generate_cli.py

@@ -5,12 +5,13 @@ import argparse
 import inspect
 import os
 import sys
-from typing import Literal
 
 import black
 import isort
+from qtpy.QtCore import Property as QtProperty
 
-from bec_widgets.utils.plugin_utils import get_rpc_classes
+from bec_widgets.utils.generate_designer_plugin import DesignerPluginGenerator
+from bec_widgets.utils.plugin_utils import BECClassContainer, get_rpc_classes
 
 if sys.version_info >= (3, 11):
     from typing import get_overloads
@@ -30,6 +31,7 @@ else:
 class ClientGenerator:
     def __init__(self):
         self.header = """# This file was automatically generated by generate_cli.py\n
+from __future__ import annotations
 import enum
 from typing import Literal, Optional, overload
 
@@ -39,17 +41,20 @@ from bec_widgets.cli.client_utils import RPCBase, rpc_call, BECGuiClientMixin
 
         self.content = ""
 
-    def generate_client(
-        self, published_classes: dict[Literal["connector_classes", "top_level_classes"], list[type]]
-    ):
+    def generate_client(self, class_container: BECClassContainer):
         """
         Generate the client for the published classes.
 
         Args:
-            published_classes(dict): A dictionary with keys "connector_classes" and "top_level_classes" and values as lists of classes.
+            class_container: The class container with the classes to generate the client for.
         """
-        self.write_client_enum(published_classes["top_level_classes"])
-        for cls in published_classes["connector_classes"]:
+        rpc_top_level_classes = class_container.rpc_top_level_classes
+        rpc_top_level_classes.sort(key=lambda x: x.__name__)
+        connector_classes = class_container.connector_classes
+        connector_classes.sort(key=lambda x: x.__name__)
+
+        self.write_client_enum(rpc_top_level_classes)
+        for cls in connector_classes:
             self.content += "\n\n"
             self.generate_content_for_class(cls)
 
@@ -87,11 +92,27 @@ class {class_name}(RPCBase):"""
             self.content += """...
     """
         for method in cls.USER_ACCESS:
-            obj = getattr(cls, method)
-            if isinstance(obj, property):
-                self.content += """
+            is_property_setter = False
+            obj = getattr(cls, method, None)
+            if obj is None:
+                obj = getattr(cls, method.split(".setter")[0], None)
+                is_property_setter = True
+                method = method.split(".setter")[0]
+            if obj is None:
+                raise AttributeError(
+                    f"Method {method} not found in class {cls.__name__}. Please check the USER_ACCESS list."
+                )
+            if isinstance(obj, (property, QtProperty)):
+                # for the cli, we can map qt properties to regular properties
+                if is_property_setter:
+                    self.content += f"""
+    @{method}.setter
+    @rpc_call"""
+                else:
+                    self.content += """
     @property
     @rpc_call"""
+
                 sig = str(inspect.signature(obj.fget))
                 doc = inspect.getdoc(obj.fget)
             else:
@@ -155,12 +176,31 @@ def main():
         client_path = os.path.join(current_path, "client.py")
 
         rpc_classes = get_rpc_classes("bec_widgets")
-        rpc_classes["connector_classes"].sort(key=lambda x: x.__name__)
 
         generator = ClientGenerator()
         generator.generate_client(rpc_classes)
         generator.write(client_path)
 
+        for cls in rpc_classes.plugins:
+            plugin = DesignerPluginGenerator(cls)
+            if not hasattr(plugin, "info"):
+                continue
+
+            # if the class directory already has a register, plugin and pyproject file, skip
+            if os.path.exists(
+                os.path.join(plugin.info.base_path, f"register_{plugin.info.plugin_name_snake}.py")
+            ):
+                continue
+            if os.path.exists(
+                os.path.join(plugin.info.base_path, f"{plugin.info.plugin_name_snake}_plugin.py")
+            ):
+                continue
+            if os.path.exists(
+                os.path.join(plugin.info.base_path, f"{plugin.info.plugin_name_snake}.pyproject")
+            ):
+                continue
+            plugin.run()
+
 
 if __name__ == "__main__":  # pragma: no cover
     sys.argv = ["generate_cli.py", "--core"]

bec_widgets/cli/rpc_wigdet_handler.py

@@ -29,7 +29,7 @@ class RPCWidgetHandler:
         from bec_widgets.utils.plugin_utils import get_rpc_classes
 
         clss = get_rpc_classes("bec_widgets")
-        self._widget_classes = {cls.__name__: cls for cls in clss["top_level_classes"]}
+        self._widget_classes = {cls.__name__: cls for cls in clss.top_level_classes}
 
     def create_widget(self, widget_type, **kwargs) -> BECConnector:
         """

bec_widgets/cli/server.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import inspect
+import json
 import signal
 import sys
 from contextlib import redirect_stderr, redirect_stdout
@@ -27,12 +28,13 @@ class BECWidgetsCLIServer:
 
     def __init__(
         self,
-        gui_id: str = None,
+        gui_id: str,
         dispatcher: BECDispatcher = None,
         client=None,
         config=None,
         gui_class: Union[BECFigure, BECDockArea] = BECFigure,
     ) -> None:
+        self.status = messages.BECStatus.BUSY
         self.dispatcher = BECDispatcher(config=config) if dispatcher is None else dispatcher
         self.client = self.dispatcher.client if client is None else client
         self.client.start()
@@ -46,13 +48,16 @@ class BECWidgetsCLIServer:
         )
 
         # Setup QTimer for heartbeat
-        self._shutdown_event = False
         self._heartbeat_timer = QTimer()
         self._heartbeat_timer.timeout.connect(self.emit_heartbeat)
         self._heartbeat_timer.start(200)
 
+        self.status = messages.BECStatus.RUNNING
+        logger.success(f"Server started with gui_id: {self.gui_id}")
+
     def on_rpc_update(self, msg: dict, metadata: dict):
         request_id = metadata.get("request_id")
+        logger.debug(f"Received RPC instruction: {msg}, metadata: {metadata}")
         try:
             obj = self.get_object_from_config(msg["parameter"])
             method = msg["action"]
@@ -60,9 +65,10 @@ class BECWidgetsCLIServer:
             kwargs = msg["parameter"].get("kwargs", {})
             res = self.run_rpc(obj, method, args, kwargs)
         except Exception as e:
-            print(e)
+            logger.error(f"Error while executing RPC instruction: {e}")
             self.send_response(request_id, False, {"error": str(e)})
         else:
+            logger.debug(f"RPC instruction executed successfully: {res}")
             self.send_response(request_id, True, {"result": res})
 
     def send_response(self, request_id: str, accepted: bool, msg: dict):
@@ -80,10 +86,15 @@ class BECWidgetsCLIServer:
         return obj
 
     def run_rpc(self, obj, method, args, kwargs):
+        logger.debug(f"Running RPC instruction: {method} with args: {args}, kwargs: {kwargs}")
         method_obj = getattr(obj, method)
         # check if the method accepts args and kwargs
         if not callable(method_obj):
-            res = method_obj
+            if not args:
+                res = method_obj
+            else:
+                setattr(obj, method, args[0])
+                res = None
         else:
             sig = inspect.signature(method_obj)
             if sig.parameters:
@@ -110,16 +121,18 @@ class BECWidgetsCLIServer:
         return obj
 
     def emit_heartbeat(self):
-        if self._shutdown_event is False:
-            self.client.connector.set(
-                MessageEndpoints.gui_heartbeat(self.gui_id),
-                messages.StatusMessage(name=self.gui_id, status=1, info={}),
-                expire=1,
-            )
+        logger.trace(f"Emitting heartbeat for {self.gui_id}")
+        self.client.connector.set(
+            MessageEndpoints.gui_heartbeat(self.gui_id),
+            messages.StatusMessage(name=self.gui_id, status=self.status, info={}),
+            expire=10,
+        )
 
     def shutdown(self):  # TODO not sure if needed when cleanup is done at level of BECConnector
-        self._shutdown_event = True
+        logger.info(f"Shutting down server with gui_id: {self.gui_id}")
+        self.status = messages.BECStatus.IDLE
         self._heartbeat_timer.stop()
+        self.emit_heartbeat()
         self.gui.close()
         self.client.shutdown()
 
@@ -127,24 +140,45 @@ class BECWidgetsCLIServer:
 class SimpleFileLikeFromLogOutputFunc:
     def __init__(self, log_func):
         self._log_func = log_func
+        self._buffer = []
 
     def write(self, buffer):
-        for line in buffer.rstrip().splitlines():
-            line = line.rstrip()
-            if line:
-                self._log_func(line)
+        self._buffer.append(buffer)
 
     def flush(self):
-        return
+        lines, _, remaining = "".join(self._buffer).rpartition("\n")
+        if lines:
+            self._log_func(lines)
+        self._buffer = [remaining]
 
     def close(self):
         return
 
 
+def _start_server(gui_id: str, gui_class: Union[BECFigure, BECDockArea], config: str | None = None):
+    if config:
+        try:
+            config = json.loads(config)
+            service_config = ServiceConfig(config=config)
+        except (json.JSONDecodeError, TypeError):
+            service_config = ServiceConfig(config_path=config)
+    else:
+        # if no config is provided, use the default config
+        service_config = ServiceConfig()
+
+    # bec_logger.configure(
+    #     service_config.redis,
+    #     QtRedisConnector,
+    #     service_name="BECWidgetsCLIServer",
+    #     service_config=service_config.service_config,
+    # )
+    server = BECWidgetsCLIServer(gui_id=gui_id, config=service_config, gui_class=gui_class)
+    return server
+
+
 def main():
     import argparse
     import os
-    import sys
 
     from qtpy.QtCore import QSize
     from qtpy.QtGui import QIcon
@@ -152,6 +186,12 @@ def main():
 
     import bec_widgets
 
+    bec_logger.level = bec_logger.LOGLEVEL.DEBUG
+    if __name__ != "__main__":
+        # if not running as main, set the log level to critical
+        # pylint: disable=protected-access
+        bec_logger._stderr_log_level = bec_logger.LOGLEVEL.CRITICAL
+
     parser = argparse.ArgumentParser(description="BEC Widgets CLI Server")
     parser.add_argument("--id", type=str, help="The id of the server")
     parser.add_argument(
@@ -159,7 +199,7 @@ def main():
         type=str,
         help="Name of the gui class to be rendered. Possible values: \n- BECFigure\n- BECDockArea",
     )
-    parser.add_argument("--config", type=str, help="Config file")
+    parser.add_argument("--config", type=str, help="Config file or config string.")
 
     args = parser.parse_args()
 
@@ -174,28 +214,22 @@ def main():
         )
         gui_class = BECFigure
 
-    with redirect_stdout(SimpleFileLikeFromLogOutputFunc(logger.debug)):
+    with redirect_stdout(SimpleFileLikeFromLogOutputFunc(logger.info)):
         with redirect_stderr(SimpleFileLikeFromLogOutputFunc(logger.error)):
             app = QApplication(sys.argv)
             app.setApplicationName("BEC Figure")
             module_path = os.path.dirname(bec_widgets.__file__)
             icon = QIcon()
             icon.addFile(
-                os.path.join(module_path, "assets", "bec_widgets_icon.png"), size=QSize(48, 48)
+                os.path.join(module_path, "assets", "app_icons", "bec_widgets_icon.png"),
+                size=QSize(48, 48),
             )
             app.setWindowIcon(icon)
 
             win = QMainWindow()
             win.setWindowTitle("BEC Widgets")
 
-            service_config = ServiceConfig(args.config)
-            bec_logger.configure(
-                service_config.redis,
-                QtRedisConnector,
-                service_name="BECWidgetsCLIServer",
-                service_config=service_config.service_config,
-            )
-            server = BECWidgetsCLIServer(gui_id=args.id, config=service_config, gui_class=gui_class)
+            server = _start_server(args.id, gui_class, args.config)
 
             gui = server.gui
             win.setCentralWidget(gui)
@@ -216,4 +250,5 @@ def main():
 
 
 if __name__ == "__main__":  # pragma: no cover
+    sys.argv = ["bec_widgets.cli.server", "--id", "e2860", "--gui_class", "BECDockArea"]
     main()

bec_widgets/examples/general_app/general_app.py

@@ -1,16 +1,17 @@
 import os
 import sys
 
-import qdarktheme
-from qtpy.QtGui import QActionGroup
-from qtpy.QtWidgets import QStyle
 from qtpy.QtCore import QSize
-from qtpy.QtGui import QIcon
-from qtpy.QtWidgets import QApplication, QMainWindow
+from qtpy.QtGui import QActionGroup, QIcon
+from qtpy.QtWidgets import QApplication, QMainWindow, QStyle
 
+import bec_widgets
 from bec_widgets.examples.general_app.web_links import BECWebLinksMixin
+from bec_widgets.utils.colors import apply_theme
 from bec_widgets.utils.ui_loader import UILoader
 
+MODULE_PATH = os.path.dirname(bec_widgets.__file__)
+
 
 class BECGeneralApp(QMainWindow):
     def __init__(self, parent=None):
@@ -41,21 +42,22 @@ class BECGeneralApp(QMainWindow):
         self.ui.action_bug_report.triggered.connect(BECWebLinksMixin.open_bec_bug_report)
 
     def change_theme(self, theme):
-        qdarktheme.setup_theme(theme)
+        apply_theme(theme)
 
     def _setup_icons(self):
         help_icon = QApplication.style().standardIcon(QStyle.SP_MessageBoxQuestion)
         bug_icon = QApplication.style().standardIcon(QStyle.SP_MessageBoxInformation)
         computer_icon = QIcon.fromTheme("computer")
+        widget_icon = QIcon(os.path.join(MODULE_PATH, "assets", "designer_icons", "dock_area.png"))
 
         self.ui.action_BEC_docs.setIcon(help_icon)
         self.ui.action_BEC_widgets_docs.setIcon(help_icon)
         self.ui.action_bug_report.setIcon(bug_icon)
 
-        self.ui.central_tab.setTabIcon(0, computer_icon)
+        self.ui.central_tab.setTabIcon(0, widget_icon)
+        self.ui.central_tab.setTabIcon(1, computer_icon)
 
     def _hook_theme_bar(self):
-        # Make actions checkable
         self.ui.action_light.setCheckable(True)
         self.ui.action_dark.setCheckable(True)
 
@@ -66,6 +68,7 @@ class BECGeneralApp(QMainWindow):
         theme_group.setExclusive(True)
 
         # Connect the actions to the theme change method
+
         self.ui.action_light.triggered.connect(lambda: self.change_theme("light"))
         self.ui.action_dark.triggered.connect(lambda: self.change_theme("dark"))
 
@@ -73,19 +76,12 @@ class BECGeneralApp(QMainWindow):
 
 
 def main():  # pragma: no cover
-    from qtpy import PYSIDE6
 
-    if not PYSIDE6:
-        print(
-            "PYSIDE6 is not available in the environment. UI files with BEC custom widgets are runnable only with PySide6."
-        )
-        return
-    import bec_widgets
-
-    module_path = os.path.dirname(bec_widgets.__file__)
     app = QApplication(sys.argv)
     icon = QIcon()
-    icon.addFile(os.path.join(module_path, "assets", "BEC-Dark.png"), size=QSize(48, 48))
+    icon.addFile(
+        os.path.join(MODULE_PATH, "assets", "app_icons", "BEC-General-App.png"), size=QSize(48, 48)
+    )
     app.setWindowIcon(icon)
     main_window = BECGeneralApp()
     main_window.show()

bec_widgets/examples/general_app/general_app.ui

@@ -1,380 +1,262 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <ui version="4.0">
- <class>MainWindow</class>
- <widget class="QMainWindow" name="MainWindow">
-  <property name="geometry">
-   <rect>
-    <x>0</x>
-    <y>0</y>
-    <width>1718</width>
-    <height>1139</height>
-   </rect>
-  </property>
-  <property name="windowTitle">
-   <string>MainWindow</string>
-  </property>
-  <property name="tabShape">
-   <enum>QTabWidget::TabShape::Rounded</enum>
-  </property>
-  <widget class="QWidget" name="centralwidget">
-   <layout class="QVBoxLayout" name="verticalLayout_3">
-    <item>
-     <widget class="QTabWidget" name="central_tab">
-      <property name="currentIndex">
-       <number>0</number>
-      </property>
-      <widget class="QWidget" name="vscode">
-       <attribute name="icon">
-        <iconset theme="QIcon::ThemeIcon::Computer"/>
-       </attribute>
-       <attribute name="title">
-        <string>Visual Studio Code</string>
-       </attribute>
-       <layout class="QVBoxLayout" name="verticalLayout_2">
-        <item>
-         <widget class="VSCodeEditor" name="vscode"/>
-        </item>
-       </layout>
-      </widget>
-      <widget class="QWidget" name="tab_2">
-       <attribute name="title">
-        <string>Tab 2</string>
-       </attribute>
-      </widget>
-     </widget>
-    </item>
-   </layout>
-  </widget>
-  <widget class="QMenuBar" name="menubar">
-   <property name="geometry">
-    <rect>
-     <x>0</x>
-     <y>0</y>
-     <width>1718</width>
-     <height>24</height>
-    </rect>
-   </property>
-   <widget class="QMenu" name="menuHelp">
-    <property name="title">
-     <string>Help</string>
-    </property>
-    <addaction name="action_BEC_docs"/>
-    <addaction name="action_BEC_widgets_docs"/>
-    <addaction name="action_bug_report"/>
-   </widget>
-   <widget class="QMenu" name="menuTheme">
-    <property name="title">
-     <string>Theme</string>
-    </property>
-    <addaction name="action_light"/>
-    <addaction name="action_dark"/>
-   </widget>
-   <addaction name="menuTheme"/>
-   <addaction name="menuHelp"/>
-  </widget>
-  <widget class="QStatusBar" name="statusbar"/>
-  <widget class="QDockWidget" name="dock_scan_control">
-   <property name="windowTitle">
-    <string>Scan Control</string>
-   </property>
-   <attribute name="dockWidgetArea">
-    <number>2</number>
-   </attribute>
-   <widget class="QWidget" name="dockWidgetContents_2">
-    <layout class="QVBoxLayout" name="verticalLayout_4">
-     <item>
-      <widget class="ScanControl" name="scan_control"/>
-     </item>
-    </layout>
-   </widget>
-  </widget>
-  <widget class="QDockWidget" name="dock_status_2">
-   <property name="windowTitle">
-    <string>BEC Service Status</string>
-   </property>
-   <attribute name="dockWidgetArea">
-    <number>2</number>
-   </attribute>
-   <widget class="QWidget" name="dockWidgetContents_3">
-    <layout class="QVBoxLayout" name="verticalLayout_5">
-     <item>
-      <widget class="BECStatusBox" name="bec_status_box_2">
-       <column>
-        <property name="text">
-         <string notr="true">1</string>
+    <class>MainWindow</class>
+    <widget class="QMainWindow" name="MainWindow">
+        <property name="geometry">
+            <rect>
+                <x>0</x>
+                <y>0</y>
+                <width>1718</width>
+                <height>1139</height>
+            </rect>
         </property>
-       </column>
-       <item>
-        <property name="flags">
-         <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
+        <property name="windowTitle">
+            <string>MainWindow</string>
         </property>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-       </item>
-       <item>
-        <property name="flags">
-         <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
+        <property name="tabShape">
+            <enum>QTabWidget::TabShape::Rounded</enum>
         </property>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-       </item>
-       <item>
-        <property name="flags">
-         <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-        </property>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-        <item>
-         <property name="flags">
-          <set>ItemIsSelectable|ItemIsDragEnabled|ItemIsDropEnabled|ItemIsUserCheckable</set>
-         </property>
-        </item>
-       </item>
-      </widget>
-     </item>
-    </layout>
-   </widget>
-  </widget>
-  <widget class="QDockWidget" name="dock_queue">
-   <property name="windowTitle">
-    <string>Scan Queue</string>
-   </property>
-   <attribute name="dockWidgetArea">
-    <number>2</number>
-   </attribute>
-   <widget class="QWidget" name="dockWidgetContents_4">
-    <layout class="QVBoxLayout" name="verticalLayout_6">
-     <item>
-      <widget class="BECQueue" name="bec_queue">
-       <row/>
-       <column/>
-       <column/>
-       <column/>
-       <item row="0" column="0"/>
-       <item row="0" column="1"/>
-       <item row="0" column="2"/>
-      </widget>
-     </item>
-    </layout>
-   </widget>
-  </widget>
-  <action name="action_BEC_docs">
-   <property name="icon">
-    <iconset theme="QIcon::ThemeIcon::DialogQuestion"/>
-   </property>
-   <property name="text">
-    <string>BEC Docs</string>
-   </property>
-  </action>
-  <action name="action_BEC_widgets_docs">
-   <property name="icon">
-    <iconset theme="QIcon::ThemeIcon::DialogQuestion"/>
-   </property>
-   <property name="text">
-    <string>BEC Widgets Docs</string>
-   </property>
-  </action>
-  <action name="action_bug_report">
-   <property name="icon">
-    <iconset theme="QIcon::ThemeIcon::DialogError"/>
-   </property>
-   <property name="text">
-    <string>Bug Report</string>
-   </property>
-  </action>
-  <action name="action_light">
-   <property name="checkable">
-    <bool>true</bool>
-   </property>
-   <property name="text">
-    <string>Light</string>
-   </property>
-  </action>
-  <action name="action_dark">
-   <property name="checkable">
-    <bool>true</bool>
-   </property>
-   <property name="text">
-    <string>Dark</string>
-   </property>
-  </action>
- </widget>
- <customwidgets>
-  <customwidget>
-   <class>BECQueue</class>
-   <extends>QTableWidget</extends>
-   <header>bec_queue</header>
-  </customwidget>
-  <customwidget>
-   <class>ScanControl</class>
-   <extends>QWidget</extends>
-   <header>scan_control</header>
-  </customwidget>
-  <customwidget>
-   <class>VSCodeEditor</class>
-   <extends>QWebEngineView</extends>
-   <header>vscode</header>
-  </customwidget>
-  <customwidget>
-   <class>BECStatusBox</class>
-   <extends>QTreeWidget</extends>
-   <header>bec_status_box</header>
-  </customwidget>
-  <customwidget>
-   <class>QWebEngineView</class>
-   <extends></extends>
-   <header location="global">QtWebEngineWidgets/QWebEngineView</header>
-  </customwidget>
- </customwidgets>
- <resources/>
- <connections/>
+        <widget class="QWidget" name="centralwidget">
+            <layout class="QVBoxLayout" name="verticalLayout_3">
+                <item>
+                    <widget class="QTabWidget" name="central_tab">
+                        <property name="currentIndex">
+                            <number>0</number>
+                        </property>
+                        <widget class="QWidget" name="dock_area_tab">
+                            <attribute name="title">
+                                <string>Dock Area</string>
+                            </attribute>
+                            <layout class="QVBoxLayout" name="verticalLayout">
+                                <property name="leftMargin">
+                                    <number>2</number>
+                                </property>
+                                <property name="topMargin">
+                                    <number>1</number>
+                                </property>
+                                <property name="rightMargin">
+                                    <number>2</number>
+                                </property>
+                                <property name="bottomMargin">
+                                    <number>2</number>
+                                </property>
+                                <item>
+                                    <widget class="BECDockArea" name="dock_area"/>
+                                </item>
+                            </layout>
+                        </widget>
+                        <widget class="QWidget" name="vscode_tab">
+                            <attribute name="icon">
+                                <iconset theme="QIcon::ThemeIcon::Computer"/>
+                            </attribute>
+                            <attribute name="title">
+                                <string>Visual Studio Code</string>
+                            </attribute>
+                            <layout class="QVBoxLayout" name="verticalLayout_2">
+                                <property name="leftMargin">
+                                    <number>2</number>
+                                </property>
+                                <property name="topMargin">
+                                    <number>1</number>
+                                </property>
+                                <property name="rightMargin">
+                                    <number>2</number>
+                                </property>
+                                <property name="bottomMargin">
+                                    <number>2</number>
+                                </property>
+                                <item>
+                                    <widget class="VSCodeEditor" name="vscode"/>
+                                </item>
+                            </layout>
+                        </widget>
+                    </widget>
+                </item>
+            </layout>
+        </widget>
+        <widget class="QMenuBar" name="menubar">
+            <property name="geometry">
+                <rect>
+                    <x>0</x>
+                    <y>0</y>
+                    <width>1718</width>
+                    <height>31</height>
+                </rect>
+            </property>
+            <widget class="QMenu" name="menuHelp">
+                <property name="title">
+                    <string>Help</string>
+                </property>
+                <addaction name="action_BEC_docs"/>
+                <addaction name="action_BEC_widgets_docs"/>
+                <addaction name="action_bug_report"/>
+            </widget>
+            <widget class="QMenu" name="menuTheme">
+                <property name="title">
+                    <string>Theme</string>
+                </property>
+                <addaction name="action_light"/>
+                <addaction name="action_dark"/>
+            </widget>
+            <addaction name="menuTheme"/>
+            <addaction name="menuHelp"/>
+        </widget>
+        <widget class="QStatusBar" name="statusbar"/>
+        <widget class="QDockWidget" name="dock_scan_control">
+            <property name="windowTitle">
+                <string>Scan Control</string>
+            </property>
+            <attribute name="dockWidgetArea">
+                <number>2</number>
+            </attribute>
+            <widget class="QWidget" name="dockWidgetContents_2">
+                <layout class="QVBoxLayout" name="verticalLayout_4">
+                    <item>
+                        <widget class="ScanControl" name="scan_control"/>
+                    </item>
+                </layout>
+            </widget>
+        </widget>
+        <widget class="QDockWidget" name="dock_status_2">
+            <property name="windowTitle">
+                <string>BEC Service Status</string>
+            </property>
+            <attribute name="dockWidgetArea">
+                <number>2</number>
+            </attribute>
+            <widget class="QWidget" name="dockWidgetContents_3">
+                <layout class="QVBoxLayout" name="verticalLayout_5">
+                    <property name="leftMargin">
+                        <number>0</number>
+                    </property>
+                    <property name="topMargin">
+                        <number>0</number>
+                    </property>
+                    <property name="rightMargin">
+                        <number>0</number>
+                    </property>
+                    <property name="bottomMargin">
+                        <number>0</number>
+                    </property>
+                    <item>
+                        <widget class="BECStatusBox" name="bec_status_box_2"/>
+                    </item>
+                </layout>
+            </widget>
+        </widget>
+        <widget class="QDockWidget" name="dock_queue">
+            <property name="windowTitle">
+                <string>Scan Queue</string>
+            </property>
+            <attribute name="dockWidgetArea">
+                <number>2</number>
+            </attribute>
+            <widget class="QWidget" name="dockWidgetContents_4">
+                <layout class="QVBoxLayout" name="verticalLayout_6">
+                    <property name="leftMargin">
+                        <number>0</number>
+                    </property>
+                    <property name="topMargin">
+                        <number>0</number>
+                    </property>
+                    <property name="rightMargin">
+                        <number>0</number>
+                    </property>
+                    <property name="bottomMargin">
+                        <number>0</number>
+                    </property>
+                    <item>
+                        <widget class="BECQueue" name="bec_queue">
+                            <row/>
+                            <column/>
+                            <column/>
+                            <column/>
+                            <item row="0" column="0"/>
+                            <item row="0" column="1"/>
+                            <item row="0" column="2"/>
+                        </widget>
+                    </item>
+                </layout>
+            </widget>
+        </widget>
+        <action name="action_BEC_docs">
+            <property name="icon">
+                <iconset theme="QIcon::ThemeIcon::DialogQuestion"/>
+            </property>
+            <property name="text">
+                <string>BEC Docs</string>
+            </property>
+        </action>
+        <action name="action_BEC_widgets_docs">
+            <property name="icon">
+                <iconset theme="QIcon::ThemeIcon::DialogQuestion"/>
+            </property>
+            <property name="text">
+                <string>BEC Widgets Docs</string>
+            </property>
+        </action>
+        <action name="action_bug_report">
+            <property name="icon">
+                <iconset theme="QIcon::ThemeIcon::DialogError"/>
+            </property>
+            <property name="text">
+                <string>Bug Report</string>
+            </property>
+        </action>
+        <action name="action_light">
+            <property name="checkable">
+                <bool>true</bool>
+            </property>
+            <property name="text">
+                <string>Light</string>
+            </property>
+        </action>
+        <action name="action_dark">
+            <property name="checkable">
+                <bool>true</bool>
+            </property>
+            <property name="text">
+                <string>Dark</string>
+            </property>
+        </action>
+    </widget>
+    <customwidgets>
+        <customwidget>
+            <class>WebsiteWidget</class>
+            <extends>QWebEngineView</extends>
+            <header>website_widget</header>
+        </customwidget>
+        <customwidget>
+            <class>BECQueue</class>
+            <extends>QTableWidget</extends>
+            <header>bec_queue</header>
+        </customwidget>
+        <customwidget>
+            <class>ScanControl</class>
+            <extends>QWidget</extends>
+            <header>scan_control</header>
+        </customwidget>
+        <customwidget>
+            <class>VSCodeEditor</class>
+            <extends>WebsiteWidget</extends>
+            <header>vs_code_editor</header>
+        </customwidget>
+        <customwidget>
+            <class>BECStatusBox</class>
+            <extends>QWidget</extends>
+            <header>bec_status_box</header>
+        </customwidget>
+        <customwidget>
+            <class>BECDockArea</class>
+            <extends>QWidget</extends>
+            <header>dock_area</header>
+        </customwidget>
+        <customwidget>
+            <class>QWebEngineView</class>
+            <extends></extends>
+            <header location="global">QtWebEngineWidgets/QWebEngineView</header>
+        </customwidget>
+    </customwidgets>
+    <resources/>
+    <connections/>
 </ui>

bec_widgets/examples/jupyter_console/jupyter_console_window.py

@@ -2,14 +2,21 @@ import os
 
 import numpy as np
 import pyqtgraph as pg
-import qdarktheme
-from qtconsole.inprocess import QtInProcessKernelManager
-from qtconsole.rich_jupyter_widget import RichJupyterWidget
+from bec_qthemes import material_icon
 from qtpy.QtCore import QSize
 from qtpy.QtGui import QIcon
-from qtpy.QtWidgets import QApplication, QVBoxLayout, QWidget
+from qtpy.QtWidgets import (
+    QApplication,
+    QGroupBox,
+    QHBoxLayout,
+    QSplitter,
+    QTabWidget,
+    QVBoxLayout,
+    QWidget,
+)
 
-from bec_widgets.utils import BECDispatcher, UILoader
+from bec_widgets.utils import BECDispatcher
+from bec_widgets.utils.colors import apply_theme
 from bec_widgets.widgets.dock.dock_area import BECDockArea
 from bec_widgets.widgets.figure import BECFigure
 from bec_widgets.widgets.jupyter_console.jupyter_console import BECJupyterConsole
@@ -21,14 +28,8 @@ class JupyterConsoleWindow(QWidget):  # pragma: no cover:
     def __init__(self, parent=None):
         super().__init__(parent)
 
-        current_path = os.path.dirname(__file__)
-        self.ui = UILoader().load_ui(os.path.join(current_path, "jupyter_console_window.ui"), self)
-
         self._init_ui()
 
-        self.ui.splitter.setSizes([200, 100])
-        self.safe_close = False
-
         # console push
         if self.console.inprocess is True:
             self.console.kernel_manager.kernel.shell.push(
@@ -40,26 +41,49 @@ class JupyterConsoleWindow(QWidget):  # pragma: no cover:
                     "w1": self.w1,
                     "w2": self.w2,
                     "w3": self.w3,
+                    "w4": self.w4,
+                    "w5": self.w5,
+                    "w6": self.w6,
+                    "w7": self.w7,
+                    "w8": self.w8,
+                    "w9": self.w9,
+                    "w10": self.w10,
                     "d0": self.d0,
                     "d1": self.d1,
                     "d2": self.d2,
-                    "fig0": self.fig0,
-                    "fig1": self.fig1,
-                    "fig2": self.fig2,
-                    "plt": self.plt,
-                    "bar": self.bar,
+                    "wave": self.wf,
+                    # "bar": self.bar,
+                    # "cm": self.colormap,
+                    "im": self.im,
+                    "mm": self.mm,
                 }
             )
 
     def _init_ui(self):
-        # Plotting window
-        self.glw_1_layout = QVBoxLayout(self.ui.glw)  # Create a new QVBoxLayout
-        self.figure = BECFigure(parent=self, gui_id="remote")  # Create a new BECDeviceMonitor
-        self.glw_1_layout.addWidget(self.figure)  # Add BECDeviceMonitor to the layout
+        self.layout = QHBoxLayout(self)
 
-        self.dock_layout = QVBoxLayout(self.ui.dock_placeholder)
-        self.dock = BECDockArea(gui_id="remote")
-        self.dock_layout.addWidget(self.dock)
+        # Horizontal splitter
+        splitter = QSplitter(self)
+        self.layout.addWidget(splitter)
+
+        tab_widget = QTabWidget(splitter)
+
+        first_tab = QWidget()
+        first_tab_layout = QVBoxLayout(first_tab)
+        self.dock = BECDockArea(gui_id="dock")
+        first_tab_layout.addWidget(self.dock)
+        tab_widget.addTab(first_tab, "Dock Area")
+
+        second_tab = QWidget()
+        second_tab_layout = QVBoxLayout(second_tab)
+        self.figure = BECFigure(parent=self, gui_id="figure")
+        second_tab_layout.addWidget(self.figure)
+        tab_widget.addTab(second_tab, "BEC Figure")
+
+        group_box = QGroupBox("Jupyter Console", splitter)
+        group_box_layout = QVBoxLayout(group_box)
+        self.console = BECJupyterConsole(inprocess=True)
+        group_box_layout.addWidget(self.console)
 
         # add stuff to figure
         self._init_figure()
@@ -67,52 +91,102 @@ class JupyterConsoleWindow(QWidget):  # pragma: no cover:
         # init dock for testing
         self._init_dock()
 
-        self.console_layout = QVBoxLayout(self.ui.widget_console)
-        self.console = BECJupyterConsole(inprocess=True)
-        self.console_layout.addWidget(self.console)
+        self.setWindowTitle("Jupyter Console Window")
 
     def _init_figure(self):
-        self.figure.plot(x_name="samx", y_name="samy", z_name="bpm4i", color_map_z="cividis")
-        self.figure.motor_map("samx", "samy")
-        self.figure.image("eiger", color_map="viridis", vrange=(0, 100))
-        self.figure.add_plot(x_name="samx", y_name="samy", z_name="bpm4i", color_map_z="magma")
-
-        self.figure.change_layout(2, 2)
-
-        self.w1 = self.figure[0, 0]
-        self.w2 = self.figure[0, 1]
-        self.w3 = self.figure[1, 0]
-
-        # curves for w1
-        self.c1 = self.w1.get_config()
+        self.w1 = self.figure.plot(
+            x_name="samx",
+            y_name="bpm4i",
+            # title="Standard Plot with sync device, custom labels - w1",
+            # x_label="Motor Position",
+            # y_label="Intensity (A.U.)",
+            row=0,
+            col=0,
+        )
+        self.w1.set(
+            title="Standard Plot with sync device, custom labels - w1",
+            x_label="Motor Position",
+            y_label="Intensity (A.U.)",
+        )
+        self.w2 = self.figure.motor_map("samx", "samy", row=0, col=1)
+        self.w3 = self.figure.image(
+            "eiger", color_map="viridis", vrange=(0, 100), title="Eiger Image - w3", row=0, col=2
+        )
+        self.w4 = self.figure.plot(
+            x_name="samx",
+            y_name="samy",
+            z_name="bpm4i",
+            color_map_z="magma",
+            new=True,
+            title="2D scatter plot - w4",
+            row=0,
+            col=3,
+        )
+        self.w5 = self.figure.plot(
+            y_name="bpm4i",
+            new=True,
+            title="Best Effort Plot - w5",
+            dap="GaussianModel",
+            row=1,
+            col=0,
+        )
+        self.w6 = self.figure.plot(
+            x_name="timestamp", y_name="bpm4i", new=True, title="Timestamp Plot - w6", row=1, col=1
+        )
+        self.w7 = self.figure.plot(
+            x_name="index", y_name="bpm4i", new=True, title="Index Plot - w7", row=1, col=2
+        )
+        self.w8 = self.figure.plot(
+            y_name="monitor_async", new=True, title="Async Plot - Best Effort - w8", row=2, col=0
+        )
+        self.w9 = self.figure.plot(
+            x_name="timestamp",
+            y_name="monitor_async",
+            new=True,
+            title="Async Plot - timestamp - w9",
+            row=2,
+            col=1,
+        )
+        self.w10 = self.figure.plot(
+            x_name="index",
+            y_name="monitor_async",
+            new=True,
+            title="Async Plot - index - w10",
+            row=2,
+            col=2,
+        )
 
     def _init_dock(self):
 
         self.d0 = self.dock.add_dock(name="dock_0")
-        self.fig0 = self.d0.add_widget("BECFigure")
-        data = np.random.rand(10, 2)
-        self.fig0.plot(data, label="2d Data")
-        self.fig0.image("eiger", vrange=(0, 100))
+        self.mm = self.d0.add_widget("BECMotorMapWidget")
+        self.mm.change_motors("samx", "samy")
 
         self.d1 = self.dock.add_dock(name="dock_1", position="right")
-        self.fig1 = self.d1.add_widget("BECFigure")
-        self.fig1.plot(x_name="samx", y_name="bpm4i")
-        self.fig1.plot(x_name="samx", y_name="bpm3a")
+        self.im = self.d1.add_widget("BECImageWidget")
+        self.im.image("waveform", "1d")
 
         self.d2 = self.dock.add_dock(name="dock_2", position="bottom")
-        self.fig2 = self.d2.add_widget("BECFigure", row=0, col=0)
-        self.plt = self.fig2.plot(x_name="samx", y_name="bpm3a")
-        self.plt.plot(x_name="samx", y_name="bpm4i", dap="GaussianModel")
-        self.bar = self.d2.add_widget("RingProgressBar", row=0, col=1)
-        self.bar.set_diameter(200)
+        self.wf = self.d2.add_widget("BECWaveformWidget", row=0, col=0)
+        self.wf.plot(x_name="samx", y_name="bpm3a")
+        self.wf.plot(x_name="samx", y_name="bpm4i", dap="GaussianModel")
+        # self.bar = self.d2.add_widget("RingProgressBar", row=0, col=1)
+        # self.bar.set_diameter(200)
+
+        # self.d3 = self.dock.add_dock(name="dock_3", position="bottom")
+        # self.colormap = pg.GradientWidget()
+        # self.d3.add_widget(self.colormap, row=0, col=0)
 
         self.dock.save_state()
 
     def closeEvent(self, event):
         """Override to handle things when main window is closed."""
         self.dock.cleanup()
-        self.figure.clear_all()
-        self.figure.client.shutdown()
+        self.dock.close()
+        self.figure.cleanup()
+        self.figure.close()
+        self.console.close()
+
         super().closeEvent(event)
 
 
@@ -126,9 +200,8 @@ if __name__ == "__main__":  # pragma: no cover
     app = QApplication(sys.argv)
     app.setApplicationName("Jupyter Console")
     app.setApplicationDisplayName("Jupyter Console")
-    qdarktheme.setup_theme("auto")
-    icon = QIcon()
-    icon.addFile(os.path.join(module_path, "assets", "terminal_icon.png"), size=QSize(48, 48))
+    apply_theme("dark")
+    icon = material_icon("terminal", color="#434343", filled=True)
     app.setWindowIcon(icon)
 
     bec_dispatcher = BECDispatcher()

bec_widgets/examples/jupyter_console/jupyter_console_window.ui

@@ -1,54 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<ui version="4.0">
- <class>Form</class>
- <widget class="QWidget" name="Form">
-  <property name="geometry">
-   <rect>
-    <x>0</x>
-    <y>0</y>
-       <width>1415</width>
-       <height>832</height>
-   </rect>
-  </property>
-  <property name="windowTitle">
-   <string>Plotting Console</string>
-  </property>
-  <layout class="QVBoxLayout" name="verticalLayout_4">
-   <item>
-    <widget class="QSplitter" name="splitter">
-     <property name="orientation">
-         <enum>Qt::Orientation::Horizontal</enum>
-     </property>
-     <widget class="QTabWidget" name="tabWidget">
-      <property name="currentIndex">
-       <number>0</number>
-      </property>
-      <widget class="QWidget" name="tab_1">
-       <attribute name="title">
-        <string>BECDock</string>
-       </attribute>
-       <layout class="QVBoxLayout" name="verticalLayout">
-        <item>
-         <widget class="QWidget" name="dock_placeholder" native="true"/>
-        </item>
-       </layout>
-      </widget>
-      <widget class="QWidget" name="tab_2">
-       <attribute name="title">
-        <string>BECFigure</string>
-       </attribute>
-       <layout class="QVBoxLayout" name="verticalLayout_3">
-        <item>
-         <widget class="QWidget" name="glw" native="true"/>
-        </item>
-       </layout>
-      </widget>
-     </widget>
-     <widget class="QWidget" name="widget_console" native="true"/>
-    </widget>
-   </item>
-  </layout>
- </widget>
- <resources/>
- <connections/>
-</ui>

bec_widgets/examples/motor_movement/motor_control_compilations.py

@@ -1,250 +0,0 @@
-# pylint: disable = no-name-in-module,missing-class-docstring, missing-module-docstring
-
-import qdarktheme
-from qtpy.QtCore import Qt
-from qtpy.QtWidgets import QApplication, QSplitter, QVBoxLayout, QWidget
-
-from bec_widgets.utils.bec_dispatcher import BECDispatcher
-from bec_widgets.widgets.motor_control.motor_control import MotorThread
-from bec_widgets.widgets.motor_control.motor_table.motor_table import MotorCoordinateTable
-from bec_widgets.widgets.motor_control.movement_absolute.movement_absolute import (
-    MotorControlAbsolute,
-)
-from bec_widgets.widgets.motor_control.movement_relative.movement_relative import (
-    MotorControlRelative,
-)
-from bec_widgets.widgets.motor_control.selection.selection import MotorControlSelection
-
-CONFIG_DEFAULT = {
-    "motor_control": {
-        "motor_x": "samx",
-        "motor_y": "samy",
-        "step_size_x": 3,
-        "step_size_y": 3,
-        "precision": 4,
-        "step_x_y_same": False,
-        "move_with_arrows": False,
-    },
-    "plot_settings": {
-        "colormap": "Greys",
-        "scatter_size": 5,
-        "max_points": 1000,
-        "num_dim_points": 100,
-        "precision": 2,
-        "num_columns": 1,
-        "background_value": 25,
-    },
-    "motors": [
-        {
-            "plot_name": "Motor Map",
-            "x_label": "Motor X",
-            "y_label": "Motor Y",
-            "signals": {
-                "x": [{"name": "samx", "entry": "samx"}],
-                "y": [{"name": "samy", "entry": "samy"}],
-            },
-        }
-    ],
-}
-
-
-class MotorControlApp(QWidget):
-    def __init__(self, parent=None, client=None, config=None):
-        super().__init__(parent)
-
-        bec_dispatcher = BECDispatcher()
-        self.client = bec_dispatcher.client if client is None else client
-        self.config = config
-
-        # Widgets
-        self.motor_control_panel = MotorControlPanel(client=self.client, config=self.config)
-        # Create MotorMap
-        # self.motion_map = MotorMap(client=self.client, config=self.config)
-        # Create MotorCoordinateTable
-        self.motor_table = MotorCoordinateTable(client=self.client, config=self.config)
-
-        # Create the splitter and add MotorMap and MotorControlPanel
-        splitter = QSplitter(Qt.Horizontal)
-        # splitter.addWidget(self.motion_map)
-        splitter.addWidget(self.motor_control_panel)
-        splitter.addWidget(self.motor_table)
-
-        # Set the main layout
-        layout = QVBoxLayout(self)
-        layout.addWidget(splitter)
-        self.setLayout(layout)
-
-        # Connecting signals and slots
-        # self.motor_control_panel.selection_widget.selected_motors_signal.connect(
-        #     lambda x, y: self.motion_map.change_motors(x, y, 0)
-        # )
-        self.motor_control_panel.absolute_widget.coordinates_signal.connect(
-            self.motor_table.add_coordinate
-        )
-        self.motor_control_panel.relative_widget.precision_signal.connect(
-            self.motor_table.set_precision
-        )
-        self.motor_control_panel.relative_widget.precision_signal.connect(
-            self.motor_control_panel.absolute_widget.set_precision
-        )
-
-        # self.motor_table.plot_coordinates_signal.connect(self.motion_map.plot_saved_coordinates)
-
-
-class MotorControlMap(QWidget):
-    def __init__(self, parent=None, client=None, config=None):
-        super().__init__(parent)
-
-        bec_dispatcher = BECDispatcher()
-        self.client = bec_dispatcher.client if client is None else client
-        self.config = config
-
-        # Widgets
-        self.motor_control_panel = MotorControlPanel(client=self.client, config=self.config)
-        # Create MotorMap
-        # self.motion_map = MotorMap(client=self.client, config=self.config)
-
-        # Create the splitter and add MotorMap and MotorControlPanel
-        splitter = QSplitter(Qt.Horizontal)
-        # splitter.addWidget(self.motion_map)
-        splitter.addWidget(self.motor_control_panel)
-
-        # Set the main layout
-        layout = QVBoxLayout(self)
-        layout.addWidget(splitter)
-        self.setLayout(layout)
-
-        # Connecting signals and slots
-        # self.motor_control_panel.selection_widget.selected_motors_signal.connect(
-        #     lambda x, y: self.motion_map.change_motors(x, y, 0)
-        # )
-
-
-class MotorControlPanel(QWidget):
-    def __init__(self, parent=None, client=None, config=None):
-        super().__init__(parent)
-
-        bec_dispatcher = BECDispatcher()
-        self.client = bec_dispatcher.client if client is None else client
-        self.config = config
-
-        self.motor_thread = MotorThread(client=self.client)
-
-        self.selection_widget = MotorControlSelection(
-            client=self.client, config=self.config, motor_thread=self.motor_thread
-        )
-        self.relative_widget = MotorControlRelative(
-            client=self.client, config=self.config, motor_thread=self.motor_thread
-        )
-        self.absolute_widget = MotorControlAbsolute(
-            client=self.client, config=self.config, motor_thread=self.motor_thread
-        )
-
-        layout = QVBoxLayout(self)
-
-        layout.addWidget(self.selection_widget)
-        layout.addWidget(self.relative_widget)
-        layout.addWidget(self.absolute_widget)
-
-        # Connecting signals and slots
-        self.selection_widget.selected_motors_signal.connect(self.relative_widget.change_motors)
-        self.selection_widget.selected_motors_signal.connect(self.absolute_widget.change_motors)
-
-        # Set the window to a fixed size based on its contents
-        # self.layout().setSizeConstraint(layout.SetFixedSize)
-
-
-class MotorControlPanelAbsolute(QWidget):
-    def __init__(self, parent=None, client=None, config=None):
-        super().__init__(parent)
-
-        bec_dispatcher = BECDispatcher()
-        self.client = bec_dispatcher.client if client is None else client
-        self.config = config
-
-        self.motor_thread = MotorThread(client=self.client)
-
-        self.selection_widget = MotorControlSelection(
-            client=client, config=config, motor_thread=self.motor_thread
-        )
-        self.absolute_widget = MotorControlAbsolute(
-            client=client, config=config, motor_thread=self.motor_thread
-        )
-
-        layout = QVBoxLayout(self)
-        layout.addWidget(self.selection_widget)
-        layout.addWidget(self.absolute_widget)
-
-        # Connecting signals and slots
-        self.selection_widget.selected_motors_signal.connect(self.absolute_widget.change_motors)
-
-
-class MotorControlPanelRelative(QWidget):
-    def __init__(self, parent=None, client=None, config=None):
-        super().__init__(parent)
-
-        bec_dispatcher = BECDispatcher()
-        self.client = bec_dispatcher.client if client is None else client
-        self.config = config
-
-        self.motor_thread = MotorThread(client=self.client)
-
-        self.selection_widget = MotorControlSelection(
-            client=client, config=config, motor_thread=self.motor_thread
-        )
-        self.relative_widget = MotorControlRelative(
-            client=client, config=config, motor_thread=self.motor_thread
-        )
-
-        layout = QVBoxLayout(self)
-        layout.addWidget(self.selection_widget)
-        layout.addWidget(self.relative_widget)
-
-        # Connecting signals and slots
-        self.selection_widget.selected_motors_signal.connect(self.relative_widget.change_motors)
-
-
-if __name__ == "__main__":  # pragma: no cover
-    import argparse
-    import sys
-
-    parser = argparse.ArgumentParser(description="Run various Motor Control Widgets compositions.")
-    parser.add_argument(
-        "-v",
-        "--variant",
-        type=str,
-        choices=["app", "map", "panel", "panel_abs", "panel_rel"],
-        help="Select the variant of the motor control to run. "
-        "'app' for the full application, "
-        "'map' for MotorMap, "
-        "'panel' for the MotorControlPanel, "
-        "'panel_abs' for MotorControlPanel with absolute control, "
-        "'panel_rel' for MotorControlPanel with relative control.",
-    )
-
-    args = parser.parse_args()
-
-    bec_dispatcher = BECDispatcher()
-    client = bec_dispatcher.client
-    client.start()
-
-    app = QApplication([])
-    qdarktheme.setup_theme("auto")
-
-    if args.variant == "app":
-        window = MotorControlApp(client=client)  # , config=CONFIG_DEFAULT)
-    elif args.variant == "map":
-        window = MotorControlMap(client=client)  # , config=CONFIG_DEFAULT)
-    elif args.variant == "panel":
-        window = MotorControlPanel(client=client)  # , config=CONFIG_DEFAULT)
-    elif args.variant == "panel_abs":
-        window = MotorControlPanelAbsolute(client=client)  # , config=CONFIG_DEFAULT)
-    elif args.variant == "panel_rel":
-        window = MotorControlPanelRelative(client=client)  # , config=CONFIG_DEFAULT)
-    else:
-        print("Please specify a valid variant to run. Use -h for help.")
-        print("Running the full application by default.")
-        window = MotorControlApp(client=client)  # , config=CONFIG_DEFAULT)
-
-    window.show()
-    sys.exit(app.exec())

bec_widgets/examples/motor_movement/motor_controller.ui

@@ -1,926 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<ui version="4.0">
- <class>Form</class>
- <widget class="QWidget" name="Form">
-  <property name="geometry">
-   <rect>
-    <x>0</x>
-    <y>0</y>
-    <width>1561</width>
-    <height>748</height>
-   </rect>
-  </property>
-  <property name="minimumSize">
-   <size>
-    <width>1409</width>
-    <height>748</height>
-   </size>
-  </property>
-  <property name="windowTitle">
-   <string>Motor Controller</string>
-  </property>
-  <layout class="QHBoxLayout" name="horizontalLayout" stretch="8,5,8">
-   <item>
-    <widget class="GraphicsLayoutWidget" name="glw">
-     <property name="enabled">
-      <bool>true</bool>
-     </property>
-    </widget>
-   </item>
-   <item>
-    <widget class="QFrame" name="Controls">
-     <property name="minimumSize">
-      <size>
-       <width>221</width>
-       <height>471</height>
-      </size>
-     </property>
-     <layout class="QVBoxLayout" name="verticalLayout_6" stretch="1,1,1,0,1">
-      <property name="spacing">
-       <number>1</number>
-      </property>
-      <property name="sizeConstraint">
-       <enum>QLayout::SetMinimumSize</enum>
-      </property>
-      <item>
-       <widget class="QGroupBox" name="motorSelection">
-        <property name="minimumSize">
-         <size>
-          <width>261</width>
-          <height>145</height>
-         </size>
-        </property>
-        <property name="title">
-         <string>Motor Selection</string>
-        </property>
-        <layout class="QGridLayout" name="gridLayout_4">
-         <item row="2" column="0">
-          <widget class="QLabel" name="label_8">
-           <property name="text">
-            <string>Motor Y</string>
-           </property>
-          </widget>
-         </item>
-         <item row="1" column="1">
-          <widget class="QComboBox" name="comboBox_motor_x"/>
-         </item>
-         <item row="2" column="1">
-          <widget class="QComboBox" name="comboBox_motor_y"/>
-         </item>
-         <item row="1" column="0">
-          <widget class="QLabel" name="label_5">
-           <property name="text">
-            <string>Motor X</string>
-           </property>
-          </widget>
-         </item>
-         <item row="3" column="0" colspan="2">
-          <widget class="QPushButton" name="pushButton_connecMotors">
-           <property name="text">
-            <string>Connect Motors</string>
-           </property>
-          </widget>
-         </item>
-        </layout>
-       </widget>
-      </item>
-      <item>
-       <spacer name="verticalSpacer_3">
-        <property name="orientation">
-         <enum>Qt::Vertical</enum>
-        </property>
-        <property name="sizeType">
-         <enum>QSizePolicy::Minimum</enum>
-        </property>
-        <property name="sizeHint" stdset="0">
-         <size>
-          <width>20</width>
-          <height>18</height>
-         </size>
-        </property>
-       </spacer>
-      </item>
-      <item>
-       <widget class="QGroupBox" name="motorControl">
-        <property name="minimumSize">
-         <size>
-          <width>261</width>
-          <height>339</height>
-         </size>
-        </property>
-        <property name="title">
-         <string>Motor Relative</string>
-        </property>
-        <layout class="QVBoxLayout" name="verticalLayout_5">
-         <item>
-          <widget class="QCheckBox" name="checkBox_enableArrows">
-           <property name="text">
-            <string>Move with arrow keys</string>
-           </property>
-          </widget>
-         </item>
-         <item>
-          <widget class="QCheckBox" name="checkBox_same_xy">
-           <property name="text">
-            <string>Step [X] = Step [Y]</string>
-           </property>
-          </widget>
-         </item>
-         <item>
-          <layout class="QGridLayout" name="step_grid">
-           <item row="2" column="0">
-            <widget class="QLabel" name="label_step_y">
-             <property name="minimumSize">
-              <size>
-               <width>111</width>
-               <height>19</height>
-              </size>
-             </property>
-             <property name="text">
-              <string>Step [Y]</string>
-             </property>
-            </widget>
-           </item>
-           <item row="0" column="0">
-            <widget class="QLabel" name="label_2">
-             <property name="minimumSize">
-              <size>
-               <width>111</width>
-               <height>19</height>
-              </size>
-             </property>
-             <property name="text">
-              <string>Decimal</string>
-             </property>
-            </widget>
-           </item>
-           <item row="1" column="1">
-            <widget class="QDoubleSpinBox" name="spinBox_step_x">
-             <property name="minimumSize">
-              <size>
-               <width>110</width>
-               <height>19</height>
-              </size>
-             </property>
-             <property name="alignment">
-              <set>Qt::AlignCenter</set>
-             </property>
-             <property name="minimum">
-              <double>0.000000000000000</double>
-             </property>
-             <property name="maximum">
-              <double>99.000000000000000</double>
-             </property>
-             <property name="singleStep">
-              <double>0.100000000000000</double>
-             </property>
-             <property name="value">
-              <double>1.000000000000000</double>
-             </property>
-            </widget>
-           </item>
-           <item row="1" column="0">
-            <widget class="QLabel" name="label_step_x">
-             <property name="minimumSize">
-              <size>
-               <width>111</width>
-               <height>19</height>
-              </size>
-             </property>
-             <property name="text">
-              <string>Step [X]</string>
-             </property>
-            </widget>
-           </item>
-           <item row="2" column="1">
-            <widget class="QDoubleSpinBox" name="spinBox_step_y">
-             <property name="minimumSize">
-              <size>
-               <width>110</width>
-               <height>19</height>
-              </size>
-             </property>
-             <property name="alignment">
-              <set>Qt::AlignCenter</set>
-             </property>
-             <property name="minimum">
-              <double>0.000000000000000</double>
-             </property>
-             <property name="maximum">
-              <double>99.000000000000000</double>
-             </property>
-             <property name="singleStep">
-              <double>0.100000000000000</double>
-             </property>
-             <property name="value">
-              <double>1.000000000000000</double>
-             </property>
-            </widget>
-           </item>
-           <item row="0" column="1">
-            <widget class="QSpinBox" name="spinBox_precision">
-             <property name="minimumSize">
-              <size>
-               <width>110</width>
-               <height>19</height>
-              </size>
-             </property>
-             <property name="alignment">
-              <set>Qt::AlignCenter</set>
-             </property>
-             <property name="maximum">
-              <number>8</number>
-             </property>
-             <property name="value">
-              <number>2</number>
-             </property>
-            </widget>
-           </item>
-          </layout>
-         </item>
-         <item>
-          <layout class="QGridLayout" name="direction_grid">
-           <property name="sizeConstraint">
-            <enum>QLayout::SetDefaultConstraint</enum>
-           </property>
-           <item row="1" column="2" alignment="Qt::AlignHCenter|Qt::AlignVCenter">
-            <widget class="QToolButton" name="toolButton_up">
-             <property name="minimumSize">
-              <size>
-               <width>26</width>
-               <height>26</height>
-              </size>
-             </property>
-             <property name="text">
-              <string>...</string>
-             </property>
-             <property name="arrowType">
-              <enum>Qt::UpArrow</enum>
-             </property>
-            </widget>
-           </item>
-           <item row="2" column="4">
-            <spacer name="horizontalSpacer_2">
-             <property name="orientation">
-              <enum>Qt::Horizontal</enum>
-             </property>
-             <property name="sizeHint" stdset="0">
-              <size>
-               <width>40</width>
-               <height>20</height>
-              </size>
-             </property>
-            </spacer>
-           </item>
-           <item row="3" column="2" alignment="Qt::AlignHCenter|Qt::AlignVCenter">
-            <widget class="QToolButton" name="toolButton_down">
-             <property name="minimumSize">
-              <size>
-               <width>26</width>
-               <height>26</height>
-              </size>
-             </property>
-             <property name="text">
-              <string>...</string>
-             </property>
-             <property name="arrowType">
-              <enum>Qt::DownArrow</enum>
-             </property>
-            </widget>
-           </item>
-           <item row="2" column="1">
-            <widget class="QToolButton" name="toolButton_left">
-             <property name="minimumSize">
-              <size>
-               <width>26</width>
-               <height>26</height>
-              </size>
-             </property>
-             <property name="text">
-              <string>...</string>
-             </property>
-             <property name="arrowType">
-              <enum>Qt::LeftArrow</enum>
-             </property>
-            </widget>
-           </item>
-           <item row="0" column="2">
-            <spacer name="verticalSpacer">
-             <property name="orientation">
-              <enum>Qt::Vertical</enum>
-             </property>
-             <property name="sizeHint" stdset="0">
-              <size>
-               <width>20</width>
-               <height>40</height>
-              </size>
-             </property>
-            </spacer>
-           </item>
-           <item row="2" column="3">
-            <widget class="QToolButton" name="toolButton_right">
-             <property name="minimumSize">
-              <size>
-               <width>26</width>
-               <height>26</height>
-              </size>
-             </property>
-             <property name="text">
-              <string>...</string>
-             </property>
-             <property name="arrowType">
-              <enum>Qt::RightArrow</enum>
-             </property>
-            </widget>
-           </item>
-           <item row="2" column="0">
-            <spacer name="horizontalSpacer">
-             <property name="orientation">
-              <enum>Qt::Horizontal</enum>
-             </property>
-             <property name="sizeHint" stdset="0">
-              <size>
-               <width>40</width>
-               <height>20</height>
-              </size>
-             </property>
-            </spacer>
-           </item>
-           <item row="4" column="2">
-            <spacer name="verticalSpacer_2">
-             <property name="orientation">
-              <enum>Qt::Vertical</enum>
-             </property>
-             <property name="sizeHint" stdset="0">
-              <size>
-               <width>20</width>
-               <height>40</height>
-              </size>
-             </property>
-            </spacer>
-           </item>
-          </layout>
-         </item>
-        </layout>
-       </widget>
-      </item>
-      <item>
-       <spacer name="verticalSpacer_4">
-        <property name="orientation">
-         <enum>Qt::Vertical</enum>
-        </property>
-        <property name="sizeType">
-         <enum>QSizePolicy::Minimum</enum>
-        </property>
-        <property name="sizeHint" stdset="0">
-         <size>
-          <width>20</width>
-          <height>18</height>
-         </size>
-        </property>
-       </spacer>
-      </item>
-      <item>
-       <widget class="QGroupBox" name="motorControl_absolute">
-        <property name="minimumSize">
-         <size>
-          <width>261</width>
-          <height>195</height>
-         </size>
-        </property>
-        <property name="title">
-         <string>Move Absolute</string>
-        </property>
-        <layout class="QVBoxLayout" name="verticalLayout">
-         <item>
-          <widget class="QCheckBox" name="checkBox_save_with_go">
-           <property name="text">
-            <string>Save position with Go</string>
-           </property>
-          </widget>
-         </item>
-         <item>
-          <layout class="QGridLayout" name="gridLayout_3">
-           <item row="1" column="1">
-            <widget class="QDoubleSpinBox" name="spinBox_absolute_y">
-             <property name="alignment">
-              <set>Qt::AlignCenter</set>
-             </property>
-             <property name="minimum">
-              <double>-500.000000000000000</double>
-             </property>
-             <property name="maximum">
-              <double>500.000000000000000</double>
-             </property>
-             <property name="singleStep">
-              <double>0.100000000000000</double>
-             </property>
-            </widget>
-           </item>
-           <item row="1" column="0">
-            <widget class="QDoubleSpinBox" name="spinBox_absolute_x">
-             <property name="alignment">
-              <set>Qt::AlignCenter</set>
-             </property>
-             <property name="minimum">
-              <double>-500.000000000000000</double>
-             </property>
-             <property name="maximum">
-              <double>500.000000000000000</double>
-             </property>
-             <property name="singleStep">
-              <double>0.100000000000000</double>
-             </property>
-            </widget>
-           </item>
-           <item row="0" column="1">
-            <widget class="QLabel" name="label_7">
-             <property name="text">
-              <string>Y</string>
-             </property>
-             <property name="alignment">
-              <set>Qt::AlignCenter</set>
-             </property>
-            </widget>
-           </item>
-           <item row="0" column="0">
-            <widget class="QLabel" name="label_6">
-             <property name="text">
-              <string>X</string>
-             </property>
-             <property name="alignment">
-              <set>Qt::AlignCenter</set>
-             </property>
-            </widget>
-           </item>
-          </layout>
-         </item>
-         <item>
-          <layout class="QHBoxLayout" name="horizontalLayout_2">
-           <item>
-            <widget class="QPushButton" name="pushButton_save">
-             <property name="text">
-              <string>Save</string>
-             </property>
-            </widget>
-           </item>
-           <item>
-            <widget class="QPushButton" name="pushButton_set">
-             <property name="text">
-              <string>Set</string>
-             </property>
-            </widget>
-           </item>
-           <item>
-            <widget class="QPushButton" name="pushButton_go_absolute">
-             <property name="text">
-              <string>Go</string>
-             </property>
-            </widget>
-           </item>
-          </layout>
-         </item>
-         <item>
-          <widget class="QPushButton" name="pushButton_stop">
-           <property name="text">
-            <string>Stop Movement</string>
-           </property>
-          </widget>
-         </item>
-        </layout>
-       </widget>
-      </item>
-     </layout>
-    </widget>
-   </item>
-   <item>
-    <widget class="QTabWidget" name="tabWidget_tables">
-     <property name="enabled">
-      <bool>true</bool>
-     </property>
-     <property name="currentIndex">
-      <number>0</number>
-     </property>
-     <widget class="QWidget" name="tab_coordinates">
-      <attribute name="title">
-       <string>Coordinates</string>
-      </attribute>
-      <layout class="QVBoxLayout" name="verticalLayout_3">
-       <item>
-        <layout class="QHBoxLayout" name="horizontalLayout_3">
-         <item>
-          <spacer name="horizontalSpacer_3">
-           <property name="orientation">
-            <enum>Qt::Horizontal</enum>
-           </property>
-           <property name="sizeHint" stdset="0">
-            <size>
-             <width>40</width>
-             <height>20</height>
-            </size>
-           </property>
-          </spacer>
-         </item>
-         <item>
-          <widget class="QLabel" name="label">
-           <property name="text">
-            <string>Entries Mode:</string>
-           </property>
-          </widget>
-         </item>
-         <item>
-          <widget class="QComboBox" name="comboBox_mode">
-           <item>
-            <property name="text">
-             <string>Individual</string>
-            </property>
-           </item>
-           <item>
-            <property name="text">
-             <string>Start/Stop</string>
-            </property>
-           </item>
-          </widget>
-         </item>
-        </layout>
-       </item>
-       <item>
-        <widget class="QTableWidget" name="tableWidget_coordinates">
-         <property name="selectionMode">
-          <enum>QAbstractItemView::MultiSelection</enum>
-         </property>
-         <property name="selectionBehavior">
-          <enum>QAbstractItemView::SelectRows</enum>
-         </property>
-         <column>
-          <property name="text">
-           <string>Show</string>
-          </property>
-         </column>
-         <column>
-          <property name="text">
-           <string>Move</string>
-          </property>
-         </column>
-         <column>
-          <property name="text">
-           <string>Tag</string>
-          </property>
-         </column>
-         <column>
-          <property name="text">
-           <string>X</string>
-          </property>
-         </column>
-         <column>
-          <property name="text">
-           <string>Y</string>
-          </property>
-         </column>
-        </widget>
-       </item>
-       <item>
-        <layout class="QGridLayout" name="gridLayout">
-         <item row="1" column="1">
-          <widget class="QPushButton" name="pushButton_resize_table">
-           <property name="text">
-            <string>Resize Table</string>
-           </property>
-          </widget>
-         </item>
-         <item row="0" column="1">
-          <widget class="QCheckBox" name="checkBox_resize_auto">
-           <property name="text">
-            <string>Resize Auto</string>
-           </property>
-           <property name="checked">
-            <bool>true</bool>
-           </property>
-          </widget>
-         </item>
-         <item row="1" column="0">
-          <widget class="QPushButton" name="pushButton_importCSV">
-           <property name="text">
-            <string>Import CSV</string>
-           </property>
-          </widget>
-         </item>
-         <item row="0" column="0">
-          <widget class="QPushButton" name="pushButton_exportCSV">
-           <property name="text">
-            <string>Export CSV</string>
-           </property>
-          </widget>
-         </item>
-         <item row="2" column="0">
-          <widget class="QPushButton" name="pushButton_help">
-           <property name="text">
-            <string>Help</string>
-           </property>
-          </widget>
-         </item>
-         <item row="2" column="1">
-          <widget class="QPushButton" name="pushButton_duplicate">
-           <property name="text">
-            <string>Duplicate Last Entry</string>
-           </property>
-          </widget>
-         </item>
-        </layout>
-       </item>
-      </layout>
-     </widget>
-     <widget class="QWidget" name="tab_settings">
-      <attribute name="title">
-       <string>Settings</string>
-      </attribute>
-      <layout class="QVBoxLayout" name="verticalLayout_4">
-       <item>
-        <widget class="QGroupBox" name="motorLimits">
-         <property name="enabled">
-          <bool>false</bool>
-         </property>
-         <property name="title">
-          <string>Motor Limits</string>
-         </property>
-         <layout class="QGridLayout" name="gridLayout_2">
-          <item row="2" column="1">
-           <widget class="QPushButton" name="pushButton_updateLimits">
-            <property name="text">
-             <string>Update</string>
-            </property>
-           </widget>
-          </item>
-          <item row="0" column="1">
-           <widget class="QLabel" name="label_Y_max">
-            <property name="text">
-             <string>+ Y</string>
-            </property>
-            <property name="alignment">
-             <set>Qt::AlignCenter</set>
-            </property>
-           </widget>
-          </item>
-          <item row="4" column="1">
-           <widget class="QLabel" name="label_Y_min">
-            <property name="text">
-             <string>- Y</string>
-            </property>
-            <property name="alignment">
-             <set>Qt::AlignCenter</set>
-            </property>
-           </widget>
-          </item>
-          <item row="1" column="0">
-           <widget class="QLabel" name="label_X_min">
-            <property name="text">
-             <string>- X</string>
-            </property>
-            <property name="alignment">
-             <set>Qt::AlignCenter</set>
-            </property>
-           </widget>
-          </item>
-          <item row="1" column="2">
-           <widget class="QLabel" name="label_X_max">
-            <property name="text">
-             <string>+ X</string>
-            </property>
-            <property name="alignment">
-             <set>Qt::AlignCenter</set>
-            </property>
-           </widget>
-          </item>
-          <item row="1" column="1">
-           <widget class="QDoubleSpinBox" name="spinBox_y_max">
-            <property name="alignment">
-             <set>Qt::AlignCenter</set>
-            </property>
-            <property name="minimum">
-             <double>-1000.000000000000000</double>
-            </property>
-            <property name="maximum">
-             <double>1000.000000000000000</double>
-            </property>
-           </widget>
-          </item>
-          <item row="3" column="1">
-           <widget class="QDoubleSpinBox" name="spinBox_y_min">
-            <property name="alignment">
-             <set>Qt::AlignCenter</set>
-            </property>
-            <property name="minimum">
-             <double>-1000.000000000000000</double>
-            </property>
-            <property name="maximum">
-             <double>1000.000000000000000</double>
-            </property>
-           </widget>
-          </item>
-          <item row="2" column="0">
-           <widget class="QDoubleSpinBox" name="spinBox_x_min">
-            <property name="alignment">
-             <set>Qt::AlignCenter</set>
-            </property>
-            <property name="minimum">
-             <double>-1000.000000000000000</double>
-            </property>
-            <property name="maximum">
-             <double>1000.000000000000000</double>
-            </property>
-           </widget>
-          </item>
-          <item row="2" column="2">
-           <widget class="QDoubleSpinBox" name="spinBox_x_max">
-            <property name="alignment">
-             <set>Qt::AlignCenter</set>
-            </property>
-            <property name="minimum">
-             <double>-1000.000000000000000</double>
-            </property>
-            <property name="maximum">
-             <double>1000.000000000000000</double>
-            </property>
-           </widget>
-          </item>
-         </layout>
-        </widget>
-       </item>
-       <item>
-        <widget class="QGroupBox" name="groupBox_2">
-         <property name="title">
-          <string>Plotting Options</string>
-         </property>
-         <layout class="QGridLayout" name="gridLayout_5">
-          <item row="0" column="1" colspan="2">
-           <widget class="QSpinBox" name="spinBox_max_points">
-            <property name="alignment">
-             <set>Qt::AlignCenter</set>
-            </property>
-            <property name="minimum">
-             <number>100</number>
-            </property>
-            <property name="maximum">
-             <number>10000</number>
-            </property>
-            <property name="singleStep">
-             <number>100</number>
-            </property>
-            <property name="value">
-             <number>5000</number>
-            </property>
-           </widget>
-          </item>
-          <item row="0" column="0">
-           <widget class="QLabel" name="label_15">
-            <property name="text">
-             <string>Max Points</string>
-            </property>
-           </widget>
-          </item>
-          <item row="2" column="1" colspan="2">
-           <widget class="QSpinBox" name="spinBox_scatter_size">
-            <property name="alignment">
-             <set>Qt::AlignCenter</set>
-            </property>
-            <property name="minimum">
-             <number>1</number>
-            </property>
-            <property name="maximum">
-             <number>15</number>
-            </property>
-            <property name="value">
-             <number>5</number>
-            </property>
-           </widget>
-          </item>
-          <item row="2" column="0">
-           <widget class="QLabel" name="label_11">
-            <property name="text">
-             <string>Scatter Size</string>
-            </property>
-           </widget>
-          </item>
-          <item row="3" column="0" colspan="3">
-           <widget class="QPushButton" name="pushButton_update_config">
-            <property name="text">
-             <string>Update Settings</string>
-            </property>
-           </widget>
-          </item>
-          <item row="1" column="1" colspan="2">
-           <widget class="QSpinBox" name="spinBox_num_dim_points">
-            <property name="alignment">
-             <set>Qt::AlignCenter</set>
-            </property>
-            <property name="minimum">
-             <number>10</number>
-            </property>
-            <property name="maximum">
-             <number>1000</number>
-            </property>
-            <property name="singleStep">
-             <number>10</number>
-            </property>
-            <property name="value">
-             <number>100</number>
-            </property>
-           </widget>
-          </item>
-          <item row="1" column="0">
-           <widget class="QLabel" name="label_16">
-            <property name="text">
-             <string>N dim</string>
-            </property>
-           </widget>
-          </item>
-          <item row="4" column="0" colspan="3">
-           <widget class="QPushButton" name="pushButton_enableGUI">
-            <property name="text">
-             <string>Enable Control GUI</string>
-            </property>
-           </widget>
-          </item>
-         </layout>
-        </widget>
-       </item>
-      </layout>
-     </widget>
-     <widget class="QWidget" name="tab_queue">
-      <attribute name="title">
-       <string>Queue</string>
-      </attribute>
-      <layout class="QVBoxLayout" name="verticalLayout_2">
-       <item>
-        <widget class="QLabel" name="label_3">
-         <property name="text">
-          <string>Work in progress</string>
-         </property>
-         <property name="alignment">
-          <set>Qt::AlignCenter</set>
-         </property>
-        </widget>
-       </item>
-       <item>
-        <widget class="QPushButton" name="pushButton_5">
-         <property name="enabled">
-          <bool>false</bool>
-         </property>
-         <property name="text">
-          <string>Reset Queue</string>
-         </property>
-        </widget>
-       </item>
-       <item>
-        <widget class="QTableWidget" name="tableWidget_2">
-         <property name="enabled">
-          <bool>false</bool>
-         </property>
-         <column>
-          <property name="text">
-           <string>queueID</string>
-          </property>
-         </column>
-         <column>
-          <property name="text">
-           <string>scan_id</string>
-          </property>
-         </column>
-         <column>
-          <property name="text">
-           <string>is_scan</string>
-          </property>
-         </column>
-         <column>
-          <property name="text">
-           <string>type</string>
-          </property>
-         </column>
-         <column>
-          <property name="text">
-           <string>scan_number</string>
-          </property>
-         </column>
-         <column>
-          <property name="text">
-           <string>IQ status</string>
-          </property>
-         </column>
-        </widget>
-       </item>
-      </layout>
-     </widget>
-    </widget>
-   </item>
-  </layout>
- </widget>
- <customwidgets>
-  <customwidget>
-   <class>GraphicsLayoutWidget</class>
-   <extends>QGraphicsView</extends>
-   <header>pyqtgraph.h</header>
-  </customwidget>
- </customwidgets>
- <resources/>
- <connections/>
-</ui>

bec_widgets/examples/plugin_example_pyside/main.py

@@ -7,7 +7,8 @@ import sys
 
 from bec_ipython_client.main import BECIPythonClient
 from qtpy.QtWidgets import QApplication
-from tictactoe import TicTacToe
+
+from bec_widgets.examples.plugin_example_pyside.tictactoe import TicTacToe
 
 if __name__ == "__main__":  # pragma: no cover
     app = QApplication(sys.argv)

bec_widgets/examples/plugin_example_pyside/registertictactoe.py

@@ -2,8 +2,9 @@
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 
 from qtpy.QtDesigner import QPyDesignerCustomWidgetCollection
-from tictactoe import TicTacToe
-from tictactoeplugin import TicTacToePlugin
+
+from bec_widgets.examples.plugin_example_pyside.tictactoe import TicTacToe
+from bec_widgets.examples.plugin_example_pyside.tictactoeplugin import TicTacToePlugin
 
 # Set PYSIDE_DESIGNER_PLUGINS to point to this directory and load the plugin
 

bec_widgets/examples/plugin_example_pyside/tictactoeplugin.py

@@ -1,10 +1,13 @@
 # Copyright (C) 2022 The Qt Company Ltd.
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+import os
 
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QIcon
-from tictactoe import TicTacToe
-from tictactoetaskmenu import TicTacToeTaskMenuFactory
+
+import bec_widgets
+from bec_widgets.examples.plugin_example_pyside.tictactoe import TicTacToe
+from bec_widgets.examples.plugin_example_pyside.tictactoetaskmenu import TicTacToeTaskMenuFactory
+from bec_widgets.utils.bec_designer import designer_material_icon
 
 DOM_XML = """
 <ui language='c++'>
@@ -24,6 +27,8 @@ DOM_XML = """
 </ui>
 """
 
+MODULE_PATH = os.path.dirname(bec_widgets.__file__)
+
 
 class TicTacToePlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
     def __init__(self):
@@ -38,10 +43,10 @@ class TicTacToePlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return DOM_XML
 
     def group(self):
-        return ""
+        return "Games"
 
     def icon(self):
-        return QIcon()
+        return designer_material_icon("sports_esports")
 
     def includeFile(self):
         return "tictactoe"

bec_widgets/examples/plugin_example_pyside/tictactoetaskmenu.py

@@ -1,11 +1,12 @@
 # Copyright (C) 2022 The Qt Company Ltd.
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 
-from qtpy.QtCore import Slot
 from qtpy.QtDesigner import QExtensionFactory, QPyDesignerTaskMenuExtension
 from qtpy.QtGui import QAction
 from qtpy.QtWidgets import QDialog, QDialogButtonBox, QVBoxLayout
-from tictactoe import TicTacToe
+
+from bec_widgets.examples.plugin_example_pyside.tictactoe import TicTacToe
+from bec_widgets.qt_utils.error_popups import SafeSlot as Slot
 
 
 class TicTacToeDialog(QDialog):  # pragma: no cover

bec_widgets/qt_utils/compact_popup.py

@@ -0,0 +1,268 @@
+import time
+from types import SimpleNamespace
+
+from bec_qthemes import material_icon
+from qtpy.QtCore import Property, Qt, Signal
+from qtpy.QtGui import QColor
+from qtpy.QtWidgets import (
+    QDialog,
+    QHBoxLayout,
+    QLabel,
+    QPushButton,
+    QSizePolicy,
+    QSpacerItem,
+    QVBoxLayout,
+    QWidget,
+)
+
+from bec_widgets.utils.colors import get_accent_colors
+
+
+class LedLabel(QLabel):
+    success_led = "color: white;border-radius: 10;background-color: qlineargradient(spread:pad, x1:0.145, y1:0.16, x2:1, y2:1, stop:0 %s, stop:1 %s);"
+    emergency_led = "color: white;border-radius: 10;background-color: qlineargradient(spread:pad, x1:0.145, y1:0.16, x2:0.92, y2:0.988636, stop:0 %s, stop:1 %s);"
+    warning_led = "color: white;border-radius: 10;background-color: qlineargradient(spread:pad, x1:0.232, y1:0.272, x2:0.98, y2:0.959773, stop:0 %s, stop:1 %s);"
+    default_led = "color: white;border-radius: 10;background-color: qlineargradient(spread:pad, x1:0.04, y1:0.0565909, x2:0.799, y2:0.795, stop:0 %s, stop:1 %s);"
+
+    def __init__(self, parent=None):
+        super().__init__(parent)
+
+        self.palette = get_accent_colors()
+        if self.palette is None:
+            # no theme!
+            self.palette = SimpleNamespace(
+                default=QColor("blue"),
+                success=QColor("green"),
+                warning=QColor("orange"),
+                emergency=QColor("red"),
+            )
+        self.setState("default")
+        self.setFixedSize(20, 20)
+
+    def setState(self, state: str):
+        match state:
+            case "success":
+                r, g, b, a = self.palette.success.getRgb()
+                self.setStyleSheet(
+                    LedLabel.success_led
+                    % (
+                        f"rgba({r},{g},{b},{a})",
+                        f"rgba({int(r*0.8)},{int(g*0.8)},{int(b*0.8)},{a})",
+                    )
+                )
+            case "default":
+                r, g, b, a = self.palette.default.getRgb()
+                self.setStyleSheet(
+                    LedLabel.default_led
+                    % (
+                        f"rgba({r},{g},{b},{a})",
+                        f"rgba({int(r*0.8)},{int(g*0.8)},{int(b*0.8)},{a})",
+                    )
+                )
+            case "warning":
+                r, g, b, a = self.palette.warning.getRgb()
+                self.setStyleSheet(
+                    LedLabel.warning_led
+                    % (
+                        f"rgba({r},{g},{b},{a})",
+                        f"rgba({int(r*0.8)},{int(g*0.8)},{int(b*0.8)},{a})",
+                    )
+                )
+            case "emergency":
+                r, g, b, a = self.palette.emergency.getRgb()
+                self.setStyleSheet(
+                    LedLabel.emergency_led
+                    % (
+                        f"rgba({r},{g},{b},{a})",
+                        f"rgba({int(r*0.8)},{int(g*0.8)},{int(b*0.8)},{a})",
+                    )
+                )
+            case unknown_state:
+                raise ValueError(
+                    f"Unknown state {repr(unknown_state)}, must be one of default, success, warning or emergency"
+                )
+
+
+class PopupDialog(QDialog):
+    def __init__(self, content_widget):
+        self.parent = content_widget.parent()
+        self.content_widget = content_widget
+
+        super().__init__(self.parent)
+
+        self.setAttribute(Qt.WA_DeleteOnClose)
+
+        self.content_widget.setParent(self)
+        QVBoxLayout(self)
+        self.layout().addWidget(self.content_widget)
+        self.content_widget.setVisible(True)
+
+    def closeEvent(self, event):
+        self.content_widget.setVisible(False)
+        self.content_widget.setParent(self.parent)
+        self.done(True)
+
+
+class CompactPopupWidget(QWidget):
+    """Container widget, that can display its content or have a compact form,
+    in this case clicking on a small button pops the contained widget up.
+
+    In the compact form, a LED-like indicator shows a status indicator.
+    """
+
+    expand = Signal(bool)
+
+    def __init__(self, parent=None, layout=QVBoxLayout):
+        super().__init__(parent)
+
+        self._popup_window = None
+        self._expand_popup = True
+
+        QVBoxLayout(self)
+        self.compact_view_widget = QWidget(self)
+        self.compact_view_widget.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Fixed)
+        QHBoxLayout(self.compact_view_widget)
+        self.compact_view_widget.layout().setSpacing(0)
+        self.compact_view_widget.layout().setContentsMargins(0, 0, 0, 0)
+        self.compact_view_widget.layout().addSpacerItem(
+            QSpacerItem(0, 0, QSizePolicy.Expanding, QSizePolicy.Fixed)
+        )
+        self.compact_label = QLabel(self.compact_view_widget)
+        self.compact_status = LedLabel(self.compact_view_widget)
+        self.compact_show_popup = QPushButton(self.compact_view_widget)
+        self.compact_show_popup.setFlat(True)
+        self.compact_show_popup.setIcon(
+            material_icon(icon_name="expand_content", size=(10, 10), convert_to_pixmap=False)
+        )
+        self.compact_view_widget.layout().addWidget(self.compact_label)
+        self.compact_view_widget.layout().addWidget(self.compact_status)
+        self.compact_view_widget.layout().addWidget(self.compact_show_popup)
+        self.compact_view_widget.setVisible(False)
+        self.layout().addWidget(self.compact_view_widget)
+        self.container = QWidget(self)
+        self.layout().addWidget(self.container)
+        self.container.setVisible(True)
+        layout(self.container)
+        self.layout = self.container.layout()
+
+        self.compact_show_popup.clicked.connect(self.show_popup)
+
+    def set_global_state(self, state: str):
+        """Set the LED-indicator state
+
+        The LED indicator represents the 'global' state. State can be one of the
+        following: "default", "success", "warning", "emergency"
+        """
+        self.compact_status.setState(state)
+
+    def show_popup(self):
+        """Display the contained widgets in a popup dialog"""
+        if self._expand_popup:
+            # show popup
+            self._popup_window = PopupDialog(self.container)
+            self._popup_window.show()
+            self._popup_window.finished.connect(lambda: self.expand.emit(False))
+            self.expand.emit(True)
+        else:
+            if self.compact_view:
+                # expand in place
+                self.compact_view = False
+                self.compact_view_widget.setVisible(True)
+                self.compact_label.setVisible(False)
+                self.compact_status.setVisible(False)
+                self.compact_show_popup.setIcon(
+                    material_icon(
+                        icon_name="collapse_content", size=(10, 10), convert_to_pixmap=False
+                    )
+                )
+                self.expand.emit(True)
+            else:
+                # back to compact form
+                self.compact_label.setVisible(True)
+                self.compact_status.setVisible(True)
+                self.compact_show_popup.setIcon(
+                    material_icon(
+                        icon_name="expand_content", size=(10, 10), convert_to_pixmap=False
+                    )
+                )
+                self.compact_view = True
+                self.expand.emit(False)
+
+    def setSizePolicy(self, size_policy1, size_policy2=None):
+        # setting size policy on the compact popup widget will set
+        # the policy for the container, and for itself
+        if size_policy2 is None:
+            # assuming first form: setSizePolicy(QSizePolicy)
+            self.container.setSizePolicy(size_policy1)
+            QWidget.setSizePolicy(self, size_policy1)
+        else:
+            self.container.setSizePolicy(size_policy1, size_policy2)
+            QWidget.setSizePolicy(self, size_policy1, size_policy2)
+
+    def addWidget(self, widget):
+        """Add a widget to the popup container
+
+        The popup container corresponds to the "full view" (not compact)
+        The widget is reparented to the container, and added to the container layout
+        """
+        widget.setParent(self.container)
+        self.container.layout().addWidget(widget)
+
+    @Property(bool)
+    def compact_view(self):
+        return self.compact_label.isVisible()
+
+    @compact_view.setter
+    def compact_view(self, set_compact: bool):
+        """Sets the compact form
+
+        If set_compact is True, the compact view is displayed ; otherwise,
+        the full view is displayed. This is handled by toggling visibility of
+        the container widget or the compact view widget.
+        """
+        if set_compact:
+            self.compact_view_widget.setVisible(True)
+            self.container.setVisible(False)
+            QWidget.setSizePolicy(self, QSizePolicy.Fixed, QSizePolicy.Fixed)
+        else:
+            self.compact_view_widget.setVisible(False)
+            self.container.setVisible(True)
+            QWidget.setSizePolicy(self, self.container.sizePolicy())
+        if self.parentWidget():
+            self.parentWidget().adjustSize()
+        else:
+            self.adjustSize()
+
+    @Property(str)
+    def label(self):
+        return self.compact_label.text()
+
+    @label.setter
+    def label(self, compact_label_text: str):
+        """Set the label text associated to the compact view"""
+        self.compact_label.setText(compact_label_text)
+
+    @Property(str)
+    def tooltip(self):
+        return self.compact_label.toolTip()
+
+    @tooltip.setter
+    def tooltip(self, tooltip: str):
+        """Set the tooltip text associated to the compact view"""
+        self.compact_label.setToolTip(tooltip)
+        self.compact_status.setToolTip(tooltip)
+
+    @Property(bool)
+    def expand_popup(self):
+        return self._expand_popup
+
+    @expand_popup.setter
+    def expand_popup(self, popup: bool):
+        self._expand_popup = popup
+
+    def closeEvent(self, event):
+        # Called by Qt, on closing - since the children widgets can be
+        # BECWidgets, it is good to explicitely call 'close' on them,
+        # to ensure proper resources cleanup
+        for child in self.container.findChildren(QWidget, options=Qt.FindDirectChildrenOnly):
+            child.close()

bec_widgets/qt_utils/error_popups.py

@@ -0,0 +1,214 @@
+import functools
+import sys
+import traceback
+
+from qtpy.QtCore import QObject, Qt, Signal, Slot
+from qtpy.QtWidgets import QApplication, QMessageBox, QPushButton, QVBoxLayout, QWidget
+
+
+def SafeSlot(*slot_args, **slot_kwargs):  # pylint: disable=invalid-name
+    """Function with args, acting like a decorator, applying "error_managed" decorator + Qt Slot
+    to the passed function, to display errors instead of potentially raising an exception
+
+    'popup_error' keyword argument can be passed with boolean value if a dialog should pop up,
+    otherwise error display is left to the original exception hook
+    """
+    popup_error = bool(slot_kwargs.pop("popup_error", False))
+
+    def error_managed(method):
+        @Slot(*slot_args, **slot_kwargs)
+        @functools.wraps(method)
+        def wrapper(*args, **kwargs):
+            try:
+                return method(*args, **kwargs)
+            except Exception:
+                ErrorPopupUtility().custom_exception_hook(*sys.exc_info(), popup_error=popup_error)
+
+        return wrapper
+
+    return error_managed
+
+
+class WarningPopupUtility(QObject):
+    """
+    Utility class to show warning popups in the application.
+    """
+
+    @SafeSlot(str, str, str, QWidget)
+    def show_warning_message(self, title, message, detailed_text, widget):
+        msg = QMessageBox(widget)
+        msg.setIcon(QMessageBox.Warning)
+        msg.setWindowTitle(title)
+        msg.setText(message)
+        msg.setStandardButtons(QMessageBox.Ok)
+        msg.setDetailedText(detailed_text)
+        msg.exec_()
+
+    def show_warning(self, title: str, message: str, detailed_text: str, widget: QWidget = None):
+        """
+        Show a warning message with the given title, message, and detailed text.
+
+        Args:
+            title (str): The title of the warning message.
+            message (str): The main text of the warning message.
+            detailed_text (str): The detailed text to show when the user expands the message.
+            widget (QWidget): The parent widget for the message box.
+        """
+        self.show_warning_message(title, message, detailed_text, widget)
+
+
+_popup_utility_instance = None
+
+
+class _ErrorPopupUtility(QObject):
+    """
+    Utility class to manage error popups in the application to show error messages to the users.
+    This class is singleton and the error popup can be enabled or disabled globally or attach to widget methods with decorator @error_managed.
+    """
+
+    error_occurred = Signal(str, str, QWidget)
+
+    def __init__(self, parent=None):
+        super().__init__(parent=parent)
+        self.error_occurred.connect(self.show_error_message)
+        self.enable_error_popup = False
+        self._initialized = True
+        sys.excepthook = self.custom_exception_hook
+
+    @SafeSlot(str, str, QWidget)
+    def show_error_message(self, title, message, widget):
+        detailed_text = self.format_traceback(message)
+        error_message = self.parse_error_message(detailed_text)
+
+        msg = QMessageBox(widget)
+        msg.setIcon(QMessageBox.Critical)
+        msg.setWindowTitle(title)
+        msg.setText(error_message)
+        msg.setStandardButtons(QMessageBox.Ok)
+        msg.setDetailedText(detailed_text)
+        msg.setTextInteractionFlags(Qt.TextSelectableByMouse)
+        msg.setMinimumWidth(600)
+        msg.setMinimumHeight(400)
+        msg.exec_()
+
+    def format_traceback(self, traceback_message: str) -> str:
+        """
+        Format the traceback message to be displayed in the error popup by adding indentation to each line.
+
+        Args:
+            traceback_message(str): The traceback message to be formatted.
+
+        Returns:
+            str: The formatted traceback message.
+        """
+        formatted_lines = []
+        lines = traceback_message.split("\n")
+        for line in lines:
+            formatted_lines.append("    " + line)  # Add indentation to each line
+        return "\n".join(formatted_lines)
+
+    def parse_error_message(self, traceback_message):
+        lines = traceback_message.split("\n")
+        error_message = "Error occurred. See details."
+        capture = False
+        captured_message = []
+
+        for line in lines:
+            if "raise" in line:
+                capture = True
+                continue
+            if capture:
+                if line.strip() and not line.startswith("  File "):
+                    captured_message.append(line.strip())
+                else:
+                    break
+
+        if captured_message:
+            error_message = " ".join(captured_message)
+        return error_message
+
+    def custom_exception_hook(self, exctype, value, tb, popup_error=False):
+        if popup_error or self.enable_error_popup:
+            error_message = traceback.format_exception(exctype, value, tb)
+            self.error_occurred.emit(
+                "Method error" if popup_error else "Application Error",
+                "".join(error_message),
+                self.parent(),
+            )
+        else:
+            sys.__excepthook__(exctype, value, tb)  # Call the original excepthook
+
+    def enable_global_error_popups(self, state: bool):
+        """
+        Enable or disable global error popups for all applications.
+
+        Args:
+            state(bool): True to enable error popups, False to disable error popups.
+        """
+        self.enable_error_popup = bool(state)
+
+
+def ErrorPopupUtility():
+    global _popup_utility_instance
+    if not _popup_utility_instance:
+        _popup_utility_instance = _ErrorPopupUtility()
+    return _popup_utility_instance
+
+
+class ExampleWidget(QWidget):  # pragma: no cover
+    """
+    Example widget to demonstrate error handling with the ErrorPopupUtility.
+
+    Warnings -> This example works properly only with PySide6, PyQt6 has a bug with the error handling.
+    """
+
+    def __init__(self, parent=None):
+        super().__init__(parent=parent)
+        self.init_ui()
+        self.warning_utility = WarningPopupUtility(self)
+
+    def init_ui(self):
+        self.layout = QVBoxLayout(self)
+
+        # Button to trigger method with error handling
+        self.error_button = QPushButton("Trigger Handled Error", self)
+        self.error_button.clicked.connect(self.method_with_error_handling)
+        self.layout.addWidget(self.error_button)
+
+        # Button to trigger method without error handling
+        self.normal_button = QPushButton("Trigger Normal Error", self)
+        self.normal_button.clicked.connect(self.method_without_error_handling)
+        self.layout.addWidget(self.normal_button)
+
+        # Button to trigger warning popup
+        self.warning_button = QPushButton("Trigger Warning", self)
+        self.warning_button.clicked.connect(self.trigger_warning)
+        self.layout.addWidget(self.warning_button)
+
+    @SafeSlot(popup_error=True)
+    def method_with_error_handling(self):
+        """This method raises an error and the exception is handled by the decorator."""
+        raise ValueError("This is a handled error.")
+
+    @SafeSlot()
+    def method_without_error_handling(self):
+        """This method raises an error and the exception is not handled here."""
+        raise ValueError("This is an unhandled error.")
+
+    @SafeSlot()
+    def trigger_warning(self):
+        """Trigger a warning using the WarningPopupUtility."""
+        self.warning_utility.show_warning(
+            title="Warning",
+            message="This is a warning message.",
+            detailed_text="This is the detailed text of the warning message.",
+            widget=self,
+        )
+
+
+if __name__ == "__main__":  # pragma: no cover
+
+    app = QApplication(sys.argv)
+    widget = ExampleWidget()
+    widget.show()
+    sys.exit(app.exec_())

bec_widgets/qt_utils/palette_viewer.py

@@ -0,0 +1,183 @@
+from qtpy.QtCore import Qt
+from qtpy.QtWidgets import (
+    QApplication,
+    QFrame,
+    QGridLayout,
+    QHBoxLayout,
+    QLabel,
+    QScrollArea,
+    QSizePolicy,
+    QVBoxLayout,
+    QWidget,
+)
+
+from bec_widgets.utils.bec_widget import BECWidget
+from bec_widgets.utils.colors import get_accent_colors, get_theme_palette
+from bec_widgets.widgets.dark_mode_button.dark_mode_button import DarkModeButton
+
+
+class PaletteViewer(BECWidget, QWidget):
+    """
+    This class is a widget that displays current palette colors.
+    """
+
+    ICON_NAME = "palette"
+
+    def __init__(self, *args, parent=None, **kwargs):
+        super().__init__(*args, theme_update=True, **kwargs)
+        QWidget.__init__(self, parent=parent)
+        self.setFixedSize(400, 600)
+        layout = QVBoxLayout(self)
+        dark_mode_button = DarkModeButton(self)
+        layout.addWidget(dark_mode_button)
+
+        # Create a scroll area to hold the color boxes
+        scroll_area = QScrollArea(self)
+        scroll_area.setWidgetResizable(True)
+        scroll_area.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Expanding)
+
+        # Create a frame to hold the color boxes
+        self.frame = QFrame(self)
+        self.frame_layout = QGridLayout(self.frame)
+        self.frame_layout.setSpacing(0)
+        self.frame_layout.setContentsMargins(0, 0, 0, 0)
+
+        scroll_area.setWidget(self.frame)
+        layout.addWidget(scroll_area)
+
+        self.setLayout(layout)
+
+        self.update_palette()
+
+    def apply_theme(self, theme) -> None:
+        """
+        Apply the theme to the widget.
+
+        Args:
+            theme (str): The theme to apply.
+        """
+        self.update_palette()
+
+    def clear_palette(self) -> None:
+        """
+        Clear the palette colors from the frame.
+        Recursively removes all widgets and layouts in the frame layout.
+        """
+        # Iterate over all items in the layout in reverse to safely remove them
+        for i in reversed(range(self.frame_layout.count())):
+            item = self.frame_layout.itemAt(i)
+
+            # If the item is a layout, clear its contents
+            if isinstance(item, QHBoxLayout):
+                # Recursively remove all widgets from the layout
+                for j in reversed(range(item.count())):
+                    widget = item.itemAt(j).widget()
+                    if widget:
+                        item.removeWidget(widget)
+                        widget.deleteLater()
+                self.frame_layout.removeItem(item)
+
+            # If the item is a widget, remove and delete it
+            elif item.widget():
+                widget = item.widget()
+                self.frame_layout.removeWidget(widget)
+                widget.deleteLater()
+
+    def update_palette(self) -> None:
+        """
+        Update the palette colors in the frame.
+        """
+        self.clear_palette()
+        palette_label = QLabel("Palette Colors (e.g. palette.windowText().color())")
+        palette_label.setStyleSheet("font-weight: bold;")
+        self.frame_layout.addWidget(palette_label, 0, 0)
+
+        palette = get_theme_palette()
+        # Add the palette colors (roles) to the frame
+        palette_roles = [
+            palette.windowText,
+            palette.toolTipText,
+            palette.placeholderText,
+            palette.text,
+            palette.buttonText,
+            palette.highlight,
+            palette.link,
+            palette.light,
+            palette.midlight,
+            palette.mid,
+            palette.shadow,
+            palette.button,
+            palette.brightText,
+            palette.toolTipBase,
+            palette.alternateBase,
+            palette.dark,
+            palette.base,
+            palette.window,
+            palette.highlightedText,
+            palette.linkVisited,
+        ]
+
+        offset = 1
+        for i, pal in enumerate(palette_roles):
+            i += offset
+            color = pal().color()
+            label_layout = QHBoxLayout()
+            color_label = QLabel(f"{pal().color().name()} ({pal.__name__})")
+            background_label = self.background_label_with_clipboard(color)
+            label_layout.addWidget(color_label)
+            label_layout.addWidget(background_label)
+            self.frame_layout.addLayout(label_layout, i, 0)
+
+        # add a horizontal spacer
+        spacer = QLabel()
+        spacer.setSizePolicy(QSizePolicy.Expanding, QSizePolicy.Minimum)
+        self.frame_layout.addWidget(spacer, i + 1, 0)
+
+        accent_colors_label = QLabel("Accent Colors (e.g. accent_colors.default)")
+        accent_colors_label.setStyleSheet("font-weight: bold;")
+        self.frame_layout.addWidget(accent_colors_label, i + 2, 0)
+
+        accent_colors = get_accent_colors()
+        items = [
+            (accent_colors.default, "default"),
+            (accent_colors.success, "success"),
+            (accent_colors.warning, "warning"),
+            (accent_colors.emergency, "emergency"),
+            (accent_colors.highlight, "highlight"),
+        ]
+
+        offset = len(palette_roles) + 2
+        for i, (color, name) in enumerate(items):
+            i += offset
+            label_layout = QHBoxLayout()
+            color_label = QLabel(f"{color.name()} ({name})")
+            background_label = self.background_label_with_clipboard(color)
+            label_layout.addWidget(color_label)
+            label_layout.addWidget(background_label)
+            self.frame_layout.addLayout(label_layout, i + 2, 0)
+
+    def background_label_with_clipboard(self, color) -> QLabel:
+        """
+        Create a label with a background color that copies the color to the clipboard when clicked.
+
+        Args:
+            color (QColor): The color to display in the background.
+
+        Returns:
+            QLabel: The label with the background color.
+        """
+        button = QLabel()
+        button.setStyleSheet(f"QLabel {{ background-color: {color.name()}; }}")
+        button.setToolTip("Click to copy color to clipboard")
+        button.setCursor(Qt.PointingHandCursor)
+        button.mousePressEvent = lambda event: QApplication.clipboard().setText(color.name())
+        return button
+
+
+if __name__ == "__main__":  # pragma: no cover
+    import sys
+
+    app = QApplication(sys.argv)
+    viewer = PaletteViewer()
+    viewer.show()
+    sys.exit(app.exec_())

bec_widgets/qt_utils/redis_message_waiter.py

@@ -0,0 +1,47 @@
+from bec_lib.serialization import MsgpackSerialization
+from bec_lib.utils import lazy_import_from
+from qtpy.QtCore import QEventLoop, QSocketNotifier, QTimer
+
+MessageObject = lazy_import_from("bec_lib.connector", ("MessageObject",))
+
+
+class QtRedisMessageWaiter:
+    def __init__(self, redis_connector, message_to_wait):
+        self.ev_loop = QEventLoop()
+        self.response = None
+        self.connector = redis_connector
+        self.message_to_wait = message_to_wait
+        self.pubsub = redis_connector._redis_conn.pubsub()
+        self.pubsub.subscribe(self.message_to_wait.endpoint)
+        fd = self.pubsub.connection._sock.fileno()
+        self.notifier = QSocketNotifier(fd, QSocketNotifier.Read)
+        self.notifier.activated.connect(self._pubsub_readable)
+
+    def _msg_received(self, msg_obj):
+        self.response = msg_obj.value
+        self.ev_loop.quit()
+
+    def wait(self, timeout=1):
+        timer = QTimer()
+        timer.singleShot(timeout * 1000, self.ev_loop.quit)
+        self.ev_loop.exec_()
+        timer.stop()
+        self.notifier.setEnabled(False)
+        self.pubsub.close()
+        return self.response
+
+    def _pubsub_readable(self, fd):
+        while True:
+            msg = self.pubsub.get_message()
+            if msg:
+                if msg["type"] == "subscribe":
+                    # get_message buffers, so we may already have the answer
+                    # let's check...
+                    continue
+                else:
+                    break
+            else:
+                return
+        channel = msg["channel"].decode()
+        msg = MessageObject(topic=channel, value=MsgpackSerialization.loads(msg["data"]))
+        self.connector._execute_callback(self._msg_received, msg, {})

bec_widgets/qt_utils/settings_dialog.py

@@ -0,0 +1,119 @@
+from qtpy.QtWidgets import QDialog, QDialogButtonBox, QHBoxLayout, QPushButton, QVBoxLayout, QWidget
+
+from bec_widgets.qt_utils.error_popups import SafeSlot as Slot
+
+
+class SettingWidget(QWidget):
+    """
+    Abstract class for a settings widget to enforce the implementation of the accept_changes and display_current_settings.
+    Can be used for toolbar actions to display the settings of a widget.
+
+    Args:
+        target_widget (QWidget): The widget that the settings will be taken from and applied to.
+    """
+
+    def __init__(self, parent=None, *args, **kwargs):
+        super().__init__(parent, *args, **kwargs)
+
+        self.target_widget = None
+
+    def set_target_widget(self, target_widget: QWidget):
+        self.target_widget = target_widget
+
+    @Slot()
+    def accept_changes(self):
+        """
+        Accepts the changes made in the settings widget and applies them to the target widget.
+        """
+        pass
+
+    @Slot(dict)
+    def display_current_settings(self, config_dict: dict):
+        """
+        Displays the current settings of the target widget in the settings widget.
+
+        Args:
+            config_dict(dict): The current settings of the target widget.
+        """
+        pass
+
+
+class SettingsDialog(QDialog):
+    """
+    Dialog to display and edit the settings of a widget with accept and cancel buttons.
+
+    Args:
+        parent (QWidget): The parent widget of the dialog.
+        target_widget (QWidget): The widget that the settings will be taken from and applied to.
+        settings_widget (SettingWidget): The widget that will display the settings.
+    """
+
+    def __init__(
+        self,
+        parent=None,
+        settings_widget: SettingWidget = None,
+        window_title: str = "Settings",
+        config: dict = None,
+        *args,
+        **kwargs,
+    ):
+        super().__init__(parent, *args, **kwargs)
+
+        self.setModal(False)
+
+        self.setWindowTitle(window_title)
+
+        self.widget = settings_widget
+        self.widget.set_target_widget(parent)
+        if config is None:
+            config = parent.get_config()
+
+        self.widget.display_current_settings(config)
+
+        self.button_box = QDialogButtonBox(QDialogButtonBox.Ok | QDialogButtonBox.Cancel)
+
+        self.apply_button = QPushButton("Apply")
+
+        button_layout = QHBoxLayout()
+        button_layout.addWidget(self.button_box.button(QDialogButtonBox.Cancel))
+        button_layout.addWidget(self.apply_button)
+        button_layout.addWidget(self.button_box.button(QDialogButtonBox.Ok))
+
+        self.button_box.accepted.connect(self.accept)
+        self.button_box.rejected.connect(self.reject)
+        self.apply_button.clicked.connect(self.apply_changes)
+
+        self.layout = QVBoxLayout(self)
+        self.layout.setContentsMargins(5, 5, 5, 5)
+        self.layout.addWidget(self.widget)
+        self.layout.addLayout(button_layout)
+
+        ok_button = self.button_box.button(QDialogButtonBox.Ok)
+        ok_button.setDefault(True)
+        ok_button.setAutoDefault(True)
+
+    @Slot()
+    def accept(self):
+        """
+        Accept the changes made in the settings widget and close the dialog.
+        """
+        self.widget.accept_changes()
+        super().accept()
+
+    @Slot()
+    def apply_changes(self):
+        """
+        Apply the changes made in the settings widget without closing the dialog.
+        """
+        self.widget.accept_changes()
+
+    def cleanup(self):
+        """
+        Cleanup the dialog.
+        """
+        self.button_box.close()
+        self.button_box.deleteLater()
+
+    def closeEvent(self, event):
+        self.cleanup()
+        super().closeEvent(event)

bec_widgets/qt_utils/toolbar.py

@@ -0,0 +1,296 @@
+# pylint: disable=no-name-in-module
+from __future__ import annotations
+
+import os
+from abc import ABC, abstractmethod
+from collections import defaultdict
+from typing import Literal
+
+from bec_qthemes._icon.material_icons import material_icon
+from qtpy.QtCore import QSize, Qt
+from qtpy.QtGui import QAction, QColor, QIcon
+from qtpy.QtWidgets import (
+    QComboBox,
+    QHBoxLayout,
+    QLabel,
+    QMenu,
+    QSizePolicy,
+    QToolBar,
+    QToolButton,
+    QWidget,
+)
+
+import bec_widgets
+
+MODULE_PATH = os.path.dirname(bec_widgets.__file__)
+
+
+class ToolBarAction(ABC):
+    """
+    Abstract base class for toolbar actions.
+
+    Args:
+        icon_path (str, optional): The name of the icon file from `assets/toolbar_icons`. Defaults to None.
+        tooltip (bool, optional): The tooltip for the action. Defaults to None.
+        checkable (bool, optional): Whether the action is checkable. Defaults to False.
+    """
+
+    def __init__(self, icon_path: str = None, tooltip: str = None, checkable: bool = False):
+        self.icon_path = (
+            os.path.join(MODULE_PATH, "assets", "toolbar_icons", icon_path) if icon_path else None
+        )
+        self.tooltip = tooltip
+        self.checkable = checkable
+        self.action = None
+
+    @abstractmethod
+    def add_to_toolbar(self, toolbar: QToolBar, target: QWidget):
+        """Adds an action or widget to a toolbar.
+
+        Args:
+            toolbar (QToolBar): The toolbar to add the action or widget to.
+            target (QWidget): The target widget for the action.
+        """
+
+
+class SeparatorAction(ToolBarAction):
+    """Separator action for the toolbar."""
+
+    def add_to_toolbar(self, toolbar: QToolBar, target: QWidget):
+        toolbar.addSeparator()
+
+
+class IconAction(ToolBarAction):
+    """
+    Action with an icon for the toolbar.
+
+    Args:
+        icon_path (str): The path to the icon file.
+        tooltip (str): The tooltip for the action.
+        checkable (bool, optional): Whether the action is checkable. Defaults to False.
+    """
+
+    def __init__(self, icon_path: str = None, tooltip: str = None, checkable: bool = False):
+        super().__init__(icon_path, tooltip, checkable)
+
+    def add_to_toolbar(self, toolbar: QToolBar, target: QWidget):
+        icon = QIcon()
+        icon.addFile(self.icon_path, size=QSize(20, 20))
+        self.action = QAction(icon, self.tooltip, target)
+        self.action.setCheckable(self.checkable)
+        toolbar.addAction(self.action)
+
+
+class MaterialIconAction:
+    """
+    Action with a Material icon for the toolbar.
+
+    Args:
+        icon_path (str, optional): The name of the Material icon. Defaults to None.
+        tooltip (bool, optional): The tooltip for the action. Defaults to None.
+        checkable (bool, optional): Whether the action is checkable. Defaults to False.
+        filled (bool, optional): Whether the icon is filled. Defaults to False.
+    """
+
+    def __init__(
+        self,
+        icon_name: str = None,
+        tooltip: str = None,
+        checkable: bool = False,
+        filled: bool = False,
+        color: str | tuple | QColor | dict[Literal["dark", "light"], str] | None = None,
+    ):
+        self.icon_name = icon_name
+        self.tooltip = tooltip
+        self.checkable = checkable
+        self.action = None
+        self.filled = filled
+        self.color = color
+
+    def add_to_toolbar(self, toolbar: QToolBar, target: QWidget):
+        icon = self.get_icon()
+        self.action = QAction(icon, self.tooltip, target)
+        self.action.setCheckable(self.checkable)
+        toolbar.addAction(self.action)
+
+    def get_icon(self):
+
+        icon = material_icon(
+            self.icon_name,
+            size=(20, 20),
+            convert_to_pixmap=False,
+            filled=self.filled,
+            color=self.color,
+        )
+        return icon
+
+
+class DeviceSelectionAction(ToolBarAction):
+    """
+    Action for selecting a device in a combobox.
+
+    Args:
+        label (str): The label for the combobox.
+        device_combobox (DeviceComboBox): The combobox for selecting the device.
+
+    """
+
+    def __init__(self, label: str, device_combobox):
+        super().__init__()
+        self.label = label
+        self.device_combobox = device_combobox
+        self.device_combobox.currentIndexChanged.connect(lambda: self.set_combobox_style("#ffa700"))
+
+    def add_to_toolbar(self, toolbar, target):
+        widget = QWidget()
+        layout = QHBoxLayout(widget)
+        label = QLabel(f"{self.label}")
+        layout.addWidget(label)
+        layout.addWidget(self.device_combobox)
+        toolbar.addWidget(widget)
+
+    def set_combobox_style(self, color: str):
+        self.device_combobox.setStyleSheet(f"QComboBox {{ background-color: {color}; }}")
+
+
+class WidgetAction(ToolBarAction):
+    """
+    Action for adding any widget to the toolbar.
+
+    Args:
+        label (str|None): The label for the widget.
+        widget (QWidget): The widget to be added to the toolbar.
+
+    """
+
+    def __init__(self, label: str | None = None, widget: QWidget = None, parent=None):
+        super().__init__(parent)
+        self.label = label
+        self.widget = widget
+
+    def add_to_toolbar(self, toolbar: QToolBar, target: QWidget):
+        container = QWidget()
+        layout = QHBoxLayout(container)
+        layout.setContentsMargins(0, 0, 0, 0)
+        layout.setSpacing(5)
+
+        if self.label is not None:
+            label_widget = QLabel(f"{self.label}")
+            label_widget.setSizePolicy(QSizePolicy.Minimum, QSizePolicy.Fixed)
+            label_widget.setAlignment(Qt.AlignVCenter | Qt.AlignRight)
+            layout.addWidget(label_widget)
+
+        if isinstance(self.widget, QComboBox):
+            self.widget.setSizeAdjustPolicy(QComboBox.AdjustToContents)
+
+            size_policy = QSizePolicy(QSizePolicy.Expanding, QSizePolicy.Fixed)
+            self.widget.setSizePolicy(size_policy)
+
+            self.widget.setMinimumWidth(self.calculate_minimum_width(self.widget))
+
+        else:
+            self.widget.setSizePolicy(QSizePolicy.Preferred, QSizePolicy.Fixed)
+
+        layout.addWidget(self.widget)
+
+        toolbar.addWidget(container)
+
+    @staticmethod
+    def calculate_minimum_width(combo_box: QComboBox) -> int:
+        """
+        Calculate the minimum width required to display the longest item in the combo box.
+
+        Args:
+            combo_box (QComboBox): The combo box to calculate the width for.
+
+        Returns:
+            int: The calculated minimum width in pixels.
+        """
+        font_metrics = combo_box.fontMetrics()
+        max_width = max(font_metrics.width(combo_box.itemText(i)) for i in range(combo_box.count()))
+        return max_width + 60
+
+
+class ExpandableMenuAction(ToolBarAction):
+    """
+    Action for an expandable menu in the toolbar.
+
+    Args:
+        label (str): The label for the menu.
+        actions (dict): A dictionary of actions to populate the menu.
+        icon_path (str, optional): The path to the icon file. Defaults to None.
+
+    """
+
+    def __init__(self, label: str, actions: dict, icon_path: str = None):
+        super().__init__(icon_path, label)
+        self.actions = actions
+        self.widgets = defaultdict(dict)
+
+    def add_to_toolbar(self, toolbar: QToolBar, target: QWidget):
+        button = QToolButton(toolbar)
+        if self.icon_path:
+            button.setIcon(QIcon(self.icon_path))
+        button.setText(self.tooltip)
+        button.setPopupMode(QToolButton.InstantPopup)
+        button.setStyleSheet(
+            """
+                   QToolButton {
+                       font-size: 14px;
+                   }
+                   QMenu {
+                       font-size: 14px;
+                   }
+               """
+        )
+        menu = QMenu(button)
+        for action_id, action in self.actions.items():
+            sub_action = QAction(action.tooltip, target)
+            if hasattr(action, "icon_path"):
+                icon = QIcon()
+                icon.addFile(action.icon_path, size=QSize(20, 20))
+                sub_action.setIcon(icon)
+            elif hasattr(action, "get_icon"):
+                sub_action.setIcon(action.get_icon())
+            sub_action.setCheckable(action.checkable)
+            menu.addAction(sub_action)
+            self.widgets[action_id] = sub_action
+        button.setMenu(menu)
+        toolbar.addWidget(button)
+
+
+class ModularToolBar(QToolBar):
+    """Modular toolbar with optional automatic initialization.
+    Args:
+        parent (QWidget, optional): The parent widget of the toolbar. Defaults to None.
+        actions (list[ToolBarAction], optional): A list of action creators to populate the toolbar. Defaults to None.
+        target_widget (QWidget, optional): The widget that the actions will target. Defaults to None.
+    """
+
+    def __init__(self, parent=None, actions: dict | None = None, target_widget=None):
+        super().__init__(parent)
+
+        self.widgets = defaultdict(dict)
+        self.set_background_color()
+
+        if actions is not None and target_widget is not None:
+            self.populate_toolbar(actions, target_widget)
+
+    def populate_toolbar(self, actions: dict, target_widget):
+        """Populates the toolbar with a set of actions.
+
+        Args:
+            actions (list[ToolBarAction]): A list of action creators to populate the toolbar.
+            target_widget (QWidget): The widget that the actions will target.
+        """
+        self.clear()
+        for action_id, action in actions.items():
+            action.add_to_toolbar(self, target_widget)
+            self.widgets[action_id] = action
+
+    def set_background_color(self):
+        self.setIconSize(QSize(20, 20))
+        self.setMovable(False)
+        self.setFloatable(False)
+        self.setContentsMargins(0, 0, 0, 0)
+        self.setStyleSheet("QToolBar { background-color: rgba(0, 0, 0, 0); border: none; }")

bec_widgets/tests/utils.py

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

bec_widgets/utils/__init__.py

@@ -9,4 +9,5 @@ from .crosshair import Crosshair
 from .entry_validator import EntryValidator
 from .layout_manager import GridLayoutManager
 from .rpc_decorator import register_rpc_methods, rpc_public
+from .ui_loader import UILoader
 from .validator_delegate import DoubleValidationDelegate

bec_widgets/utils/bec_connector.py

@@ -1,16 +1,23 @@
 # pylint: disable = no-name-in-module,missing-module-docstring
 from __future__ import annotations
 
+import os
 import time
+import uuid
 from typing import Optional
 
+from bec_lib.logger import bec_logger
 from bec_lib.utils.import_utils import lazy_import_from
 from pydantic import BaseModel, Field, field_validator
 from qtpy.QtCore import QObject, QRunnable, QThreadPool, Signal
-from qtpy.QtCore import Slot as pyqtSlot
+from qtpy.QtWidgets import QApplication
 
 from bec_widgets.cli.rpc_register import RPCRegister
+from bec_widgets.qt_utils.error_popups import ErrorPopupUtility
+from bec_widgets.qt_utils.error_popups import SafeSlot as pyqtSlot
+from bec_widgets.utils.yaml_dialog import load_yaml, load_yaml_gui, save_yaml, save_yaml_gui
 
+logger = bec_logger.logger
 BECDispatcher = lazy_import_from("bec_widgets.utils.bec_dispatcher", ("BECDispatcher",))
 
 
@@ -60,20 +67,34 @@ class Worker(QRunnable):
 
 
 class BECConnector:
-    """Connection mixin class for all BEC widgets, to handle BEC client and device manager"""
+    """Connection mixin class to handle BEC client and device manager"""
 
-    USER_ACCESS = ["config_dict", "get_all_rpc"]
+    USER_ACCESS = ["_config_dict", "_get_all_rpc"]
+    EXIT_HANDLERS = {}
 
     def __init__(self, client=None, config: ConnectionConfig = None, gui_id: str = None):
         # BEC related connections
         self.bec_dispatcher = BECDispatcher(client=client)
         self.client = self.bec_dispatcher.client if client is None else client
 
+        if not self.client in BECConnector.EXIT_HANDLERS:
+            # register function to clean connections at exit;
+            # the function depends on BECClient, and BECDispatcher
+            @pyqtSlot()
+            def terminate(client=self.client, dispatcher=self.bec_dispatcher):
+                logger.info("Disconnecting", repr(dispatcher))
+                dispatcher.disconnect_all()
+                logger.info("Shutting down BEC Client", repr(client))
+                client.shutdown()
+
+            BECConnector.EXIT_HANDLERS[self.client] = terminate
+            QApplication.instance().aboutToQuit.connect(terminate)
+
         if config:
             self.config = config
             self.config.widget_class = self.__class__.__name__
         else:
-            print(
+            logger.debug(
                 f"No initial config found for {self.__class__.__name__}.\n"
                 f"Initializing with default config."
             )
@@ -86,9 +107,14 @@ class BECConnector:
             self.gui_id = self.config.gui_id
 
         # register widget to rpc register
+        # be careful: when registering, and the object is not a BECWidget,
+        # cleanup has to called manually since there is no 'closeEvent'
         self.rpc_register = RPCRegister()
         self.rpc_register.add_rpc(self)
 
+        # Error popups
+        self.error_utility = ErrorPopupUtility()
+
         self._thread_pool = QThreadPool.globalInstance()
 
     def submit_task(self, fn, *args, on_complete: pyqtSlot = None, **kwargs) -> Worker:
@@ -126,23 +152,23 @@ class BECConnector:
         self._thread_pool.start(worker)
         return worker
 
-    def get_all_rpc(self) -> dict:
+    def _get_all_rpc(self) -> dict:
         """Get all registered RPC objects."""
         all_connections = self.rpc_register.list_all_connections()
         return dict(all_connections)
 
     @property
-    def rpc_id(self) -> str:
+    def _rpc_id(self) -> str:
         """Get the RPC ID of the widget."""
         return self.gui_id
 
-    @rpc_id.setter
-    def rpc_id(self, rpc_id: str) -> None:
+    @_rpc_id.setter
+    def _rpc_id(self, rpc_id: str) -> None:
         """Set the RPC ID of the widget."""
         self.gui_id = rpc_id
 
     @property
-    def config_dict(self) -> dict:
+    def _config_dict(self) -> dict:
         """
         Get the configuration of the widget.
 
@@ -151,8 +177,8 @@ class BECConnector:
         """
         return self.config.model_dump()
 
-    @config_dict.setter
-    def config_dict(self, config: BaseModel) -> None:
+    @_config_dict.setter
+    def _config_dict(self, config: BaseModel) -> None:
         """
         Get the configuration of the widget.
 
@@ -161,6 +187,60 @@ class BECConnector:
         """
         self.config = config
 
+    def apply_config(self, config: dict, generate_new_id: bool = True) -> None:
+        """
+        Apply the configuration to the widget.
+
+        Args:
+            config(dict): Configuration settings.
+            generate_new_id(bool): If True, generate a new GUI ID for the widget.
+        """
+        self.config = ConnectionConfig(**config)
+        if generate_new_id is True:
+            gui_id = str(uuid.uuid4())
+            self.rpc_register.remove_rpc(self)
+            self.set_gui_id(gui_id)
+            self.rpc_register.add_rpc(self)
+        else:
+            self.gui_id = self.config.gui_id
+
+    def load_config(self, path: str | None = None, gui: bool = False):
+        """
+        Load the configuration of the widget from YAML.
+
+        Args:
+            path(str): Path to the configuration file for non-GUI dialog mode.
+            gui(bool): If True, use the GUI dialog to load the configuration file.
+        """
+        if gui is True:
+            config = load_yaml_gui(self)
+        else:
+            config = load_yaml(path)
+
+        if config is not None:
+            if config.get("widget_class") != self.__class__.__name__:
+                raise ValueError(
+                    f"Configuration file is not for {self.__class__.__name__}. Got configuration for {config.get('widget_class')}."
+                )
+            self.apply_config(config)
+
+    def save_config(self, path: str | None = None, gui: bool = False):
+        """
+        Save the configuration of the widget to YAML.
+
+        Args:
+            path(str): Path to save the configuration file for non-GUI dialog mode.
+            gui(bool): If True, use the GUI dialog to save the configuration file.
+        """
+        if gui is True:
+            save_yaml_gui(self, self._config_dict)
+        else:
+            if path is None:
+                path = os.getcwd()
+            file_path = os.path.join(path, f"{self.__class__.__name__}_config.yaml")
+
+            save_yaml(file_path, self._config_dict)
+
     @pyqtSlot(str)
     def set_gui_id(self, gui_id: str) -> None:
         """
@@ -221,16 +301,3 @@ class BECConnector:
             return self.config.model_dump()
         else:
             return self.config
-
-    def cleanup(self):
-        """Cleanup the widget."""
-        self.rpc_register.remove_rpc(self)
-        all_connections = self.rpc_register.list_all_connections()
-        if len(all_connections) == 0:
-            print("No more connections. Shutting down GUI BEC client.")
-            self.bec_dispatcher.disconnect_all()
-            self.client.shutdown()
-
-    # def closeEvent(self, event):
-    #     self.cleanup()
-    #     super().closeEvent(event)

bec_widgets/utils/bec_designer.py

@@ -6,7 +6,9 @@ import sys
 import sysconfig
 from pathlib import Path
 
+from bec_qthemes import material_icon
 from qtpy import PYSIDE6
+from qtpy.QtGui import QIcon
 
 if PYSIDE6:
     from PySide6.scripts.pyside_tool import (
@@ -21,6 +23,19 @@ if PYSIDE6:
 import bec_widgets
 
 
+def designer_material_icon(icon_name: str) -> QIcon:
+    """
+    Create a QIcon for the BECDesigner with the given material icon name.
+
+    Args:
+        icon_name (str): The name of the material icon.
+
+    Returns:
+        QIcon: The QIcon for the material icon.
+    """
+    return QIcon(material_icon(icon_name, filled=True, convert_to_pixmap=True))
+
+
 def list_editable_packages() -> set[str]:
     """
     List all editable packages in the environment.
@@ -73,26 +88,28 @@ def patch_designer():  # pragma: no cover
     os.environ["PY_MAJOR_VERSION"] = str(major_version)
     os.environ["PY_MINOR_VERSION"] = str(minor_version)
 
-    if sys.platform == "linux":
+    if sys.platform == "win32":
+        if is_virtual_env():
+            _extend_path_var("PATH", os.fspath(Path(sys._base_executable).parent), True)
+    else:
+        if sys.platform == "linux":
+            suffix = f"{sys.abiflags}.so"
+            env_var = "LD_PRELOAD"
+        elif sys.platform == "darwin":
+            suffix = ".dylib"
+            env_var = "DYLD_INSERT_LIBRARIES"
+        else:
+            raise RuntimeError(f"Unsupported platform: {sys.platform}")
         version = f"{major_version}.{minor_version}"
-        library_name = f"libpython{version}{sys.abiflags}.so"
-        if is_pyenv_python():
-            library_name = str(Path(sysconfig.get_config_var("LIBDIR")) / library_name)
-        os.environ["LD_PRELOAD"] = library_name
-    elif sys.platform == "darwin":
-        library_name = f"libpython{major_version}.{minor_version}.dylib"
+        library_name = f"libpython{version}{suffix}"
         lib_path = str(Path(sysconfig.get_config_var("LIBDIR")) / library_name)
-        os.environ["DYLD_INSERT_LIBRARIES"] = lib_path
+        os.environ[env_var] = lib_path
 
         if is_pyenv_python() or is_virtual_env():
             # append all editable packages to the PYTHONPATH
             editable_packages = list_editable_packages()
             for pckg in editable_packages:
                 _extend_path_var("PYTHONPATH", pckg, True)
-    elif sys.platform == "win32":
-        if is_virtual_env():
-            _extend_path_var("PATH", os.fspath(Path(sys._base_executable).parent), True)
-
     qt_tool_wrapper(ui_tool_binary("designer"), sys.argv[1:])
 
 

bec_widgets/utils/bec_dispatcher.py

@@ -6,11 +6,14 @@ from typing import TYPE_CHECKING, Union
 
 import redis
 from bec_lib.client import BECClient
+from bec_lib.logger import bec_logger
 from bec_lib.redis_connector import MessageObject, RedisConnector
 from bec_lib.service_config import ServiceConfig
-from qtpy.QtCore import PYQT5, PYQT6, PYSIDE2, PYSIDE6, QCoreApplication, QObject
+from qtpy.QtCore import QObject
 from qtpy.QtCore import Signal as pyqtSignal
 
+logger = bec_logger.logger
+
 if TYPE_CHECKING:
     from bec_lib.endpoints import EndpointInfo
 
@@ -65,17 +68,11 @@ class QtRedisConnector(RedisConnector):
             cb(msg.content, msg.metadata)
 
 
-class BECClientWithoutLoggerInit(BECClient):
-    def _initialize_logger(self):
-        return
-
-
 class BECDispatcher:
     """Utility class to keep track of slots connected to a particular redis connector"""
 
     _instance = None
     _initialized = False
-    qapp = None
 
     def __new__(cls, client=None, config: str = None, *args, **kwargs):
         if cls._instance is None:
@@ -87,9 +84,6 @@ class BECDispatcher:
         if self._initialized:
             return
 
-        if not QCoreApplication.instance():
-            BECDispatcher.qapp = QCoreApplication([])
-
         self._slots = collections.defaultdict(set)
         self.client = client
 
@@ -98,24 +92,22 @@ class BECDispatcher:
                 if not isinstance(config, ServiceConfig):
                     # config is supposed to be a path
                     config = ServiceConfig(config)
-                self.client = BECClientWithoutLoggerInit(
-                    config=config, connector_cls=QtRedisConnector
-                )  # , forced=True)
-            else:
-                self.client = BECClientWithoutLoggerInit(
-                    connector_cls=QtRedisConnector
-                )  # , forced=True)
+            self.client = BECClient(
+                config=config, connector_cls=QtRedisConnector, name="BECWidgets"
+            )
         else:
             if self.client.started:
                 # have to reinitialize client to use proper connector
+                logger.info("Shutting down BECClient to switch to QtRedisConnector")
                 self.client.shutdown()
             self.client._BECClient__init_params["connector_cls"] = QtRedisConnector
 
         try:
             self.client.start()
         except redis.exceptions.ConnectionError:
-            print("Could not connect to Redis, skipping start of BECClient.")
+            logger.warning("Could not connect to Redis, skipping start of BECClient.")
 
+        logger.success("Initialized BECDispatcher")
         self._initialized = True
 
     @classmethod
@@ -123,20 +115,13 @@ class BECDispatcher:
         cls._instance = None
         cls._initialized = False
 
-        if not cls.qapp:
-            return
-
-        # shutdown QCoreApp if it exists
-        if PYQT5 or PYQT6:
-            cls.qapp.exit()
-        elif PYSIDE2 or PYSIDE6:
-            cls.qapp.shutdown()
-        cls.qapp = None
-
     def connect_slot(
-        self, slot: Callable, topics: Union[EndpointInfo, str, list[Union[EndpointInfo, str]]]
+        self,
+        slot: Callable,
+        topics: Union[EndpointInfo, str, list[Union[EndpointInfo, str]]],
+        **kwargs,
     ) -> None:
-        """Connect widget's pyqt slot, so that it is called on new pub/sub topic message.
+        """Connect widget's qt slot, so that it is called on new pub/sub topic message.
 
         Args:
             slot (Callable): A slot method/function that accepts two inputs: content and metadata of
@@ -144,11 +129,18 @@ class BECDispatcher:
             topics (EndpointInfo | str | list): A topic or list of topics that can typically be acquired via bec_lib.MessageEndpoints
         """
         slot = QtThreadSafeCallback(slot)
-        self.client.connector.register(topics, cb=slot)
+        self.client.connector.register(topics, cb=slot, **kwargs)
         topics_str, _ = self.client.connector._convert_endpointinfo(topics)
         self._slots[slot].update(set(topics_str))
 
     def disconnect_slot(self, slot: Callable, topics: Union[str, list]):
+        """
+        Disconnect a slot from a topic.
+
+        Args:
+            slot(Callable): The slot to disconnect
+            topics(Union[str, list]): The topic(s) to disconnect from
+        """
         # find the right slot to disconnect from ;
         # slot callbacks are wrapped in QtThreadSafeCallback objects,
         # but the slot we receive here is the original callable
@@ -159,11 +151,17 @@ class BECDispatcher:
             return
         self.client.connector.unregister(topics, cb=connected_slot)
         topics_str, _ = self.client.connector._convert_endpointinfo(topics)
-        self._slots[slot].difference_update(set(topics_str))
-        if not self._slots[slot]:
-            del self._slots[slot]
+        self._slots[connected_slot].difference_update(set(topics_str))
+        if not self._slots[connected_slot]:
+            del self._slots[connected_slot]
 
     def disconnect_topics(self, topics: Union[str, list]):
+        """
+        Disconnect all slots from a topic.
+
+        Args:
+            topics(Union[str, list]): The topic(s) to disconnect from
+        """
         self.client.connector.unregister(topics)
         topics_str, _ = self.client.connector._convert_endpointinfo(topics)
         for slot in list(self._slots.keys()):
@@ -173,4 +171,11 @@ class BECDispatcher:
                 del self._slots[slot]
 
     def disconnect_all(self, *args, **kwargs):
+        """
+        Disconnect all slots from all topics.
+
+        Args:
+            *args: Arbitrary positional arguments
+            **kwargs: Arbitrary keyword arguments
+        """
         self.disconnect_topics(self.client.connector._topics_cb)

bec_widgets/utils/bec_signal_proxy.py

@@ -0,0 +1,54 @@
+""" This custom class is a thin wrapper around the SignalProxy class to allow signal calls to be blocked.
+Unblocking the proxy needs to be done through the slot unblock_proxy. The most likely use case for this class is
+when the callback function is potentially initiating a slower progress, i.e. requesting a data analysis routine to 
+analyse data. Requesting a new fit may lead to request piling up and an overall slow done of performance. This proxy
+will allow you to decide by yourself when to unblock and execute the callback again."""
+
+from pyqtgraph import SignalProxy
+from qtpy.QtCore import Signal, Slot
+
+
+class BECSignalProxy(SignalProxy):
+    """Thin wrapper around the SignalProxy class to allow signal calls to be blocked, but args still being stored
+
+    Args:
+        *args: Arguments to pass to the SignalProxy class
+        rateLimit (int): The rateLimit of the proxy
+        **kwargs: Keyword arguments to pass to the SignalProxy class
+
+    Example:
+    >>> proxy = BECSignalProxy(signal, rate_limit=25, slot=callback)"""
+
+    is_blocked = Signal(bool)
+
+    def __init__(self, *args, rateLimit=25, **kwargs):
+        super().__init__(*args, rateLimit=rateLimit, **kwargs)
+        self._blocking = False
+        self.old_args = None
+        self.new_args = None
+
+    @property
+    def blocked(self):
+        """Returns if the proxy is blocked"""
+        return self._blocking
+
+    @blocked.setter
+    def blocked(self, value: bool):
+        self._blocking = value
+        self.is_blocked.emit(value)
+
+    def signalReceived(self, *args):
+        """Receive signal, store the args and call signalReceived from the parent class if not blocked"""
+        self.new_args = args
+        if self.blocked is True:
+            return
+        self.blocked = True
+        self.old_args = args
+        super().signalReceived(*args)
+
+    @Slot()
+    def unblock_proxy(self):
+        """Unblock the proxy, and call the signalReceived method in case there was an update of the args."""
+        self.blocked = False
+        if self.new_args != self.old_args:
+            self.signalReceived(*self.new_args)

bec_widgets/utils/bec_widget.py

@@ -0,0 +1,96 @@
+from __future__ import annotations
+
+import darkdetect
+from bec_lib.logger import bec_logger
+from qtpy.QtCore import Slot
+from qtpy.QtWidgets import QApplication, QWidget
+
+from bec_widgets.utils.bec_connector import BECConnector, ConnectionConfig
+from bec_widgets.utils.colors import set_theme
+
+logger = bec_logger.logger
+
+
+class BECWidget(BECConnector):
+    """Mixin class for all BEC widgets, to handle cleanup"""
+
+    # The icon name is the name of the icon in the icon theme, typically a name taken
+    # from fonts.google.com/icons. Override this in subclasses to set the icon name.
+    ICON_NAME = "widgets"
+
+    def __init__(
+        self,
+        client=None,
+        config: ConnectionConfig = None,
+        gui_id: str = None,
+        theme_update: bool = False,
+    ):
+        """
+        Base class for all BEC widgets. This class should be used as a mixin class for all BEC widgets, e.g.:
+
+
+        >>> class MyWidget(BECWidget, QWidget):
+        >>>     def __init__(self, parent=None, client=None, config=None, gui_id=None):
+        >>>         super().__init__(client=client, config=config, gui_id=gui_id)
+        >>>         QWidget.__init__(self, parent=parent)
+
+
+        Args:
+            client(BECClient, optional): The BEC client.
+            config(ConnectionConfig, optional): The connection configuration.
+            gui_id(str, optional): The GUI ID.
+            theme_update(bool, optional): Whether to subscribe to theme updates. Defaults to False. When set to True, the
+                widget's apply_theme method will be called when the theme changes.
+        """
+        if not isinstance(self, QWidget):
+            raise RuntimeError(f"{repr(self)} is not a subclass of QWidget")
+        super().__init__(client=client, config=config, gui_id=gui_id)
+
+        # Set the theme to auto if it is not set yet
+        app = QApplication.instance()
+        if not hasattr(app, "theme"):
+            # DO NOT SET THE THEME TO AUTO! Otherwise, the qwebengineview will segfault
+            # Instead, we will set the theme to the system setting on startup
+            if darkdetect.isDark():
+                set_theme("dark")
+            else:
+                set_theme("light")
+
+        if theme_update:
+            logger.debug(f"Subscribing to theme updates for {self.__class__.__name__}")
+            self._connect_to_theme_change()
+
+    def _connect_to_theme_change(self):
+        """Connect to the theme change signal."""
+        qapp = QApplication.instance()
+        if hasattr(qapp, "theme_signal"):
+            qapp.theme_signal.theme_updated.connect(self._update_theme)
+
+    def _update_theme(self, theme: str):
+        """Update the theme."""
+        if theme is None:
+            qapp = QApplication.instance()
+            if hasattr(qapp, "theme"):
+                theme = qapp.theme.theme
+            else:
+                theme = "dark"
+        self.apply_theme(theme)
+
+    @Slot(str)
+    def apply_theme(self, theme: str):
+        """
+        Apply the theme to the widget.
+
+        Args:
+            theme(str, optional): The theme to be applied.
+        """
+
+    def cleanup(self):
+        """Cleanup the widget."""
+
+    def closeEvent(self, event):
+        self.rpc_register.remove_rpc(self)
+        try:
+            self.cleanup()
+        finally:
+            super().closeEvent(event)

bec_widgets/utils/colors.py

@@ -1,10 +1,89 @@
-import re
-from typing import Literal
+from __future__ import annotations
 
+import itertools
+import re
+from typing import TYPE_CHECKING, Literal
+
+import bec_qthemes
 import numpy as np
 import pyqtgraph as pg
+from bec_qthemes._os_appearance.listener import OSThemeSwitchListener
 from pydantic_core import PydanticCustomError
 from qtpy.QtGui import QColor
+from qtpy.QtWidgets import QApplication
+
+if TYPE_CHECKING:
+    from bec_qthemes._main import AccentColors
+
+
+def get_theme_palette():
+    if QApplication.instance() is None or not hasattr(QApplication.instance(), "theme"):
+        theme = "dark"
+    else:
+        theme = QApplication.instance().theme.theme
+    return bec_qthemes.load_palette(theme)
+
+
+def get_accent_colors() -> AccentColors | None:
+    """
+    Get the accent colors for the current theme. These colors are extensions of the color palette
+    and are used to highlight specific elements in the UI.
+    """
+    if QApplication.instance() is None or not hasattr(QApplication.instance(), "theme"):
+        return None
+    return QApplication.instance().theme.accent_colors
+
+
+def _theme_update_callback():
+    """
+    Internal callback function to update the theme based on the system theme.
+    """
+    app = QApplication.instance()
+    # pylint: disable=protected-access
+    app.theme.theme = app.os_listener._theme.lower()
+    app.theme_signal.theme_updated.emit(app.theme.theme)
+    apply_theme(app.os_listener._theme.lower())
+
+
+def set_theme(theme: Literal["dark", "light", "auto"]):
+    """
+    Set the theme for the application.
+
+    Args:
+        theme (Literal["dark", "light", "auto"]): The theme to set. "auto" will automatically switch between dark and light themes based on the system theme.
+    """
+    app = QApplication.instance()
+    bec_qthemes.setup_theme(theme, install_event_filter=False)
+
+    app.theme_signal.theme_updated.emit(theme)
+    apply_theme(theme)
+
+    if theme != "auto":
+        return
+
+    if not hasattr(app, "os_listener") or app.os_listener is None:
+        app.os_listener = OSThemeSwitchListener(_theme_update_callback)
+        app.installEventFilter(app.os_listener)
+
+
+def apply_theme(theme: Literal["dark", "light"]):
+    """
+    Apply the theme to all pyqtgraph widgets. Do not use this function directly. Use set_theme instead.
+    """
+    app = QApplication.instance()
+    # go through all pyqtgraph widgets and set background
+    children = itertools.chain.from_iterable(
+        top.findChildren(pg.GraphicsLayoutWidget) for top in app.topLevelWidgets()
+    )
+    pg.setConfigOptions(
+        foreground="d" if theme == "dark" else "k", background="k" if theme == "dark" else "w"
+    )
+    for pg_widget in children:
+        pg_widget.setBackground("k" if theme == "dark" else "w")
+
+    # now define stylesheet according to theme and apply it
+    style = bec_qthemes.load_stylesheet(theme)
+    app.setStyleSheet(style)
 
 
 class Colors:
@@ -28,9 +107,98 @@ class Colors:
             angles.append(angle)
         return angles
 
+    @staticmethod
+    def set_theme_offset(theme: Literal["light", "dark"] | None = None, offset=0.2) -> tuple:
+        """
+        Set the theme offset to avoid colors too close to white or black with light or dark theme respectively for pyqtgraph plot background.
+
+        Args:
+            theme(str): The theme to be applied.
+            offset(float): Offset to avoid colors too close to white or black with light or dark theme respectively for pyqtgraph plot background.
+
+        Returns:
+            tuple: Tuple of min_pos and max_pos.
+
+        Raises:
+            ValueError: If theme_offset is not between 0 and 1.
+        """
+
+        if offset < 0 or offset > 1:
+            raise ValueError("theme_offset must be between 0 and 1")
+
+        if theme is None:
+            app = QApplication.instance()
+            if hasattr(app, "theme"):
+                theme = app.theme.theme
+
+        if theme == "light":
+            min_pos = 0.0
+            max_pos = 1 - offset
+        else:
+            min_pos = 0.0 + offset
+            max_pos = 1.0
+
+        return min_pos, max_pos
+
+    @staticmethod
+    def evenly_spaced_colors(
+        colormap: str,
+        num: int,
+        format: Literal["QColor", "HEX", "RGB"] = "QColor",
+        theme_offset=0.2,
+        theme: Literal["light", "dark"] | None = None,
+    ) -> list:
+        """
+        Extract `num` colors from the specified colormap, evenly spaced along its range,
+        and return them in the specified format.
+
+        Args:
+            colormap (str): Name of the colormap.
+            num (int): Number of requested colors.
+            format (Literal["QColor","HEX","RGB"]): The format of the returned colors ('RGB', 'HEX', 'QColor').
+            theme_offset (float): Has to be between 0-1. Offset to avoid colors too close to white or black with light or dark theme respectively for pyqtgraph plot background.
+            theme (Literal['light', 'dark'] | None): The theme to be applied. Overrides the QApplication theme if specified.
+
+        Returns:
+            list: List of colors in the specified format.
+
+        Raises:
+            ValueError: If theme_offset is not between 0 and 1.
+        """
+        if theme_offset < 0 or theme_offset > 1:
+            raise ValueError("theme_offset must be between 0 and 1")
+
+        cmap = pg.colormap.get(colormap)
+        min_pos, max_pos = Colors.set_theme_offset(theme, theme_offset)
+
+        # Generate positions that are evenly spaced within the acceptable range
+        if num == 1:
+            positions = np.array([(min_pos + max_pos) / 2])
+        else:
+            positions = np.linspace(min_pos, max_pos, num)
+
+        # Sample colors from the colormap at the calculated positions
+        colors = cmap.map(positions, mode="float")
+        color_list = []
+
+        for color in colors:
+            if format.upper() == "HEX":
+                color_list.append(QColor.fromRgbF(*color).name())
+            elif format.upper() == "RGB":
+                color_list.append(tuple((np.array(color) * 255).astype(int)))
+            elif format.upper() == "QCOLOR":
+                color_list.append(QColor.fromRgbF(*color))
+            else:
+                raise ValueError("Unsupported format. Please choose 'RGB', 'HEX', or 'QColor'.")
+        return color_list
+
     @staticmethod
     def golden_angle_color(
-        colormap: str, num: int, format: Literal["QColor", "HEX", "RGB"] = "QColor"
+        colormap: str,
+        num: int,
+        format: Literal["QColor", "HEX", "RGB"] = "QColor",
+        theme_offset=0.2,
+        theme: Literal["dark", "light"] | None = None,
     ) -> list:
         """
         Extract num colors from the specified colormap following golden angle distribution and return them in the specified format.
@@ -39,33 +207,77 @@ class Colors:
             colormap (str): Name of the colormap.
             num (int): Number of requested colors.
             format (Literal["QColor","HEX","RGB"]): The format of the returned colors ('RGB', 'HEX', 'QColor').
+            theme_offset (float): Has to be between 0-1. Offset to avoid colors too close to white or black with light or dark theme respectively for pyqtgraph plot background.
 
         Returns:
             list: List of colors in the specified format.
 
         Raises:
-            ValueError: If the number of requested colors is greater than the number of colors in the colormap.
+            ValueError: If theme_offset is not between 0 and 1.
         """
+
         cmap = pg.colormap.get(colormap)
-        cmap_colors = cmap.getColors(mode="float")
-        if num > len(cmap_colors):
-            raise ValueError(
-                f"Number of colors requested ({num}) is greater than the number of colors in the colormap ({len(cmap_colors)})"
-            )
-        angles = Colors.golden_ratio(len(cmap_colors))
-        color_selection = np.round(np.interp(angles, (-np.pi, np.pi), (0, len(cmap_colors))))
-        colors = []
-        for ii in color_selection[:num]:
-            color = cmap_colors[int(ii)]
+        phi = (1 + np.sqrt(5)) / 2  # Golden ratio
+        golden_angle_conjugate = 1 - (1 / phi)  # Approximately 0.38196601125
+
+        min_pos, max_pos = Colors.set_theme_offset(theme, theme_offset)
+
+        # Generate positions within the acceptable range
+        positions = np.mod(np.arange(num) * golden_angle_conjugate, 1)
+        positions = min_pos + positions * (max_pos - min_pos)
+
+        # Sample colors from the colormap at the calculated positions
+        colors = cmap.map(positions, mode="float")
+        color_list = []
+
+        for color in colors:
             if format.upper() == "HEX":
-                colors.append(QColor.fromRgbF(*color).name())
+                color_list.append(QColor.fromRgbF(*color).name())
             elif format.upper() == "RGB":
-                colors.append(tuple((np.array(color) * 255).astype(int)))
+                color_list.append(tuple((np.array(color) * 255).astype(int)))
             elif format.upper() == "QCOLOR":
-                colors.append(QColor.fromRgbF(*color))
+                color_list.append(QColor.fromRgbF(*color))
             else:
                 raise ValueError("Unsupported format. Please choose 'RGB', 'HEX', or 'QColor'.")
-        return colors
+        return color_list
+
+    @staticmethod
+    def hex_to_rgba(hex_color: str, alpha=255) -> tuple:
+        """
+        Convert HEX color to RGBA.
+
+        Args:
+            hex_color(str): HEX color string.
+            alpha(int): Alpha value (0-255). Default is 255 (opaque).
+
+        Returns:
+            tuple: RGBA color tuple (r, g, b, a).
+        """
+        hex_color = hex_color.lstrip("#")
+        if len(hex_color) == 6:
+            r, g, b = tuple(int(hex_color[i : i + 2], 16) for i in (0, 2, 4))
+        elif len(hex_color) == 8:
+            r, g, b, a = tuple(int(hex_color[i : i + 2], 16) for i in (0, 2, 4, 6))
+            return (r, g, b, a)
+        else:
+            raise ValueError("HEX color must be 6 or 8 characters long.")
+        return (r, g, b, alpha)
+
+    @staticmethod
+    def rgba_to_hex(r: int, g: int, b: int, a: int = 255) -> str:
+        """
+        Convert RGBA color to HEX.
+
+        Args:
+            r(int): Red value (0-255).
+            g(int): Green value (0-255).
+            b(int): Blue value (0-255).
+            a(int): Alpha value (0-255). Default is 255 (opaque).
+
+        Returns:
+            hec_color(str): HEX color string.
+        """
+        return "#{:02X}{:02X}{:02X}{:02X}".format(r, g, b, a)
 
     @staticmethod
     def validate_color(color: tuple | str) -> tuple | str:
@@ -256,7 +468,7 @@ class Colors:
             return color
 
     @staticmethod
-    def validate_color_map(color_map: str) -> str:
+    def validate_color_map(color_map: str, return_error: bool = True) -> str | bool:
         """
         Validate the colormap input if it is supported by pyqtgraph. Can be used in any pydantic model as a field validator. If validation fails it prints all available colormaps from pyqtgraph instance.
 
@@ -264,13 +476,24 @@ class Colors:
             color_map(str): The colormap to be validated.
 
         Returns:
-            str: The validated colormap.
+            str: The validated colormap, if colormap is valid.
+            bool: False, if colormap is invalid.
+
+        Raises:
+            PydanticCustomError: If colormap is invalid.
         """
-        available_colormaps = pg.colormap.listMaps()
+        available_pg_maps = pg.colormap.listMaps()
+        available_mpl_maps = pg.colormap.listMaps("matplotlib")
+        available_mpl_colorcet = pg.colormap.listMaps("colorcet")
+
+        available_colormaps = available_pg_maps + available_mpl_maps + available_mpl_colorcet
         if color_map not in available_colormaps:
-            raise PydanticCustomError(
-                "unsupported colormap",
-                f"Colormap '{color_map}' not found in the current installation of pyqtgraph. Choose on the following: {available_colormaps}.",
-                {"wrong_value": color_map},
-            )
+            if return_error:
+                raise PydanticCustomError(
+                    "unsupported colormap",
+                    f"Colormap '{color_map}' not found in the current installation of pyqtgraph. Choose on the following: {available_colormaps}.",
+                    {"wrong_value": color_map},
+                )
+            else:
+                return False
         return color_map

bec_widgets/utils/container_utils.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import itertools
 from typing import Type
 

bec_widgets/utils/crosshair.py

@@ -1,12 +1,24 @@
+from collections import defaultdict
+
 import numpy as np
 import pyqtgraph as pg
 
 # from qtpy.QtCore import QObject, pyqtSignal
-from qtpy.QtCore import QObject
+from qtpy.QtCore import QObject, Qt
 from qtpy.QtCore import Signal as pyqtSignal
 
 
+class NonDownsamplingScatterPlotItem(pg.ScatterPlotItem):
+    def setDownsampling(self, ds=None, auto=None, method=None):
+        pass
+
+    def setClipToView(self, state):
+        pass
+
+
 class Crosshair(QObject):
+    positionChanged = pyqtSignal(tuple)
+    positionClicked = pyqtSignal(tuple)
     # Signal for 1D plot
     coordinatesChanged1D = pyqtSignal(tuple)
     coordinatesClicked1D = pyqtSignal(tuple)
@@ -26,10 +38,13 @@ class Crosshair(QObject):
         super().__init__(parent)
         self.is_log_y = None
         self.is_log_x = None
+        self.is_derivative = None
         self.plot_item = plot_item
         self.precision = precision
         self.v_line = pg.InfiniteLine(angle=90, movable=False)
+        self.v_line.skip_auto_range = True
         self.h_line = pg.InfiniteLine(angle=0, movable=False)
+        self.h_line.skip_auto_range = True
         self.plot_item.addItem(self.v_line, ignoreBounds=True)
         self.plot_item.addItem(self.h_line, ignoreBounds=True)
         self.proxy = pg.SignalProxy(
@@ -37,74 +52,76 @@ class Crosshair(QObject):
         )
         self.plot_item.scene().sigMouseClicked.connect(self.mouse_clicked)
 
+        self.plot_item.ctrl.derivativeCheck.checkStateChanged.connect(self.check_derivatives)
+        self.plot_item.ctrl.logXCheck.checkStateChanged.connect(self.check_log)
+        self.plot_item.ctrl.logYCheck.checkStateChanged.connect(self.check_log)
+        self.plot_item.ctrl.downsampleSpin.valueChanged.connect(self.clear_markers)
+
         # Initialize markers
-        self.marker_moved_1d = []
-        self.marker_clicked_1d = []
+        self.marker_moved_1d = {}
+        self.marker_clicked_1d = {}
         self.marker_2d = None
         self.update_markers()
 
     def update_markers(self):
         """Update the markers for the crosshair, creating new ones if necessary."""
 
-        # Clear existing markers
-        for marker in self.marker_moved_1d + self.marker_clicked_1d:
-            self.plot_item.removeItem(marker)
-        if self.marker_2d:
-            self.plot_item.removeItem(self.marker_2d)
-
         # Create new markers
-        self.marker_moved_1d = []
-        self.marker_clicked_1d = []
-        self.marker_2d = None
         for item in self.plot_item.items:
             if isinstance(item, pg.PlotDataItem):  # 1D plot
+                if item.name() in self.marker_moved_1d:
+                    continue
                 pen = item.opts["pen"]
                 color = pen.color() if hasattr(pen, "color") else pg.mkColor(pen)
-                marker_moved = pg.ScatterPlotItem(
+                marker_moved = NonDownsamplingScatterPlotItem(
                     size=10, pen=pg.mkPen(color), brush=pg.mkBrush(None)
                 )
-                marker_clicked = pg.ScatterPlotItem(
-                    size=10, pen=pg.mkPen(None), brush=pg.mkBrush(color)
-                )
-                self.marker_moved_1d.append(marker_moved)
+                marker_moved.skip_auto_range = True
+                self.marker_moved_1d[item.name()] = marker_moved
                 self.plot_item.addItem(marker_moved)
+
                 # Create glowing effect markers for clicked events
-                marker_clicked_list = []
                 for size, alpha in [(18, 64), (14, 128), (10, 255)]:
-                    marker_clicked = pg.ScatterPlotItem(
+                    marker_clicked = NonDownsamplingScatterPlotItem(
                         size=size,
                         pen=pg.mkPen(None),
                         brush=pg.mkBrush(color.red(), color.green(), color.blue(), alpha),
                     )
-                    marker_clicked_list.append(marker_clicked)
+                    marker_clicked.skip_auto_range = True
+                    self.marker_clicked_1d[item.name()] = marker_clicked
                     self.plot_item.addItem(marker_clicked)
 
-                self.marker_clicked_1d.append(marker_clicked_list)
             elif isinstance(item, pg.ImageItem):  # 2D plot
+                if self.marker_2d is not None:
+                    continue
                 self.marker_2d = pg.ROI(
                     [0, 0], size=[1, 1], pen=pg.mkPen("r", width=2), movable=False
                 )
                 self.plot_item.addItem(self.marker_2d)
 
-    def snap_to_data(self, x, y) -> tuple:
+    def snap_to_data(self, x, y) -> tuple[defaultdict[list], defaultdict[list]]:
         """
         Finds the nearest data points to the given x and y coordinates.
 
         Args:
-            x: The x-coordinate
-            y: The y-coordinate
+            x: The x-coordinate of the mouse cursor
+            y: The y-coordinate of the mouse cursor
 
         Returns:
-            tuple: The nearest x and y values
+            tuple: x and y values snapped to the nearest data
         """
-        y_values_1d = []
-        x_values_1d = []
+        y_values = defaultdict(list)
+        x_values = defaultdict(list)
         image_2d = None
 
         # Iterate through items in the plot
         for item in self.plot_item.items:
             if isinstance(item, pg.PlotDataItem):  # 1D plot
-                x_data, y_data = item.xData, item.yData
+                name = item.name()
+                plot_data = item._getDisplayDataset()
+                if plot_data is None:
+                    continue
+                x_data, y_data = plot_data.x, plot_data.y
                 if x_data is not None and y_data is not None:
                     if self.is_log_x:
                         min_x_data = np.min(x_data[x_data > 0])
@@ -112,25 +129,25 @@ class Crosshair(QObject):
                         min_x_data = np.min(x_data)
                     max_x_data = np.max(x_data)
                     if x < min_x_data or x > max_x_data:
-                        return None, None
+                        y_values[name] = None
+                        x_values[name] = None
+                        continue
                     closest_x, closest_y = self.closest_x_y_value(x, x_data, y_data)
-                    y_values_1d.append(closest_y)
-                    x_values_1d.append(closest_x)
+                    y_values[name] = closest_y
+                    x_values[name] = closest_x
             elif isinstance(item, pg.ImageItem):  # 2D plot
+                name = item.config.monitor
                 image_2d = item.image
+                # clip the x and y values to the image dimensions to avoid out of bounds errors
+                y_values[name] = int(np.clip(y, 0, image_2d.shape[1] - 1))
+                x_values[name] = int(np.clip(x, 0, image_2d.shape[0] - 1))
 
-        # Handle 1D plot
-        if y_values_1d:
-            if all(v is None for v in x_values_1d) or all(v is None for v in y_values_1d):
+        if x_values and y_values:
+            if all(v is None for v in x_values.values()) or all(
+                v is None for v in y_values.values()
+            ):
                 return None, None
-            closest_x = min(x_values_1d, key=lambda xi: abs(xi - x))  # Snap x to closest data point
-            return closest_x, y_values_1d
-
-        # Handle 2D plot
-        if image_2d is not None:
-            x_idx = int(np.clip(x, 0, image_2d.shape[0] - 1))
-            y_idx = int(np.clip(y, 0, image_2d.shape[1] - 1))
-            return x_idx, y_idx
+            return x_values, y_values
 
         return None, None
 
@@ -156,8 +173,9 @@ class Crosshair(QObject):
         Args:
             event: The mouse moved event
         """
-        self.check_log()
         pos = event[0]
+        self.update_markers()
+        self.positionChanged.emit((pos.x(), pos.y()))
         if self.plot_item.vb.sceneBoundingRect().contains(pos):
             mouse_point = self.plot_item.vb.mapSceneToView(pos)
             self.v_line.setPos(mouse_point.x())
@@ -168,27 +186,34 @@ class Crosshair(QObject):
                 x = 10**x
             if self.is_log_y:
                 y = 10**y
-            x, y_values = self.snap_to_data(x, y)
+            x_snap_values, y_snap_values = self.snap_to_data(x, y)
+            if x_snap_values is None or y_snap_values is None:
+                return
+            if all(v is None for v in x_snap_values.values()) or all(
+                v is None for v in y_snap_values.values()
+            ):
+                # not sure how we got here, but just to be safe...
+                return
 
             for item in self.plot_item.items:
                 if isinstance(item, pg.PlotDataItem):
-                    if x is None or all(v is None for v in y_values):
-                        return
-                    coordinate_to_emit = (
-                        round(x, self.precision),
-                        [round(y_val, self.precision) for y_val in y_values],
-                    )
+                    name = item.name()
+                    x, y = x_snap_values[name], y_snap_values[name]
+                    if x is None or y is None:
+                        continue
+                    self.marker_moved_1d[name].setData([x], [y])
+                    coordinate_to_emit = (name, round(x, self.precision), round(y, self.precision))
                     self.coordinatesChanged1D.emit(coordinate_to_emit)
-                    for i, y_val in enumerate(y_values):
-                        self.marker_moved_1d[i].setData(
-                            [x if not self.is_log_x else np.log10(x)],
-                            [y_val if not self.is_log_y else np.log10(y_val)],
-                        )
                 elif isinstance(item, pg.ImageItem):
-                    if x is None or y_values is None:
-                        return
-                    coordinate_to_emit = (x, y_values)
+                    name = item.config.monitor
+                    x, y = x_snap_values[name], y_snap_values[name]
+                    if x is None or y is None:
+                        continue
+                    self.marker_2d.setPos([x, y])
+                    coordinate_to_emit = (name, x, y)
                     self.coordinatesChanged2D.emit(coordinate_to_emit)
+                else:
+                    continue
 
     def mouse_clicked(self, event):
         """Handles the mouse clicked event, updating the crosshair position and emitting signals.
@@ -196,40 +221,69 @@ class Crosshair(QObject):
         Args:
             event: The mouse clicked event
         """
-        self.check_log()
+
+        # we only accept left mouse clicks
+        if event.button() != Qt.MouseButton.LeftButton:
+            return
+        self.update_markers()
         if self.plot_item.vb.sceneBoundingRect().contains(event._scenePos):
             mouse_point = self.plot_item.vb.mapSceneToView(event._scenePos)
             x, y = mouse_point.x(), mouse_point.y()
+            self.positionClicked.emit((x, y))
 
             if self.is_log_x:
                 x = 10**x
             if self.is_log_y:
                 y = 10**y
-            x, y_values = self.snap_to_data(x, y)
+            x_snap_values, y_snap_values = self.snap_to_data(x, y)
+
+            if x_snap_values is None or y_snap_values is None:
+                return
+            if all(v is None for v in x_snap_values.values()) or all(
+                v is None for v in y_snap_values.values()
+            ):
+                # not sure how we got here, but just to be safe...
+                return
 
             for item in self.plot_item.items:
                 if isinstance(item, pg.PlotDataItem):
-                    if x is None or all(v is None for v in y_values):
-                        return
-                    coordinate_to_emit = (
-                        round(x, self.precision),
-                        [round(y_val, self.precision) for y_val in y_values],
-                    )
+                    name = item.name()
+                    x, y = x_snap_values[name], y_snap_values[name]
+                    if x is None or y is None:
+                        continue
+                    self.marker_clicked_1d[name].setData([x], [y])
+                    coordinate_to_emit = (name, round(x, self.precision), round(y, self.precision))
                     self.coordinatesClicked1D.emit(coordinate_to_emit)
-                    for i, y_val in enumerate(y_values):
-                        for marker in self.marker_clicked_1d[i]:
-                            marker.setData(
-                                [x if not self.is_log_x else np.log10(x)],
-                                [y_val if not self.is_log_y else np.log10(y_val)],
-                            )
                 elif isinstance(item, pg.ImageItem):
-                    if x is None or y_values is None:
-                        return
-                    coordinate_to_emit = (x, y_values)
+                    name = item.config.monitor
+                    x, y = x_snap_values[name], y_snap_values[name]
+                    if x is None or y is None:
+                        continue
+                    self.marker_2d.setPos([x, y])
+                    coordinate_to_emit = (name, x, y)
                     self.coordinatesClicked2D.emit(coordinate_to_emit)
-                    self.marker_2d.setPos([x, y_values])
+                else:
+                    continue
+
+    def clear_markers(self):
+        """Clears the markers from the plot."""
+        for marker in self.marker_moved_1d.values():
+            marker.clear()
+        for marker in self.marker_clicked_1d.values():
+            marker.clear()
 
     def check_log(self):
         """Checks if the x or y axis is in log scale and updates the internal state accordingly."""
         self.is_log_x = self.plot_item.ctrl.logXCheck.isChecked()
         self.is_log_y = self.plot_item.ctrl.logYCheck.isChecked()
+        self.clear_markers()
+
+    def check_derivatives(self):
+        """Checks if the derivatives are enabled and updates the internal state accordingly."""
+        self.is_derivative = self.plot_item.ctrl.derivativeCheck.isChecked()
+        self.clear_markers()
+
+    def cleanup(self):
+        self.v_line.deleteLater()
+        self.h_line.deleteLater()
+        self.clear_markers()

bec_widgets/utils/entry_validator.py

@@ -19,7 +19,7 @@ class EntryValidator:
         device = self.devices[name]
         description = device.describe()
 
-        if entry is None:
+        if entry is None or entry == "":
             entry = next(iter(device._hints), name) if hasattr(device, "_hints") else name
         if entry not in description:
             raise ValueError(f"Entry '{entry}' not found in device '{name}' signals")

bec_widgets/utils/filter_io.py

@@ -0,0 +1,156 @@
+"""Module for handling filter I/O operations in BEC Widgets for input fields.
+These operations include filtering device/signal names and/or device types.
+"""
+
+from abc import ABC, abstractmethod
+
+from bec_lib.logger import bec_logger
+from qtpy.QtCore import QStringListModel
+from qtpy.QtWidgets import QComboBox, QCompleter, QLineEdit
+
+logger = bec_logger.logger
+
+
+class WidgetFilterHandler(ABC):
+    """Abstract base class for widget filter handlers"""
+
+    @abstractmethod
+    def set_selection(self, widget, selection: list) -> None:
+        """Set the filtered_selection for the widget
+
+        Args:
+            selection (list): Filtered selection of items
+        """
+
+    @abstractmethod
+    def check_input(self, widget, text: str) -> bool:
+        """Check if the input text is in the filtered selection
+
+        Args:
+            widget: Widget instance
+            text (str): Input text
+
+        Returns:
+            bool: True if the input text is in the filtered selection
+        """
+
+
+class LineEditFilterHandler(WidgetFilterHandler):
+    """Handler for QLineEdit widget"""
+
+    def set_selection(self, widget: QLineEdit, selection: list) -> None:
+        """Set the selection for the widget to the completer model
+
+        Args:
+            widget (QLineEdit): The QLineEdit widget
+            selection (list): Filtered selection of items
+        """
+        if not isinstance(widget.completer, QCompleter):
+            completer = QCompleter(widget)
+            widget.setCompleter(completer)
+        widget.completer.setModel(QStringListModel(selection, widget))
+
+    def check_input(self, widget: QLineEdit, text: str) -> bool:
+        """Check if the input text is in the filtered selection
+
+        Args:
+            widget (QLineEdit): The QLineEdit widget
+            text (str): Input text
+
+        Returns:
+            bool: True if the input text is in the filtered selection
+        """
+        model = widget.completer.model()
+        model_data = [model.data(model.index(i)) for i in range(model.rowCount())]
+        return text in model_data
+
+
+class ComboBoxFilterHandler(WidgetFilterHandler):
+    """Handler for QComboBox widget"""
+
+    def set_selection(self, widget: QComboBox, selection: list) -> None:
+        """Set the selection for the widget to the completer model
+
+        Args:
+            widget (QComboBox): The QComboBox widget
+            selection (list): Filtered selection of items
+        """
+        widget.clear()
+        widget.addItems(selection)
+
+    def check_input(self, widget: QComboBox, text: str) -> bool:
+        """Check if the input text is in the filtered selection
+
+        Args:
+            widget (QComboBox): The QComboBox widget
+            text (str): Input text
+
+        Returns:
+            bool: True if the input text is in the filtered selection
+        """
+        return text in [widget.itemText(i) for i in range(widget.count())]
+
+
+class FilterIO:
+    """Public interface to set filters for input widgets.
+    It supports the list of widgets stored in class attribute _handlers.
+    """
+
+    _handlers = {QLineEdit: LineEditFilterHandler, QComboBox: ComboBoxFilterHandler}
+
+    @staticmethod
+    def set_selection(widget, selection: list, ignore_errors=True):
+        """
+        Retrieve value from the widget instance.
+
+        Args:
+            widget: Widget instance.
+            selection(list): List of filtered selection items.
+            ignore_errors(bool, optional): Whether to ignore if no handler is found.
+        """
+        handler_class = FilterIO._find_handler(widget)
+        if handler_class:
+            return handler_class().set_selection(widget=widget, selection=selection)
+        if not ignore_errors:
+            raise ValueError(
+                f"No matching handler for widget type: {type(widget)} in handler list {FilterIO._handlers}"
+            )
+        return None
+
+    @staticmethod
+    def check_input(widget, text: str, ignore_errors=True):
+        """
+        Check if the input text is in the filtered selection.
+
+        Args:
+            widget: Widget instance.
+            text(str): Input text.
+            ignore_errors(bool, optional): Whether to ignore if no handler is found.
+
+        Returns:
+            bool: True if the input text is in the filtered selection.
+        """
+        handler_class = FilterIO._find_handler(widget)
+        if handler_class:
+            return handler_class().check_input(widget=widget, text=text)
+        if not ignore_errors:
+            raise ValueError(
+                f"No matching handler for widget type: {type(widget)} in handler list {FilterIO._handlers}"
+            )
+        return None
+
+    @staticmethod
+    def _find_handler(widget):
+        """
+        Find the appropriate handler for the widget by checking its base classes.
+
+        Args:
+            widget: Widget instance.
+
+        Returns:
+            handler_class: The handler class if found, otherwise None.
+        """
+        for base in type(widget).__mro__:
+            if base in FilterIO._handlers:
+                return FilterIO._handlers[base]
+        return None

bec_widgets/utils/fps_counter.py

@@ -0,0 +1,84 @@
+"""
+This module provides a utility class for counting and reporting frames per second (FPS) in a PyQtGraph application.
+
+Classes:
+    FPSCounter: A class that monitors the paint events of a `ViewBox` to calculate and emit FPS values.
+
+Usage:
+    The `FPSCounter` class can be used to monitor the rendering performance of a `ViewBox` in a PyQtGraph application.
+    It connects to the `ViewBox`'s paint event and calculates the FPS over a specified interval, emitting the FPS value
+    at regular intervals.
+
+Example:
+    from qtpy import QtWidgets, QtCore
+    import pyqtgraph as pg
+    from fps_counter import FPSCounter
+
+    app = pg.mkQApp("FPS Counter Example")
+    win = pg.GraphicsLayoutWidget()
+    win.show()
+
+    vb = pg.ViewBox()
+    plot_item = pg.PlotItem(viewBox=vb)
+    win.addItem(plot_item)
+
+    fps_counter = FPSCounter(vb)
+    fps_counter.sigFpsUpdate.connect(lambda fps: print(f"FPS: {fps:.2f}"))
+
+    sys.exit(app.exec_())
+"""
+
+from time import perf_counter
+
+import pyqtgraph as pg
+from qtpy import QtCore
+
+
+class FPSCounter(QtCore.QObject):
+    """
+    A utility class for counting and reporting frames per second (FPS).
+
+    This class connects to a `ViewBox`'s paint event to count the number of
+    frames rendered and calculates the FPS over a specified interval. It emits
+    a signal with the FPS value at regular intervals.
+
+    Attributes:
+        sigFpsUpdate (QtCore.Signal): Signal emitted with the FPS value.
+        view_box (pg.ViewBox): The `ViewBox` instance to monitor.
+    """
+
+    sigFpsUpdate = QtCore.Signal(float)
+
+    def __init__(self, view_box):
+        super().__init__()
+        self.view_box = view_box
+        self.view_box.sigPaint.connect(self.increment_count)
+        self.count = 0
+        self.last_update = perf_counter()
+        self.timer = QtCore.QTimer()
+        self.timer.timeout.connect(self.calculate_fps)
+        self.timer.start(1000)
+
+    def increment_count(self):
+        """
+        Increment the frame count when the `ViewBox` is painted.
+        """
+        self.count += 1
+
+    def calculate_fps(self):
+        """
+        Calculate the frames per second (FPS) based on the number of frames
+        """
+        now = perf_counter()
+        elapsed = now - self.last_update
+        fps = self.count / elapsed if elapsed > 0 else 0.0
+        self.last_update = now
+        self.count = 0
+        self.sigFpsUpdate.emit(fps)
+
+    def cleanup(self):
+        """
+        Clean up the FPS counter by stopping the timer and disconnecting the signal.
+        """
+        self.timer.stop()
+        self.timer.timeout.disconnect(self.calculate_fps)

bec_widgets/utils/generate_designer_plugin.py

@@ -0,0 +1,149 @@
+import inspect
+import os
+import re
+
+from qtpy.QtCore import QObject
+
+EXCLUDED_PLUGINS = ["BECConnector", "BECDockArea", "BECDock", "BECFigure"]
+
+
+class DesignerPluginInfo:
+    def __init__(self, plugin_class):
+        self.plugin_class = plugin_class
+        self.plugin_name_pascal = plugin_class.__name__
+        self.plugin_name_snake = self.pascal_to_snake(self.plugin_name_pascal)
+        self.widget_import = f"from {plugin_class.__module__} import {self.plugin_name_pascal}"
+        plugin_module = (
+            ".".join(plugin_class.__module__.split(".")[:-1]) + f".{self.plugin_name_snake}_plugin"
+        )
+        self.plugin_import = f"from {plugin_module} import {self.plugin_name_pascal}Plugin"
+
+        # first sentence / line of the docstring is used as tooltip
+        self.plugin_tooltip = (
+            plugin_class.__doc__.split("\n")[0].strip().replace('"', "'")
+            if plugin_class.__doc__
+            else self.plugin_name_pascal
+        )
+
+        self.base_path = os.path.dirname(inspect.getfile(plugin_class))
+
+    @staticmethod
+    def pascal_to_snake(name: str) -> str:
+        """
+        Convert PascalCase to snake_case.
+
+        Args:
+            name (str): The name to be converted.
+
+        Returns:
+            str: The converted name.
+        """
+        s1 = re.sub(r"([a-z0-9])([A-Z])", r"\1_\2", name)
+        s2 = re.sub(r"([A-Z]+)([A-Z][a-z])", r"\1_\2", s1)
+        return s2.lower()
+
+
+class DesignerPluginGenerator:
+    def __init__(self, widget: type):
+        self._excluded = False
+        self.widget = widget
+        self.info = DesignerPluginInfo(widget)
+        if widget.__name__ in EXCLUDED_PLUGINS:
+
+            self._excluded = True
+            return
+
+        self.templates = {}
+        self.template_path = os.path.join(
+            os.path.dirname(os.path.abspath(__file__)), "plugin_templates"
+        )
+
+    def run(self, validate=True):
+        if self._excluded:
+            print(f"Plugin {self.widget.__name__} is excluded from generation.")
+            return
+        if validate:
+            self._check_class_validity()
+        self._load_templates()
+        self._write_templates()
+
+    def _check_class_validity(self):
+
+        # Check if the widget is a QWidget subclass
+        if not issubclass(self.widget, QObject):
+            return
+
+        # Check if the widget class has parent as the first argument. This is a strict requirement of Qt!
+        signature = list(inspect.signature(self.widget.__init__).parameters.values())
+        if len(signature) == 1 or signature[1].name != "parent":
+            raise ValueError(
+                f"Widget class {self.widget.__name__} must have parent as the first argument."
+            )
+
+        base_cls = [val for val in self.widget.__bases__ if issubclass(val, QObject)]
+        if not base_cls:
+            raise ValueError(
+                f"Widget class {self.widget.__name__} must inherit from a QObject subclass."
+            )
+
+        # Check if the widget class calls the super constructor with parent argument
+        init_source = inspect.getsource(self.widget.__init__)
+        cls_init_found = (
+            bool(init_source.find(f"{base_cls[0].__name__}.__init__(self, parent=parent") > 0)
+            or bool(init_source.find(f"{base_cls[0].__name__}.__init__(self, parent)") > 0)
+            or bool(init_source.find(f"{base_cls[0].__name__}.__init__(self, parent,") > 0)
+        )
+        super_init_found = (
+            bool(
+                init_source.find(f"super({base_cls[0].__name__}, self).__init__(parent=parent") > 0
+            )
+            or bool(init_source.find(f"super({base_cls[0].__name__}, self).__init__(parent,") > 0)
+            or bool(init_source.find(f"super({base_cls[0].__name__}, self).__init__(parent)") > 0)
+        )
+        if issubclass(self.widget.__bases__[0], QObject) and not super_init_found:
+            super_init_found = (
+                bool(init_source.find("super().__init__(parent=parent") > 0)
+                or bool(init_source.find("super().__init__(parent,") > 0)
+                or bool(init_source.find("super().__init__(parent)") > 0)
+            )
+
+        if not cls_init_found and not super_init_found:
+            raise ValueError(
+                f"Widget class {self.widget.__name__} must call the super constructor with parent."
+            )
+
+    def _write_templates(self):
+        self._write_register()
+        self._write_plugin()
+        self._write_pyproject()
+
+    def _write_register(self):
+        file_path = os.path.join(self.info.base_path, f"register_{self.info.plugin_name_snake}.py")
+        with open(file_path, "w", encoding="utf-8") as f:
+            f.write(self.templates["register"].format(**self.info.__dict__))
+
+    def _write_plugin(self):
+        file_path = os.path.join(self.info.base_path, f"{self.info.plugin_name_snake}_plugin.py")
+        with open(file_path, "w", encoding="utf-8") as f:
+            f.write(self.templates["plugin"].format(**self.info.__dict__))
+
+    def _write_pyproject(self):
+        file_path = os.path.join(self.info.base_path, f"{self.info.plugin_name_snake}.pyproject")
+        out = {"files": [f"{self.info.plugin_class.__module__.split('.')[-1]}.py"]}
+        with open(file_path, "w", encoding="utf-8") as f:
+            f.write(str(out))
+
+    def _load_templates(self):
+        for file in os.listdir(self.template_path):
+            if not file.endswith(".template"):
+                continue
+            with open(os.path.join(self.template_path, file), "r", encoding="utf-8") as f:
+                self.templates[file.split(".")[0]] = f.read()
+
+
+if __name__ == "__main__":  # pragma: no cover
+    # from bec_widgets.widgets.bec_queue.bec_queue import BECQueue
+    from bec_widgets.widgets.spinner.spinner import SpinnerWidget
+
+    generator = DesignerPluginGenerator(SpinnerWidget)
+    generator.run(validate=False)

bec_widgets/utils/linear_region_selector.py

@@ -0,0 +1,84 @@
+""" Module for a thin wrapper (LinearRegionWrapper) around the LinearRegionItem in pyqtgraph.
+The class is mainly designed for usage with the BECWaveform and 1D plots. """
+
+import pyqtgraph as pg
+from qtpy.QtCore import QObject, Signal, Slot
+from qtpy.QtGui import QColor
+
+
+class LinearRegionWrapper(QObject):
+    """Wrapper class for the LinearRegionItem in pyqtgraph for 1D plots (BECWaveform)
+
+    Args:
+        plot_item (pg.PlotItem): The plot item to add the region selector to.
+        parent (QObject): The parent object.
+        color (QColor): The color of the region selector.
+        hover_color (QColor): The color of the region selector when the mouse is over it.
+    """
+
+    # Signal with the region tuble (start, end)
+    region_changed = Signal(tuple)
+
+    def __init__(
+        self, plot_item: pg.PlotItem, color: QColor = None, hover_color: QColor = None, parent=None
+    ):
+        super().__init__(parent)
+        self.is_log_x = None
+        self._edge_width = 2
+        self.plot_item = plot_item
+        self.linear_region_selector = pg.LinearRegionItem()
+        self.proxy = None
+        self.change_roi_color((color, hover_color))
+        self.plot_item.ctrl.logXCheck.checkStateChanged.connect(self.check_log)
+        self.plot_item.ctrl.logYCheck.checkStateChanged.connect(self.check_log)
+
+    # Slot for changing the color of the region selector (edge and fill)
+    @Slot(tuple)
+    def change_roi_color(self, colors: tuple[QColor | str | tuple, QColor | str | tuple]):
+        """Change the color and hover color of the region selector.
+        Hover color means the color when the mouse is over the region.
+
+        Args:
+            colors (tuple): Tuple with the color and hover color
+        """
+        color, hover_color = colors
+        if color is not None:
+            self.linear_region_selector.setBrush(pg.mkBrush(color))
+        if hover_color is not None:
+            self.linear_region_selector.setHoverBrush(pg.mkBrush(hover_color))
+
+    @Slot()
+    def add_region_selector(self):
+        """Add the region selector to the plot item"""
+        self.plot_item.addItem(self.linear_region_selector)
+        # Use proxy to limit the update rate of the region change signal to 10Hz
+        self.proxy = pg.SignalProxy(
+            self.linear_region_selector.sigRegionChanged,
+            rateLimit=10,
+            slot=self._region_change_proxy,
+        )
+
+    @Slot()
+    def remove_region_selector(self):
+        """Remove the region selector from the plot item"""
+        self.proxy.disconnect()
+        self.proxy = None
+        self.plot_item.removeItem(self.linear_region_selector)
+
+    def _region_change_proxy(self):
+        """Emit the region change signal. If the plot is in log mode, convert the region to log."""
+        x_low, x_high = self.linear_region_selector.getRegion()
+        if self.is_log_x:
+            x_low = 10**x_low
+            x_high = 10**x_high
+        self.region_changed.emit((x_low, x_high))
+
+    @Slot()
+    def check_log(self):
+        """Check if the plot is in log mode."""
+        self.is_log_x = self.plot_item.ctrl.logXCheck.isChecked()
+        self.is_log_y = self.plot_item.ctrl.logYCheck.isChecked()
+
+    def cleanup(self):
+        """Cleanup the widget."""
+        self.remove_region_selector()

bec_widgets/utils/ophyd_kind_util.py

@@ -0,0 +1,26 @@
+from enum import IntFlag
+
+try:
+
+    from enum import KEEP
+
+    class IFBase(IntFlag, boundary=KEEP): ...
+
+except ImportError:
+
+    IFBase = IntFlag
+
+
+class Kind(IFBase):
+    """
+    This is used in the .kind attribute of all OphydObj (Signals, Devices).
+
+    A Device examines its components' .kind atttribute to decide whether to
+    traverse it in read(), read_configuration(), or neither. Additionally, if
+    decides whether to include its name in `hints['fields']`.
+    """
+
+    omitted = 0b000
+    normal = 0b001
+    config = 0b010
+    hinted = 0b101  # Notice that bool(hinted & normal) is True.

bec_widgets/utils/plot_indicator_items.py

@@ -0,0 +1,247 @@
+"""Module to create an arrow item for a pyqtgraph plot"""
+
+import numpy as np
+import pyqtgraph as pg
+from bec_lib.logger import bec_logger
+from qtpy.QtCore import QObject, QPointF, Signal, Slot
+
+from bec_widgets.utils.colors import get_accent_colors
+
+logger = bec_logger.logger
+
+
+class BECIndicatorItem(QObject):
+
+    def __init__(self, plot_item: pg.PlotItem = None, parent=None):
+        super().__init__(parent=parent)
+        self.accent_colors = get_accent_colors()
+        self.plot_item = plot_item
+        self._item_on_plot = False
+        self._pos = None
+        self.is_log_x = False
+        self.is_log_y = False
+
+    @property
+    def item_on_plot(self) -> bool:
+        """Returns if the item is on the plot"""
+        return self._item_on_plot
+
+    @item_on_plot.setter
+    def item_on_plot(self, value: bool) -> None:
+        self._item_on_plot = value
+
+    def add_to_plot(self) -> None:
+        """Add the item to the plot"""
+        raise NotImplementedError("Method add_to_plot not implemented")
+
+    def remove_from_plot(self) -> None:
+        """Remove the item from the plot"""
+        raise NotImplementedError("Method remove_from_plot not implemented")
+
+    def set_position(self, pos) -> None:
+        """This method should implement the logic to set the position of the
+        item on the plot. Depending on the child class, the position can be
+        a tuple (x,y) or a single value, i.e. x position where y position is fixed.
+        """
+        raise NotImplementedError("Method set_position not implemented")
+
+    def check_log(self):
+        """Checks if the x or y axis is in log scale and updates the internal state accordingly."""
+        self.is_log_x = self.plot_item.ctrl.logXCheck.isChecked()
+        self.is_log_y = self.plot_item.ctrl.logYCheck.isChecked()
+        self.set_position(self._pos)
+
+
+class BECTickItem(BECIndicatorItem):
+    """Class to create a tick item which can be added to a pyqtgraph plot.
+    The tick item will be added to the layout of the plot item and can be used to indicate
+    a position"""
+
+    position_changed = Signal(float)
+    position_changed_str = Signal(str)
+
+    def __init__(self, plot_item: pg.PlotItem = None, parent=None):
+        super().__init__(plot_item=plot_item, parent=parent)
+        self.tick_item = pg.TickSliderItem(
+            parent=parent, allowAdd=False, allowRemove=False, orientation="bottom"
+        )
+        self.tick_item.skip_auto_range = True
+        self.tick = None
+        self._pos = 0.0
+        self._range = [0, 1]
+
+    @Slot(float)
+    def set_position(self, pos: float) -> None:
+        """Set the x position of the tick item
+
+        Args:
+            pos (float): The position of the tick item.
+        """
+        if self.is_log_x is True:
+            pos = pos if pos > 0 else 1e-10
+            pos = np.log10(pos)
+        self._pos = pos
+        view_box = self.plot_item.getViewBox()  # Ensure you're accessing the correct view box
+        view_range = view_box.viewRange()[0]
+        self.update_range(self.plot_item.vb, view_range)
+        self.position_changed.emit(pos)
+        self.position_changed_str.emit(str(pos))
+
+    @Slot()
+    def update_range(self, _, view_range: tuple[float, float]) -> None:
+        """Update the range of the tick item
+
+        Args:
+            vb (pg.ViewBox): The view box.
+            viewRange (tuple): The view range.
+        """
+        if self._pos < view_range[0] or self._pos > view_range[1]:
+            self.tick_item.setVisible(False)
+        else:
+            self.tick_item.setVisible(True)
+
+        if self.tick_item.isVisible():
+            origin = self.tick_item.tickSize / 2.0
+            length = self.tick_item.length
+
+            length_with_padding = length + self.tick_item.tickSize + 2
+
+            self._range = view_range
+            tick_with_padding = (self._pos - view_range[0]) / (view_range[1] - view_range[0])
+            tick_value = (tick_with_padding * length_with_padding - origin) / length
+            self.tick_item.setTickValue(self.tick, tick_value)
+
+    def add_to_plot(self):
+        """Add the tick item to the view box or plot item."""
+        if self.plot_item is None:
+            return
+
+        self.plot_item.layout.addItem(self.tick_item, 2, 1)
+        self.tick_item.setOrientation("top")
+        self.tick = self.tick_item.addTick(0, movable=False, color=self.accent_colors.highlight)
+        self.update_tick_pos_y()
+        self.plot_item.vb.sigXRangeChanged.connect(self.update_range)
+        self.plot_item.ctrl.logXCheck.checkStateChanged.connect(self.check_log)
+        self.plot_item.ctrl.logYCheck.checkStateChanged.connect(self.check_log)
+        self.plot_item.vb.geometryChanged.connect(self.update_tick_pos_y)
+        self.item_on_plot = True
+
+    @Slot()
+    def update_tick_pos_y(self):
+        """Update tick position, while respecting the tick_item coordinates"""
+        pos = self.tick.pos()
+        pos = self.tick_item.mapToParent(pos)
+        new_pos = self.plot_item.vb.geometry().bottom()
+        new_pos = self.tick_item.mapFromParent(QPointF(pos.x(), new_pos))
+        self.tick.setPos(new_pos)
+
+    def remove_from_plot(self):
+        """Remove the tick item from the view box or plot item."""
+        if self.plot_item is not None and self.item_on_plot is True:
+            self.plot_item.vb.sigXRangeChanged.disconnect(self.update_range)
+            self.plot_item.ctrl.logXCheck.checkStateChanged.disconnect(self.check_log)
+            self.plot_item.ctrl.logYCheck.checkStateChanged.disconnect(self.check_log)
+            if self.plot_item.layout is not None:
+                self.plot_item.layout.removeItem(self.tick_item)
+        self.item_on_plot = False
+
+    def cleanup(self) -> None:
+        """Cleanup the item"""
+        self.remove_from_plot()
+        if self.tick_item is not None:
+            self.tick_item.close()
+            self.tick_item.deleteLater()
+            self.tick_item = None
+
+
+class BECArrowItem(BECIndicatorItem):
+    """Class to create an arrow item which can be added to a pyqtgraph plot.
+    It can be either added directly to a view box or a plot item.
+    To add the arrow item to a view box or plot item, use the add_to_plot method.
+
+    Args:
+        view_box (pg.ViewBox | pg.PlotItem): The view box or plot item to which the arrow item should be added.
+        parent (QObject): The parent object.
+
+    Signals:
+        position_changed (tuple[float, float]): Signal emitted when the position of the arrow item has changed.
+        position_changed_str (tuple[str, str]): Signal emitted when the position of the arrow item has changed.
+    """
+
+    # Signal to emit if the position of the arrow item has changed
+    position_changed = Signal(tuple)
+    position_changed_str = Signal(tuple)
+
+    def __init__(self, plot_item: pg.PlotItem = None, parent=None):
+        super().__init__(plot_item=plot_item, parent=parent)
+        self.arrow_item = pg.ArrowItem(parent=parent)
+        self.arrow_item.skip_auto_range = True
+        self._pos = (0, 0)
+        self.arrow_item.setVisible(False)
+
+    @Slot(dict)
+    def set_style(self, style: dict) -> None:
+        """Set the style of the arrow item
+
+        Args:
+            style (dict): The style of the arrow item. Dictionary with key,
+                          value pairs which are accepted from the pg.ArrowItem.setStyle method.
+        """
+        self.arrow_item.setStyle(**style)
+
+    @Slot(tuple)
+    def set_position(self, pos: tuple[float, float]) -> None:
+        """Set the position of the arrow item
+
+        Args:
+            pos (tuple): The position of the arrow item as a tuple (x, y).
+        """
+        self._pos = pos
+        pos_x = pos[0]
+        pos_y = pos[1]
+        if self.is_log_x is True:
+            pos_x = np.log10(pos_x) if pos_x > 0 else 1e-10
+            view_box = self.plot_item.getViewBox()  # Ensure you're accessing the correct view box
+            view_range = view_box.viewRange()[0]
+            # Avoid values outside the view range in the negative direction. Otherwise, there is
+            # a buggy behaviour of the arrow item and it appears at the wrong position.
+            if pos_x < view_range[0]:
+                pos_x = view_range[0]
+        if self.is_log_y is True:
+            pos_y = np.log10(pos_y) if pos_y > 0 else 1e-10
+
+        self.arrow_item.setPos(pos_x, pos_y)
+        self.position_changed.emit(self._pos)
+        self.position_changed_str.emit((str(self._pos[0]), str(self._pos[1])))
+
+    def add_to_plot(self):
+        """Add the arrow item to the view box or plot item."""
+        if not self.arrow_item:
+            logger.warning(f"Arrow item was already destroyed, cannot be created")
+            return
+
+        self.arrow_item.setStyle(
+            angle=-90,
+            pen=pg.mkPen(self.accent_colors.emergency, width=1),
+            brush=pg.mkBrush(self.accent_colors.highlight),
+            headLen=20,
+        )
+        self.arrow_item.setVisible(True)
+        if self.plot_item is not None:
+            self.plot_item.addItem(self.arrow_item)
+            self.plot_item.ctrl.logXCheck.checkStateChanged.connect(self.check_log)
+            self.plot_item.ctrl.logYCheck.checkStateChanged.connect(self.check_log)
+            self.item_on_plot = True
+
+    def remove_from_plot(self):
+        """Remove the arrow item from the view box or plot item."""
+        if self.plot_item is not None and self.item_on_plot is True:
+            self.plot_item.ctrl.logXCheck.checkStateChanged.disconnect(self.check_log)
+            self.plot_item.ctrl.logYCheck.checkStateChanged.disconnect(self.check_log)
+            self.plot_item.removeItem(self.arrow_item)
+        self.item_on_plot = False
+
+    def cleanup(self) -> None:
+        """Cleanup the item"""
+        self.remove_from_plot()
+        self.arrow_item = None

bec_widgets/utils/plugin_templates/plugin.template

@@ -1,23 +1,26 @@
-from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QIcon
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
 
-from bec_widgets.widgets.jupyter_console.jupyter_console import BECJupyterConsole
+from qtpy.QtDesigner import QDesignerCustomWidgetInterface
+
+from bec_widgets.utils.bec_designer import designer_material_icon
+{widget_import}
 
 DOM_XML = """
 <ui language='c++'>
-    <widget class='BECJupyterConsole' name='bec_jupyter'>
+    <widget class='{plugin_name_pascal}' name='{plugin_name_snake}'>
     </widget>
 </ui>
 """
 
 
-class BECJupyterConsolePlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
+class {plugin_name_pascal}Plugin(QDesignerCustomWidgetInterface):  # pragma: no cover
     def __init__(self):
         super().__init__()
         self._form_editor = None
 
     def createWidget(self, parent):
-        t = BECJupyterConsole(parent)
+        t = {plugin_name_pascal}(parent)
         return t
 
     def domXml(self):
@@ -27,10 +30,10 @@ class BECJupyterConsolePlugin(QDesignerCustomWidgetInterface):  # pragma: no cov
         return ""
 
     def icon(self):
-        return QIcon()
+        return designer_material_icon({plugin_name_pascal}.ICON_NAME)
 
     def includeFile(self):
-        return "bec_jupyter"
+        return "{plugin_name_snake}"
 
     def initialize(self, form_editor):
         self._form_editor = form_editor
@@ -42,10 +45,10 @@ class BECJupyterConsolePlugin(QDesignerCustomWidgetInterface):  # pragma: no cov
         return self._form_editor is not None
 
     def name(self):
-        return "BECJupyterConsole"
+        return "{plugin_name_pascal}"
 
     def toolTip(self):
-        return "BECJupyterConsole widget"
+        return "{plugin_tooltip}"
 
     def whatsThis(self):
         return self.toolTip()

bec_widgets/utils/plugin_templates/register.template

@@ -6,9 +6,9 @@ def main():  # pragma: no cover
         return
     from PySide6.QtDesigner import QPyDesignerCustomWidgetCollection
 
-    from bec_widgets.widgets.jupyter_console.jupyter_console_plugin import BECJupyterConsolePlugin
+    {plugin_import}
 
-    QPyDesignerCustomWidgetCollection.addCustomWidget(BECJupyterConsolePlugin())
+    QPyDesignerCustomWidgetCollection.addCustomWidget({plugin_name_pascal}Plugin())
 
 
 if __name__ == "__main__":  # pragma: no cover

bec_widgets/utils/plugin_utils.py

@@ -1,12 +1,13 @@
 import importlib
 import inspect
 import os
-from typing import Literal
+from dataclasses import dataclass
 
 from bec_lib.plugin_helper import _get_available_plugins
 from qtpy.QtWidgets import QGraphicsWidget, QWidget
 
 from bec_widgets.utils import BECConnector
+from bec_widgets.utils.bec_widget import BECWidget
 
 
 def get_plugin_widgets() -> dict[str, BECConnector]:
@@ -44,9 +45,74 @@ def _filter_plugins(obj):
     return inspect.isclass(obj) and issubclass(obj, BECConnector)
 
 
-def get_rpc_classes(
-    repo_name: str,
-) -> dict[Literal["connector_classes", "top_level_classes"], list[type]]:
+@dataclass
+class BECClassInfo:
+    name: str
+    module: str
+    file: str
+    obj: type
+    is_connector: bool = False
+    is_widget: bool = False
+    is_top_level: bool = False
+
+
+class BECClassContainer:
+    def __init__(self):
+        self._collection = []
+
+    def add_class(self, class_info: BECClassInfo):
+        """
+        Add a class to the collection.
+
+        Args:
+            class_info(BECClassInfo): The class information
+        """
+        self.collection.append(class_info)
+
+    @property
+    def collection(self):
+        """
+        Get the collection of classes.
+        """
+        return self._collection
+
+    @property
+    def connector_classes(self):
+        """
+        Get all connector classes.
+        """
+        return [info.obj for info in self.collection if info.is_connector]
+
+    @property
+    def top_level_classes(self):
+        """
+        Get all top-level classes.
+        """
+        return [info.obj for info in self.collection if info.is_top_level]
+
+    @property
+    def plugins(self):
+        """
+        Get all plugins. These are all classes that are on the top level and are widgets.
+        """
+        return [info.obj for info in self.collection if info.is_widget and info.is_top_level]
+
+    @property
+    def widgets(self):
+        """
+        Get all widgets. These are all classes inheriting from BECWidget.
+        """
+        return [info.obj for info in self.collection if info.is_widget]
+
+    @property
+    def rpc_top_level_classes(self):
+        """
+        Get all top-level classes that are RPC-enabled. These are all classes that users can choose from.
+        """
+        return [info.obj for info in self.collection if info.is_top_level and info.is_connector]
+
+
+def get_rpc_classes(repo_name: str) -> BECClassContainer:
     """
     Get all RPC-enabled classes in the specified repository.
 
@@ -56,8 +122,7 @@ def get_rpc_classes(
     Returns:
         dict: A dictionary with keys "connector_classes" and "top_level_classes" and values as lists of classes.
     """
-    connector_classes = []
-    top_level_classes = []
+    collection = BECClassContainer()
     anchor_module = importlib.import_module(f"{repo_name}.widgets")
     directory = os.path.dirname(anchor_module.__file__)
     for root, _, files in sorted(os.walk(directory)):
@@ -78,11 +143,16 @@ def get_rpc_classes(
                 obj = getattr(module, name)
                 if not hasattr(obj, "__module__") or obj.__module__ != module.__name__:
                     continue
-                if isinstance(obj, type) and issubclass(obj, BECConnector):
-                    connector_classes.append(obj)
+                if isinstance(obj, type):
+                    class_info = BECClassInfo(name=name, module=module_name, file=path, obj=obj)
+                    if issubclass(obj, BECConnector):
+                        class_info.is_connector = True
+                    if issubclass(obj, BECWidget):
+                        class_info.is_widget = True
                     if len(subs) == 1 and (
                         issubclass(obj, QWidget) or issubclass(obj, QGraphicsWidget)
                     ):
-                        top_level_classes.append(obj)
+                        class_info.is_top_level = True
+                    collection.add_class(class_info)
 
-    return {"connector_classes": connector_classes, "top_level_classes": top_level_classes}
+    return collection

bec_widgets/utils/reference_utils.py

@@ -0,0 +1,92 @@
+import os
+import sys
+
+from PIL import Image, ImageChops
+from qtpy.QtGui import QPixmap
+
+import bec_widgets
+
+REFERENCE_DIR = os.path.join(
+    os.path.dirname(os.path.dirname(bec_widgets.__file__)), "tests/references"
+)
+REFERENCE_DIR_FAILURES = os.path.join(
+    os.path.dirname(os.path.dirname(bec_widgets.__file__)), "tests/reference_failures"
+)
+
+
+def compare_images(image1_path: str, reference_image_path: str):
+    """
+    Load two images and compare them pixel by pixel
+
+    Args:
+        image1_path(str): The path to the first image
+        reference_image_path(str): The path to the reference image
+
+    Raises:
+        ValueError: If the images are different
+    """
+    image1 = Image.open(image1_path)
+    image2 = Image.open(reference_image_path)
+    if image1.size != image2.size:
+        raise ValueError("Image size has changed")
+    diff = ImageChops.difference(image1, image2)
+    if diff.getbbox():
+        # copy image1 to the reference directory to upload as artifact
+        os.makedirs(REFERENCE_DIR_FAILURES, exist_ok=True)
+        image_name = os.path.join(REFERENCE_DIR_FAILURES, os.path.basename(image1_path))
+        image1.save(image_name)
+        print(f"Image saved to {image_name}")
+
+        raise ValueError("Images are different")
+
+
+def snap_and_compare(widget: any, output_directory: str, suffix: str = ""):
+    """
+    Save a rendering of a widget and compare it to a reference image
+
+    Args:
+        widget(any): The widget to render
+        output_directory(str): The directory to save the image to
+        suffix(str): A suffix to append to the image name
+
+    Raises:
+        ValueError: If the images are different
+
+    Examples:
+        snap_and_compare(widget, tmpdir, suffix="started")
+
+    """
+
+    if not isinstance(output_directory, str):
+        output_directory = str(output_directory)
+
+    os_suffix = sys.platform
+
+    name = (
+        f"{widget.__class__.__name__}_{suffix}_{os_suffix}.png"
+        if suffix
+        else f"{widget.__class__.__name__}_{os_suffix}.png"
+    )
+
+    # Save the widget to a pixmap
+    test_image_path = os.path.join(output_directory, name)
+    pixmap = QPixmap(widget.size())
+    widget.render(pixmap)
+    pixmap.save(test_image_path)
+
+    try:
+        reference_path = os.path.join(REFERENCE_DIR, f"{widget.__class__.__name__}")
+        reference_image_path = os.path.join(reference_path, name)
+
+        if not os.path.exists(reference_image_path):
+            raise ValueError(f"Reference image not found: {reference_image_path}")
+
+        compare_images(test_image_path, reference_image_path)
+
+    except ValueError:
+        image = Image.open(test_image_path)
+        os.makedirs(REFERENCE_DIR_FAILURES, exist_ok=True)
+        image_name = os.path.join(REFERENCE_DIR_FAILURES, name)
+        image.save(image_name)
+        print(f"Image saved to {image_name}")
+        raise

bec_widgets/utils/ui_loader.py

@@ -1,21 +1,18 @@
+import os
+
 from qtpy import PYQT6, PYSIDE6, QT_VERSION
 from qtpy.QtCore import QFile, QIODevice
 
+from bec_widgets.utils.generate_designer_plugin import DesignerPluginInfo
+from bec_widgets.utils.plugin_utils import get_rpc_classes
+
 if PYSIDE6:
     from PySide6.QtUiTools import QUiLoader
 
-    from bec_widgets.examples.plugin_example_pyside.tictactoe import TicTacToe
-    from bec_widgets.utils.plugin_utils import get_rpc_classes
-
     class CustomUiLoader(QUiLoader):
-        def __init__(self, baseinstance):
+        def __init__(self, baseinstance, custom_widgets: dict = None):
             super().__init__(baseinstance)
-            widgets = get_rpc_classes("bec_widgets").get("top_level_classes", [])
-
-            # remove this line once the plugin is not needed anymore
-            widgets.append(TicTacToe)
-
-            self.custom_widgets = {widget.__name__: widget for widget in widgets}
+            self.custom_widgets = custom_widgets or {}
 
             self.baseinstance = baseinstance
 
@@ -28,25 +25,21 @@ if PYSIDE6:
 
 
 class UILoader:
-    """Universal UI loader for PyQt5, PyQt6, PySide2, and PySide6."""
+    """Universal UI loader for PyQt6 and PySide6."""
 
     def __init__(self, parent=None):
         self.parent = parent
-        if QT_VERSION.startswith("5"):
-            # PyQt5 or PySide2
-            from qtpy import uic
 
-            self.loader = uic.loadUi
-        elif QT_VERSION.startswith("6"):
-            # PyQt6 or PySide6
-            if PYSIDE6:
-                self.loader = self.load_ui_pyside6
-            elif PYQT6:
-                from PyQt6.uic import loadUi
+        widgets = get_rpc_classes("bec_widgets").top_level_classes
 
-                self.loader = loadUi
-            else:
-                raise ImportError("No compatible Qt bindings found.")
+        self.custom_widgets = {widget.__name__: widget for widget in widgets}
+
+        if PYSIDE6:
+            self.loader = self.load_ui_pyside6
+        elif PYQT6:
+            self.loader = self.load_ui_pyqt6
+        else:
+            raise ImportError("No compatible Qt bindings found.")
 
     def load_ui_pyside6(self, ui_file, parent=None):
         """
@@ -59,7 +52,7 @@ class UILoader:
             QWidget: The loaded widget.
         """
 
-        loader = CustomUiLoader(parent)
+        loader = CustomUiLoader(parent, self.custom_widgets)
         file = QFile(ui_file)
         if not file.open(QIODevice.ReadOnly):
             raise IOError(f"Cannot open file: {ui_file}")
@@ -67,6 +60,71 @@ class UILoader:
         file.close()
         return widget
 
+    def load_ui_pyqt6(self, ui_file, parent=None):
+        """
+        Specific loader for PyQt6 using loadUi.
+        Args:
+            ui_file(str): Path to the .ui file.
+            parent(QWidget): Parent widget.
+
+        Returns:
+            QWidget: The loaded widget.
+        """
+        from PyQt6.uic.Loader.loader import DynamicUILoader
+
+        class CustomDynamicUILoader(DynamicUILoader):
+            def __init__(self, package, custom_widgets: dict = None):
+                super().__init__(package)
+                self.custom_widgets = custom_widgets or {}
+
+            def _handle_custom_widgets(self, el):
+                """Handle the <customwidgets> element."""
+
+                def header2module(header):
+                    """header2module(header) -> string
+
+                    Convert paths to C++ header files to according Python modules
+                    >>> header2module("foo/bar/baz.h")
+                    'foo.bar.baz'
+                    """
+
+                    if header.endswith(".h"):
+                        header = header[:-2]
+
+                    mpath = []
+                    for part in header.split("/"):
+                        # Ignore any empty parts or those that refer to the current
+                        # directory.
+                        if part not in ("", "."):
+                            if part == "..":
+                                # We should allow this for Python3.
+                                raise SyntaxError(
+                                    "custom widget header file name may not contain '..'."
+                                )
+
+                            mpath.append(part)
+
+                    return ".".join(mpath)
+
+                for custom_widget in el:
+                    classname = custom_widget.findtext("class")
+                    header = custom_widget.findtext("header")
+                    if header:
+                        header = self._translate_bec_widgets_header(header)
+                    self.factory.addCustomWidget(
+                        classname,
+                        custom_widget.findtext("extends") or "QWidget",
+                        header2module(header),
+                    )
+
+            def _translate_bec_widgets_header(self, header):
+                for name, value in self.custom_widgets.items():
+                    if header == DesignerPluginInfo.pascal_to_snake(name):
+                        return value.__module__
+                return header
+
+        return CustomDynamicUILoader("", self.custom_widgets).loadUi(ui_file, parent)
+
     def load_ui(self, ui_file, parent=None):
         """
         Universal UI loader method.

bec_widgets/utils/widget_io.py

@@ -1,5 +1,6 @@
 # pylint: disable=no-name-in-module
 from abc import ABC, abstractmethod
+from typing import Literal
 
 from qtpy.QtWidgets import (
     QApplication,
@@ -20,7 +21,7 @@ class WidgetHandler(ABC):
     """Abstract base class for all widget handlers."""
 
     @abstractmethod
-    def get_value(self, widget: QWidget):
+    def get_value(self, widget: QWidget, **kwargs):
         """Retrieve value from the widget instance."""
 
     @abstractmethod
@@ -31,7 +32,7 @@ class WidgetHandler(ABC):
 class LineEditHandler(WidgetHandler):
     """Handler for QLineEdit widgets."""
 
-    def get_value(self, widget: QLineEdit) -> str:
+    def get_value(self, widget: QLineEdit, **kwargs) -> str:
         return widget.text()
 
     def set_value(self, widget: QLineEdit, value: str) -> None:
@@ -41,17 +42,22 @@ class LineEditHandler(WidgetHandler):
 class ComboBoxHandler(WidgetHandler):
     """Handler for QComboBox widgets."""
 
-    def get_value(self, widget: QComboBox) -> int:
+    def get_value(self, widget: QComboBox, as_string: bool = False, **kwargs) -> int | str:
+        if as_string is True:
+            return widget.currentText()
         return widget.currentIndex()
 
-    def set_value(self, widget: QComboBox, value: int) -> None:
-        widget.setCurrentIndex(value)
+    def set_value(self, widget: QComboBox, value: int | str) -> None:
+        if isinstance(value, str):
+            value = widget.findText(value)
+        if isinstance(value, int):
+            widget.setCurrentIndex(value)
 
 
 class TableWidgetHandler(WidgetHandler):
     """Handler for QTableWidget widgets."""
 
-    def get_value(self, widget: QTableWidget) -> list:
+    def get_value(self, widget: QTableWidget, **kwargs) -> list:
         return [
             [
                 widget.item(row, col).text() if widget.item(row, col) else ""
@@ -70,7 +76,7 @@ class TableWidgetHandler(WidgetHandler):
 class SpinBoxHandler(WidgetHandler):
     """Handler for QSpinBox and QDoubleSpinBox widgets."""
 
-    def get_value(self, widget):
+    def get_value(self, widget, **kwargs):
         return widget.value()
 
     def set_value(self, widget, value):
@@ -80,7 +86,7 @@ class SpinBoxHandler(WidgetHandler):
 class CheckBoxHandler(WidgetHandler):
     """Handler for QCheckBox widgets."""
 
-    def get_value(self, widget):
+    def get_value(self, widget, **kwargs):
         return widget.isChecked()
 
     def set_value(self, widget, value):
@@ -90,7 +96,7 @@ class CheckBoxHandler(WidgetHandler):
 class LabelHandler(WidgetHandler):
     """Handler for QLabel widgets."""
 
-    def get_value(self, widget):
+    def get_value(self, widget, **kwargs):
         return widget.text()
 
     def set_value(self, widget, value):
@@ -111,7 +117,7 @@ class WidgetIO:
     }
 
     @staticmethod
-    def get_value(widget, ignore_errors=False):
+    def get_value(widget, ignore_errors=False, **kwargs):
         """
         Retrieve value from the widget instance.
 
@@ -121,7 +127,7 @@ class WidgetIO:
         """
         handler_class = WidgetIO._find_handler(widget)
         if handler_class:
-            return handler_class().get_value(widget)  # Instantiate the handler
+            return handler_class().get_value(widget, **kwargs)  # Instantiate the handler
         if not ignore_errors:
             raise ValueError(f"No handler for widget type: {type(widget)}")
         return None
@@ -142,6 +148,26 @@ class WidgetIO:
         elif not ignore_errors:
             raise ValueError(f"No handler for widget type: {type(widget)}")
 
+    @staticmethod
+    def check_and_adjust_limits(spin_box: QDoubleSpinBox, number: float):
+        """
+        Check if the new limits are within the current limits, if not adjust the limits.
+
+        Args:
+            number(float): The new value to check against the limits.
+        """
+
+        min_value = spin_box.minimum()
+        max_value = spin_box.maximum()
+
+        # Calculate the new limits
+        new_limit = number + 5 * number
+
+        if number < min_value:
+            spin_box.setMinimum(new_limit)
+        elif number > max_value:
+            spin_box.setMaximum(new_limit)
+
     @staticmethod
     def _find_handler(widget):
         """

bec_widgets/utils/yaml_dialog.py

@@ -6,7 +6,7 @@ import yaml
 from qtpy.QtWidgets import QFileDialog
 
 
-def load_yaml(instance) -> Union[dict, None]:
+def load_yaml_gui(instance) -> Union[dict, None]:
     """
     Load YAML file from disk.
 
@@ -20,12 +20,25 @@ def load_yaml(instance) -> Union[dict, None]:
     file_path, _ = QFileDialog.getOpenFileName(
         instance, "Load Settings", "", "YAML Files (*.yaml *.yml);;All Files (*)", options=options
     )
+    config = load_yaml(file_path)
+    return config
 
+
+def load_yaml(file_path: str) -> Union[dict, None]:
+    """
+    Load YAML file from disk.
+
+    Args:
+        file_path(str): Path to the YAML file.
+
+    Returns:
+        dict: Configuration data loaded from the YAML file.
+    """
     if not file_path:
         return None
     try:
         with open(file_path, "r") as file:
-            config = yaml.safe_load(file)
+            config = yaml.load(file, Loader=yaml.FullLoader)
         return config
 
     except FileNotFoundError:
@@ -38,7 +51,7 @@ def load_yaml(instance) -> Union[dict, None]:
         print(f"An error occurred while loading the settings from {file_path}: {e}")
 
 
-def save_yaml(instance, config: dict) -> None:
+def save_yaml_gui(instance, config: dict) -> None:
     """
     Save YAML file to disk.
 
@@ -51,6 +64,17 @@ def save_yaml(instance, config: dict) -> None:
         instance, "Save Settings", "", "YAML Files (*.yaml *.yml);;All Files (*)", options=options
     )
 
+    save_yaml(file_path, config)
+
+
+def save_yaml(file_path: str, config: dict) -> None:
+    """
+    Save YAML file to disk.
+
+    Args:
+        file_path(str): Path to the YAML file.
+        config(dict): Configuration data to be saved.
+    """
     if not file_path:
         return
     try:

bec_widgets/widgets/base_classes/device_input_base.py

@@ -0,0 +1,392 @@
+from __future__ import annotations
+
+import enum
+
+from bec_lib.device import ComputedSignal, Device, Positioner, ReadoutPriority
+from bec_lib.device import Signal as BECSignal
+from bec_lib.logger import bec_logger
+from qtpy.QtCore import Property, Signal, Slot
+
+from bec_widgets.utils import ConnectionConfig
+from bec_widgets.utils.bec_widget import BECWidget
+from bec_widgets.utils.filter_io import FilterIO
+from bec_widgets.utils.widget_io import WidgetIO
+
+logger = bec_logger.logger
+
+
+class BECDeviceFilter(enum.Enum):
+    """Filter for the device classes."""
+
+    DEVICE = "Device"
+    POSITIONER = "Positioner"
+    SIGNAL = "Signal"
+    COMPUTED_SIGNAL = "ComputedSignal"
+
+
+class DeviceInputConfig(ConnectionConfig):
+    device_filter: list[BECDeviceFilter] = []
+    readout_filter: list[ReadoutPriority] = []
+    devices: list[str] = []
+    default: str | None = None
+    arg_name: str | None = None
+    apply_filter: bool = True
+
+
+class DeviceInputBase(BECWidget):
+    """
+    Mixin base class for device input widgets.
+    It allows to filter devices from BEC based on
+    device class and readout priority.
+    """
+
+    _device_handler = {
+        BECDeviceFilter.DEVICE: Device,
+        BECDeviceFilter.POSITIONER: Positioner,
+        BECDeviceFilter.SIGNAL: BECSignal,
+        BECDeviceFilter.COMPUTED_SIGNAL: ComputedSignal,
+    }
+
+    _filter_handler = {
+        BECDeviceFilter.DEVICE: "filter_to_device",
+        BECDeviceFilter.POSITIONER: "filter_to_positioner",
+        BECDeviceFilter.SIGNAL: "filter_to_signal",
+        BECDeviceFilter.COMPUTED_SIGNAL: "filter_to_computed_signal",
+        ReadoutPriority.MONITORED: "readout_monitored",
+        ReadoutPriority.BASELINE: "readout_baseline",
+        ReadoutPriority.ASYNC: "readout_async",
+        ReadoutPriority.CONTINUOUS: "readout_continuous",
+        ReadoutPriority.ON_REQUEST: "readout_on_request",
+    }
+
+    def __init__(self, client=None, config=None, gui_id: str = None):
+
+        if config is None:
+            config = DeviceInputConfig(widget_class=self.__class__.__name__)
+        else:
+            if isinstance(config, dict):
+                config = DeviceInputConfig(**config)
+            self.config = config
+        super().__init__(client=client, config=config, gui_id=gui_id, theme_update=True)
+        self.get_bec_shortcuts()
+        self._device_filter = []
+        self._readout_filter = []
+        self._devices = []
+
+    ### QtSlots ###
+
+    @Slot(str)
+    def set_device(self, device: str):
+        """
+        Set the device.
+
+        Args:
+            device (str): Default name.
+        """
+        if self.validate_device(device) is True:
+            WidgetIO.set_value(widget=self, value=device)
+            self.config.default = device
+        else:
+            logger.warning(f"Device {device} is not in the filtered selection.")
+
+    @Slot()
+    def update_devices_from_filters(self):
+        """Update the devices based on the current filter selection
+        in self.device_filter and self.readout_filter. If apply_filter is False,
+        it will not apply the filters, store the filter settings and return.
+        """
+        current_device = WidgetIO.get_value(widget=self, as_string=True)
+        self.config.device_filter = self.device_filter
+        self.config.readout_filter = self.readout_filter
+        if self.apply_filter is False:
+            return
+        all_dev = self.dev.enabled_devices
+        # Filter based on device class
+        devs = [dev for dev in all_dev if self._check_device_filter(dev)]
+        # Filter based on readout priority
+        devs = [dev for dev in devs if self._check_readout_filter(dev)]
+        self.devices = [device.name for device in devs]
+        self.set_device(current_device)
+
+    @Slot(list)
+    def set_available_devices(self, devices: list[str]):
+        """
+        Set the devices. If a device in the list is not valid, it will not be considered.
+
+        Args:
+            devices (list[str]): List of devices.
+        """
+        self.apply_filter = False
+        self.devices = devices
+
+    ### QtProperties ###
+
+    @Property(
+        "QStringList",
+        doc="List of devices. If updated, it will disable the apply filters property.",
+    )
+    def devices(self) -> list[str]:
+        """
+        Get the list of devices for the applied filters.
+
+        Returns:
+            list[str]: List of devices.
+        """
+        return self._devices
+
+    @devices.setter
+    def devices(self, value: list):
+        self._devices = value
+        self.config.devices = value
+        FilterIO.set_selection(widget=self, selection=value)
+
+    @Property(str)
+    def default(self):
+        """Get the default device name. If set through this property, it will update only if the device is within the filtered selection."""
+        return self.config.default
+
+    @default.setter
+    def default(self, value: str):
+        if self.validate_device(value) is False:
+            return
+        self.config.default = value
+        WidgetIO.set_value(widget=self, value=value)
+
+    @Property(bool)
+    def apply_filter(self):
+        """Apply the filters on the devices."""
+        return self.config.apply_filter
+
+    @apply_filter.setter
+    def apply_filter(self, value: bool):
+        self.config.apply_filter = value
+        self.update_devices_from_filters()
+
+    @Property(bool)
+    def filter_to_device(self):
+        """Include devices in filters."""
+        return BECDeviceFilter.DEVICE in self.device_filter
+
+    @filter_to_device.setter
+    def filter_to_device(self, value: bool):
+        if value is True and BECDeviceFilter.DEVICE not in self.device_filter:
+            self._device_filter.append(BECDeviceFilter.DEVICE)
+        if value is False and BECDeviceFilter.DEVICE in self.device_filter:
+            self._device_filter.remove(BECDeviceFilter.DEVICE)
+        self.update_devices_from_filters()
+
+    @Property(bool)
+    def filter_to_positioner(self):
+        """Include devices of type Positioner in filters."""
+        return BECDeviceFilter.POSITIONER in self.device_filter
+
+    @filter_to_positioner.setter
+    def filter_to_positioner(self, value: bool):
+        if value is True and BECDeviceFilter.POSITIONER not in self.device_filter:
+            self._device_filter.append(BECDeviceFilter.POSITIONER)
+        if value is False and BECDeviceFilter.POSITIONER in self.device_filter:
+            self._device_filter.remove(BECDeviceFilter.POSITIONER)
+        self.update_devices_from_filters()
+
+    @Property(bool)
+    def filter_to_signal(self):
+        """Include devices of type Signal in filters."""
+        return BECDeviceFilter.SIGNAL in self.device_filter
+
+    @filter_to_signal.setter
+    def filter_to_signal(self, value: bool):
+        if value is True and BECDeviceFilter.SIGNAL not in self.device_filter:
+            self._device_filter.append(BECDeviceFilter.SIGNAL)
+        if value is False and BECDeviceFilter.SIGNAL in self.device_filter:
+            self._device_filter.remove(BECDeviceFilter.SIGNAL)
+        self.update_devices_from_filters()
+
+    @Property(bool)
+    def filter_to_computed_signal(self):
+        """Include devices of type ComputedSignal in filters."""
+        return BECDeviceFilter.COMPUTED_SIGNAL in self.device_filter
+
+    @filter_to_computed_signal.setter
+    def filter_to_computed_signal(self, value: bool):
+        if value is True and BECDeviceFilter.COMPUTED_SIGNAL not in self.device_filter:
+            self._device_filter.append(BECDeviceFilter.COMPUTED_SIGNAL)
+        if value is False and BECDeviceFilter.COMPUTED_SIGNAL in self.device_filter:
+            self._device_filter.remove(BECDeviceFilter.COMPUTED_SIGNAL)
+        self.update_devices_from_filters()
+
+    @Property(bool)
+    def readout_monitored(self):
+        """Include devices with readout priority Monitored in filters."""
+        return ReadoutPriority.MONITORED in self.readout_filter
+
+    @readout_monitored.setter
+    def readout_monitored(self, value: bool):
+        if value is True and ReadoutPriority.MONITORED not in self.readout_filter:
+            self._readout_filter.append(ReadoutPriority.MONITORED)
+        if value is False and ReadoutPriority.MONITORED in self.readout_filter:
+            self._readout_filter.remove(ReadoutPriority.MONITORED)
+        self.update_devices_from_filters()
+
+    @Property(bool)
+    def readout_baseline(self):
+        """Include devices with readout priority Baseline in filters."""
+        return ReadoutPriority.BASELINE in self.readout_filter
+
+    @readout_baseline.setter
+    def readout_baseline(self, value: bool):
+        if value is True and ReadoutPriority.BASELINE not in self.readout_filter:
+            self._readout_filter.append(ReadoutPriority.BASELINE)
+        if value is False and ReadoutPriority.BASELINE in self.readout_filter:
+            self._readout_filter.remove(ReadoutPriority.BASELINE)
+        self.update_devices_from_filters()
+
+    @Property(bool)
+    def readout_async(self):
+        """Include devices with readout priority Async in filters."""
+        return ReadoutPriority.ASYNC in self.readout_filter
+
+    @readout_async.setter
+    def readout_async(self, value: bool):
+        if value is True and ReadoutPriority.ASYNC not in self.readout_filter:
+            self._readout_filter.append(ReadoutPriority.ASYNC)
+        if value is False and ReadoutPriority.ASYNC in self.readout_filter:
+            self._readout_filter.remove(ReadoutPriority.ASYNC)
+        self.update_devices_from_filters()
+
+    @Property(bool)
+    def readout_continuous(self):
+        """Include devices with readout priority continuous in filters."""
+        return ReadoutPriority.CONTINUOUS in self.readout_filter
+
+    @readout_continuous.setter
+    def readout_continuous(self, value: bool):
+        if value is True and ReadoutPriority.CONTINUOUS not in self.readout_filter:
+            self._readout_filter.append(ReadoutPriority.CONTINUOUS)
+        if value is False and ReadoutPriority.CONTINUOUS in self.readout_filter:
+            self._readout_filter.remove(ReadoutPriority.CONTINUOUS)
+        self.update_devices_from_filters()
+
+    @Property(bool)
+    def readout_on_request(self):
+        """Include devices with readout priority OnRequest in filters."""
+        return ReadoutPriority.ON_REQUEST in self.readout_filter
+
+    @readout_on_request.setter
+    def readout_on_request(self, value: bool):
+        if value is True and ReadoutPriority.ON_REQUEST not in self.readout_filter:
+            self._readout_filter.append(ReadoutPriority.ON_REQUEST)
+        if value is False and ReadoutPriority.ON_REQUEST in self.readout_filter:
+            self._readout_filter.remove(ReadoutPriority.ON_REQUEST)
+        self.update_devices_from_filters()
+
+    ### Python Methods and Properties ###
+
+    @property
+    def device_filter(self) -> list[object]:
+        """Get the list of filters to apply on the devices."""
+        return self._device_filter
+
+    @property
+    def readout_filter(self) -> list[str]:
+        """Get the list of filters to apply on the devices"""
+        return self._readout_filter
+
+    def get_available_filters(self) -> list:
+        """Get the available filters."""
+        return [entry for entry in BECDeviceFilter]
+
+    def get_readout_priority_filters(self) -> list:
+        """Get the available readout priority filters."""
+        return [entry for entry in ReadoutPriority]
+
+    def set_device_filter(
+        self, filter_selection: str | BECDeviceFilter | list[str] | list[BECDeviceFilter]
+    ):
+        """
+        Set the device filter. If None is passed, no filters are applied and all devices included.
+
+        Args:
+            filter_selection (str | list[str]): Device filters. It is recommended to make an enum for the filters.
+        """
+        filters = None
+        if isinstance(filter_selection, list):
+            filters = [self._filter_handler.get(entry) for entry in filter_selection]
+        if isinstance(filter_selection, str) or isinstance(filter_selection, BECDeviceFilter):
+            filters = [self._filter_handler.get(filter_selection)]
+        if filters is None or any([entry is None for entry in filters]):
+            logger.warning(f"Device filter {filter_selection} is not in the device filter list.")
+            return
+        for entry in filters:
+            setattr(self, entry, True)
+
+    def set_readout_priority_filter(
+        self, filter_selection: str | ReadoutPriority | list[str] | list[ReadoutPriority]
+    ):
+        """
+        Set the readout priority filter. If None is passed, all filters are included.
+
+        Args:
+            filter_selection (str | list[str]): Readout priority filters.
+        """
+        filters = None
+        if isinstance(filter_selection, list):
+            filters = [self._filter_handler.get(entry) for entry in filter_selection]
+        if isinstance(filter_selection, str) or isinstance(filter_selection, ReadoutPriority):
+            filters = [self._filter_handler.get(filter_selection)]
+        if filters is None or any([entry is None for entry in filters]):
+            logger.warning(
+                f"Readout priority filter {filter_selection} is not in the readout priority list."
+            )
+            return
+        for entry in filters:
+            setattr(self, entry, True)
+
+    def _check_device_filter(
+        self, device: Device | BECSignal | ComputedSignal | Positioner
+    ) -> bool:
+        """Check if filter for device type is applied or not.
+
+        Args:
+            device(Device | Signal | ComputedSignal | Positioner): Device object.
+        """
+        return all(isinstance(device, self._device_handler[entry]) for entry in self.device_filter)
+
+    def _check_readout_filter(
+        self, device: Device | BECSignal | ComputedSignal | Positioner
+    ) -> bool:
+        """Check if filter for readout priority is applied or not.
+
+        Args:
+            device(Device | Signal | ComputedSignal | Positioner): Device object.
+        """
+        return device.readout_priority in self.readout_filter
+
+    def get_device_object(self, device: str) -> object:
+        """
+        Get the device object based on the device name.
+
+        Args:
+            device(str): Device name.
+
+        Returns:
+            object: Device object, can be device of type Device, Positioner, Signal or ComputedSignal.
+        """
+        self.validate_device(device)
+        dev = getattr(self.dev, device.lower(), None)
+        if dev is None:
+            raise ValueError(
+                f"Device {device} is not found in the device manager {self.dev} as enabled device."
+            )
+        return dev
+
+    def validate_device(self, device: str) -> bool:
+        """
+        Validate the device if it is present in the filtered device selection.
+
+        Args:
+            device(str): Device to validate.
+        """
+        all_devs = [dev.name for dev in self.dev.enabled_devices]
+        if device in self.devices and device in all_devs:
+            return True
+        return False

bec_widgets/widgets/base_classes/device_signal_input_base.py

@@ -0,0 +1,280 @@
+from bec_lib.callback_handler import EventType
+from bec_lib.device import Signal
+from bec_lib.logger import bec_logger
+from qtpy.QtCore import Property, Slot
+
+from bec_widgets.utils import ConnectionConfig
+from bec_widgets.utils.bec_widget import BECWidget
+from bec_widgets.utils.filter_io import FilterIO
+from bec_widgets.utils.ophyd_kind_util import Kind
+from bec_widgets.utils.widget_io import WidgetIO
+
+logger = bec_logger.logger
+
+
+class DeviceSignalInputBaseConfig(ConnectionConfig):
+    """Configuration class for DeviceSignalInputBase."""
+
+    signal_filter: str | list[str] | None = None
+    default: str | None = None
+    arg_name: str | None = None
+    device: str | None = None
+    signals: list[str] | None = None
+
+
+class DeviceSignalInputBase(BECWidget):
+    """
+    Mixin base class for device signal input widgets.
+    Mixin class for device signal input widgets. This class provides methods to get the device signal list and device
+    signal object based on the current text of the widget.
+    """
+
+    _filter_handler = {
+        Kind.hinted: "include_hinted_signals",
+        Kind.normal: "include_normal_signals",
+        Kind.config: "include_config_signals",
+    }
+
+    def __init__(self, client=None, config=None, gui_id: str = None):
+        if config is None:
+            config = DeviceSignalInputBaseConfig(widget_class=self.__class__.__name__)
+        else:
+            if isinstance(config, dict):
+                config = DeviceSignalInputBaseConfig(**config)
+            self.config = config
+        super().__init__(client=client, config=config, gui_id=gui_id)
+
+        self._device = None
+        self.get_bec_shortcuts()
+        self._signal_filter = []
+        self._signals = []
+        self._hinted_signals = []
+        self._normal_signals = []
+        self._config_signals = []
+        self.bec_dispatcher.client.callbacks.register(
+            EventType.DEVICE_UPDATE, self.update_signals_from_filters
+        )
+
+    ### Qt Slots ###
+
+    @Slot(str)
+    def set_signal(self, signal: str):
+        """
+        Set the signal.
+
+        Args:
+            signal (str): signal name.
+        """
+        if self.validate_signal(signal) is True:
+            WidgetIO.set_value(widget=self, value=signal)
+            self.config.default = signal
+        else:
+            logger.warning(
+                f"Signal {signal} not found for device {self.device} and filtered selection {self.signal_filter}."
+            )
+
+    @Slot(str)
+    def set_device(self, device: str | None):
+        """
+        Set the device. If device is not valid, device will be set to None which happpens
+
+        Args:
+            device(str): device name.
+        """
+        if self.validate_device(device) is False:
+            self._device = None
+        else:
+            self._device = device
+        self.update_signals_from_filters()
+
+    @Slot(dict, dict)
+    @Slot()
+    def update_signals_from_filters(
+        self, content: dict | None = None, metadata: dict | None = None
+    ):
+        """Update the filters for the device signals based on list in self.signal_filter.
+        In addition, store the hinted, normal and config signals in separate lists to allow
+        customisation within QLineEdit.
+
+        Note:
+        Signal and ComputedSignals have no signals. The naming convention follows the device name.
+        """
+        self.config.signal_filter = self.signal_filter
+        # pylint: disable=protected-access
+        self._hinted_signals = []
+        self._normal_signals = []
+        self._config_signals = []
+        if self.validate_device(self._device) is False:
+            self._device = None
+            self.config.device = self._device
+            return
+        device = self.get_device_object(self._device)
+        # See above convention for Signals and ComputedSignals
+        if isinstance(device, Signal):
+            self._signals = [self._device]
+            FilterIO.set_selection(widget=self, selection=[self._device])
+            return
+        device_info = device._info["signals"]
+        if Kind.hinted in self.signal_filter:
+            hinted_signals = [
+                signal
+                for signal, signal_info in device_info.items()
+                if (signal_info.get("kind_str", None) == str(Kind.hinted.value))
+            ]
+            self._hinted_signals = hinted_signals
+        if Kind.normal in self.signal_filter:
+            normal_signals = [
+                signal
+                for signal, signal_info in device_info.items()
+                if (signal_info.get("kind_str", None) == str(Kind.normal.value))
+            ]
+            self._normal_signals = normal_signals
+        if Kind.config in self.signal_filter:
+            config_signals = [
+                signal
+                for signal, signal_info in device_info.items()
+                if (signal_info.get("kind_str", None) == str(Kind.config.value))
+            ]
+            self._config_signals = config_signals
+        self._signals = self._hinted_signals + self._normal_signals + self._config_signals
+        FilterIO.set_selection(widget=self, selection=self.signals)
+
+    ### Qt Properties ###
+
+    @Property(str)
+    def device(self) -> str:
+        """Get the selected device."""
+        if self._device is None:
+            return ""
+        return self._device
+
+    @device.setter
+    def device(self, value: str):
+        """Set the device and update the filters, only allow devices present in the devicemanager."""
+        self._device = value
+        self.config.device = value
+        self.update_signals_from_filters()
+
+    @Property(bool)
+    def include_hinted_signals(self):
+        """Include hinted signals in filters."""
+        return Kind.hinted in self.signal_filter
+
+    @include_hinted_signals.setter
+    def include_hinted_signals(self, value: bool):
+        if value:
+            self._signal_filter.append(Kind.hinted)
+        else:
+            self._signal_filter.remove(Kind.hinted)
+        self.update_signals_from_filters()
+
+    @Property(bool)
+    def include_normal_signals(self):
+        """Include normal signals in filters."""
+        return Kind.normal in self.signal_filter
+
+    @include_normal_signals.setter
+    def include_normal_signals(self, value: bool):
+        if value:
+            self._signal_filter.append(Kind.normal)
+        else:
+            self._signal_filter.remove(Kind.normal)
+        self.update_signals_from_filters()
+
+    @Property(bool)
+    def include_config_signals(self):
+        """Include config signals in filters."""
+        return Kind.config in self.signal_filter
+
+    @include_config_signals.setter
+    def include_config_signals(self, value: bool):
+        if value:
+            self._signal_filter.append(Kind.config)
+        else:
+            self._signal_filter.remove(Kind.config)
+        self.update_signals_from_filters()
+
+    ### Properties and Methods ###
+
+    @property
+    def signals(self) -> list[str]:
+        """
+        Get the list of device signals for the applied filters.
+
+        Returns:
+            list[str]: List of device signals.
+        """
+        return self._signals
+
+    @signals.setter
+    def signals(self, value: list[str]):
+        self._signals = value
+        self.config.signals = value
+        FilterIO.set_selection(widget=self, selection=value)
+
+    @property
+    def signal_filter(self) -> list[str]:
+        """Get the list of filters to apply on the device signals."""
+        return self._signal_filter
+
+    def get_available_filters(self) -> list[str]:
+        """Get the available filters."""
+        return [entry for entry in self._filter_handler]
+
+    def set_filter(self, filter_selection: str | list[str]):
+        """
+        Set the device filter. If None, all devices are included.
+
+        Args:
+            filter_selection (str | list[str]): Device filters from BECDeviceFilter and BECReadoutPriority.
+        """
+        filters = None
+        if isinstance(filter_selection, list):
+            filters = [self._filter_handler.get(entry) for entry in filter_selection]
+        if isinstance(filter_selection, str):
+            filters = [self._filter_handler.get(filter_selection)]
+        if filters is None:
+            return
+        for entry in filters:
+            setattr(self, entry, True)
+
+    def get_device_object(self, device: str) -> object | None:
+        """
+        Get the device object based on the device name.
+
+        Args:
+            device(str): Device name.
+
+        Returns:
+            object: Device object, can be device of type Device, Positioner, Signal or ComputedSignal.
+        """
+        self.validate_device(device)
+        dev = getattr(self.dev, device.lower(), None)
+        if dev is None:
+            logger.warning(f"Device {device} not found in devicemanager.")
+            return None
+        return dev
+
+    def validate_device(self, device: str | None, raise_on_false: bool = False) -> bool:
+        """
+        Validate the device if it is present in current BEC instance.
+
+        Args:
+            device(str): Device to validate.
+        """
+        if device in self.dev:
+            return True
+        if raise_on_false is True:
+            raise ValueError(f"Device {device} not found in devicemanager.")
+        return False
+
+    def validate_signal(self, signal: str) -> bool:
+        """
+        Validate the signal if it is present in the device signals.
+
+        Args:
+            signal(str): Signal to validate.
+        """
+        if signal in self.signals:
+            return True
+        return False

bec_widgets/widgets/bec_progressbar/bec_progress_bar.pyproject

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

bec_widgets/widgets/bec_progressbar/bec_progress_bar_plugin.py

@@ -0,0 +1,54 @@
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+
+from qtpy.QtDesigner import QDesignerCustomWidgetInterface
+
+from bec_widgets.utils.bec_designer import designer_material_icon
+from bec_widgets.widgets.bec_progressbar.bec_progressbar import BECProgressBar
+
+DOM_XML = """
+<ui language='c++'>
+    <widget class='BECProgressBar' name='bec_progress_bar'>
+    </widget>
+</ui>
+"""
+
+
+class BECProgressBarPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self._form_editor = None
+
+    def createWidget(self, parent):
+        t = BECProgressBar(parent)
+        return t
+
+    def domXml(self):
+        return DOM_XML
+
+    def group(self):
+        return "BEC Utils"
+
+    def icon(self):
+        return designer_material_icon(BECProgressBar.ICON_NAME)
+
+    def includeFile(self):
+        return "bec_progress_bar"
+
+    def initialize(self, form_editor):
+        self._form_editor = form_editor
+
+    def isContainer(self):
+        return False
+
+    def isInitialized(self):
+        return self._form_editor is not None
+
+    def name(self):
+        return "BECProgressBar"
+
+    def toolTip(self):
+        return "A custom progress bar with smooth transitions and a modern design."
+
+    def whatsThis(self):
+        return self.toolTip()

bec_widgets/widgets/bec_progressbar/bec_progressbar.py

@@ -0,0 +1,258 @@
+import sys
+from string import Template
+
+from qtpy.QtCore import Property, QEasingCurve, QPropertyAnimation, QRectF, Qt, QTimer, Slot
+from qtpy.QtGui import QColor, QPainter, QPainterPath
+from qtpy.QtWidgets import QApplication, QLabel, QVBoxLayout, QWidget
+
+from bec_widgets.utils.bec_widget import BECWidget
+from bec_widgets.utils.colors import get_accent_colors
+
+
+class BECProgressBar(BECWidget, QWidget):
+    """
+    A custom progress bar with smooth transitions. The displayed text can be customized using a template.
+    """
+
+    USER_ACCESS = [
+        "set_value",
+        "set_maximum",
+        "set_minimum",
+        "label_template",
+        "label_template.setter",
+    ]
+    ICON_NAME = "page_control"
+
+    def __init__(self, parent=None, client=None, config=None, gui_id=None):
+        super().__init__(client=client, config=config, gui_id=gui_id)
+        QWidget.__init__(self, parent=parent)
+
+        accent_colors = get_accent_colors()
+
+        # internal values
+        self._oversampling_factor = 50
+        self._value = 0
+        self._target_value = 0
+        self._maximum = 100 * self._oversampling_factor
+
+        # User values
+        self._user_value = 0
+        self._user_minimum = 0
+        self._user_maximum = 100
+        self._label_template = "$value / $maximum - $percentage %"
+
+        # Color settings
+        self._background_color = QColor(30, 30, 30)
+        self._progress_color = accent_colors.highlight  # QColor(210, 55, 130)
+
+        self._completed_color = accent_colors.success
+        self._border_color = QColor(50, 50, 50)
+
+        # layout settings
+        self._value_animation = QPropertyAnimation(self, b"_progressbar_value")
+        self._value_animation.setDuration(200)
+        self._value_animation.setEasingCurve(QEasingCurve.Type.OutCubic)
+
+        # label on top of the progress bar
+        self.center_label = QLabel(self)
+        self.center_label.setAlignment(Qt.AlignCenter)
+        self.center_label.setStyleSheet("color: white;")
+        self.center_label.setMinimumSize(0, 0)
+
+        layout = QVBoxLayout(self)
+        layout.setContentsMargins(0, 0, 0, 0)
+        layout.setSpacing(0)
+        layout.addWidget(self.center_label)
+        self.setLayout(layout)
+
+        self.update()
+
+    @Property(str, doc="The template for the center label. Use $value, $maximum, and $percentage.")
+    def label_template(self):
+        """
+        The template for the center label. Use $value, $maximum, and $percentage to insert the values.
+
+        Examples:
+        >>> progressbar.label_template = "$value / $maximum - $percentage %"
+        >>> progressbar.label_template = "$value / $percentage %"
+
+        """
+        return self._label_template
+
+    @label_template.setter
+    def label_template(self, template):
+        self._label_template = template
+        self.set_value(self._user_value)
+        self.update()
+
+    @Property(float, designable=False)
+    def _progressbar_value(self):
+        """
+        The current value of the progress bar.
+        """
+        return self._value
+
+    @_progressbar_value.setter
+    def _progressbar_value(self, val):
+        self._value = val
+        self.update()
+
+    def _update_template(self):
+        template = Template(self._label_template)
+        return template.safe_substitute(
+            value=self._user_value,
+            maximum=self._user_maximum,
+            percentage=int((self.map_value(self._user_value) / self._maximum) * 100),
+        )
+
+    @Slot(float)
+    @Slot(int)
+    def set_value(self, value):
+        """
+        Set the value of the progress bar.
+
+        Args:
+            value (float): The value to set.
+        """
+        if value > self._user_maximum:
+            value = self._user_maximum
+        elif value < self._user_minimum:
+            value = self._user_minimum
+        self._target_value = self.map_value(value)
+        self._user_value = value
+        self.center_label.setText(self._update_template())
+        self.animate_progress()
+
+    def paintEvent(self, event):
+        painter = QPainter(self)
+        painter.setRenderHint(QPainter.Antialiasing)
+        rect = self.rect().adjusted(10, 0, -10, -1)
+
+        # Draw background
+        painter.setBrush(self._background_color)
+        painter.setPen(Qt.NoPen)
+        painter.drawRoundedRect(rect, 10, 10)  # Rounded corners
+
+        # Draw border
+        painter.setBrush(Qt.NoBrush)
+        painter.setPen(self._border_color)
+        painter.drawRoundedRect(rect, 10, 10)
+
+        # Determine progress color based on completion
+        if self._value >= self._maximum:
+            current_color = self._completed_color
+        else:
+            current_color = self._progress_color
+
+        # Set clipping region to preserve the background's rounded corners
+        progress_rect = rect.adjusted(
+            0, 0, int(-rect.width() + (self._value / self._maximum) * rect.width()), 0
+        )
+        clip_path = QPainterPath()
+        clip_path.addRoundedRect(QRectF(rect), 10, 10)  # Clip to the background's rounded corners
+        painter.setClipPath(clip_path)
+
+        # Draw progress bar
+        painter.setBrush(current_color)
+        painter.drawRect(progress_rect)  # Less rounded, no additional rounding
+
+        painter.end()
+
+    def animate_progress(self):
+        """
+        Animate the progress bar from the current value to the target value.
+        """
+        self._value_animation.stop()
+        self._value_animation.setStartValue(self._value)
+        self._value_animation.setEndValue(self._target_value)
+        self._value_animation.start()
+
+    @Property(float)
+    def maximum(self):
+        """
+        The maximum value of the progress bar.
+        """
+        return self._user_maximum
+
+    @maximum.setter
+    def maximum(self, maximum: float):
+        """
+        Set the maximum value of the progress bar.
+        """
+        self.set_maximum(maximum)
+
+    @Property(float)
+    def minimum(self):
+        """
+        The minimum value of the progress bar.
+        """
+        return self._user_minimum
+
+    @minimum.setter
+    def minimum(self, minimum: float):
+        self.set_minimum(minimum)
+
+    @Property(float)
+    def initial_value(self):
+        """
+        The initial value of the progress bar.
+        """
+        return self._user_value
+
+    @initial_value.setter
+    def initial_value(self, value: float):
+        self.set_value(value)
+
+    @Slot(float)
+    def set_maximum(self, maximum: float):
+        """
+        Set the maximum value of the progress bar.
+
+        Args:
+            maximum (float): The maximum value.
+        """
+        self._user_maximum = maximum
+        self.set_value(self._user_value)  # Update the value to fit the new range
+        self.update()
+
+    @Slot(float)
+    def set_minimum(self, minimum: float):
+        """
+        Set the minimum value of the progress bar.
+
+        Args:
+            minimum (float): The minimum value.
+        """
+        self._user_minimum = minimum
+        self.set_value(self._user_value)  # Update the value to fit the new range
+        self.update()
+
+    def map_value(self, value: float):
+        """
+        Map the user value to the range [0, 100*self._oversampling_factor] for the progress
+        """
+        return (
+            (value - self._user_minimum) / (self._user_maximum - self._user_minimum) * self._maximum
+        )
+
+
+if __name__ == "__main__":  # pragma: no cover
+    app = QApplication(sys.argv)
+
+    progressBar = BECProgressBar()
+    progressBar.show()
+    progressBar.set_minimum(-100)
+    progressBar.set_maximum(0)
+
+    # Example of setting values
+    def update_progress():
+        value = progressBar._user_value + 2.5
+        if value > progressBar._user_maximum:
+            value = -100  # progressBar._maximum / progressBar._upsampling_factor
+        progressBar.set_value(value)
+
+    timer = QTimer()
+    timer.timeout.connect(update_progress)
+    timer.start(200)  # Update every half second
+
+    sys.exit(app.exec())

bec_widgets/widgets/bec_progressbar/register_bec_progress_bar.py

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

bec_widgets/widgets/bec_queue/bec_queue.py

@@ -1,30 +1,123 @@
+from __future__ import annotations
+
 from bec_lib.endpoints import MessageEndpoints
-from qtpy.QtCore import Qt, Slot
-from qtpy.QtWidgets import QHeaderView, QTableWidget, QTableWidgetItem, QWidget
+from bec_qthemes import material_icon
+from qtpy.QtCore import Property, Qt, Signal, Slot
+from qtpy.QtGui import QColor
+from qtpy.QtWidgets import QHeaderView, QLabel, QTableWidget, QTableWidgetItem, QVBoxLayout, QWidget
 
-from bec_widgets.utils.bec_connector import BECConnector, ConnectionConfig
+from bec_widgets.qt_utils.compact_popup import CompactPopupWidget
+from bec_widgets.qt_utils.toolbar import ModularToolBar, SeparatorAction, WidgetAction
+from bec_widgets.utils.bec_connector import ConnectionConfig
+from bec_widgets.utils.bec_widget import BECWidget
+from bec_widgets.widgets.button_abort.button_abort import AbortButton
+from bec_widgets.widgets.button_reset.button_reset import ResetButton
+from bec_widgets.widgets.button_resume.button_resume import ResumeButton
+from bec_widgets.widgets.stop_button.stop_button import StopButton
 
 
-class BECQueue(BECConnector, QTableWidget):
+class BECQueue(BECWidget, CompactPopupWidget):
     """
     Widget to display the BEC queue.
     """
 
+    ICON_NAME = "edit_note"
+    status_colors = {
+        "STOPPED": "red",
+        "PENDING": "orange",
+        "IDLE": "gray",
+        "PAUSED": "yellow",
+        "DEFERRED_PAUSE": "lightyellow",
+        "RUNNING": "green",
+        "COMPLETED": "blue",
+    }
+
+    queue_busy = Signal(bool)
+
     def __init__(
         self,
         parent: QWidget | None = None,
         client=None,
         config: ConnectionConfig = None,
         gui_id: str = None,
+        refresh_upon_start: bool = True,
     ):
         super().__init__(client, config, gui_id)
-        QTableWidget.__init__(self, parent=parent)
-        self.setColumnCount(3)
-        self.setHorizontalHeaderLabels(["Scan Number", "Type", "Status"])
-        header = self.horizontalHeader()
+        CompactPopupWidget.__init__(self, parent=parent, layout=QVBoxLayout)
+        self.layout.setSpacing(0)
+        self.layout.setContentsMargins(0, 0, 0, 0)
+
+        # Set up the toolbar
+        self.set_toolbar()
+        # Set up the table
+        self.table = QTableWidget(self)
+        # self.layout.addWidget(self.table)
+        self.table.setColumnCount(4)
+        self.table.setHorizontalHeaderLabels(["Scan Number", "Type", "Status", "Cancel"])
+        header = self.table.horizontalHeader()
         header.setSectionResizeMode(QHeaderView.Stretch)
+
+        self.addWidget(self.table)
+        self.label = "BEC Queue"
+        self.tooltip = "BEC Queue status"
+
         self.bec_dispatcher.connect_slot(self.update_queue, MessageEndpoints.scan_queue_status())
         self.reset_content()
+        if refresh_upon_start:
+            self.refresh_queue()
+
+    def set_toolbar(self):
+        """
+        Set the toolbar.
+        """
+        widget_label = QLabel("Live Queue")
+        widget_label.setStyleSheet("font-weight: bold;")
+        self.toolbar = ModularToolBar(
+            actions={
+                "widget_label": WidgetAction(widget=widget_label),
+                "separator_1": SeparatorAction(),
+                "resume": WidgetAction(widget=ResumeButton(toolbar=False)),
+                "stop": WidgetAction(widget=StopButton(toolbar=False)),
+                "reset": WidgetAction(widget=ResetButton(toolbar=False)),
+            },
+            target_widget=self,
+        )
+
+        self.addWidget(self.toolbar)
+
+    @Property(bool)
+    def hide_toolbar(self):
+        """Property to hide the BEC Queue toolbar."""
+        return not self.toolbar.isVisible()
+
+    @hide_toolbar.setter
+    def hide_toolbar(self, hide: bool):
+        """
+        Setters for the hide_toolbar property.
+
+        Args:
+            hide(bool): Whether to hide the toolbar.
+        """
+        self._hide_toolbar(hide)
+
+    def _hide_toolbar(self, hide: bool):
+        """
+        Hide the toolbar.
+
+        Args:
+            hide(bool): Whether to hide the toolbar.
+        """
+        self.toolbar.setVisible(not hide)
+
+    def refresh_queue(self):
+        """
+        Refresh the queue.
+        """
+        msg = self.client.connector.get(MessageEndpoints.scan_queue_status())
+        if msg is None:
+            # msg is None if no scan has been run yet (fresh start)
+            return
+        self.update_queue(msg.content, msg.metadata)
 
     @Slot(dict, dict)
     def update_queue(self, content, _metadata):
@@ -37,8 +130,8 @@ class BECQueue(BECConnector, QTableWidget):
         """
         # only show the primary queue for now
         queue_info = content.get("queue", {}).get("primary", {}).get("info", [])
-        self.setRowCount(len(queue_info))
-        self.clearContents()
+        self.table.setRowCount(len(queue_info))
+        self.table.clearContents()
 
         if not queue_info:
             self.reset_content()
@@ -48,6 +141,7 @@ class BECQueue(BECConnector, QTableWidget):
             blocks = item.get("request_blocks", [])
             scan_types = []
             scan_numbers = []
+            scan_ids = []
             status = item.get("status", "")
             for request_block in blocks:
                 scan_type = request_block.get("content", {}).get("scan_type", "")
@@ -56,13 +150,25 @@ class BECQueue(BECConnector, QTableWidget):
                 scan_number = request_block.get("scan_number", "")
                 if scan_number:
                     scan_numbers.append(str(scan_number))
+                scan_id = request_block.get("scan_id", "")
+                if scan_id:
+                    scan_ids.append(scan_id)
             if scan_types:
                 scan_types = ", ".join(scan_types)
             if scan_numbers:
                 scan_numbers = ", ".join(scan_numbers)
-            self.set_row(index, scan_numbers, scan_types, status)
+            if scan_ids:
+                scan_ids = ", ".join(scan_ids)
+            self.set_row(index, scan_numbers, scan_types, status, scan_ids)
+        busy = (
+            False
+            if all(item.get("status") in ("STOPPED", "COMPLETED", "IDLE") for item in queue_info)
+            else True
+        )
+        self.set_global_state("warning" if busy else "default")
+        self.queue_busy.emit(busy)
 
-    def format_item(self, content: str) -> QTableWidgetItem:
+    def format_item(self, content: str, status=False) -> QTableWidgetItem:
         """
         Format the content of the table item.
 
@@ -72,11 +178,21 @@ class BECQueue(BECConnector, QTableWidget):
         Returns:
             QTableWidgetItem: The formatted item.
         """
+        if not content or not isinstance(content, str):
+            content = ""
         item = QTableWidgetItem(content)
         item.setTextAlignment(Qt.AlignHCenter | Qt.AlignVCenter)
+        # item.setFlags(item.flags() & ~Qt.ItemFlag.ItemIsEditable)
+
+        if status:
+            try:
+                color = self.status_colors.get(content, "black")  # Default to black if not found
+                item.setForeground(QColor(color))
+            except:
+                return item
         return item
 
-    def set_row(self, index: int, scan_number: str, scan_type: str, status: str):
+    def set_row(self, index: int, scan_number: str, scan_type: str, status: str, scan_id: str):
         """
         Set the row of the table.
 
@@ -86,18 +202,50 @@ class BECQueue(BECConnector, QTableWidget):
             scan_type (str): The scan type.
             status (str): The status.
         """
+        abort_button = self._create_abort_button(scan_id)
+        abort_button.button.clicked.connect(self.delete_selected_row)
 
-        self.setItem(index, 0, self.format_item(scan_number))
-        self.setItem(index, 1, self.format_item(scan_type))
-        self.setItem(index, 2, self.format_item(status))
+        self.table.setItem(index, 0, self.format_item(scan_number))
+        self.table.setItem(index, 1, self.format_item(scan_type))
+        self.table.setItem(index, 2, self.format_item(status, status=True))
+        self.table.setCellWidget(index, 3, abort_button)
+
+    def _create_abort_button(self, scan_id: str) -> AbortButton:
+        """
+        Create an abort button with styling for BEC Queue widget for certain scan_id.
+
+        Args:
+            scan_id(str): The scan id to abort.
+
+        Returns:
+            AbortButton: The abort button.
+        """
+        abort_button = AbortButton(scan_id=scan_id)
+
+        abort_button.button.setText("")
+        abort_button.button.setIcon(
+            material_icon("cancel", color="#cc181e", filled=True, convert_to_pixmap=False)
+        )
+        abort_button.button.setStyleSheet("background-color:  rgba(0,0,0,0) ")
+        abort_button.button.setFlat(True)
+
+        return abort_button
+
+    def delete_selected_row(self):
+
+        button = self.sender()
+        row = self.table.indexAt(button.pos()).row()
+        self.table.removeRow(row)
+
+        button.deleteLater()
 
     def reset_content(self):
         """
         Reset the content of the table.
         """
 
-        self.setRowCount(1)
-        self.set_row(0, "", "", "")
+        self.table.setRowCount(1)
+        self.set_row(0, "", "", "", "")
 
 
 if __name__ == "__main__":  # pragma: no cover

bec_widgets/widgets/bec_queue/bec_queue_plugin.py

@@ -1,9 +1,11 @@
 # Copyright (C) 2022 The Qt Company Ltd.
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+import os
 
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QIcon
 
+import bec_widgets
+from bec_widgets.utils.bec_designer import designer_material_icon
 from bec_widgets.widgets.bec_queue.bec_queue import BECQueue
 
 DOM_XML = """
@@ -13,6 +15,8 @@ DOM_XML = """
 </ui>
 """
 
+MODULE_PATH = os.path.dirname(bec_widgets.__file__)
+
 
 class BECQueuePlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
     def __init__(self):
@@ -27,10 +31,10 @@ class BECQueuePlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return DOM_XML
 
     def group(self):
-        return ""
+        return "BEC Services"
 
     def icon(self):
-        return QIcon()
+        return designer_material_icon(BECQueue.ICON_NAME)
 
     def includeFile(self):
         return "bec_queue"

bec_widgets/widgets/bec_status_box/bec_status_box.py

@@ -5,15 +5,16 @@ The widget automatically updates the status of all running BEC services, and dis
 from __future__ import annotations
 
 import sys
+from collections import defaultdict
+from dataclasses import dataclass
 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
+from qtpy.QtWidgets import QHBoxLayout, QTreeWidget, QTreeWidgetItem, QWidget
 
-from bec_widgets.utils.bec_connector import BECConnector, ConnectionConfig
+from bec_widgets.qt_utils.compact_popup import CompactPopupWidget
+from bec_widgets.utils.bec_widget import BECWidget
 from bec_widgets.widgets.bec_status_box.status_item import StatusItem
 
 if TYPE_CHECKING:
@@ -23,45 +24,18 @@ if TYPE_CHECKING:
 BECStatus = lazy_import_from("bec_lib.messages", ("BECStatus",))
 
 
-class BECStatusBoxConfig(ConnectionConfig):
-    pass
-
-
-class BECServiceInfoContainer(BaseModel):
+@dataclass
+class BECServiceInfoContainer:
     """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.",
-    )
+    status: str
     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.
+    """Mixin to receive the latest service status from the BEC server and emit it via services_update signal.
 
     Args:
         client (BECClient): The client object to connect to the BEC server.
@@ -69,29 +43,33 @@ class BECServiceStatusMixin(QObject):
 
     services_update = Signal(dict, dict)
 
-    def __init__(self, client: BECClient):
-        super().__init__()
+    ICON_NAME = "dns"
+
+    def __init__(self, parent, client: BECClient):
+        super().__init__(parent)
         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."""
+        """Get the latest service status from the BEC server."""
         # pylint: disable=protected-access
         self.client._update_existing_services()
         self.services_update.emit(self.client._services_info, self.client._services_metric)
 
+    def cleanup(self):
+        """Cleanup the BECServiceStatusMixin."""
+        self._service_update_timer.stop()
+        self._service_update_timer.deleteLater()
 
-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.
+
+class BECStatusBox(BECWidget, CompactPopupWidget):
+    """An autonomous widget to display the status of BEC services.
 
     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".
+        box_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.
@@ -99,58 +77,68 @@ class BECStatusBox(BECConnector, QTreeWidget):
 
     CORE_SERVICES = ["DeviceServer", "ScanServer", "SciHub", "ScanBundler", "FileWriterManager"]
 
-    service_update = Signal(dict)
+    service_update = Signal(BECServiceInfoContainer)
     bec_core_state = Signal(str)
 
     def __init__(
         self,
         parent=None,
-        service_name: str = "BEC Server",
+        box_name: str = "BEC Servers",
         client: BECClient = None,
-        config: BECStatusBoxConfig | dict = None,
         bec_service_status_mixin: BECServiceStatusMixin = 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)
+        super().__init__(client=client, gui_id=gui_id)
+        CompactPopupWidget.__init__(self, parent=parent, layout=QHBoxLayout)
 
-        self.service_name = service_name
-        self.config = config
-
-        self.bec_service_info_container = {}
-        self.tree_items = {}
-        self.tree_top_item = None
+        self.box_name = box_name
+        self.status_container = defaultdict(lambda: {"info": None, "item": None, "widget": None})
 
         if not bec_service_status_mixin:
-            bec_service_status_mixin = BECServiceStatusMixin(client=self.client)
+            bec_service_status_mixin = BECServiceStatusMixin(self, client=self.client)
         self.bec_service_status = bec_service_status_mixin
 
+        self.label = box_name
+        self.tooltip = "BEC servers health status"
         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)
+        self.tree.itemDoubleClicked.connect(self.on_tree_item_double_clicked)
+        self.addWidget(self.tree)
 
     def init_ui(self) -> None:
-        """Initialize the UI for the status box, and add QTreeWidget as the basis for the status box."""
+        """Init the UI for the BECStatusBox widget, should only take place once."""
         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)
+        top_label = self._create_status_widget(self.box_name, status=BECStatus.IDLE)
+        tree_item = QTreeWidgetItem()
+        tree_item.setExpanded(True)
+        tree_item.setDisabled(True)
+        self.status_container[self.box_name].update({"item": tree_item, "widget": top_label})
+        self.tree.addTopLevelItem(tree_item)
+        self.tree.setItemWidget(tree_item, 0, top_label)
         self.service_update.connect(top_label.update_config)
+        self._initialized = True
+
+    def init_ui_tree_widget(self) -> None:
+        """Initialise the tree widget for the status box."""
+        self.tree = QTreeWidget(self)
+        self.tree.setHeaderHidden(True)
+        # TODO probably here is a problem still with setting the stylesheet
+        self.tree.setStyleSheet(
+            "QTreeWidget::item:!selected "
+            "{ "
+            "border: 1px solid gainsboro; "
+            "border-left: none; "
+            "border-top: none; "
+            "}"
+            "QTreeWidget::item:selected {}"
+        )
 
     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.
+        information about the service in the status_container.
 
         Args:
             service_name (str): The name of the service.
@@ -163,16 +151,8 @@ class BECStatusBox(BECConnector, QTreeWidget):
         """
         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,
-            },
-        )
+        self._update_status_container(service_name, status, info, metrics)
+        item = StatusItem(parent=self, config=self.status_container[service_name]["info"])
         return item
 
     @Slot(str)
@@ -183,30 +163,36 @@ class BECStatusBox(BECConnector, QTreeWidget):
         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())
+        self.status_container[self.box_name]["info"].status = status
+        self.set_global_state("emergency" if status == "NOTCONNECTED" else "success")
+        self.service_update.emit(self.status_container[self.box_name]["info"])
 
-    def _update_bec_service_container(
+    def _update_status_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.
+        """Update the status_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.
+            status (BECStatus): The status of the service.
+            info (dict): The information about the service.
+            metrics (dict): The metrics of the service.
         """
-        container = self.bec_service_info_container.get(service_name, None)
+        container = self.status_container[service_name].get("info", None)
+
         if container:
-            container.status = status
+            container.status = status.name
             container.info = info
             container.metrics = metrics
             return
         service_info_item = BECServiceInfoContainer(
-            service_name=service_name, status=status, info=info, metrics=metrics
+            service_name=service_name,
+            status=status.name if isinstance(status, BECStatus) else status,
+            info=info,
+            metrics=metrics,
         )
-        self.bec_service_info_container.update({service_name: service_info_item})
+        self.status_container[service_name].update({"info": service_info_item})
 
     @Slot(dict, dict)
     def update_service_status(self, services_info: dict, services_metric: dict) -> None:
@@ -217,7 +203,7 @@ class BECStatusBox(BECConnector, QTreeWidget):
             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 = []
+        checked = [self.box_name]
         services_info = self.update_core_services(services_info, services_metric)
         checked.extend(self.CORE_SERVICES)
 
@@ -225,28 +211,19 @@ class BECStatusBox(BECConnector, QTreeWidget):
             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())
+            if service_name in self.status_container:
+                if not msg:
+                    self.add_tree_item(service_name, "NOTCONNECTED", {}, metrics)
+                    continue
+                self._update_status_container(service_name, msg.status, msg.info, metrics)
+                self.service_update.emit(self.status_container[service_name]["info"])
                 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.add_tree_item(service_name, msg.status, msg.info, metrics)
         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
+        """Update the core services of BEC, and emit the updated status to the BECStatusBox.
 
         Args:
             services_info (dict): A dictionary containing the service status of different services.
@@ -255,28 +232,28 @@ class BECStatusBox(BECConnector, QTreeWidget):
         Returns:
             dict: The services_info dictionary after removing the info updates related to the CORE_SERVICES
         """
-        bec_core_state = "RUNNING"
+        core_state = BECStatus.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())
+            msg = services_info.pop(service_name, None)
+            if service_name not in self.status_container:
+                if not msg:
+                    self.add_tree_item(service_name, "NOTCONNECTED", {}, metrics)
+                    continue
+                self.add_tree_item(service_name, msg.status, msg.info, metrics)
                 continue
-            self.add_tree_item(service_name, msg.status, msg.info, metrics)
+            if not msg:
+                self.status_container[service_name]["info"].status = "NOTCONNECTED"
+                core_state = None
+            else:
+                self._update_status_container(service_name, msg.status, msg.info, metrics)
+                if core_state:
+                    core_state = msg.status if msg.status.value < core_state.value else core_state
 
-        self.bec_core_state.emit(bec_core_state)
+            self.service_update.emit(self.status_container[service_name]["info"])
+
+        self.bec_core_state.emit(core_state.name if core_state else "NOTCONNECTED")
         return services_info
 
     def check_redundant_tree_items(self, checked: list) -> None:
@@ -285,11 +262,12 @@ class BECStatusBox(BECConnector, QTreeWidget):
         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]
+        to_be_deleted = [key for key in self.status_container if key not in checked]
 
         for key in to_be_deleted:
-            item, _ = self.tree_items.pop(key)
-            self.tree_top_item.removeChild(item)
+            obj = self.status_container.pop(key)
+            item = obj["item"]
+            self.status_container[self.box_name]["item"].removeChild(item)
 
     def add_tree_item(
         self, service_name: str, status: BECStatus, info: dict = None, metrics: dict = None
@@ -298,30 +276,16 @@ class BECStatusBox(BECConnector, QTreeWidget):
 
         Args:
             service_name (str): The name of the service.
-            service_status_msg (StatusMessage): The status of the service.
+            status (BECStatus): The status of the service.
+            info (dict): The information about 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_widget = self._create_status_widget(service_name, status, info, 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 {}"
-        )
+        self.status_container[self.box_name]["item"].addChild(item)
+        self.tree.setItemWidget(item, 0, item_widget)
+        self.status_container[service_name].update({"item": item, "widget": item_widget})
 
     @Slot(QTreeWidgetItem, int)
     def on_tree_item_double_clicked(self, item: QTreeWidgetItem, column: int) -> None:
@@ -331,26 +295,25 @@ class BECStatusBox(BECConnector, QTreeWidget):
             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()
+        for _, objects in self.status_container.items():
+            if objects["item"] == item:
+                objects["widget"].show_popup()
 
-    def closeEvent(self, event):
-        super().cleanup()
-        QTreeWidget().closeEvent(event)
+    def cleanup(self):
+        """Cleanup the BECStatusBox widget."""
+        self.bec_service_status.cleanup()
+        return super().cleanup()
 
 
-def main():
-    """Main method to run the BECStatusBox widget."""
-    # pylint: disable=import-outside-toplevel
+if __name__ == "__main__":  # pragma: no cover
+    import sys
+
     from qtpy.QtWidgets import QApplication
 
+    from bec_widgets.utils.colors import set_theme
+
     app = QApplication(sys.argv)
-    qdarktheme.setup_theme("auto")
+    set_theme("dark")
     main_window = BECStatusBox()
     main_window.show()
     sys.exit(app.exec())
-
-
-if __name__ == "__main__":
-    main()

bec_widgets/widgets/bec_status_box/bec_status_box.pyproject

@@ -1,4 +1 @@
-{
-    "files": ["bec_status_box.py", "status_item.py",
-    ]
-}
+{'files': ['bec_status_box.py']}

bec_widgets/widgets/bec_status_box/bec_status_box_plugin.py

@@ -1,9 +1,11 @@
 # Copyright (C) 2022 The Qt Company Ltd.
 # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+import os
 
 from qtpy.QtDesigner import QDesignerCustomWidgetInterface
-from qtpy.QtGui import QIcon
 
+import bec_widgets
+from bec_widgets.utils.bec_designer import designer_material_icon
 from bec_widgets.widgets.bec_status_box.bec_status_box import BECStatusBox
 
 DOM_XML = """
@@ -13,6 +15,8 @@ DOM_XML = """
 </ui>
 """
 
+MODULE_PATH = os.path.dirname(bec_widgets.__file__)
+
 
 class BECStatusBoxPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
     def __init__(self):
@@ -27,10 +31,10 @@ class BECStatusBoxPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return DOM_XML
 
     def group(self):
-        return ""
+        return "BEC Services"
 
     def icon(self):
-        return QIcon()
+        return designer_material_icon(BECStatusBox.ICON_NAME)
 
     def includeFile(self):
         return "bec_status_box"
@@ -48,7 +52,7 @@ class BECStatusBoxPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
         return "BECStatusBox"
 
     def toolTip(self):
-        return "BECStatusBox widget for monitoring bec services"
+        return "An autonomous widget to display the status of BEC services."
 
     def whatsThis(self):
         return self.toolTip()

bec_widgets/widgets/bec_status_box/status_item.py

@@ -2,40 +2,32 @@
 The widget is bound to be used with the BECStatusBox widget."""
 
 import enum
-import sys
+import os
 from datetime import datetime
 
-import qdarktheme
 from bec_lib.utils.import_utils import lazy_import_from
-from pydantic import Field
+from bec_qthemes import material_icon
 from qtpy.QtCore import Qt, Slot
-from qtpy.QtWidgets import QDialog, QHBoxLayout, QLabel, QStyle, QVBoxLayout, QWidget
+from qtpy.QtGui import QIcon, QPainter
+from qtpy.QtWidgets import QDialog, QHBoxLayout, QLabel, QVBoxLayout, QWidget
 
-from bec_widgets.utils.bec_connector import ConnectionConfig
+import bec_widgets
+from bec_widgets.utils.colors import get_accent_colors
 
 # TODO : Put normal imports back when Pydantic gets faster
 BECStatus = lazy_import_from("bec_lib.messages", ("BECStatus",))
 
+MODULE_PATH = os.path.dirname(bec_widgets.__file__)
+
 
 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.")
+    RUNNING = "done_outline"
+    BUSY = "progress_activity"
+    IDLE = "progress_activity"
+    ERROR = "emergency_home"
+    NOTCONNECTED = "signal_disconnected"
 
 
 class StatusItem(QWidget):
@@ -43,23 +35,24 @@ class StatusItem(QWidget):
 
     Args:
         parent: The parent widget.
-        config (dict): The configuration for the service.
+        config (dict): The configuration for the service, must be a BECServiceInfoContainer.
     """
 
-    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
+    def __init__(self, parent: QWidget = None, config=None):
         QWidget.__init__(self, parent=parent)
+        if config is None:
+            # needed because we need parent to be the first argument for QT Designer
+            raise ValueError(
+                "Please initialize the StatusItem with a BECServiceInfoContainer for config, received None."
+            )
+        self.accent_colors = get_accent_colors()
+        self.config = config
         self.parent = parent
         self.layout = None
-        self.config = config
-        self._popup_label_ref = {}
         self._label = None
         self._icon = None
+        self.icon_size = (24, 24)
+        self._popup_label_ref = {}
         self.init_ui()
 
     def init_ui(self) -> None:
@@ -74,23 +67,21 @@ class StatusItem(QWidget):
         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.
+    def update_config(self, config) -> None:
+        """Update the config of the status item widget.
 
         Args:
-            config (dict): Config updates from parent widget.
+            config (dict): Config updates from parent widget, must be a BECServiceInfoContainer.
         """
-        if config["service_name"] != self.config.service_name:
+        if self.config is None or config.service_name != self.config.service_name:
             return
-        self.config.status = config["status"]
-        self.config.info = config["info"]
-        self.config.metrics = config["metrics"]
+        self.config = config
         self.update_ui()
 
     def update_ui(self) -> None:
         """Update the UI of the labels, and popup dialog."""
+        if self.config is None:
+            return
         self.set_text()
         self.set_status()
         self._set_popup_text()
@@ -99,8 +90,8 @@ class StatusItem(QWidget):
         """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 len(service.split("/")) > 1 and service.split("/")[0].startswith("BEC"):
+            service = service.split("/", maxsplit=1)[0] + "/..." + service.split("/")[1][-4:]
         if status == "NOTCONNECTED":
             status = "NOT CONNECTED"
         text = f"{service} is {status}"
@@ -108,9 +99,16 @@ class StatusItem(QWidget):
 
     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))
+        status = self.config.status
+        if status in ["RUNNING", "BUSY"]:
+            color = self.accent_colors.success
+        elif status == "IDLE":
+            color = self.accent_colors.warning
+        elif status in ["ERROR", "NOTCONNECTED"]:
+            color = self.accent_colors.emergency
+        icon = QIcon(material_icon(IconsEnum[status].value, filled=True, color=color))
+
+        self._icon.setPixmap(icon.pixmap(*self.icon_size))
         self._icon.setAlignment(Qt.AlignmentFlag.AlignRight)
 
     def show_popup(self) -> None:
@@ -143,6 +141,7 @@ class StatusItem(QWidget):
         metrics_text = (
             f"<b>SERVICE:</b> {self.config.service_name}<br><b>STATUS:</b> {self.config.status}<br>"
         )
+        metrics_text += f"<b>BEC_LIB VERSION:</b> {self.config.info['version']}<br>"
         if self.config.metrics:
             for key, value in self.config.metrics.items():
                 if key == "create_time":
@@ -153,19 +152,3 @@ class StatusItem(QWidget):
     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/widgets/button_abort/abort_button.pyproject

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

bec_widgets/widgets/button_abort/abort_button_plugin.py

@@ -0,0 +1,54 @@
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+
+from qtpy.QtDesigner import QDesignerCustomWidgetInterface
+
+from bec_widgets.utils.bec_designer import designer_material_icon
+from bec_widgets.widgets.button_abort.button_abort import AbortButton
+
+DOM_XML = """
+<ui language='c++'>
+    <widget class='AbortButton' name='abort_button'>
+    </widget>
+</ui>
+"""
+
+
+class AbortButtonPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self._form_editor = None
+
+    def createWidget(self, parent):
+        t = AbortButton(parent)
+        return t
+
+    def domXml(self):
+        return DOM_XML
+
+    def group(self):
+        return "BEC Buttons"
+
+    def icon(self):
+        return designer_material_icon(AbortButton.ICON_NAME)
+
+    def includeFile(self):
+        return "abort_button"
+
+    def initialize(self, form_editor):
+        self._form_editor = form_editor
+
+    def isContainer(self):
+        return False
+
+    def isInitialized(self):
+        return self._form_editor is not None
+
+    def name(self):
+        return "AbortButton"
+
+    def toolTip(self):
+        return "A button that abort the scan."
+
+    def whatsThis(self):
+        return self.toolTip()

bec_widgets/widgets/button_abort/button_abort.py

@@ -0,0 +1,57 @@
+from bec_qthemes import material_icon
+from qtpy.QtCore import Qt
+from qtpy.QtWidgets import QHBoxLayout, QPushButton, QToolButton, QWidget
+
+from bec_widgets.qt_utils.error_popups import SafeSlot
+from bec_widgets.utils.bec_widget import BECWidget
+
+
+class AbortButton(BECWidget, QWidget):
+    """A button that abort the scan."""
+
+    ICON_NAME = "cancel"
+
+    def __init__(
+        self, parent=None, client=None, config=None, gui_id=None, toolbar=False, scan_id=None
+    ):
+        super().__init__(client=client, config=config, gui_id=gui_id)
+        QWidget.__init__(self, parent=parent)
+
+        self.get_bec_shortcuts()
+
+        self.layout = QHBoxLayout(self)
+        self.layout.setSpacing(0)
+        self.layout.setContentsMargins(0, 0, 0, 0)
+        self.layout.setAlignment(Qt.AlignmentFlag.AlignVCenter)
+
+        if toolbar:
+            icon = material_icon("cancel", color="#666666", filled=True)
+            self.button = QToolButton(icon=icon)
+            self.button.setToolTip("Abort the scan")
+        else:
+            self.button = QPushButton()
+            self.button.setText("Abort")
+            self.button.setStyleSheet(
+                "background-color:  #666666; color: white; font-weight: bold; font-size: 12px;"
+            )
+        self.button.clicked.connect(self.abort_scan)
+
+        self.layout.addWidget(self.button)
+
+        self.scan_id = scan_id
+
+    @SafeSlot()
+    def abort_scan(
+        self,
+    ):  # , scan_id: str | None = None): #FIXME scan_id will be added when combining with Queue widget
+        """
+        Abort the scan.
+
+        Args:
+            scan_id(str|None): The scan id to abort. If None, the current scan will be aborted.
+        """
+        if self.scan_id is not None:
+            print(f"Aborting scan with scan_id: {self.scan_id}")
+            self.queue.request_scan_abortion(scan_id=self.scan_id)
+        else:
+            self.queue.request_scan_abortion()

bec_widgets/widgets/button_abort/register_abort_button.py

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

bec_widgets/widgets/button_reset/button_reset.py

@@ -0,0 +1,59 @@
+from bec_qthemes import material_icon
+from qtpy.QtCore import Qt
+from qtpy.QtWidgets import QHBoxLayout, QMessageBox, QPushButton, QToolButton, QWidget
+
+from bec_widgets.qt_utils.error_popups import SafeSlot
+from bec_widgets.utils.bec_widget import BECWidget
+
+
+class ResetButton(BECWidget, QWidget):
+    """A button that resets the scan queue."""
+
+    ICON_NAME = "restart_alt"
+
+    def __init__(self, parent=None, client=None, config=None, gui_id=None, toolbar=False):
+        super().__init__(client=client, config=config, gui_id=gui_id)
+        QWidget.__init__(self, parent=parent)
+
+        self.get_bec_shortcuts()
+
+        self.layout = QHBoxLayout(self)
+        self.layout.setSpacing(0)
+        self.layout.setContentsMargins(0, 0, 0, 0)
+        self.layout.setAlignment(Qt.AlignmentFlag.AlignVCenter)
+
+        if toolbar:
+            icon = material_icon(
+                "restart_alt", color="#F19E39", filled=True, convert_to_pixmap=False
+            )
+            self.button = QToolButton(icon=icon)
+            self.button.setToolTip("Reset the scan queue")
+        else:
+            self.button = QPushButton()
+            self.button.setText("Reset Queue")
+            self.button.setStyleSheet(
+                "background-color:  #F19E39; color: white; font-weight: bold; font-size: 12px;"
+            )
+        self.button.clicked.connect(self.confirm_reset_queue)
+
+        self.layout.addWidget(self.button)
+
+    @SafeSlot()
+    def confirm_reset_queue(self):
+        """Prompt the user to confirm the queue reset."""
+        msg_box = QMessageBox()
+        msg_box.setIcon(QMessageBox.Warning)
+        msg_box.setWindowTitle("Confirm Reset")
+        msg_box.setText(
+            "Are you sure you want to reset the scan queue? This action cannot be undone."
+        )
+        msg_box.setStandardButtons(QMessageBox.Yes | QMessageBox.No)
+        msg_box.setDefaultButton(QMessageBox.No)
+
+        if msg_box.exec_() == QMessageBox.Yes:
+            self.reset_queue()
+
+    @SafeSlot()
+    def reset_queue(self):
+        """Reset the scan queue."""
+        self.queue.request_queue_reset()

bec_widgets/widgets/button_reset/register_reset_button.py

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

bec_widgets/widgets/button_reset/reset_button.pyproject

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

bec_widgets/widgets/button_reset/reset_button_plugin.py

@@ -0,0 +1,54 @@
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+
+from qtpy.QtDesigner import QDesignerCustomWidgetInterface
+
+from bec_widgets.utils.bec_designer import designer_material_icon
+from bec_widgets.widgets.button_reset.button_reset import ResetButton
+
+DOM_XML = """
+<ui language='c++'>
+    <widget class='ResetButton' name='reset_button'>
+    </widget>
+</ui>
+"""
+
+
+class ResetButtonPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self._form_editor = None
+
+    def createWidget(self, parent):
+        t = ResetButton(parent)
+        return t
+
+    def domXml(self):
+        return DOM_XML
+
+    def group(self):
+        return "BEC Buttons"
+
+    def icon(self):
+        return designer_material_icon(ResetButton.ICON_NAME)
+
+    def includeFile(self):
+        return "reset_button"
+
+    def initialize(self, form_editor):
+        self._form_editor = form_editor
+
+    def isContainer(self):
+        return False
+
+    def isInitialized(self):
+        return self._form_editor is not None
+
+    def name(self):
+        return "ResetButton"
+
+    def toolTip(self):
+        return "A button that reset the scan queue."
+
+    def whatsThis(self):
+        return self.toolTip()

bec_widgets/widgets/button_resume/button_resume.py

@@ -0,0 +1,42 @@
+from bec_qthemes import material_icon
+from qtpy.QtCore import Qt
+from qtpy.QtWidgets import QHBoxLayout, QPushButton, QToolButton, QWidget
+
+from bec_widgets.qt_utils.error_popups import SafeSlot
+from bec_widgets.utils.bec_widget import BECWidget
+
+
+class ResumeButton(BECWidget, QWidget):
+    """A button that continue scan queue."""
+
+    ICON_NAME = "resume"
+
+    def __init__(self, parent=None, client=None, config=None, gui_id=None, toolbar=False):
+        super().__init__(client=client, config=config, gui_id=gui_id)
+        QWidget.__init__(self, parent=parent)
+
+        self.get_bec_shortcuts()
+
+        self.layout = QHBoxLayout(self)
+        self.layout.setSpacing(0)
+        self.layout.setContentsMargins(0, 0, 0, 0)
+        self.layout.setAlignment(Qt.AlignmentFlag.AlignVCenter)
+
+        if toolbar:
+            icon = material_icon("resume", color="#2793e8", filled=True, convert_to_pixmap=False)
+            self.button = QToolButton(icon=icon)
+            self.button.setToolTip("Resume the scan queue")
+        else:
+            self.button = QPushButton()
+            self.button.setText("Resume")
+            self.button.setStyleSheet(
+                "background-color:  #2793e8; color: white; font-weight: bold; font-size: 12px;"
+            )
+        self.button.clicked.connect(self.continue_scan)
+
+        self.layout.addWidget(self.button)
+
+    @SafeSlot()
+    def continue_scan(self):
+        """Stop the scan."""
+        self.queue.request_scan_continuation()

bec_widgets/widgets/button_resume/register_resume_button.py

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

bec_widgets/widgets/button_resume/resume_button.pyproject

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

bec_widgets/widgets/button_resume/resume_button_plugin.py

@@ -0,0 +1,54 @@
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+
+from qtpy.QtDesigner import QDesignerCustomWidgetInterface
+
+from bec_widgets.utils.bec_designer import designer_material_icon
+from bec_widgets.widgets.button_resume.button_resume import ResumeButton
+
+DOM_XML = """
+<ui language='c++'>
+    <widget class='ResumeButton' name='resume_button'>
+    </widget>
+</ui>
+"""
+
+
+class ResumeButtonPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self._form_editor = None
+
+    def createWidget(self, parent):
+        t = ResumeButton(parent)
+        return t
+
+    def domXml(self):
+        return DOM_XML
+
+    def group(self):
+        return "BEC Buttons"
+
+    def icon(self):
+        return designer_material_icon(ResumeButton.ICON_NAME)
+
+    def includeFile(self):
+        return "resume_button"
+
+    def initialize(self, form_editor):
+        self._form_editor = form_editor
+
+    def isContainer(self):
+        return False
+
+    def isInitialized(self):
+        return self._form_editor is not None
+
+    def name(self):
+        return "ResumeButton"
+
+    def toolTip(self):
+        return "A button that continue scan queue."
+
+    def whatsThis(self):
+        return self.toolTip()

bec_widgets/widgets/buttons/__init__.py

@@ -1 +0,0 @@
-from .stop_button.stop_button import StopButton

bec_widgets/widgets/buttons/stop_button/stop_button.py

@@ -1,32 +0,0 @@
-from qtpy.QtWidgets import QPushButton
-
-from bec_widgets.utils import BECConnector
-
-
-class StopButton(BECConnector, QPushButton):
-    """A button that stops the current scan."""
-
-    def __init__(self, parent=None, client=None, config=None, gui_id=None):
-        super().__init__(client=client, config=config, gui_id=gui_id)
-        QPushButton.__init__(self, parent=parent)
-
-        self.get_bec_shortcuts()
-        self.setText("Stop")
-        self.setStyleSheet("background-color:  #cc181e; color: white")
-        self.clicked.connect(self.stop_scan)
-
-    def stop_scan(self):
-        """Stop the scan."""
-        self.queue.request_scan_abortion()
-        self.queue.request_queue_reset()
-
-
-if __name__ == "__main__":  # pragma: no cover
-    import sys
-
-    from qtpy.QtWidgets import QApplication
-
-    app = QApplication(sys.argv)
-    widget = StopButton()
-    widget.show()
-    sys.exit(app.exec_())

bec_widgets/widgets/color_button/color_button.py

@@ -0,0 +1,73 @@
+from __future__ import annotations
+
+from typing import Literal
+
+import pyqtgraph as pg
+from qtpy.QtCore import Qt, Signal
+from qtpy.QtWidgets import QHBoxLayout, QWidget
+
+from bec_widgets.qt_utils.error_popups import SafeSlot
+
+
+class ColorButton(QWidget):
+    """
+    A ColorButton that opens a dialog to select a color. Inherits from pyqtgraph.ColorButton.
+    Patches event loop of the ColorDialog, if opened in another QDialog.
+    """
+
+    color_selected = Signal(str)
+
+    ICON_NAME = "colors"
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        self.layout = QHBoxLayout(self)
+        self.layout.setSpacing(0)
+        self.layout.setContentsMargins(0, 0, 0, 0)
+        self.layout.setAlignment(Qt.AlignmentFlag.AlignVCenter)
+
+        self.button = pg.ColorButton()
+        self.button.setFlat(True)
+        self.button.clicked.connect(self.select_color)
+        self.layout.addWidget(self.button)
+
+    @SafeSlot()
+    def select_color(self):
+        self.origColor = self.button.color()
+        self.button.colorDialog.setCurrentColor(self.button.color())
+        self.button.colorDialog.open()
+        self.button.colorDialog.exec()
+        self.color_selected.emit(self.button.color().name())
+
+    @SafeSlot(str)
+    def set_color(self, color: tuple | str):
+        """
+        Set the color of the button.
+
+        Args:
+            color(tuple|str): The color to set.
+        """
+        self.button.setColor(color)
+
+    def get_color(self, format: Literal["RGBA", "HEX"] = "RGBA") -> tuple | str:
+        """
+        Get the color of the button in the specified format.
+
+        Args:
+            format(Literal["RGBA", "HEX"]): The format of the returned color.
+
+        Returns:
+            tuple|str: The color in the specified format.
+        """
+        if format == "RGBA":
+            return self.button.color().getRgb()
+        if format == "HEX":
+            return self.button.color().name()
+
+    def cleanup(self):
+        """
+        Clean up the ColorButton.
+        """
+        self.button.colorDialog.close()
+        self.button.colorDialog.deleteLater()

bec_widgets/widgets/color_button/color_button.pyproject

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

bec_widgets/widgets/color_button/color_button_plugin.py

@@ -0,0 +1,55 @@
+import os
+
+from qtpy.QtDesigner import QDesignerCustomWidgetInterface
+
+import bec_widgets
+from bec_widgets.utils.bec_designer import designer_material_icon
+from bec_widgets.widgets.color_button.color_button import ColorButton
+
+DOM_XML = """
+<ui language='c++'>
+    <widget class='ColorButton' name='color_button'>
+    </widget>
+</ui>
+"""
+MODULE_PATH = os.path.dirname(bec_widgets.__file__)
+
+
+class ColorButtonPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self._form_editor = None
+
+    def createWidget(self, parent):
+        t = ColorButton(parent)
+        return t
+
+    def domXml(self):
+        return DOM_XML
+
+    def group(self):
+        return "BEC Buttons"
+
+    def icon(self):
+        return designer_material_icon(ColorButton.ICON_NAME)
+
+    def includeFile(self):
+        return "color_button"
+
+    def initialize(self, form_editor):
+        self._form_editor = form_editor
+
+    def isContainer(self):
+        return False
+
+    def isInitialized(self):
+        return self._form_editor is not None
+
+    def name(self):
+        return "ColorButton"
+
+    def toolTip(self):
+        return "ColorButton which opens a color dialog."
+
+    def whatsThis(self):
+        return self.toolTip()

bec_widgets/widgets/color_button/register_color_button.py

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