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.

API

exception ophyd_async.epics.motor.MotorLimitsException

Bases: Exception

Exception for invalid motor limits.

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 check_motor_limit(abs_start_pos: float, abs_end_pos: float)

Check the positions are within limits.

Will raise a MotorLimitsException if the given absolute positions will be outside the motor soft limits.

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.

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.