bluesky.plans.fly#
- bluesky.plans.fly(flyers: list[Flyable], *, md: MutableMapping[str, Any] | None = None, collect_flush_period: float | None = None, stream_name: str | None = None, watch: Sequence[str] = ()) Generator[Msg, Any, str][source]#
Perform a fly scan with one or more ‘flyers’.
- Parameters:
- flyerscollection
objects that support the flyer interface
- mdCustomPlanMetadata, optional
Additional metadata to include in the run start document
- collect_flush_periodfloat, optional
If set, will use collect_while_completing with the given flush period
- stream_namestr, optional
If set, will declare a stream with the given name for all flyers
- watch: set of watch groups, optional
Additional groups to monitor while collecting from flyers. Will only be used if collect_flush_period is set.
- Yields:
- msgMsg
bluesky messages for opening/closing run, optionally declaring stream, and controlling flyers