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

docs(widget tutorial): step by step guide added

Browse Source
This commit is contained in:
wyzula_j
2024-08-27 18:15:33 +02:00
committed by wyzula_j
parent d0e5643d4f
commit b32ced85ff
3 changed files with 248 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/developer/widget_development/widget_base_class.md
View File

@ -34,7 +34,7 @@ integrated with the BEC system by providing:
dictionaries, JSON, or YAML formats, allowing for persistent storage and retrieval of widget states.
4. **RPC Registration**: Widgets derived
from [`BECWidget`](https://bec.readthedocs.io/projects/bec-widgets/en/latest/api_reference/_autosummary/bec_widgets.utils.bec_widget.BECWidget.html#bec_widgets.utils.bec_widget.BECWidget)
from [`BECConnector`](https://bec.readthedocs.io/projects/bec-widgets/en/latest/api_reference/_autosummary/bec_widgets.utils.bec_connector.BECConnector.html#bec_widgets.utils.bec_connector.BECConnector)
are automatically registered with
the [`RPCRegister`](https://bec.readthedocs.io/projects/bec-widgets/en/latest/api_reference/_autosummary/bec_widgets.cli.rpc_register.RPCRegister.html#bec_widgets.cli.rpc_register.RPCRegister),
enabling them to handle remote procedure calls (RPCs) efficiently. This allows the widget to be controlled remotely
@ -135,7 +135,7 @@ BEC system through convenient shortcuts:
self.client.shutdown()
```
### Example: `PositionerBox` Widget
### Example: [`PositionerBox`](user.widgets.positioner_box) Widget
Let’s look at an example of a widget that leverages
the [`BECWidget`](https://bec.readthedocs.io/projects/bec-widgets/en/latest/api_reference/_autosummary/bec_widgets.utils.bec_widget.BECWidget.html#bec_widgets.utils.bec_widget.BECWidget)