bluesky.plan_stubs.prepare

bluesky.plan_stubs.prepare(obj: Preparable[Any], *args: Any, group: Hashable | None = None, wait: bool = False, **kwargs: Any) → Generator[Msg, Any, Status]

Prepare a device ready for trigger or kickoff.

Parameters:

objPreparable

Device with ‘prepare’ method

groupstring (or any hashable object), optional

identifier used by ‘wait’

waitboolean, optional

If True, wait for completion before processing any more messages. False by default.

kwargs

passed through to obj.prepare()

Yields:

msgMsg

Msg(‘kickoff’, obj)

See also

bluesky.plan_stubs.complete()

bluesky.plan_stubs.collect()

bluesky.plan_stubs.wait()