bluesky.plan_stubs.locate#

bluesky.plan_stubs.locate(*objs: Locatable[Any], squeeze: bool | None = None) → Generator[Msg, Any, Mapping[str, Location[Any]]][source]#

Locate some Movables in parallel and return their locations by name.

Parameters:

*objsLocatable[Any]: One or more objects implementing the locate() method. They must also have a name property.
squeezebool, optional: Ignored, with a warning. Use loc to get a single location.

Returns:

locationsMapping[str, Location]: The location of each object, keyed by its name.

Yields:

msgMsg: Msg('locate', obj1, ..., objn)

Raises:

TypeError: If an object has no name.
ValueError: If two objects have the same name.