KeithleyDevice (LSST Camera Control Software - Test Stand Subsystem 1.0.4 API)

java.lang.Object
- org.lsst.ccs.framework.ConfigurableComponent
- - org.lsst.ccs.subsystem.monitor.Device
  - - org.lsst.ccs.subsystem.teststand.KeithleyDevice

All Implemented Interfaces:

org.lsst.ccs.framework.Configurable, BiasDevice, PhotoDiodeDevice

Direct Known Subclasses:

KeithleySimDevice
```
public class KeithleyDevice
extends org.lsst.ccs.subsystem.monitor.Device
implements BiasDevice, PhotoDiodeDevice
```
Program to test the Keithley N6487 device driver * (based on Owen Saxton's Agilent driver tester) * * @author Homer Neal * **************************************************************************

Nested Class Summary
- Nested classes/interfaces inherited from interface org.lsst.ccs.framework.Configurable
  org.lsst.ccs.framework.Configurable.Environment

Field Summary

Fields
Modifier and Type Field and Description

protected org.lsst.ccs.drivers.scpi.Scpi scpi
- Fields inherited from class org.lsst.ccs.subsystem.monitor.Device
  chanMask, ctlChans, fullName, inited, lineMask, lineState, lineWarm, log, mon, online
- Fields inherited from class org.lsst.ccs.framework.ConfigurableComponent
  environment

Fields
Modifier and Type	Field and Description
`protected org.lsst.ccs.drivers.scpi.Scpi`	`scpi`

Constructor Summary

Constructors
Constructor and Description
`KeithleyDevice()` Constructor * **************************************************************************
`KeithleyDevice(String host, int port)` KeithleyDevice constructor - put Keithley in initial subsystem state

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected int[]`	`checkChannel(String name, int hwChan, String type, String subtype)` Checks a channel's parameters for validity.
`void`	`clearBuffer()` Clear buffer * **************************************************************************
`protected void`	`close()` Closes the connection.
`protected void`	`configure(org.lsst.ccs.subsystem.monitor.Monitor mon)` Performs configuration.
`double`	`getCurrent()` Shows the set current.
`String`	`getCurrentLimit()` Shows the soft current limit.
`double`	`getRunBias(int cfgstate)` Returns the bias value for acquisition * **************************************************************************
`int`	`getState()`
`String`	`getVoltage()` Shows the set voltage.
`String`	`getVoltageLimit()` Shows the soft voltage limit.
`protected void`	`initChannel(int chan, int type, int subtype)` Initializes a channel.
`protected void`	`initialize()` Initializes the device **************************************************************************
`void`	`open()` Opens connection to a device using all defaults * **************************************************************************
`String`	`open(String host)` Opens connection to a device.
`String`	`open(String host, int port)` Opens connection to a device.
`String`	`openftdi(String host, int port)` Opens FTDI connection to a device.
`void`	`rampVolts(double duration, double value)` Ramps to the desired voltage * **************************************************************************
`String`	`readBuffer()` Read buffer * **************************************************************************
`protected double`	`readChannel(int chan, int type)` Reads a channel.
`double`	`readCurrent()` Reads the actual current.
`double`	`readVoltage()` Reads the actual voltage.
`void`	`reset()`
`void`	`setArmCount(int value)` Sets ARM count * **************************************************************************
`void`	`setBuffSize(int value)` Set buffer size * **************************************************************************
`void`	`setCurrent(double value)` Sets the current.
`void`	`setCurrentLimit(double value)` Sets the soft current limit.
`void`	`setCurrentRange(double value)` Sets the current range * **************************************************************************
`void`	`setOutput(int state)` Turns the output on or off.
`void`	`setRate(int rate)` Sets the read rate in PLC * **************************************************************************
`void`	`setRunBias(double runBias, int cfgstate)` Sets the bias value for acquisition * **************************************************************************
`void`	`setState(int istate)`
`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`	`setVoltageLimit(double value)` Sets the soft voltage limit.
`void`	`setVoltageRange(double value)` Sets the voltage range * **************************************************************************
`boolean`	`showOutput()` Shows the output state.
`void`	`zeroCorrectCurrent()` Zero correct the current * **************************************************************************

Methods inherited from class org.lsst.ccs.subsystem.monitor.Device
addChannel, addChildConfigValues, addLine, checkHwLine, checkLine, checkOnline, checkTimeout, dropChannel, getConfigValues, getFullName, getOutputLines, initSensors, isHwLineSet, isLineSet, isOnline, isTimeout, readChannelGroup, readSensors, setHwLine, setLine, setLineWarm, setOnline, setOutputLines, testOnline

Methods inherited from class org.lsst.ccs.framework.ConfigurableComponent
alias, change, getDictionary, getEnvironment, getName, getParent, setEnvironment

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

Field Detail

scpi

protected org.lsst.ccs.drivers.scpi.Scpi scpi

Constructor Detail
- KeithleyDevice
```
public KeithleyDevice(String host,
                      int port)
               throws org.lsst.ccs.drivers.commons.DriverException
```
  KeithleyDevice constructor - put Keithley in initial subsystem state
  
  Parameters:
  
  host - device address
  
  port - port or baud * * @param runBias CCD bias voltage while running * **************************************************************************
  
  Throws:
  
  org.lsst.ccs.drivers.commons.DriverException
- KeithleyDevice
```
public KeithleyDevice()
```
  Constructor * **************************************************************************

Method Detail

configure
```
protected void configure(org.lsst.ccs.subsystem.monitor.Monitor mon)
```
Performs configuration. * **************************************************************************

Overrides:

configure in class org.lsst.ccs.subsystem.monitor.Device

open

@Command(name="open",
         description="Open connection to device using defaults")
public void open()
                                                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Opens connection to a device using all defaults * **************************************************************************

Throws:: org.lsst.ccs.drivers.commons.DriverException

close
```
protected void close()
```
Closes the connection. * **************************************************************************

Specified by:

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

initialize
```
protected void initialize()
```
Initializes the device **************************************************************************

Specified by:

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

open

@Command(name="open",
         description="Open connection to device")
public String open(@Argument(name="host",description="Host name")
                                                                                           String host)
                                                                                    throws org.lsst.ccs.drivers.commons.DriverException

Opens connection to a device. * **************************************************************************

Throws:: org.lsst.ccs.drivers.commons.DriverException

open

@Command(name="open",
         description="Open connection to device")
public String open(@Argument(name="host",description="Host name")
                                                                                           String host,
                                                                                           @Argument(name="port",description="Port number")
                                                                                           int port)
                                                                                    throws org.lsst.ccs.drivers.commons.DriverException

Opens connection to a device. * **************************************************************************

Throws:: org.lsst.ccs.drivers.commons.DriverException

openftdi

@Command(name="openftdi",
         description="Open FTDI connection to device")
public String openftdi(@Argument(name="serialname",description="Serial device name")
                                                                                                        String host,
                                                                                                        @Argument(name="baud",description="baud rate")
                                                                                                        int port)
                                                                                                 throws org.lsst.ccs.drivers.commons.DriverException

Opens FTDI connection to a device. * **************************************************************************

Throws:: org.lsst.ccs.drivers.commons.DriverException

setArmCount

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

Sets 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 * **************************************************************************

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

Clear buffer * **************************************************************************

Throws:: org.lsst.ccs.drivers.commons.DriverException

readBuffer

@Command(name="readbuff",
         description="read the buffer")
public String readBuffer()
                                                                                    throws org.lsst.ccs.drivers.commons.DriverException

Read buffer * **************************************************************************

Throws:: org.lsst.ccs.drivers.commons.DriverException

setBuffSize

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

Set buffer size * **************************************************************************

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(name="value",description="Voltage Range to set")
                                                                                                                                    double value)

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

Specified by:: setVoltageRange in interface BiasDevice
Specified by:: setVoltageRange in interface PhotoDiodeDevice

setVoltage

@Command(name="setvoltage",
         description="Set the voltage")
public void setVoltage(@Argument(name="value",description="Voltage to set")
                                                                                           double value)

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

Specified by:: setVoltage in interface BiasDevice
Specified by:: setVoltage in interface PhotoDiodeDevice

setVoltageAcq
```
@Command(name="setvoltageacq",
         description="Set the voltage to the acquisition set point")
public void setVoltageAcq(int cfgstate)
```
Sets the voltage to the value needed for acquisition. * **************************************************************************

Specified by:

setVoltageAcq in interface BiasDevice

Specified by:

setVoltageAcq in interface PhotoDiodeDevice

rampVolts

@Command(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)

Ramps to the desired voltage * **************************************************************************

Specified by:: rampVolts in interface BiasDevice
Specified by:: rampVolts in interface PhotoDiodeDevice

getVoltage

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

Shows the set voltage. * **************************************************************************

Throws:: org.lsst.ccs.drivers.commons.DriverException

readVoltage
```
@Command(name="readvoltage",
         description="Read the actual voltage")
public double readVoltage()
```
Reads the actual voltage. * **************************************************************************

Specified by:

readVoltage in interface BiasDevice

Specified by:

readVoltage in interface PhotoDiodeDevice

setVoltageLimit

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

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

Throws:: org.lsst.ccs.drivers.commons.DriverException

getVoltageLimit

@Command(name="showvoltlim",
         description="Show the soft voltage limit")
public String getVoltageLimit()
                                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Shows the soft voltage limit. * **************************************************************************

Throws:: org.lsst.ccs.drivers.commons.DriverException

setCurrentRange

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

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

Throws:: org.lsst.ccs.drivers.commons.DriverException

setCurrent

@Command(name="setcurrent",
         description="Set the current")
public void setCurrent(@Argument(name="value",description="Current to set")
                                                                                           double value)

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

Specified by:: setCurrent in interface BiasDevice
Specified by:: setCurrent in interface PhotoDiodeDevice

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

getCurrent

@Command(name="showcurrent",
         description="Show the set current")
public double getCurrent()

Shows the set current. * **************************************************************************

readCurrent
```
@Command(type=ACTION,
         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

setCurrentLimit

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

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

Throws:: org.lsst.ccs.drivers.commons.DriverException

getCurrentLimit

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

Shows the soft current limit. * **************************************************************************

Throws:: org.lsst.ccs.drivers.commons.DriverException

setRate

@Command(name="setrate",
         description="sets the read rate in plc")
public void setRate(@Argument(name="rate",description="number of PLC")
                                                                                               int rate)

Sets the read rate in PLC * **************************************************************************

Specified by:: setRate in interface BiasDevice
Specified by:: setRate in interface PhotoDiodeDevice

setOutput

@Command(name="setoutput",
         description="Turn output on or off. 1 ==> ON")
public void setOutput(@Argument(name="state",description="Output state: on or off")
                                                                                                         int state)

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

Specified by:: setOutput in interface BiasDevice
Specified by:: setOutput in interface PhotoDiodeDevice

showOutput
```
@Command(name="showoutput",
         description="Show the output state")
public boolean showOutput()
```
Shows the output state. * **************************************************************************

Specified by:

showOutput in interface BiasDevice

Specified by:

showOutput in interface PhotoDiodeDevice

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.subsystem.monitor.Device
Throws:: Exception

initChannel
```
protected void initChannel(int chan,
                           int type,
                           int subtype)
```
Initializes a channel. * **************************************************************************

Overrides:

initChannel in class org.lsst.ccs.subsystem.monitor.Device

reset

@Command(name="reset",
         description="reset trips etc...")
public void reset()
                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Throws:: org.lsst.ccs.drivers.commons.DriverException

readChannel
```
protected double readChannel(int chan,
                             int type)
```
Reads a channel. * **************************************************************************

Overrides:

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

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
Specified by:: setRunBias in interface PhotoDiodeDevice

getRunBias
```
@Command(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

Specified by:

getRunBias in interface PhotoDiodeDevice

setState

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

Specified by:: setState in interface BiasDevice
Specified by:: setState in interface PhotoDiodeDevice

getState

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

Specified by:: getState in interface BiasDevice
Specified by:: getState in interface PhotoDiodeDevice

Class KeithleyDevice

Nested Class Summary

Nested classes/interfaces inherited from interface org.lsst.ccs.framework.Configurable

Field Summary

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

Fields inherited from class org.lsst.ccs.framework.ConfigurableComponent

Constructor Summary

Method Summary

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

Methods inherited from class org.lsst.ccs.framework.ConfigurableComponent

Methods inherited from class java.lang.Object

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

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

Field Detail

scpi

Constructor Detail

KeithleyDevice

KeithleyDevice

Method Detail

configure

open

close

initialize

open

open

openftdi

setArmCount

setTrigCount

clearBuffer

readBuffer

setBuffSize

setVoltageRange

setVoltage

setVoltageAcq

rampVolts

getVoltage

readVoltage

setVoltageLimit

getVoltageLimit

setCurrentRange

setCurrent

zeroCorrectCurrent

getCurrent

readCurrent

setCurrentLimit

getCurrentLimit

setRate

setOutput

showOutput

checkChannel

initChannel

reset

readChannel

setRunBias

getRunBias

setState

getState