bluesky.plan_stubs.stage#
- bluesky.plan_stubs.stage(obj: Stageable, *, group: Hashable | None = None, wait: bool | None = None) Generator[Msg, Any, Status | list[Any]][source]#
‘Stage’ a device (i.e., prepare it for use, ‘arm’ it).
- Parameters:
- objDevice
- groupstring (or any hashable object), optional
identifier used by ‘wait’; None by default
- waitboolean, optional
If True, wait for completion before processing any more messages. False by default.
- Returns:
- stage
Either a status representing the stage operation or a list of staged values for backward compatibility.
- Yields:
- msgMsg
See also
bluesky.plan_stubs.unstage()bluesky.plan_stubs.stage_all()