mirror of
https://github.com/bec-project/bec_widgets.git
synced 2025-07-14 03:31:50 +02:00
docs(user): widget gallery with documentation added
This commit is contained in:
BIN
docs/user/widgets/bec_status_box/bec_status_box.gif
Normal file
BIN
docs/user/widgets/bec_status_box/bec_status_box.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 1.2 MiB |
38
docs/user/widgets/bec_status_box/bec_status_box.md
Normal file
38
docs/user/widgets/bec_status_box/bec_status_box.md
Normal file
@ -0,0 +1,38 @@
|
||||
(user.widgets.bec_status_box)=
|
||||
# BEC Status Box
|
||||
|
||||
````{tab} Overview
|
||||
|
||||
The [`BEC Status Box`](/api_reference/_autosummary/bec_widgets.cli.client.BECStatusBox) widget is designed to monitor the status and health of all running BEC processes. This widget provides a real-time overview of the BEC core services, including DeviceServer, ScanServer, SciHub, ScanBundler, and FileWriter. The top-level display indicates the overall state of the BEC services, while the collapsed view allows users to delve into the status of each individual process. By double-clicking on a specific process, users can access a detailed popup window with live updates of the metrics for that process.
|
||||
|
||||
## Key Features:
|
||||
- **Comprehensive Service Monitoring**: Track the state of individual BEC services, including real-time updates on their health and status.
|
||||
- **Automatic Service Tracking**: Automatically detects and monitors additional clients connecting to the BEC services.
|
||||
- **Detailed Metrics**: Provides live updates of the metrics for each process, accessible through an interactive popup window.
|
||||
|
||||

|
||||
````
|
||||
|
||||
````{tab} Examples
|
||||
|
||||
The `BECStatusBox` widget can be integrated within a [`BECDockArea`](user.widgets.bec_dock_area) or used as an individual component in your application through `QtDesigner`. Below are examples demonstrating how to create and use the `BECStatusBox` widget.
|
||||
|
||||
## Example 1 - Adding BEC Status Box to BECDockArea
|
||||
|
||||
In this example, we demonstrate how to add a `BECStatusBox` widget to a `BECDockArea`, allowing users to monitor the status of BEC processes directly from the GUI.
|
||||
|
||||
```python
|
||||
# Add a new dock with a BECStatusBox widget
|
||||
bec_status_box = gui.add_dock().add_widget("BECStatusBox")
|
||||
```
|
||||
|
||||
```{hint}
|
||||
Once the `BECStatusBox` is added, users can interact with it to view the status of individual processes. By expanding the view, you can see the status of each BEC service in detail.
|
||||
```
|
||||
````
|
||||
|
||||
````{tab} API
|
||||
```{eval-rst}
|
||||
.. include:: /api_reference/_autosummary/bec_widgets.cli.client.BECStatusBox.rst
|
||||
```
|
||||
````
|
Reference in New Issue
Block a user