ophyd.status.wait

ophyd.status.wait(status, timeout=None, *, poll_rate='DEPRECATED')

(Blocking) wait for the status object to complete

Parameters
status: StatusBase

A Status object

timeout: Union[Number, None], optional

Amount of time in seconds to wait. None disables, such that wait() will only return when either the status completes or if interrupted by the user.

poll_rate: “DEPRECATED”

DEPRECATED. Has no effect because this does not poll.

Raises
WaitTimeoutError

If the status has not completed within timeout (starting from when this method was called, not from the beginning of the action).

Exception

This is status.exception(), raised if the status has finished with an error. This may include TimeoutError, which indicates that the action itself raised TimeoutError, distinct from WaitTimeoutError above.