bluesky.plan_stubs.kickoff

bluesky.plan_stubs.kickoff(obj, *, group=None, wait=False, **kwargs)

Kickoff one fly-scanning device.

Parameters:

objfly-able Device with ‘kickoff’, and ‘complete’ methods.

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.kickoff()

Yields:

msgMsg

Msg(‘kickoff’, obj)

See also

bluesky.plan_stubs.complete()

bluesky.plan_stubs.collect()

bluesky.plan_stubs.wait()