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

pnpq.devices package

Submodules

• pnpq.devices.odl_ozoptics_650ml module
  • OdlOzOptics
    • OdlOzOptics.connect()
    • OdlOzOptics.echo()
    • OdlOzOptics.forward()
    • OdlOzOptics.get_device_info()
    • OdlOzOptics.get_mfg_date()
    • OdlOzOptics.get_serial()
    • OdlOzOptics.get_step()
    • OdlOzOptics.home()
    • OdlOzOptics.move()
    • OdlOzOptics.oz_mode()
    • OdlOzOptics.read_key()
    • OdlOzOptics.readall()
    • OdlOzOptics.reset()
    • OdlOzOptics.resolution
    • OdlOzOptics.reverse()
    • OdlOzOptics.serial_close()
    • OdlOzOptics.serial_command()
    • OdlOzOptics.serial_read()
    • OdlOzOptics.serial_send()
    • OdlOzOptics.set_step()
    • OdlOzOptics.start_burn_in()
    • OdlOzOptics.stop()
    • OdlOzOptics.write_hw_version()
    • OdlOzOptics.write_mfg_date()
    • OdlOzOptics.write_name()
    • OdlOzOptics.write_serial()
    • OdlOzOptics.write_to_flash()
  • OpticalDelayLine
    • OpticalDelayLine.conn
    • OpticalDelayLine.device_sn
    • OpticalDelayLine.name
    • OpticalDelayLine.port
• pnpq.devices.odl_thorlabs_kbd101 module
  • AbstractOpticalDelayLineThorlabsKBD101
    • AbstractOpticalDelayLineThorlabsKBD101.get_homeparams()
    • AbstractOpticalDelayLineThorlabsKBD101.get_jogparams()
    • AbstractOpticalDelayLineThorlabsKBD101.get_status()
    • AbstractOpticalDelayLineThorlabsKBD101.get_velparams()
    • AbstractOpticalDelayLineThorlabsKBD101.home()
    • AbstractOpticalDelayLineThorlabsKBD101.identify()
    • AbstractOpticalDelayLineThorlabsKBD101.jog()
    • AbstractOpticalDelayLineThorlabsKBD101.move_absolute()
    • AbstractOpticalDelayLineThorlabsKBD101.set_homeparams()
    • AbstractOpticalDelayLineThorlabsKBD101.set_jogparams()
    • AbstractOpticalDelayLineThorlabsKBD101.set_velparams()
  • OpticalDelayLineHomeParams
  • OpticalDelayLineJogParams
  • OpticalDelayLineThorlabsKBD101
    • OpticalDelayLineThorlabsKBD101.connection
    • OpticalDelayLineThorlabsKBD101.get_homeparams()
    • OpticalDelayLineThorlabsKBD101.get_jogparams()
    • OpticalDelayLineThorlabsKBD101.get_status()
    • OpticalDelayLineThorlabsKBD101.get_velparams()
    • OpticalDelayLineThorlabsKBD101.home()
    • OpticalDelayLineThorlabsKBD101.home_on_init
    • OpticalDelayLineThorlabsKBD101.identify()
    • OpticalDelayLineThorlabsKBD101.jog()
    • OpticalDelayLineThorlabsKBD101.log
    • OpticalDelayLineThorlabsKBD101.move_absolute()
    • OpticalDelayLineThorlabsKBD101.set_channel_enabled()
    • OpticalDelayLineThorlabsKBD101.set_homeparams()
    • OpticalDelayLineThorlabsKBD101.set_jogparams()
    • OpticalDelayLineThorlabsKBD101.set_velparams()
  • OpticalDelayLineVelocityParams
• pnpq.devices.odl_thorlabs_kbd101_stub module
  • OpticalDelayLineThorlabsKBD101Stub
    • OpticalDelayLineThorlabsKBD101Stub.current_home_params
    • OpticalDelayLineThorlabsKBD101Stub.current_jog_params
    • OpticalDelayLineThorlabsKBD101Stub.current_state
    • OpticalDelayLineThorlabsKBD101Stub.current_velocity_params
    • OpticalDelayLineThorlabsKBD101Stub.get_homeparams()
    • OpticalDelayLineThorlabsKBD101Stub.get_jogparams()
    • OpticalDelayLineThorlabsKBD101Stub.get_status()
    • OpticalDelayLineThorlabsKBD101Stub.get_velparams()
    • OpticalDelayLineThorlabsKBD101Stub.home()
    • OpticalDelayLineThorlabsKBD101Stub.identify()
    • OpticalDelayLineThorlabsKBD101Stub.jog()
    • OpticalDelayLineThorlabsKBD101Stub.log
    • OpticalDelayLineThorlabsKBD101Stub.move_absolute()
    • OpticalDelayLineThorlabsKBD101Stub.set_homeparams()
    • OpticalDelayLineThorlabsKBD101Stub.set_jogparams()
    • OpticalDelayLineThorlabsKBD101Stub.set_velparams()
    • OpticalDelayLineThorlabsKBD101Stub.time_scaling_factor
• pnpq.devices.polarization_controller_thorlabs_mpc module
  • AbstractPolarizationControllerThorlabsMPC
    • AbstractPolarizationControllerThorlabsMPC.get_params()
    • AbstractPolarizationControllerThorlabsMPC.get_status()
    • AbstractPolarizationControllerThorlabsMPC.get_status_all()
    • AbstractPolarizationControllerThorlabsMPC.home()
    • AbstractPolarizationControllerThorlabsMPC.identify()
    • AbstractPolarizationControllerThorlabsMPC.jog()
    • AbstractPolarizationControllerThorlabsMPC.move_absolute()
    • AbstractPolarizationControllerThorlabsMPC.set_channel_enabled()
    • AbstractPolarizationControllerThorlabsMPC.set_params()
  • PolarizationControllerParams
  • PolarizationControllerThorlabsMPC
    • PolarizationControllerThorlabsMPC.available_channels
    • PolarizationControllerThorlabsMPC.connection
    • PolarizationControllerThorlabsMPC.get_params()
    • PolarizationControllerThorlabsMPC.get_status()
    • PolarizationControllerThorlabsMPC.get_status_all()
    • PolarizationControllerThorlabsMPC.home()
    • PolarizationControllerThorlabsMPC.identify()
    • PolarizationControllerThorlabsMPC.jog()
    • PolarizationControllerThorlabsMPC.log
    • PolarizationControllerThorlabsMPC.move_absolute()
    • PolarizationControllerThorlabsMPC.set_channel_enabled()
    • PolarizationControllerThorlabsMPC.set_params()
  • PolarizationControllerThorlabsMPC220
    • PolarizationControllerThorlabsMPC220.available_channels
  • PolarizationControllerThorlabsMPC320
    • PolarizationControllerThorlabsMPC320.available_channels
• pnpq.devices.polarization_controller_thorlabs_mpc_stub module
  • PolarizationControllerThorlabsMPC320Stub
    • PolarizationControllerThorlabsMPC320Stub.available_channels
    • PolarizationControllerThorlabsMPC320Stub.current_params
    • PolarizationControllerThorlabsMPC320Stub.current_state
    • PolarizationControllerThorlabsMPC320Stub.get_params()
    • PolarizationControllerThorlabsMPC320Stub.get_status()
    • PolarizationControllerThorlabsMPC320Stub.get_status_all()
    • PolarizationControllerThorlabsMPC320Stub.home()
    • PolarizationControllerThorlabsMPC320Stub.identify()
    • PolarizationControllerThorlabsMPC320Stub.jog()
    • PolarizationControllerThorlabsMPC320Stub.log
    • PolarizationControllerThorlabsMPC320Stub.move_absolute()
    • PolarizationControllerThorlabsMPC320Stub.set_channel_enabled()
    • PolarizationControllerThorlabsMPC320Stub.set_params()
    • PolarizationControllerThorlabsMPC320Stub.time_scaling_factor
• pnpq.devices.switch_thorlabs_osw_e module
  • AbstractOpticalSwitchThorlabsE
    • AbstractOpticalSwitchThorlabsE.close()
    • AbstractOpticalSwitchThorlabsE.get_board_name()
    • AbstractOpticalSwitchThorlabsE.get_state()
    • AbstractOpticalSwitchThorlabsE.get_type_code()
    • AbstractOpticalSwitchThorlabsE.open()
    • AbstractOpticalSwitchThorlabsE.set_state()
  • OpticalSwitchThorlabsE
    • OpticalSwitchThorlabsE.close()
    • OpticalSwitchThorlabsE.get_board_name()
    • OpticalSwitchThorlabsE.get_state()
    • OpticalSwitchThorlabsE.get_type_code()
    • OpticalSwitchThorlabsE.open()
    • OpticalSwitchThorlabsE.serial_config
    • OpticalSwitchThorlabsE.serial_number
    • OpticalSwitchThorlabsE.set_state()
  • SerialConfig
    • SerialConfig.baudrate
    • SerialConfig.bytesize
    • SerialConfig.exclusive
    • SerialConfig.parity
    • SerialConfig.rtscts
    • SerialConfig.stopbits
    • SerialConfig.timeout
    • SerialConfig.write_timeout
  • State
    • State.BAR
    • State.CROSS
• pnpq.devices.switch_thorlabs_osw_e_stub module
  • OpticalSwitchThorlabsEStub
    • OpticalSwitchThorlabsEStub.close()
    • OpticalSwitchThorlabsEStub.get_board_name()
    • OpticalSwitchThorlabsEStub.get_state()
    • OpticalSwitchThorlabsEStub.get_type_code()
    • OpticalSwitchThorlabsEStub.open()
    • OpticalSwitchThorlabsEStub.set_state()
• pnpq.devices.utils module
  • TimeoutException
  • check_usb_hub_connected()
  • get_available_port()
  • timeout()
• pnpq.devices.waveplate_thorlabs_k10cr1 module
  • AbstractWaveplateThorlabsK10CR1
    • AbstractWaveplateThorlabsK10CR1.get_homeparams()
    • AbstractWaveplateThorlabsK10CR1.get_jogparams()
    • AbstractWaveplateThorlabsK10CR1.get_velparams()
    • AbstractWaveplateThorlabsK10CR1.home()
    • AbstractWaveplateThorlabsK10CR1.identify()
    • AbstractWaveplateThorlabsK10CR1.is_homed()
    • AbstractWaveplateThorlabsK10CR1.jog()
    • AbstractWaveplateThorlabsK10CR1.move_absolute()
    • AbstractWaveplateThorlabsK10CR1.set_homeparams()
    • AbstractWaveplateThorlabsK10CR1.set_jogparams()
    • AbstractWaveplateThorlabsK10CR1.set_velparams()
  • WaveplateHomeParams
  • WaveplateJogParams
  • WaveplateThorlabsK10CR1
    • WaveplateThorlabsK10CR1.connection
    • WaveplateThorlabsK10CR1.get_homeparams()
    • WaveplateThorlabsK10CR1.get_jogparams()
    • WaveplateThorlabsK10CR1.get_velparams()
    • WaveplateThorlabsK10CR1.home()
    • WaveplateThorlabsK10CR1.home_on_init
    • WaveplateThorlabsK10CR1.identify()
    • WaveplateThorlabsK10CR1.is_homed()
    • WaveplateThorlabsK10CR1.jog()
    • WaveplateThorlabsK10CR1.log
    • WaveplateThorlabsK10CR1.move_absolute()
    • WaveplateThorlabsK10CR1.set_channel_enabled()
    • WaveplateThorlabsK10CR1.set_homeparams()
    • WaveplateThorlabsK10CR1.set_jogparams()
    • WaveplateThorlabsK10CR1.set_velparams()
  • WaveplateVelocityParams
• pnpq.devices.waveplate_thorlabs_k10cr1_stub module
  • WaveplateThorlabsK10CR1Stub
    • WaveplateThorlabsK10CR1Stub.current_home_params
    • WaveplateThorlabsK10CR1Stub.current_jog_params
    • WaveplateThorlabsK10CR1Stub.current_state
    • WaveplateThorlabsK10CR1Stub.current_velocity_params
    • WaveplateThorlabsK10CR1Stub.get_homeparams()
    • WaveplateThorlabsK10CR1Stub.get_jogparams()
    • WaveplateThorlabsK10CR1Stub.get_velparams()
    • WaveplateThorlabsK10CR1Stub.home()
    • WaveplateThorlabsK10CR1Stub.homed
    • WaveplateThorlabsK10CR1Stub.identify()
    • WaveplateThorlabsK10CR1Stub.is_homed()
    • WaveplateThorlabsK10CR1Stub.jog()
    • WaveplateThorlabsK10CR1Stub.log
    • WaveplateThorlabsK10CR1Stub.move_absolute()
    • WaveplateThorlabsK10CR1Stub.set_homeparams()
    • WaveplateThorlabsK10CR1Stub.set_jogparams()
    • WaveplateThorlabsK10CR1Stub.set_velparams()
    • WaveplateThorlabsK10CR1Stub.time_scaling_factor

Module contents