org.lsst.ccs.drivers.keithley

Class Model2231A

java.lang.Object

org.lsst.ccs.drivers.ascii.Ascii

org.lsst.ccs.drivers.scpi.Scpi

org.lsst.ccs.drivers.keithley.Model2231A

All Implemented Interfaces:

org.lsst.ccs.drivers.commons.DriverConstants, org.lsst.ccs.drivers.commons.PowerSupplyDriver

public class Model2231A
extends org.lsst.ccs.drivers.scpi.Scpi
implements org.lsst.ccs.drivers.commons.PowerSupplyDriver

Routines for controlling a Keithley model 2231A power supply

Author:

Owen Saxton

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	BAUDRATE
static int	MAX_CHANNEL
static double	MAX_VALUE
static int	MIN_CHANNEL
static int	NUM_CHANNELS

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

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

Constructor Summary

Constructors

Constructor and Description
Model2231A() Constructor.

Method Summary

Modifier and Type	Method and Description
double[]	getCurrent() Gets the set current for all channels.
double	getCurrent(int chan) Gets the set current for a channel.
double	getMaximumCurrent(int chan) Gets the maximum current for a channel.
double	getMaximumVoltage(int chan) Gets the maximum voltage for a channel.
boolean	getOutput(int chan) Gets the output state of a channel.
double[]	getVoltage() Gets the set voltages for all channels.
double	getVoltage(int chan) Gets the set voltage for a channel.
double	getVoltageLimit(int chan) Gets the voltage limit for a channel.
boolean	getVoltageLimitCheck(int chan) Gets whether voltage limit check is enabled for a channel.
void	lockPanel(boolean lock) Locks or unlocks the front panel.
void	open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType connType, String ident, int baudRate, int commParm) Opens a connection.
double	readCurrent(int chan) Reads the current for a channel.
double	readVoltage(int chan) Reads the voltage for a channel.
void	setCurrent(double[] values) Sets the current for all channels.
void	setCurrent(double value, int chan) Sets the current for a channel.
void	setOffDelay(double time, int chan) Sets the power-off delay for a channel.
void	setOnDelay(double time, int chan) Sets the power-on delay for a channel.
void	setOutput(boolean on, int chan) Turns output on or off for a channel.
void	setVoltage(double[] values) Sets the voltage for all channels.
void	setVoltage(double value, int chan) Sets the voltage for a channel.
void	setVoltageLimit(double value, int chan) Sets the voltage limit for a channel.
void	setVoltageLimitCheck(boolean on, int chan) Turns on or off the voltage limit check for a channel.

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

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

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.lsst.ccs.drivers.commons.PowerSupplyDriver

close, open

Field Detail

BAUDRATE

public static final int BAUDRATE

See Also:

Constant Field Values

MIN_CHANNEL

public static final int MIN_CHANNEL

See Also:

Constant Field Values

MAX_CHANNEL

public static final int MAX_CHANNEL

See Also:

Constant Field Values

NUM_CHANNELS

public static final int NUM_CHANNELS

See Also:

Constant Field Values

MAX_VALUE

public static final double MAX_VALUE

See Also:

Constant Field Values

Constructor Detail

Model2231A

public Model2231A()

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.

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, ignored - always set to 9600

commParm - The communications parameters, ignored - always set to 0

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOutput

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

Turns output on or off for a channel.

Specified by:

setOutput in interface org.lsst.ccs.drivers.commons.PowerSupplyDriver

Parameters:

on - Turn on if true, off if false

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException

getOutput

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

Gets the output state of a channel.

Specified by:

getOutput in interface org.lsst.ccs.drivers.commons.PowerSupplyDriver

Parameters:

chan - The channel number

Returns:

The output state

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOnDelay

public void setOnDelay(double time,
                       int chan)
                throws org.lsst.ccs.drivers.commons.DriverException

Sets the power-on delay for a channel.

Specified by:

setOnDelay in interface org.lsst.ccs.drivers.commons.PowerSupplyDriver

Parameters:

time - The delay (sec)

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException

setOffDelay

public void setOffDelay(double time,
                        int chan)
                 throws org.lsst.ccs.drivers.commons.DriverException

Sets the power-off delay for a channel.

Specified by:

setOffDelay in interface org.lsst.ccs.drivers.commons.PowerSupplyDriver

Parameters:

time - The delay (sec)

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException

setVoltage

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

Sets the voltage for a channel.

Specified by:

setVoltage in interface org.lsst.ccs.drivers.commons.PowerSupplyDriver

Parameters:

value - The value to set

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException

setVoltage

public void setVoltage(double[] values)
                throws org.lsst.ccs.drivers.commons.DriverException

Sets the voltage for all channels.

Parameters:

values - The three-element array of values to set

Throws:

org.lsst.ccs.drivers.commons.DriverException

getVoltage

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

Gets the set voltage for a channel.

Specified by:

getVoltage in interface org.lsst.ccs.drivers.commons.PowerSupplyDriver

Parameters:

chan - The channel number

Returns:

The voltage

Throws:

org.lsst.ccs.drivers.commons.DriverException

getVoltage

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

Gets the set voltages for all channels.

Returns:

A three-element array of voltages

Throws:

org.lsst.ccs.drivers.commons.DriverException

getMaximumVoltage

public double getMaximumVoltage(int chan)
                         throws org.lsst.ccs.drivers.commons.DriverException

Gets the maximum voltage for a channel.

Parameters:

chan - The channel number

Returns:

The maximum voltage

Throws:

org.lsst.ccs.drivers.commons.DriverException

readVoltage

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

Reads the voltage for a channel.

Specified by:

readVoltage in interface org.lsst.ccs.drivers.commons.PowerSupplyDriver

Parameters:

chan - The channel number

Returns:

The voltage

Throws:

org.lsst.ccs.drivers.commons.DriverException

setCurrent

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

Sets the current for a channel.

Specified by:

setCurrent in interface org.lsst.ccs.drivers.commons.PowerSupplyDriver

Parameters:

value - The value to set

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException

setCurrent

public void setCurrent(double[] values)
                throws org.lsst.ccs.drivers.commons.DriverException

Sets the current for all channels.

Parameters:

values - The three-element array of values to set

Throws:

org.lsst.ccs.drivers.commons.DriverException

getCurrent

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

Gets the set current for a channel.

Specified by:

getCurrent in interface org.lsst.ccs.drivers.commons.PowerSupplyDriver

Parameters:

chan - The channel number

Returns:

The current

Throws:

org.lsst.ccs.drivers.commons.DriverException

getCurrent

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

Gets the set current for all channels.

Returns:

The three-element array of currents

Throws:

org.lsst.ccs.drivers.commons.DriverException

getMaximumCurrent

public double getMaximumCurrent(int chan)
                         throws org.lsst.ccs.drivers.commons.DriverException

Gets the maximum current for a channel.

Parameters:

chan - The channel number

Returns:

The maximum current

Throws:

org.lsst.ccs.drivers.commons.DriverException

readCurrent

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

Reads the current for a channel.

Specified by:

readCurrent in interface org.lsst.ccs.drivers.commons.PowerSupplyDriver

Parameters:

chan - The channel number

Returns:

The current

Throws:

org.lsst.ccs.drivers.commons.DriverException

setVoltageLimit

public void setVoltageLimit(double value,
                            int chan)
                     throws org.lsst.ccs.drivers.commons.DriverException

Sets the voltage limit for a channel.

Parameters:

value - The value to set

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException

getVoltageLimit

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

Gets the voltage limit for a channel.

Parameters:

chan - The channel number

Returns:

The voltage

Throws:

org.lsst.ccs.drivers.commons.DriverException

setVoltageLimitCheck

public void setVoltageLimitCheck(boolean on,
                                 int chan)
                          throws org.lsst.ccs.drivers.commons.DriverException

Turns on or off the voltage limit check for a channel.

Parameters:

on - Whether to turn on the limit check

chan - The channel number

Throws:

org.lsst.ccs.drivers.commons.DriverException

getVoltageLimitCheck

public boolean getVoltageLimitCheck(int chan)
                             throws org.lsst.ccs.drivers.commons.DriverException

Gets whether voltage limit check is enabled for a channel.

Parameters:

chan - The channel number

Returns:

Whether voltage limit check is enabled

Throws:

org.lsst.ccs.drivers.commons.DriverException

lockPanel

public void lockPanel(boolean lock)
               throws org.lsst.ccs.drivers.commons.DriverException

Locks or unlocks the front panel.

Parameters:

lock - True to lock the panel; false to unlock it

Throws:

org.lsst.ccs.drivers.commons.DriverException