0
0
mirror of https://github.com/bec-project/bec_widgets.git synced 2025-07-14 11:41:49 +02:00

docs: add widget to documentation

This commit is contained in:
2024-06-20 18:33:44 +02:00
parent 5d4ca816cd
commit 6fa1c06053
3 changed files with 114 additions and 5 deletions

View File

@ -13,13 +13,13 @@ To install BEC Widgets using the pip package manager, execute the following comm
```bash
pip install bec_widgets[pyqt6]
pip install 'bec_widgets[pyqt6]'
```
In case you want to use PyQt5, you can install it by using the following command:
```bash
pip install bec_widgets[pyqt5]
pip install 'bec_widgets[pyqt5]'
```
**Troubleshooting**

View File

@ -0,0 +1,30 @@
(user.widgets.text_box)=
# [BEC Status Box](/api_reference/_autosummary/bec_widgets.cli.client.BECStatusBox)
**Purpose:**
The BECStatusBox Widget is a widget that allows you to monitor the status/health of the all running BEC processes. The widget generates the view automatically and updates the status of the processes in real-time. The top level indicates the overall state of the BEC core services (DeviceServer, ScanServer, SciHub, ScanBundler and FileWriter), but you can also see the status of each individual process by opening the collapsed view. In the collapsed view, you can double click on each process to get a popup window with live updates of the metrics for each process in real-time.
**Key Features:**
- monitor the state of individual BEC services.
- automatically track BEC services, i.e. additional clients connecting.
- live-updates of the metrics for each process.
**Example of Use:**
![BECStatus](./bec_status_box.gif)
**Code example:**
The following code snipped demonstrates how to create a `BECStatusBox` widget using BEC Widgets within BEC.
```python
bec_status_box = gui.add_dock().add_widget("BECStatusBox")
```