instruments package

Submodules

instruments.AEDFA_IL_23_B_FA module

instruments.Agilent34401A module

class instruments.Agilent34401A.Agilent34401A(res_manager, address=’GPIB0::22::INSTR’)

Bases: object

This class models the Agilent 34401A Multimeter.

change_state()

close()

Release resource.

get_current(query_range=1, resolution=1e-06)

Queries the current reading of the multimeter

Parameters:

• query_range (Integer) – range for query
• resolution (Float) – resolution for query

Returns:

current reading as float

get_feedback()

Requirement for generic feedback

get_scaling()

Gets the scaling factor.

Returns:Scaling factor as Int or Float

get_voltage(scaled=False, query_range=10, resolution=0.01)

Queries the voltage of multimeter.

Parameters:

• scaled (Boolean) – Optional scaling
• query_range (Integer) – range for query
• resolution (Float) – resolution for query

Returns:

current voltage reading as float

set_scaling(factor=1)

Sets the scaling factor of the multimeter instrument.

Parameters:factor (Float or Integer) – Desired factor

whoAmI()

Returns:reference to device

instruments.AgilentE3643A module

class instruments.AgilentE3643A.AgilentE3643A(res_manager, address=’YourAddressHere’)

Bases: object

This class models the Agilent DC power supply.

change_state()

Toggles the self.active parameter

close()

Release resources, closes serial port. :raises: Exception when serial communication port is not open

get_current()

Gets the current. :return: the measured DC current :raises: Exception when serial communication port is not open

get_voltage()

Gets the voltage. :return: the measured DC voltage :raises: Exception when serial communication port is not open

open()

Opens serial connection. :raises: Exception when serial communication port is not open

recall_state(mem=1)

Loads stored state from specified memory location

Parameters:mem (Integer) – Specified space to query

save_state(mem=1)

Stores state within non-volatile memory

Parameters:mem (Integer) – Specified space to write to

setCurrent(value=0)

Sets the current.

Parameters:value (float) – Specified current value, defaults to 0 Raises:Exception when serial communication port is not open

setOutputSwitch(value=0)

Set the output switch to 1 -> ON or 0 -> OFF

Parameters:value (Integer) – Specified state, defaults to 0 for OFF, 1 for ON Raises:Exception when serial communication port is not open or value is not 0 or 1

setVoltage(value=0)

Sets the voltage.

Parameters:value (float) – Specified voltage value, defaults to 0 Raises:Exception when serial communication port is not open

setovervoltage(value=0)

Sets the over voltage.

Parameters:value (float) – Specified voltage value, defaults to 0 Raises:Exception when serial communication port is not open

whoAmI()

Returns:reference to device

instruments.AndoAQ4321 module

class instruments.AndoAQ4321.AndoAQ4321(res_manager, address=’GPIB0::24::INSTR’)

Bases: object

This class models the AndoAQ4321 laser.

Note

When using any laser command, remember to send shut-off-laser command at the end of each sweep command set. For Trigger Sweep, send shut-off-laser command after sweep ends (sweep end condition noted in TriggerSweepSetup function)

change_state()

checkStatus()

Checks the status of the laser. Handles timeout exception

Returns:Boolean

checkStatusSingle()

Checks the status of the laser. Handles timeout exception

Returns:Boolean

get_max_wavelength()

Queries the maximum allowed wavelength

Returns:Integer

get_min_wavelength()

Queries the minimum allowed wavelength

Returns:Integer

getpower()

Gets output power in dbm

Returns:Float

getwavelength()

Queries wavelength of the laser

Returns:Float

manualStep(step)

Use if want to manually step by a particular size, in conjuction with Send Single Wavelength

Parameters:step (Float) – specified step increment, but be greater than or equal to 0.001

outputOFF()

Turns output of laser source OFF

Note

Output occasionally doesn’t turn off unless turned ON beforehand

pauseSweep()

Suspend sweep

resumeSweep()

Use after pause to resume, still have to call trigger() for next data point if using with trigger sweep

setpower(power=0)

Sets power in dbm

Parameters:power (Integer) – Specified power to set the laser to in dbm

setwavelength(wavelength)

Loads a single wavelength and sets output high

Parameters:waveLength (Integer) – Specified wavelength

stopSweep()

Stop sweep

sweepWavelengthsContinuous(start, end, time)

Executes a sweep with respect to a specified time

Parameters:

• start (Integer) – Specified wavelength between 1520-1580
• end (Integer) – Specified wavelength between 1520-1580
• time (Float) – Specified time

sweepWavelengthsStep(start, end, step)

Executes a sweep with respect to a specified step

Parameters:

• start (Integer) – Specified wavelength between 1520-1580
• end (Integer) – Specified wavelength between 1520-1580
• step (Float) – Specified step must be greater or equal to than 0.001

sweepWavelengthsTriggerSetup(start, end, step)

Have to keep track of Triggers in main command, use Stop Sweep Command to end sweep. Extra triggers do not make the laser sweep outside of specified end wavelength. Remeber to shut off laser after sweep ends

Parameters:

• start (Integer) – Specified wavelength between 1520-1580
• end (Integer) – Specified wavelength between 1520-1580
• time (Float) – Specified time

trigger()

Triggers laser

whoAmI()

Returns:reference to device

instruments.AnritsuMS2667C module

class instruments.AnritsuMS2667C.AnritsuMS2667C(res_manager, address=’GPIB0::23::INSTR’)

Bases: object

This class models a Spectrum Analyzer

change_state()

getPeak(central, span)

Queries the peak for a specified central and span.

Parameters:

• central (Float) – Specified central
• span (Float) – Specified span

Returns:

Tuple of readings

waveformReadCentral(central, span, resolutionStep=1)

Queries the wave form

Parameters:

• central (Float) – Specified central
• span (Float) – Specified span
• resolutionStep (Integer) – Defaults to 1; specified step size

Returns:

List of readings

waveformReadRange(start, end, resolutionStep=1)

Queries the wave form

Parameters:

• start (Float) – Specified start
• end (Float) – Specified end
• resolutionStep (Integer) – Defaults to 1; specified step size

Returns:

List of readings

whoAmI()

Returns:reference to device

instruments.AragonBOSA400 module

class instruments.AragonBOSA400.AragonBOSA400(res_manager, address=‘128.59.65.231’)

Bases: object

This class models the AndoAQ4321 laser.

Note

When using any laser command, remember to send shut-off-laser command at the end of each sweep command set. For Trigger Sweep, send shut-off-laser command after sweep ends (sweep end condition noted in TriggerSweepSetup function)

change_state()

getAuxInputPower()

getIL(start, end, step, polarization)

Executes a sweep with respect to a specified time and collect injection loss information

Parameters:

• start (Integer) – Specified wavelength between 1520-1580
• end (Integer) – Specified wavelength between 1520-1580
• step (String) – Specified step
• step – polarization mode

getRL(start, end, step, polarization)

Executes a sweep with respect to a specified time and collect reflection loss information

Parameters:

• start (Integer) – Specified wavelength between 1520-1580
• end (Integer) – Specified wavelength between 1520-1580
• step (String) – Specified step
• step – polarization mode

getSpectrum(start, end, step, polarization)

Executes a sweep with respect to a specified time and collect reflection loss information

Parameters:

• start (Integer) – Specified wavelength between 1520-1580
• end (Integer) – Specified wavelength between 1520-1580
• step (String) – Specified step
• step – polarization mode

NOTE: polarization arg doesn’t do anything yet!

get_feedback()

get_max_wavelength()

Queries the maximum allowed wavelength

Returns:Integer

get_min_wavelength()

Queries the minimum allowed wavelength

Returns:Integer

getpower()

Gets output power in dbm

Returns:Float

getwavelength()

Queries wavelength of the laser

Returns:Float

outputOFF()

Turns output of laser source OFF

outputON()

Turns output of laser source OFF

setpower(wavelength)

BOSA cannot adjust output power - raise exception

setwavelength(wavelength)

Loads a single wavelength (in nanometers) and sets output high

Parameters:waveLength (Integer) – Specified wavelength

stopSweep()

Stop sweep

sweepWavelengthsContinuous(start, end, time)

Executes a sweep with respect to a specified time

Parameters:

• start (Integer) – Specified wavelength between 1520-1580
• end (Integer) – Specified wavelength between 1520-1580
• time (Float) – Specified time

sweepWavelengthsTriggerSetup(start, end, step)

Have to keep track of Triggers in main command, use Stop Sweep Command to end sweep. Extra triggers do not make the laser sweep outside of specified end wavelength. Remeber to shut off laser after sweep ends

Parameters:

• start (Integer) – Specified wavelength between 1520-1580
• end (Integer) – Specified wavelength between 1520-1580
• step (Float) – Specified step in nm

trigger()

Triggers laser - Now this just starts the sweep

whoAmI()

Returns:reference to device

class instruments.AragonBOSA400.BOSA(interfaceType, location, portNo=10000, IDN=True, Reset=False)

class BOSA: driver used to communicate with BOSA equipment

ask(command)

writes and reads data

connectLan()

connect the instrument to a LAN

read()

read something from device

write(command)

write to equiment: independent of the interface Parameters:

command -> data to send to device +

exception instruments.AragonBOSA400.BOSAException

Bases: exceptions.Exception

instruments.AragonBOSA400.check_response(command, response, OK=False)

instruments.AragonBOSA400.nm_to_ghz(nm)

instruments.DSensor_ILD1420 module

class instruments.DSensor_ILD1420.DSensor_ILD1420(COM_Port, sensor_model=42)

Bases: object

Error(err)

Read errors from sensor

InterfaceRS422()

close()

open()

poll(n=1)

Retrieves last n values from sensor

instruments.DSensor_ILD1420.Error(err, sensor)

Read errors from sensor

instruments.ELL8 module

class instruments.ELL8.ELL8(ser)

Bases: object

abs_move(steps)

rotate the stage by specified # of steps

close()

releases motor control

delta_move(steps)

rotate the stage by specified # of steps

get_position()

return the motors current position

home()

homes the stage

move_complete()

set_as_zero(zer_deg)

change the origin (zero)

set_vel_params(vel)

Set the velocity parameters for the motor in terms of percentage of max

instruments.ELL8.hexString(data)

Creates a string that is a byte sequense of the hex values input e.g. data = ‘0A 23 34 56’

instruments.ELL8.int2hexStr(integer, nb)

Convert an integer to its corresponding bytearray

integer (int): the number we want to convert nb (int): the number of bytes

instruments.GonStage_KST_Z812B module

class instruments.GonStage_KST_Z812B.GonStage_KST_Z812B(ser, GNL_model)

Bases: instruments.Motor_KST_ZST.Motor_KST_ZST

abs_rot(degs)

Absolute translation on the motor

degs (float): the millmeters of rotation (negative -> backwards)

check_abs_transl(dist)

Check wether a move to position ‘dist’ is in range

delta_rot(degs)

Relative translation on the motor

degs (float): the millimeters of rotation (negative -> backwards)

get_deg_pos()

return the motors current position, in millimeters

home()

Puts the motor to backward limit position, so that the position markers make sense

set_as_zero(zer_deg)

change the origin (zero)

instruments.HP6624A module

class instruments.HP6624A.HP6624A(res_manager, address=’GPIB0::1::INSTR’)

Bases: object

This class models a MULTIPLE OUTPUT LINEAR SYSTEM.

change_state()

getOCswitch(channel=1)

Queries the OC switch of a specified channel

Parameters:channel (Integer) – Specified channel to query Returns:Integer

getoutcurrent(channel=1)

Queries the out-current of a specified channel

Parameters:channel (Integer) – Specified channel to query Returns:Integer

getoutswitch(channel=1)

Queries the out switch of a specified channel

Parameters:channel (Integer) – Specified channel to query Returns:Integer

getoutvoltage(channel=1)

Queries the voltage of a specified channel

Parameters:channel (Integer) – Specified channel to query Returns:Integer

getsetcurrent(channel=1)

Queries the current of a specified channel

Parameters:channel (Integer) – Specified channel to query Returns:Integer

getsetvoltage(channel=1)

Queries the voltage of a specified channel

Parameters:channel (Integer) – Specified channel to query Returns:Integer

recall_state(mem=1)

Loads stored state from specified memory location

Parameters:mem (Integer) – Specified space to query

save_state(mem=1)

Stores state within non-volatile memory

Parameters:mem (Integer) – Specified space to write to

setOCSwitch(value=0, channel=1)

Set the OC Switch

Parameters:

• value (Integer) – Specified value to set channel to
• channel (Integer) – Specified channel to set

setOutputSwitch(value=0, channel=1)

Set the output Switch

Parameters:

• value (Integer) – Specified output value to set channel to
• channel (Integer) – Specified channel to set

setcurrent(value=0, channel=1)

Set the current

Parameters:

• value (Integer) – Specified current to set channel to
• channel (Integer) – Specified channel to set

setovervoltage(value=0, channel=1)

Set the over-voltage

Parameters:

• value (Integer) – Specified over-voltage to set channel to
• channel (Integer) – Specified channel to set

setvoltage(value=0, channel=1)

Set the voltage

Parameters:

• value (Integer) – Specified voltage to set channel to
• channel (Integer) – Specified channel to set

whoAmI()

Returns:reference to device

instruments.HP8163A module

class instruments.HP8163A.HP8163A(res_manager, address=’GPIB0::14::INSTR’, channel=1)

Bases: object

This class models a Powermeter Agilent 8163A/B Lightwave Multimeter.

CURRENT_CHANNEL = 1

change_state()

close()

Release resources

config_meter(range)

get_feedback()

get_power(wavelength=1550)

return power meter reading after setting correct wavelength

get_result_from_log(samples=64)

prep_measure_on_trigger(samples=64)

whoAmI()

Returns:reference to device

instruments.Keithley2280S module

class instruments.Keithley2280S.Keithley2280S(res_manager, address=‘169.254.115.242’, channel=1)

Bases: object

This class models a DC Source Meter 2280S from Keithley.

CURRENT_CHANNEL = 1

change_state()

close_connection()

getOCswitch(channel=1)

get_current(channel=1)

get_voltage(channel=1)

getoutcurrent(channel=1)

getoutswitch(channel=1)

getoutvoltage(channel=1)

getsetcurrent(channel=1)

getsetvoltage(channel=1)

recall_state(mem=1)

save_state(mem=1)

setOCSwitch(value=0, channel=1)

setOutputSwitch(value=0, channel=’CH1’)

setcurrent(value=0, channel=1)

setovercurrent(value=0, channel=1)

setovervoltage(value=0, channel=1)

setvoltage(value=0, channel=1)

whoAmI()

Returns:reference to device

instruments.Keithley2400 module

class instruments.Keithley2400.Keithley2400(res_manager, address=’GPIB0::21::INSTR’)

Bases: object

This class models the Keithley Model 2400 Series SourceMeter DC-Source

change_state()

close()

Release resources

get_current(query_range=1, resolution=1e-06)

Get the current

Parameters:

• query_range (Integer) – Specified range value, defaults to 10
• resolution (Float) – Specified resoultion to query, defaults to 0.000001

Returns:

Float

get_voltage(query_range=10, resolution=0.01)

Get the voltage

Parameters:

• query_range (Integer) – Specified range value, defaults to 10
• resolution (Float) – Specified resoultion to query, defaults to 0.01

Returns:

Float

getoutcurrent()

Queries the current out-current

Returns:Float

getoutswitch()

Queries the current out-switch

Returns:String

getoutvoltage()

Queries the current out-voltage

Returns:Float

getsetcurrent()

Queries the current

Returns:String

getsetvoltage()

Queries the current voltage

Returns:String

recall_state(mem=1)

Loads stored state from specified memory location

Parameters:mem (Integer) – Specified space to query

save_state(mem=1)

Stores state within non-volatile memory

Parameters:mem (Integer) – Specified space to write to

setOutputSwitch(value=0)

Set the output switch to 1 -> ON or 0 -> OFF

Parameters:value (Integer) – Specified state, defaults to 0 for OFF, 1 for ON

setcurrent(value=0)

Set the current

Parameters:value (Integer) – Specified voltage value, defaults to 0

setovercurrent(value=0)

Set the over current

Parameters:value (Integer) – Specified current value, defaults to 0

setovervoltage(value=0)

Set the over voltage

Parameters:value (Integer) – Specified voltage value, defaults to 0

setvoltage(value=0)

Set the voltage

Parameters:value (Integer) – Specified voltage value, defaults to 0

whoAmI()

Returns:reference to device

instruments.Motor_KST_ZST module

class instruments.Motor_KST_ZST.Motor_KST_ZST(serial)

Bases: object

This class models a motor for stages

abs_move(steps)

Relative rotation on the motor

Parameters:steps (Integer) – the endpoint of motion

close()

releases motor resources

delta_move(steps)

Relative rotation onpos the motor

Parameters:steps (Integer) – the number of steps to move (negative -> backwards)

get_position()

return the motors current position

move_complete()

Waits until the MOVE_COMPLETE message is received by the controller. Helper-function for delta_move() and abs_move() functions.

set_as_zero(new_zero)

change the origin (zero)

set_vel_params(vel_init, accel, vel_fin)

Set the velocity parameters for the motor

Parameters:

• vel_init (Integer) – initial velocity (steps / sec)
• accel (Integer) – acceleration (steps / sec^2)
• vel_fin (Integer) – max(final) velocity (steps / sec)

instruments.Motor_KST_ZST.hexString(data)

Creates a string that is a byte sequense of the hex values input :param data: Example is ‘0A 23 34 56’

instruments.Motor_KST_ZST.int2hexStr(integer, numberOfBytes)

Convert an integer to its corresponding bytearray

Parameters:

• integer (Integer) – the number we want to convert
• numberOfBytes (Integer) – The number of bytes

Returns:

Mutable sequence of integers of type bytearray

instruments.Motor_MST_DRV module

class instruments.Motor_MST_DRV.Motor_MST_DRV(serial, bay=0, chan=1)

Bases: object

This class models a motor for stages

abs_move(steps)

Relative rotation on the motor

Parameters:steps (Integer) – the endpoint of motion

close()

releases motor resources

delta_move(steps)

Relative rotation onpos the motor

Parameters:steps (Integer) – the number of steps to move (negative -> backwards)

get_position()

return the motors current position

move_complete()

Waits until the MOVE_COMPLETE message is received by the controller. Helper-function for delta_move() and abs_move() functions.

set_as_zero(new_zero)

change the origin (zero)

set_vel_params(vel_init, accel, vel_fin)

Set the velocity parameters for the motor

Parameters:

• vel_init (Integer) – initial velocity (steps / sec)
• accel (Integer) – acceleration (steps / sec^2)
• vel_fin (Integer) – max(final) velocity (steps / sec)

instruments.Motor_MST_DRV.hexString(data)

Creates a string that is a byte sequense of the hex values input :param data: Example is ‘0A 23 34 56’

instruments.Motor_MST_DRV.int2hexStr(integer, numberOfBytes)

Convert an integer to its corresponding bytearray

Parameters:

• integer (Integer) – the number we want to convert
• numberOfBytes (Integer) – The number of bytes

Returns:

Mutable sequence of integers of type bytearray

instruments.Motor_MST_DRV.prep_long_src_dst(bay=0)

instruments.Motor_MST_DRV.prep_short_src_dst(bay=0)

instruments.Motor_MST_DRV.send_chan_ident(ser, chan=1)

instruments.Motor_MST_DRV.send_long_dst_src(ser, bay=0)

instruments.Motor_MST_DRV.send_short_dst_src(ser, bay=0)

instruments.NewportPM500 module

Newport Controler Class

implementation for vertical stage

class instruments.NewportPM500.NewportPM500(gpib_addr)

Bases: object

close()

release resources

move_down()

Moves the stage to negative limit switch

move_up()

Moves the stage to positive limit switch

set_velocity(vel)

Set the velocity for the motor movement

vel (integer): velocity in um/sec

instruments.Polatis module

class instruments.Polatis.Polatis(rm, address)

Bases: object

This class models the Polatis 16x16 optical switch. Dependencies: PyVisa, datetime, time.

Note

there are a handful of sleep() calls throughout the class that slow down the performance of the switch. This is beacuase the firmware on the switch is not stable enough to support commands executed at high-speeds.

change_state()

close()

instrument cleanup

cmd_line(commands)

Allows the user to pass raw commands to the device, the commands are passed in SCPI. See pg.5 PROD-B-100-03-0 for further documentation.

Parameters:commands (Sting) – SCPI commands for the instrument Returns:varied

get_all_connections()

Query the existing complete switch state in the form of port pair lists

Returns:String

get_boot_mode()

Get the current boot mode, either: DARK, REST, AUT. More detailed documentation at pg.31 PROD-B-100-03-0

Returns:String

get_port_state(portNumber)

Query the port connected to the specified port <NR1>

Parameters:portNumber (integer) – integer of desired port to query Returns:String

get_zip_connections()

Data Model for to string functionality

make_connections(ingress, egress, explicit=’only’)

Makes connections between ports. The ingress range is 1 to 16 and egress range is 16-32. This means that at most 16 connections can be made at one time.

Parameters:

• ingress (list of integers) – a collection of input ports
• egress (list of integers) – a collection of output ports
• explicit – The explicit parameter can either be: add, only, sub. Defaults to only, see pg.22 of tech manual for details of each.

quick_connect(ingress=0, egress=0)

Allows the user to quickly make a connection between 2 ports

Parameters:

• ingress (integer) – input port
• egress (integer) – output port

read_pattern(name=”, boot=True)

Reads in a pattern that is in store_pattern format.

Parameters:

• name (String) – filename for desired pattern to be read, defaults to an empty String.
• boot (Boolean) – Boot == true if you want to load this pattern into the instrument, defaults to True.

Returns:

String

Raises:

Exception

reset()

Resets the instrument and disconnects all connections

set_boot_mode(mode=’aut’)

Allows the user set the boot mode

Parameters:mode (String) – Possible modes are DARK, RESTore, AUTosave. See pg.31 for details

whoAmI()

Returns:reference to device

write_pattern(name=’newPattern.txt’)

Stores the current pattern associated with the self._switch, writes the to a txt file.

Parameters:name (String) – desired filename, defaults to newPattern.txt

instruments.Polatis.sdebug(msg)

instruments.RSY01 module

class instruments.RSY01.RSY01(res_manager, address=’GPIB0::28::INSTR’)

Bases: object

This class models Signal Generator, specifically for Model RSY01

change_state()

out_off()

Turns the level off.

out_on()

Turns the level on.

reset()

Resets the instrument

set_freq(freq=10)

Set the frequency to specified frequency.

Parameters:freq (Integer) – Specified frequency, defaults to 10.

set_power(power=0)

Set the power to specified power.

Parameters:power (Integer) – Specified power, defaults to 0.

sweepTriggerSetup(start, end, step)

Execute a trigger sweep

Parameters:

• start (Float) – Specified start
• end (Float) – Specified end
• step (Float) – Specified step

trigger()

Execute the trigger for laster

whoAmI()

Returns:reference to device

instruments.Rotator_CR1_Z7 module

class instruments.Rotator_CR1_Z7.Rotator_CR1_Z7(ser)

Bases: instruments.Motor_KST_ZST.Motor_KST_ZST

abs_angle(deg)

Relative rotation on the motor

deg (float): the degrees of rotation (negative -> counter-clockwise)

delta_angle(deg)

Relative rotation on the motor

deg (float): the degrees of rotation (negative -> counter-clockwise)

get_angle()

return the motors current position, in degrees

set_as_zero(zer_deg)

change the origin (zero)

instruments.Rotator_ELL8 module

class instruments.Rotator_ELL8.Rotator_ELL8(ser)

Bases: instruments.ELL8.ELL8

abs_angle(deg)

Relative rotation on the motor

deg (float): the degrees of rotation (negative -> counter-clockwise)

delta_angle(deg)

Relative rotation on the motor

deg (float): the degrees of rotation (negative -> counter-clockwise)

get_angle()

return the motors current position, in degrees

set_as_zero(zer_deg)

change the origin (zero)

instruments.Santec_TSL_210H module

class instruments.Santec_TSL_210H.Santec_TSL_210H(res_manager, address=’GPIB0::3::INSTR’)

Bases: object

This class models the Santec_TSL_210H TUNABLE LD LIGHT SOURCE.

Note

When using any laser command, remember to send shut-off-laser command at the end of each sweep command set.

For Trigger Sweep, send shut-off-laser command after sweep ends (sweep end condition noted in TriggerSweepSetup function)

change_state()

checkStatus()

Check the status of the instrument

Returns:Booleans

coherenceOFF()

Turns coherence OFF

coherenceON()

Turns coherence ON

get_max_wavelength()

Queries the maximum allowed wavelength.

Returns:Float

get_min_wavelength()

Queries the minimum allowed wavelength.

Returns:Float

getcoherence()

Queries the coherence value

Returns:Float

getcurrent()

Queries the current, Note: current is mA

Returns:Float

getpower()

Gets output power in dbm

Returns:Float

getpowermw()

Queries the status of the powerMW

Returns:Float

getstatus()

Queries the status of the…

Returns:String

gettemperature()

Queries the temperature, Note: temperature is C

Returns:Float

getwavelength()

Query the current wavelength

Returns:Float

outputOFF()

Turns output of laser source OFF. Output occasionally doesn’t turn off unless turned ON beforehand

outputON()

Turns output of laser source ON.

pauseSweep()

Pause sweep

setACC()

Sets the ACC

setAPC()

Sets the APC

setcoherence(coherence)

Sets the coherence

Parameters:coherence (Integer) – Specified coherence

setcurrent(current)

Set the current. Note: current is mA

Parameters:current (Integer) – specified current to set

setpower(power)

Set power in dbm

Parameters:power (Float) – power specified to set

setpowermw(powermw)

Sets the powerMW

Parameters:powerMW (Integer) – specified powerMW to set

settemperature(temperature)

Set the temperature. Note: temperature is C

Parameters:temperature (Integer) – specified temperature to set

setwavelength(wavelength)

Loads a single wavelength and sets output high.

Parameters:wavelength (Float) – Specified wavelength, must be greater than minimum and less than maximum wavelength

startSweep()

Start sweep

stopSweep()

Stop the sweep

sweepWavelengthsTriggerSetup(start, end, step)

Execute a sweep of the wavelength trigger. Have to keep track of Triggers in main command. Use Stop Sweep Command to end sweep. Extra triggers do not make the laser sweep outside of specified end wavelength. Remeber to shut off laser after sweep ends.

Parameters:

• start (Float) – Starting point for sweep
• end (Float) – Ending point for sweep
• step (Float) – Size of increment

trigger()

Trigger the laser

whoAmI()

Returns:reference to device

instruments.StepMotor_KST_ZST module

class instruments.StepMotor_KST_ZST.StepMotor_KST_ZST(ser)

Bases: instruments.Motor_KST_ZST.Motor_KST_ZST

abs_transl(dist)

Absolute translation on the motor

dist (float): the millmeters of rotation (negative -> backwards)

check_abs_transl(dist)

Check wether a move to position ‘dist’ is in range

delta_transl(dist)

Relative translation on the motor

dist (float): the millimeters of translation (negative -> backwards) m_callback (function): (Optional) a function that will run while the motor

will be in motion. (e.g. show camera) This callback’s last parameter must be a callback itself, named ‘callback’

params (tuple): the callback’s parameters

get_info()

Get information back form the controller Used for debugging purposes

get_mm_pos()

return the motors current position, in millimeters

home()

Puts the motor to backward limit position, so that the position markers make sense

set_as_zero(zer_mm)

change the origin (zero)

instruments.StepMotor_MST_DRV module

class instruments.StepMotor_MST_DRV.StepMotor_MST_DRV(ser, bay=0, chan=1)

Bases: instruments.Motor_MST_DRV.Motor_MST_DRV

abs_transl(dist)

Absolute translation on the motor

dist (float): the millmeters of rotation (negative -> backwards)

check_abs_transl(dist)

Check wether a move to position ‘dist’ is in range

delta_transl(dist)

Relative translation on the motor

dist (float): the millimeters of translation (negative -> backwards) m_callback (function): (Optional) a function that will run while the motor

will be in motion. (e.g. show camera) This callback’s last parameter must be a callback itself, named ‘callback’

params (tuple): the callback’s parameters

get_info()

Get information back form the controller Used for debugging purposes

get_mm_pos()

return the motors current position, in millimeters

home()

Initializes all paremeters specific to the step motor and homes the motor.

The homing and backlash position need to be set up in a way that homing the system brings the system into a safe position. The backlash correction needs to be performed in such away that the correction is performed in the direction away from the chip and the other probes.

set_as_zero(zer_mm)

change the origin (zero)

instruments.TL2500 module

class instruments.TL2500.TL2500(res_manager, address=‘127.0.0.1:8888’)

Bases: object

This class handles the communication with the fiContec TL2500 system.

calibrate()

Calibrate machine for current configuration

Should be blocking until machine is calibrated

return ready or error

close()

connect_structure(chip_id, structure_id, active_align=False)

Prober connects probes and performs active alignment of optical probes.

1. Prober reads coordinates of structure IO from internal database - coordinates include type of IO and feedback signal source for active alignment
2. Prober checks whether it is configured to couple the structure
3. Prober couples structure and performs active alignment
4. Prober returns ‘error’/’ready’ message

free_prober()

Prober returns all loaded devices (wafer and/or chip) to original location

returns ‘ready’ / ‘error’

get_chip_temp()

Prober returns reticle holder temperature in degree Celsius

get_chuck_temp()

Prober return wafer chuck temperature in degree Celsius

get_state()

Returns the state of the prober. Minimal set of returns: error, uncalibrated, ready

get_structure_needs(structure)

Prober gives information on the fibers that need to be connected with PowerMeter and/or MultiMeter attached to the Prober

1. Return (power_fiber_id, multi_fiber_id) – can be None too

load_bluetape(bluetape_id)

Prober loads bluetape to die ejector position. Sets state so that following coupling commands are executed for single die coupling.

1. Prober checks configuration
2. Prober checks whether ejector is free. If not stores loaded bluetape in casssette
3. Prober reads location of bluetape_id from database
4. Prober loads bluetape to die ejector
5. Prober returns error/success message

load_chip(reticle_id)

Prober loads reticle onto single die probing station. Sets state so that following coupling commands are executed depending whether chip is in waferfor or die form.

(1) Prober fetches position and state of chip from DB (2a) If die is on already loaded wafer do nothing (2b) If die is on new wafer possibly store current wafer back to foup (2c) If die is in chip state and measurement platform is currently occupied restore current die to original location (3) Prober checks its configuration whether its equipped for chip state (wafer or die) (4) Prober loads wafer or picks die either from bluetape or gel pack (5) If needed Prober places die on probing station (6) Prober returns ‘ready’ or ‘error’

load_wafer(wafer_id)

Prober loads bluetape to die ejector position. Sets state so that following coupling commands are executed for wafer scale coupling.

1. Prober checks configuration
2. Prober checks whether wafer chuck is free. If not stores loaded wafer in casssette
3. Prober reads location of wafer_id from database
4. Prober loads wafer to wafer chuck
5. Prober returns error/success message

set_chip_temp(temp)

Prober sets reticle holder temperature in degree Celsius

2. If lock = True - tool driver returns functions only when temp is reached.
3. If lock = False - tool driver only initiates heating process

set_chuck_temp(temp, lock)

Prober sets wafer chuck temperature in degree Celsius

2. If lock = True - tool driver returns functions only when temp is reached.
3. If lock = False - tool driver only initiates heating process

store_bluetape()

Prober stores currently loaded bluetape in cassette. (2) Prober returns error/success message

store_chip(pack_id=None)

Prober stores active chip in pack. * If no pack_id defined: (1) Return chip to previous location (2) Prober returns error/ready message.

• If pack_id defined:

1. Prober checks location and fill-stage of pack_id
2. Prober stores chip in pack if possible
3. Prober updates database with location of chip about pack_id and location in pack
4. Prober returns error/ready message.

store_wafer()

Prober stores currently loaded wafer in cassette. (2) Prober returns error/success message

test_connection()

whoAmI()

Returns:instrument attributes

instruments.TL2500MultiDummy module

Dummy holder for the multimeter attached to the TL2500 prober system

class instruments.TL2500MultiDummy.TL2500MultiDummy(res_manager, address=‘0.0.0.0’)

Bases: object

whoAmI()

instruments.TL2500PowerDummy module

Dummy holder for the powermeter attached to the TL2500 prober system

class instruments.TL2500PowerDummy.TL2500PowerDummy(res_manager, address=‘0.0.0.0’)

Bases: object

whoAmI()

instruments.TektronixCSA8000 module

class instruments.TektronixCSA8000.TektronixCSA8000(res_manager, address=’GPIB0::16::INSTR’, channel=1)

Bases: object

This class models a sampling oscilloscope…

change_state()

Toggles the self.active parameter

getAcquisitionParam()

getAmplitude(source=’CH1’, measSlot=1)

getFallTime(source=’CH1’, measSlot=1)

getFrequency(source=’CH1’, measSlot=1)

getHistogramStatistics()

getMaskHitCount()

getMaskHitRatio()

getMaskParamter()

getMaximum(source=’CH1’, measSlot=1)

getMean(source=’CH1’, measSlot=1)

getMeasurementVal(measType, source=’CH1’, measSlot=1)

This function specifiecs a measurement channel to collect a specific type of data

meaSlot is the measuement slot on the oscilloscope. Valid numbers and integers between 1-8 source is the source channel for the measurement. Valid numbers are integers between 1-8

Options for Measurements are: HIGH | LOW | AMPLitude | MEAN | MAXimum | MINImum | PK2Pk | MID | POVershoot | NOVershoot | RMSNoise | PKPKNoise | AOPTPWRDBM | RMS | ACRMs | CRMs | CMEan | SNRatio | AOPTPWR | GAIN | OMA | RISe | FALL | PERIod | FREQuency | PCROss | NCROss | PWIdth | NWIdth | PDUty | NDUty | BURst | RMSJitter | PKPKJitter | DELay | PHAse | AREa | CARea | EXTINCTDB | EXTINCTPCT | EXTINCTRATIO | EXTINCTCAL | EYEHeight | PCTCROss | LEVCROss | QFACtor | EYEWIdth | DISTDUty | BITTime | BITRate | TIMCROss | EYEOfactor | SUPRSDB | SUPRSPCT | SUPRSRATIO | PULSESym

getMinimum(source=’CH1’, measSlot=1)

getOMA(source=’CH1’, measSlot=1)

getPeriod(source=’CH1’, measSlot=1)

getPk2Pk(source=’CH1’, measSlot=1)

getRiseTime(source=’CH1’, measSlot=1)

getRmsNoise(source=’CH1’, measSlot=1)

getSampleRate(scale)

Notes:

resetHistogramCount()

resetMask()

runMaskAutoFit()

runMaskAutoSize()

selectMathSlot(num)

num can be between 1 and 8

setAcquisitionMode(sample=True, average=False, envelope=False)

setAveragingNum(num=16)

setHistogramAxis(linear=True, log=True)

setHistogramMode(HORizontal=True, VERtical=False)

setHistogramSource(source=’CH1’)

source options are:

CH1 - CH8 MATH1 - MATH8 REF1 - REF8

setMaskHitCountTarget(count)

setMaskHitRatioTarget(ratio)

setMaskSource(source=’CH1’)

source options are:

CH1 - CH8 MATH1 - MATH8 REF1 - REF8

setMaskStandard(standard=’NONe’)

Supported Standards are: NONe | CUSTom | ATARXG1 | ATARXG2 | ATARXG3 | ATATXG1 | ATATXG2 | ATATXG3 | ENET40GB_LR4 | ENET40GB_SR4 | ENET1250 | ENET2500 | ENET3125 | ENET9953 | ENET10313| ENET10GB_LRM | ENET100B_BX10 | ENET100GB_ER4 | ENET100GB_LR4 | ENET100GB_SR4 | ENET100GB_SR10 | ENET100B_LX10 | ENET1000B_KX | ENET10313 | ENET11096 | ENET41250 | FC133 | FC133E | FC266 | FC266E | FC531 | FC531E | FC1063 | FC1063E | FC2125 | FC2125E_ABR | FC2125E_ABT | FC2125E_AGR | FC2125E_AGT | FC4250E_ABR | FC4250E_ABT | FC4250E_AGR | FC4250E_AGT | FC8500E_ABR | FC8500E_ABT | FC8500E_AGR| FC8500E_AGT | FC8500D | FC8500FINAL | FC4250 | FC10519 | FC11317 | FC14025_MMR6_1 | FC14025_SMR6_1 | FEC2666 | FEC10664 | FEC10709 | FEC42657 | FEC43018 | INF2500 | INFIE25 | INFIniband | OC1 | OC3 | OC9| OC12 | OC18 | OC24 | OC36 | OC48 | OC192 | OC768 | OTU27952 |PCIEXPRESS_Rcv | PCIEXPRESS50_Rcv | PSM4_100G_TX | RIO_SERIAL1G | RIO_SERIAL2G | RIO_SERIAL3G | SAS3_0_XR | SAS3_0_XR_AASJ | SAS3_0_SATA | USERMask | XFI9950_TAA | XFI9950_RAD | XFI9950_THB | XFI9950_RHC | XFI9950_TMBP | XFI9950_RMCP |XAUIFar | XAUIRFar | XAUINear | XAUIRNear

setMathFunction(func_string=’C1+C2’)

Example for the func_string:

C1+C2 C2*R2 Log(C1+C2)

Cx representing the channel x

setSampleRate(scale)

Notes:

startAcquisition()

stopAcquisition()

unlockFront()

whoAmI()

Returns:reference to device

instruments.WT68145B module

class instruments.WT68145B.WT68145B(res_manager, address=’GPIB0::5::INSTR’)

Bases: object

auto_trigger_mode()

Enter auto trigger mode

change_state()

decrement()

Execute decrement

fill_freq_buffer(start, stop, steps)

Writes to frequency buffer.

Parameters:

• start (Float) – Specify starting point.
• stop (Float) – Specify ending point
• steps (Float) – Specify steps

freq_step()

Set step frequency.

full_range_sweep()

Execute full range sweep

increment()

Execute increment

out_off()

Turns output OFF

out_on()

Turns output ON

set_CW_mode()

Enter CW mode

set_analogsweep_mode()

Enter analog-sweep mode

set_analogsweep_time(time=1000)

Set analog-sweep time

Parameters:time (Integer) – Specify time value; defaults to 1000

set_deltasweep_mode()

Enter delta sweep mode

set_freq1(freq=10)

Sets the first frequency to specified value.

Parameters:freq (Integer) – Frequency to spcify; defaults to 10.

set_freq2(freq=10)

Sets the second frequency to specified value.

Parameters:freq (Integer) – Frequency to spcify; defaults to 10.

set_power(power=0)

Set the power to specified value.

Parameters:power (Integer) – Specified power value; defaults to 0

set_stepsweep_mode()

Enter step-sweep mode

set_stepsweep_steps(steps=1000)

Set the number of steps

Parameters:steps (Integer) – Specified step value; defaults to 1000

set_stepsweep_stepsize(step=500)

Set the stepsize of step-sweep mode

Parameters:step (Integer) – Specify the step size; defaults to 500.

set_stepsweep_time(time=100)

Sets the step sweep time

Parameters:time (Integer) – Specified time value; defaults to 100

set_sweep_delta(delta=5)

Set delta sweep value

Parameters:delta (Integer) – Specified delta value; defaults to 5

single_trigger_mode()

Enter single trigger mode.

sweep_f1f2()

Execute a sweep of the two frequencies

trigger_sweep()

Execute trigger sweep

whoAmI()

Returns:reference to device

instruments.template module

instruments.template.instrument(instrument_type)

Module contents