org.lsst.ccs.drivers.keithley

Class Test2231A

java.lang.Object

org.lsst.ccs.drivers.ascii.TestAscii

org.lsst.ccs.drivers.scpi.TestScpi

org.lsst.ccs.drivers.keithley.Test2231A

public class Test2231A
extends org.lsst.ccs.drivers.scpi.TestScpi

Program to test the Keithley model 2231A device driver

Author:

Owen Saxton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Test2231A.OnOff

Field Summary

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

scpi

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

dev

Constructor Summary

Constructors

Constructor and Description
Test2231A() Constructor

Method Summary

Modifier and Type	Method and Description
void	lock() Locks the front panel.
String	readCurrent() Reads the actual current.
String	readCurrent(int chan) Reads the actual current.
String	readVoltage() Reads the actual voltage.
String	readVoltage(int chan) Reads the actual voltage.
void	setChannel(int chan) Sets the channel.
void	setCurrent(double value) Sets the current.
void	setCurrent(double value, int chan) Sets the current.
void	setCurrents(double... values) Sets all the currents.
void	setMaxCurrent() Sets the current to the maximum.
void	setMaxCurrent(int chan) Sets the current to the maximum.
void	setMaxVoltage() Sets the voltage to the maximum.
void	setMaxVoltage(int chan) Sets the voltage to the maximum.
void	setOffDelay(double delay) Sets the output off delay.
void	setOffDelay(double delay, int chan) Sets the output off delay.
void	setOnDelay(double delay) Sets the output on delay.
void	setOnDelay(double delay, int chan) Sets the output on delay.
void	setOutput(Test2231A.OnOff state) Turns the output on or off.
void	setOutput(Test2231A.OnOff state, int chan) Turns the output on or off.
void	setVoltage(double value) Sets the voltage.
void	setVoltage(double value, int chan) Sets the voltage.
void	setVoltageLimit(double value) Sets the soft voltage limit.
void	setVoltageLimit(double value, int chan) Sets the soft voltage limit.
void	setVoltages(double... values) Sets all the voltages.
String	showChannel() Shows the set channel.
String	showCurrent() Shows the set current.
String	showCurrent(int chan) Shows the set current.
String	showCurrents() Shows all the set currents.
String	showMaxCurrent() Shows the maximum current.
String	showMaxCurrent(int chan) Shows the maximum current.
String	showMaxVoltage() Shows the maximum voltage.
String	showMaxVoltage(int chan) Shows the maximum voltage.
String	showOutput() Shows the output state.
String	showOutput(int chan) Shows the output state.
String	showVoltage() Shows the set voltage.
String	showVoltage(int chan) Shows the set voltage.
String	showVoltageLimit() Shows the soft voltage limit.
String	showVoltageLimit(int chan) Shows the soft voltage limit.
String	showVoltages() Shows all the set voltage(s).
void	timeRead(int chan, int count) Performs timing measurements.
void	unlock() Unlocks the front panel.

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

clear, enableOpc, readDouble, readFloat, readInteger, readString, reset, selfTest, setEse, setSre, showError, showEse, showEsr, showIdentification, showOpc, showSre, showStatus, waitComp, writeCommand

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

close, makeCommandString, open, open, open, openFtdi, openFtdi, openNet, openNet, openSerial, openSerial, read, read, setCmndTerm, setDefaultParm, setOptions, setRespTerm, setTerminator, setTimeout, write

Methods inherited from class java.lang.Object

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

Constructor Detail

Test2231A

public Test2231A()

Constructor

Method Detail

setChannel

@Command(name="setchannel",
         description="Set the current channel")
public void setChannel(@Argument(description="Channel number")
                                                                                                   int chan)

Sets the channel.

Parameters:

chan - The channel number

showChannel

@Command(name="showchannel",
         description="Show the set channel")
public String showChannel()

Shows the set channel.

Returns:

The result string

setVoltage

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

Sets the voltage.

Parameters:

value - The value to set

Throws:

org.lsst.ccs.drivers.commons.DriverException

setVoltage

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

Sets the voltage.

Parameters:

value - The value to set

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException

setVoltages

@Command(name="setvoltages",
         description="Set all the voltages")
public void setVoltages(@Argument(description="Voltages to set")
                                                                                                  double... values)
                                                                                           throws org.lsst.ccs.drivers.commons.DriverException

Sets all the voltages.

Parameters:

values - The values to set

Throws:

org.lsst.ccs.drivers.commons.DriverException

setMaxVoltage

@Command(name="setmaxvoltage",
         description="Set the voltage to maximum")
public void setMaxVoltage()
                                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Sets the voltage to the maximum.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setMaxVoltage

@Command(name="setmaxvoltage",
         description="Set the voltage to maximum")
public void setMaxVoltage(@Argument(description="Channel number")
                                                                                                            int chan)
                                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Sets the voltage to the maximum.

Parameters:

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException

showMaxVoltage

@Command(name="showmaxvoltage",
         description="Show the maximum voltage")
public String showMaxVoltage()
                                                                                                       throws org.lsst.ccs.drivers.commons.DriverException

Shows the maximum voltage.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

showMaxVoltage

@Command(name="showmaxvoltage",
         description="Show the maximum voltage")
public String showMaxVoltage(@Argument(description="Channel number")
                                                                                                              int chan)
                                                                                                       throws org.lsst.ccs.drivers.commons.DriverException

Shows the maximum voltage.

Parameters:

chan - The channel number

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

showVoltage

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

Shows the set voltage.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

showVoltage

@Command(name="showvoltage",
         description="Show the set voltage")
public String showVoltage(@Argument(description="Channel number")
                                                                                                    int chan)
                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Shows the set voltage.

Parameters:

chan - The channel number

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

showVoltages

@Command(name="showvoltages",
         description="Show all the set voltages")
public String showVoltages()
                                                                                                    throws org.lsst.ccs.drivers.commons.DriverException

Shows all the set voltage(s).

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

readVoltage

@Command(name="readvoltage",
         description="Read the actual voltage")
public String readVoltage()
                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Reads the actual voltage.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

readVoltage

@Command(name="readvoltage",
         description="Read the actual voltage")
public String readVoltage(@Argument(description="Channel number")
                                                                                                       int chan)
                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Reads the actual voltage.

Parameters:

chan - The channel number

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setVoltageLimit

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

Sets the soft voltage limit.

Parameters:

value - The value to set

Throws:

org.lsst.ccs.drivers.commons.DriverException

setVoltageLimit

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

Sets the soft voltage limit.

Parameters:

value - The value to set

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException

showVoltageLimit

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

Shows the soft voltage limit.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

showVoltageLimit

@Command(name="showvoltlim",
         description="Show the soft voltage limit")
public String showVoltageLimit(@Argument(description="Channel number")
                                                                                                                int chan)
                                                                                                         throws org.lsst.ccs.drivers.commons.DriverException

Shows the soft voltage limit.

Parameters:

chan - The channel number

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setCurrent

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

Sets the current.

Parameters:

value - The value to set

Throws:

org.lsst.ccs.drivers.commons.DriverException

setCurrent

@Command(name="setcurrent",
         description="Set the current")
public void setCurrent(@Argument(description="Current to set")
                                                                                           double value,
                                                                                           @Argument(description="Channel number")
                                                                                           int chan)
                                                                                    throws org.lsst.ccs.drivers.commons.DriverException

Sets the current.

Parameters:

value - The value to set

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException

setCurrents

@Command(name="setcurrents",
         description="Set all the currents")
public void setCurrents(@Argument(description="Currents to set")
                                                                                                  double... values)
                                                                                           throws org.lsst.ccs.drivers.commons.DriverException

Sets all the currents.

Parameters:

values - The values to set

Throws:

org.lsst.ccs.drivers.commons.DriverException

setMaxCurrent

@Command(name="setmaxcurrent",
         description="Set the current to maximum")
public void setMaxCurrent()
                                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Sets the current to the maximum.

Throws:

org.lsst.ccs.drivers.commons.DriverException

setMaxCurrent

@Command(name="setmaxcurrent",
         description="Set the current to maximum")
public void setMaxCurrent(@Argument(description="Channel number")
                                                                                                            int chan)
                                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Sets the current to the maximum.

Parameters:

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException

showMaxCurrent

@Command(name="showmaxcurrent",
         description="Show the set current")
public String showMaxCurrent()
                                                                                                   throws org.lsst.ccs.drivers.commons.DriverException

Shows the maximum current.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

showMaxCurrent

@Command(name="showmaxcurrent",
         description="Show the set current")
public String showMaxCurrent(@Argument(description="Channel number")
                                                                                                          int chan)
                                                                                                   throws org.lsst.ccs.drivers.commons.DriverException

Shows the maximum current.

Parameters:

chan - The channel number

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

showCurrent

@Command(name="showcurrent",
         description="Show the set current")
public String showCurrent()
                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Shows the set current.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

showCurrent

@Command(name="showcurrent",
         description="Show the set current")
public String showCurrent(@Argument(description="Channel number")
                                                                                                    int chan)
                                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Shows the set current.

Parameters:

chan - The channel number

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

showCurrents

@Command(name="showcurrents",
         description="Show the set current")
public String showCurrents()
                                                                                               throws org.lsst.ccs.drivers.commons.DriverException

Shows all the set currents.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

readCurrent

@Command(name="readcurrent",
         description="Read the actual current")
public String readCurrent()
                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Reads the actual current.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

readCurrent

@Command(name="readcurrent",
         description="Read the actual current")
public String readCurrent(@Argument(description="Channel number")
                                                                                                       int chan)
                                                                                                throws org.lsst.ccs.drivers.commons.DriverException

Reads the actual current.

Parameters:

chan - The channel number

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOnDelay

@Command(name="setondelay",
         description="Set output on delay")
public void setOnDelay(@Argument(description="Output on delay")
                                                                                               double delay)
                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Sets the output on delay.

Parameters:

delay - The delay before turning the output on (sec)

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOnDelay

@Command(name="setondelay",
         description="Set output on delay")
public void setOnDelay(@Argument(description="Output on delay")
                                                                                               double delay,
                                                                                               @Argument(description="Channel number")
                                                                                               int chan)
                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Sets the output on delay.

Parameters:

delay - The delay before turning the output on (sec)

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOffDelay

@Command(name="setoffdelay",
         description="Set output off delay")
public void setOffDelay(@Argument(description="Output off delay")
                                                                                                  double delay)
                                                                                           throws org.lsst.ccs.drivers.commons.DriverException

Sets the output off delay.

Parameters:

delay - The delay before turning the output off (sec)

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOffDelay

@Command(name="setoffdelay",
         description="Set output off delay")
public void setOffDelay(@Argument(description="Output off delay")
                                                                                                  double delay,
                                                                                                  @Argument(description="Channel number")
                                                                                                  int chan)
                                                                                           throws org.lsst.ccs.drivers.commons.DriverException

Sets the output off delay.

Parameters:

delay - The delay before turning the output off (sec)

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutput

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

Turns the output on or off.

Parameters:

state - The state to set: on or off

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutput

@Command(name="setoutput",
         description="Turn output on or off")
public void setOutput(@Argument(description="Output state: on or off")
                                                                                               Test2231A.OnOff state,
                                                                                               @Argument(description="Channel number")
                                                                                               int chan)
                                                                                        throws org.lsst.ccs.drivers.commons.DriverException

Turns the output on or off.

Parameters:

state - The state to set: on or off

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException

showOutput

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

Shows the output state.

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

showOutput

@Command(name="showoutput",
         description="Show the output state")
public String showOutput(@Argument(description="Channel number")
                                                                                                   int chan)
                                                                                            throws org.lsst.ccs.drivers.commons.DriverException

Shows the output state.

Parameters:

chan - The channel number

Returns:

The result string

Throws:

org.lsst.ccs.drivers.commons.DriverException

lock

@Command(name="lock",
         description="Lock the front panel")
public void lock()
                                                                             throws org.lsst.ccs.drivers.commons.DriverException

Locks the front panel.

Throws:

org.lsst.ccs.drivers.commons.DriverException

unlock

@Command(name="unlock",
         description="Unlock the front panel")
public void unlock()
                                                                                   throws org.lsst.ccs.drivers.commons.DriverException

Unlocks the front panel.

Throws:

org.lsst.ccs.drivers.commons.DriverException

timeRead

@Command(name="timeread",
         description="Time voltage reading")
public void timeRead(@Argument(description="Channel number")
                                                                                            int chan,
                                                                                            @Argument(description="Read count")
                                                                                            int count)
                                                                                     throws org.lsst.ccs.drivers.commons.DriverException

Performs timing measurements.

Parameters:

chan - The channel to use

count - The number of times to read the voltage

Throws:

org.lsst.ccs.drivers.commons.DriverException