feat(widgets/circular_progress_bar): SpiralProgressBar added with rpc interface
Description
New spiral progress bar for nested scans available for rpc interface.
Full documentations coming with #190 (closed) and #189 (closed).
In rpc interface can be added like this after launching BECIPythonClient
:
d2 = gui.add_dock()
bar = d2.add_widget_bec("SpiralProgressBar")
# example of usage
bar.set_number_of_bars(5)
bar.set_colors_from_map('viridis')
bar.set_value([10,20,30,40,50])
this behaviour can be scriptable with for example scan status endpoint for scan progress.
By default the progress bar is set to be updated from scan_segment
endpoint automatically configuring itself for 'scan_motors'.
Auto updates can be disabled by bar.enable_scan_updates(False)
.
In next step I would like to include some text information in the middle of the widget such as what is actually on which circle or some scan info/metadata.
Related Issues
closes #133 (closed)
Type of Change
- new SpiralProgressBar
Potential side effects
None
Definition of Done
-
Documentation is up-to-date. -
e2e -
unit tests -
config structure