bluesky.plan_stubs.complete

bluesky.plan_stubs.complete(obj, *, group=None, wait=False, **kwargs)[source]

Tell a flyer, ‘stop collecting, whenever you are ready’.

The flyer returns a status object. Some flyers respond to this command by stopping collection and returning a finished status object immediately. Other flyers finish their given course and finish whenever they finish, irrespective of when this command is issued.

Parameters
objfly-able

Device with ‘kickoff’, ‘complete’, and ‘collect’ 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.complete()

Yields
msgMsg

a ‘complete’ Msg and maybe a ‘wait’ message