dodal.plan_stubs.wrapped#

Functions

move(moves[, group])

Move a device, wrapper for bp.mv.

move_relative(moves[, group])

Move a device relative to its current position, wrapper for bp.mvr.

set_absolute(movable, value[, group, wait])

Set a device, wrapper for bp.abs_set.

set_relative(movable, value[, group, wait])

Change a device, wrapper for bp.rel_set.

sleep(time)

Suspend all action for a given time, wrapper for bp.sleep

wait([group, timeout])

Wait for a group status to complete, wrapper for bp.wait.
dodal.plan_stubs.wrapped.set_absolute(movable: Movable, value: Any, group: str | None = None, wait: bool = False) → Generator[Msg, Any, P][source]#

Set a device, wrapper for bp.abs_set.

Parameters:

  • movable (Movable) – The device to set

  • value (T) – The new value

  • group (Group | None, optional) – The message group to associate with the setting, for sequencing. Defaults to None.

  • wait (bool, optional) – The group should wait until all setting is complete (e.g. a motor has finished moving). Defaults to False.

Returns:

Plan

Return type:

MsgGenerator

Yields:

Iterator[MsgGenerator] – Bluesky messages

dodal.plan_stubs.wrapped.set_relative(movable: Movable, value: Any, group: str | None = None, wait: bool = False) → Generator[Msg, Any, P][source]#

Change a device, wrapper for bp.rel_set.

Parameters:

  • movable (Movable) – The device to set

  • value (T) – The new value

  • group (Group | None, optional) – The message group to associate with the setting, for sequencing. Defaults to None.

  • wait (bool, optional) – The group should wait until all setting is complete (e.g. a motor has finished moving). Defaults to False.

Returns:

Plan

Return type:

MsgGenerator

Yields:

Iterator[MsgGenerator] – Bluesky messages

dodal.plan_stubs.wrapped.move(moves: Mapping[Movable, Any], group: str | None = None) → Generator[Msg, Any, P][source]#

Move a device, wrapper for bp.mv.

Parameters:

  • moves (Mapping[Movable, T]) – Mapping of Movables to target positions

  • group (Group | None, optional) – The message group to associate with the setting, for sequencing. Defaults to None.

Returns:

Plan

Return type:

MsgGenerator

Yields:

Iterator[MsgGenerator] – Bluesky messages

dodal.plan_stubs.wrapped.move_relative(moves: Mapping[Movable, Any], group: str | None = None) → Generator[Msg, Any, P][source]#

Move a device relative to its current position, wrapper for bp.mvr.

Parameters:

  • moves (Mapping[Movable, T]) – Mapping of Movables to target deltas

  • group (Group | None, optional) – The message group to associate with the setting, for sequencing. Defaults to None.

Returns:

Plan

Return type:

MsgGenerator

Yields:

Iterator[MsgGenerator] – Bluesky messages

dodal.plan_stubs.wrapped.sleep(time: float) → Generator[Msg, Any, P][source]#

Suspend all action for a given time, wrapper for bp.sleep

Parameters:

time (float) – Time to wait in seconds

Returns:

Plan

Return type:

MsgGenerator

Yields:

Iterator[MsgGenerator] – Bluesky messages

dodal.plan_stubs.wrapped.wait(group: str | None = None, timeout: float | None = None) → Generator[Msg, Any, P][source]#

Wait for a group status to complete, wrapper for bp.wait. Does not expose move_on, as when used as a stub will not fail on Timeout.

Parameters:

  • group (Group | None, optional) – The name of the group to wait for, defaults to None, in which case waits for all groups that have not yet been awaited.

  • timeout (float | None, default=None) – a timeout in seconds

Returns:

Plan

Return type:

MsgGenerator

Yields:

Iterator[MsgGenerator] – Bluesky messages