pnpq.devices.odl_thorlabs_kbd101_stub module

pnpq.devices.odl_thorlabs_kbd101_stub module#

class pnpq.devices.odl_thorlabs_kbd101_stub.OpticalDelayLineThorlabsKBD101Stub(*, time_scaling_factor: float = 0.0, current_velocity_params: pnpq.devices.odl_thorlabs_kbd101.OpticalDelayLineVelocityParams = <factory>, current_home_params: pnpq.devices.odl_thorlabs_kbd101.OpticalDelayLineHomeParams = <factory>, current_jog_params: pnpq.devices.odl_thorlabs_kbd101.OpticalDelayLineJogParams = <factory>)#

Bases: AbstractOpticalDelayLineThorlabsKBD101

Parameters:
current_home_params: OpticalDelayLineHomeParams#
current_jog_params: OpticalDelayLineJogParams#
current_state: dict[ChanIdent, Quantity]#
current_velocity_params: OpticalDelayLineVelocityParams#
get_homeparams()#

Request home parameters from the device.

Return type:

OpticalDelayLineHomeParams

get_jogparams()#

Request jog parameters from the device.

Return type:

OpticalDelayLineJogParams

get_status()#

Request the latest status message from the device.

Return type:

AptMessage_MGMSG_MOT_GET_USTATUSUPDATE

get_velparams()#

Request velocity parameters from the device.

Return type:

OpticalDelayLineVelocityParams

home()#

Move the device to home position.

Return type:

None

identify()#

Identifies the device represented by this instance by flashing the light on the device.

Parameters:

chan_ident – The motor channel to identify.

Return type:

None

jog(jog_direction)#

Jog the device in a certain direction.

Parameters:

jog_direction (JogDirection) – The direction to jog in.

Return type:

None

log = <BoundLoggerLazyProxy(logger=None, wrapper_class=None, processors=None, context_class=None, initial_values={}, logger_factory_args=())>#
move_absolute(position)#

Move the device to the specified position.

Parameters:

position (Quantity) – The angle to move to.

Return type:

None

set_homeparams(home_direction=None, limit_switch=None, home_velocity=None, offset_distance=None)#

Set home parameters on the device.

All parameters of this function are optional. Only fields with values are updated on the device.

Parameters:

  • home_direction (HomeDirection | None) – The home direction.

  • limit_switch (LimitSwitch | None) – The limit switch.

  • home_velocity (Quantity | None) – The home velocity.

  • offset_distance (Quantity | None) – The offset distance.

Return type:

None

set_jogparams(jog_mode=None, jog_step_size=None, jog_minimum_velocity=None, jog_acceleration=None, jog_maximum_velocity=None, jog_stop_mode=None)#

Set jog parameters on the device.

All parameters of this function are optional. Only fields with values are updated on the device.

Parameters:

  • jog_mode (JogMode | None) – The jog mode.

  • jog_step_size (Quantity | None) – The jog step size.

  • jog_minimum_velocity (Quantity | None) – The minimum velocity.

  • jog_acceleration (Quantity | None) – The acceleration.

  • jog_maximum_velocity (Quantity | None) – The maximum velocity.

  • jog_stop_mode (StopMode | None) – The stop mode.

Return type:

None

set_velparams(minimum_velocity=None, acceleration=None, maximum_velocity=None)#

Set velocity parameters on the device.

All parameters of this function are optional. Only fields with values are updated on the device.

Parameters:

  • minimum_velocity (None | Quantity) – The minimum velocity. According to the documentation, this should always be 0. Therefore this parameter can be left unused.

  • acceleration (None | Quantity) – The acceleration.

  • maximum_velocity (None | Quantity) – The maximum velocity.

Return type:

None

time_scaling_factor: float = 0.0#
Contents