ophyd_async.epics.motor

Support for EPICS motor record.

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

Module Contents

Classes

FlyMotorInfo	Minimal set of information required to fly a motor.
Motor	Device that moves a motor record.

API

exception ophyd_async.epics.motor.MotorLimitsException

Bases: Exception

Exception for invalid motor limits.

class ophyd_async.epics.motor.FlyMotorInfo(/, **data: ~typing.Any)

Bases: pydantic.BaseModel

Minimal set of information required to fly a motor.

start_position: float

‘Field(…)’

Absolute position of the motor once it finishes accelerating to desired velocity, in motor EGUs

end_position: float

‘Field(…)’

Absolute position of the motor once it begins decelerating from desired velocity, in EGUs

time_for_move: float

‘Field(…)’

Time taken for the motor to get from start_position to end_position, excluding run-up and run-down, in seconds.

timeout: CalculatableTimeout

‘Field(…)’

Maximum time for the complete motor move, including run up and run down. Defaults to time_for_move + run up and run down times + 10s.

class ophyd_async.epics.motor.Motor(prefix: str, name='')

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

Set name of the motor and its children.

async prepare(value: FlyMotorInfo)

Move to the beginning of a suitable run-up distance ready for a flyscan.

async kickoff()

Begin moving motor from prepared position to final position.

complete() → WatchableAsyncStatus

Mark as complete once motor reaches completed position.

async set(new_position: float, timeout: CalculatableTimeout = CALCULATE_TIMEOUT)

Move motor to the given value.

async stop(success=False)

Request to stop moving and return immediately.

async locate() → Location[float]

Return the current setpoint and readback of the motor.

subscribe(function: Callback[dict[str, Reading[float]]]) → None

Subscribe.

clear_sub(function: Callback[dict[str, Reading[float]]]) → None

Unsubscribe.