org.lsst.ccs.drivers.mks

Class GP835

java.lang.Object

org.lsst.ccs.drivers.ascii.Ascii

org.lsst.ccs.drivers.scpi.Scpi

org.lsst.ccs.drivers.mks.GP835

All Implemented Interfaces:

org.lsst.ccs.drivers.commons.DriverConstants

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/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 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
GP835() Constructor

Method Summary

Modifier and Type	Method and Description
void	assignRelay(int relay, int assign) Assigns a trip relay to a vacuum type.
void	checkOpenGP390() Checks that GP390 connection is open.
void	enableRelay(int relay, boolean enable) Enables/disables a trip relay.
double	getFilamentPower() Returns the filament power
String	getInstrument() Gets the currently selected instrument
String	getMSP() Gets the mass spectrometer scan results
double	getPressure() Returns the pressure
double	getPressureGP390() Returns the pressure directly from the GP390
int	getRelayAssignment(int relay) Gets the assignment for a trip relay.
double	getRelayTrip(int relay, int type) Gets a trip relay set point.
String	getTestReport() Gets the test report
boolean	isFilamentOn() Gets whether the vacuum gauge micro-ion filament is on
boolean	isGaugeOn() Gets whether the vacuum gauge is on
boolean	isRelayActive(int relay) Gets whether a trip relay is active.
boolean	isRelayEnabled(int relay) Gets whether a trip relay is enabled.
void	open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType connType, String ident, int parm1, int parm2) Opens a connection.
void	open(String serialname) Opens a serial connection.
void	openftdi(String serialname) Opens an FTDI connection.
double[][]	readAMU() Reads the AMU data
double[][]	readDoublePairArray(String command) Reads a double pair array with SCPI error checking after writing a command.
String	readGP390(String cmnd) Sends a GP390 command and returns the result
void	setFilamentOff() Sets the vacuum gauge micro-ion filament off --- usually to avoid light
void	setFilamentOn() Sets the vacuum gauge micro-ion filament on.
void	setGaugeOff() Sets the whole vacuum gauge off --- usually to avoid light
void	setGaugeOn() Sets the whole vacuum gauge on.
void	setMSPOff() Sets the mass spectrometer off --- usually to avoid light
void	setMSPOn() Sets the mass spectrometer on.
void	setRelayTrip(int relay, int type, double value) Sets a trip relay set point.

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, getConnTimeout, getTimeout, isDropEcho, isOpen, makeDataCharacteristics, open, open, openFtdi, openFtdi, openFtdi, openNet, openNet, openSerial, openSerial, openSerial, read, read, readBytes, readBytes, setCommandTerm, setConnTimeout, setConnTimeout, 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

Constructor Detail

GP835

public GP835()

Constructor

Method Detail

open

public void open(org.lsst.ccs.drivers.commons.DriverConstants.ConnType connType,
                 String ident,
                 int parm1,
                 int parm2)
          throws org.lsst.ccs.drivers.commons.DriverException

Opens a connection. Overrides the SCPI open and provides any additional actions.

Overrides:

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

Parameters:

connType - The connection type (FTDI or SERIAL)

ident - The identification (USB S/N or port)

parm1 - The first parameter (baud rate)

parm2 - The second parameter (data characteristics)

Throws:

org.lsst.ccs.drivers.commons.DriverException

open

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

Opens a serial connection.

Parameters:

serialname - The device name of the serial port

Throws:

org.lsst.ccs.drivers.commons.DriverException

openftdi

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

Opens an FTDI connection.

Parameters:

serialname - The device name of the serial port

Throws:

org.lsst.ccs.drivers.commons.DriverException

getPressure

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

Returns the pressure

Returns:

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?

getPressureGP390

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

Returns the pressure directly from the GP390

Returns:

The pressure

Throws:

org.lsst.ccs.drivers.commons.DriverException

getFilamentPower

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

Returns the filament power

Returns:

The power

Throws:

org.lsst.ccs.drivers.commons.DriverException

getMSP

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

Gets the mass spectrometer scan results

Returns:

The scan data

Throws:

org.lsst.ccs.drivers.commons.DriverException

getTestReport

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

Gets the test report

Returns:

The test report, as a string

Throws:

org.lsst.ccs.drivers.commons.DriverException

getInstrument

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

Gets the currently selected instrument

Returns:

The name of the current instrument

Throws:

org.lsst.ccs.drivers.commons.DriverException

setGaugeOn

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

Sets the whole vacuum gauge on. This takes 7-8 seconds

Throws:

org.lsst.ccs.drivers.commons.DriverException

setGaugeOff

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

Sets the whole vacuum gauge off --- usually to avoid light

Throws:

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

isGaugeOn

public boolean isGaugeOn()
                  throws org.lsst.ccs.drivers.commons.DriverException

Gets whether the vacuum gauge is on

Returns:

Whether the gauge is on

Throws:

org.lsst.ccs.drivers.commons.DriverException

setFilamentOn

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

Sets the vacuum gauge micro-ion filament on. This takes 7-8 seconds

Throws:

org.lsst.ccs.drivers.commons.DriverException

setFilamentOff

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

Sets the vacuum gauge micro-ion filament off --- usually to avoid light

Throws:

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

isFilamentOn

public boolean isFilamentOn()
                     throws org.lsst.ccs.drivers.commons.DriverException

Gets whether the vacuum gauge micro-ion filament is on

Returns:

Whether the gauge is on

Throws:

org.lsst.ccs.drivers.commons.DriverException

setRelayTrip

public void setRelayTrip(int relay,
                         int type,
                         double value)
                  throws org.lsst.ccs.drivers.commons.DriverException

Sets a trip relay set point.

Parameters:

relay - The relay number (1 - 3)

type - The set point type (1 = activation, 0 = deactivation)

value - The set point value

Throws:

org.lsst.ccs.drivers.commons.DriverException

getRelayTrip

public double getRelayTrip(int relay,
                           int type)
                    throws org.lsst.ccs.drivers.commons.DriverException

Gets a trip relay set point.

Parameters:

relay - The relay number (1 - 3)

type - The set point type (1 = activation, 0 = deactivation)

Returns:

The set point value

Throws:

org.lsst.ccs.drivers.commons.DriverException

assignRelay

public void assignRelay(int relay,
                        int assign)
                 throws org.lsst.ccs.drivers.commons.DriverException

Assigns a trip relay to a vacuum type.

Parameters:

relay - The relay number (1 - 3)

assign - The assignment: 0 = absolute, 1 = differential

Throws:

org.lsst.ccs.drivers.commons.DriverException

getRelayAssignment

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

Gets the assignment for a trip relay.

Parameters:

relay - The relay number (1 - 3)

Returns:

The assignment: 0 = absolute, 1 = differential

Throws:

org.lsst.ccs.drivers.commons.DriverException

enableRelay

public void enableRelay(int relay,
                        boolean enable)
                 throws org.lsst.ccs.drivers.commons.DriverException

Enables/disables a trip relay.

Parameters:

relay - The relay number (1 - 3)

enable - Whether to enable

Throws:

org.lsst.ccs.drivers.commons.DriverException

isRelayEnabled

public boolean isRelayEnabled(int relay)
                       throws org.lsst.ccs.drivers.commons.DriverException

Gets whether a trip relay is enabled.

Parameters:

relay - The relay number (1 - 3)

Returns:

Whether enabled

Throws:

org.lsst.ccs.drivers.commons.DriverException

isRelayActive

public boolean isRelayActive(int relay)
                      throws org.lsst.ccs.drivers.commons.DriverException

Gets whether a trip relay is active.

Parameters:

relay - The relay number (1 - 3)

Returns:

Whether active

Throws:

org.lsst.ccs.drivers.commons.DriverException

setMSPOn

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

Sets the mass spectrometer on. This takes ? seconds

Throws:

org.lsst.ccs.drivers.commons.DriverException

setMSPOff

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

Sets the mass spectrometer off --- usually to avoid light

Throws:

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

readAMU

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

Reads the AMU data

Returns:

Array of double pairs of data

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.

Parameters:

command - The command to write, excluding terminator

Returns:

The returned array of double float values

Throws:

org.lsst.ccs.drivers.commons.DriverException

checkOpenGP390

public void checkOpenGP390()

Checks that GP390 connection is open. This is a no-op.

readGP390

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

Sends a GP390 command and returns the result

Parameters:

cmnd - The command to send

Returns:

The raw response

Throws:

org.lsst.ccs.drivers.commons.DriverException