ESP 300 Motion Controller

class pymeasure.instruments.newport.ESP300(adapter, name='Newport ESP 300 Motion Controller', **kwargs)

Bases: SCPIMixin, Instrument

Represents the Newport ESP 300 Motion Controller and provides a high-level for interacting with the instrument.

By default this instrument is constructed with 3 axes. Axes are controlled through an Axis class.

clear_errors()

Clears the error messages by checking until a 0 code is received.

disable()

Disables all of the axes associated with this controller.

enable()

Enables all of the axes associated with this controller.

property error: Any

Get an error code from the motion controller.

property errors

Get a list of error Exceptions that can be later raised, or used to diagnose the situation.

property phi

Get the third axis of the controller.

Deprecated since version 0.17.0: Use axes[2] instead.

shutdown()

Shuts down the controller by disabling all of the axes.

property x

Get the first axis of the controller.

Deprecated since version 0.17.0: Use axes[0] instead.

property y

Get the second axis of the controller.

Deprecated since version 0.17.0: Use axes[1] instead.

class pymeasure.instruments.newport.esp300.Axis(axis, controller)

Bases: object

Represents an axis of the Newport ESP300 Motor Controller, which can have independent parameters from the other axes.

define_position(position)

Overwrites the value of the current position with the given value.

disable()

Disables motion for the axis.

enable()

Enables motion for the axis.

property enabled: Any

Returns a boolean value that is True if the motion for this axis is enabled.

home(type=1)

Drives the axis to the home position, which may be the negative hardware limit for some actuators (e.g. LTA-HS). type can take integer values from 0 to 6.

property left_limit: Any

A floating point property that controls the left software limit of the axis.

property motion_done: Any

Returns a boolean that is True if the motion is finished.

property position: Any

A floating point property that controls the position of the axis. The units are defined based on the actuator. Use the wait_for_stop() method to ensure the position is stable.

property right_limit: Any

A floating point property that controls the right software limit of the axis.

property units: Any

A string property that controls the displacement units of the axis, which can take values of: encoder count, motor step, millimeter, micrometer, inches, milli-inches, micro-inches, degree, gradient, radian, milliradian, and microradian.

wait_for_stop(delay=0, interval=0.05)

Blocks the program until the motion is completed. A further delay can be specified in seconds.

zero()

Resets the axis position to be zero at the current poisiton.

class pymeasure.instruments.newport.esp300.AxisError(code)

Bases: Exception

Raised when a particular axis causes an error for the Newport ESP300.

class pymeasure.instruments.newport.esp300.GeneralError(code)

Bases: Exception

Raised when the Newport ESP300 has a general error.