ophyd.epics_motor.EpicsMotor

class ophyd.epics_motor.EpicsMotor(prefix='', *, name, kind=None, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)

An EPICS motor record, wrapped in a Positioner

Keyword arguments are passed through to the base class, Positioner

Parameters
prefixstr

The record to use

read_attrssequence of attribute names

The signals to be read during data acquisition (i.e., in read() and describe() calls)

namestr, optional

The name of the device

parentinstance or None

The instance of the parent device, if applicable

settle_timefloat, optional

The amount of time to wait after moves to report status completion

timeoutfloat, optional

The default timeout to use for motion requests, in seconds.

__init__(prefix='', *, name, kind=None, read_attrs=None, configuration_attrs=None, parent=None, **kwargs)

Methods

__init__([prefix, kind, read_attrs, …])

add_instantiation_callback(callback[, …])

Register a callback which will receive each OphydObject instance.

check_value(pos)

Check that the position is within the soft limits

clear_sub(cb[, event_type])

Remove a subscription, given the original callback function

configure(d)

Configure the device for something during a run

describe()

Provide schema and meta-data for read().

describe_configuration()

Provide schema & meta-data for read_configuration()

destroy()

Disconnect and destroy all signals on the Device

get(**kwargs)

Get the value of all components in the device

get_device_tuple()

The device tuple type associated with an Device class

get_instantiated_signals(*[, attr_prefix])

Yields all of the instantiated signals in a device hierarchy

get_lim(flag)

Returns the travel limit of motor

home(direction[, wait])

Perform the default homing function in the desired direction

move(position[, wait])

Move to a specified position, optionally waiting for motion to complete.

pause()

Attempt to ‘pause’ the device.

put(dev_t, **kwargs)

Put a value to all components of the device

read()

Read data from the device.

read_configuration()

Dictionary mapping names to value dicts with keys: value, timestamp

resume()

Resume a device from a ‘paused’ state.

set(new_position, *[, timeout, moved_cb, wait])

Set a value and return a Status object

set_current_position(pos)

Configure the motor user position to the given value

set_lim(low, high)

Sets the low and high travel limits of motor

stage()

Stage the device for data collection.

stop(*[, success])

Stop the Device and all (instantiated) subdevices

subscribe(callback[, event_type, run])

Subscribe to events this event_type generates.

summary()

trigger()

Trigger the device and return status object.

unstage()

Unstage the device.

unsubscribe(cid)

Remove a subscription

unsubscribe_all()

wait_for_connection([all_signals, timeout])

Wait for signals to connect

walk_components()

Walk all components in the Device hierarchy

walk_signals(*[, include_lazy])

Walk all signals in the Device hierarchy

walk_subdevice_classes()

Walk all sub-Devices classes in the Device hierarchy

walk_subdevices(*[, include_lazy])

Walk all sub-Devices in the hierarchy

Attributes

SUB_ACQ_DONE

SUB_DONE

SUB_READBACK

SUB_START

acceleration

A descriptor representing a device component (or signal)

attr_name

component_names

configuration_attrs

connected

If the device is connected.

direction_of_travel

A descriptor representing a device component (or signal)

dotted_name

Return the dotted name

egu

The engineering units (EGU) for a position

event_types

Events that can be subscribed to via obj.subscribe

high_limit

high_limit_switch

A descriptor representing a device component (or signal)

high_limit_travel

A descriptor representing a device component (or signal)

hints

home_forward

A descriptor representing a device component (or signal)

home_reverse

A descriptor representing a device component (or signal)

kind

lazy_wait_for_connection

limits

low_limit

low_limit_switch

A descriptor representing a device component (or signal)

low_limit_travel

A descriptor representing a device component (or signal)

motor_done_move

A descriptor representing a device component (or signal)

motor_egu

A descriptor representing a device component (or signal)

motor_is_moving

A descriptor representing a device component (or signal)

motor_stop

A descriptor representing a device component (or signal)

moving

Whether or not the motor is moving

name

name of the device

offset_freeze_switch

A descriptor representing a device component (or signal)

parent

The parent of the ophyd object.

position

The current position of the motor in its engineering units

precision

The precision of the readback PV, as reported by EPICS

read_attrs

report

A report on the object.

root

Walk parents to find ultimate ancestor (parent’s parent…).

set_use_switch

A descriptor representing a device component (or signal)

settle_time

Amount of time to wait after moves to report status completion

signal_names

timeout

Amount of time to wait before to considering a motion as failed

tolerated_alarm

trigger_signals

user_offset

A descriptor representing a device component (or signal)

user_offset_dir

A descriptor representing a device component (or signal)

user_readback

A descriptor representing a device component (or signal)

user_setpoint

A descriptor representing a device component (or signal)

velocity

A descriptor representing a device component (or signal)