mxcubecore.HardwareObjects.abstract.AbstractMotor#

Abstract Motor class. Defines the MotorStates enum, get/set velocity, home and set_value_relative methods. Emits signals valueChanged and limitsChanged.

Classes

`AbstractMotor`(name)	Abstract motor class
`MotorStates`(value)	Motor states definitions.

class mxcubecore.HardwareObjects.abstract.AbstractMotor.AbstractMotor(name)[source]#

Bases: AbstractActuator

Abstract motor class

SPECIFIC_STATES#: alias of MotorStates

get_velocity()[source]#: Read motor velocity. :returns: velocity [unit/s] :rtype: (float)

home(timeout=None)[source]#: Homing procedure. :param timeout: Timeout [s]. :type timeout: float

init()[source]#: Initialise tolerance property

set_value_relative(relative_value, timeout=0)[source]#

Set actuator to relative to the current value :param value: target value :type value: float :param timeout: optional - timeout [s],

If timeout == 0: return at once and do not wait; if timeout is None: wait forever.

set_velocity(velocity)[source]#: Set the motor velocity :param velocity: target velocity :type velocity: float

update_value(value=None)[source]#: Check if the value has changed. Emits signal valueChanged. :param value: value :type value: float

class mxcubecore.HardwareObjects.abstract.AbstractMotor.MotorStates(value)[source]#

Bases: Enum

Motor states definitions.