`ophyd_async.epics.motor`#

Support for EPICS motor record.

https://github.com/epics-modules/motor

Module Contents#

Classes#

Device that moves a motor record.

API#

exception ophyd_async.epics.motor.MotorLimitsException[source]#

Bases: Exception

Exception for invalid motor limits.

class ophyd_async.epics.motor.Motor(prefix: str, name='')[source]#

Bases: ophyd_async.core.StandardReadable, bluesky.protocols.Locatable[float], bluesky.protocols.Stoppable, bluesky.protocols.Flyable, bluesky.protocols.Preparable, bluesky.protocols.Subscribable[float]

Device that moves a motor record.

set_name(name: str, *, child_name_separator: str | None = None) → None[source]#: Set name of the motor and its children.

async prepare(value: FlyMotorInfo)[source]#: Move to the beginning of a suitable run-up distance ready for a flyscan.

async kickoff()[source]#: Begin moving motor from prepared position to final position.

complete() → WatchableAsyncStatus[source]#: Mark as complete once motor reaches completed position.

async set(new_position: float, timeout: CalculatableTimeout = CALCULATE_TIMEOUT)[source]#: Move motor to the given value.

async stop(success=False)[source]#: Request to stop moving and return immediately.

async locate() → Location[float][source]#: Return the current setpoint and readback of the motor.

subscribe(function: Callback[dict[str, Reading[float]]]) → None[source]#: Subscribe.

clear_sub(function: Callback[dict[str, Reading[float]]]) → None[source]#: Unsubscribe.