bluesky.plan_stubs.wait

bluesky.plan_stubs.wait(group: Hashable | None = None, *, timeout: float | None = None, error_on_timeout: bool = True)

Wait for all statuses in a group to report being finished.

Parameters:

groupstring (or any hashable object), optional

Identifier given to abs_set, rel_set, trigger; None by default

timeoutfloat, optional

The maximum duration, in seconds, to wait for all objects in the group to complete. If the timeout expires and error_on_timeout is set to True, a TimeoutError is raised.

error_on_timeoutbool, Defaults to True

Specifies the behavior when the timeout is reached: - If True, a TimeoutError is raised if the operations do not complete within the specified timeout. - If False, the method returns once all objects are done.

Yields

——

msgMsg

Msg(‘wait’, None, group=group, error_on_timeout=error_on_timeout, timeout=timeout)