org.lsst.ccs.drivers.keithley

Class N6487

java.lang.Object

org.lsst.ccs.drivers.ascii.Ascii

org.lsst.ccs.drivers.scpi.Scpi

org.lsst.ccs.drivers.keithley.N6487

All Implemented Interfaces:

org.lsst.ccs.drivers.commons.DriverConstants

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

Class for controlling the Keithley 6487 picoammeter and voltage source

Author:

Homer Neal

Nested Class Summary

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

Modifier and Type	Field and Description
static int	DEFAULT_BAUD
static int	MAX_BUFF_SIZE

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

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

CONN_TYPE_FTDI, CONN_TYPE_NETWORK, CONN_TYPE_SERIAL

Constructor Summary

Constructors

Constructor and Description
N6487() Constructor.

Method Summary

Modifier and Type	Method and Description
void	accumBuffer(int nreads, double nplc) Starts the accumulation of current readings in the buffer.
void	accumBuffer(int nreads, double nplc, boolean wait) Deprecated.
void	clearStat() Clears status
void	clrBuff() Clears the buffer
boolean	current_OK() Deprecated.
double	getCurrentLimit() Gets the set current limit.
int	getLineFreq() Gets the line frequency
static double	getMaxBias() Gets the maximum allowed bias value
static double	getMAXBIAS() Deprecated.
int	getMaxBufferSize() Gets the maximum buffer size
static double	getMinBias() Gets the minimum allowed bias value
static double	getMINBIAS() Deprecated.
boolean	getOutput() Gets the output state.
double	getVoltage() Gets the set voltage.
boolean	isAbort() Gets the (unused) abort state.
boolean	isACCUM_IN_PROGRESS() Deprecated.
boolean	isAccumInProgress() Gets whether data accumulation is in progress
boolean	isCurrentOk() Checks whether current is within bounds
boolean	isDataReady() Gets whether data is ready
boolean	isDATAREADY() Deprecated.
boolean	isOkToTalk() Gets the blocking flag
boolean	isOKTOTALK() Deprecated.
boolean	isTrip() Gets the (unused) trip state.
void	open() Opens a connection.using all default parameters
void	open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType connType, String ident, int baudRate, int commParm) Opens a connection.
void	open(String devname) Opens a connection.
void	open(String devname, int baud) Opens a connection.
void	openftdi(String serial, int baud) Opens an FTDI connection.
String	printdevid() Returns a formatted device identification string.
void	rampVolts_sweep(double duration, double value, int nsteps) Deprecated.
void	rampVolts(double duration, double value) Ramps the voltage to a desired level over a given duration using a default of 10 steps
void	rampVolts(double duration, double value, int nsteps) Ramps the voltage to a desired level over a given duration.
void	rampVoltsSweep(double duration, double value, int nsteps) Ramps the voltage to a desired level over a given duration.
double[][]	readBuffer() Reads the accumulated buffer data.
double	readCurrent() Reads the current.
double[][]	readCurrents(int nreads, double nplc) Makes a set of current readings.
String	readStringKthly(String instr) Writes a command and reads the (string) result.
double	readVoltage() Reads the voltage.
void	reset() Reset
void	setAbort(boolean abort) Sets the (unused) abort state.
void	setArmCount(int value) Sets the ARM count
void	setBuffSize(int value) Sets the buffer size (#readings up to 3000 for the 6487)
void	setCurrentLimit(double maxima) Sets the current limit.
void	setCurrentRange(double value) Sets the current range.
void	setDebug(boolean setOn) Sets the debug state
void	setDisplay(boolean dstate) Sets the display on(true)/off(false)
void	setOKTOTALK(boolean okToTalk) Deprecated.
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) Sets the (unused) trip state.
void	setVoltage(double value) Sets the voltage.
void	setVoltageRange(double value) Sets the voltage range.
void	softReset() Soft reset
void	waitAccum(double timeout) Waits for the buffer accumulation to complete.
void	writeKthly(String instr) Writes a command.
void	zeroCorrectCurrent() Zero corrects the current.
void	zeroCorrectVoltage() Zero correct the voltage.

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

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

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

close, closeSilent, flush, makeDataCharacteristics, open, open, open, openFtdi, openFtdi, openNet, openSerial, openSerial, read, read, readBytes, readBytes, setCommandTerm, setResponseTerm, setTerminator, setTerminator, setTimeout, setTimeout, write, writeBytes, writeBytes

Methods inherited from class java.lang.Object

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

Field Detail

MAX_BUFF_SIZE

public static final int MAX_BUFF_SIZE

See Also:

Constant Field Values

DEFAULT_BAUD

public static final int DEFAULT_BAUD

See Also:

Constant Field Values

Constructor Detail

N6487

public N6487()

Constructor.

Method Detail

open

public void open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType connType,
                 String ident,
                 int baudRate,
                 int commParm)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection. This gets called by all other open methods

Overrides:

open in class org.lsst.ccs.drivers.ascii.Ascii

Parameters:

connType - The enumerated connection type: FTDI or SERIAL

ident - The USB ID (FTDI) or port name (SERIAL)

baudRate - The baud rate, or 0 for the default (9600)

commParm - The communications parameters

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

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

Opens a connection.

Parameters:

devname - The serial device name

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 baud)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection.

Parameters:

devname - The serial device name

baud - The baud rate

Throws:

org.lsst.ccs.drivers.commons.DriverException

openftdi

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

Opens an FTDI connection.

Parameters:

serial - The FTDI serial number

baud - The baud rate

Throws:

org.lsst.ccs.drivers.commons.DriverException

printdevid

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

Returns a formatted device identification string.

Returns:

The string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setDebug

public void setDebug(boolean setOn)

Sets the debug state

Parameters:

setOn - True to set debug state, false to clear it

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

Soft reset

Throws:

org.lsst.ccs.drivers.commons.DriverException

clearStat

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

Clears status

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

setRate

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

Sets the integration rate in the number of power line cycles

Parameters:

value - The integration rate

Throws:

org.lsst.ccs.drivers.commons.DriverException

setArmCount

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

Sets the ARM count

Parameters:

value - 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

Parameters:

value - 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

Parameters:

value - 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 6487)

Parameters:

value - The buffer size

Throws:

org.lsst.ccs.drivers.commons.DriverException

clrBuff

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

Clears the buffer

Throws:

org.lsst.ccs.drivers.commons.DriverException

setCurrentRange

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

Sets the current range.

Parameters:

value - The current range

Throws:

org.lsst.ccs.drivers.commons.DriverException

zeroCorrectCurrent

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

Zero corrects the current.

Throws:

org.lsst.ccs.drivers.commons.DriverException

readCurrent

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

Reads the current.

Returns:

The read current

Throws:

org.lsst.ccs.drivers.commons.DriverException

readCurrents

public double[][] readCurrents(int nreads,
                               double nplc)
                        throws org.lsst.ccs.drivers.commons.DriverException

Makes a set of current readings.

Parameters:

nreads - The number of readings

nplc - The sample rate

Returns:

The read current

Throws:

org.lsst.ccs.drivers.commons.DriverException

accumBuffer

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

Starts the accumulation of current readings in the buffer.

Parameters:

nreads - The number of readings

nplc - The sample rate

Throws:

org.lsst.ccs.drivers.commons.DriverException

waitAccum

public void waitAccum(double timeout)
               throws org.lsst.ccs.drivers.commons.DriverException

Waits for the buffer accumulation to complete. The command to check for completion has already been issued, and will not be executed until completion actually occurs. At that point the result (1) will be sent. Until then, reading will time out.

Parameters:

timeout - The timeout (secs)

Throws:

org.lsst.ccs.drivers.commons.DriverException

readBuffer

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

Reads the accumulated buffer data.

Returns:

The array of buffered values

Throws:

org.lsst.ccs.drivers.commons.DriverException

getMaxBufferSize

public int getMaxBufferSize()

Gets the maximum buffer size

Returns:

The maximum allowed buffer size

getLineFreq

public int getLineFreq()
                throws org.lsst.ccs.drivers.commons.DriverException

Gets the line frequency

Returns:

The frequency (50 or 60)

Throws:

org.lsst.ccs.drivers.commons.DriverException

isOkToTalk

public boolean isOkToTalk()

Gets the blocking flag

Returns:

The blocking flag

isDataReady

public boolean isDataReady()

Gets whether data is ready

Returns:

Whether data is ready

isAccumInProgress

public boolean isAccumInProgress()

Gets whether data accumulation is in progress

Returns:

Whether data accumulation is in progress

getMinBias

public static double getMinBias()

Gets the minimum allowed bias value

Returns:

The minimum value

getMaxBias

public static double getMaxBias()

Gets the maximum allowed bias value

Returns:

The maximum value

setOutput

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

Turns output on or off.

Parameters:

on - Whether to turn on

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutput

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

Gets the output state.

Returns:

Whether output is on

Throws:

org.lsst.ccs.drivers.commons.DriverException

isTrip

public boolean isTrip()

Gets the (unused) trip state.

Returns:

Whether trip is true

setTrip

public void setTrip(boolean trip)

Sets the (unused) trip state.

Parameters:

trip - Whether trip is true

isAbort

public boolean isAbort()

Gets the (unused) abort state.

Returns:

Whether abort is true

setAbort

public void setAbort(boolean abort)

Sets the (unused) abort state.

Parameters:

abort - Whether abort is true

setVoltageRange

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

Sets the voltage range.

Parameters:

value - 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.

Parameters:

value - The voltage to set

Throws:

org.lsst.ccs.drivers.commons.DriverException

rampVoltsSweep

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

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

Parameters:

duration - The time duration

value - The voltage value

nsteps - The number of steps

Throws:

org.lsst.ccs.drivers.commons.DriverException

isCurrentOk

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

Checks whether current is within bounds

Returns:

Whether current is okay

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.

Parameters:

duration - The time duration

value - The voltage value

nsteps - The number of steps

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 - The time duration

value - The voltage level

Throws:

org.lsst.ccs.drivers.commons.DriverException

getVoltage

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

Gets the set voltage.

Returns:

The set voltage

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.

Returns:

The read voltage

Throws:

org.lsst.ccs.drivers.commons.DriverException

setCurrentLimit

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

Sets the current limit.

Parameters:

maxima - 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.

Returns:

The current limit

Throws:

org.lsst.ccs.drivers.commons.DriverException

writeKthly

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

Writes a command.

Parameters:

instr - 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.

Parameters:

instr - The command to write, excluding terminator

Returns:

The returned string

Throws:

org.lsst.ccs.drivers.commons.DriverException

accumBuffer

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

Deprecated.

Throws:

org.lsst.ccs.drivers.commons.DriverException

isACCUM_IN_PROGRESS

@Deprecated
public boolean isACCUM_IN_PROGRESS()

Deprecated.

isDATAREADY

@Deprecated
public boolean isDATAREADY()

Deprecated.

isOKTOTALK

@Deprecated
public boolean isOKTOTALK()

Deprecated.

setOKTOTALK

@Deprecated
public void setOKTOTALK(boolean okToTalk)

Deprecated.

current_OK

@Deprecated
public boolean current_OK()
                               throws org.lsst.ccs.drivers.commons.DriverException

Deprecated.

Throws:

org.lsst.ccs.drivers.commons.DriverException

rampVolts_sweep

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

Deprecated.

Throws:

org.lsst.ccs.drivers.commons.DriverException

getMINBIAS

@Deprecated
public static double getMINBIAS()

Deprecated.

getMAXBIAS

@Deprecated
public static double getMAXBIAS()

Deprecated.