pnpq.devices.waveplate_thorlabs_k10cr1_stub module

You are reading the documentation for the main branch, which may contain unreleased changes. The most recent release is v0.1.0.

pnpq.devices.waveplate_thorlabs_k10cr1_stub module#

class pnpq.devices.waveplate_thorlabs_k10cr1_stub.WaveplateThorlabsK10CR1Stub(*, time_scaling_factor: float = 0.0, current_velocity_params: pnpq.devices.waveplate_thorlabs_k10cr1.WaveplateVelocityParams = <factory>, current_jog_params: pnpq.devices.waveplate_thorlabs_k10cr1.WaveplateJogParams = <factory>, current_home_params: pnpq.devices.waveplate_thorlabs_k10cr1.WaveplateHomeParams = <factory>)#

Bases: AbstractWaveplateThorlabsK10CR1

Parameters:
current_home_params: WaveplateHomeParams#
current_jog_params: WaveplateJogParams#
current_state: dict[ChanIdent, Quantity]#
current_velocity_params: WaveplateVelocityParams#
get_homeparams()#

Request home parameters from the device.

Return type:

WaveplateHomeParams

get_jogparams()#

Request jog parameters from the device.

Return type:

WaveplateJogParams

get_velparams()#

Request velocity parameters from the device.

Return type:

WaveplateVelocityParams

home()#

Move the waveplate to its home position.

Return type:

None

homed: bool = False#
identify()#

Identify the device by blinking its LED.

Return type:

None

is_homed()#

Check if the device is homed. Sends the REQ_STATUSUPDATE message and checks the HOMED status bit.

Returns:

True if the device is homed, False otherwise.

Return type:

bool

jog(jog_direction)#

Jog the waveplate 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 waveplate to a certain angle.

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 (None | HomeDirection) – The home direction.

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

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

  • offset_distance (None | Quantity) – 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 (None | JogMode) – The jog mode.

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

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

  • jog_acceleration (None | Quantity) – The acceleration.

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

  • jog_stop_mode (None | StopMode) – 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