org.lsst.ccs.drivers.gpvacmon

Class GP835

java.lang.Object

org.lsst.ccs.drivers.ascii.Ascii

org.lsst.ccs.drivers.scpi.Scpi

org.lsst.ccs.drivers.gpvacmon.GP835

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

General access routines for the GP835 device

Author:

Homer Neal **************************************************************************

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GP835.onOff Public constants *

Nested classes/interfaces inherited from class org.lsst.ccs.drivers.ascii.Ascii

org.lsst.ccs.drivers.ascii.Ascii.ConnType, 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

Field Summary

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

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

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

CONN_TYPE_FTDI, CONN_TYPE_NETWORK, CONN_TYPE_SERIAL

Constructor Summary

Constructors

Constructor and Description
GP835()

Method Summary

Modifier and Type	Method and Description
void	close() Closes the connection.
String	getError()
double	getFilamentPower() return the power to the filament
String	getIdent() Gets the GP835 identity.
String	getMSP() return the mass spectrometer scan results
double	getPressure() return the pressure
String	getReport() Gets the GP835 report.
String	getSelectedInstrument() return the currently selected instrument
int	getState() Return the status response as an int
String	getStatus() Return the full Status byte *
String	getTestReport() return the test report
void	init() Initializes device.
void	open(String serialname, int baud) Opens a connection.
void	openftdi(String serialname, int baud) Opens an FTDI connection.
double[][]	readAMU()
double[][]	readDoublePairArray(String command) Reads a double pair array with SCPI error checking after writing a command.
String	readGP835() Reads a response.
String	readGP835(String command) Reads a response after writing a command.
int	readIntegerGP835(String command) Reads a response after writing a command.
void	reset() reset to factory defaults *
void	setGaugeOff() Sets the gauge off --- usually to avoid light
void	setGaugeOn() Sets the gauge on
int	stripError(String err) Return the error register *
int	stripStatus(String status) Strips off "STB" if present and converts hex code to int *
void	writeGP835(String command) Writes a command.

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

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

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

closeSilent, flush, makeDataCharacteristics, open, open, open, open, read, read, readBytes, readBytes, setTerminator, setTimeout, setTimeout, write, writeBytes, writeBytes

Methods inherited from class java.lang.Object

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

Constructor Detail

GP835

public GP835()
      throws org.lsst.ccs.drivers.commons.DriverException

Throws:

org.lsst.ccs.drivers.commons.DriverException

Method Detail

open

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

Opens a connection. *

Parameters:

serialname - The device name of the serial port

baud - The baud rate

Throws:

org.lsst.ccs.drivers.commons.DriverException

openftdi

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

Opens an FTDI connection.

Throws:

org.lsst.ccs.drivers.commons.DriverException

init

public void init()

Initializes device.

close

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

Closes the connection. * * @throws DriverException *

Overrides:

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

reset

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

reset to factory defaults *

Overrides:

reset in class org.lsst.ccs.drivers.scpi.Scpi

Throws:

org.lsst.ccs.drivers.commons.DriverException

getStatus

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

Return the full Status byte *

Throws:

org.lsst.ccs.drivers.commons.DriverException

stripStatus

public int stripStatus(String status)
                throws org.lsst.ccs.drivers.commons.DriverException

Strips off "STB" if present and converts hex code to int *

Throws:

org.lsst.ccs.drivers.commons.DriverException

getState

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

Return the status response as an int

Throws:

org.lsst.ccs.drivers.commons.DriverException

stripError

public int stripError(String err)
               throws org.lsst.ccs.drivers.commons.DriverException

Return the error register *

Throws:

org.lsst.ccs.drivers.commons.DriverException

getError

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

Overrides:

getError in class org.lsst.ccs.drivers.scpi.Scpi

Throws:

org.lsst.ccs.drivers.commons.DriverException

getIdent

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

Gets the GP835 identity. *

Throws:

org.lsst.ccs.drivers.commons.DriverException

getReport

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

Gets the GP835 report. *

Throws:

org.lsst.ccs.drivers.commons.DriverException

getPressure

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

return the pressure

Throws:

org.lsst.ccs.drivers.commons.DriverException - * 9.5.6 External Total Pressure To get the total pressure from an external instrument: INST ETPR OUTP ON MEAS:PRES?

getFilamentPower

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

return the power to the filament

Throws:

org.lsst.ccs.drivers.commons.DriverException

getMSP

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

return the mass spectrometer scan results

Throws:

org.lsst.ccs.drivers.commons.DriverException

getTestReport

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

return the test report

Throws:

org.lsst.ccs.drivers.commons.DriverException

getSelectedInstrument

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

return the currently selected instrument

Throws:

org.lsst.ccs.drivers.commons.DriverException

setGaugeOn

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

Sets the gauge on

Throws:

org.lsst.ccs.drivers.commons.DriverException - *

setGaugeOff

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

Sets the gauge off --- usually to avoid light

Throws:

org.lsst.ccs.drivers.commons.DriverException - *

writeGP835

public void writeGP835(String command)
                throws org.lsst.ccs.drivers.commons.DriverException

Writes a command.

Parameters:

command - The command to write, excluding terminator

Throws:

org.lsst.ccs.drivers.commons.DriverException - *

readGP835

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

Reads a response. * * @return The command response string * * @throws DriverException

Throws:

org.lsst.ccs.drivers.commons.DriverTimeoutException - *

org.lsst.ccs.drivers.commons.DriverException

readGP835

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

Reads a response after writing a command. * * @param command The command to write, excluding terminator * * @return The command response string * * @throws DriverException

Throws:

org.lsst.ccs.drivers.commons.DriverTimeoutException - *

org.lsst.ccs.drivers.commons.DriverException

readIntegerGP835

public int readIntegerGP835(String command)
                     throws org.lsst.ccs.drivers.commons.DriverException

Reads a response after writing a command. * * @param command The command to write, excluding terminator * * @return The command response string * * @throws DriverException

Throws:

org.lsst.ccs.drivers.commons.DriverTimeoutException - *

org.lsst.ccs.drivers.commons.DriverException

readAMU

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

Throws:

org.lsst.ccs.drivers.commons.DriverException

readDoublePairArray

public double[][] readDoublePairArray(String command)
                               throws org.lsst.ccs.drivers.commons.DriverException

Reads a double pair array with SCPI error checking after writing a command. * * @param command The command to write, excluding terminator * @return The returned array of double float values * * @throws DriverException

Throws:

org.lsst.ccs.drivers.commons.DriverTimeoutException - * *************************************************************************

org.lsst.ccs.drivers.commons.DriverException