bluesky.plan_stubs.kickoff#
- bluesky.plan_stubs.kickoff(obj: Flyable, *, group: Hashable | None = None, wait: bool = False, **kwargs) Generator[Msg, Any, Status][source]#
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()
- Returns:
- status
Status of kickoff operation. If wait is True, this will always be complete by the time it is returned.
- Yields:
- msgMsg
Msg(‘kickoff’, obj)