ophyd_async.epics.motor

Support for EPICS motor record.

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

Module Contents

Classes

Motor	Device that moves a motor record.
InstantMotorMock	Mock behaviour that instantly moves readback to setpoint.
OffsetMode	In Set mode, determine what to do when the motor setpoint is written.
UseSetMode	Determine what to do when the motor setpoint is written.

API

exception ophyd_async.epics.motor.MotorLimitsError

Bases: Exception

Exception for invalid motor limits.

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

Bases: ophyd_async.core.StandardMovable, ophyd_async.core.StandardReadable, bluesky.protocols.Flyable, bluesky.protocols.Preparable

Device that moves a motor record.

movable_logic() → MovableLogic

Return MotorMoveLogic for this motor.

async prepare(value: FlyMotorInfo)

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

async kickoff()

Begin moving motor from prepared position to final position.

complete() → WatchableAsyncStatus

Mark as complete once motor reaches completed position.

class ophyd_async.epics.motor.InstantMotorMock(name: str = '', parent: DeviceMock | None = None)

Bases: ophyd_async.core.DeviceMock[Motor]

Mock behaviour that instantly moves readback to setpoint.

async connect(device: Motor) → None

Mock signals to do an instant move on setpoint write.

class ophyd_async.epics.motor.OffsetMode

Bases: ophyd_async.core.StrictEnum

In Set mode, determine what to do when the motor setpoint is written.

VARIABLE

‘Variable’

Change the offset so the readback matches the setpoint.

FROZEN

‘Frozen’

Tell the controller to change the readback without changing the offset.

class ophyd_async.epics.motor.UseSetMode

Bases: ophyd_async.core.StrictEnum

Determine what to do when the motor setpoint is written.

USE

‘Use’

Tell the controller to move to the setpoint.

SET

‘Set’

Change offset (in record or in controller) when setpoint is written.