bluesky.plan_stubs.locate

bluesky.plan_stubs.locate(obj: Locatable, squeeze: Literal[True] = True) → Location

bluesky.plan_stubs.locate(*objs: Locatable, squeeze: bool = True) → list[Location]

Locate some Movables and return their locations.

Parameters:

objDevice or Signal

sqeeze: bool

If True, return the result as a list. If False, always return a list of retults even with a single object.

Yields:

msgMsg

Msg('locate', obj1, ..., objn, squeeze=True)