bluesky.run_engine.RunEngine.request_suspend#
- RunEngine.request_suspend(fut, *, pre_plan=None, post_plan=None, justification=None)[source]#
Request that the run suspend itself until the future is finished.
The two plans will be run before and after waiting for the future. This enable doing things like opening and closing shutters and resetting cameras around a suspend.
- Parameters:
- futasyncio.Future
- pre_planiterable or callable, optional
Plan to execute just before suspending. If callable, must take no arguments.
- post_planiterable or callable, optional
Plan to execute just before resuming. If callable, must take no arguments.
- justificationstr, optional
explanation of why the suspension has been requested