bluesky.plan_stubs.trigger#

bluesky.plan_stubs.trigger(obj: Triggerable, *, group: Hashable | None = None, wait: bool = False) Generator[Msg, Any, Status][source]#

Trigger and acquisition. Optionally, wait for it to complete.

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:
status

Status that completes when trigger is complete. If wait is True, this will always be complete by the time it is returned.

Yields:
msgMsg