pnpq.devices.odl_ozoptics_650ml 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.odl_ozoptics_650ml module#

class pnpq.devices.odl_ozoptics_650ml.OdlOzOptics(serial_port=None, serial_number=None)#

Bases: OpticalDelayLine

Parameters:

  • serial_port (str | None)

  • serial_number (str | None)

connect()#
Return type:

None

echo(on_off)#
Parameters:

on_off (int)

Return type:

str

forward()#
Return type:

str

get_device_info()#
Return type:

tuple[str, str]

get_mfg_date()#
Return type:

str

get_serial()#
Return type:

str

get_step()#
Return type:

int

home()#
Return type:

str

move(dist)#
Parameters:

dist (float)

Return type:

None

oz_mode(on_off)#
Parameters:

on_off (int)

Return type:

str

read_key(key, retries=5)#
Parameters:

  • key (str)

  • retries (int)

Return type:

str

readall()#
Return type:

tuple[bool, str]

reset()#
Return type:

str

resolution#

32768 steps per motor revolution(5.08 mm = 2xDistance Travel or mirror travel per pitch 0.1 inch)

reverse()#
Return type:

str

serial_close()#
Return type:

None

serial_command(serial_cmd)#
Parameters:

serial_cmd (str)

Return type:

str

serial_read()#
Return type:

str

serial_send(serial_cmd)#
Parameters:

serial_cmd (str)

Return type:

None

set_step(value)#
Parameters:

value (int)

Return type:

str

start_burn_in(parameter)#
Parameters:

parameter (int)

Return type:

str

stop()#
Return type:

str

write_hw_version(parameter)#
Parameters:

parameter (int)

Return type:

str

write_mfg_date(parameter)#
Parameters:

parameter (int)

Return type:

str

write_name(parameter)#
Parameters:

parameter (int)

Return type:

str

write_serial(parameter)#
Parameters:

parameter (int)

Return type:

str

write_to_flash()#
Return type:

str

class pnpq.devices.odl_ozoptics_650ml.OpticalDelayLine(port=None, serial_number=None)#

Bases: object

Base class for the OzOptics ODL driver.

Parameters:

  • port (str | None)

  • serial_number (str | None)

conn: Serial#

represents a Serial connection

device_sn: str | None#

device’s serial number

name: str#
port: str | None#

initialize ODL class

Contents