org.lsst.ccs.drivers.keithley

Class N2502

java.lang.Object

org.lsst.ccs.drivers.ascii.Ascii

org.lsst.ccs.drivers.scpi.Scpi

org.lsst.ccs.drivers.keithley.N2502

All Implemented Interfaces:

org.lsst.ccs.drivers.commons.DriverConstants

public class N2502
extends org.lsst.ccs.drivers.scpi.Scpi

Class for controlling the Keithley 2502 picoammeter and voltage source

Author:

Homer Neal * *****************************************************************************

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	N2502.avg_status

Nested classes/interfaces inherited from class org.lsst.ccs.drivers.ascii.Ascii

org.lsst.ccs.drivers.ascii.Ascii.DataBits, org.lsst.ccs.drivers.ascii.Ascii.FlowCtrl, org.lsst.ccs.drivers.ascii.Ascii.Option, org.lsst.ccs.drivers.ascii.Ascii.Parity, org.lsst.ccs.drivers.ascii.Ascii.StopBits, org.lsst.ccs.drivers.ascii.Ascii.Terminator

Nested classes/interfaces inherited from interface org.lsst.ccs.drivers.commons.DriverConstants

org.lsst.ccs.drivers.commons.DriverConstants.ConnType

Field Summary

Fields inherited from class org.lsst.ccs.drivers.scpi.Scpi

CHECK_CONTAINS, CHECK_ENDS_WITH, CHECK_EQUALS, CHECK_MATCHES, CHECK_STARTS_WITH, ESR_ANY_ERROR, ESR_COMMAND_ERROR, ESR_DEVICE_ERROR, ESR_EXECUTION_ERROR, ESR_QUERY_ERROR, IDENT_FW_VERSION, IDENT_MANUFACTURER, IDENT_MODEL_NAME, IDENT_SERIAL_NUMBER, SB_ERROR_QUEUE, SB_EVENT_STATUS, SB_MASTER_STATUS, SB_MESSAGE_AVAILABLE, SB_OPERATION_STATUS, SB_QUESTIONABLE_STATUS

Constructor Summary

Constructors

Constructor and Description
N2502() Constructor.

Method Summary

Modifier and Type	Method and Description
void	accumBuffer(int nreads, double nplc, boolean wait) starts the accumulation of readings in the buffer.
void	clearStat() Clear Status * **************************************************************************
void	clrBuff() Clear the buffer * **************************************************************************
int	getChannel()
double	getCurrent() Gets the set current.
double	getCurrentLimit() Gets the set current limit.
static double	getMAXBIAS()
static double	getMINBIAS()
int	getnAvg()
boolean	getOutput() Gets the output state.
double	getVoltage() Gets the set voltage.
double	getVoltageLimit() Gets the set voltage limit.
boolean	isAbort()
boolean	isDATAREADY()
String	isDo_avg()
boolean	isOKTOTALK()
boolean	isTrip()
void	open() Opens a connection.using all default parameters
void	open(String devname) Opens a connection.
void	open(String devname, int port) Opens a connection.
void	openftdi(String serialname, int port) Opens an FTDI connection.
String	printdevid()
void	rampVolts_sweep(double duration, double value, int nsteps) Ramps the voltage to a desired level over a given duration.
void	rampVolts(double duration, double value) Ramps the voltage to a desired level over a given duration.
void	rampVolts(double duration, double value, int nsteps) Ramps the voltage to a desired level over a given duration.
double[][]	readBuffer() Reads the buffer.
double	readCurrent() Reads the current.
double	readDouble(String command) Reads a double with SCPI error checking after writing a command.
double[][]	readDoublePairArray(String command) Reads a double pair array with SCPI error checking after writing a command.
int	readInteger(String command) Reads an integer with SCPI error checking after writing a command.
String	readStringKthly(String instr) Writes a command and reads the (string) result.
double	readVoltage() Reads the voltage.
void	reset() Reset * **************************************************************************
void	setAbort(boolean abort)
void	setArmCount(int value) Sets the ARM count * **************************************************************************
void	setBuffSize(int value) Sets the buffer size (#readings up to 3000 for the 2502) * **************************************************************************
void	setChannel(int channel)
void	setCurrent(double value) Sets the current.
void	setCurrentLimit(double maxima) Sets the current limit.
void	setCurrentRange(double value) Sets the current range.
void	setDisplay(boolean dstate) Sets the display on(true)/off(false)
void	setDo_avg(boolean do_avg_req)
void	setnAvg(int nAvg)
void	setOKTOTALK(boolean OKTOTALK)
void	setOutput(boolean on) Turns output on or off.
void	setRate(double value) Sets the integration rate in the number of power line cycles * **************************************************************************
void	setTrigCount(int value) Sets the trigger count * **************************************************************************
void	setTrigDelay(int value) Sets the trigger delay * **************************************************************************
void	setTrip(boolean trip)
void	setVoltage(double value) Sets the voltage.
void	setVoltageLimit(double maxima) Sets the voltage limit.
void	setVoltageRange(double value) Sets the voltage range.
void	softReset()
void	writeCommand(String command) Writes a command with SCPI error checking.
void	writeKthly(String instr) Writes a command.
void	zeroCorrectCurrent() zero correct the current.
void	zeroCorrectVoltage() zero correct the voltage.

Methods inherited from class org.lsst.ccs.drivers.scpi.Scpi

checkError, checkIdentification, clearStatus, enableOperationComplete, getError, getEventStatus, getEventStatusEnable, getIdentification, getOperationComplete, getServiceRequestEnable, getStatusByte, makeChannelList, makeChannelList, readDoubleArray, readFloat, readFloatArray, readIntegerArray, readString, readStringArray, runSelfTest, setEventStatusEnable, setServiceRequestEnable, testIdentification, waitCompletion

Methods inherited from class org.lsst.ccs.drivers.ascii.Ascii

close, closeSilent, flush, getTimeout, isOpen, makeDataCharacteristics, open, open, open, openFtdi, openFtdi, openFtdi, openNet, openNet, openSerial, openSerial, openSerial, read, read, readBytes, readBytes, setCommandTerm, setDefaultParm, setMultidrop, setOptions, setResponseTerm, setTerminator, setTimeout, setTimeout, write, writeBytes, writeBytes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

N2502

public N2502()

Constructor.

Method Detail

open

public void open(String devname)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection.

Parameters:

devname - **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

public void open()
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection.using all default parameters

Throws:

org.lsst.ccs.drivers.commons.DriverException - **************************************************************************

open

public void open(String devname,
                 int port)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection. **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

openftdi

public void openftdi(String serialname,
                     int port)
              throws org.lsst.ccs.drivers.commons.DriverException

Opens an FTDI connection.

Parameters:

serialname -

port -

Throws:

org.lsst.ccs.drivers.commons.DriverException - **************************************************************************

printdevid

public String printdevid()
                  throws org.lsst.ccs.drivers.commons.DriverException

Throws:

org.lsst.ccs.drivers.commons.DriverException

reset

public void reset()
           throws org.lsst.ccs.drivers.commons.DriverException

Reset * **************************************************************************

Overrides:

reset in class org.lsst.ccs.drivers.scpi.Scpi

Throws:

org.lsst.ccs.drivers.commons.DriverException

softReset

public void softReset()
               throws org.lsst.ccs.drivers.commons.DriverException

Throws:

org.lsst.ccs.drivers.commons.DriverException

clearStat

public void clearStat()
               throws org.lsst.ccs.drivers.commons.DriverException

Clear Status * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutput

public void setOutput(boolean on)
               throws org.lsst.ccs.drivers.commons.DriverException

Turns output on or off. * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutput

public boolean getOutput()
                  throws org.lsst.ccs.drivers.commons.DriverException

Gets the output state. * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

isTrip

public boolean isTrip()

setTrip

public void setTrip(boolean trip)

isAbort

public boolean isAbort()

setAbort

public void setAbort(boolean abort)

setRate

public void setRate(double value)
             throws org.lsst.ccs.drivers.commons.DriverException

Sets the integration rate in the number of power line cycles * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

setArmCount

public void setArmCount(int value)
                 throws org.lsst.ccs.drivers.commons.DriverException

Sets the ARM count * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

setTrigCount

public void setTrigCount(int value)
                  throws org.lsst.ccs.drivers.commons.DriverException

Sets the trigger count * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

setTrigDelay

public void setTrigDelay(int value)
                  throws org.lsst.ccs.drivers.commons.DriverException

Sets the trigger delay * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

setBuffSize

public void setBuffSize(int value)
                 throws org.lsst.ccs.drivers.commons.DriverException

Sets the buffer size (#readings up to 3000 for the 2502) * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

clrBuff

public void clrBuff()
             throws org.lsst.ccs.drivers.commons.DriverException

Clear the buffer * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

getChannel

public int getChannel()

setChannel

public void setChannel(int channel)

setVoltageRange

public void setVoltageRange(double value)
                     throws org.lsst.ccs.drivers.commons.DriverException

Sets the voltage range. * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

setVoltage

public void setVoltage(double value)
                throws org.lsst.ccs.drivers.commons.DriverException

Sets the voltage. * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

rampVolts_sweep

public void rampVolts_sweep(double duration,
                            double value,
                            int nsteps)
                     throws org.lsst.ccs.drivers.commons.DriverException

Ramps the voltage to a desired level over a given duration. * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

rampVolts

public void rampVolts(double duration,
                      double value,
                      int nsteps)
               throws org.lsst.ccs.drivers.commons.DriverException

Ramps the voltage to a desired level over a given duration. * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

rampVolts

public void rampVolts(double duration,
                      double value)
               throws org.lsst.ccs.drivers.commons.DriverException

Ramps the voltage to a desired level over a given duration. using a default of 10 steps

Parameters:

duration -

value -

Throws:

org.lsst.ccs.drivers.commons.DriverException - **************************************************************************

getVoltage

public double getVoltage()
                  throws org.lsst.ccs.drivers.commons.DriverException

Gets the set voltage.

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException - **************************************************************************

zeroCorrectVoltage

public void zeroCorrectVoltage()
                        throws org.lsst.ccs.drivers.commons.DriverException

zero correct the voltage. * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

readVoltage

public double readVoltage()
                   throws org.lsst.ccs.drivers.commons.DriverException

Reads the voltage. * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

setCurrentRange

public void setCurrentRange(double value)
                     throws org.lsst.ccs.drivers.commons.DriverException

Sets the current range. * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

setCurrent

public void setCurrent(double value)
                throws org.lsst.ccs.drivers.commons.DriverException

Sets the current. * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

getCurrent

public double getCurrent()
                  throws org.lsst.ccs.drivers.commons.DriverException

Gets the set current. * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

zeroCorrectCurrent

public void zeroCorrectCurrent()
                        throws org.lsst.ccs.drivers.commons.DriverException

zero correct the current. * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

readCurrent

public double readCurrent()
                   throws org.lsst.ccs.drivers.commons.DriverException

Reads the current. * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

setVoltageLimit

public void setVoltageLimit(double maxima)
                     throws org.lsst.ccs.drivers.commons.DriverException

Sets the voltage limit. * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

getVoltageLimit

public double getVoltageLimit()
                       throws org.lsst.ccs.drivers.commons.DriverException

Gets the set voltage limit. * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

setCurrentLimit

public void setCurrentLimit(double maxima)
                     throws org.lsst.ccs.drivers.commons.DriverException

Sets the current limit. * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

getCurrentLimit

public double getCurrentLimit()
                       throws org.lsst.ccs.drivers.commons.DriverException

Gets the set current limit. * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

setDisplay

public void setDisplay(boolean dstate)
                throws org.lsst.ccs.drivers.commons.DriverException

Sets the display on(true)/off(false)

Parameters:

dstate -

Throws:

org.lsst.ccs.drivers.commons.DriverException - **************************************************************************

accumBuffer

public void accumBuffer(int nreads,
                        double nplc,
                        boolean wait)
                 throws org.lsst.ccs.drivers.commons.DriverException

starts the accumulation of readings in the buffer.

Throws:

org.lsst.ccs.drivers.commons.DriverException - **************************************************************************

readBuffer

public double[][] readBuffer()
                      throws org.lsst.ccs.drivers.commons.DriverException

Reads the buffer. * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

getMINBIAS

public static double getMINBIAS()

getMAXBIAS

public static double getMAXBIAS()

setOKTOTALK

public void setOKTOTALK(boolean OKTOTALK)

isOKTOTALK

public boolean isOKTOTALK()

isDATAREADY

public boolean isDATAREADY()

isDo_avg

public String isDo_avg()

setDo_avg

public void setDo_avg(boolean do_avg_req)

getnAvg

public int getnAvg()

setnAvg

public void setnAvg(int nAvg)

readDoublePairArray

public double[][] readDoublePairArray(String command)
                               throws org.lsst.ccs.drivers.commons.DriverException

Reads a double pair array with SCPI error checking after writing a command. * * @param command The command to write, excluding terminator * @return The returned array of double float values * * @throws DriverException

Throws:

DriverTimeoutException - * *************************************************************************

org.lsst.ccs.drivers.commons.DriverException

writeKthly

public void writeKthly(String instr)
                throws org.lsst.ccs.drivers.commons.DriverException

Writes a command. * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeCommand

public void writeCommand(String command)
                  throws org.lsst.ccs.drivers.commons.DriverException

Writes a command with SCPI error checking.

Overrides:

writeCommand in class org.lsst.ccs.drivers.scpi.Scpi

Parameters:

command - The command to write, excluding terminator

Throws:

org.lsst.ccs.drivers.commons.DriverException

readStringKthly

public String readStringKthly(String instr)
                       throws org.lsst.ccs.drivers.commons.DriverException

Writes a command and reads the (string) result. * **************************************************************************

Throws:

org.lsst.ccs.drivers.commons.DriverException

readDouble

public double readDouble(String command)
                  throws org.lsst.ccs.drivers.commons.DriverException

Reads a double with SCPI error checking after writing a command.

Overrides:

readDouble in class org.lsst.ccs.drivers.scpi.Scpi

Parameters:

command - The command to write, excluding terminator

Returns:

The returned double float value

Throws:

org.lsst.ccs.drivers.commons.DriverException

DriverTimeoutException

readInteger

public int readInteger(String command)
                throws org.lsst.ccs.drivers.commons.DriverException

Reads an integer with SCPI error checking after writing a command.

Overrides:

readInteger in class org.lsst.ccs.drivers.scpi.Scpi

Parameters:

command - The command to write, excluding terminator

Returns:

The returned integer value

Throws:

org.lsst.ccs.drivers.commons.DriverException

DriverTimeoutException