bluesky.plan_stubs.complete#
- bluesky.plan_stubs.complete(obj: Flyable, *, group: Hashable | None = None, wait: bool = False, **kwargs) Generator[Msg, Any, Status][source]#
Tell a flyable, ‘stop collecting, whenever you are ready’.
A flyable 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’ 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.complete()
- Returns:
- status
Status of complete operation. If wait is True, this will always be complete by the time it is returned.
- Yields:
- msgMsg
a ‘complete’ Msg and maybe a ‘wait’ message