T-Cube DC Servo Motor Controller (TDC001)¶
Driver for controlling Thorlabs TDC001 T-Cube DC Servo Motor Controllers using the Kinesis SDK.
One must place Thorlabs.MotionControl.DeviceManager.dll and Thorlabs.MotionControl.TCube.DCServo.dll in the path.
-
exception
instrumental.drivers.motion.tdc_001.
TDC001Error
¶
-
class
instrumental.drivers.motion.tdc_001.
SoftwareApproachPolicy
¶ -
AllowAll
= 3¶
-
DisableFarOutsideRange
= 1¶
-
DisableOutsideRange
= 0¶
-
TruncateBeyondLimit
= 2¶
-
-
class
instrumental.drivers.motion.tdc_001.
TDC001
(serial, polling_period=<Mock object>, allow_all_moves=True)¶ Controlling Thorlabs TDC001 T-Cube DC Servo Motor Controllers
Takes the serial number of the device as a string.
The polling period, which is how often the device updates its status, is passed as a pint pint quantity with units of time and is optional argument, with a default of 200ms
-
class
Status
(status_bits)¶ Stores information about the status of the device from the status bits.
-
__init__
(status_bits)¶
-
-
TDC001.
__init__
(serial, polling_period=<Mock object>, allow_all_moves=True)¶ Parameters: - serial_number (str) –
- polling_period (pint quantity with units of time) –
-
TDC001.
at_position
(position, tol=1)¶ Indicates whether the motor is at the given position.
Parameters: - position (pint quantity of units self.real_world_units) –
- tol (int representing the number of encoder counts within which the) –
- is considered to be at position (motor) –
-
TDC001.
close
()¶ Closes the connectin to the device
-
TDC001.
get_motor_params
()¶ Gets the stage motor parameters.
Returns: - (steps_per_rev (int,)
- gearbox_ratio (int,)
- pitch (float))
-
TDC001.
get_position
()¶ Returns the position of the motor.
Note that this represents the position at the most recent polling event.
-
TDC001.
get_status
()¶ Returns the status registry bits from the device.
-
TDC001.
home
()¶ Homes the device
-
TDC001.
move_and_wait
(position, delay='100ms', tol=1)¶ Moves to the indicated position and waits until that position is reached.
Parameters: - position (pint quantity of units self.real_world_units) –
- delay (pint quantity with units of time) – the period with which the position of the motor is checked.
- tol (int) – the tolerance, in encoder units, to which the motor is considered at position
-
TDC001.
move_to
(position)¶ Moves to the indicated position
Returns immediately.
Parameters: position (pint quantity of units self.real_world_units) –
-
class
-
instrumental.drivers.motion.tdc_001.
list_instruments
()¶