mxcubecore.HardwareObjects.ExporterMotor

Example xml file: <object class=”ExporterMotor”>

<username>phiy</username> <exporter_address>wid30bmd2s:9001</exporter_address> <actuator_name>AlignmentY</actuator_name> <tolerance>1e-2</tolerance>

</object> optional parameters, with default values. To be used only if the values differ from the default ones.

The position attribute is actuator_name+position_suffix <position_suffix>Position</position_suffix> The state attribute is actuator_name+state_suffix <state_suffix>State</state_suffix> Use the global application state instead of the motor state. <use_global_state>False</use_global_state>

Classes

ExporterMotor(name)

Motor using the Exporter protocol, based on AbstractMotor

class mxcubecore.HardwareObjects.ExporterMotor.ExporterMotor(name)

Bases: AbstractMotor

Motor using the Exporter protocol, based on AbstractMotor

abort()

Stop the motor movement immediately.

get_dynamic_limits()

Returns motor low and high dynamic limits. :returns: two floats tuple (low limit, high limit). :rtype: (tuple)

get_limits()

Returns motor low and high limits. :param cmd: command name :type cmd: str

Returns:

two floats tuple (low limit, high limit).

Return type:

(tuple)

get_max_speed()

Get the motor maximum speed. :returns: the maximim speed [unit/s]. :rtype: (float)

get_state()

Get the motor state. :returns: Motor state. :rtype: (enum ‘HardwareObjectState’)

get_value()

Get the motor position. :returns: Motor position. :rtype: (float)

home(timeout=None)

Homing procedure. :param timeout: optional - timeout [s]. :type timeout: float

init()

Initialise the motor

wait_motor_move(timeout=20)

Wait until the end of move ended using the motor state. :param timeout: Timeout [s]. Default value is 20 s :type timeout: float

Raises:

RuntimeError – Execution timeout.

wait_move(timeout=20)

Wait until the end of move ended, using the application state. :param timeout: Timeout [s]. Default value is 20 s :type timeout: float