org.lsst.ccs.subsystem.teststand

Class KeithleyDevice

java.lang.Object

org.lsst.ccs.monitor.Device

org.lsst.ccs.subsystem.teststand.KeithleyDevice

All Implemented Interfaces:

org.lsst.ccs.framework.HardwareController, org.lsst.ccs.framework.HasLifecycle, BiasDevice, PhotoDiodeDevice

Direct Known Subclasses:

KeithleySimDevice

public class KeithleyDevice
extends org.lsst.ccs.monitor.Device
implements BiasDevice, PhotoDiodeDevice

Device class for communicating with the Keithley driver

Author:

Homer Neal

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHAN_CURRENT
static int	CHAN_VOLTAGE
static int	NUM_CHANS

Fields inherited from class org.lsst.ccs.monitor.Device

chanMask, ctlChans, disabled, fullName, inited, lineMask, lineState, lineWarm, log, mon, name, online, s

Constructor Summary

Constructors

Constructor and Description
KeithleyDevice()

Method Summary

Modifier and Type	Method and Description
double	accumBuffer(int nreads, double nplc) Start the accumulation of readings into the device's internal buffer
double	accumBuffer(int nreads, double nplc, boolean wait) Start the accumulation of readings into the device's internal buffer
protected int[]	checkChannel(String name, int hwChan, String type, String subtype) Checks a channel's parameters for validity.
void	clearBuffer() Clears the data buffer
protected void	close() Closes the connection.
String	getCurrentLimit() Shows the soft current limit.
double	getLast_curr() Deprecated.
double	getLast_volt() Deprecated.
double	getLastCurrent() Gets the last current measurement
double	getLastVoltage() Gets the last voltage measurement
double	getRunBias(int cfgstate) Returns the bias value for acquisition
int	getState() Gets the state
double	getVoltage() Shows the set voltage.
protected void	initDevice() Performs initial configuration.
protected void	initialize() Performs full initialization - opens the connection
boolean	isAccumInProgress() Tells whether PD accumulation is in progress
boolean	isDoPDPlot() Gets whether PD plots are produced
String	query(String str) Writes a command to the Keithley and returns response
String	query(String str1, String str2) Writes a command to the Keithley and returns response
void	rampVolts(double duration, double value) Ramps to the desired voltage
void	rampVolts(double duration, double value, int nsteps) Ramps to the desired voltage over a given time and for nsteps
double[][]	readBuffer() Reads the data buffer
double[][]	readBuffer(String filename) Reads buffer and dumps it to a file
double[][]	readBuffer(String filename, String host) Reads buffer and dumps it to a remote file
String	readBufferStr() Reads buffered data and returns it as a string
protected double	readChannel(int chan, int type) Reads a channel.
double	readCurrent() Reads the actual current.
double[][]	readCurrents(int nreads, double nplc) Gets a set of current readings
double	readVoltage() Reads the actual voltage.
void	reset() Resets the Keithley to a known default state
void	send(String str) Writes a command to the Keithley
void	send(String str1, String str2) Writes a command to the Keithley
void	setAbort(boolean state) Sets the abort state
void	setArmCount(int count) Sets ARM count
void	setBuffSize(int value) Sets the buffer size
void	setCfg(TSConfig cfg) Sets the configuration
void	setChannel(int value) Sets the channel.
void	setCurrentLimit(double value) Sets the soft current limit.
void	setCurrentRange(double value) Sets the current range
void	setDisplay(boolean dstate) Sets the Display ON(true)/OFF(false)
void	setDoPDPlot(boolean doPDPlot) Sets whether PD plots are produced
void	setDPSF(hep.aida.IDataPointSetFactory dpsf) Sets the data point set factory address.
void	setOutput(int state) Turns the output on or off.
void	setRate(double rate) Sets the read rate in PLC
void	setRunBias(double runBias, int cfgstate) Sets the bias value for acquisition
void	setState(int istate) Sets the state
void	setTimeout(double nsec) Sets the timeout
void	setTrigCount(int value) Sets TRIGger count
void	setVoltage(double value) Sets the voltage.
void	setVoltageAcq(int cfgstate) Sets the voltage to the value needed for acquisition.
void	setVoltageRange(double value) Sets the voltage range
boolean	showOutput() Shows the output state.
void	softReset() Resets the Keithley to a known default state w/o initializing all settings
void	waitAccum(double timeout) Waits for accumulation to finish.
void	zeroCorrectCurrent() Zero correct the current

Methods inherited from class org.lsst.ccs.monitor.Device

addChannel, addLine, checkHardware, checkHwLine, checkLine, checkOnline, checkTimeout, configure, disable, dropChannel, enable, getFullName, getName, getOutputLines, init, initChannel, initChannel, initSensors, isHwLineSet, isLineSet, isOnline, isTimeout, readChannel, readChannelGroup, readChannelNow, readSensors, setHwLine, setLine, setLineWarm, setOnline, setOutputLines, testOnline

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.subsystem.teststand.BiasDevice

isOnline

Methods inherited from interface org.lsst.ccs.subsystem.teststand.PhotoDiodeDevice

isOnline

Methods inherited from interface org.lsst.ccs.framework.HardwareController

checkStarted, checkStopped

Methods inherited from interface org.lsst.ccs.framework.HasLifecycle

build, postBuild, postInit, postShutdown, postStart, shutdown, start

Field Detail

CHAN_VOLTAGE

public static final int CHAN_VOLTAGE

See Also:

Constant Field Values

CHAN_CURRENT

public static final int CHAN_CURRENT

See Also:

Constant Field Values

NUM_CHANS

public static final int NUM_CHANS

See Also:

Constant Field Values

Constructor Detail

KeithleyDevice

public KeithleyDevice()

Method Detail

initDevice

protected void initDevice()

Performs initial configuration.

Overrides:

initDevice in class org.lsst.ccs.monitor.Device

initialize

protected void initialize()

Performs full initialization - opens the connection

Specified by:

initialize in class org.lsst.ccs.monitor.Device

close

protected void close()

Closes the connection.

Specified by:

close in class org.lsst.ccs.monitor.Device

checkChannel

protected int[] checkChannel(String name,
                             int hwChan,
                             String type,
                             String subtype)
                      throws Exception

Checks a channel's parameters for validity.

Overrides:

checkChannel in class org.lsst.ccs.monitor.Device

Parameters:

name - Channel name

hwChan - Hardware channel number

type - Channel type

subtype - Channel subtype

Returns:

Encoded type and subtype as an array

Throws:

Exception - if parameter invalid

readChannel

protected double readChannel(int chan,
                             int type)

Reads a channel.

Overrides:

readChannel in class org.lsst.ccs.monitor.Device

Parameters:

chan -

type -

Returns:

setCfg

public void setCfg(TSConfig cfg)

Sets the configuration

Specified by:

setCfg in interface BiasDevice

Specified by:

setCfg in interface PhotoDiodeDevice

Parameters:

cfg -

setDPSF

public void setDPSF(hep.aida.IDataPointSetFactory dpsf)

Sets the data point set factory address.

Specified by:

setDPSF in interface BiasDevice

Specified by:

setDPSF in interface PhotoDiodeDevice

Parameters:

dpsf - The data point set factory

setArmCount

@Command(name="setarmcount",
         description="Set the ARM count")
public void setArmCount(@Argument(name="count",description="ARM count")
                                                                                               int count)
                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Sets ARM count

Parameters:

count - The arm count

Throws:

org.lsst.ccs.drivers.commons.DriverException

setTrigCount

@Command(name="settrigcount",
         description="Set the trigger count")
public void setTrigCount(@Argument(name="value",description="trigger count")
                                                                                                     int value)
                                                                                              throws org.lsst.ccs.drivers.commons.DriverException

Sets TRIGger count

Parameters:

value - The count value

Throws:

org.lsst.ccs.drivers.commons.DriverException

setDisplay

@Command(name="setdisplay",
         description="Set the display")
public void setDisplay(@Argument(name="OnOff",description="true(ON)/false(OFF)")
                                                                                           boolean dstate)
                                                                                    throws org.lsst.ccs.drivers.commons.DriverException

Sets the Display ON(true)/OFF(false)

Specified by:

setDisplay in interface PhotoDiodeDevice

Parameters:

dstate -

Throws:

org.lsst.ccs.drivers.commons.DriverException

clearBuffer

@Command(name="clrbuff",
         description="Clears the Keithley read buffer")
public void clearBuffer()
                                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Clears the data buffer

Throws:

org.lsst.ccs.drivers.commons.DriverException

readCurrents

@Command(type=QUERY,
         name="readCurrents",
         description="Read a set of currents")
public double[][] readCurrents(@Argument(name="nreads",description="#reads (armcount)")
                                                                                                                                 int nreads,
                                                                                                                                 @Argument(name="nplc",description="#Pulse Line Counts btwn reads (0.01->60.)")
                                                                                                                                 double nplc)
                                                                                                                          throws org.lsst.ccs.drivers.commons.DriverException

Gets a set of current readings

Parameters:

nreads -

nplc -

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException

accumBuffer

@Command(type=QUERY,
         name="accumBuffer",
         description="start the buffer accumulation")
public double accumBuffer(@Argument(name="nreads",description="#reads (armcount)")
                                                                                                                                  int nreads,
                                                                                                                                  @Argument(name="nplc",description="#Pulse Line Counts btwn reads (0.01->60.)")
                                                                                                                                  double nplc)

Start the accumulation of readings into the device's internal buffer

Specified by:

accumBuffer in interface PhotoDiodeDevice

Parameters:

nreads -

nplc -

Returns:

The expected time (secs)

accumBuffer

@Command(type=QUERY,
         name="accumBuffer",
         description="start the buffer accumulation")
public double accumBuffer(@Argument(name="nreads",description="#reads (armcount)")
                                                                                                                                  int nreads,
                                                                                                                                  @Argument(name="nplc",description="#Pulse Line Counts btwn reads (0.01->60.)")
                                                                                                                                  double nplc,
                                                                                                                                  @Argument(name="wait",description="to wait (true) or not to (false)")
                                                                                                                                  boolean wait)

Start the accumulation of readings into the device's internal buffer

Specified by:

accumBuffer in interface PhotoDiodeDevice

Parameters:

nreads -

nplc -

wait -

Returns:

The expected time (secs)

waitAccum

@Command(type=QUERY,
         name="waitAccum",
         description="wait for accumulation completion")
public void waitAccum(@Argument(description="Timeout (sec)")
                                                                                                                               double timeout)
                                                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Waits for accumulation to finish.

Specified by:

waitAccum in interface PhotoDiodeDevice

Parameters:

timeout -

Throws:

org.lsst.ccs.drivers.commons.DriverException

readBuffer

@Command(type=QUERY,
         name="readBuffer",
         description="read the buffer")
public double[][] readBuffer()
                                                                                                               throws org.lsst.ccs.drivers.commons.DriverException

Reads the data buffer

Specified by:

readBuffer in interface PhotoDiodeDevice

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException

readBuffer

@Command(type=QUERY,
         name="readBuffer",
         description="read the buffer and dump to file")
public double[][] readBuffer(@Argument(name="filename",description="output filename for the Keithley buffered values")
                                                                                                                                       String filename)
                                                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Reads buffer and dumps it to a file

Parameters:

filename -

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException

readBuffer

@Command(type=QUERY,
         name="readBuffer",
         description="read the buffer and dump to file")
public double[][] readBuffer(@Argument(name="filename",description="output filename for the Keithley buffered values")
                                                                                                                                       String filename,
                                                                                                                                       @Argument(name="host",description="user@host")
                                                                                                                                       String host)
                                                                                                                                throws IOException,
                                                                                                                                       org.lsst.ccs.drivers.commons.DriverException

Reads buffer and dumps it to a remote file

Parameters:

filename -

host -

Returns:

Throws:

IOException

org.lsst.ccs.drivers.commons.DriverException

readBufferStr

@Command(name="readBufferStr",
         description="read the buffer and returns as a string")
public String readBufferStr()
                                                                                                                    throws org.lsst.ccs.drivers.commons.DriverException

Reads buffered data and returns it as a string

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException

setBuffSize

@Command(name="setBuffSize",
         description="Set the buffer size.")
public void setBuffSize(@Argument(description="buffer size")
                                                                                                  int value)
                                                                                           throws org.lsst.ccs.drivers.commons.DriverException

Sets the buffer size

Specified by:

setBuffSize in interface PhotoDiodeDevice

Parameters:

value -

Throws:

org.lsst.ccs.drivers.commons.DriverException

setVoltageRange

@Command(name="setVoltageRange",
         description="Set the voltage range. Can be 10V, 50V or 500V")
public void setVoltageRange(@Argument(description="Voltage Range to set")
                                                                                                                                    double value)
                                                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Sets the voltage range

Specified by:

setVoltageRange in interface BiasDevice

Parameters:

value -

Throws:

org.lsst.ccs.drivers.commons.DriverException

setVoltage

@Command(name="setVoltage",
         description="Set the voltage")
public void setVoltage(@Argument(name="value",description="Voltage to set")
                                                                                           double value)
                                                                                    throws org.lsst.ccs.drivers.commons.DriverException

Sets the voltage.

Specified by:

setVoltage in interface BiasDevice

Parameters:

value -

Throws:

org.lsst.ccs.drivers.commons.DriverException

setChannel

@Command(name="setChannel",
         description="not implemented")
public void setChannel(@Argument(name="value",description="Channel to select")
                                                                                           int value)

Sets the channel.

Specified by:

setChannel in interface PhotoDiodeDevice

Parameters:

value -

setVoltageAcq

@Command(name="setVoltageAcq",
         description="Set the voltage to the acquisition set point")
public void setVoltageAcq(int cfgstate)
                                                                                                                       throws org.lsst.ccs.drivers.commons.DriverException

Sets the voltage to the value needed for acquisition.

Specified by:

setVoltageAcq in interface BiasDevice

Parameters:

cfgstate -

Throws:

org.lsst.ccs.drivers.commons.DriverException

rampVolts

@Command(type=QUERY,
         name="rampVolts",
         description="ramp the voltage")
public void rampVolts(@Argument(description="number of seconds to ramp from current voltage to desired voltage")
                                                                                                               double duration,
                                                                                                               @Argument(description="Voltage to ramp to")
                                                                                                               double value)
                                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Ramps to the desired voltage

Specified by:

rampVolts in interface BiasDevice

Parameters:

duration -

value -

Throws:

org.lsst.ccs.drivers.commons.DriverException

rampVolts

@Command(type=QUERY,
         name="rampVolts",
         description="ramp the voltage")
public void rampVolts(@Argument(name="duration",description="number of seconds to ramp from current voltage to desired voltage")
                                                                                                               double duration,
                                                                                                               @Argument(name="value",description="Voltage to ramp to")
                                                                                                               double value,
                                                                                                               @Argument(name="nsteps",description="number of steps")
                                                                                                               int nsteps)
                                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Ramps to the desired voltage over a given time and for nsteps

Specified by:

rampVolts in interface BiasDevice

Parameters:

duration -

value -

nsteps -

Throws:

org.lsst.ccs.drivers.commons.DriverException

getLastCurrent

@Command(description="return last current measurement")
public double getLastCurrent()

Gets the last current measurement

Specified by:

getLastCurrent in interface BiasDevice

Specified by:

getLastCurrent in interface PhotoDiodeDevice

Returns:

The current

getLast_curr

@Deprecated
 @Command(description="return last current measurement")
public double getLast_curr()

Deprecated.

getLastVoltage

@Command(description="return last voltage measurement")
public double getLastVoltage()

Gets the last voltage measurement

Specified by:

getLastVoltage in interface BiasDevice

Returns:

The voltage

getLast_volt

@Deprecated
 @Command(description="return last voltage measurement")
public double getLast_volt()

Deprecated.

getVoltage

@Command(description="Show the set voltage")
public double getVoltage()
                                                               throws org.lsst.ccs.drivers.commons.DriverException

Shows the set voltage.

Returns:

Throws:

org.lsst.ccs.drivers.commons.DriverException

readVoltage

@Command(type=QUERY,
         description="Read the actual voltage")
public double readVoltage()

Reads the actual voltage.

Specified by:

readVoltage in interface BiasDevice

Returns:

setCurrentRange

@Command(name="setCurrentRange",
         description="Set the current range")
public void setCurrentRange(@Argument(description="Current Range to set")
                                                                                                           double value)
                                                                                                    throws org.lsst.ccs.drivers.commons.DriverException

Sets the current range

Specified by:

setCurrentRange in interface BiasDevice

Specified by:

setCurrentRange in interface PhotoDiodeDevice

Parameters:

value - The current range

Throws:

org.lsst.ccs.drivers.commons.DriverException

zeroCorrectCurrent

@Command(name="zeroCorrectCurrent",
         description="Zero correct the current")
public void zeroCorrectCurrent()
                                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Zero correct the current

Throws:

org.lsst.ccs.drivers.commons.DriverException

readCurrent

@Command(type=QUERY,
         name="readCurrent",
         description="Read the actual current")
public double readCurrent()

Reads the actual current.

Specified by:

readCurrent in interface BiasDevice

Specified by:

readCurrent in interface PhotoDiodeDevice

Returns:

isAccumInProgress

@Command(type=QUERY,
         name="isAccumInProgress",
         description="Are the current readings being accumulated")
public boolean isAccumInProgress()

Tells whether PD accumulation is in progress

Specified by:

isAccumInProgress in interface PhotoDiodeDevice

Returns:

setCurrentLimit

@Command(name="setCurrentLimit",
         description="Set the soft current limit")
public void setCurrentLimit(@Argument(description="Current limit to set")
                                                                                                                double value)
                                                                                                         throws org.lsst.ccs.drivers.commons.DriverException

Sets the soft current limit.

Specified by:

setCurrentLimit in interface BiasDevice

Parameters:

value - The limit value

Throws:

org.lsst.ccs.drivers.commons.DriverException

getCurrentLimit

@Command(type=QUERY,
         name="showcurrlim",
         description="Show the soft current limit")
public String getCurrentLimit()
                                                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Shows the soft current limit.

Specified by:

getCurrentLimit in interface BiasDevice

Returns:

The limit

Throws:

org.lsst.ccs.drivers.commons.DriverException

setRate

@Command(name="setRate",
         description="sets the read rate in plc")
public void setRate(@Argument(description="number of PLC")
                                                                                               double rate)
                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Sets the read rate in PLC

Specified by:

setRate in interface PhotoDiodeDevice

Parameters:

rate - The inverse rate, in clock ticks

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutput

@Command(name="setOutput",
         description="Turn output on or off. 1 ==> ON")
public void setOutput(@Argument(description="Output state: on or off")
                                                                                                         int state)
                                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Turns the output on or off.

Specified by:

setOutput in interface BiasDevice

Parameters:

state - Output state (on if 1, off otherwise)

Throws:

org.lsst.ccs.drivers.commons.DriverException

showOutput

@Command(type=QUERY,
         name="showoutput",
         description="Show the output state")
public boolean showOutput()
                                                                                                                  throws org.lsst.ccs.drivers.commons.DriverException

Shows the output state.

Specified by:

showOutput in interface BiasDevice

Returns:

The output state (true = on, false = off)

Throws:

org.lsst.ccs.drivers.commons.DriverException

setTimeout

@Command(name="setTimeout",
         description="set timeout for Keithley SCPI communication")
public void setTimeout(@Argument(name="nsec",description="length of timeout in seconds")
                                                                                                                       double nsec)

Sets the timeout

Specified by:

setTimeout in interface BiasDevice

Specified by:

setTimeout in interface PhotoDiodeDevice

Parameters:

nsec - Timeout (secs)

reset

@Command(name="reset",
         description="reset trips etc...")
public void reset()

Resets the Keithley to a known default state

Specified by:

reset in interface BiasDevice

Specified by:

reset in interface PhotoDiodeDevice

softReset

@Command(name="softReset",
         description="soft reset etc...")
public void softReset()

Resets the Keithley to a known default state w/o initializing all settings

Specified by:

softReset in interface BiasDevice

Specified by:

softReset in interface PhotoDiodeDevice

setRunBias

@Command(name="setrunbias",
         description="Sets the bias value for acquisition")
public void setRunBias(double runBias,
                                                                                                               int cfgstate)

Sets the bias value for acquisition

Specified by:

setRunBias in interface BiasDevice

Parameters:

runBias -

cfgstate -

getRunBias

@Command(type=QUERY,
         name="getRunBias",
         description="Returns the bias value for acquisition")
public double getRunBias(int cfgstate)

Returns the bias value for acquisition

Specified by:

getRunBias in interface BiasDevice

Parameters:

cfgstate -

Returns:

The run bias

setAbort

@Command(name="abort",
         description="abort or clear abort for any long operation")
public void setAbort(boolean state)

Sets the abort state

Specified by:

setAbort in interface BiasDevice

Specified by:

setAbort in interface PhotoDiodeDevice

Parameters:

state -

setState

@Command(name="setstate",
         description="set keithley device status")
public void setState(int istate)

Sets the state

Specified by:

setState in interface BiasDevice

Specified by:

setState in interface PhotoDiodeDevice

Parameters:

istate -

getState

@Command(type=QUERY,
         name="getState",
         description="get keithley device status")
public int getState()

Gets the state

Specified by:

getState in interface BiasDevice

Specified by:

getState in interface PhotoDiodeDevice

Returns:

The ordinal of the state

isDoPDPlot

public boolean isDoPDPlot()

Gets whether PD plots are produced

Returns:

setDoPDPlot

@Command(description="set whether PD plots are produced")
public void setDoPDPlot(@Argument(description="true for do plots")
                                                                                  boolean doPDPlot)

Sets whether PD plots are produced

Specified by:

setDoPDPlot in interface PhotoDiodeDevice

Parameters:

doPDPlot - Whether plots are produced

send

@Command(name="send",
         description="write a string to the device")
public void send(String str)
                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Writes a command to the Keithley

Specified by:

send in interface PhotoDiodeDevice

Parameters:

str -

Throws:

org.lsst.ccs.drivers.commons.DriverException

send

@Command(name="send",
         description="write a string to the device")
public void send(String str1,
                                                                                            String str2)
                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Writes a command to the Keithley

Specified by:

send in interface PhotoDiodeDevice

Parameters:

str1 -

str2 -

Throws:

org.lsst.ccs.drivers.commons.DriverException

query

@Command(name="query",
         description="write a command and read response")
public String query(String str)
                                                                                              throws org.lsst.ccs.drivers.commons.DriverException

Writes a command to the Keithley and returns response

Specified by:

query in interface PhotoDiodeDevice

Parameters:

str -

Returns:

the response

Throws:

org.lsst.ccs.drivers.commons.DriverException

query

@Command(name="query",
         description="write a command and read response")
public String query(String str1,
                                                                                                     String str2)
                                                                                              throws org.lsst.ccs.drivers.commons.DriverException

Writes a command to the Keithley and returns response

Specified by:

query in interface PhotoDiodeDevice

Parameters:

str1 -

str2 -

Returns:

the response

Throws:

org.lsst.ccs.drivers.commons.DriverException