bluesky.plans.kickoff

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

Kickoff a fly-scanning device.

Parameters:
  • obj (fly-able) – Device with ‘kickoff’, ‘complete’, and ‘collect’ methods
  • group (string (or any hashable object), optional) – identifier used by ‘wait’
  • wait (boolean, optional) – If True, wait for completion before processing any more messages. False by default.
  • kwargs – passed through to obj.kickoff()
Yields:

msg (Msg) – Msg(‘kickoff’, obj)

See also

bluesky.plans.complete bluesky.plans.collect bluesky.plans.wait